h3n3/NSPanel_HA_Blueprint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed link to addon climate docs

Browse Source
This commit is contained in:
Edward Firmo
2023-08-09 23:14:05 +02:00
parent 8650b0814c
commit 9556262880
2 changed files with 132 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
ReleaseNotes.md
View File

@@ -7,7 +7,9 @@
 
## General
- Thanks for 600 stars.
First of all, we wanna say a big thanks to all of you who starred this project in GitHub. It's amazing how the number of stars keeps growing and is now around 650!!!
After a long wait since the latest big release, which we used to leave our desks for a while and enjoy some vacations time with our beloved ones, we are proud to introduce the version 4.0, which adds new screens and makes your panel more flexible and robust.
###
@@ -34,23 +36,33 @@ Since in this update lots of input to the blueprint changed, we highly recommend
 
## Overview of all changes
1. Alarm control panel
2. Support to sensor display precision from Home Assistant (#880)
3. Filtered device list (#881)
4. New language selector (#882)
5. Removed `settings_entity` (#887)
6. Support for US model on landscape mode (#890)
7. API status indication on the panel ([#5ff5d35](https://github.com/Blackymas/NSPanel_HA_Blueprint/commit/5ff5d35833be1a1cf9ca0f570662456058980024))
8. Light & cover settings pages will show only the supported features (#896)
9. New "Fan speed page" (#897)
10. Select wake-up page (#898)
11. Panel's local control
12. Embedded thermostat/heater (#917)
1. Add-ons support
- Embedded thermostat/heater (#917)
2. Alarm control panel
3. Support to sensor display precision from Home Assistant (#880)
4. Filtered device list (#881)
5. New language selector (#882)
6. Removed `settings_entity` (#887)
7. Support for US model on landscape mode (#890)
8. API status indication on the panel ([#5ff5d35](https://github.com/Blackymas/NSPanel_HA_Blueprint/commit/5ff5d35833be1a1cf9ca0f570662456058980024))
9. Light & cover settings pages will show only the supported features (#896)
10. New "Fan speed page" (#897)
11. Select wake-up page (#898)
12. Panel's local control
 
## Details of all changes
### 1. Alarm control panel
### 1. Support to add-ons
We are trying to make your panel more usefull and more robust by changing some of the functionalitites to run internally in the panel, even when the Wi-Fi network or Home Assistant are not available, however, every new functionality takes a bit from the ESP embedded in your panel and increases the complexity, and having a code cabaple to adapt to all the different user cases will be very complex and certainly will exceed the available memory.
The first add-on available is an **[embedded thermostat/heater](/docs/en/addon_climate.md)**, able to control it locally even when your Wi-Fi is out or Home Assistant is unavailable.
Please refeer to the [documentation](/docs/en/addon_climate.md) to get more details on how to enable this add-on.
 
### 2. Alarm control panel
recommend api-encryption: https://esphome.io/components/api.html#configuration-variables
and, of course warn the user that this is a possible security issue.
Anyways - this is also done with many other projects, AND it would require that a possible hacker is already inside the internal (or mayby iot) (W)LAN - and at this point....
@@ -60,37 +72,37 @@ recommend to have a big warning, and that the user has to take care about e.g.:
- enable api-encryption
 
### 2. Support to sensor display precision from Home Assistant
### 3. Support to sensor display precision from Home Assistant
Now the values shown in your panel will follow the [sensor display precision](https://www.home-assistant.io/blog/2023/03/01/release-20233/#sensor-display-precision) provided by Home Assistant.
=> If you have problems with a value exceeding the available space in your panel, please reduce the number of decimals using Home Assistant [sensor display precision](https://www.home-assistant.io/blog/2023/03/01/release-20233/#sensor-display-precision).
 
### 3. Filtered device list
### 4. Filtered device list
When selecting the NSPanel on the automation, only ESP32 devices will be shown, making easier to find your panel.
![image](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/0e66bd6b-23c3-4014-8603-958acea48462)
 
### 4. New language selector
### 5. New language selector
Starts using the new language selector release with HA 2023.5.0 and based on RFC 5646, which will increase reliability and standardization of the code.
Althougt this is not visible for users at the first view, it will enable the use of more granualar language selections (like pt-BR vs pt-PT or en-US vs en-UK) if needed in the future.
=> If you are an existing users, please remember to select your language again after the update, as the previous selection will be invalid.
 
### 5. Removed `settings_entity`
### 6. Removed `settings_entity`
The entity `sensor.xxxxx_settings_entity` was previously used by ESPHome to to transfer information about the selected entity on the settings page to the Blueprint, enabling the transfer of settings from different instances of the blueprint with the use of service `esphome.xxxxx_set_settings_entity`. This mechanism was a bit fragile and not user friendly.
With this version the information about the entity shown will be part of the `sensor.xxxxx_nspanel_event` and the settings pages will be called with the service `esphome.xxxxx_open_entity_settings_page`.
Apart of a cleaner device page, this change should be transparent for most users. If you have made automations based on the removed elements, please update it using the new service.
 
### 6. Support for US model on landscape mode
### 7. Support for US model on landscape mode
If you are using a panel model US in landscape mode, you can now use `nspanel_us_land.tft` where the bars related to the hardware buttons will be located at the right, closer to the respective buttons and fixing the offset on the touch screen when using `nspanel_eu.tft` into a US panel.
=> The hardware buttons labels are hidden in this format, as Nextion cannot support rotated text.
 
### 7. API status indication on the panel
### 8. API status indication on the panel
Now the Wi-Fi icon in the panel (at the right side of the time) will show one of 3 possible states:
![wifi_gray](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/8e462abb-68d7-4ade-b3c1-ef115aa66c2c) The panel is connected to the Wi-Fi and the API is connected to Home Assistant (mdi:wifi)
@@ -100,16 +112,16 @@ Now the Wi-Fi icon in the panel (at the right side of the time) will show one of
![wifi-off_red](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/c8b15d1f-0950-42d7-84d1-fca8610543c0) The panel is **NOT** connected to the Wi-Fi (mdi:wifi-off)
 
### 8. Light & cover settings pages will show only the supported features
### 9. Light & cover settings pages will show only the supported features
Now when long press a button conneted to a light or a cover, the detailed light settings page will open only when the entity supports advanced control, and the detailed page will only show the controls supported by that entity.
 
### 9. New "Fan speed page"
### 10. New "Fan speed page"
If you have a connected fan supporting speed control, now you are able to control it's speed from your panel. Just add the new fan to one of the buttons pages or to the hardware buttons and a long press on those buttons will pop up the new "Fan speed page":
![image](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/4167928e-6822-4db6-a24b-f8a1d52806f5)
 
### 10. Select wake-up page
### 11. Select wake-up page
Now you can select the wake-up page on the blueprint settings:
![image](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/30b54682-f1ca-43ac-80af-f89459a6ffd7)
@@ -117,39 +129,19 @@ Now you can select the wake-up page on the blueprint settings:
This selected page will be shown after a boot (after the boot page) and with a touch in the screen when on screen saver page. After showing this wake-up page, all the previous behavior for closing the page (with a click or after a timeout) will be the same.
 
### 11. Panel's local control
### 12. Panel's local control
We are trying to make your panel as autonomous as possible by moving some of the controls from the Blueprint to ESPHome. This will reduce the load in your network and Home Assistant, but also will make a more reliable system capable to do it's core functionality even when the network is unavailable or Home Assistant is restarting.
With this version, the following engines have been moved to your panel (local control):
- Time display
- Physical relay control (when hardware left button is connected to relay 1 or right button to relay 2)
- Embedded thermostat (see bellow)
 
### 12. Embedded thermostat/heater
Now you can use your panel to control a heater and let your ambient more confortable, and you will be able to control it locally even when your Wi-Fi is out or Home Assistant is unavailable.
in order to have this enable, add the following to your substitutions:
```yaml
substitutions:
embedded_thermostat_disabled: "false"
embedded_thermostat_heater_relay: "1" # Select 1 for "Relay 1" or 2 for "Relay 2"
```
For more advanced settings, please take a look at the full documentation.
===>>> Add documentation before release <<<===
- How to enable
- Substitutions
- etc
&nbsp;
## Next topics we are currently working on
See here: https://github.com/Blackymas/NSPanel_HA_Blueprint/labels/roadmap
## What's Changed
* @chpego - Fixes on the blueprint UI (#928)
* @bkbartk - Updated Dutch translations (#974)
## New Contributors
* @bkbartk
*

95
docs/en/addon_climate.md Normal file
View File

@@ -0,0 +1,95 @@
# Add-on: Climate
## Description
This add-on enables the use of your panel's relays to act as a thermostat (heater only for now) using the internal temperature sensor and independent of the network availability.
### Attention
The NSPanel is limited to 2A per relay. Don't use it for directly power your heater if exceeding the panel specifications:
- 150W/110V/Gang, 300W/110V/Total
- 300W/220V/Gang, 600W/220V/Total
More details on the [Sonoff NSPanel's page](https://sonoff.tech/product/central-control-panel/nspanel/) and the [product specifications document](https://sonoff.tech/wp-content/uploads/2021/11/%E4%BA%A7%E5%93%81%E5%8F%82%E6%95%B0%E8%A1%A8-NSPanel-20210831.pdf).
&nbsp;
## Installation
You will need to add the reference to the `addon_climate` file on your ESPHome settings in the `package` section and after te `remote_package` (base code), as shown bellow:
```yaml
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"
addon_climate_heater_relay: "1"
##### CHANGE ME END #####
packages:
remote_package:
url: https://github.com/Blackymas/NSPanel_HA_Blueprint
ref: main
files: [nspanel_esphome.yaml]
refresh: 300s
addon_climate:
url: https://github.com/Blackymas/NSPanel_HA_Blueprint
ref: main
files: [nspanel_esphome_addon_climate.yaml]
refresh: 300s
```
&nbsp;
## Configuration
The following keys are available to be used in your `substitutions`:
|Key|Required|Supported values|Default|Description|
|:-|:-:|:-:|:-:|:-|
|addon_climate_heater_relay|Mandatory|`1` or `2`|`0` (disabled)|Relay used for conrol the heater. User `1` for "Relay 1" or `2` for "Relay 2".|
|addon_climate_temp_units|Optional|`°C` or `°F`|`°C`|Temperature unit.|
|addon_climate_min_heating_off_time|Optional|Positive integer representing the number of seconds|`300`|Minimum duration (in seconds) the heating action must be disengaged before it may be engaged.|
|addon_climate_min_heating_run_time|Optional|Positive integer representing the number of seconds|`300`|Minimum duration (in seconds) the heating action must be engaged before it may be disengaged.|
|addon_climate_min_idle_time|Optional|Positive integer representing the number of seconds|`30`|Minimum duration (in seconds) the idle action must be active before calling another climate action.|
|addon_climate_visual_min_temperature|Optional|Number representing a temperature in the selected unit|`5`|The minimum temperature the climate device can reach. Used to set the range of the frontend gauge.|
|addon_climate_visual_max_temperature|Optional|Number representing a temperature in the selected unit|`25`|The maximum temperature the climate device can reach. Used to set the range of the frontend gauge.|
|addon_climate_visual_temperature_step|Optional|Number representing a temperature in the selected unit|`0.5`|The granularity with which the target temperature can be controlled.|
- All values must be delimited with `""`
- For more details on the keys, please take a look at [ESPHome Base Climate Configurations](https://esphome.io/components/climate/index.html#base-climate-configuration) and [ESPHome Climate Thermostat - Additional actions behavior](https://esphome.io/components/climate/thermostat.html#additional-actions-behavior).
### Example:
```yaml
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_us.tft"
addon_climate_heater_relay: "1" #Use relay 1
addon_climate_temp_units: "°F" #Temperatures in Fahrenheit
addon_climate_visual_min_temperature: "40" #Min supported temperature is 40F
addon_climate_visual_max_temperature: "80" #Max supported temperature is 80F
addon_climate_visual_temperature_step: "1" #Temperature granularity is 1F
##### CHANGE ME END #####
packages:
remote_package:
url: https://github.com/Blackymas/NSPanel_HA_Blueprint
ref: main
files: [nspanel_esphome.yaml]
refresh: 300s
addon_climate:
url: https://github.com/Blackymas/NSPanel_HA_Blueprint
ref: main
files: [nspanel_esphome_addon_climate.yaml]
refresh: 300s
```