mirror of
https://github.com/joBr99/nspanel-lovelace-ui.git
synced 2025-12-19 22:24:15 +01:00
upd docs
This commit is contained in:
@@ -0,0 +1,20 @@
|
||||
# Alarm Card
|
||||
|
||||

|
||||
|
||||
```yaml
|
||||
cards:
|
||||
- type: cardAlarm
|
||||
title: Alarm Test 1
|
||||
entity: alarm_control_panel.alarmo
|
||||
```
|
||||
|
||||
List of supported config keys of this card:
|
||||
|
||||
key | optional | type | default | description
|
||||
-- | -- | -- | -- | --
|
||||
`type` | False | string | `None` | Used by navigate items
|
||||
`title` | True | string | `None` | Title of the Page
|
||||
`entity` | False | string | `None` | contains the entity of the current card
|
||||
`key` | True | string | `None` | Used by navigate items
|
||||
`alarmControl` | True | complex | `None` | overwrites the action executed on pressing the left bottom icon, by default this button is used to show a list of open sensors on a failed attempt to arm.
|
||||
@@ -1,2 +1,26 @@
|
||||
# Climate/Thermo Card
|
||||
|
||||

|
||||
|
||||
```yaml
|
||||
cards:
|
||||
- type: cardThermo
|
||||
title: HeatPump
|
||||
entity: climate.heatpump
|
||||
- type: cardThermo
|
||||
title: HvaC
|
||||
entity: climate.hvac
|
||||
- type: cardThermo
|
||||
title: ecobee
|
||||
entity: climate.ecobee
|
||||
```
|
||||
|
||||
List of supported config keys of this card:
|
||||
|
||||
key | optional | type | default | description
|
||||
-- | -- | -- | -- | --
|
||||
`type` | False | string | `None` | Type of the card
|
||||
`entities` | False | complex | `None` | contains a list of entities of this card
|
||||
`title` | True | string | `None` | Title of the Page
|
||||
`temperatureUnit` | True | string | `celsius` | set this to fahrenheit to change the temperatureUnit on the page
|
||||
`key` | True | string | `None` | Used by navigate items in combination with the type (cardEntities_key)
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||

|
||||
|
||||
```
|
||||
```yaml
|
||||
cards:
|
||||
- type: cardEntities
|
||||
title: Test Entities Card
|
||||
@@ -38,4 +38,5 @@ List of supported entitiy types for this page:
|
||||
- input_text (read-only)
|
||||
- lock
|
||||
- fan
|
||||
- automation
|
||||
- automation
|
||||
- iText
|
||||
@@ -2,8 +2,7 @@
|
||||
|
||||

|
||||
|
||||
|
||||
```
|
||||
```yaml
|
||||
cards:
|
||||
- type: cardGrid
|
||||
title: Test Grid Card
|
||||
@@ -44,4 +43,5 @@ List of supported entitiy types for this page:
|
||||
- light
|
||||
- input_text (read-only)
|
||||
- lock
|
||||
- automation
|
||||
- automation
|
||||
- iText
|
||||
@@ -0,0 +1,19 @@
|
||||
# Alarm Card
|
||||
|
||||

|
||||
|
||||
```yaml
|
||||
cards:
|
||||
- type: cardMedia
|
||||
entity: media_player.spotify
|
||||
```
|
||||
|
||||
List of supported config keys of this card:
|
||||
|
||||
key | optional | type | default | description
|
||||
-- | -- | -- | -- | --
|
||||
`type` | False | string | `None` | Used by navigate items
|
||||
`title` | True | string | `None` | Title of the Page
|
||||
`entity` | False | string | `None` | contains the entity of the current card
|
||||
`key` | True | string | `None` | Used by navigate items
|
||||
`alarmControl` | True | complex | `None` | overwrites the action executed on pressing the left bottom icon, by default this button is used to show a list of open sensors on a failed attempt to arm.
|
||||
@@ -0,0 +1,46 @@
|
||||
# WiFi / QR Card
|
||||
|
||||

