Add Alarm docs
Update docs to reflect the current state (new features & changes)
This commit is contained in:
Edward Firmo
107
README.md
107
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 :)**_
|
||||
|
||||
|
||||
## NSPanel:
|
||||
|
||||
|
||||
@@ -35,46 +36,46 @@ The goal was to create a version that allows everyone to use the NSpanel fully l
|
||||
|
||||
|
||||
|
||||
(Home and Buttonpage)
|
||||
(Home and Button page)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(Lightsettings - Brightness and TEMP Color)
|
||||
(Light settings - Brightness and TEMP Color)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(Colorwheel and Thermostat)
|
||||
(Light color wheel and Thermostat)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(Coversetting and Weather Forecast)
|
||||
(Cover settings and Weather forecast)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(NSPanel Settings and Boot Screen)
|
||||
(NSPanel settings and Boot screen)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
(HA Device Setting for Example temperature correction)
|
||||
|
||||
(HA device settings - Temperature correction)
|
||||
|
||||
|
||||
## Blueprint:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
- Light control (brightness-slider, colorwheel, TempColor-slider) - via long Press
|
||||
- Cover control (open, close, position-slider) - via long press
|
||||
- Thermostat + Touch + [Relay control for floor heating](/docs/en/addon_climate.md)
|
||||
- Light control (brightness, color and temperature) - 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 ;)
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
## Button Page
|
||||
- 32 Button
|
||||
|
||||
### Button Page
|
||||
- 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
|
||||
- automatic detection by long press if it is a light or cover for submenu
|
||||
- swipe between all pages
|
||||
- swipe also down and up for fast access to certain pages
|
||||
- All buttons with long press function
|
||||
- Automatic detection by long press if it is a light, cover or climate for submenu
|
||||
- Swipe between all pages
|
||||
- Swipe also down and up for fast access to certain pages
|
||||
|
||||
|
||||
## Light Settings
|
||||
|
||||
### Light Settings
|
||||
- Light current state
|
||||
- Brightness Slider
|
||||
- Colorwheel
|
||||
- TempColor slider
|
||||
- Brightness slider
|
||||
- RGB color wheel
|
||||
- Color temperature slider
|
||||
- Jump back to the right button page
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
### 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
|
||||
- Touch Temp control
|
||||
- Outside temperature
|
||||
- Hot water
|
||||
- heating on, off and idle
|
||||
- Hot water button
|
||||
|
||||
### Fan speed
|
||||
- Turn-on and turn-off fan
|
||||
- Set speed via slider or buttons
|
||||
- jump back to the right button page
|
||||
|
||||
|
||||
## Weather Forecast
|
||||
- 5 days Weather Forecast via swipe (Integration Accuweather - but should also go with other integrations)
|
||||
- Lowest and highest temperature outside
|
||||
|
||||
### Weather Forecast
|
||||
- 5 days weather forecast via swipe (supports most used weather integrations)
|
||||
- Min and max outside temperatures
|
||||
- Date
|
||||
- Rain probability
|
||||
- Sunshine hours
|
||||
- UV index
|
||||
- Thunderstorm probability
|
||||
- Wind speed
|
||||
- Other weather parameters (when provided by your integration):
|
||||
- Rain probability
|
||||
- Sunshine hours
|
||||
- UV index
|
||||
- Thunderstorm probability
|
||||
- Wind speed
|
||||
|
||||
|
||||
## 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 %
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Thanks to:
|
||||
SmartHome Yourself: https://www.youtube.com/c/SmarthomeyourselfDe_DIY
|
||||
|
||||
|
||||
Reference in New Issue
Block a user