Skip to content

Trial port of the rtl_433 Library for use with OpenMQTTGateway on a ESP32 and a CC1101 Transceiver

License

Notifications You must be signed in to change notification settings

wastlmuc/rtl_433_ESP

 
 

Repository files navigation

This is an attempt at creating an Arduino library for use on ESP32 boards with a CC1101 transceiver or SX127X Transceivers with the device decoders from the rtl_433 package. And be available for use with openMQTTGateway as an available module.

Inspiration for this came from the ESPiLight effort. Kudos to puuu for this, and the awesome package.

This is the LILYGO® LoRa32 V2.1_1.6.1 433Mhz board running OpenMQTTGateway. image

The initial port implements only enables a subset of the available modulations and device decoders, and is limited to devices I have access to and can test with.

  • One comment about the transceiver modules, I have found that the receiver is not as sensitive as a rtl_sdr and I only get about 1/2 the range or less. And having the antenna oriented into a vertical position does improve reception.

Enabled rtl_433 Demodulation modules

OOK

OOK_MC_ZEROBIT
OOK_PULSE_DMC
OOK_PULSE_MANCHESTER_ZEROBIT
OOK_PULSE_NRZS
OOK_PULSE_PCM
OOK_PULSE_PIWM_DC
OOK_PULSE_PPM
OOK_PULSE_PWM
OOK_PULSE_PWM_OSV1
OOK_PULSE_RZ

FSK

FSK_PULSE_MANCHESTER_ZEROBIT
FSK_PULSE_PCM
FSK_PULSE_PWM

Enabled Device Decoders from rtl_433 release 22.11

OOK Signal Device Decoders

