diff --git a/README.md b/README.md index 6bd47b8..d41f7b2 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,13 @@ Main goal is to run a slideshow presenting end-user customizable contents with l * Raspberry Pi computer with Power supply, HDMI cable and SD-Card * Display with HDMI input (best with HDMI CEC support) -* this can be a dedicated computer monitor or a TV Set -* the Display should support FullHD Resolution (native 1920x1080) +* this can be a dedicated computer monitor or a TV Set +* the Display should support FullHD Resolution (native 1920x1080) * LAN or WLAN connection * Mouse and Keyboard only needed for initial setup * VLC Application (included in Full Raspian Image) * Python-VLC module (needs to be installed during setup) +* Python-crontab module (needs to be installed * Cloud account for automated media update (we suggest to use "Grüne Wolke") * The media files need to be provided as ZIP-File containing the images and videos @@ -49,30 +50,32 @@ Main goal is to run a slideshow presenting end-user customizable contents with l * It can be configured for a safe shut down at night time (reduce light pollution) * A diplay supporting HDMI CEC will automatically switch to StandBy * Power for Raspberry Pi and display shall be turned off by a timer device -* set the timer a few minutes after scheduled shut down of the Raspberry Pi computer -* when the power is switched back on in the morning, The slideshow will autoomatically start and in background update the media files +* set the timer a few minutes after scheduled shut down of the Raspberry Pi computer +* when the power is switched back on in the morning, The slideshow will autoomatically start and in background update the media files ## Development Environment * The project is developed on a Raspberry Pi 400, any Raspberry Pi model (except Pico) is fine * The project is intended to run on Raspbian Linux -* support for other platforms is possible, but not tested +* support for other platforms is possible, but not tested ## TODOs -* setup script -* run p3 install python-vlc -* add the script to auto-start -* run configuration script -* configuration script -* add cronjob for safe shutdown at given time -* add remote URL to config file, validating, that the URL points to a ZIP file. -* improve initial startup -* so far only dummy images for intial slideshow -* provide manual in media slides and as documentation (Wiki?) -* tutorials and other on-boarding guides (maybe with "Grünstreifen") -* testing, testing -* and more testing in real world ;-) +- [x] create setup script *(setup.py)* +- [x] run pip3 install python-vlc +- [x] run pip3 install python-crontab +- [x] add green-signals to auto-start +- [x] write configuration file +- [x] user friendly GUI +- [x] configuration script *(included in setup.py)* +- [ ] add cronjob for safe shutdown at given time +- [ ] validation that remote URL points to a ZIP file. +- [ ] improve on-barding +- [ ] so far only dummy images for intial slideshow +- [ ] provide manual in media slides and as documentation (Wiki?) +- [ ] tutorials and other on-boarding guides (maybe with "Grünstreifen") +- [ ] testing, testing +- [ ] and more testing in real world ;-) ## Contact: Chatbegruenung, Channel netzbegruenung-digitalsignage