Skip to content

Commit

Permalink
Merge pull request #2236 from briangunderson/patch-1
Browse files Browse the repository at this point in the history
Update lovelace_ui.md
  • Loading branch information
edwardtfn authored Aug 29, 2024
2 parents 2307ea3 + fa5b871 commit e146b1f
Show file tree
Hide file tree
Showing 13 changed files with 216 additions and 210 deletions.
5 changes: 5 additions & 0 deletions ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -920,6 +920,10 @@ This update is crucial for users leveraging BLE functionality, and the new boot
This hotfix addresses a critical issue introduced in v4.3.10 where the incorrect TFT file was used during the download process.
The fix has been applied to the release flow, but updating your firmware (ESPHome) is required, and it is recommended to also update the Blueprint and TFT components.

> [!WARNING]
> Home Assistant v2024.8.0 is required.
> Please take a look at our [Version compatibility matrix](https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/version_compatibility.md) for a full list.
### Incorrect TFT File Download Issue Resolved (#2223)
- **Criticality:** Major
- **Affected Components:** Release Flow, ESPHome, Blueprint, TFT
Expand All @@ -944,6 +948,7 @@ Your efforts have significantly improved its functionality and reliability (#183
- **@andythomas**: For the comprehensive enhancements made to our documentation.
Your contributions have made our guides more informative and accessible, enriching the user experience for everyone (#1865).
- **@AJediIAm**: For the valuable contributions in reviewing and improving the installation documentation (#2106 & #2107).
- **@briangunderson**: For updating the docs to reflect to the new name for '**action**' (formelly '**service**') on Home Assistant v2024.8.0 (#2236)

## Previous releases
- [v4.3.10 - Boot Stability Enhancements and Troubleshooting Support](https://github.com/Blackymas/NSPanel_HA_Blueprint/releases/tag/v4.3.10)
Expand Down
2 changes: 1 addition & 1 deletion docs/addon_cover.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ packages:
For this add-on, all the basic settings are accessible via the device's page in
your Home Assistant. For most cases, no additional YAML settings are needed.
You will find the following configuration entities under the device's page (**Settings** > **Devices & Services** > **ESPHome**):
You will find the following configuration entities under the device's page (**Settings** > **Devices & services** > **ESPHome**):
<!-- markdownlint-disable MD013 MD033 -->
Expand Down
18 changes: 9 additions & 9 deletions docs/alarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,36 @@ You can control an Alarm Control Panel from your NSPanel, which allows you to se
modes supported by Home Assistant (Home, Away, Night, Vacation, or Custom bypass) or disarm the alarm.

Currently, the NSPanel supports alarms without a code or with a numeric code. For alarms using a text code,
the NSPanel will display it, but interactions (like button clicks) will send service calls to Home Assistant
the NSPanel will display it, but interactions (like button clicks) will send action calls to Home Assistant
without the code, leading to failed operations that require a code.

> [!IMPORTANT]
> **Security advisory**
> The default communication between your NSPanel (ESPHome) and Home Assistant (HA) is not encrypted. This
> could allow someone with network access to monitor and replicate the service calls. This risk is
> could allow someone with network access to monitor and replicate the action calls. This risk is
> particularly relevant when controlling your alarm system.
>
> To enhance security, we strongly recommend enabling API encryption for NSPanel users managing an Alarm
> system. Follow the instructions in the ["API encryption" example here](customization.md#api-encryption)
> to implement this security measure.
## Configuration

### Allow the device to make Home Assistant service calls
### Allow the device to perform Home Assistant actions

First, you need to configure your Home Assistant to permit your NSPanel to make service calls. While
most services are handled via the Blueprint, ESPHome needs to send events with all necessary data in
plain text for these service calls. To mitigate any security risks, alarm-related calls are managed
First, you need to configure your Home Assistant to permit your NSPanel to perform actions. While
most actions are handled via the Blueprint, ESPHome needs to send events with all necessary data in
plain text for these action calls. To mitigate any security risks, alarm-related calls are managed
directly by the panel.

To enable this:
1. Go to your ESPHome integrations panel (Settings > Devices and Services > ESPHome).
1. Go to your ESPHome integrations panel (Settings > Devices and services > ESPHome).
2. Click "Configure" next to your panel's entry.

![Configure option in ESPHome integrations panel](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/37bfc622-c0cd-4941-a397-3eeb2ddbe6a2)

3. Select the "Allow the device to make Home Assistant service calls" option.
3. Select the "**Allow the device to perform Home Assistant actions**" option.

![Allow service calls option in ESPHome configuration](https://github.com/Blackymas/NSPanel_HA_Blueprint/assets/94725493/9b20a1b6-94ad-4fff-aef2-eb3599db9bf1)
![Allow the device to perform Home Assistant actions](pics/Allow_the_device_to_perform_Home_Assistant_actions.png)

### Blueprint settings

Expand Down
Loading

0 comments on commit e146b1f

Please sign in to comment.