aaribaud/ESPSomfy-RTS
0
0
Fork 0
mirror of https://github.com/rstrouse/ESPSomfy-RTS.git synced 2025-12-15 03:52:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Integrations (markdown)

rstrouse 2023-07-08 15:19:48 -07:00
parent 0a8f43062e
commit bca9a78b42
1 changed files with 39 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

39
Integrations.md

@ -96,6 +96,23 @@ See `GET /groups` endpoint for descriptions of group reference objects.
</details>
## GET|PUT|POST /groupCommand
Sends a command for a group.
### Parameters
* `groupId` - The id of the group to send the command to [1-16].
* `command` - The command to send to the group.
* `m | My | my` - My
* `u | Up | up` - Up
* `d | Down | down` - Down
* `repeat` - The number of repeats to send for the group. ESPSomfy RTS sends 1 frame plus 1 repeat for a total of 2 frames.
`GET /groupCommand?groupId=1&command=up` - Moves all the shades in the group to the full open position.
`GET /groupCommand?groupId=1&command=my` - Moves all the shades in the group that are currently stationary to the favorite position.
### Returns
JSON reference to the group
## GET /groups
Gets an array of groups that are configured on the device
@ -459,6 +476,28 @@ An array of shade reference objects
</details>
## GET|PUT|POST /tiltCommand
Tilts the slats for a blind
### Parameters
* `shadeId` - The id of the shade to send the command to [1-32].
* `command` - Optional tilt command to send to the shade. You must supply the target or the command.
* `m | My | my` - My
* `u | Up | up` - Up
* `d | Down | down` - Down
* `su | StepUp | stepup` - StepUp (80-bit only simulates the thumbwheel)
* `sd | StepDown | stepdown` - StepDown (80-bit only simulates the thumbwheel)
* `target` - Optional target for the slat position [0-100].
* `repeat` - The number of repeats to send for the shade. ESPSomfy RTS sends 1 frame plus 1 repeat for a total of 2 frames.
`GET /tiltCommand?shadeId=1&command=up` - Tilts the slats open.
`GET /tiltCommand?shadeId=1&command=my` - Moves the slats to the favorite position if stationary or stops the movement if moving.
`GET /tiltCommand?shadeId=1&target=35` - Moves the slats to 35%.
### Returns
JSON reference to the group
# MQTT
ESPSomfy-RTS publishes attributes to your MQTT broker and subscribes to topics that allow you to control the shades. To enable your broker connect it in the configuration pages under MQTT. This will begin reporting the shade status to your broker under the topic you assigned.