Add Alarm docs

Update docs to reflect the current state (new features & changes)
2023-08-11 11:11:09 +02:00
parent 186447109b
commit da6d8c1c5e
3 changed files with 90 additions and 57 deletions
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 🙋 WE ARE LOOKING FOR YOU! _**We are always looking for people who would like to support this project. We are looking for help with "programming new features, writing documentation or translating documentation to EN. If you are interested then please contact us :)**_
 &nbsp;
 ## NSPanel:
 ![2 Home](https://user-images.githubusercontent.com/41958506/212768891-9610d800-43c5-454f-a8b6-6b7c43677b5d.png)
@@ -35,46 +36,46 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 ![3 Buttonpage](https://user-images.githubusercontent.com/41958506/203654022-c6d81263-ce56-4a84-917a-9d4911f19f55.png)
 ![NEW Domains](https://user-images.githubusercontent.com/41958506/206879659-3aea30c1-b126-4d52-a869-abf6adfc8fa1.png)
-(Home and Buttonpage)
+(Home and Button page)
 ![4 lightsetting 1](https://user-images.githubusercontent.com/41958506/203654055-943d1910-7673-4d9f-ad81-7ef00d155e5a.png)
 ![5 Lightsetting 2](https://user-images.githubusercontent.com/41958506/203654076-93e110df-f314-4cf1-8500-ed667f2202fd.png)
-(Lightsettings - Brightness and TEMP Color)
+(Light settings - Brightness and TEMP Color)
 ![6 Lightsetting 3](https://user-images.githubusercontent.com/41958506/203654179-f7303b02-c886-4890-b976-cb498940a627.png)
 ![7 Thermostat](https://user-images.githubusercontent.com/41958506/203654189-4294b634-430f-423c-b170-9f1680f94b0e.png)
-(Colorwheel and Thermostat)
+(Light color wheel and Thermostat)
 ![8 Cover](https://user-images.githubusercontent.com/41958506/203654290-c6ec2f2f-7924-492c-914c-0d96dc3907e0.png)
 ![9 Weather](https://user-images.githubusercontent.com/41958506/203654307-24000d00-b7e1-47eb-bd64-9e97b508db52.png)
-(Coversetting and Weather Forecast)
+(Cover settings and Weather forecast)
 ![10 Settings](https://user-images.githubusercontent.com/41958506/203654386-e4e574ad-8674-4268-84dd-1c4e40f98eb9.png)
 ![1 Boot](https://user-images.githubusercontent.com/41958506/203667473-d33523a4-3197-4838-9099-cccebfc727db.png)
-(NSPanel Settings and Boot Screen)
+(NSPanel settings and Boot screen)
 ![Device Setting 1](https://user-images.githubusercontent.com/41958506/203723223-8afc0e44-51cf-49ed-8a49-8ba713716639.png)
 ![Device Setting 2](https://user-images.githubusercontent.com/41958506/203724491-53ecd93d-bc7c-4c2d-850b-f106691e2639.png)
-(HA Device Setting for Example temperature correction)
+(HA device settings - Temperature correction)
 &nbsp;
 ## Blueprint:
 ![Blueprint 1](https://user-images.githubusercontent.com/41958506/203655004-a11f5a1c-d098-4e1a-958a-0293e50000b2.png)
 ![Blueprint 2](https://user-images.githubusercontent.com/41958506/203655014-e6cae9df-aaf8-4537-8165-b8f44a177d3b.png)
-
+&nbsp;
 ## Features:
 - Easy to use and simple configuration via Blueprint - no change in the code is necessary
 - 32 buttons on 4 button pages with long press function for settings (more buttons are also possible)
@@ -82,9 +83,9 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 - Buttons show current brightness and cover position in the button itself
 - Buttons label can be assigned via blueprint
 - Weather + 5 days weather forecast
- Thermostat + Touch + Relay control for floor heating
+- Thermostat + Touch + [Relay control for floor heating](/docs/en/addon_climate.md)
- Light control (brightness-slider, colorwheel, TempColor-slider) - via long Press
+- Light control (brightness, color and temperature) - via long Press
- Cover control (open, close, position-slider) - via long press
+- Cover control (open, close and position) - via long press
 - Settings page (display brightness, display dim brightness, sleep mode, reboot NSPanel)
 - Swipe between pages
 - Top menu with 10 icons for specific states
@@ -93,10 +94,10 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 - 2 physical switches with optional fallback mode
 - and much more ;)
 &nbsp;
 ## Pages
-# Pages
+### Home
 ## Home
 - Current weather with button to Weather Forcast page
 - Hardware buttons can be freely assigned
 - Hardware button label (optional)
@@ -107,63 +108,69 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
 - Room humidity
 - Up to 3 user's selectable entities
-
+&nbsp;
-## Button Page
+### Button Page
- 32 Button
+- Up to 32 buttons
 - 4 Button pages
 - Button design is automatically generated based on the selected entity
 - Buttons show current brightness and cover position in the button itself
 - Buttons label can be assigned via blueprint
- all buttons with long press function
+- All buttons with long press function
- automatic detection by long press if it is a light or cover for submenu
+- Automatic detection by long press if it is a light, cover or climate for submenu
- swipe between all pages 
+- Swipe between all pages 
- swipe also down and up for fast access to certain pages
+- Swipe also down and up for fast access to certain pages
-
+&nbsp;
-## Light Settings
+### Light Settings
 - Light current state
- Brightness Slider
+- Brightness slider
- Colorwheel
+- RGB color wheel
- TempColor slider
+- Color temperature slider
 - Jump back to the right button page
-
+&nbsp;
-## Cover Settings
+### Cover Settings
 - Open and close cover
 - Cover position via slider
- Cover battery value if available (I use Ikea roller blind)
+- Cover battery value (when available)
 - jump back to the right button page
 &nbsp;
 ### Thermostat / Climate
 - Target temperature control slider 
 - Current temperature
 - 4 user's selectable values (for water and external temperatures, etc.)
 - All the standard climate controls from Home Assistant (`heat`, `fan`, `cool`, `auto`, `dry`)
 - 2 user's selectable buttons
 - [Can be used for local control (even when Wi-Fi is unavailable) when your panel's relays are used to control your heater](/docs/en/addon_climate.md)
-## Thermostat
+&nbsp;
- Touch Temp control 
+### Fan speed
- Outside temperature
+- Turn-on and turn-off fan
- Hot water
+- Set speed via slider or buttons
- heating on, off and idle
+- jump back to the right button page
 - Hot water button
-
+&nbsp;
-## Weather Forecast
+### Weather Forecast
- 5 days Weather Forecast via swipe (Integration Accuweather - but should also go with other integrations)
+- 5 days weather forecast via swipe (supports most used weather integrations)
- Lowest and highest temperature outside
+- Min and max outside temperatures
 - Date
- Rain probability
+- Other weather parameters (when provided by your integration):
- Sunshine hours
+  - Rain probability
- UV index
+  - Sunshine hours
- Thunderstorm probability
+  - UV index
- Wind speed
+  - Thunderstorm probability
  - Wind speed
-
+&nbsp;
-## Display Settings
+### Display Settings
 - Restart NSPanel
- Sleep mode - display off after time X
+- Sleep mode - Turn off display after given time (seconds)
 - Display brightness slider
 - Display dim brightness slider
 - Status Brightness in %
 &nbsp;
 ## Thanks to:
 SmartHome Yourself: https://www.youtube.com/c/SmarthomeyourselfDe_DIY
--- a/ReleaseNotes.md
+++ b/ReleaseNotes.md
@@ -61,13 +61,11 @@ Please refeer to the [documentation](/docs/en/addon_climate.md) to get more deta
 &nbsp;
 ### 2. Alarm control panel
-recommend api-encryption: https://esphome.io/components/api.html#configuration-variables
+Now you can control an Alarm Control Panel from your NSPanel, which will allow you to set the alarm mode between the standard modes supported by Home Assistant (Home, Away, Night, Vacation or Custom bypass) or disarm the alarm.
-and, of course warn the user that this is a possible security issue.
+
-Anyways - this is also done with many other projects, AND it would require that a possible hacker is already inside the internal (or mayby iot) (W)LAN - and at this point....
+<<< ADD SCREENSHOT >>>
-recommend to have a big warning, and that the user has to take care about e.g.:
+
- secure internal network
+For more details, instructions and security considerations, please take a look at the [Alarm Control Panel docs](/docs/en/alarm.md).
 - split internal networks: IOT, Guest, Internal, Management, ...
 - enable api-encryption
 &nbsp;
 ### 3. Support to sensor display precision from Home Assistant
--- a/docs/en/alarm.md
+++ b/docs/en/alarm.md
@@ -0,0 +1,28 @@
 # Alarm Control Panel
 You can control an Alarm Control Panel from your NSPanel, which will allow you to set the alarm mode between the standard modes supported by Home Assistant (Home, Away, Night, Vacation or Custom bypass) or disarm the alarm.
 Currently, only alarms without a code will be supported. If your alarm requires a code, you will still be able to display it on your NSPanel, however, when you click in any button it will send services calls to Home Assistant without the code and it will fail for the service where a code is requires.
 &nbsp;
 ### Security advisory
 By default, the communication between your NSPanel (ESPHome) and Home Assistant (HA) is not encrypted, which means a person with access to your network could potentially monitor the communication between your panel and HA and replicate the service calls. Although this is not a big issue for most of the service calls (turn-on a light, close a curtain, etc.), it can be a problem when controlling your alarm system.<br>
 Based on that, we hardly reccoment the use of API encryption for all users controlling an Alarm system via a NSPanel. You can easily enable this by following the ["API encryption" example available here](customization.md#api-encryption).
 &nbsp;
 ## Configuration
 Open the automation based on the NSPanel Blueprint and look for a section related to "Alarm Control Panel".<br>
 Select your alarm control panel entity, click "Save", and your are done. :)<br>
 <<< ADD SCREENSHOT >>>>
 &nbsp;
 ## Controlling your alarm from your panel
 When an alarm control panel is set in your Blueprint automation, you will see the alarm icon on your panel's Home page:<br>
 <<< ADD ICON IMAGE >>>><br>
 ![Home page](https://user-images.githubusercontent.com/41958506/212768891-9610d800-43c5-454f-a8b6-6b7c43677b5d.png)
 A click on that icon will show the Alarm Control Panel page:<br>
 <<< ADD SCREENSHOT >>>>
 You can change your alarm settings with a single click on the button related to the new state you want to set your alarm to, or close the page to go back to Home page.