mirror of
https://github.com/rstrouse/ESPSomfy-RTS.git
synced 2025-12-15 03:52:11 +01:00
Updated Configuring the Software (markdown)
rstrouse
parent
a4454c6bb2
commit
399a82ebb2
1 changed files with 96 additions and 24 deletions
|
|
@ -54,9 +54,9 @@ Next review each of the pin selectors and set them to the proper pin assignment
|
|||
|
||||
After you have verified the pins, click the `Enable Radio` checkbox and then press the `Save Radio` button. ESPSomfy RTS will now enable the transceiver into receive mode so you can tune your radio. Once the radio has been enabled, the `Radio not Initialized` header will disappear from the screen. If the message does not disappear, then you likely have an issue with your pin selections.
|
||||
|
||||
You can view all incoming frames from your remotes with the `Logs` button. This will display the frames with the most recently received frame at the topmost position. Pressing the `Copy` button will copy the current command list into your clipboard. If you are submitting an issue that ESPSomfy RTS doesn't recognize a particular command this will help with debugging and allow me to provide further assistance.
|
||||
You can view all incoming frames from your remotes on the Logs tab. This will display the frames with the most recently received frame at the topmost position. Pressing the `Copy` button will copy the current command list into your clipboard. If you are submitting an issue that ESPSomfy RTS doesn't recognize a particular command this will help with debugging and allow me to provide further assistance.
|
||||
|
||||
|
||||
|
||||
|
||||
#### TROUBLESHOOTING TIP - I Cannot make the RADIO NOT INITIALIZED message go away
|
||||
This message appears when ESPSomfy-RTS sends the configuration to the CC1101 but it cannot read it back. This can be caused by a couple of things but the most common reason is because of the way the CC1101 boards are marked. First check your wiring and keep in mind that the odd numbered pins (1,3,5,7) are on the bottom edge of the board and when you flip it over to hook it up they go from right to left instead of left to right.
|
||||
|
|
@ -67,9 +67,6 @@ Please take a moment to ensure the selections are correct for the RX and TX pins
|
|||
#### TROUBLESHOOTING TIP - I still cannot get ESPSomfy-RTS to pair with my motor
|
||||
If you have multiple motors and one of them will not pair then this can be one of a couple of things. First verify that you have the correct protocol selected. If you select the RTS protocol for an RTW motor or vice versa, ESPSomfy will send out commands in RTS protocol for which your RTW motor will simply ignore. Somfy motors also have a limited number of memory slots if you fill them up you will need to factory reset the motor to clear them out then pair your remotes again.
|
||||
|
||||
|
||||
|
||||
|
||||
## Tune your Transceiver
|
||||
The default tuning parameters are most likely not the best settings for your transceiver. To start, first select the RX Bandwidth to 96.96kHz and the Frequency Deviation to 11.43kHz. You can use the arrows on your keyboard to fine tune the value. Then press the `Save Radio` button. Next, using a remote from about 3 feet away press one of the buttons. ESPSomfy RTS should pick up the signal and provide an RSSI (Received Signal Strength Indicator) value. This number is a measurement of how strong the signal is. The closer this value gets to 0 indicates a stronger received signal.
|
||||
|
||||
|
|
@ -95,13 +92,15 @@ The TX Power determines how loud the transceiver shouts at the motors. You can l
|
|||
|
||||
Also, if you are fiddling with the base frequency and are having a hard time capturing remotes. Set it back to 433.42Mhz and start over. Remember that sometimes a frozen flagpole is simply a magnet for any moron with a tongue. I you don't know what I am talking about you didn't grow up neck deep in snow or haven't fiddled with anything until you are stuck.
|
||||
|
||||
# Shade Setup
|
||||
# Shade/Motor Setup
|
||||
The ESPSomfy RTS device supports a maximum of 32 shades, blinds, or draperies. So if you live in a glass house don't throw rocks make another device. You can also modify the code to increase the SOMFY_MAX_SHADES value but you will eventually run out of memory on the ESP32. So stop being so cheap and build another $12 device.
|
||||
|
||||
ESPSomfy RTS needs a bit of information about each motor it is controlling as well as any other means of controlling said motors. This will ensure that the shade positions are always in sync. Up is up and down is down and any position in between is a percentage of down. So if you are used to the percentage of up translation from others, then get used to a percentage of down.
|
||||
ESPSomfy RTS needs a bit of information about each motor it is controlling as well as any other means of controlling said motors. This will ensure that the shade positions are always in sync. Up is up and down is down and any position in between is a percentage of down. So if you are used to the percentage of up translation from others, then get used to a percentage of down.
|
||||
|
||||
No matter if I am standing on my head or in any other position, I cannot square a percentage of open in my mind. It doesn't work, 100% is not open and 0% is not closed. I just can't convince myself of that backwards logic any better than I can convince myself that I look great in a turtleneck. So before you submit an issue that it is backwards just don't. Then ask yourself if you remove the shade completely... is that 100%. If it is you need help.
|
||||
|
||||
Ok so after all that I added a checkbox to the shade configuration that will allow you to live in your madness. Click the Invert Position checkbox and it will register as percentage of open.
|
||||
|
||||
At this point it is probably beneficial to provide a little bit of a glossary.
|
||||
* **Blind** - A window covering made up of slats with a single up/down motor and an optional tilt motor.
|
||||
* **Shade** - A window covering that is made up of fabric with a single motor that drives the shade covering up or down on a roller tube. This term is also used as a generic term referring to a defined Shade, Blind, or Drapery in the ESPSomfy RTS software.
|
||||
|
|
@ -111,15 +110,16 @@ At this point it is probably beneficial to provide a little bit of a glossary.
|
|||
* **Pairing** - The process of linking the defined shade in this software so it can control the shade.
|
||||
|
||||
## Adding a Shade
|
||||
To add a shade navigate to the Somfy tab and press the `Add Shade` button. This will open up the shade properties and allow you to enter the information about your shade. You can come back later and edit any of these values later but I caution editing the address after it has been paired. Once you pair the shade with the motor, the motor will store this address. If you change it later it will not know who it is.
|
||||
To add a shade click on the gears icon to open the configuration then click on the Somfy section. With the Shades tab selected, press the `Add Shade` button. This will open up a new shade window to allow you to enter the information about your shade. You can come back later and edit any of these values later but I caution editing the address after it has been paired. Once you pair the shade with the motor, the motor will store this address. If you change it later it will not know who it is.
|
||||
|
||||
### Protocol
|
||||
First choose the protocol that the motor understands. Most Somfy motors, use a 56-bit protocol. However, some use 80-bits to communicate and will require you to select the 80-bit setting for the `Bit Length`. The easiest way to tell if you have this scenario is to open the frame log described above then press a button on the remote that is currently being used to control the motor. When ESPSomfy RTS hears the commands from the remote it will indicate whether it was 56-bits or 80-bits.
|
||||
ESPSomfy RTS supports RTS, RTW, and RTV protocols. If your remote has the 3 letters RTS on it then you likely have an RTS motor. However, there are a number of motors out there that speak a slightly different version of this protocol. Look in your manual for the letters RTW to see if you have an RTW motor. ESPSomfy RTS can support motors speaking either dialect on the same ESPSomfy device. It just needs to know which one it is speaking.
|
||||
|
||||
ESPSomfy RTS supports RTS and RTW protocols. If your remote has the 3 letters RTS on it then you likely have an RTS motor. However, there are a number of motors out there that speak a slightly different version of this protocol. Look in your manual for the letters RTW to see if you have an RTW motor. ESPSomfy RTS can support motors speaking either dialect on the same ESPSomfy device. It just needs to know which one it is speaking.
|
||||
### Bit Length
|
||||
Most Somfy motors, use a 56-bit length protocol. However, some use 80-bits to communicate and will require you to select the 80-bit setting for the `Bit Length`. The easiest way to tell if you have this scenario is to open the frame log described above then press a button on the remote that is currently being used to control the motor. When ESPSomfy RTS hears the commands from the remote it will indicate whether it was 56-bits or 80-bits. Additional options are provided when the 80-bit protocol is selected. Most remotes with a tilt wheel operate at 80-bits.
|
||||
|
||||
### Shade Type
|
||||
Next select the type of shade motor you are adding. This can be a Roller Shade, Blind, Drapery, or Awning. This determines what type of functions are available for control. Roller shades and draperies typically only support one function where they open and close with the motor. Blinds however support an optional tilt function. If your window covering has a tilt motor or integrated tilt functions, then you will need to use the blind type in order to support it. If you select Blind from the dropdown then a Tilt Type option will become available and the icon will change.
|
||||
### Type
|
||||
Next select the type of motor you are adding. This can be a Roller Shade, Blind, Shutter, Drapery, or Awning. This determines what type of functions are available for control. Roller shades, shutters, and draperies typically only support one function where they open and close with the motor. Blinds however support an optional tilt function. If your window covering has a tilt motor or integrated tilt functions, then you will need to use the blind type in order to support it. If you select Blind from the dropdown then a Tilt Type option will become available and the icon will change.
|
||||
|
||||
There are a number of tilt mechanisms supported by ESPSomfy RTS. If this is a blind with a tilt function you should select the appropriate type of tilt mechanism that is used on the motor. These are described below.
|
||||
* ***None*** - The slats of the blind are manually controlled or not controllable remotely.
|
||||
|
|
@ -128,12 +128,13 @@ There are a number of tilt mechanisms supported by ESPSomfy RTS. If this is a b
|
|||
|
||||
Awnings add support for Sun/Wind sensors that retract the awning whenever the sun goes away or the wind may damage your precious butterfly wing attached to the house. Selecting Awning as the motor type will add these options to the interface and integrations. For the sensor to work properly you will need to link it to the motor using the link remote function. After all this sensor operates as if it were a remote.
|
||||
|
||||
|
||||
|
||||
|
||||
### Name
|
||||
You must provide up to 20 characters for the name of the shade. This can include any printable character.
|
||||
|
||||
### Addressing
|
||||
The Remote Address is expected to be unique for all known addresses and the default is generated from the MAC address of your ESP32. This can be any value so long as it is unique. Change it at will but did I mention that it must be unique and the algortithm to calculate a new address only makes sure the address is unique among all the addresses that the ESPSomfy RTS module already knows about.
|
||||
### Remote Address
|
||||
The Remote Address is expected to be unique for all known addresses and the default is generated from the MAC address of your ESP32. This can be any 24 bit value so long as it is unique. Change it at will but did I mention that it must be unique and the algortithm to calculate a new address only makes sure the address is unique among all the addresses that the ESPSomfy RTS module already knows about.
|
||||
|
||||
Remote addresses are 24-bits long and are assigned at the factory for Telis remotes. So unless you have very old remotes you can probably safely assign these to some lower number if you want but only before pairing. Did I mention that these need to be unique for all controller channels and remotes within earshot of the ESPSomfy RTS module.
|
||||
|
||||
|
|
@ -161,22 +162,25 @@ Once you are satisfied with your settings press the `Add Shade` button. This wi
|
|||
* **Pair Shade** - Allows you to pair the shade with the somfy motor
|
||||
* **Link Remote** - Links the channel on your Somfy remote to the shade. This ensures the position of the shade can be known at all times. You can link up to 5 channels to each shade. Beyond that you probably need to simplify your life because you have remotes strewn everywhere. Honestly you should get checked.
|
||||
|
||||
After your shade has been added click the Done button to to dismiss the current shade.
|
||||
|
||||
## Editing a Shade
|
||||
You can edit any shade that you have previously added by navigating to the Somfy tab under the config gears in the upper right. From the list of added shades simply click on the pencil to bring up the shade editing screen.
|
||||
You can edit any shade that you have previously added by navigating to the Somfy section -> Shades tab under the config gears in the upper right. From the list of added shades simply click on the pencil to bring up the shade editing screen.
|
||||
|
||||
|
||||
|
||||
|
||||
## Pairing a Shade
|
||||
In order to control the shade motor you must first pair it with the motor. This is not unlike how a Telis remote is paired with the motor and in fact it follows this procedure exactly.
|
||||
## Pairing a Shade/Motor
|
||||
In order to control the motor you must first pair it. This is not unlike how a Telis remote is paired with the motor and in fact it follows this procedure exactly. The motor memory stores the address of each remote that it accepts commands from. So in the first step you open the memory by pressing the prog button on a remote long enough to get it to jog. Then press the prog button for the ESPSomfy RTS shade to get it to jog again.
|
||||
|
||||
On left side of the shade in the list there will be an edit pencil. You guessed it you should click on it to bring up the shade editor window. If you just added the shade and pressed the `Add Shade` button you should already be here.
|
||||
On left side of each shade in the list there will be an edit pencil. You guessed it you should click on it to bring up the shade editor window. If you just added the shade and pressed the `Add Shade` button you should already be here.
|
||||
|
||||
Click the `Pair Shade` button to bring up the pairing screen. This will contain instructions on how to put the motor into pairing mode so you can proceed. After the motor jogs press the `Prog` button on the pairing screen and the motor should once again jog to tell you it was successful. There is no communication from the motor to the remotes so I am relying on you to verify that the motor jogged after pressing the `Prog` button. If it didn't then don't say it did. You will have to go through the unpairing process if you aren't honest about it and try again.
|
||||
|
||||
The pairing and unpairing process is essentially the same but in either instance Somfy does not provide any digital response that the pairing unpairing was successful. The only response is a visual one from the shade when it jogs. If the shade does not jog after pressing the prog button, simply perform the unpair process without putting the shade into paring mode with the external remote and try again. If you followed the procedure correctly this will just work. The range for the Somfy Controller is really, really far... over the hill and through the dell. Did I mention that I am impressed with the range?
|
||||
The pairing and unpairing process is essentially the same but in either instance Somfy does not provide any digital response that the pairing unpairing was successful. The only response is a visual one from the shade when it jogs. If the shade does not jog after pressing the prog button, simply press the prog button again until it jogs exactly one time. If it jogs more than once you have unpaired the shade as this amounts to a toggle operation.
|
||||
|
||||
|
||||
If you followed the procedure correctly this will just work. The range for the Somfy Controller is really, really far... over the hill and through the dell. Did I mention that I am impressed with the range?
|
||||
|
||||
|
||||
|
||||
## Linking Remotes (and Sensors)
|
||||
Once you have paired the shades it is time to link the other remotes you use to open and close the shades. This linking process makes sure we capture every movement of the shade so that its position is always accurately reported. If you happen to also have sensors like the Soliris sun/wind sensor that protects your awning you need to also link this as if it were a remote.
|
||||
|
|
@ -187,14 +191,82 @@ Now that you have been through the pairing process and saw how painless that was
|
|||
|
||||
When this screen is open the controller is listening for any remote out there that is sending a command to the shade. Simply press any button on the remote you want to link. If you are having trouble deciding which button to press, press the up button. Once the remote is detected it will automatically close the link remote window as soon as it hears the remote.
|
||||
|
||||
|
||||
|
||||
|
||||
To unlink an external remote from the shade simply click on the trash can icon from the linked remotes list.
|
||||
|
||||
## Setting a Rolling Code
|
||||
You may set the rolling code for a shade registered in ESPSomfy RTS. However, I caution you on using this feature and I hesitated to add it. If these get out of sync you will need to reset the memory on the motor. This is because each command sent to the motor increments the rolling code value stored on the motor by 1. If it does not match the expected value by a small window then the motor will not respond to the command and is part of the security features of the motor. Still if you are interested in what that number is you can click on the `Set Rolling Code` button just to see it but heed the warnings on the page. Really, I've got your back here.
|
||||
|
||||
|
||||
|
||||
|
||||
# Grouping Shades/Motors
|
||||
Starting in firmware v2.0.0 you can group your shades. This grouping functionality takes advantage of the ability to store multiple remote addresses in each motor. This means that a single command is sent to all motors instead of sending commands one at a time to each motor. While that would have been the short route to take it would result in many commands being sent is succession. This would likely mean that it would start the movement for each shade one at a time. Given the speed at which the command interface operates, when a large number of them are grouped the delay in movement would be noticeable.
|
||||
|
||||
So because my type A tends to show we have a solution that works the pairing for each group so that a single command is sent for all shades in the group. Groups do not have a defined position and cannot be controlled by setting the position. This is because the timings of each member can and will likely be different.
|
||||
|
||||
## Adding a Group
|
||||
To add a group, click the gears to enter configuration mode. Then click on the Somfy section and select the Groups tab. From there press the Add Group button. If you haven't figured it out by now this operates in a consistent manner to the Shades tab.
|
||||
|
||||
|
||||
|
||||
The group must first be added before pairing the individual shades to it. So give your new group a name and press the Add Group button.
|
||||
|
||||
## Editing a Group
|
||||
All the groups that you have added will be listed on the Groups tab. So to edit an existing group press the gears icon at the top of the screen, then open the Somfy section and select the Groups tab. Next to each group there will be a pencil icon ripe for the clicking. Click the pencil next to the group you want to edit.
|
||||
|
||||
|
||||
|
||||
### Linking a Motor to a Group
|
||||
Each member motor of a group must be linked using the linking process. This is a two step procedure that closely follows the pairing procedure that you originally performed for pair the motor in the first place. This means that ESPSomfy RTS shade must be paired to the motor before performing this procedure.
|
||||
|
||||
To begin linking a new shade to the group click the Link Shade button to open the shade linking process. At each step in the wizard take a moment to read the instructions so you do not get lost. I spent the time to write them and I really want you to read it.
|
||||
|
||||
**STEP 1**
|
||||
Review the operation
|
||||
|
||||
|
||||
|
||||
**STEP 2**
|
||||
Select the shade to link
|
||||
|
||||
|
||||
|
||||
**STEP 3**
|
||||
Open the motor memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**STEP 4**
|
||||
Pair Shade to Group
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Removing a Motor from a Group
|
||||
Because we are linking to the shade memory, removing a shade from a group requires unlinking the address. To do this click the trash can icon next to the linked shade in the Edit Group interface. This will begin the procedure for removing the shade reference from the memory.
|
||||
|
||||
**STEP 1**
|
||||
Review the process
|
||||
|
||||
|
||||
|
||||
**STEP 2**
|
||||
Open Motor Memory
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**STEP 3**
|
||||
Unpair the shade from the group
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# Backup and Restore
|
||||
You may back up your shade settings at any time using the backup function. To back up your shade settings, from the gears menu, select the `Updates` tab. From this tab simply click on the backup button and a text file containing the current shade configuration will be downloaded to your browser. You may use this file should you need to replace your ESP32 or simply want to use another device.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue