From fd8c3a79ae3b655b388acb6cd270eedc2f220f53 Mon Sep 17 00:00:00 2001 From: Northern Man Date: Sun, 23 Oct 2022 20:34:59 -0400 Subject: [PATCH] Updated docs for the Heltec ESP32 Board (#1301) --- docs/prerequisites/board.md | 1 + docs/use/rf.md | 170 +++++++++++++++++++----------------- 2 files changed, 91 insertions(+), 80 deletions(-) diff --git a/docs/prerequisites/board.md b/docs/prerequisites/board.md index 89860dc51c..0d05d3a9d3 100644 --- a/docs/prerequisites/board.md +++ b/docs/prerequisites/board.md @@ -27,6 +27,7 @@ The boards below doesn't need hardware modification (or a lite one). |OLIMEX ESP32 Ethernet POE|-|-|-|X|-|X|-|X| |OLIMEX ESP32 Ethernet POE ISO|-|-|-|X|-|X|-|X| |ESP32-WT32-ETH01 Ethernet|-|-|-|X|-|X|-|X| +|Heltec WiFi LoRa 32 (V2.1)|-|rtl_433|-|X|X|-|X|-| |[M5Stack Basic](M5)|![](../img/OpenMQTTgateway_M5_Stack_Board_Display_Text.png)|-|-|X|-|X|X|X| |[M5Tough](M5)|-|-|-|X|-|X|X|X| |M5Stick|-|-|send|X|-|X|-|X| diff --git a/docs/use/rf.md b/docs/use/rf.md index 9e158f79ca..b73801e793 100644 --- a/docs/use/rf.md +++ b/docs/use/rf.md @@ -245,7 +245,14 @@ for on: ## rtl_433 device decoders -This feature is only available on a ESP32 based device with a CC1101 transceiver connected due to the resource requirements of the rtl_433 device decoders. At the present time only Pulse Position Modulation (OOK_PPM) and Pulse Width Modulation (OOK_PWM) based decoders are available. +This feature is only available on a ESP32 based device with a supported transceiver connected due to the resource requirements of the rtl_433 device decoders. At the present time only Pulse Position Modulation (OOK_PPM) and Pulse Width Modulation (OOK_PWM) based decoders are available. + +### Supported hardware combinations + +- ESP32 based device with a CC1101 transceiver +- Heltec WiFi LoRa 32 (V2.1) + +### Supported Decoders ``` Registering protocol [2] "Acurite 609TXC Temperature and Humidity Sensor" @@ -254,75 +261,80 @@ Registering protocol [4] "Acurite 986 Refrigerator / Freezer Thermometer" Registering protocol [5] "Acurite 606TX Temperature Sensor" Registering protocol [6] "Acurite 00275rm,00276rm Temp/Humidity with optional probe" Registering protocol [7] "Acurite 590TX Temperature with optional Humidity" -Registering protocol [8] "Akhan 100F14 remote keyless entry" -Registering protocol [9] "AlectoV1 Weather Sensor (Alecto WS3500 WS4500 Ventus W155/W044 Oregon)" -Registering protocol [10] "Ambient Weather TX-8300 Temperature/Humidity Sensor" -Registering protocol [11] "Auriol AFW2A1 temperature/humidity sensor" -Registering protocol [12] "Auriol HG02832, HG05124A-DCF, Rubicson 48957 temperature/humidity sensor" -Registering protocol [13] "BlueLine Power Monitor" -Registering protocol [14] "Blyss DC5-UK-WH" -Registering protocol [16] "Bresser Thermo-/Hygro-Sensor 3CH" -Registering protocol [18] "Burnhard BBQ thermometer" -Registering protocol [19] "Calibeur RF-104 Sensor" -Registering protocol [20] "Cardin S466-TX2" -Registering protocol [21] "Chuango Security Technology" -Registering protocol [22] "Companion WTR001 Temperature Sensor" -Registering protocol [25] "Ecowitt Wireless Outdoor Thermometer WH53/WH0280/WH0281A" -Registering protocol [26] "Eurochron EFTH-800 temperature and humidity sensor" -Registering protocol [30] "Esperanza EWS" -Registering protocol [32] "Fine Offset Electronics, WH2, WH5, Telldus Temperature/Humidity/Rain Sensor" -Registering protocol [33] "Fine Offset Electronics, WH0530 Temperature/Rain Sensor" -Registering protocol [34] "Fine Offset WH1050 Weather Station" -Registering protocol [35] "Fine Offset Electronics WH1080/WH3080 Weather Station" -Registering protocol [37] "FT-004-B Temperature Sensor" -Registering protocol [38] "Generic wireless motion sensor" -Registering protocol [39] "Generic Remote SC226x EV1527" -Registering protocol [40] "Generic temperature sensor 1" -Registering protocol [41] "Globaltronics QUIGG GT-TMBBQ-05" -Registering protocol [42] "Globaltronics GT-WT-02 Sensor" -Registering protocol [43] "Globaltronics GT-WT-03 Sensor" -Registering protocol [44] "Microchip HCS200 KeeLoq Hopping Encoder based remotes" -Registering protocol [45] "Honeywell ActivLink, Wireless Doorbell" -Registering protocol [46] "HT680 Remote control" -Registering protocol [47] "inFactory, nor-tec, FreeTec NC-3982-913 temperature humidity sensor" -Registering protocol [49] "Interlogix GE UTC Security Devices" -Registering protocol [51] "Kedsum Temperature & Humidity Sensor, Pearl NC-7415" -Registering protocol [52] "Kerui PIR / Contact Sensor" -Registering protocol [53] "LaCrosse TX Temperature / Humidity Sensor" -Registering protocol [54] "LaCrosse TX141-Bv2, TX141TH-Bv2, TX141-Bv3, TX141W, TX145wsdth sensor" -Registering protocol [55] "LaCrosse/ELV/Conrad WS7000/WS2500 weather sensors" -Registering protocol [56] "LaCrosse WS-2310 / WS-3600 Weather Station" -Registering protocol [58] "Maverick et73" -Registering protocol [60] "Missil ML0757 weather station" -Registering protocol [64] "Nexus, FreeTec NC-7345, NX-3980, Solight TE82S, TFA 30.3209 temperature/humidity sensor" -Registering protocol [66] "Opus/Imagintronix XT300 Soil Moisture" -Registering protocol [67] "Oregon Scientific SL109H Remote Thermal Hygro Sensor" -Registering protocol [69] "Philips outdoor temperature sensor (type AJ3650)" -Registering protocol [70] "Philips outdoor temperature sensor (type AJ7010)" -Registering protocol [71] "Prologue, FreeTec NC-7104, NC-7159-675 temperature sensor" -Registering protocol [73] "Quhwa" -Registering protocol [75] "Rubicson Temperature Sensor" -Registering protocol [76] "Rubicson 48659 Thermometer" -Registering protocol [77] "Conrad S3318P, FreeTec NC-5849-913 temperature humidity sensor" -Registering protocol [78] "Silvercrest Remote Control" -Registering protocol [79] "Skylink HA-434TL motion sensor" -Registering protocol [80] "Wireless Smoke and Heat Detector GS 558" -Registering protocol [81] "Solight TE44/TE66, EMOS E0107T, NX-6876-917" -Registering protocol [82] "Springfield Temperature and Soil Moisture" -Registering protocol [83] "TFA Dostmann 30.3221.02 T/H Outdoor Sensor" -Registering protocol [84] "TFA Drop Rain Gauge 30.3233.01" -Registering protocol [85] "TFA pool temperature sensor" -Registering protocol [86] "TFA-Twin-Plus-30.3049, Conrad KW9010, Ea2 BL999" -Registering protocol [87] "Thermopro TP11 Thermometer" -Registering protocol [88] "Thermopro TP08/TP12/TP20 thermometer" -Registering protocol [90] "TS-FT002 Wireless Ultrasonic Tank Liquid Level Meter With Temperature Sensor" -Registering protocol [91] "Visonic powercode" -Registering protocol [92] "Waveman Switch Transmitter" -Registering protocol [93] "WG-PB12V1 Temperature Sensor" -Registering protocol [94] "WS2032 weather station" -Registering protocol [95] "Hyundai WS SENZOR Remote Temperature Sensor" -Registering protocol [96] "WT0124 Pool Thermometer" -Registering protocol [98] "X10 Security" +Registering protocol [8] "Acurite Grill/Meat Thermometer 01185M" +Registering protocol [9] "Akhan 100F14 remote keyless entry" +Registering protocol [10] "AlectoV1 Weather Sensor (Alecto WS3500 WS4500 Ventus W155/W044 Oregon)" +Registering protocol [11] "Ambient Weather TX-8300 Temperature/Humidity Sensor" +Registering protocol [13] "Auriol AFT 77 B2 temperature sensor" +Registering protocol [14] "Auriol AFW2A1 temperature/humidity sensor" +Registering protocol [15] "Auriol AHFL temperature/humidity sensor" +Registering protocol [16] "Auriol HG02832, HG05124A-DCF, Rubicson 48957 temperature/humidity sensor" +Registering protocol [18] "Blyss DC5-UK-WH" +Registering protocol [20] "Bresser Thermo-/Hygro-Sensor 3CH" +Registering protocol [22] "Burnhard BBQ thermometer" +Registering protocol [23] "Calibeur RF-104 Sensor" +Registering protocol [24] "Cardin S466-TX2" +Registering protocol [25] "Chuango Security Technology" +Registering protocol [26] "Companion WTR001 Temperature Sensor" +Registering protocol [29] "Ecowitt Wireless Outdoor Thermometer WH53/WH0280/WH0281A" +Registering protocol [30] "Eurochron EFTH-800 temperature and humidity sensor" +Registering protocol [34] "Esperanza EWS" +Registering protocol [36] "Fine Offset Electronics, WH2, WH5, Telldus Temperature/Humidity/Rain Sensor" +Registering protocol [37] "Fine Offset Electronics, WH0530 Temperature/Rain Sensor" +Registering protocol [38] "Fine Offset WH1050 Weather Station" +Registering protocol [39] "Fine Offset Electronics WH1080/WH3080 Weather Station" +Registering protocol [41] "FT-004-B Temperature Sensor" +Registering protocol [42] "Generic wireless motion sensor" +Registering protocol [43] "Generic Remote SC226x EV1527" +Registering protocol [44] "Generic temperature sensor 1" +Registering protocol [45] "Govee Water Leak Dectector H5054, Door Contact Sensor B5023" +Registering protocol [46] "Globaltronics QUIGG GT-TMBBQ-05" +Registering protocol [47] "Globaltronics GT-WT-02 Sensor" +Registering protocol [48] "Globaltronics GT-WT-03 Sensor" +Registering protocol [49] "Microchip HCS200 KeeLoq Hopping Encoder based remotes" +Registering protocol [50] "Honeywell ActivLink, Wireless Doorbell" +Registering protocol [51] "HT680 Remote control" +Registering protocol [52] "inFactory, nor-tec, FreeTec NC-3982-913 temperature humidity sensor" +Registering protocol [54] "Interlogix GE UTC Security Devices" +Registering protocol [56] "Kedsum Temperature & Humidity Sensor, Pearl NC-7415" +Registering protocol [57] "Kerui PIR / Contact Sensor" +Registering protocol [58] "LaCrosse TX Temperature / Humidity Sensor" +Registering protocol [59] "LaCrosse TX141-Bv2, TX141TH-Bv2, TX141-Bv3, TX141W, TX145wsdth sensor" +Registering protocol [60] "LaCrosse/ELV/Conrad WS7000/WS2500 weather sensors" +Registering protocol [61] "LaCrosse WS-2310 / WS-3600 Weather Station" +Registering protocol [63] "Markisol, E-Motion, BOFU, Rollerhouse, BF-30x, BF-415 curtain remote" +Registering protocol [64] "Maverick et73" +Registering protocol [66] "Missil ML0757 weather station" +Registering protocol [68] "Nexus, FreeTec NC-7345, NX-3980, Solight TE82S, TFA 30.3209 temperature/humidity sensor" +Registering protocol [70] "Opus/Imagintronix XT300 Soil Moisture" +Registering protocol [71] "Oregon Scientific SL109H Remote Thermal Hygro Sensor" +Registering protocol [73] "Philips outdoor temperature sensor (type AJ3650)" +Registering protocol [74] "Philips outdoor temperature sensor (type AJ7010)" +Registering protocol [75] "Prologue, FreeTec NC-7104, NC-7159-675 temperature sensor" +Registering protocol [76] "Quhwa" +Registering protocol [78] "Rubicson Temperature Sensor" +Registering protocol [79] "Rubicson 48659 Thermometer" +Registering protocol [80] "Conrad S3318P, FreeTec NC-5849-913 temperature humidity sensor" +Registering protocol [81] "Silvercrest Remote Control" +Registering protocol [82] "Skylink HA-434TL motion sensor" +Registering protocol [83] "Wireless Smoke and Heat Detector GS 558" +Registering protocol [84] "Solight TE44/TE66, EMOS E0107T, NX-6876-917" +Registering protocol [85] "Springfield Temperature and Soil Moisture" +Registering protocol [86] "TFA Dostmann 30.3221.02 T/H Outdoor Sensor" +Registering protocol [87] "TFA Drop Rain Gauge 30.3233.01" +Registering protocol [88] "TFA pool temperature sensor" +Registering protocol [89] "TFA-Twin-Plus-30.3049, Conrad KW9010, Ea2 BL999" +Registering protocol [90] "Thermopro TP11 Thermometer" +Registering protocol [91] "Thermopro TP08/TP12/TP20 thermometer" +Registering protocol [93] "TS-FT002 Wireless Ultrasonic Tank Liquid Level Meter With Temperature Sensor" +Registering protocol [94] "Visonic powercode" +Registering protocol [95] "Waveman Switch Transmitter" +Registering protocol [96] "WG-PB12V1 Temperature Sensor" +Registering protocol [97] "WS2032 weather station" +Registering protocol [98] "Hyundai WS SENZOR Remote Temperature Sensor" +Registering protocol [99] "WT0124 Pool Thermometer" +Registering protocol [100] "X10 RF" +Registering protocol [101] "X10 Security" ``` ### Change receive frequency @@ -331,17 +343,12 @@ Default receive frequency of the CC1101 module is 433.92 Mhz, and this can be ca `home/OpenMQTTGateway/commands/MQTTtoRTL_433 {"mhz":315.026}` -### Minimum Signal Strength - -Default minimum signal strength to enable the receiver is -82, and this setting can be changed with the following command. - -`home/OpenMQTTGateway/commands/MQTTtoRTL_433 {"rssi":-75}` +### Change Signal RSSI Threshold Delta -### Enable rtl_433 device decoder verbose debug +Delta applied to RSSI floor noise level to determine start and end of signal, defaults to 9db. -This function does not work when all available decoders are enabled and triggers an out of memory restart. +`home/OpenMQTTGateway/commands/MQTTtoRTL_433 {"rssi": 9}` -`home/OpenMQTTGateway/commands/MQTTtoRTL_433 {"debug":4}` ### Retrieve current status of receiver @@ -353,13 +360,16 @@ This function does not work when all available decoders are enabled and triggers "debug":0, - rtl_433 verbose setting "duration":11799327, - duration of current signal "Gap length":-943575, - duration of gap between current signal -"signalRssi":-38, - most recent received signal strength +"rssi":-38, - most recent received signal strength "train":1, - signal processing train # "messageCount":3, - total number of signals received +"totalSignals":9, - RegOokFix signal quality count ( of 10 ) +"ignoredSignals":0, - RegOokFix signal quality ignored signals +"unparsedSignals":3, - RegOokFix signal quality unparseable signals "_enabledReceiver":1, - which receiver is enabled "receiveMode":0, - is the receiver currently receiving a signal "currentRssi":-89, - current rssi level -"minimumRssi":-82, - minimum rssi level to start signal processing +"rssiThreshold":-82, - minimum rssi level to start signal processing "pulses":0, - how many pulses have been received in the current signal "StackHighWaterMark":5528, - ESP32 Stack "freeMem":112880} - ESP32 memory available