You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/addon_climate.md
+21-17Lines changed: 21 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ substitutions:
34
34
wifi_ssid: !secret wifi_ssid
35
35
wifi_password: !secret wifi_password
36
36
ota_password: ""# Optional: set OTA password, or use ${wifi_password} for backward compatibility (see migration guide)
37
+
language: en # Language code - see docs/localization.md for all supported codes
37
38
38
39
# Add-on configuration (if needed)
39
40
## Upload TFT
@@ -68,23 +69,23 @@ packages:
68
69
The following keys are available to be used in your `substitutions`:
69
70
70
71
<!-- markdownlint-disable MD013 MD033 -->
71
-
Key|Required|Supported values|Default|Description
72
-
:-|:-:|:-:|:-:|:-
73
-
cooler_relay|Mandatory for *cool* and *dual*|`1` or `2`|`0` (disabled)|Relay used to control the cooler. Use `1` for "Relay 1" or `2` for "Relay 2".
74
-
heater_relay|Mandatory for *heat* and *dual*|`1` or `2`|`0` (disabled)|Relay used to control the heater. Use `1` for "Relay 1" or `2` for "Relay 2".
75
-
temp_units|Optional|`°C` or `°F`|`°C`|Temperature unit.
76
-
min_off_time|Optional|Positive integer representing the number of seconds|`300`|Minimum duration (in seconds) the cooling/heating action must be disengaged before it may be engaged.
77
-
min_run_time|Optional|Positive integer representing the number of seconds|`300`|Minimum duration (in seconds) the cooling/heating action must be engaged before it may be disengaged.
78
-
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.
79
-
target_low|Optional|Number representing a temperature in the selected unit|`18` (°C) or `64` (°F)|The initial lower threshold for the target temperature.
80
-
target_high|Optional|Number representing a temperature in the selected unit|`24` (°C) or `75` (°F)|The initial higher threshold for the target temperature.
81
-
temp_min|Optional|Number representing a temperature in the selected unit|*cool: `15` (°C) or `60` (°F)*<br>*heat: `7` (°C) or `45` (°F)*<br>*dual: `7` (°C) or `45` (°F)* |The minimum temperature the climate device can reach. Used to set the range of the frontend gauge.
82
-
temp_max|Optional|Number representing a temperature in the selected unit|*cool: `45` (°C) or `113` (°F)*<br>*heat: `35` (°C) or `95` (°F)*<br>*dual: `45` (°C) or `113` (°F)* |The maximum temperature the climate device can reach. Used to set the range of the frontend gauge.
83
-
~temp_step~|Deprecated|~Number representing a temperature in the selected unit~|~`0.5`~<br>`0.5` (°C) or `1` (°F)|~The granularity with which the target temperature can be controlled.~
84
-
cool_deadband|Optional|Number representing a temperature hysteresis in the selected unit|`0.5` (°C) or `1` (°F)|The minimum temperature differential (temperature above the set point) before engaging cooling.
85
-
cool_overrun|Optional|Number representing a temperature hysteresis in the selected unit|`0.5` (°C) or `1` (°F)|The minimum temperature differential (cooling beyond the set point) before disengaging cooling.
86
-
heat_deadband|Optional|Number representing a temperature hysteresis in the selected unit|`0.5` (°C) or `1` (°F)|The minimum temperature differential (temperature below the set point) before engaging heat.
87
-
heat_overrun|Optional|Number representing a temperature hysteresis in the selected unit|`0.5` (°C) or `1` (°F)|The minimum temperature differential (heating beyond the set point) before disengaging heat.
|cooler_relay|Mandatory for *cool* and *dual*|`1` or `2`|`0` (disabled)|Relay used to control the cooler. Use `1` for "Relay 1" or `2` for "Relay 2".|
75
+
|heater_relay|Mandatory for *heat* and *dual*|`1` or `2`|`0` (disabled)|Relay used to control the heater. Use `1` for "Relay 1" or `2` for "Relay 2".|
76
+
|temp_units|Optional|`°C` or `°F`|`°C`|Temperature unit.|
77
+
|min_off_time|Optional|Positive integer representing the number of seconds|`300`|Minimum duration (in seconds) the cooling/heating action must be disengaged before it may be engaged.|
78
+
|min_run_time|Optional|Positive integer representing the number of seconds|`300`|Minimum duration (in seconds) the cooling/heating action must be engaged before it may be disengaged.|
79
+
|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.|
80
+
|target_low|Optional|Number representing a temperature in the selected unit|`18` (°C) or `64` (°F)|The initial lower threshold for the target temperature.|
81
+
|target_high|Optional|Number representing a temperature in the selected unit|`24` (°C) or `75` (°F)|The initial higher threshold for the target temperature.|
82
+
|temp_min|Optional|Number representing a temperature in the selected unit|*cool: `15` (°C) or `60` (°F)*<br>*heat: `7` (°C) or `45` (°F)*<br>*dual: `7` (°C) or `45` (°F)*|The minimum temperature the climate device can reach. Used to set the range of the frontend gauge.|
83
+
|temp_max|Optional|Number representing a temperature in the selected unit|*cool: `45` (°C) or `113` (°F)*<br>*heat: `35` (°C) or `95` (°F)*<br>*dual: `45` (°C) or `113` (°F)*|The maximum temperature the climate device can reach. Used to set the range of the frontend gauge.|
84
+
|~temp_step~|Deprecated|~Number representing a temperature in the selected unit~|~`0.5`~<br>`0.5` (°C) or `1` (°F)|~The granularity with which the target temperature can be controlled.~|
85
+
|cool_deadband|Optional|Number representing a temperature hysteresis in the selected unit|`0.5` (°C) or `1` (°F)|The minimum temperature differential (temperature above the set point) before engaging cooling.|
86
+
|cool_overrun|Optional|Number representing a temperature hysteresis in the selected unit|`0.5` (°C) or `1` (°F)|The minimum temperature differential (cooling beyond the set point) before disengaging cooling.|
87
+
|heat_deadband|Optional|Number representing a temperature hysteresis in the selected unit|`0.5` (°C) or `1` (°F)|The minimum temperature differential (temperature below the set point) before engaging heat.|
88
+
|heat_overrun|Optional|Number representing a temperature hysteresis in the selected unit|`0.5` (°C) or `1` (°F)|The minimum temperature differential (heating beyond the set point) before disengaging heat.|
88
89
89
90
<!-- markdownlint-enable MD013 MD033 -->
90
91
@@ -104,6 +105,7 @@ substitutions:
104
105
wifi_ssid: !secret wifi_ssid
105
106
wifi_password: !secret wifi_password
106
107
ota_password: ""# Optional: set OTA password, or use ${wifi_password} for backward compatibility (see migration guide)
108
+
language: en # Language code - see docs/localization.md for all supported codes
107
109
108
110
# Add-on configuration (if needed)
109
111
## Upload TFT
@@ -146,6 +148,7 @@ substitutions:
146
148
wifi_ssid: !secret wifi_ssid
147
149
wifi_password: !secret wifi_password
148
150
ota_password: ""# Optional: set OTA password, or use ${wifi_password} for backward compatibility (see migration guide)
151
+
language: en # Language code - see docs/localization.md for all supported codes
149
152
150
153
# Add-on configuration (if needed)
151
154
## Upload TFT
@@ -188,6 +191,7 @@ substitutions:
188
191
wifi_ssid: !secret wifi_ssid
189
192
wifi_password: !secret wifi_password
190
193
ota_password: ""# Optional: set OTA password, or use ${wifi_password} for backward compatibility (see migration guide)
194
+
language: en # Language code - see docs/localization.md for all supported codes
Copy file name to clipboardExpand all lines: docs/api.md
+2-10Lines changed: 2 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ You can look up the action names available on your Home Assistant instance under
60
60
### Table of Contents
61
61
<!-- markdownlint-disable MD013 -->
62
62
| Action ID | Action Name | Description |
63
-
|------------|--------------|-------------|
63
+
|---------|-----------|-----------|
64
64
|[`button`](#button-action-button)|[Button Action](#button-action-button)| Configures properties and state of buttons on a specified button page. |
65
65
|[`command`](#command-action-command)|[Command Action](#command-action-command)| Sends a custom command directly to the display. |
66
66
|[`component_color`](#component-color-action-component_color)|[Component Color Action](#component-color-action-component_color)| Changes the foreground color of a specified component on the display. |
@@ -503,7 +503,6 @@ The bitmask values are aligned with the
503
503
- `code_format` (string): Specifies the code format required for arming/disarming the alarm system, such as numeric or alphanumeric.
504
504
- `code_arm_required` (bool): Indicates whether a code is required to arm the system.
505
505
- `entity` (string): The entity ID of the alarm system, used for state updates and control actions.
506
-
- `mui_alarm` (string[]): An array of localized text strings for the alarm control buttons, supporting various alarm states and actions.
507
506
508
507
**Home Assistant Example:**
509
508
@@ -516,13 +515,6 @@ data:
516
515
code_format: "number"
517
516
code_arm_required: true
518
517
entity: "alarm_control_panel.home_alarm"
519
-
mui_alarm:
520
-
- "Zuhause"
521
-
- "Abwesend"
522
-
- "Nacht"
523
-
- "Urlaub"
524
-
- "Umgehen"
525
-
- "Entwaffnen"
526
518
```
527
519
528
520
> [!NOTE]
@@ -729,7 +721,7 @@ RTTTL is a compact format for storing melody sequences in a text-based format, m
729
721
This string must conform to the RTTTL format, which includes the melody's name, default settings, and a sequence of notes.
730
722
731
723
**Example Tones:**
732
-
For example tones and further inspiration, you can visit examples of RTTTL songs [here](https://esphome.io/components/rtttl/#common-beeps).
724
+
For example tones and further inspiration, you can visit this list with [examples of RTTTL songs](https://esphome.io/components/rtttl/#common-beeps).
Copy file name to clipboardExpand all lines: docs/blueprint.md
+15-5Lines changed: 15 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ The individual elements of the Blueprint are described below.
9
9
10
10
It is possible to change both the color of the labels and the icons for most of the elements on each screen.
11
11
12
-
On the blueprint settings, you will be able to select any of the MDI icons supported by Home Assistant, however, your panel will only support the icons available on the [HASwitchPlate Material Design Icons](https://htmlpreview.github.io/?https://github.com/jobr99/Generate-HASP-Fonts/blob/master/cheatsheet.html).
12
+
On the blueprint settings, you will be able to select any of the MDI icons supported by Home Assistant,
13
+
however, your panel will only support the icons available on the
14
+
[HASwitchPlate Material Design Icons](https://htmlpreview.github.io/?https://github.com/jobr99/Generate-HASP-Fonts/blob/master/cheatsheet.html).
13
15
14
16
For an easier overview, the menu items "Icon Color" and "Label Color" will not be described separately in the following documentation.
15
17
@@ -26,10 +28,18 @@ This is technically the only required field, as basic functionality will be avai
26
28
27
29
### Language for NSPanel
28
30
29
-
The language can be selected via the drop-down menu.
31
+
Language is no longer configured in the Blueprint. It is now set directly in your ESPHome YAML
32
+
as a substitution, which means only your chosen language's strings are compiled into the firmware —
33
+
saving memory and allowing the panel to display correct date and UI strings even when offline.
30
34
31
-
Currently around 30 languages are supported, but if you cannot find your language there,
32
-
please create a [new feature request](https://github.com/edwardtfn/NSPanel-Easy/issues/new) and we will be happy to help.
35
+
To set your language, add the `language` substitution to your ESPHome YAML:
36
+
37
+
```yaml
38
+
substitutions:
39
+
language: pt # Portuguese - see docs/localization.md for all supported codes
40
+
```
41
+
42
+
For the full list of supported language codes, see [Localization](localization.md).
33
43
34
44
### Date format
35
45
@@ -63,7 +73,7 @@ If the value of the sensor needs to be corrected, this can be done via the tempe
63
73
## Home page - Entities States
64
74
65
75
| Entity | Description | Example |
66
-
| --- | --- | ---|
76
+
| --- | --- | --- |
67
77
| Home page - Entity State 01-04 (Optional) | Up to four HA entities can be displayed on the home screen. |  |
68
78
| Home page - Chips 01-07 (optional) | Used to display icons of HA binary entities on the home screen. The icon is displayed when the entity is on/open/true/active. Otherwise, no icon is displayed. |  |
69
79
| Custom button 01-06 (Optional) | 7 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, such as light, media player, etc. |  |
0 commit comments