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

Markdown lint

Browse Source
This commit is contained in:
Andy Thomas
2024-03-29 11:28:49 +01:00
parent ea5e349d7a
commit ab04f7a86d
3 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/customization.md
View File

@@ -553,7 +553,8 @@ You can overlap the settings with this customization.
more boards are supported and the memory management is better, making it ideal if you wanna customize your panel to support memory consumption functionalities, more boards are supported and the memory management is better, making it ideal if you wanna customize your panel to support memory consumption functionalities,
like `bluetooth_proxy` or [Improv](https://www.improv-wifi.com/). Consequently, this project uses `esp-idf` as the default framework since `v4.3`. like `bluetooth_proxy` or [Improv](https://www.improv-wifi.com/). Consequently, this project uses `esp-idf` as the default framework since `v4.3`.
However, the `arduino` protocol still very popular and, therefore, more components are available and the project allows to switch between the frameworks by adding the following lines in your panel's yaml file. However, the `arduino` protocol still very popular and, therefore, more components are available and the project allows to switch between the frameworks
by adding the following lines in your panel's yaml file.
#### Framework `arduino` #### Framework `arduino`
```yaml ```yaml

22
docs/howto.md
View File

@@ -12,15 +12,15 @@ You can write a short message with your findings, and we'll include it here.
Below are the topics covered in this document, each with relevant tips 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-to-create-issues-when-i-have-a-problem) 1. [How do I create "Issues" when I have a problem ](#how-to-create-issues-when-i-have-a-problem)
1. [Update Blueprint](#update-blueprint) 2. [Update Blueprint](#update-blueprint)
1. [Update ESPHome](#update-esphome) 3. [Update ESPHome](#update-esphome)
1. [Update TFT](#update-tft) 4. [Update TFT](#update-tft)
1. [Notification via HA](#notification-via-ha) 5. [Notification via HA](#notification-via-ha)
1. [Climate control with relays](#climate-control-with-relays) 6. [Climate control with relays](#climate-control-with-relays)
1. [Call a page directly](#call-a-page-directly) 7. [Call a page directly](#call-a-page-directly)
1. [Play RTTTL Sound](#play-rtttl-sound) 8. [Play RTTTL Sound](#play-rtttl-sound)
1. [Start automations via Input_Boolean](#start-automations-via-input_boolean) 9. [Start automations via Input_Boolean](#start-automations-via-input_boolean)
1. [Updating Wi-Fi and OTA passwords in ESPHome with this project](#updating-wi-fi-settings-and-ota-passwords-in-esphome-with-this-project) 10. [Updating Wi-Fi and OTA passwords in ESPHome with this project](#updating-wi-fi-settings-and-ota-passwords-in-esphome-with-this-project)
## How to create "issues" when I have a problem ## How to create "issues" when I have a problem
@@ -177,7 +177,9 @@ trigger:
## Climate control with Relays ## Climate control with Relays
> [!ATTENTION] > [!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 an the [add-on climate](addon_climate.md), which will continue to work even if Home Assistant and/or WiFi are not available. You probably only want to use this approach, if you are not using the build-in thermometer. > Although these instructions are still valid, since v4.0 there is a better way to setup a climate control using the panel's relays an the [add-on climate](addon_climate.md),
> which will continue to work even if Home Assistant and/or WiFi are not available.
> You probably only want to use this approach, if you are not using the build-in thermometer.
In order to use the NSPanel to control a radiator or underfloor heating, at least one Generic Thermostat must be created in the HA. 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/ More information can be found here: https://www.home-assistant.io/integrations/generic_thermostat/

2
docs/install.md
View File

@@ -143,12 +143,10 @@ Learn about secrets in ESPHome: [Home Assistant Secrets in ESPHome](https://www.
> it is strongly recommended to use HTTP, especially when employing the `arduino` framework. > it is strongly recommended to use HTTP, especially when employing the `arduino` framework.
> The support for HTTPS in this context can be unstable, > The support for HTTPS in this context can be unstable,
> often leading to issues with file transfers. > often leading to issues with file transfers.
12. (Optional) Enhance security with API encryption by adding the copied key from step 6 to the **My Customization** area. 12. (Optional) Enhance security with API encryption by adding the copied key from step 6 to the **My Customization** area.
> [!TIP] > [!TIP]
> You can get a new randomly generated valid key from [ESPHome Native API Component](https://esphome.io/components/api.html#configuration-variables) page. > You can get a new randomly generated valid key from [ESPHome Native API Component](https://esphome.io/components/api.html#configuration-variables) page.
13. After finalizing settings, click **Save** and close the YAML window. 13. After finalizing settings, click **Save** and close the YAML window.
Your NSPanel is now configured in your ESPHome Dashboard. Your NSPanel is now configured in your ESPHome Dashboard.