Registering protocol [0] "Amazon Basics Meat Thermometer"
Registering protocol [1] "Acurite 896 Rain Gauge"
Registering protocol [2] "Acurite 609TXC Temperature and Humidity Sensor"
Registering protocol [3] "Acurite 592TXR Temp/Humidity, 592TX Temp, 5n1 Weather Station, 6045 Lightning, 899 Rain, 3N1, Atlas"
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] "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 F007TH, TFA 30.3208.02, SwitchDocLabs F016TH temperature sensor"
Registering protocol [12] "Ambient Weather TX-8300 Temperature/Humidity Sensor"
Registering protocol [13] "Atech-WS308 temperature sensor"
Registering protocol [15] "Auriol AFT 77 B2 temperature sensor"
Registering protocol [16] "Auriol AFW2A1 temperature/humidity sensor"
Registering protocol [17] "Auriol AHFL temperature/humidity sensor"
Registering protocol [18] "Auriol HG02832, HG05124A-DCF, Rubicson 48957 temperature/humidity sensor"
Registering protocol [20] "Blyss DC5-UK-WH"
Registering protocol [22] "Bresser Thermo-/Hygro-Sensor 3CH"
Registering protocol [24] "Burnhard BBQ thermometer"
Registering protocol [25] "Calibeur RF-104 Sensor"
Registering protocol [26] "Cardin S466-TX2"
Registering protocol [27] "Celsia CZC1 Thermostat"
Registering protocol [28] "Chuango Security Technology"
Registering protocol [29] "Clipsal CMR113 Cent-a-meter power meter"
Registering protocol [30] "Companion WTR001 Temperature Sensor"
Registering protocol [31] "Cotech 36-7959, SwitchDocLabs FT020T wireless weather station with USB"
Registering protocol [32] "Digitech XC-0324 / AmbientWeather FT005TH temp/hum sensor"
Registering protocol [34] "DSC Security Contact"
Registering protocol [35] "DSC Security Contact (WS4945)"
Registering protocol [36] "Ecowitt Wireless Outdoor Thermometer WH53/WH0280/WH0281A"
Registering protocol [37] "Eurochron EFTH-800 temperature and humidity sensor"
Registering protocol [41] "EMOS E6016 weatherstation with DCF77"
Registering protocol [42] "EMOS E6016 rain gauge"
Registering protocol [44] "ERT Interval Data Message (IDM)"
Registering protocol [45] "ERT Interval Data Message (IDM) for Net Meters"
Registering protocol [46] "ERT Standard Consumption Message (SCM)"
Registering protocol [48] "Esperanza EWS"
Registering protocol [50] "Fine Offset Electronics, WH2, WH5, Telldus Temperature/Humidity/Rain Sensor"
Registering protocol [51] "Fine Offset Electronics, WH0530 Temperature/Rain Sensor"
Registering protocol [52] "Fine Offset WH1050 Weather Station"
Registering protocol [53] "Fine Offset Electronics WH1080/WH3080 Weather Station"
Registering protocol [54] "Ford Car Key"
Registering protocol [56] "FT-004-B Temperature Sensor"
Registering protocol [57] "Funkbus / Instafunk (Berker, Gira, Jung)"
Registering protocol [58] "Gasmate BA1008 meat thermometer"
Registering protocol [59] "Generic wireless motion sensor"
Registering protocol [60] "Generic Remote SC226x EV1527"
Registering protocol [61] "Generic temperature sensor 1"
Registering protocol [62] "Govee Water Leak Detector H5054, Door Contact Sensor B5023"
Registering protocol [63] "Govee Water Leak Detector H5054"
Registering protocol [64] "Globaltronics QUIGG GT-TMBBQ-05"
Registering protocol [65] "Globaltronics GT-WT-02 Sensor"
Registering protocol [66] "Globaltronics GT-WT-03 Sensor"
Registering protocol [67] "Microchip HCS200/HCS300 KeeLoq Hopping Encoder based remotes"
Registering protocol [68] "HIDEKI TS04 Temperature, Humidity, Wind and Rain Sensor"
Registering protocol [69] "Honeywell Door/Window Sensor, 2Gig DW10/DW11, RE208 repeater"
Registering protocol [70] "Honeywell ActivLink, Wireless Doorbell"
Registering protocol [71] "HT680 Remote control"
Registering protocol [72] "IBIS beacon"
Registering protocol [73] "inFactory, nor-tec, FreeTec NC-3982-913 temperature humidity sensor"
Registering protocol [75] "Interlogix GE UTC Security Devices"
Registering protocol [77] "Jasco/GE Choice Alert Security Devices"
Registering protocol [78] "Kedsum Temperature & Humidity Sensor, Pearl NC-7415"
Registering protocol [79] "Kerui PIR / Contact Sensor"
Registering protocol [81] "LaCrosse TX Temperature / Humidity Sensor"
Registering protocol [82] "LaCrosse TX141-Bv2, TX141TH-Bv2, TX141-Bv3, TX141W, TX145wsdth, (TFA, ORIA) sensor"
Registering protocol [83] "LaCrosse/ELV/Conrad WS7000/WS2500 weather sensors"
Registering protocol [84] "LaCrosse WS-2310 / WS-3600 Weather Station"
Registering protocol [86] "Markisol, E-Motion, BOFU, Rollerhouse, BF-30x, BF-415 curtain remote"
Registering protocol [87] "Maverick et73"
Registering protocol [88] "Maverick ET-732/733 BBQ Sensor"
Registering protocol [90] "Linear Megacode Garage/Gate Remotes"
Registering protocol [91] "Missil ML0757 weather station"
Registering protocol [92] "Neptune R900 flow meters"
Registering protocol [94] "KlikAanKlikUit Wireless Switch"
Registering protocol [95] "Nexa"
Registering protocol [96] "Nexus, FreeTec NC-7345, NX-3980, Solight TE82S, TFA 30.3209 temperature/humidity sensor"
Registering protocol [98] "Norgo NGE101"
Registering protocol [99] "Oil Ultrasonic STANDARD ASK"
Registering protocol [100] "Opus/Imagintronix XT300 Soil Moisture"
Registering protocol [101] "Oregon Scientific Weather Sensor"
Registering protocol [102] "Oregon Scientific SL109H Remote Thermal Hygro Sensor"
Registering protocol [103] "OSv1 Temperature Sensor"
Registering protocol [104] "Philips outdoor temperature sensor (type AJ3650)"
Registering protocol [105] "Philips outdoor temperature sensor (type AJ7010)"
Registering protocol [106] "SmartFire Proflame 2 remote control"
Registering protocol [107] "Prologue, FreeTec NC-7104, NC-7159-675 temperature sensor"
Registering protocol [108] "Proove / Nexa / KlikAanKlikUit Wireless Switch"
Registering protocol [109] "Quhwa"
Registering protocol [110] "Radiohead ASK"
Registering protocol [111] "Sensible Living Mini-Plant Moisture Sensor"
Registering protocol [112] "RainPoint soil temperature and moisture sensor"
Registering protocol [113] "Regency Ceiling Fan Remote (-f 303.75M to 303.96M)"
Registering protocol [114] "Revolt NC-5642 Energy Meter"
Registering protocol [116] "Rubicson, TFA 30.3197 or InFactory PT-310 Temperature Sensor"
Registering protocol [117] "Rubicson 48659 Thermometer"
Registering protocol [118] "Rubicson Pool Thermometer 48942"
Registering protocol [119] "Conrad S3318P, FreeTec NC-5849-913 temperature humidity sensor"
Registering protocol [120] "Schrader TPMS"
Registering protocol [121] "Schrader TPMS EG53MA4, PA66GF35"
Registering protocol [122] "Schrader TPMS SMD3MA4 (Subaru) 3039 (Infiniti, Nissan, Renault)"
Registering protocol [123] "Standard Consumption Message Plus (SCMplus)"
Registering protocol [124] "Security+ (Keyfob)"
Registering protocol [125] "Silvercrest Remote Control"
Registering protocol [126] "SimpliSafe Home Security System (May require disabling automatic gain for KeyPad decodes)"
Registering protocol [127] "Skylink HA-434TL motion sensor"
Registering protocol [128] "Wireless Smoke and Heat Detector GS 558"
Registering protocol [129] "Solight TE44/TE66, EMOS E0107T, NX-6876-917"
Registering protocol [130] "Somfy RTS"
Registering protocol [131] "Springfield Temperature and Soil Moisture"
Registering protocol [132] "Telldus weather station FT0385R sensors"
Registering protocol [133] "TFA Dostmann 30.3221.02 T/H Outdoor Sensor"
Registering protocol [134] "TFA Drop Rain Gauge 30.3233.01"
Registering protocol [135] "TFA pool temperature sensor"
Registering protocol [136] "TFA-Twin-Plus-30.3049, Conrad KW9010, Ea2 BL999"
Registering protocol [137] "Thermopro TP11 Thermometer"
Registering protocol [138] "Thermopro TP08/TP12/TP20 thermometer"
Registering protocol [140] "EezTire E618 (TPMS10ATC)"
Registering protocol [141] "TyreGuard 400 TPMS"
Registering protocol [142] "TS-FT002 Wireless Ultrasonic Tank Liquid Level Meter With Temperature Sensor"
Registering protocol [143] "Emos TTX201 Temperature Sensor"
Registering protocol [144] "Vaillant calorMatic VRT340f Central Heating Control"
Registering protocol [145] "Vauno EN8822C"
Registering protocol [146] "Visonic powercode"
Registering protocol [147] "Waveman Switch Transmitter"
Registering protocol [149] "WG-PB12V1 Temperature Sensor"
Registering protocol [150] "WS2032 weather station"
Registering protocol [151] "Hyundai WS SENZOR Remote Temperature Sensor"
Registering protocol [152] "WT0124 Pool Thermometer"
Registering protocol [153] "WT450, WT260H, WT405H"
Registering protocol [154] "X10 RF"
Registering protocol [155] "X10 Security"
Registering protocol [156] "Yale HSA (Home Security Alarm), YES-Alarmkit"

