247 lines
10 KiB
Markdown
247 lines
10 KiB
Markdown
|
|
# Introduction
|
|
In this document, we collect important information, tips, and solutions related to various topics noticed over time. This is a community-driven resource, and we encourage everyone to contribute their knowledge.
|
|
|
|
## Community Contribution
|
|
If you have a solution or tip to share, please contribute! Your knowledge can significantly help others in the community. You can write a short message with your findings, and we'll include it here.
|
|
|
|
# Topics and Solutions
|
|
Below are the topics covered in this document, each with relevant tips and solutions.
|
|
|
|
1. [How do I create "Issues" when I have a problem ](#How-do-I-create-issues-when-I-have-a-problem)
|
|
1. [Update Blueprint](#Update-blueprint)
|
|
1. [Update ESPHome](#Update-esphome)
|
|
1. [Update TFT](#Update-tft)
|
|
1. [Notification via HA](#notification-via-ha)
|
|
1. [Climate control with relays](#climate-control-with-relays)
|
|
1. [Call a page directly](#Call-a-page-directly)
|
|
1. [Play RTTTL Sound](#play-rtttl-sound)
|
|
1. [Start automations via Input_Boolean](#Start-automations-via-input_boolean)
|
|
|
|
|
|
## How to create "issues" when I have a problem
|
|
|
|
> _**To be able to solve your problem, it is important for us to have as much information as possible**_.
|
|
|
|
* Describe your problem as detailed as possible.
|
|
* Please write your ESPHome and Home Assistant version, as the version of files of this project (TFT, ESPHome and Blueprint).
|
|
* Please go to your automation and then to the "3 dots" and then to _**Edit as YAML**_. Copy the complete code and attach it to the ticket
|
|
* An important "helper" for solving problems is the trace of an automation. You can find the trace under _**Settings --> Automations & Scenes --> your NSPanel automation --> Traces (top right)**_
|
|
|
|
> TRACES! Please execute again what does not work and open the trace immediately afterwards. Often you have to open the trace after the reboot too. During the start up, most things are loaded.
|
|
|
|
> IMPORTANT! in the trace you can see by the _**"orange "**_ lines which way the automation has gone. Please tell us this path. Also, please take one or more screenshots and add them to your ticket. Especially important for us is where the _**"Orange "**_ line ends, because most of the time this is also where the problem is.
|
|
|
|
> IMPORTANT! When you have opened the trace, there is a _**"timestamp "**_ at the top. It is important that you select the correct timestamp.
|
|
|
|
|
|
### Example trace after reboot:
|
|
|
|
|
|
|
|
### Example automations Blueprint:
|
|
```
|
|
alias: YYXYYXYYX - NSPanel Configuration
|
|
description: ""
|
|
use_blueprint:
|
|
path: nspanel_configuration.yaml
|
|
input:
|
|
nspanel_name: nspanel_dev
|
|
language: DE
|
|
sync_value_ha: select_no
|
|
sync_slider_ha: select_no
|
|
weather: AccuWeather
|
|
accuweather: home_wetter
|
|
outdoortemp: sensor.terrasse_garage_motion_sensor_temperature
|
|
humidity: sensor.kinderzimmer_lea_temperatur_sensor_humidity
|
|
hotwatertemp: sensor.hotwater_temp
|
|
hotwatercharge: switch.charge
|
|
heatingsystemflame: binary_sensor.flamestatus
|
|
climate: climate.nspanel_buro
|
|
left_button_entity: light.haustur_spot_2
|
|
right_button_entity: light.haustur_spot_1
|
|
entity01: light.buro_sideboard
|
|
entity01_name: Sideboard
|
|
entity02: cover.kuche_rollo
|
|
entity02_name: Küche Rollo
|
|
entity03: switch.buro_dart_beleuchtung
|
|
entity03_name: Dart Licht
|
|
delay: 2
|
|
right_button_name: Test 1
|
|
left_button_name: Test 2
|
|
```
|
|
|
|
## Update Blueprint
|
|
|
|
>IMPORTANT: To install a new version of the NSPanel, the Blueprint, ESPHome and the TFT must be updated!
|
|
|
|
1. In Home Assistant, go to Settings > Automation & Scenes, select the tab Blueprints and find the blueprint named "NSPanel Configuration"
|
|
2. Click the 3-dot menu and select "Re-import blueprint":<br>
|
|
3. Click "Re-import" button:<br>
|
|
4. Reload automations or restart Home Assistant.
|
|
5. The new Blueprint is now available. Settings that have already been made are adopted.
|
|
6. Please review the blueprint settings (under Automations tab) for new settings available with the new version.
|
|
|
|
## Update ESPHome
|
|
|
|
***IMPORTANT:***
|
|
- *To install a new version of the NSPanel, the Blueprint, ESPHome and the TFT must be updated!*
|
|
- *These instructions are for updating a panel where an older version of these files are already installed.*
|
|
|
|
To flash your panel with an updated version from this project, go to the ESPHome dashboard (in your Home Assistant) and find the device you want to update. Then click the 3-dot menu and select the option "Validate":
|
|
|
|
|
|
|
|
The system will go thru all the settings, combining your entries in "substitutions" and the ESPHome file(s) from the GitHub repository and validate the final setup. It might take some time.
|
|
|
|
If everything goes well, you will see a green check mark in the top of the dialog window. When you get that, you can click "Install":
|
|
|
|
|
|
|
|
As your panel is probably already connected to the Wi-Fi, you may select to install "Wirelessly", as it is much easier and you don't have to unassemble your panel.
|
|
|
|
|
|
|
|
The new firmware will be built and then flashed to your panel, which will restart at the end of this process and start sending logs again:
|
|
|
|
|
|
|
|
|
|
## Update TFT
|
|
|
|
>IMPORTANT: To install a new version of the NSPanel, the Blueprint, ESPHome and the TFT must be updated!
|
|
|
|
The display can be updated via the UI:
|
|
|
|
1. Go to ***Settings --> Devices & Services --> Integrations*** , select the display under the ESPHome integration.
|
|
|
|
2. Press the switch "Update TFT Display" under Configuration.
|
|
|
|
3. The display starts the update process and then restarts.
|
|
|
|
-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/DisplayUpdate.PNG)
|
|
|
|
## Notification via HA
|
|
|
|
To show a notification on the NSPAnel, the following service call can be used:
|
|
|
|
```
|
|
service: esphome.panelname_notification_show
|
|
data:
|
|
label: Example text
|
|
text: Example text
|
|
```
|
|
|
|
To clear any notifications, the following service call can be used:
|
|
|
|
```
|
|
service: esphome.panelname_notification_clear
|
|
data: {}
|
|
```
|
|
|
|
|
|
To use the notifications in an automation, again simply use the service call as shown in the example below:
|
|
|
|
```
|
|
description: ""
|
|
mode: single
|
|
trigger:
|
|
- platform: state
|
|
entity_id:
|
|
- binary_sensor.motion_detector
|
|
to: "on"
|
|
condition: []
|
|
action:
|
|
- service: esphome.panelname_notification_show
|
|
data:
|
|
label: Motion Detected
|
|
text: Example for a Notification on the Panel Screen
|
|
```
|
|
|
|
## Climate control with Relays
|
|
> Attention!! Although these instructions are still valid, since v4.0 there is a better way to setup a climate control using the panel's relays: https://github.com/Blackymas/NSPanel_HA_Blueprint/wiki/(EN)-Add%E2%80%90on:-Climate
|
|
|
|
In order to use the NSPanel to control a radiator or underfloor heating, at least one Generic Thermostat must be created in the HA. More information can be found here: https://www.home-assistant.io/integrations/generic_thermostat/
|
|
|
|
Example configuration Generic Thermostat:
|
|
|
|
```
|
|
climate:
|
|
- platform: generic_thermostat
|
|
name: Study
|
|
heater: switch.study_heater ## Wenn das NSPanel Relays den Heizkreis Regler schaltet, kann dieses hier definiert werden
|
|
target_sensor: sensor.study_temperature ## Hier kann der NSPanel Sensor verwendet werden
|
|
min_temp: 15
|
|
max_temp: 21
|
|
ac_mode: false
|
|
target_temp: 17
|
|
cold_tolerance: 0.3
|
|
hot_tolerance: 0
|
|
min_cycle_duration:
|
|
seconds: 5
|
|
keep_alive:
|
|
minutes: 3
|
|
initial_hvac_mode: "off"
|
|
away_temp: 16
|
|
precision: 0.1
|
|
```
|
|
|
|
Afterwards, the climate.entity must be assigned accordingly in the panel configuration:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/climate.PNG)
|
|
|
|
## Call a page directly
|
|
|
|
Sometimes it can make sense to automatically show a certain side of the display. To do this, the following service can be used:
|
|
|
|
```
|
|
service: esphome.nspanel_send_command_printf
|
|
data:
|
|
cmd: page home
|
|
```
|
|
|
|
For example, to directly display button page 2, "home" must be replaced with "buttonpage02".
|
|
|
|
The following pages are currently available for a direct call:
|
|
- alarm
|
|
- buttonpage01
|
|
- buttonpage02
|
|
- buttonpage03
|
|
- buttonpage04
|
|
- climate
|
|
- entitypage01
|
|
- entitypage02
|
|
- entitypage03
|
|
- entitypage04
|
|
- home
|
|
- qrcode
|
|
|
|
## Play RTTTL Sound
|
|
|
|
HA can send a RTTTL to the NSPanel, custom melodies are possible.
|
|
|
|
The use this function, the following service is called: ***nspanel_play_rtttl***
|
|
|
|
You can find many RTTTL strings on the web, the important thing is that they must start with the name and then a colon.
|
|
|
|
Here is an example:
|
|
|
|
```
|
|
The Simpsons:d=4,o=5,b=160:c.6,e6,f#6,8a6,g.6,e6,c6,8a,8f#,8f#,8f#,2g,8p,8p,8f#,8f#,8f#,8g,a#.,8c6,8c6,8c6,c6
|
|
```
|
|
|
|
|
|
|
|
More information: https://esphome.io/components/rtttl.html#common-beeps
|
|
|
|
More songs: https://codebender.cc/sketch:109888#RTTTL%20Songs.ino
|
|
|
|
## Start Automations via Input_Boolean
|
|
|
|
Although the NSPanel can execute scripts directly over the buttons, there is also the possibility of starting automations directly by the means of Input_Boolean.
|
|
|
|
For this, a helper must first be created under ***Settings --> Devices&Services --> Helpers***, see here:
|
|
https://www.home-assistant.io/integrations/input_boolean/-HowTo---All-important-thing-you-should-know.assets/Toggle1.PNG)
|
|
|
|
Now add the created Input_Boolean as a trigger in the desired automation under State:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle2.PNG)
|
|
|
|
In the last step, assign the trigger to a button in the Panel Config:-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle3.PNG)
|