NB-Public/green-signals
53
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

updated ReadMe

Browse source
This commit is contained in:
Stefan Schmidt-Bilkenroth 2021-04-06 21:21:51 +02:00
parent a5025dfd12
commit 47a14e166f
1 changed files with 21 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -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 * Raspberry Pi computer with Power supply, HDMI cable and SD-Card
* Display with HDMI input (best with HDMI CEC support) * Display with HDMI input (best with HDMI CEC support)
* this can be a dedicated computer monitor or a TV Set * this can be a dedicated computer monitor or a TV Set
* the Display should support FullHD Resolution (native 1920x1080) * the Display should support FullHD Resolution (native 1920x1080)
* LAN or WLAN connection * LAN or WLAN connection
* Mouse and Keyboard only needed for initial setup * Mouse and Keyboard only needed for initial setup
* VLC Application (included in Full Raspian Image) * VLC Application (included in Full Raspian Image)
* Python-VLC module (needs to be installed during setup) * 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") * 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 * 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) * 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 * A diplay supporting HDMI CEC will automatically switch to StandBy
* Power for Raspberry Pi and display shall be turned off by a timer device * 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 * 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 * when the power is switched back on in the morning, The slideshow will autoomatically start and in background update the media files
## Development Environment ## Development Environment
* The project is developed on a Raspberry Pi 400, any Raspberry Pi model (except Pico) is fine * 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 * 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 ## TODOs
* setup script - [x] create setup script *(setup.py)*
* run p3 install python-vlc - [x] run pip3 install python-vlc
* add the script to auto-start - [x] run pip3 install python-crontab
* run configuration script - [x] add green-signals to auto-start
* configuration script - [x] write configuration file
* add cronjob for safe shutdown at given time - [x] user friendly GUI
* add remote URL to config file, validating, that the URL points to a ZIP file. - [x] configuration script *(included in setup.py)*
* improve initial startup - [ ] add cronjob for safe shutdown at given time
* so far only dummy images for intial slideshow - [ ] validation that remote URL points to a ZIP file.
* provide manual in media slides and as documentation (Wiki?) - [ ] improve on-barding
* tutorials and other on-boarding guides (maybe with "Grünstreifen") - [ ] so far only dummy images for intial slideshow
* testing, testing - [ ] provide manual in media slides and as documentation (Wiki?)
* and more testing in real world ;-) - [ ] tutorials and other on-boarding guides (maybe with "Grünstreifen")
- [ ] testing, testing
- [ ] and more testing in real world ;-)
## Contact: ## Contact:
Chatbegruenung, Channel netzbegruenung-digitalsignage Chatbegruenung, Channel netzbegruenung-digitalsignage