CEC Script install doco

Author: petersem

README.md

@@ -3,7 +3,7 @@
 
 ![Docker Pulls](https://img.shields.io/docker/pulls/petersem/posterr) 
 ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/petersem/posterr/latest?logo=docker) 
-![Image Build](https://img.shields.io/github/workflow/status/petersem/posterr/ci?color=green)
+![GitHub Stars](https://img.shields.io/github/stars/petersem/posterr?style=flat)
 ![Version](https://img.shields.io/github/package-json/v/petersem/posterr?logoColor=blue)
 ![GitHub last commit](https://img.shields.io/github/last-commit/petersem/posterr)
 ![Platforms](https://img.shields.io/badge/platform-docker-blue)
@@ -39,7 +39,9 @@
  - Support LED Matrix displays running Awtrix software
  - Display custom web pages as slides (if web page compatible) - **EXPERIMENTAL!**
  - Rotate display -90° (for running on display devices, like Firesticks, which do not support portait rotation)
- - Post API (at '/api/sleep') to toggle sleep mode. (Pass in header 'psw: your Posterr password')
+ - Post API (at '/api/sleep') to toggle sleep mode. (Pass in header values `'psw: your Posterr password'` and `'sleep: true|false'`)
+ - Get API at the same endpoint will return the sleep status without any parsed parameters.
+ - Supports `CEC` control of monitor inconjunction with the Posterr `Sleep Timer`. 
 ---
 ## Prerequisites
 ### Mandatory
@@ -104,6 +106,10 @@ petersem/posterr
 ### <ins>Unraid</ins>
  - Use the Posterr template in community apps. (Being replaced with new version)
 
+---
+## CEC Control script installation **(rPi only)**
+ - Install instructions are located [HERE](/scripts/scriptdoco.md)
+
 ---
 ## Updates
  - From v1.10.1, there will be a notice at the top of the settings screen informing you if you are running an old version. 

scripts/scriptdoco.md

@@ -0,0 +1,69 @@
+
+# Posterr Script - Download and start install steps
+## What is this?
+If you implement the `Sleep Timer` feature in Posterr, the screen is blanked out, but still powered on. This script uses the [`CEC`](https://support.google.com/chromecast/answer/7199917?hl=en#:~:text=CEC%20(Consumer%20Electronics%20Control)%20allows,Google%20streaming%20device%20is%20connected.) feature of your HDMI connected display to put the display in standby mode. This will save power and increase the longevity of your display.
+
+*Posterr scripts are designed to work on a rPi with a connected CEC compatible display.* 
+
+## Compatibility
+There are items required for the script 
+- These scripts will only work on a `Raspberry Pi 4/5`, that is being used to display Posterr
+- The operating system should be `PI OS` or `PI OS Lite`. 
+- Displays connected via HDMI.
+- The monitor or tv being used must support CEC control.
+- The `cec-utils` package is required for this script to work. 
+*(the install script will install this if needed)* 
+
+## Get the Posterr scripts 
+### Download
+```
+cd ~/
+curl -sSL https://raw.githubusercontent.com/petersem/posterr/master/scripts/rpiwatcherservice.tar.gz -o rpiwatcherservice.tar.gz 
+mkdir ~/posterr-scripts
+```
+### Decompress
+```
+tar -xvf rpiwatcherservice.tar.gz -C ~/posterr-scripts
+``` 
+### Set script permissions
+```
+cd ~/posterr-scripts
+sudo chmod 777 sleepwatch-install-service.sh
+sudo chmod +X sleepwatch-install-service.sh
+```
+### Start installation
+```
+./sleepwatch-install-service.sh
+```
+> 
+> Installation script **MUST** run as your standard user, not with sudo
+> 
+## Uninstall
+To uninstall the Poster Script, run the remove script and then delete the poster-scripts folder
+```
+~/posterr-scripts/sleepwatch-remove-service.sh
+cd ~
+sudo rm -R posterr-scripts
+```
+## Troubleshooting
+- Limited support is available on [Discord](https://discord.gg/TcnEkMEf9J).
+- Run the following command to check the status of the service.
+```
+sudo systemctl status posterr-watcher.service
+``` 
+
+## Technical Details
+- This script implements a `systemd service` which runs the `~/poster-scripts/sleepwatch.sh script`. 
+- The sleepwatch script polls a Posterr API ever 5 seconds to determine if Posterr is in scheduled sleep mode or not. It then issues an `on` or `standby` command to the attached display.
+
+The script does the following:
+- Gathers the URL for Posterr, current user and home directory
+- Substitutes values and creates the 'sleepwatch.sh' file.
+- Substitutes values into the service `unit` file 
+- Restarts as `super user` (required for installation)
+- Installs `cec-utils` if not nstalled.
+- Copies the `unit` file, installs, then starts the service. 
+
+> ## *This is a new feature and script, so let me know how you go on Discord.*
+
+[Return to main page](/README.md)