The gaps in the numbers are device decoders disabled by default.

FSK Signal Device Decoders

Registering protocol [0] "Ambient Weather WH31E Thermo-Hygrometer Sensor, EcoWitt WH40 rain gauge"
Registering protocol [2] "TBH weather sensor"
Registering protocol [3] "Badger ORION water meter, 100kbps (-f 916.45M -s 1200k)"
Registering protocol [4] "Bresser Weather Center 5-in-1"
Registering protocol [5] "Bresser Weather Center 6-in-1, 7-in-1 indoor, soil, new 5-in-1, 3-in-1 wind gauge, Froggit WH6000, Ventus C8488A"
Registering protocol [6] "Bresser Weather Center 7-in-1"
Registering protocol [7] "Cavius smoke, heat and water detector"
Registering protocol [9] "CurrentCost Current Sensor"
Registering protocol [10] "Danfoss CFR Thermostat"
Registering protocol [11] "DirecTV RC66RX Remote Control"
Registering protocol [12] "EcoDHOME Smart Socket and MCEE Solar monitor"
Registering protocol [13] "Efergy e2 classic"
Registering protocol [14] "Efergy Optical"
Registering protocol [15] "Emax W6, rebrand Altronics x7063/4, Optex 990040/50/51, Orium 13093/13123, Infactory FWS-1200, Newentor Q9, Otio 810025, Protmex PT3390A, Jula Marquant 014331/32, Weather Station or temperature/humidity sensor"
Registering protocol [16] "emonTx OpenEnergyMonitor"
Registering protocol [17] "ESIC EMT7110 power meter"
Registering protocol [18] "Fine Offset Electronics, WH25, WH32B, WH24, WH65B, HP1000, Misol WS2320 Temperature/Humidity/Pressure Sensor"
Registering protocol [19] "Fine Offset Electronics/ECOWITT WH51, SwitchDoc Labs SM23 Soil Moisture Sensor"
Registering protocol [20] "Fine Offset Electronics WH1080/WH3080 Weather Station (FSK)"
Registering protocol [21] "Ambient Weather WH31L (FineOffset WH57) Lightning-Strike sensor"
Registering protocol [22] "Fine Offset Electronics WH45 air quality sensor"
Registering protocol [23] "Fine Offset Electronics WN34 temperature sensor"
Registering protocol [24] "Fine Offset Electronics WS80 weather station"
Registering protocol [25] "Flowis flow meters"
Registering protocol [26] "GE Color Effects"
Registering protocol [27] "GEO minim+ energy monitor"
Registering protocol [28] "Microchip HCS200/HCS300 KeeLoq Hopping Encoder based remotes (FSK)"
Registering protocol [29] "Holman Industries iWeather WS5029 weather station (newer PCM)"
Registering protocol [30] "Holman Industries iWeather WS5029 weather station (older PWM)"
Registering protocol [32] "Honeywell CM921 Wireless Programmable Room Thermostat"
Registering protocol [33] "Honeywell ActivLink, Wireless Doorbell (FSK)"
Registering protocol [34] "IKEA Sparsnas Energy Meter Monitor"
Registering protocol [35] "Inkbird ITH-20R temperature humidity sensor"
Registering protocol [36] "Insteon"
Registering protocol [37] "LaCrosse Technology View LTV-WSDTH01 Breeze Pro Wind Sensor"
Registering protocol [38] "LaCrosse Technology View LTV-R1, LTV-R3 Rainfall Gauge, LTV-W1/W2 Wind Sensor"
Registering protocol [39] "LaCrosse Technology View LTV-TH Thermo/Hygro Sensor"
Registering protocol [40] "LaCrosse TX31U-IT, The Weather Channel WS-1910TWC-IT"
Registering protocol [41] "LaCrosse TX34-IT rain gauge"
Registering protocol [42] "LaCrosse TX29IT, TFA Dostmann 30.3159.IT Temperature sensor"
Registering protocol [43] "LaCrosse TX35DTH-IT, TFA Dostmann 30.3155 Temperature/Humidity sensor"
Registering protocol [44] "LaCrosse Technology View LTV-WR1 Multi Sensor"
Registering protocol [45] "Wireless M-Bus, Mode C&T, 100kbps (-f 868.95M -s 1200k)"
Registering protocol [46] "Wireless M-Bus, Mode T, 32.768kbps (-f 868.3M -s 1000k)"
Registering protocol [47] "Wireless M-Bus, Mode S, 32.768kbps (-f 868.3M -s 1000k)"
Registering protocol [50] "Marlec Solar iBoost+ sensors"
Registering protocol [51] "Maverick XR-30 BBQ Sensor"
Registering protocol [52] "Oil Ultrasonic SMART FSK"
Registering protocol [53] "Oil Ultrasonic STANDARD FSK"
Registering protocol [54] "Watchman Sonic / Apollo Ultrasonic / Beckett Rocket oil tank monitor"
Registering protocol [55] "Watchman Sonic Advanced / Plus"
Registering protocol [56] "RojaFlex shutter and remote devices"
Registering protocol [57] "Sharp SPC775 weather station"
Registering protocol [58] "SimpliSafe Gen 3 Home Security System"
Registering protocol [59] "Somfy io-homecontrol"
Registering protocol [60] "SRSmith Pool Light Remote Control SRS-2C-TX (-f 915M)"
Registering protocol [61] "Steelmate TPMS"
Registering protocol [62] "TFA Dostmann 14.1504.V2 Radio-controlled grill and meat thermometer"
Registering protocol [63] "TFA Dostmann 30.3196 T/H outdoor sensor"
Registering protocol [64] "TFA Marbella Pool Thermometer"
Registering protocol [65] "Abarth 124 Spider TPMS"
Registering protocol [66] "AVE TPMS"
Registering protocol [67] "Citroen TPMS"
Registering protocol [68] "Elantra2012 TPMS"
Registering protocol [69] "Ford TPMS"
Registering protocol [70] "Hyundai TPMS (VDO)"
Registering protocol [72] "Jansite TPMS Model Solar"
Registering protocol [73] "Kia TPMS (-s 1000k)"
Registering protocol [74] "PMV-107J (Toyota) TPMS"
Registering protocol [75] "Porsche Boxster/Cayman TPMS"
Registering protocol [76] "Renault TPMS"
Registering protocol [77] "Renault 0435R TPMS"
Registering protocol [78] "Toyota TPMS"
Registering protocol [79] "Unbranded SolarTPMS for trucks"

