From 0b9897b62cfab2835172ee44adc2b8c13a3b5c1c Mon Sep 17 00:00:00 2001 From: rstrouse <47839015+rstrouse@users.noreply.github.com> Date: Mon, 3 Jul 2023 11:31:00 -0700 Subject: [PATCH] Updated User Interface Reference (markdown) --- User-Interface-Reference.md | 50 ++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/User-Interface-Reference.md b/User-Interface-Reference.md index 20372d4..48505cc 100644 --- a/User-Interface-Reference.md +++ b/User-Interface-Reference.md @@ -271,4 +271,52 @@ In most instances you should set this to the highest transmission level supporte #### 10 - RSSI Status ESPSomfy RTS will display the Radio Signal Strength Indicator (RSSI) for incoming frames. So when testing your remote and adjusting the radio settings you will see how strong the signal you are receiving is on each button press. The number next to the RSSI label indicates how many frames it has received and will increment each time it receives a frame. The large RSSI number will indicate how strong the signal was when the frame was received. -The strongest RSSI value will be closest to 0. So an RSSI of -20dBm is stronger than a -40dBm signal. Most antennas will stop picking up signals at around -110dBm and become less reliable around -90dBm. \ No newline at end of file +The strongest RSSI value will be closest to 0. So an RSSI of -20dBm is stronger than a -40dBm signal. Most antennas will stop picking up signals at around -110dBm and become less reliable around -90dBm. + +### Logs Tab +The logs tab lists all received communications from any Somfy radio nearby. All frames that are identified as protocol communications will display in the listing with the most recent frame appearing at the top of the list. + +ESPSomfy RTS does not store these logs on the flash of the ESP32. This is intentional as to keep the flash usage to a minimum. There are many more important uses for this resource and frames are only logged to interfaces that are currently in configuration mode. When the home mode is selected, no frames are dispatched. + +![image](https://github.com/rstrouse/ESPSomfy-RTS/assets/47839015/cfdf5724-7880-4244-b84e-4d3dd65bf6c7) + +#### Table Columns +A brief description of the columns is provided below: +* Key - The obfuscation key used for the frame. Depending on the protocol, this key may also contain the raw command value. ESPSomfy RTS will extract the data from this key for RTW and RTV protocols to determine the proper command byte. +* Address - The 24-bit address of the remote that sent the frame. +* Command - The button that was pressed on the remote. This will be one of the following values + * Up + * Down + * My + * My+Up + * My+Down + * My+Up+Down + * Up+Down + * Prog + * SunFlag + * Sensor + * Step Up + * Step Down +* Code - The rolling code used in the frame from the remote. +* RSSI - The Receive Signal Strength Indicator (RSSI) value for the frame. +* Bits - The number of bits that were used to reflect the frame. This is most often 56 or 80 bits. +* Time - Local time for the timezone set in the general section of the configuration. + +#### Clear Button +To clear all logs from the display click the clear button. + +#### Copy Button +You can copy the current detail pulse encoding for all the frames in the list to your clipboard by clicking the copy button. All information related to the frame including the pulse timings in microseconds are included in this JSON data format. Below is an example of the output for a single frame. +```json +[{"encKey": 175, + "address": 979145, + "rcode": 111, + "command": "Up", + "rssi": -23, + "bits": 56, + "valid": true, + "sync": 4, + "pulses": [10439,7337,2559,2584,2548,2549,4857,1296,1286,1274,1272,1291,644,646,632,639,656,621,642,632,1311,621,642,631,659,642,624,1268,1310,1271,622,657,1288,643,621,659,660,614,650,1272,1284,1274,646,636,634,654,622,642,1283,1281,1317,1267,1271,1279,663,616,640,657,1290,593,667,1281,1284,642,652,615,662,624,644,648,637,1289,1293,1261,1280,644,656,1266,646,645,1277,1267,669,625,635,639,1290,1272], + "time": "2023-07-03T10:45:21.311-0700" +}] +```