{"id":22956803,"url":"https://github.com/juanboro/rtl_433_decoder_esp","last_synced_at":"2025-04-02T01:28:06.987Z","repository":{"id":263714665,"uuid":"891241408","full_name":"juanboro/rtl_433_Decoder_ESP","owner":"juanboro","description":"RTL_433 Decoder for ESP32","archived":false,"fork":false,"pushed_at":"2024-12-14T13:43:22.000Z","size":751,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-14T14:28:15.531Z","etag":null,"topics":["esp-arduino","esp32","esp32-idf","rtl433"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/juanboro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-20T01:27:37.000Z","updated_at":"2024-12-14T13:43:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"2998004e-41ef-47e4-bbf9-90b95c8ba21a","html_url":"https://github.com/juanboro/rtl_433_Decoder_ESP","commit_stats":null,"previous_names":["juanboro/rtl_433_decoder_esp"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juanboro%2Frtl_433_Decoder_ESP","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juanboro%2Frtl_433_Decoder_ESP/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juanboro%2Frtl_433_Decoder_ESP/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juanboro%2Frtl_433_Decoder_ESP/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/juanboro","download_url":"https://codeload.github.com/juanboro/rtl_433_Decoder_ESP/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229730822,"owners_count":18115421,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp-arduino","esp32","esp32-idf","rtl433"],"created_at":"2024-12-14T17:11:47.512Z","updated_at":"2025-02-07T16:29:32.297Z","avatar_url":"https://github.com/juanboro.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"This library enables [rtl_433](https://github.com/merbanan/rtl_433) signal decoding on ESP32 devices.  It is heavily based on the work of [rtl_433_ESP](https://github.com/NorthernMan54/rtl_433_ESP), but with the goal of just being a decoder library without dependencies on receiver hardware or MQTT output clients.\n\n# Library Usage\n## gist...\n```cpp\nvoid process_callback(char *msg, void *ctx) {\n  // msg points to a null terminated string in JSON format of the decoded data\n\n  // ctx points to whatever you set it to when calling processRaw. \n\n  // free() msg when you are done with it!\n  free(msg);\n}\n\n// call processRaw with a vector of on(+)/off(-) integer pulses\nvoid recv_raw(rtl_433_Decoder \u0026rd,std::vector\u003cint\u003e \u0026rawdata) {\n  rd.processRaw(rawdata, nullptr);\n}\n\n// Setup decoder with callback\nvoid init() {\n  rtl_433_Decoder rd;\n  rd.setCallback(\u0026process_callback);\n  rd.rtlSetup();\n}\n```\n\nAn example used for a ESPHome component can be found [here](https://github.com/juanboro/esphome-rtl_433-decoder/blob/main/components/rtl_433/rtl_433.cpp)\n\n## Recommendations\nThe main goal here is for being able to decode known devices, not as a signal analysis tool.  I'd recommend using rtl_sdr on a PC with a SDR (as well as other tools) to determine/test specific signals, and then configure this once working devices are determined for rtl_433.\n\n# More Advanced Usage and Notes\n## Compile definition options\n- MY_RTL433_DEVICES - allows compiling only a subset of decoders.  This could be desirable in order to help reduce memory and cpu overhead.  Example: ```-DMY_RTL433_DEVICES=\"DECL(govee_h5054) DECL(lacrosse_tx141x) \"```\n\n## Porting approach\nSee: [tools/update_rtl433.py](https://github.com/juanboro/rtl_433_Decoder_ESP/blob/main/tools/update_rtl433.py)\n\n# Todo\n* [X] Allow reporting the device enabled/disabled list \n* [X] Allow enabling disabled devices, and disable enabled\n* [X] Init class by default to allow OOK and FSK, and then control FSK/OOK on per signal basis (multiple receiver support)\n* [ ] Actually test with real FSK signals.\n* [ ] Re-enable _some_ of the debugging from rtl_433_ESP\nFor the first 3 above - see basic esphome [example](https://github.com/juanboro/esphome-rtl_433-decoder/blob/main/rtl_433_protocols.yaml)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuanboro%2Frtl_433_decoder_esp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuanboro%2Frtl_433_decoder_esp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuanboro%2Frtl_433_decoder_esp/lists"}