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 10:50:55 +01:00
parent 371803dcf3
commit f69b48df52
1 changed files with 42 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/blueprint.md
View File

@@ -1,7 +1,10 @@
This article covers the settings in the Blueprint Automation.
# Blueprint Automation
This article covers the settings in the Blueprint Automation.
The Blueprint Automation is the central configuration element of this solution for the NSPanel.<br>
In principle, the setup of the automation is self-explanatory. The individual elements of the Blueprint are described below.
The Blueprint Automation is the central configuration element of this solution for the NSPanel.
In principle, the setup of the automation is self-explanatory.
The individual elements of the Blueprint are described below.
It is possible to change both the color of the labels and the icons for most of the elements on each screen.
@@ -11,9 +14,6 @@ On the blueprint settings, you will be able to select any of the MDI icons suppo
For an easier overview, the menu items "Icon Color" and "Label Color" will not be described separately in the following documentation.
&nbsp;
# Parameters
## Basic settings
### NSPanel device (REQUIRED)
@@ -35,43 +35,57 @@ Select how you want to see the date displayed on your panel (Home page and weath
Select how you want to see the time displayed on your panel's Home page.
### Delay to avoid synchronization problems
If the Wi-Fi signal is poor, you may have issues when loading some pages. If this happens, try to increase this delay as that may help.
If the Wi-Fi signal is poor, you may have issues when loading some pages.
If this happens, try to increase this delay as that may help.
## Weather and Temperature
### Weather entity from HA
Select a Weather entity to use.
Most of the weather integrations are supported, however some may be able to provide more information than others.<br>
Most of the weather integrations are supported, however some may be able to provide more information than others.
We run all of our tests with "Accuweather", so the parameters shown on the panel are targetting this integration and will be shown with your integration when available.
### Outdoor temperature Sensor (Optional)
Optionally, the value of an outdoor temperature sensor can be used here. If no separate sensor is used, the value of the weather integration will be used.
Optionally, the value of an outdoor temperature sensor can be used here.
If no separate sensor is used, the value of the weather integration will be used.
### Indoor Temperature Sensor (Optional)
An indoor temperature sensor is not necessary. Leave the field empty if you want to use the temperature sensor of the NSPanel. If the value of the sensor needs to be corrected, this can be done via the temperature correction for the NSPanel under HA Devices.
An indoor temperature sensor is not necessary.
Leave the field empty if you want to use the temperature sensor of the NSPanel.
If the value of the sensor needs to be corrected, this can be done via the temperature correction for the NSPanel under HA Devices.
## Home page - Sensor
#### Sensor 01-03 - Entity (Optional)
Up to three sensors can be displayed on the home screen. Select the corresponding HA entity.
Up to three sensors can be displayed on the home screen.
Select the corresponding HA entity.
## Home page - Chips
#### Chip 01-07 - Entity (Optional)
Used to display HA entities on the home screen. For example to display the status of a specific switch on the NSPanel.
Used to display HA entities on the home screen.
For example to display the status of a specific switch on the NSPanel.
## Home page - Custom buttons
#### Custom button 01-06 - Entity (Optional)
Your panel will show 10 buttons on the Home page. 4 of those are fixed for Notifications, QR Code, Entities pages and Alarm, but you have additional 6 custom buttons that can be assigned to different entities from your Home Assistant. The behavior of these buttons will depend on the entity's domain (light, media player, etc).
Your panel will show 10 buttons on the Home page.
4 of those are fixed for Notifications, QR Code, Entities pages and Alarm, but you have additional 6 custom buttons that can be assigned to different entities from your Home Assistant.
The behavior of these buttons will depend on the entity's domain (light, media player, etc).
## Alarm Control Panel
An alarm control panel entity can be controlled by your panel. When you assign the entity here, it's icon will be shown as a button on the Home page.
An alarm control panel entity can be controlled by your panel.
When you assign the entity here, it's icon will be shown as a button on the Home page.
## Climate
### Climate to Control (Optional)
Here you select the main climate entity controlled by your panel. It's temperature will be used on the Home page and by clicking on that value you will be able to control the climate settings.
Here you select the main climate entity controlled by your panel.
It's temperature will be used on the Home page and by clicking on that value you will be able to control the climate settings.
You can optionally use your panel to control a climate system locally, using it's temperature sensor and relays. You will find more details about this on the Add-on Climate docummentation.<br>
If you are using the Add-on Climate, it will create a climate entity in your panel's device page. You still have to select that entity on this field in the blueprint settings to have it used as your main climate.
You can optionally use your panel to control a climate system locally, using it's temperature sensor and relays.
You will find more details about this on the Add-on Climate docummentation.
If you are using the Add-on Climate, it will create a climate entity in your panel's device page.
You still have to select that entity on this field in the blueprint settings to have it used as your main climate.
Additional climate entities can be assigned to buttons and will be explained later in this documment.
@@ -82,7 +96,9 @@ On the blueprint settings, you will also find settings for sensors and custom bu
Activates the QR Code page and shows the QR Code button on the Home page.
### QR Code content (Optional)
String, which is shown as a QR Code on the NSPanel. This can be a simple text, a URL or could also be used for a simplified login to the Wi-Fi. Here is an example (simply change SSID and password to your credentials and either use "WPA" or "WEP"):
String, which is shown as a QR Code on the NSPanel.
This can be a simple text, a URL or could also be used for a simplified login to the Wi-Fi.
Here is an example (simply change SSID and password to your credentials and either use "WPA" or "WEP"):
`Wi-Fi:S:SSID;T:WPA/WEP;P:PASSWORD;;`
@@ -100,7 +116,8 @@ For more details about these specifications, please visit the [WPA3™ Specifica
## Hardware Buttons
### Activate Relay x local Fallback (Optional)
Normally, the internal relays of the NSPanels are triggered via HA. If the NSPanel loses Wi-Fi connection or HA is down, the hardware button can then switch the corresponding relay directly.
Normally, the internal relays of the NSPanels are triggered via HA.
If the NSPanel loses Wi-Fi connection or HA is down, the hardware button can then switch the corresponding relay directly.
### Left/Right Hardware Button - Entity (Optional)
The entity that should be switched with the left/right hardware button.
@@ -136,16 +153,19 @@ The buttons are numbered as follows:
| Row 3 | 05 &nbsp;&nbsp;&nbsp; 06 | 13 &nbsp;&nbsp;&nbsp; 14 | 21 &nbsp;&nbsp;&nbsp; 22 | 29 &nbsp;&nbsp;&nbsp; 30 |
| Row 4 | 07 &nbsp;&nbsp;&nbsp; 08 | 15 &nbsp;&nbsp;&nbsp; 16 | 23 &nbsp;&nbsp;&nbsp; 24 | 31 &nbsp;&nbsp;&nbsp; 32 |
When the respective button is pressed, a toggle action is executed or the corresponding page is automatically opened, e.g. the cover control for covers, etc.
When the respective button is pressed, a toggle action is executed or the corresponding page is automatically opened, e.g.
the cover control for covers, etc.
For 2 state buttons (where toggle is the default action), a long press in the button will open it's corresponding page, when supported.
For each button an own name can be specified optionally.
All buttons offer the possibility to optionally confirm the execution of the action. This can be activated or deactivated separately for each button via *"Confirm execution of the button press"*.
All buttons offer the possibility to optionally confirm the execution of the action.
This can be activated or deactivated separately for each button via *"Confirm execution of the button press"*.
## Entity Page 01-04
### Activate Entity Page (Optional)
This option activates the entity pages on the Home Screen. The entity pages can be used for example to display values or statuses of entities on the individual pages.
This option activates the entity pages on the Home Screen.
The entity pages can be used for example to display values or statuses of entities on the individual pages.
### Entity Page 01-04 name - LABEL (Optional)
Naming of the corresponding Entity Screens.