public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[somfytahoma] added support for the control over the LAN (local mode) (#13411)

Browse Source 
* [somfytahoma] added support for the control over the LAN (local mode)

Signed-off-by: Ondrej Pecta <opecta@gmail.com>
This commit is contained in:
Ondrej Pecta
2022-12-11 12:07:25 +01:00
committed by GitHub
parent 48b471a313
commit 45052a810c
17 changed files with 646 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
bundles/org.openhab.binding.somfytahoma/README.md
View File

@@ -45,7 +45,7 @@ Any home automation system based on the OverKiz API is potentially supported.
- water heater system (monitor and control)
- Yutaki heat pump consisting of heat pump, heating control and hot water tank (controls and a lot of states; it is tested with components RAS-4WHNPE, RWM-4.ONE, DHWT-300S-3.0H2E)
Both Somfy Tahoma and Somfy Connexoon gateways have been confirmed working.
Both Somfy Tahoma and Somfy Connexoon gateways have been confirmed working in the cloud mode.
## Discovery
@@ -59,7 +59,41 @@ If you are missing some device, check the debug log during the discovery and cre
## Thing Configuration
To retrieve thing configuration and url parameter, just add the automatically discovered device from your inbox and copy its values from thing edit page. (the url parameter is visible on edit page only)
### bridge
| Parameter | Parameter ID | Required/Optional | Description |
|----------------|---------------|-------------------|--------------------------------------------------------------------------------------|
| Cloud portal | cloudPortal | Optional | Cloud portal to connect to |
| Email address | email | Required | Email address for the portal |
| Password | password | Required | Password for the portal |
| Refresh | refresh | Optional | Refresh time for polling events (in seconds) |
| Status timeout | statusTimeout | Optional | Reconciliation timeout after which the status is refreshed (in seconds) |
| Retries | retries | Optional | Specifies the number of retries when command execution |
| Retry delay | retryDelay | Optional | Delay in milliseconds between subsequent retries after a command failure |
| Developer mode | devMode | Optional | Enables the direct control of your devices over the lan using the local API endpoint |
| Gateway IP | ip | Optional | Local IP address of gateway, relevant only if developer mode is enabled |
| Gateway PIN | pin | Optional | Gateway PIN in format ABCD-EFGH-IJKL, relevant only if developer mode is enabled |
| Local token | token | Optional | Token for local communication, relevant only if developer mode is enabled |
For more information about the developer mode please see https://github.com/Somfy-Developer/Somfy-TaHoma-Developer-Mode.
If the gateway ip or pin are not provided, the binding tries to detect it automatically and saves it into the configuration.
If the local token is not provided, the binding creates the local token automatically and saves it into the configuration.
Please note that the action groups (scenarios) control does not work in local mode due to missing support in the gateway firmware.
The gateway support for the developer mode is limited as well, so far Connexoon gateways do not support the developer mode.
### gateway
| Parameter | Parameter ID | Required/Optional | Description |
|------------|--------------|-------------------|-------------------------------------------|
| Gateway id | id | Required | ID of your gateway (sometimes called pin) |
### other devices
| Parameter | Parameter ID | Required/Optional | Description |
|------------|--------------|-------------------|------------------------------|
| Device URL | url | Required | The identifier of the device |
To retrieve the url parameter or gateway id, just add the automatically discovered device from your inbox and copy its values from thing edit page. (the url parameter is visible on edit page only)
Please see the example below.
## Channels
@@ -73,7 +107,7 @@ Please see the example below.
| gate | gate_state | get state of your gate (open, closed, pedestrian) |
| gate | gate_position | get position (0-100%) of your gate (where supported) |
| roller shutter, shutter, screen, ven. blind, garage door, awning, pergola, curtain | control | device controller which reacts to commands UP/DOWN/ON/OFF/OPEN/CLOSE/MY/STOP + closure 0-100 |
| roller shutter | moving | Indicates if the device is currently operating a command |
| roller shutter | moving | Indicates if the device is currently operating a command |
| window | control | device controller which reacts to commands UP/DOWN/ON/OFF/OPEN/CLOSE/STOP + closure 0-100 |
| silent roller shutter | silent_control | similar to control channel but in silent mode |
| venetian blind, adjustable slats roller shutter, bioclimatic pergola | orientation | percentual orientation of the blind's slats, it can have value 0-100. For IO Homecontrol devices only (non RTS) |
@@ -150,7 +184,7 @@ Please see the example below.
| hitachi (yutaki) air to water heating zone | zone_mode | sets the zone mode (Auto, Manual) |
| hitachi (yutaki) air to water heating zone | thermostat_setting_zone1 | controls the thermostat setting for the zone 1 |
| hitachi (yutaki) air to water heating zone | wh_setting_temp_zone1 | controls the water heating setting temperature for the zone 1 |
| hitachi (yutaki) air to water heating zone | room_ambient_temp_zone1 | controls the room ambient temperature for the zone 1 |
| hitachi (yutaki) air to water heating zone | room_ambient_temp_zone1 | controls the room ambient temperature for the zone 1 |
| hitachi (yutaki) domestic hot water | anti_legionella | controls the anti legionella mode (Run, Stop) |
| hitachi (yutaki) domestic hot water | anti_legionella_temp | controls the anti legionella temperature |
| hitachi (yutaki) domestic hot water | target_boost_mode | controls the boost mode (No request, Enabled, Disabled) |