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

Update README.md

Browse source
This commit is contained in:
rstrouse 2023-02-18 19:31:32 -08:00 • committed by GitHub
parent 44d6c5dc99
commit 16ef81381d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -13,7 +13,33 @@ This software uses a couple of readily available hardware components. These inc
# Functionality
After you get this up and running you will have the ability to interact with your shades using the built-in web interface, socket interface, and MQTT. There is also a full [Home Assistant integration](https://github.com/rstrouse/ESPSomfy-RTS-HA) that can be installed through HACS that can control your shades remotely and provide automations.
![image](https://user-images.githubusercontent.com/47839015/213935196-753e994c-7cd6-480f-8e6e-e5a61266fc3c.png)
![image](https://user-images.githubusercontent.com/47839015/219909983-275b4e8b-ab89-44d0-8e3e-ae9713ae34c0.png)
* Move the shade using up, down, and my buttons
* Set and remove my button favorite
* Interactive shade positioning
## Moving a Shade
You can move the shade to the full up position by clicking the up button. To stop the shade during travel, press the my button and the shade will stop. To move the shade to the full down position press the down button. At any point during the movement you can press the my button to stop the shade.
If you would like to move the shade to a favorite position. Press the my button while the shade is at rest and the shade will move to the position set for the my button. These are displayed under the shade name so you do not have to guess what the current favorite is set to.
To move a shade to a target percentage of closed, click or tap on the shade icon. An interface will open that will allow you to select the position using a slider control. Move the slider to the desired position. When you release the slider the shade will begin to open or close to reach the desired position. You can change this position even when the shade is moving.
![image](https://user-images.githubusercontent.com/47839015/219912949-ab90d33e-4ef7-4294-b137-e8c2925a6fde.png)
## Setting a Favorite
To set your favorite my position you can either use the ESPSomfy RTS interface or your Somfy remote. ESPSomfy RTS listens for the long press of the my button so if you use the remote it will pick up this favorite. However, if you previously had a favorite set before installing ESPSomfy RTS you should reset it using ESPSomfy RTS. Somfy uses the same command to set and unset its favorites.
To set or unset a favorite long press the my button. After a few seconds a screen like below will appear. ESPSomfy RTS allows you to set a favorite by position, so you can drag the slider to 37% and press the `SET MY POSITION` button. After pressing the button the shade will move to that position and jog briefly indicating that the favorite has been saved.
![image](https://user-images.githubusercontent.com/47839015/219910353-d256a3a3-8a76-45cb-9dcc-e98fd4fd0b43.png)
To unset a favorite perform the long press on the my button to open the favorites interface. Then move the slider to the current my position and the button will turn red and the text will change to `CLEAR MY POSITION`. Once you press the button the shade will jog indicating that the favorite has been cleared.
![image](https://user-images.githubusercontent.com/47839015/219911658-b0ea72c8-d571-4405-9d27-20cad3d6549f.png)
# Getting Started
To get started you must create a radio device. The wiki contains full instructions on how to get this up and running. You don't need a soldering iron to make this project work. Dupont connections between the radio and the ESP32 will suffice. However, I have also included some instructions on how to make an inconspicuous radio enclosure for a few bucks. Here is the [Simple Hardware Guide](https://github.com/rstrouse/ESPSomfy-RTS/wiki/Simple-ESPSomfy-RTS-device)