Skip to content

(EN) HowTo All important thing you should know

hollabee edited this page Jan 19, 2023 · 11 revisions

In this post we will collect all the important things about different topics that we notice over time. 

_**NOTE! If you notice something during the configuration or you had some problem and could solve it, it would be great for us and everyone else in the community if you share your knowledge with us. You can write me a short message and I will include it in this post.

 

IMPORTANT! If you have a problem with the setup or a feature and open an "Issue on Github ", please describe your problem as detailed as possible. Pictures can also help here.

 

IMPORTANT! When you open an "Issue ", follow the instructions bitterly see here How to create "Issues".

 
 


 

Contents:

  1. How do I create "Issues" when I have a problem .
  2. Update Blueprint
  3. Update ESPHome
  4. Update TFT
  5. Manual TFT upload via local HA (coming soon)
  6. Upload TFT error and solution (coming soon
  7. Notification via HA (coming soon)
  8. Climate for relays
  9. Display internal switches as lamp in HA
  10. Quick navigation (coming soon)
  11. Call certain pages directly
  12. Play RTTTL Sound
  13. Advanced functions and automations (coming soon)
  14. Start automations via Input_Boolean

 


 

1. 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.

  • Issues can be created in DE or EN.
  • Describe your problem as detailed as possible.
  • Please write your ESPHome and Home Assistant version.
  • 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. In the boot 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:

Bildschirmfoto 2022-11-27 um 14 54 58

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

2. Update Blueprint

Currently HA does not offer the possibility to update Blueprints directly via the UI. This has to be done manually e.g. via the file editor.

  1. Download the latest release of the Blueprint from the Github repository.
  2. Replace the existing YAML file "nspanel_blueprint.yaml" in the folder ./config/blueprints/automation/Blackymas with the new version.
  3. Reload automations or restart Home Assistant.
  4. The new Blueprint is now available. Settings that have already been made are adopted.

BlueprintUpdate


3. Update ESPHome

To update ESPHome go to the ESPHome integration. There click on "Update All":![ESPHome Update0](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/ESPHome Update0.PNG)

The update process may take a few minutes.![ESPHome Update](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/ESPHome Update.PNG)


4. Update TFT

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.

    DisplayUpdate


5. Manual TFT upload via local HA

coming soon


6. Upload TFT error and solution

coming soon


7. Notification via HA

coming soon


8. Climate control with Relays

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:climate


9. Display internal switches as lamp in HA

In the world of Home Assistant, the relay in the NSPanel is a switch. And although this is generally correct, these relays are often used for a lamp or a fan, for example. If now e.g. a lamp is switched directly with the relay, it is desirable that also in the HA the switch is displayed as a lamp or that this "lamp" should be added to a light group.

With the Switch as X integration, these switches can be converted into the entity types that best suit the use case: https://www.home-assistant.io/integrations/switch_as_x/

Swichasx


10. Quick Navigation

coming soon


11. Call certain pages 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_dev_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:

automation_1


12. 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_dev_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

212177541-206ed70d-b4e0-436c-9ef5-25e03a816898

More information: https://esphome.io/components/rtttl.html#common-beeps

More songs: https://codebender.cc/sketch:109888#RTTTL%20Songs.ino


13. Advanced functions and automations

coming soon


14. Start Automation 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/![Toggle1](./(EN)-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:Toggle2

In the last step, assign the trigger to a button in the Panel Config:Toggle3