docs
BIN
HMI/nspanel.HMI
77
README.md
@@ -6,9 +6,15 @@
|
|||||||
|
|
||||||
NsPanel Lovelace UI is a Firmware for the nextion screen inside of NSPanel in the Design of [HomeAssistant](https://www.home-assistant.io/)'s Lovelace UI Design.
|
NsPanel Lovelace UI is a Firmware for the nextion screen inside of NSPanel in the Design of [HomeAssistant](https://www.home-assistant.io/)'s Lovelace UI Design.
|
||||||
|
|
||||||
|
See the following picture to get an idea of the look of this firmware for NSPanel.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
It works with [Tasmota](https://tasmota.github.io/docs/) over MQTT.
|
It works with [Tasmota](https://tasmota.github.io/docs/) over MQTT.
|
||||||
To control the panel and update it with content from HomeAssistant there is an [AppDeamon](https://github.com/AppDaemon/appdaemon) App.
|
To control the panel and update it with content from HomeAssistant there is an [AppDeamon](https://github.com/AppDaemon/appdaemon) App.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- [How It Works](#how-it-works)
|
- [How It Works](#how-it-works)
|
||||||
- [Requirements](#requirements)
|
- [Requirements](#requirements)
|
||||||
|
|
||||||
@@ -181,41 +187,32 @@ Upload the [tft file from HMI folder](HMI/nspanel.tft) to a Webserver (for examp
|
|||||||
|
|
||||||
### Configuring the MQTT integration in AppDaemon
|
### Configuring the MQTT integration in AppDaemon
|
||||||
|
|
||||||
|
For the app to work you need a working MQTT Configuration in AppDaemon. Please configure mqtt server, user and password in `appdaemon.yaml`
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
plugins:
|
||||||
|
HASS:
|
||||||
|
type: hass
|
||||||
|
MQTT:
|
||||||
|
type: mqtt
|
||||||
|
namespace: mqtt
|
||||||
|
client_id: "appdaemon"
|
||||||
|
client_host: 192.168.75.30
|
||||||
|
client_port: 1883
|
||||||
|
client_user: "mqttuser"
|
||||||
|
client_password: "mqttpassword"
|
||||||
|
client_topics: NONE
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
```
|
||||||
|
|
||||||
### Configure your NSPanel in AppDaemon
|
### Configure your NSPanel in AppDaemon
|
||||||
|
|
||||||
|
Confiure your NSPanel as you like, you need to edit the `apps.yaml` inside of your appdeamon config folder.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Old Docs
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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
|
```yaml
|
||||||
nspanel-1:
|
nspanel-1:
|
||||||
@@ -264,6 +261,20 @@ key | optional | type | default | description
|
|||||||
`config` | False | complex | | Config/Mapping between Homeassistant and your NsPanel
|
`config` | False | complex | | Config/Mapping between Homeassistant and your NsPanel
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 3b. Node Red Flow (Deprecated, but functional with limited Feature Set)
|
## 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.
|
Import the example node-red flow from "node-red-example-flow.json" file and adjust to your needs.
|
||||||
|
|||||||
BIN
doc-pics/screen_cardEntities1.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
doc-pics/screen_cardEntities2.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
doc-pics/screen_cardMedia.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 7.5 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 8.3 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 7.7 KiB |
BIN
doc-pics/screens.png
Normal file
|
After Width: | Height: | Size: 109 KiB |