Files

Edward Firmo 6c23adcf6c Moving docs to repo

2023-12-11 23:28:39 +01:00

8.4 KiB

Raw Blame History

This section covers the initial configuration. All important steps for installation and setup of ESPHome and the Blueprint are described here.

⭐ Step by Step Setup Video

ATTENTION! if you have already installed the version "nspanel-lovelace-ui" from joBr99 on your NSPanel, an intermediate step is necessary - otherwise it is not possible to install this or any other version.

NOTE! We are not EN native speakers, there may well be errors in translation or sentence structure. If something is wrong or unclear an "Issue" can be opened. If you want to help us, feel free to propose a change directly in GitHub or please get in contact with us.

Content:

1. Short version of the setup of Esphome and Blueprint

(for those who already have experience with ESPhome and Home Assistant)

1. First you have to install the Blueprint. For this please use the following link

It is also possible to copy the code from the file "nspnael_blueprint.yaml " and paste it into HA. You can find instructions for this under Using Automation Blueprints and Automation blueprint tutorial

2. You have to download the file nspanel_us.tft or "nspanel_eu.tft" from Github

3. Upload the file to your Home Assistant Server in the www folder, see Home Assistant HTTP 'Hosting Files' section for details.

4. In the next step you have to create a new ESP32 device in ESPHome

5. When the new ESP32 device has been created, next click "Edit " on the device you have just created to open the web editor. Now the following code must be copied and pasted.

❗ IMPORTANT! The already existing code in the ESPHome file must be "COMPLETELY " deleted and "REPLACED " by the code below.

❗ IMPORTANT! in the block "CHANGE ME " all values (device_name, wifi_ssid, wifi_password, nextion_update_url ) in the " " must be replaced by your own values. It is also possible to work here with "!secret ".

CODE:

substitutions:
  ###### CHANGE ME START ######
  device_name: "YOUR_NSPANEL_NAME" 
  wifi_ssid: !secret wifi_ssid
  wifi_password: !secret wifi_password

  nextion_update_url: "http://homeassistant.local:8123/local/nspanel_eu.tft"
  nextion_blank_url: "http://homeassistant.local:8123/local/nspanel_blank.tft"

  ##### addon-configuration #####
  ## addon_climate ##
  # addon_climate_heater_relay: "1" # possible values: 1/2

  ##### CHANGE ME END #####

packages:
  remote_package:
    url: https://github.com/Blackymas/NSPanel_HA_Blueprint
    ref: main
    files:
      - nspanel_esphome.yaml # Core package
      # - advanced/esphome/nspanel_esphome_advanced.yaml # activate advanced (legacy) elements - can be useful for troubleshooting
      # - nspanel_esphome_addon_climate_cool.yaml # activate for local climate (cooling) control
      # - nspanel_esphome_addon_climate_heat.yaml # activate for local climate (heater) control
    refresh: 1s

esp32:
  framework:
    type: esp-idf

##### My customization - Start #####
##### My customization - End #####

⚠️ The following TFT files are available and can be replaced in your URL accordingly:

nspanel_eu.tft (European layout)
nspanel_us.tft (US layout)
nspanel_us_land.tft (US layout - landscape orientation)

6. Now the NSPanel can be flashed with the new ESPHome code.

How to flash the NSPanel you can see here: HowTo - Flash NSPanel with ESPhome

7. After the NSPanel is flashed, you can go to "Settings --> Devices & Services --> Add Integration" to add your new device and finish setting it up.

8. In the last step, only the TFT must be uploaded. To do this, open your new device in the ESPHome integration and activate the item "Update TFT display " under "Configuration". Now the current TFT file is loaded from local Home Assistant Server or GitHub and uploaded to your NSPanel. ATTENTION! This process will take up to 30 minutes.

9. Now the setup of ESPHome and NSPanel is completed.

10. Now you can configure your NSPanel via the Blueprint. To do this, go to "Settings --> Automations & Scenes --> Templates --> NSPanel Configuration --> CREATE AUTOMATION" and start with the setup of the NSPanel.

NOTE! In the blueprint, the field "NSPanel device" is required. Although you can still save the automation without a device selected, it would be unusable without that information.

2. Version "nspanel-lovelace-ui" by joBr99 was previously installed

See (EN) Common Issues | TFT Upload When nspanel lovelace ui has been installed

3. Advanced configuration for all ESPHome and Home Assistant professionals

ATTENTION! Customizations and advanced mode are not supported by this project's team. Use this with caution and only when you know what you are doing.

Before you start customizing your system, we would like to invite you to share anything nice you achieve. You can always create a new Pull Request to dev branch and this will give a chance for other users with similar challenges to take advantage of your discoveries.

The simpler way to go "advanced" with ESPHome is to use "Customizations". We have a page specifically for that where, again, your contribution is very welcome: Customization

If you want for some reason use a local copy of nspanel_esphome.yaml, you can copy the file from GitHub to you local file system and reference in your ESPHome settings like this:

substitutions:
  ###### CHANGE ME START ######
  device_name: office-workstation-panel
  wifi_ssid: !secret wifi_ssid
  wifi_password: !secret wifi_password

  nextion_update_url: "http://homeassistant.local:8123/local/nspanel_us_land.tft"

  ##### CHANGE ME END #####

packages:
  local_package: !include packages/nspanel_esphome.yaml

Note that a sub-folder was used in the example above in order to avoid that file to be added as an additional device in your ESPHome dashboard. You can also have the file in the same folder, but with it's name starting with ., so ESPHome dashboard understands that file should be ignored when listing devices.

Blueprint file "nspanel_blueprint.yaml " can also be installed manually.
There is also the possibility to upload the TFT file "nspanel_us.tft " manually. The whole thing can also be combined with a "Folder Watcher ".
additionally we provide the HMI files "nspanel_xx.HMI " for the Nextion Editor to customize graphics and programming if needed.

8.4 KiB Raw Blame History