|
||||
|
||||
```yaml
|
||||
cards:
|
||||
- type: cardQR
|
||||
title: Guest Wifi
|
||||
qrCode: "WIFI:S:test_ssid;T:WPA;P:test_pw;;"
|
||||
entities:
|
||||
- entity: iText.test_ssid
|
||||
name: Name
|
||||
icon: mdi:wifi
|
||||
- entity: iText.test_pw
|
||||
name: Password
|
||||
icon: mdi:key
|
||||
```
|
||||
|
||||
List of supported config keys of this card:
|
||||
|
||||
key | optional | type | default | description
|
||||
-- | -- | -- | -- | --
|
||||
`type` | False | string | `None` | Used by navigate items
|
||||
`entities` | False | complex | `None` | contains entities of the card, only valid on cardEntities and cardGrid and cardQR
|
||||
`title` | True | string | `None` | Title of the Page
|
||||
`key` | True | string | `None` | Used by navigate items
|
||||
`qrCode` | False | string | `None` | Value of the qrCode
|
||||
|
||||
List of supported entitiy types for this page:
|
||||
|
||||
- switch
|
||||
- input_boolean
|
||||
- binary_sensor
|
||||
- sensor
|
||||
- button
|
||||
- scenes
|
||||
- script
|
||||
- input_button
|
||||
- light
|
||||
- input_text (read-only)
|
||||
- lock
|
||||
- automation
|
||||
|
||||
The qrCode value is evaluated as a homeassistant Template, so it is possible to get values from HomeAssistant within the qrCode.
|
||||
|
||||
`"WIFI:S:{{states('input_text.test_ssid')}};T:WPA;P:{{states('input_text.test_pw')}};;"`
|
||||
25
docs/faq.md
25
docs/faq.md
@@ -4,6 +4,31 @@
|
||||
|
||||
Please check your MQTT Topics in your apps.yaml and your mqtt configuration on tasmota.
|
||||
|
||||
## How to update
|
||||
|
||||
### Update AppDaemon Script
|
||||
|
||||
HACS will show you that there is an update avalible and ask you to update. It is important to restart the AppDaemon Container afterwards.
|
||||
|
||||
### Update Display Firmware
|
||||
|
||||
You should get an notification on the screen, asking you to update the firmware. In case you want to update manually you can use the following commands.
|
||||
|
||||
EU Version: `FlashNextion http://nspanel.pky.eu/lui-release.tft`
|
||||
|
||||
US Version Portrait: `FlashNextion http://nspanel.pky.eu/lui-us-p-release.tft`
|
||||
|
||||
US Version Landscape: `FlashNextion http://nspanel.pky.eu/lui-us-l-release.tft`
|
||||
|
||||
### Update Tasmota Berry Driver
|
||||
|
||||
You should get an notification on the screen, asking you to update the driver, if an update is needed.
|
||||
|
||||
You can update the berry driver directly from the Tasmota Console with the following command.
|
||||
|
||||
`UpdateDriverVersion https://raw.githubusercontent.com/joBr99/nspanel-lovelace-ui/main/tasmota/autoexec.be`
|
||||
|
||||
|
||||
## How to upgrade from a release to the current development version
|
||||
|
||||
1. Update App in HACS to main
|
||||
|
||||
BIN
docs/img/card-thermo.png
Normal file
BIN
docs/img/card-thermo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
85
docs/notifications.md
Normal file
85
docs/notifications.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# Sending Notifications to the Panel
|
||||
|
||||
There are two notification types, that can be triggered by sending a command over mqtt to the panel here are examples for homeassistant scripts:
|
||||
|
||||
<details>
|
||||
<summary>Seperate Page</summary>
|
||||
<br>
|
||||
|
||||
This is the notification used by the backend for updates, opening it requires to the following commands to the CustomSend Topic:
|
||||
|
||||
`pageType popupNotify`
|
||||
|
||||
`entityUpdateDetail~internalName~heading~headingColor~button1text~button1color~button2text~tB2Color~notificationText~textColor~sleepTimeout`
|
||||
|
||||
It is possible to exit from the page by sending `exitPopup`
|
||||
|
||||
Send Message to the Panel combined with a buzzer sound:
|
||||
|
||||
```yaml
|
||||
nspanel_popup_notification:
|
||||
alias: Popup Notification
|
||||
sequence:
|
||||
- service: mqtt.publish
|
||||
data:
|
||||
topic: cmnd/tasmota_NsPanelTerrasse/Backlog
|
||||
payload: CustomSend pageType~popupNotify; CustomSend entityUpdateDetail~id~{{
|
||||
title }}~65535~~~~~{{ message }}~65535~{{ timeout }}; Buzzer 2,2,2
|
||||
mode: single
|
||||
icon: mdi:message-badge
|
||||
```
|
||||
|
||||
Send Message to the Panel:
|
||||
|
||||
```yaml
|
||||
nspanel_popup_notification:
|
||||
alias: Popup Notification
|
||||
sequence:
|
||||
- service: mqtt.publish
|
||||
data:
|
||||
topic: cmnd/tasmota_NsPanelTerrasse/Backlog
|
||||
payload: CustomSend pageType~popupNotify; CustomSend entityUpdateDetail~id~{{
|
||||
title }}~65535~~~~~{{ message }}~65535~{{ timeout }}
|
||||
mode: single
|
||||
icon: mdi:message-badge
|
||||
```
|
||||
</details>
|
||||
|
||||
|
||||
<details>
|
||||
<summary>Notification on screensaver</summary>
|
||||
<br>
|
||||
|
||||
The screensaver can display Notifications by sending this command to the CustomSend topic: `notify~heading~text`
|
||||
|
||||
|
||||
Send Message to the Screensaver combined with a buzzer sound:
|
||||
|
||||
```yaml
|
||||
nspanel_screensaver_notification:
|
||||
alias: Screensaver Notification
|
||||
sequence:
|
||||
- service: mqtt.publish
|
||||
data:
|
||||
topic: cmnd/tasmota_NsPanelTerrasse/Backlog
|
||||
payload: CustomSend notify~{{ heading }}~{{ message }}; Buzzer 2,2,2
|
||||
mode: single
|
||||
icon: mdi:message-badge
|
||||
```
|
||||
|
||||
Send Message to the Screensaver:
|
||||
|
||||
```yaml
|
||||
nspanel_screensaver_notification:
|
||||
alias: Screensaver Notification
|
||||
sequence:
|
||||
- service: mqtt.publish
|
||||
data:
|
||||
topic: cmnd/tasmota_NsPanelTerrasse/Backlog
|
||||
payload: CustomSend notify~{{ heading }}~{{ message }}
|
||||
mode: single
|
||||
icon: mdi:message-badge
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# Change behaviour of hardware buttons
|
||||
|
||||
## Tasmota Rules
|
||||
|
||||
You can configure the buttons to mimic an UI element on the screen by configuring tasmota rules.
|
||||
|
||||
The following rule will change the behaviour of the two buttons to do page navigation.
|
||||
|
||||
```
|
||||
Rule2 on Button1#state do Publish tele/%topic%/RESULT {"CustomRecv":"event,buttonPress2,hwbtn,bPrev"} endon on Button2#state do Publish tele/%topic%/RESULT {"CustomRecv":"event,buttonPress2,hwbtn,bNext"} endon
|
||||
|
||||
Rule2 1
|
||||
```
|
||||
|
||||
## Decouple buttons from controlling power outputs
|
||||
|
||||
If you do not want your NSPanel physical buttons to trigger the relays and prefer to have them as software configurable buttons, open the Tasmota console of your NSPanel and enter the following:
|
||||
|
||||
`SetOption73 1`
|
||||
|
||||
Your relays will now appear as switches in HomeAssistant and you can control your buttons by using automations:
|
||||
|
||||

|
||||
|
||||
You may reverse this change by entering the following in the Tasmota console of your NSPanel:
|
||||
|
||||
`SetOption73 0`
|
||||
|
||||
Please note: Doing this will mean that if HomeAssistant is not working for any reason your buttons will not function correctly.
|
||||
|
||||
18
docs/subpages.md
Normal file
18
docs/subpages.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Subpages
|
||||
|
||||
You can configure entities with with the prefix `navigate`, that are navigating to cards, in case it's hidden card, the navigation items will change and the arrow is bringing you back to the privious page.
|
||||
|
||||
```yaml
|
||||
- entity: navigate.cardGrid_testKey
|
||||
```
|
||||
|
||||
will allow you to navigate to a cardGrid page with the configured key testKey
|
||||
|
||||
```yaml
|
||||
hiddenCards:
|
||||
- type: cardGrid
|
||||
title: Exmaple Grid
|
||||
entities:
|
||||
- entity: light.test_item
|
||||
key: testKey
|
||||
```
|
||||
Reference in New Issue
Block a user