{"id":499,"date":"2020-01-02T05:58:55","date_gmt":"2020-01-02T11:58:55","guid":{"rendered":"http:\/\/blog.captainsglen.com\/?p=499"},"modified":"2020-01-03T09:36:36","modified_gmt":"2020-01-03T15:36:36","slug":"digital-photo-frame-diy","status":"publish","type":"post","link":"https:\/\/blog.captainsglen.com\/?p=499","title":{"rendered":"Digital Photo Frame – DIY"},"content":{"rendered":"

If you’ve ever fancied a digital display frame, but perhaps wanted more than just a simple carousel of your pictures, or greater control over how the device behaves, then read on.<\/p>\n

What we’ll build<\/h1>\n

A digital display board that showcases your photographs, with an overlaid calendar and weather forecast. For those of you into home automation, I’ll also cover how to turn the display on and off by integrating with Samsung SmartThings home hub – the basic approach could serve as a starting point for other integrations.<\/p>\n

How we’ll do it<\/h2>\n

A Raspberry Pi zero w (about $26 with case and power supply) combined with a Dell 24″ monitor (about $120), and the\u00a0Dakboard<\/a> web digital display service.<\/p>\n

Dakboard<\/h1>\n

The simplest way to get started is to follow this handy guide.<\/a> This will help you get your Pi up and running, though I found that for the release of Raspbian current as of December 2019, I need to follow the alternative instructions for updating the autostart instructions :<\/p>\n

\/etc\/xdg\/lxsession\/LXDE-pi\/autostart\n\n<\/pre>\n
Automating the Pi display<\/h1>\n
We’re going to create a RESTful web service (API) that can be invoked with a simple URL to turn the display on and off, this is what our home automation will call. This will leverage Python3, Flask, and NGINX.<\/p>\n
NGINX<\/h2>\n
This is a popular web server for the Pi, you could use apache but the tutorials I was following used nginx.<\/p>\n
sudo apt-get install nginx<\/span><\/pre>\n
Python3<\/h2>\n
If your Raspbian install is fresh (you used noobs to get up and running) you probably don’t need to sudo apt-get update, but it might not include Python3, so let’s install that.<\/p>\n
Log into your Pi (I use SSH from my Macbook)<\/p>\n
sudo apt-get install python3-pip<\/pre>\n
UWSGI flask<\/span><\/h2>\n
This will install the flask API framework, which greatly simplifies the work required to create RESTful apis in python.<\/p>\n
sudo pip3 install flask uwsgi<\/pre>\n
sudo pip3 install flask-restful<\/span><\/pre>\n
Python api program<\/h2>\n
You can clone from https:\/\/github.com\/klcampbell6502\/pirest.git or use the code as displayed there.<\/p>\n
from flask import Flask\nfrom flask_restful import Resource, Api\nimport os\n\u00a0\napp = Flask(__name__)\n\u00a0\napi = Api(app)\n\nclass ScreenOff(Resource):\n    def get(self):\n        os.system(\"vcgencmd display_power 0\")\n        return \"off\"\n\u00a0\nclass ScreenOn(Resource):\n    def get(self):\n        os.system(\"vcgencmd display_power 1\")\n        return \"on\"\n\napi.add_resource(ScreenOff,'\/screen\/off')\napi.add_resource(ScreenOn,'\/screen\/on')\n\nif __name__ == '__main__':\n    app.run(host='0.0.0.0')<\/pre>\n
Testing<\/h3>\n
We should now be able to test the flask API using the debug environment:<\/p>\n
uwsgi --socket 0.0.0.0:8000 --protocol=http -w api:app<\/pre>\n
and then invoke the URL:<\/p>\n
http:\/\/yourpiaddress:8000\/screen\/off<\/pre>\n
You should see the single word “off” in your browser, and if you look in your ssh output you should see something like this:<\/p>\n
*** uWSGI is running in multiple interpreter mode ***<\/span>\nspawned uWSGI worker 1 (and the only) (pid: 7822, cores: 1)<\/span>\ndisplay_power=0\n<\/span>[pid: 7822|app: 0|req: 1\/1] 192.168.86.24 () {32 vars in 644 bytes} [Wed Jan\u00a0 <\/span>1 12:16:54 2020] GET \/screen\/off => generated 6 bytes in 273 msecs (HTTP\/1.1 200) 2 headers in 70 bytes (1 switches on core 0)<\/span>\n[pid: 7822|app: 0|req: 2\/2] 192.168.86.24 () {32 vars in 574 bytes} [Wed Jan\u00a0 <\/span>1 12:16:55 2020] GET \/favicon.ico => generated 233 bytes in 330 msecs (HTTP\/1.1 404) 2 headers in 72 bytes (1 switches on core 0)<\/span><\/pre>\n
Oh, and your HDMI display is now off \ud83d\ude42 Type ctrl-C in your ssh session to stop the uWSGI test server. To make things more robust we’re now going to integrate uWSGI with the nginx web server.<\/p>\n
nginx integration<\/h2>\n
If you didn’t download the project from git then you’ll need to create a file uwsgi.ini in the directory containing your .py file:<\/p>\n
[uwsgi]<\/span>\nchdir = \/home\/pi\/Documents\/pirest<\/span>\nmodule = api:app<\/span>\nmaster = true<\/span>\nprocesses = 1<\/span>\nthreads = 2<\/span>\n\nuid = www-data<\/span>\ngid = www-data<\/span>\n\nsocket = \/tmp\/pirest.sock<\/span>\nchmod-socket = 664<\/span>\nvacuum = true<\/span>\ndie-on-term = true<\/span>\ntouch-reload = \/home\/pi\/Documents\/pirest\/api.py<\/span><\/pre>\n
This will provide the startup instructions for uwsgi when invoked from nginx.
Now we’ll get rid of the default nginx site<\/p>\n
sudo rm \/etc\/nginx\/sites-enabled\/default<\/pre>\n
and now create a proxy file<\/p>\n
sudo nano \/etc\/nginx\/sites-available\/pirest_proxy<\/span><\/pre>\n
containing the following:<\/p>\n
server {<\/span>\nlisten 80;<\/span>\nserver_name localhost;<\/span>\nlocation \/ { try_files $uri @app; }<\/span>\nlocation @app {<\/span>\ninclude uwsgi_params;<\/span>\nuwsgi_pass unix:\/tmp\/pirest.sock;<\/span>\n}<\/span>\n}<\/span><\/pre>\n
Now we need to create a symbolic link to this file<\/p>\n
sudo ln -s \/etc\/nginx\/sites-available\/pirest_proxy \/etc\/nginx\/sites-enabled<\/pre>\n
then restart nginx<\/p>\n
sudo systemctl restart nginx<\/pre>\n
Set uWSGI to run on boot<\/h3>\n
cd \/etc\/systemd\/system<\/pre>\n
sudo nano uwsgi.service<\/pre>\n
and into this new file, paste the following:<\/p>\n
[Unit]<\/span>\nDescription=uWSGI Service<\/span>\nAfter=network.target<\/span>\n\n[Service]<\/span>\nUser=pi<\/span>\nGroup=www-data<\/span>\nWorkingDirectory=\/home\/pi\/Documents\/pirest<\/span>\nExecStart=\/usr\/local\/bin\/uwsgi --ini \/home\/pi\/Documents\/pirest\/uwsgi.ini<\/span>\nEnvironment=\"PATH=\/usr\/local\/sbin:\/usr\/local\/bin:\/usr\/sbin:\/usr\/bin:\/sbin:\/bin:$<\/span>\n\n[Install]<\/span>\nWantedBy=multi-user.target<\/span><\/pre>\n
restart the daemon so the new configuration is picked up:<\/p>\n
sudo systemctl daemon-reload<\/pre>\n
and start the service we’ve just defined:<\/p>\n
sudo systemctl start uwsgi.service<\/pre>\n
You can check the status of the running service like this:<\/p>\n
sudo systemctl status uwsgi.service<\/pre>\n
you should see something like this:<\/p>\n
?<\/b><\/span> uwsgi.service - uWSGI Service<\/span>\n \u00a0 <\/span>Loaded: loaded (\/etc\/systemd\/system\/uwsgi.service; disabled; vendor preset: enabled)<\/span>\n \u00a0 <\/span>Active: <\/span>active (running)<\/b><\/span> since Wed 2020-01-01 12:49:52 CST; 1min 3s ago<\/span>\n\n Main PID: 8038 (uwsgi)<\/span>\n \u00a0 <\/span>Memory: 13.1M<\/span>\n \u00a0 <\/span>CGroup: \/system.slice\/uwsgi.service<\/span>\n \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>??8038 \/usr\/local\/bin\/uwsgi --ini \/home\/pi\/Documents\/pirest\/uwsgi.ini<\/span>\n \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <\/span>??8044 \/usr\/local\/bin\/uwsgi --ini \/home\/pi\/Documents\/pirest\/uwsgi.ini<\/span>\nJan 01 12:49:55 piboard02 uwsgi[8038]: mapped 143936 bytes (140 KB) for 2 cores<\/span>\nJan 01 12:49:55 piboard02 uwsgi[8038]: *** Operational MODE: threaded ***<\/span>\nJan 01 12:50:07 piboard02 uwsgi[8038]: WSGI app 0 (mountpoint='') ready in 12 seconds on interpreter 0x16984f0 pid: 8038 (de<\/span>\nJan 01 12:50:07 piboard02 uwsgi[8038]: *** uWSGI is running in multiple interpreter mode ***<\/span>\nJan 01 12:50:07 piboard02 uwsgi[8038]: spawned uWSGI master process (pid: 8038)<\/span>\nJan 01 12:50:07 piboard02 uwsgi[8038]: spawned uWSGI worker 1 (pid: 8044, cores: 2)<\/span>\nJan 01 12:50:07 piboard02 uwsgi[8038]: display_power=0<\/span>\nJan 01 12:50:07 piboard02 uwsgi[8038]: [pid: 8044|app: 0|req: 1\/1] 192.168.86.24 () {42 vars in 767 bytes} [Wed Jan\u00a0 <\/span>1 12:50<\/span>\nJan 01 12:50:15 piboard02 uwsgi[8038]: display_power=1<\/span>\nJan 01 12:50:15 piboard02 uwsgi[8038]: [pid: 8044|app: 0|req: 2\/2] 192.168.86.24 () {40 vars in 734 bytes} [Wed Jan\u00a0 <\/span>1 12:50<\/span>\nlines 1-19\/19 (END)<\/span><\/pre>\n
You’ll see here that I tried the service on and off by entering this URL in my browser:<\/p>\n
http:\/\/piboard02\/screen\/on<\/pre>\n
The final step is to ensure that this starts with every boot:<\/p>\n
sudo systemctl enable uwsgi.service<\/pre>\n
and you’ll see something along these lines:<\/p>\n
\u201cCreated symlink \/etc\/systemd\/system\/multi-user.target.wants\/uwsgi.service \/etc\/systemd\/system\/uwsgi.service\u201d<\/pre>\n
Reboot and test using the URL – give it time to boot, especially if using a pi zero as they’re pretty slow.<\/p>\n
SmartThings Integration<\/h1>\n
Device Handler<\/h2>\n
OK, so you’ve got a pi running a display board, and you can turn the HDMI output on and off by opening a URL. Now to create a device handler for SmartThings that enables you to include this in automations, and of course control it from your SmartThings app.<\/p>\n
Go grab the source over at my github repo<\/a>. For now, I’m going to assume the reader knows how to create an account at the Samsung developer site\u00a0https:\/\/graph.api.smartthings.com\/<\/a><\/p>\n
\"\"<\/a><\/p>\n
Go to My Device Handlers, and Create – From Code, then paste the code from Git. Or, you could just import my repo into your account. You’ll then need to publish it, choosing “just me” should be sufficient.<\/p>\n
\"\"<\/a><\/p>\n
New Device<\/h2>\n
Using the IDE, create a new device:<\/p>\n
\u00a0<\/p>\n\n\n
\"\"<\/figure>\n\n\n\n
Complete the new device screen – use your own values for Network ID (which must be unique), name, label, etc. I’ve used IP address for network ID, but what you use actually doesn’t matter.<\/p>\n\n\n\n
When you get to the Type pulldown, scroll all the way down past the commercial handlers until you see the REST Switch device handler we just created. Location and Hub must be set to your SmartThings hub, you’ll typically only see a single choice in those pulldowns.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Click on the Edit link alongside Settings in the device display, and then enter the IP address and port 80 for your Pi. Your hub must be on the same network as your pi, as the hub itself will run the device handler code we just established.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
After a couple of minutes the newly created device should appear in your app:<\/p>\n\n\n\n
\"\"<\/figure>\n","protected":false},"excerpt":{"rendered":"
If you’ve ever fancied a digital display frame, but perhaps wanted more than just a simple carousel of your pictures, or greater control over […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"wpupg_custom_link":[],"wpupg_custom_link_behaviour":[],"wpupg_custom_link_nofollow":[],"wpupg_custom_image":[],"wpupg_custom_image_id":[],"advanced_seo_description":"","jetpack_seo_html_title":"","jetpack_seo_noindex":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[3],"tags":[45,46],"class_list":["post-499","post","type-post","status-publish","format-standard","hentry","category-technique","tag-dakboard","tag-raspberry-pi"],"acf":[],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/pePLXi-83","jetpack-related-posts":[],"_links":{"self":[{"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=\/wp\/v2\/posts\/499","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=499"}],"version-history":[{"count":7,"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=\/wp\/v2\/posts\/499\/revisions"}],"predecessor-version":[{"id":516,"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=\/wp\/v2\/posts\/499\/revisions\/516"}],"wp:attachment":[{"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=499"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=499"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.captainsglen.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=499"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}