diff --git a/README.md b/README.md index a155144d..118a3b5c 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,66 @@ Upload the tft file from HMI folder to a Webserver (for example www folder of Ho `FlashNextion http://192.168.75.30:8123/local/nspanel.tft` -## 3. Setup Node-Red Flow +## 3. Setup your Backend + +The Backend answers to commands from NsPanel and send's content to display on the screen. + +## 3a. AppDeamon Backend (Recommended) + +### Installation + + + +### App Configuration + +```yaml +nspanel-1: + module: nspanel-lovelance-ui + class: NsPanelLovelanceUIManager + config: + panelRecvTopic: "tele/tasmota_your_mqtt_topic/RESULT" + panelSendTopic: "cmnd/tasmota_your_mqtt_topic/CustomSend" + timeoutScreensaver: 15000 + #brightnessScreensaver: 10 + brightnessScreensaver: + - time: "7:00:00" + value: 10 + - time: "23:00:00" + value: 0 + locale: "de_DE" + timeFormat: "%H : %M" + dateFormat: "%A, %d. %B %Y" + pages: + - type: cardEntities + heading: Example Page 1 + items: + - cover.example_cover + - switch.example_switch + - input_boolean.example_input_boolean + - sensor.example_sensor + - type: cardEntities + heading: Example Page 1 + items: + - button.example_button + - cover.rolladenterasse_cover_1 + - light.schreibtischlampe + - delete + - type: cardThermo + heading: Exmaple Thermostat + item: climate.example_climate + - type: cardMedia + heading: Exampe Media + item: media_player.spotify_user +``` + +key | optional | type | default | description +-- | -- | -- | -- | -- +`module` | False | string | | The module name of the app. +`class` | False | string | | The name of the Class. +`config` | False | complex | | Config/Mapping between Homeassistant and your NsPanel + + +## 3b. Node Red Flow (Deprecated, but functional with limited Feature Set) Import the example node-red flow from "node-red-example-flow.json" file and adjust to your needs. diff --git a/appdaemon/apps/apps.yaml b/appdaemon/apps.yaml similarity index 100% rename from appdaemon/apps/apps.yaml rename to appdaemon/apps.yaml diff --git a/appdaemon/apps/nspanel.py b/apps/nspanel-lovelance-ui/nspanel-lovelance-ui.py similarity index 100% rename from appdaemon/apps/nspanel.py rename to apps/nspanel-lovelance-ui/nspanel-lovelance-ui.py