Sensors I use as part of Testing

These are the sensors that are part of my personal collection, and can confirm that they work correctly. Other sensors devices are on a best effort basis as I have no method to test and confirm functionality.

Acurite Tower - Acurite 592TXR Temp/Humidity, 592TX Temp, 5n1 Weather Station, 6045 Lightning, 899 Rain, 3N1, Atlas LaCrosse-TX141Bv3 - LaCrosse TX141-Bv2, TX141TH-Bv2, TX141-Bv3, TX141W, TX145wsdth, (TFA, ORIA) sensor Acurite-986 - Acurite 986 Refrigerator / Freezer Thermometer Skylink_HA-434TL_motion - Skylink HA-434TL motion sensor FineOffSet WH51

Transceiver Modules Supported

CC1101 433 Mhz Transceiver Module

Datasheet for the CC1101 board I'm using

CC1101 datasheet

SX127X - Heltec WiFi LoRa 32 and LILYGO® LoRa32

This is the Heltec SX127X board I used for development. I used the 433 Mhz Board

This is the LILYGO® LoRa32 V2.1_1.6.1 433 board I used for development. I used the 433 Mhz Board

SX1278 - external to ESP32 DOIT DevKit V1

This is the AI-Thinker R01 - SX1278 module I used for development. I used the Ra-01 433 Mhz Board

