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

Lint

Browse Source
This commit is contained in:
Edward Firmo
2024-01-05 11:41:56 +01:00
parent d235ddb4ac
commit f12d4c1eea
3 changed files with 8 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/error_initializing.md
View File

@@ -63,7 +63,7 @@ You can use this button to force a reboot of your panel. This button is availabl
## Additional Tips and Resources ## Additional Tips and Resources
After troubleshooting, if issues persist, consult the [Issues](/Blackymas/NSPanel_HA_Blueprint/issues) and feel free to create a new one asking for more personalized assistance. After troubleshooting, if issues persist, consult the [Issues](https://github.com/Blackymas/NSPanel_HA_Blueprint/issues) and feel free to create a new one asking for more personalized assistance.
Please share as much info as possible, like: Please share as much info as possible, like:
1. Describing (or a picture of) what is in your screen 1. Describing (or a picture of) what is in your screen

10
docs/howto.md
View File

@@ -114,13 +114,9 @@ The new firmware will be built and then flashed to your panel, which will restar
The display can be updated via the UI: The display can be updated via the UI:
1. Go to ***Settings --> Devices & Services --> Integrations*** , select the display under the ESPHome integration. 1. Go to ***Settings --> Devices & Services --> Integrations*** , select the display under the ESPHome integration.
2. Press the switch "Update TFT Display" under Configuration. 2. Press the switch "Update TFT Display" under Configuration.
3. The display starts the update process and then restarts. 3. The display starts the update process and then restarts.
![DisplayUpdate](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/DisplayUpdate.PNG)
## Notification via HA ## Notification via HA
To show a notification on the NSPAnel, the following service call can be used: To show a notification on the NSPAnel, the following service call can be used:
@@ -186,7 +182,7 @@ climate:
precision: 0.1 precision: 0.1
``` ```
Afterwards, the climate.entity must be assigned accordingly in the panel configuration:![climate](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/climate.PNG) Afterwards, the climate.entity must be assigned accordingly in the panel configuration.
## Call a page directly ## Call a page directly
@@ -241,9 +237,9 @@ Although the NSPanel can execute scripts directly over the buttons, there is als
For this, a helper must first be created under ***Settings --> Devices&Services --> Helpers***, see here: 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) 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](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle2.PNG) Now add the created Input_Boolean as a trigger in the desired automation under State.
In the last step, assign the trigger to a button in the Panel Config:![Toggle3](./(DE)-HowTo---Alle-wichtigen-Dinge-die-man-wissen-sollte.assets/Toggle3.PNG) In the last step, assign the trigger to a button in the Panel Config.
## Updating Wi-Fi settings and OTA Passwords in ESPHome with This Project ## Updating Wi-Fi settings and OTA Passwords in ESPHome with This Project

8
docs/install.md
View File

@@ -5,7 +5,7 @@ Whether you're a first-time smart device user or an enthusiast looking to person
> [!NOTE] > [!NOTE]
> Some images or instructions on this guide might be slighly different due to different configurations depending on your ESPHome and Home Assistant implementation or versions.<br> > Some images or instructions on this guide might be slighly different due to different configurations depending on your ESPHome and Home Assistant implementation or versions.<br>
> If you find something that is not understandable or needs to be updated, please let us know. You can create an issue reporting this, or fix it yourself and submit a [Pull Request](/Blackymas/NSPanel_HA_Blueprint/pulls) to this repository. > If you find something that is not understandable or needs to be updated, please let us know. You can create an issue reporting this, or fix it yourself and submit a [Pull Request](https://github.com/Blackymas/NSPanel_HA_Blueprint/pulls) to this repository.
## Summary ## Summary
- [Preparation](#preparation) - [Preparation](#preparation)
@@ -162,7 +162,7 @@ The installation in a NSPanel with Sonoff's original firmware should be straighf
If you have already installed on your NSPanel the "nspanel-lovelace-ui" firmware from @joBr99 or from Tasmota, an [intermediate step](lovelace_ui.md) is necessary. Please execute that first before returning here. If you have already installed on your NSPanel the "nspanel-lovelace-ui" firmware from @joBr99 or from Tasmota, an [intermediate step](lovelace_ui.md) is necessary. Please execute that first before returning here.
#### Other #### Other
Please try the standard process and if you find any issue, please [create a new issue](/Blackymas/NSPanel_HA_Blueprint/issues) and inform which custom firmware you have installed before migrating to NSPanel HA Blueprint. Please try the standard process and if you find any issue, please [create a new issue](https://github.com/Blackymas/NSPanel_HA_Blueprint/issues) and inform which custom firmware you have installed before migrating to NSPanel HA Blueprint.
## Upload TFT ## Upload TFT
##### Pending: ##### Pending:
@@ -229,7 +229,7 @@ For homes with multiple panels:
> [!WARNING] > [!WARNING]
> Customizations and advanced mode are not supported by this project's team. Use them with caution and only if you have the necessary expertise. > Customizations and advanced mode are not supported by this project's team. Use them with caution and only if you have the necessary expertise.
Before customizing your system, we encourage you to share any enhancements you make. Consider creating a [Pull Request](/Blackymas/NSPanel_HA_Blueprint/pulls) to the `dev` branch to share your discoveries with the community. Before customizing your system, we encourage you to share any enhancements you make. Consider creating a [Pull Request](https://github.com/Blackymas/NSPanel_HA_Blueprint/pulls) to the `dev` branch to share your discoveries with the community.
### ESPHome ### ESPHome
@@ -275,7 +275,7 @@ For guidance on using Nextion, refer to:
> [!TIP] > [!TIP]
> For troubleshooting TFT transfer issues, consult our [TFT Transfer Troubleshooting Guide](tft_upload.md) first. > For troubleshooting TFT transfer issues, consult our [TFT Transfer Troubleshooting Guide](tft_upload.md) first.
If problems persist after troubleshooting, visit the [Issues](/Blackymas/NSPanel_HA_Blueprint/issues) page. Feel free to create a new issue for personalized assistance, providing details such as: If problems persist after troubleshooting, visit the [Issues](https://github.com/Blackymas/NSPanel_HA_Blueprint/issues) page. Feel free to create a new issue for personalized assistance, providing details such as:
1. A description or picture of what is displayed on your screen. 1. A description or picture of what is displayed on your screen.
2. Information on whether you are updating from a previous version of this project, migrating from another NSPanel customization, or customizing a panel with the original Sonoff settings. 2. Information on whether you are updating from a previous version of this project, migrating from another NSPanel customization, or customizing a panel with the original Sonoff settings.
3. ESPHome logs from the start of your panel to the point where the upload fails. 3. ESPHome logs from the start of your panel to the point where the upload fails.