Updated Integrations (markdown)

rstrouse 2023-09-24 12:03:40 -07:00
parent 9ca33be45a
commit 7e0a4228c3

@ -578,8 +578,115 @@ ESPSomfy-RTS publishes attributes to your MQTT broker and subscribes to topics t
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/b6c578ef-2d55-4d3a-b259-054ac99ef185)
## Published Topics
ESPSomfy RTS publishes information related to the configured shades and groups in a hierarchical tree of topics. All ESPSomfy RTS topics are published to a root topic that you set in the configuration. At startup all topics are published but ESPSomfy RTS will only publish topic data when there is a change so you can subscribe to the topic and receive real time updates. While there is a complete list of the available topics below, you should use a tool such as MQTT Explorer when developing with MQTT. This will save you countless hours of trial and error.
### \[root topic\]/shades/\[shadeId\]/shadeId
The shade id
### \[root topic\]/shades/\[shadeId\]/name
The name set for the shade
### \[root topic\]/shades/\[shadeId\]/remoteAddress
The address assigned to the shade
### \[root topic\]/shades/\[shadeId\]/shadeType
The shade type assigned to the shade
* 0 = Roller Shade
* 1 = Blind
* 2 = Left pull drapery
* 3 = Awning
* 4 = Shutter
* 5 = Garage (1-button)
* 6 = Garage (3-button)
* 7 = Right pull drapery
* 8 = Center pull drapery
* 9 = Dry Contact
### \[root topic\]/shades/\[shadeId\]/tiltType
The tilt type if the shade type is blind
* 0 = None
* 1 = Tilt Motor
* 2 = Integrated Tilt
* 3 = Tilt Only
### \[root topic\]/shades/\[shadeId\]/flipCommands
Indicates whether up is down and down is up. Valid values are true or false
### \[root topic\]/shades/\[shadeId\]/flipPosition
Indicates whether 100% is open or closed. Valid values are true or false
### \[root topic\]/shades/\[shadeId\]/position
The current lift position in percentage of the motor.
### \[root topic\]/shades/\[shadeId\]/tiltPosition
The current tilt position in percentage of the motor.
### \[root topic\]/shades/\[shadeId\]/direction
The current direction of the motor movement. This will be one of the following values
-1 = The shade is moving up
0 = The shade is stopped
1 = The shade is moving down
### \[root topic\]/shades/\[shadeId\]/target
The lift position that the shade is seeking
### \[root topic\]/shades/\[shadeId\]/tiltTarget
The tilt position that the shade is seeking
### \[root topic\]/shades/\[shadeId\]/lastRollingCode
The last rolling code that was used to send the last command from ESPSomfy RTS
### \[root topic\]/shades/\[shadeId\]/mypos
The current favorite lift position. -1 is unset
### \[root topic\]/shades/\[shadeId\]/myTiltPos
The current favorite tilt position. -1 is unset
### \[root topic\]/shades/\[shadeId\]/sunSensor
Indicates the existence of a sun sensor. Valid values are true or false
### \[root topic\]/shades/\[shadeId\]/sunFlag
Indicates whether the sun sensor is enabled or not. Valid values are 0 or 1
### \[root topic\]/shades/\[shadeId\]/sunny
Indicates whether the shade thinks it is sunny or not. Valid values are 0 or 1
### \[root topic\]/shades/\[shadeId\]/windy
Indicates whether the shade thinks it is windy or calm. Valid values are 0 or 1
### \[root topic\]/groups/\[groupId\]/groupId
The group id
### \[root topic\]/groups/\[groupId\]/name
The name set for the group
### \[root topic\]/groups/\[groupId\]/remoteAddress
The address assigned to the group
### \[root topic\]/groups/\[groupId\]/direction
The current direction of the member motor movement. This will be one of the following values
-1 = The shades are moving up
0 = The shade are stopped
1 = The shades are moving down
### \[root topic\]/groups/\[groupId\]/lastRollingCode
The last rolling code that was used to send the last command from ESPSomfy RTS
### \[root topic\]/groups/\[groupId\]/sunSensor
Indicates the existence of a sun sensor for at least one member of the group. Valid values are true or false
### \[root topic\]/groups/\[groupId\]/sunFlag
Indicates whether the sun sensor is enabled or not for at least one member of the group. Valid values are 0 or 1
### \[root topic\]/groups/\[groupId\]/sunny
Indicates whether the group thinks it is sunny or not. Valid values are 0 or 1
### \[root topic\]/groups/\[groupId\]/windy
The whether the group thinks it is windy or calm. Valid values are 0 or 1
## Subscribed Topics
ESPSomfy RTS subscribes to topics on your MQTT broker. These topics are responded to immediately so please do not set a retain flag or a QoS greater than 0 for these. If you do, when ESPSomfy RTS connects to the broker it will send these commands again and just booh.
ESPSomfy RTS subscribes to topics on your MQTT broker. These topics are responded to immediately so please do not set a retain flag or a QoS greater than 0 for these. If you do, when ESPSomfy RTS connects to the broker it will send these commands again and just booh. Also, do not publish to topics that are published by ESPSomfy RTS. These topics should be read only in that you should only subscribe to those topics. Publishing data to those topics will have you pulling your hair out.
### \[root topic\]/shades/\[shadeId\]/direction/set
Moves the shade in the direction of the numeric payload. This can be 0 for stop or toggle, 1 for down, and -1 for up.