This is the ESP32 DOIT DevKit V1 board I used for development.

Wiring for ESP32 DOIT DevKit V1 and AI-Thinker R01 - SX1278

image

Wiring and Building the Example

Details are here

Projects using the library

Roadmap / Next Steps

  • Firmware size tuning
  • Further heap usage tuning
  • Find stack leak when running all devices
  • Enable additional pulse demod functions
  • Simplify the process to update from the rtl_433 source

Signal detection and reception approach

To determne that a signal is available for reception, the library watches the current RSSI reported by the transceiver module and when it crosses a predetermined RSSI threshold it enables the signal receiver function. End of signal is determined when the signal drops below the predetermined RSSI threshold for a minimum of 150,000 micro seconds.

RSSI Threshold Automatic Setting

The RSSI Threshold for signal detection is automatically determined based on the average RSSI signal level received aka RSSI floor level with a delta ( RSSI_THRESHOLD ) added to it. The average RSSI signal level is calculated over RSSI_SAMPLES.

SX127X OOK RSSI FIXED Threshold

For background see section 2.1.3.2. of SX127X Data sheet

To tune the SX127X OOK RSSI FIXED Threshold two values are used to determine if the threshold needs to be increased or decreased. The first is the noise received between signals. If the number of noise bits received between signals is greater than 100, then the threshold is incremented. Second is the unparsed signals. If an unparsed signal is received, but it has less than 20 pulses, the threshold is decremented.

