diff --git a/Integrations.md b/Integrations.md index bca8d46..9b39b27 100644 --- a/Integrations.md +++ b/Integrations.md @@ -96,6 +96,23 @@ See `GET /groups` endpoint for descriptions of group reference objects. +## 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 +## 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.