ioBroker.rtl_433

rtl_433 adapter for ioBroker

This adapter allows you to integrate data from the airwaves into ioBroker using an inexpensive RTL-SDR USB stick. These are built around chips originally used to tune in analog TV signals but are now used as software defined radios. 433 MHz is a common frequency as it is open in the US. The software defined radio is capable of tuning in most of the open frequency bands, the parameters of this adapter allow you to configure the frequency you need.

You can use multiple RTL-SDR dongles to monitor multiple frequencies by setting up more than one instance of iobroker.rtl_433. Options are available to use the native index of the device to rtl_433, the USB port, a TCP/IP address and others as supported by the rtl_433 utility.

The reason for the 433 in the name is that the adapter requires the utility rtl_433 to be installed and runnable on the host computer. All the remote sensors that can be integrated with this adapter are read from the utility and displayed in the protocols tab. As is often the case with USB adapters the device might not be ready the first time it tries to start and may compain about LIB_USB or other USB errors, this is not to be generally worried about - it should start with a minute.

This is a work in progress. I do not have a full set of keys that rtl_433 uses to generate its JSON but I have gone through the test cases on the project collecting most of the possible keys. If a data type is not recognized it will simply be imported as string/value. The keys of responses supported can easily be extended by modifying lib/datapoints.js. Setting the logging to debug for the adapter will show the JSON formatted data from the rtl_433 program.

Note: The meta-data includes an alive state. This is only pertinent to devices that radio their data frequently like thermometers and not to be a cause for concern on devices that radio their data infrequently like contact sensors.

Remote sensor

You can read a remote sensor! To do so you would only need to install rtl-sdr on the remote computer with a rtl-sdr dongle. Using a Raspberry Pi as the remote you would do a fresh install, update it, then run

sudo apt-get install rtl-sdr

After it is installed you would connect the rtl-sdr adapter on it then run

rtl_tcp -a `hostname -I | awk '{print $1}'`

Then in the setup pages of the iobroker.rtl_433 adapter put in the device type of TCP/IP and enter the ip:port of the Pi. Note: if you omit the port it will assume port 1234. When the adapter restarts it will connect to the remote sensor to get the data.

Frequency hopping

You can enter multiple frequencies into the frequency input in the options tab separated by a comma or whitespace

344975000 433920000

this will tell the rtl_433 utility to hop between those frequencies. The default hop interval is 600 seconds but that can be changed in the hop frequency input just below the frequency input.

Troubleshooting

Based on the feedback I have improved the admin pages to be much more comprehensive. This should help to alleviate the issues I have seen so far.

• Make sure rtl_433 runs from the command line.
• Make sure it can run from the command line as the iobroker user.
• If you contact me, please include the following:
  • version - the version from the main admin page.
  • rtl_433_cmd - the command line from the main admin page.
  • any pertinent logs

If you are experiencing trouble with a specific device, please let me know the output for that device using 'rtl_433 -F json' so I can figure out what the program is doing when the device transmits.

Changelog

0.1.2

• "include" feature to capture your own then stop the creation of new devices, other coniguration changes

0.1.3

• automatically add missing states to existing device, helps future proof the adapter. Added protocol to INFO, can be used to know what the device is capable of.

1.0.0

• This has been operating successfully for over a half a year on my local installation. I have decided to move it to 1.0 designation with full ioBroker package compliance and registration

1.0.1

• Fixed internationalization of admin page labels as well as a few initializattion problems

1.1.0

• Improved the administration pages to be both more flexable and informative.
• Changed how the adapter instanciates the rtl_433 utility for stability purpose.
• Fixed many errors in the internationalization

1.1.1

• a few teaks for converting the old configuration

1.1.2

• a few more fixes

1.1.3

• Fixed frequency hopping use in the configuration. Fixed a bug that crashed the adapter if an object was not correctly created. Hardened the ioBroker interface to errors with heavy use of try/catch and logging.

1.1.4

• Explicitly added ack=true to the setState commands to eliminate warnings in the logs, fixed bad selector that lost protocols when not on the protocols tab, updated dependencies.

1.1.5

• In previous versions I only recorded values that differed from the previous value. Now you have an option to de-duplicate the values or not. Updated dependencies.

1.1.6

• Fixed the error about "parentChannel" and updated dependencies

License

MIT License

Copyright (c) 2021 Sean Phillips [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2021 Sean Phillips [email protected]