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

Updated User Interface Concepts (markdown)

rstrouse 2023-07-02 12:34:02 -07:00
parent 00ec0e9ce2
commit 5b6646d5d3
1 changed files with 65 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

65
User-Interface-Concepts.md

@ -96,12 +96,77 @@ The system section allows for base configuration of the software. In this secti
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/2df1272e-d714-46f2-9415-65fb7d3d4780)
### Options Tab
In the options tab you can set the following information for your ESPSomfy RTS device
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/8fc2ea72-b40a-4adf-b335-89a12079598a)
#### Host Name
This is the name that is broadcast for your device
#### Time Zone
From this dropdown you can select the timezone. Please note that not all available timezones have been included in the list. This is because this list is potentially very massive so where there are duplicate timezones only the first option in the timezone database is provided. If yours is not listed look for a city that shares your time zone.
#### NTP Time Server
The ESP32 does not have an integrated real time clock. As a result, it uses a timeserver to acquire the current coordinated time for your timezone. This can be configured to use a time server that is local to your network.
#### Broadcast uPnP over SSDP
By checking this box ESPSomfy RTS will publish the universal plug and play interface on your network. This allows for discovery of the device on some networks. For instance, if you are running a windows environment each ESPSomfy RTS device will appear in the network section when the device is booted. Keep in mind ESPSomfy RTS will always publish itself and its services over MDNS.
### Security Tab
The security tab allows you to configure your authentication options and permissions. While the permission list is limited, this should provide you with the ability to allow control of the ESPSomfy RTS device on your network.
#### Secure Config Only
When this box is checked users on the network will not need to login to the ESPSomfy RTS device to operate the configured motors. However, they will be required to login when the mode changes from Home Mode to Configuration Mode.
#### Security Type
The security type allows you to set authentication in three specific modes. After selecting a mode the screen will change with the options available for that mode. The available modes are None, Pin Entry, and Password
##### None
No separate login required
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/b5712f36-3476-4c29-a7ea-2e43f6f309c4)
##### Pin Entry
A pin login is provided when the permissive mode is selected
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/e9bc8d79-76e3-497f-a559-b5797bcb3e87)
##### Password
A username and password login is provided when the permissive mode is selected.
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/49b06c4b-a9dc-48d4-85c7-61a30219d95c)
### Firmware Tab
The firmware tab provides all the interfaces for backing up and restoring your device as well as installing firmware updates.
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/ec26b621-93ab-4b13-9b07-f7b9a4080359)
## Network Section
The network section allows for configuration of the network interfaces to include the adapter, IP/DHCP settings, and MQTT interfaces
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/945bfc2d-6377-477b-bebd-db40867f4fb7)
### Adapter Tab
The adapter tab indicates how the ESPSomfy RTS device will connect to your network. From here you can indicate whether you will be using WiFi or hardwired ethernet and provide the options for either one of them.
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/be9bc592-3de2-47e6-8175-7b48480587c6)
#### Use Ethernet
When the Use Ethernet box is checked the configuration options for your ethernet adapter will be displayed.
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/0a8afa6d-6b99-4c3b-880a-9a5f085520a1)
### DHCP/Static IP Tab
From this tab you can set your ESPSomfy RTS device to use Domain Host Control Protocol (DHCP) from your router (recommended) or configure a static IP address. Honestly you should use the features of your router to reserve an address for the device. But if you are set in your old-school ways, I have provide you with this ability.
#### Acquire IP Address automatically (DHCP)
When this options is unchecked the ip address configuration will be displayed.
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/06c21d49-b623-4200-a018-6f5e41f12751)
### MQTT Tab
In this tab you can identify the MQTT broker for your configuration. ESPSomfy RTS will communicate its state to this broker and allow MQTT commands to operate the configured shades and groups.
![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/abd5a8ec-2486-45fc-bb1f-07f0f28dc5db)
## Somfy Section
In this section you can configure the individual shade motors and groups.