The first approach is what is recommended in the SX127X datasheet, and the second is a control to lower the threshold if it is too high and incomplete signals are received.

Compile definition options

DEMOD_DEBUG           ; enable verbose debugging of signal processing
DEVICE_DEBUG          ; Validate fields are mapped to response object ( rtl_433 )
MEMORY_DEBUG          ; display heap usage information
RESOURCE_DEBUG        : Monitor HEAP and STACK usage and report large jumps
MY_DEVICES            ; Only include my personal subset of devices
NO_DEAF_WORKAROUND    ; Workaround for issue #16 ( by default the workaround is enabaled )
PUBLISH_UNPARSED      ; Enable publishing of MQTT messages for unparsed signals, e.g. {model":"unknown","protocol":"signal parsing failed"…
RAW_SIGNAL_DEBUG      ; display raw received messages
RSSI_SAMPLES          ; Number of rssi samples to collect for average calculation, defaults to 50,000
RSSI_THRESHOLD        ; Delta applied to average RSSI value to calculate RSSI Signal Threshold, defaults to 9
RTL_DEBUG             ; Enable RTL_433 device decoder verbose mode for all device decoders ( 0=normal, 1=verbose, 2=verbose decoders, 3=debug decoders, 4=trace decoding. )
RTL_VERBOSE=##        ; Enable RTL_433 device decoder verbose mode, ## is the decoder # from the appropriate memcpy line in signalDecoder.cpp
RTL_ANALYZER          ; Enable pulse stream analysis ( note is very resource intensive and will not work with other modules )
RTL_ANALYZE=##        ; Enable pulse stream analysis for decoder ##
SIGNAL_RSSI           ; Enable collection of per pulse RSSI Values during signal reception for display in signal debug messages
RF_MODULE_INIT_STATUS ; Display transceiver config during startup
DISABLERSSITHRESHOLD  ; Disable automatic setting of RSSI_THRESHOLD ( legacy behaviour ), and use MINRSSI ( -82 )
OOK_MODULATION        ; Enable OOK Device Decoders, setting to false enables FSK Device Decoders 

RF Module Wiring

ONBOARD_LED           ; GPIO pin to toggle during signal reception ( Typically onboard LED )

SX1276 Module Options

RF_SX1276             ; Enable support for SX1276 Transceiver
OOK_FIXED_THRESHOLD   ; Initial OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90
AUTOOOKFIX            ; Set to enable automatic setting of OOK_FIXED_THRESHOLD based on noise level between signals

SX1276 Module Wiring ( Required if not using standard configuration )

RF_MODULE_CS          ; SX1276 SPI Chip select
RF_MODULE_DIO0        ; SX1276 DIO0 PIN
RF_MODULE_RST         ; SX1276 RST PIN
RF_MODULE_DIO1        ; SX1276 DIO1 PIN

SX1278 Module Options

RF_SX1278 - Enable support for SX1276
OOK_FIXED_THRESHOLD   ; Initial OOK threshold ( See 2.1.3.2. of datasheet ), defaults to 90
AUTOOOKFIX            ; Set to enable automatic setting of OOK_FIXED_THRESHOLD based on noise level between signals

SX1278 Module Wiring ( Required if not using standard configuration )

RF_MODULE_CS          ; SX1278 SPI Chip select
RF_MODULE_DIO0        ; SX1278 DIO0 PIN
RF_MODULE_RST         ; SX1278 RST PIN
RF_MODULE_DIO1        ; SX1278 DIO1 PIN

CC1101 Module Options

RF_CC1101             ; Enable support for CC1101 Transceiver
NO_DEAF_WORKAROUND    ; Workaround for issue #16 ( by default the workaround is enabaled )

CC1101 Module Wiring

RF_MODULE_CS          ; CC1101 SPI Chip select
RF_MODULE_GDO0        ; CC1101 GDOO PIN
RF_MODULE_GDO2        ; CC1101 GDO2 PIN

RF Module SPI Wiring ( Required if not using standard configuration )

When using a non standard SPI configuration ( Standard config is SCK - 18, MISO - 19, MOSI - 23, CS - 5)

RF_MODULE_SCK         ; SPI Clock
RF_MODULE_MISO        ; SPI Serial Output
RF_MODULE_MOSI        ; SPI Serial Input
RF_MODULE_CS          ; SPI Chip select

Porting approach

Copying src files

Copying rtl_433/src abuf.c to src/rtl_433
Copying rtl_433/src bitbuffer.c to src/rtl_433
Copying rtl_433/src compat_time.c to src/rtl_433
Copying rtl_433/src data.c to src/rtl_433
Copying rtl_433/src decoder_util.c to src/rtl_433
Copying rtl_433/src list.c to src/rtl_433
Copying rtl_433/src logger.c to src/rtl_433
Copying rtl_433/src output_log.c to src/rtl_433
Copying rtl_433/src pulse_data.c to src/rtl_433
Copying rtl_433/src r_util.c to src/rtl_433
Copying rtl_433/src util.c to src/rtl_433

These src files need copying and updating

cp ../rtl_433/src/pulse_analyzer.c ../src/rtl_433
cp ../rtl_433/src/pulse_slicer.c ../src/rtl_433
cp ../rtl_433/src/r_api.c ../src/rtl_433

Copying include files

Copying rtl_433/include abuf.h to include
Copying rtl_433/include bitbuffer.h to include
Copying rtl_433/include compat_time.h to include
Copying rtl_433/include decoder.h to include
Copying rtl_433/include decoder_util.h to include
Copying rtl_433/include fatal.h to include
Copying rtl_433/include list.h to include
Copying rtl_433/include logger.h to include
Copying rtl_433/include optparse.h to include
Copying rtl_433/include output_log.h to include
Copying rtl_433/include pulse_analyzer.h to include
Copying rtl_433/include pulse_detect.h to include
Copying rtl_433/include pulse_slicer.h to include
Copying rtl_433/include r_api.h to include
Copying rtl_433/include r_device.h to include
Copying rtl_433/include r_util.h to include
Copying rtl_433/include rfraw.h to include
Copying rtl_433/include util.h to include

These include files need copying and updating

cp ../rtl_433/include/data.h ../include
cp ../rtl_433/include/pulse_data.h ../include
cp ../rtl_433/include/r_private.h ../include
cp ../rtl_433/include/rtl_433.h ../include

Codebase conflicts

  • ESPiLight and rtl_433 conflict on silvercrest
.platformio/packages/toolchain-xtensa32/bin/../lib/gcc/xtensa-esp32-elf/5.2.0/../../../../xtensa-esp32-elf/bin/ld: Warning: size of symbol `silvercrest' changed from 4 in .pio/build/rtl_433-9e0770/libb28/libESPiLight.a(protocol.c.o) to 76 in .pio/build/rtl_433-9e0770/lib395/librtl_433_ESP.a(silvercrest.c.o)

Supporting Additional Devices etc

As support for devices is limited to what we have personally available, donations for additional devices is encouraged.

Donate

Thanks

  • Tks to the rtl_433 team for a great codebase
  • @diepeterpan for testing and showing that the OOK_PULSE_MANCHESTER_ZEROBIT decoder works, and adding support for Oregon-CM160 ( oregon_scientific.c)

Media Mentions

January 2023

February 2023

January 2024

About

Trial port of the rtl_433 Library for use with OpenMQTTGateway on a ESP32 and a CC1101 Transceiver

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C 92.7%
  • C++ 6.9%
  • Other 0.4%