{"id":40912569,"url":"https://github.com/stuartparmenter/rtl433-addon","last_synced_at":"2026-01-22T03:09:15.587Z","repository":{"id":316991114,"uuid":"1065590913","full_name":"stuartparmenter/rtl433-addon","owner":"stuartparmenter","description":"rtl_433 Home Assistant Add-on","archived":false,"fork":false,"pushed_at":"2025-11-24T01:40:08.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-24T06:39:06.744Z","etag":null,"topics":["homeassistant","homeassistant-addon","rtlsdr"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stuartparmenter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-28T03:09:03.000Z","updated_at":"2025-11-24T01:40:09.000Z","dependencies_parsed_at":"2025-09-28T05:36:14.643Z","dependency_job_id":"3007bb2d-2a37-4a9b-9f7c-511a92f32bb6","html_url":"https://github.com/stuartparmenter/rtl433-addon","commit_stats":null,"previous_names":["stuartparmenter/rtl433-addon"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/stuartparmenter/rtl433-addon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuartparmenter%2Frtl433-addon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuartparmenter%2Frtl433-addon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuartparmenter%2Frtl433-addon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuartparmenter%2Frtl433-addon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stuartparmenter","download_url":"https://codeload.github.com/stuartparmenter/rtl433-addon/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuartparmenter%2Frtl433-addon/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28651851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T01:17:37.254Z","status":"online","status_checked_at":"2026-01-22T02:00:07.137Z","response_time":144,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["homeassistant","homeassistant-addon","rtlsdr"],"created_at":"2026-01-22T03:09:14.948Z","updated_at":"2026-01-22T03:09:15.580Z","avatar_url":"https://github.com/stuartparmenter.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rtl_433 Home Assistant Add-on\n\n## About\n\nThis add-on is a simple wrapper around the excellent [rtl_433](https://github.com/merbanan/rtl_433) project that receives wireless sensor data via [one of the supported SDR dongles](https://triq.org/rtl_433/HARDWARE.html), decodes and outputs it in a variety of formats including JSON and MQTT. The wireless sensors rtl_433 understands transmit data mostly on 433.92 MHz, 868 MHz, 315 MHz, 345 MHz, and 915 MHz ISM bands.\n\n## SDR Driver Information\n\n**Important**: There are multiple RTL-SDR driver repositories with confusingly similar names but different functionality. The main ones include:\n\n- [osmocom/rtl-sdr](https://github.com/osmocom/rtl-sdr) - The original upstream repository\n- [librtlsdr/librtlsdr](https://github.com/librtlsdr/librtlsdr) - Hayati Ayguen's fork with extensive enhancements\n- [rtlsdrblog/rtl-sdr-blog](https://github.com/rtlsdrblog/rtl-sdr-blog) - Modified drivers for RTL-SDR Blog hardware\n- [steve-m/librtlsdr](https://github.com/steve-m/librtlsdr) - Another older fork\n\nThis add-on uses [Hayati Ayguen's librtlsdr fork](https://github.com/librtlsdr/librtlsdr) which provides enhanced functionality over the original osmocom drivers, including better tuner control, additional bandwidth options, and improved compatibility with modern RTL-SDR hardware like the RTL-SDR Blog V4. Importantly, this fork supports bias tee control for the RTL-SDR Blog V4 dongles (set `bias_tee 1` in your rtl_433 config file to enable).\n\nNote: rtl_433 supports both rtl-sdr and [SoapySDR](https://github.com/pothosware/SoapySDR), but this add-on only includes rtl-sdr support to keep the container size manageable. If you need SoapySDR support, you would need to modify the Dockerfile to build and include the SoapySDR library and its drivers.\n\n[View the rtl_433 documentation](https://triq.org/rtl_433)\n\n## How it works\n\nThe only thing this add-on does is run rtl_433 under the Home Assistant OS supervisor. When you first start the add-on, it automatically creates a default configuration file in the addon's config directory that's pre-configured to connect to Home Assistant's MQTT broker.\n\nYou can customize the configuration by editing the template files in the addon config directory or by creating additional `.conf.template` files for multiple radios.\n\nOnce you get the rtl_433 sensor data into MQTT, you'll need to help Home Assistant discover and make sense of it. You can do that in a number of ways:\n\n  * manually configure `sensors` and `binary_sensors` in HA and [link them to the appropriate MQTT topics](https://www.home-assistant.io/integrations/sensor.mqtt/) coming out of rtl_433,\n  * run the [rtl_433_mqtt_hass.py](https://github.com/merbanan/rtl_433/tree/master/examples/rtl_433_mqtt_hass.py) script manually or on a schedule to do most of the configuration automatically, or\n  * install the [rtl_433 MQTT Auto Discovery Home Assistant Add-on](https://github.com/pbkhrv/rtl_433-hass-addons/tree/main/rtl_433_mqtt_autodiscovery), which runs rtl_433_mqtt_hass.py for you.\n\n## Prerequisites\n\n To use this add-on, you need the following:\n\n 1. [An SDR dongle supported by rtl_433](https://triq.org/rtl_433/HARDWARE.html).\n\n 2. Home Assistant OS running on a machine with the SDR dongle plugged into it.\n\n 3. Some wireless sensors supported by rtl_433. The full list of supported protocols and devices can be found under \"Supported device protocols\" section of the [rtl_433's README](https://github.com/merbanan/rtl_433/blob/master/README.md).\n\n## Installation\n\n 1. Install the add-on.\n\n 2. Plug your SDR dongle to the machine running the add-on.\n\n 3. Start the add-on. A default configuration will be created in the addon's config directory that's pre-configured to connect to Home Assistant's MQTT broker.\n\n 4. Check the logs to see if rtl_433 is detecting your wireless sensors.\n\n 5. Customize the configuration by editing `rtl_433.conf.template` to specify frequency bands, protocols, and other settings for your specific hardware and sensors. You can view the [default template](rtl_433.conf.template) for reference, or create additional `.conf.template` files for multiple radios.\n\n## Accessing Configuration Files\n\nThe addon stores configuration files in `/addon_configs/2b3c960e_rtl433/` on your Home Assistant host. To access and edit these files:\n\n1. Install the File Editor addon from the Home Assistant addon store (found under Official add-ons)\n2. Go to the File Editor addon configuration\n3. Turn off \"Enforce Basepath\" to allow navigation outside the `/homeassistant` directory\n4. Navigate to `/addon_configs/2b3c960e_rtl433/` to find your configuration files\n\nAlternatively, you can access these files directly if you have SSH access to your Home Assistant host.\n\n## Configuration\n\nFor a \"zero configuration\" setup, install the [Mosquitto broker](https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md) addon. While other brokers may work, they are not tested and will require manual setup. Once the addon is installed, start or restart the rtl_433 and rtl_433_mqtt_autodiscovery addons to start capturing known 433 MHz protocols.\n\nFor more advanced configuration, take a look at the example config file included in the rtl_433 source code: [rtl_433.example.conf](https://github.com/merbanan/rtl_433/blob/master/conf/rtl_433.example.conf)\n\nNote that the configuration template files support variable substitution for MQTT connection details (`${host}`, `${port}`, `${username}`, `${password}`, `${retain}`). If you need to use literal dollar signs for other purposes, **escape them with backslashes**. For example, to use the literal string `$GPRMC` in the configuration file, use `\\$GPRMC`.\n\nThe `retain` option controls if MQTT's `retain` flag is enabled or disabled by default. It can be overridden on a per-radio basis by setting `retain` to `true` or `false` in the `output` setting.\n\nWhen configuring manually, assuming that you intend to get the rtl_433 data into Home Assistant, the absolute minimum that you need to specify in the config file is the [MQTT connection and authentication information](https://triq.org/rtl_433/OPERATION.html#mqtt-output):\n\n```\noutput      mqtt://HOST:PORT,user=XXXX,pass=YYYYYYY\n```\n\nrtl_433 defaults to listening on 433.92MHz, but even if that's what you need, it's probably a good idea to specify the frequency explicitly to avoid confusion:\n\n```\nfrequency   433.92M\n```\n\nYou might also want to narrow down the list of protocols that rtl_433 should try to decode. The full list can be found under \"Supported device protocols\" section of the [README](https://github.com/merbanan/rtl_433/blob/master/README.md). Let's say you want to listen to Acurite 592TXR temperature/humidity sensors:\n\n```\nprotocol    40\n```\n\nLast but not least, if you decide to use the MQTT auto discovery script or add-on, its documentation recommends converting units in all of the data coming out of rtl_433 into SI:\n\n```\nconvert     si\n```\n\nAssuming you have only one USB dongle attached and rtl_433 is able to automatically find it, we arrive at a minimal rtl_433 config file that looks like this:\n\n```\noutput      mqtt://HOST:PORT,user=XXXX,pass=YYYYYYY\n\nfrequency   433.92M\nprotocol    40\n\nconvert     si\n```\n\nPlease check [the official rtl_433 documentation](https://triq.org/rtl_433) and [config file examples](https://github.com/merbanan/rtl_433/tree/master/conf) for more information.\n\n## Credit\n\nThis add-on is based on [pbkhrv's rtl_433-hass-addons](https://github.com/pbkhrv/rtl_433-hass-addons) repository. For automatic MQTT discovery of rtl_433 devices in Home Assistant, see pbkhrv's excellent [rtl_433_mqtt_autodiscovery add-on](https://github.com/pbkhrv/rtl_433-hass-addons/tree/main/rtl_433_mqtt_autodiscovery).\n\nThe original lineage traces back to James Fry's [rtl4332mqtt Hass.IO Add-on](https://github.com/james-fry/hassio-addons/tree/master/rtl4332mqtt), which is in turn based on Chris Kacerguis' project here: [https://github.com/chriskacerguis/honeywell2mqtt](https://github.com/chriskacerguis/honeywell2mqtt), which is in turn based on Marco Verleun's rtl2mqtt image here: [https://github.com/roflmao/rtl2mqtt](https://github.com/roflmao/rtl2mqtt).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuartparmenter%2Frtl433-addon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstuartparmenter%2Frtl433-addon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuartparmenter%2Frtl433-addon/lists"}