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
8aaf2c038a
commit
a4454c6bb2
1 changed files with 33 additions and 22 deletions
|
|
@ -1,43 +1,54 @@
|
|||
From here on out we just need to get the shades talking to the ESPSomfy RTS device. You will first connect the device to your local WiFi network then add the shades, pair them, and link the remotes.
|
||||
From here on out we just need to get the shades talking to the ESPSomfy RTS device. You will first connect the device to your local network then add the shades, pair them, and link the remotes.
|
||||
|
||||
# Initial WiFi Connection
|
||||
When the software is first connected it will start its own ESPSomfy RTS wifi network. You will need to connect to this network so you provide the WiFi credentials for your network. So open your WiFi networks and connect to the unsecured network named `ESPSomfy RTS`. Once connected navigate to `http://192.168.4.1` and it will bring up the blank shades screen. Click on the gear icon at the upper right to open the configuration screen and select the WiFi tab. Initially, the transceiver will not be initialized until you enable it in a later step. This is to ensure you have the pin mappings set correctly.
|
||||
# Initial Network Connection
|
||||
When the software is first connected it will start its own ESPSomfy RTS wifi network in Access Point (AP) mode. You will need to connect to this network so you can configure ESPSomfy RTS to connect to your network. So open your WiFi networks and connect to the unsecured network named `ESPSomfy RTS`. Once connected navigate to `http://192.168.4.1` and it will bring up the blank Home screen. Click on the gear icon at the upper right to open the configuration screen and select the Network section. Initially, the transceiver will not be initialized until you enable it in a later step. This is to ensure you have the pin mappings set correctly so do not worry about this message for now. First lets get you connected to your home network.
|
||||
|
||||
Press the scan button and when the list returns, select your WiFi network, enter the passphrase and hit save. If you have one of the hardwired ethernet ESP32 devices you may select the Use Ethernet checkbox. See the section below on configuring ESPSomfy RTS to use a hardwired ethernet connection.
|
||||
## Set Initial System Options
|
||||
When first setting up ESPSomfy RTS you should first name the device and provide the time zone you are located in. If you have your own NTP time server then you can also provide that information as well. If you have computers that support Universal Plug and Play (uPnP) such as Microsoft Windows you can check the Broadcast uPnP over SSDP and your ESPSomfy RTS device will show up in your network list.
|
||||
|
||||
|
||||
|
||||
|
||||
While you are here, click on the General tab and provide a unique host name for the device. This will allow you to connect to it using the name of the device rather than the IP address. If you skip this step for now you will need to find the IP address of the device assigned by your router. You can also find it in the Network section of Windows Explorer as it will show up by default. Double clicking on it will bring up the Home Page.
|
||||
Once you have entered your information press the Save button to persist your changes. Keep in mind you should provide a unique host name for each of your ESPSomfy RTS devices. You probably only need this if you have more than 32 shades to control, or the radio is encased in Kryptonite diminishing the signal, or it is located on another planet, or has a magic spell of protection on it. However, the range of the actual Somfy remotes are abysmal so multiple ESPSomfy RTS devices may be in order if the remotes cannot be heard from a centralized device.
|
||||
|
||||
You will need to disconnect from the wifi network after you have provided your credentials to see the device on your local network. This will disconnect the ESP32 from its own network and connect it to your WiFi network.
|
||||
## Configure your Network Adapter
|
||||
You must first indicate whether you are using a hardwired Ethernet adapter or WiFi. If you built your ESPSomfy RTS device from an ESP32 module that has a hardwired RJ45 Ethernet port and have not connected it to your local network, plug it in now. Either way choose the correct section below to get connected up to your network.
|
||||
|
||||
From here on out you can access it by navigating to `http://ESPSomfyRTS.local` on your local WiFi network. That is until you change the host name and it will then start to use `http://<your hostname>.local`. This allows you to have several ESPSomfy RTS modules on your network at the same time each with thier own name.
|
||||
### Using a WiFi Connection
|
||||
Press the scan button to look for available WiFi networks. When the list returns, select your WiFi network or if you are stealing WiFi from one of your neighbors choose that one, enter the passphrase and hit save. If you are using a hidden SSID just stop it. It provided no security at any level and if I were a WiFi predator I would already have your hidden SSID. But if your SSID isn't listed you can type it in SSID field and provide the passphrase for it.
|
||||
|
||||
You probably only need this if you have more than 32 shades to control, or the radio is encased in Kryptonite diminishing the signal, or it is located on another planet, or has a magic spell of protection on it. It should also show up in your Windows networking list as the module has SSDP and mDNS built in. Lots of unlikely or's just had to be listed.
|
||||
|
||||
|
||||
# Using Hardwired Ehernet
|
||||
ESPSomfy RTS supports hardwired Ethernet boards. If your board is not listed you will need to review the spec sheet for your board and apply the settings from this information. ESPSomfy RTS will also perform a fallback to a wireless connection should the Ethernet cable become disconnected that is if you have provided valid WiFi credentials in the WiFi section. ESPSomfy RTS will only enable one interface at a time since initial testing with both enabled, really slowed down performance.
|
||||
Once you have entered the information you can click the Save Adapter button. ESPSomfy RTS will not connect to your WiFi network until you have disconnected from the dedicated access point that you are currently connected to. So to allow ESPSomfy RTS to connect to your network disconnect your computer from the ESPSomfyRTS WiFi network.
|
||||
|
||||
To use a board that has hardwired Ethernet click the `Use Ethernet` checkbox to enable the options for configuring your board. Then select your Board Type from the board type dropdown. If your board is not listed use a custom board type and ensure the documentation for the board matches the configuration. It is very important that the information related to the board is consistent with the manufacturer's settings. Incorrect settings for an Ethernet jack can destroy the board since the pins are not protected.
|
||||
### Using Hardwired Ethernet
|
||||
If you have one of the hardwired ethernet ESP32 devices select the Use Ethernet checkbox. This will change the screen to allow you to configure the Physical Hardware (PHY) for your Ethernet enabled ESP32 device. Use care to ensure you have properly configured the hardware as many of those boards have no protections on the connection between the ESP32 microcontroller and the Ethernet chip. You can damage the Ethernet chip with improper settings.
|
||||
|
||||
|
||||
Select your board from the Board Type dropdown. Many of the Ethernet enabled boards are listed in this dropdown but if it is not listed break out the documentation for your board and enter them as a Custom Config. Again take care to get these settings correct. If your board is listed take a moment to ensure nothing has changed in the manufacturing since these settings were first obtained from the documentation. You will be presented with a confirmation screen when you save the adapter.
|
||||
|
||||
# Reserve DHCP Address
|
||||
You should really take a moment to reserve the IP address and set the host name in your router for the ESPSomfy-RTS device. This will ensure the IP address remains the same each time it connects to the network. If you are an old hat at the IoT thing for your home you know this dance. If not look in the instructions for you WiFi router and reserve the IP address for the device. If you are having issues were occasionally the ESPSomfy-RTS cannot be found by its name then this will likely alleviate that problem.
|
||||
The Fallback to Wireless feature allows you to disconnect the Ethernet cable and ESPSomfy RTS will automatically connect to the WiFi network. To use this feature you need to first configure the WiFi adapter then configure the Ethernet adapter. While it might have been fun to have both active at the same time it puts too much load on the ESP32 to be practical. Only one adapter will be enabled at a time.
|
||||
|
||||
mDNS is the service that is used for allowing you to connect via the local name of the ESPSomfy-RTS device, while it does work it isn't really that reliable. Making a DHCP reservation complete with the host name of the device will help if you have occasional drop offs from your network.
|
||||
|
||||
|
||||
# General Settings
|
||||
Once the ESPSomfy RTS device has rebooted access the General tab. There are a few options here for the server. This includes the host name of your Somfy server as well as the time zone and whether the server should announce iself over Universal Plug & Play. If you have isolated the device on your network you can choose a timeserver that is local to your network. This will ensure time logs and backups are in sync.
|
||||
Once you press the Save Adapter button you will be presented with the prompt below. Take a second to read the prompt and ensure all of the settings are correct before pressing the Save Ethernet Settings button.
|
||||
|
||||
|
||||
|
||||
|
||||
## Connecting your local network
|
||||
ESPSomfy RTS will not connect to your local network until you have disconnected from the dedicated access point that you are currently connected to. So to connect to your local network disconnect your computer from the ESPSomfyRTS WiFi network. When there are no connections to the dedicated access point set up by ESPSomfy RTS it will reboot and connect to your local network.
|
||||
|
||||
Once you disconnect ESPSomfy RTS will no longer be available on 192.168.4.1 and will be assigned an IP address from your local network. Your ESPSomfy RTS device has rebooted it should be available on the IP address assigned by your router or at the host name you provided in the previous step. On an Apple or Linux device you will find it at http://<host name>.local and if you enabled SSDP on Windows it will be at http://<host name>. DNS can be stupid sometimes so you may need to look in your router for the IP address.
|
||||
|
||||
# Setting up a Fixed IP Address
|
||||
By default ESPSomfy RTS uses the Domain Host Control Protocol (DHCP) settings in your router. I highly recommend allowing your router to do its job and assign the IP address. However, you should reserve the address in the DHCP settings for your router so no other device can be assigned the IP address. mDNS is the service that is used for allowing you to connect via the local name of the ESPSomfy-RTS device, while it does work it isn't really that reliable. Making a DHCP reservation complete with the host name of the device will help if you have occasional drop offs from your network.
|
||||
|
||||
If you are old school and don't have enough complexity in your life you can configure a static IP by navigating to Network -> DCHP/Static IP in the configuration pages. When you uncheck the Acquire IP Address automatically (DHCP) checkbox the settings for setting up a fixed IP address will appear. If you do not know what values you should use for this just don't do it and reserve an address in the DHCP server of your router. Then simply call it a day.
|
||||
|
||||
# Set up the Transceiver
|
||||
Initially, ESPSomfyRTS will start with the transceiver disabled. You will need to ensure the pin mappings match the wiring that you used when initially building your device. To set up and configure your transceiver navigate to the transceiver configuration screen. From the gears menu click the `Somfy` tab then click the `Configure Transceiver` button. A screen will appear with the transceiver options.
|
||||
Initially, ESPSomfyRTS will start with the transceiver disabled. Now that you have the network connected, you will need to ensure the pin mappings match the wiring that you used when initially building your device. To set up and configure your transceiver navigate to the transceiver configuration screen. While in configuration mode click the `Radio` section. From here you can set up the transceiver. A detailed description of the Transceiver options can be found in this [Wiki](https://github.com/rstrouse/ESPSomfy-RTS/wiki/User-Interface-Reference#transceiver-tab).
|
||||
|
||||
|
||||
|
||||
|
||||
First you need to select the protocol and radio type. If you do not know what type of motor radio you have it is likely an RTS protocol with a 56-BIT motor. ESPSomfy-RTS supports the RTW or the RTS protocol. If your remote is a Telis RTS, Chronis RTS, Situo RTS, or a Smoove RTS then you for sure have an RTS motor. However, if your documentation mentions RTW or you have an ASA motor then select the RTW protocol. The protocol and the radio type that you set here will be the values that are used as the default when you create a new shade. You will have the opportunity to set these for each individual motor later.
|
||||
First you need to select the protocol and radio type. If you do not know what type of motor radio you have it is likely an RTS protocol with a 56-BIT motor. ESPSomfy-RTS supports the RTW, RTV, and the RTS protocol. If your remote is a Telis RTS, Chronis RTS, Situo RTS, or a Smoove RTS then you for sure have an RTS motor. However, if your documentation mentions RTW or you have an ASA motor then select the RTW protocol. The protocol and the radio type that you set here will be the values that are used as the default when you create a new shade. You will have the opportunity to set these for each individual motor later. If you have motors on different protocols you can set them up for each protocol so long as they are using the same base frequency.
|
||||
|
||||
Next review each of the pin selectors and set them to the proper pin assignment for your wiring. The screen will default to the default wiring from the hardware build but please double check to ensure these values match the way you wired the transceiver. If you used a wired Ethernet board these will most definitely not be correct.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue