Skip to content

Commit ad850aa

Browse files
committed
added Somfy RTS docs
1 parent 9a3e8ec commit ad850aa

File tree

3 files changed

+46
-0
lines changed

3 files changed

+46
-0
lines changed

docs/setitup/actuators.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,9 @@
1515

1616
Vcc pin of the board and the Module to a 5V supply source
1717
Ground pins of the board and the Module to the ground of the supply source.
18+
19+
## Somfy RTS
20+
For this actor a 433.42 MHz RF transmitter is required.
21+
The standard 433.92 MHz transmitter don't work.
22+
The CC1101 Transceiver supports both 433.42 MHz and 433.92 MHz and can be used with the Somfy RTS actor.
23+
The wiring of the hardware is described in the [RF gateway](rf).

docs/setitup/rf.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Connect the Emitter and Receiver to a 5V (**3.3V** for CC1101) supply source, an
2727
|ESP8266|D2/**D3**/D1/D8|**RX**/D2|D5|**3V3**|D7|D6|D8|GND
2828
|ESP32|**27**/26|12|D18|**3V3**|D23|D19|D5|GND
2929

30+
To use the CC1101 module, `ZradioCC1101` must be uncomment in the `User_config.h` or added to the `build_flags`.
3031
More information about the [CC1101 wiring](https://github.com/LSatan/SmartRC-CC1101-Driver-Lib#wiring).
3132

3233

docs/use/actuators.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,42 @@ After this calibration, if you set the `r` channel to 0.0, it will be remapped t
7474
Also, the gamma curve for this channel will be set to 2.5.
7575
This means that input values are raised to the power 2.5 internally.
7676
This can be used to improve the linearity of inputs.
77+
78+
## Somfy RTS
79+
This actor allows to control Somfy RTS devices.
80+
81+
### Setup
82+
Before the module can be used virtual Somfy RTS remotes must be created.
83+
This is done in `config_Somfy.h`.
84+
85+
`SOMFY_REMOTE_NUM` must be set to the number of virtual Somfy RTS remotes you want to have.
86+
Then create for each of the virtual Somfy RTS remotes a unique 3-byte code and add them to `somfyRemotes`.
87+
After a remote is setup, the order and codes should not be changed, else the setup process for all remotes have to be repeated.
88+
Adding new codes at the end of the list is no problem.
89+
Example of three virtual Somfy RTS remote codes:
90+
```C
91+
const uint32_t somfyRemotes[SOMFY_REMOTE_NUM] = {0x5184c8, 0xba24d0, 0xb77753};
92+
```
93+
94+
Next the virtual Somfy RTS remotes must be paired with the Somfy RTS devices you want to control.
95+
The next section describes how the PROG command/button of the virtual remote can be used.
96+
Use the manual of the device you want to control for instructions on how to pair the virtual remote with the device.
97+
98+
### Commands
99+
Commands must be send to the `commands/MQTTtoSomfy` subtopic.
100+
Only json messages are supported.
101+
The json message must contain two properties:
102+
* remote: the index of the remote which is used to send the command (index start at zero)
103+
* command: the command which should be send with the remote as string, see [table of command names](https://github.com/Legion2/Somfy_Remote_Lib#available-commands).
104+
105+
::: tip NOTE
106+
The middle button on physical Somfy RTS Remote controls is called "My".
107+
:::
108+
109+
Send PROG command with remote 0:
110+
111+
`mosquitto_pub -t home/OpenMQTTGateway_Somfy/commands/MQTTtoSomfy -m '{"remote":0,"command":"Prog"}'`
112+
113+
Send Up command with remote 1:
114+
115+
`mosquitto_pub -t home/OpenMQTTGateway_Somfy/commands/MQTTtoSomfy -m '{"remote":1,"command":"Up"}'`

0 commit comments

Comments
 (0)