diff --git a/CHANGELOG.md b/CHANGELOG.md index 2518c7e..134fc8d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,11 @@ Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +## [0.1.3] - 2020-07-28 +- Added [@isramos](https://github.com/isramos) frequency option +- Added note about running `rpi-update` to README +- Color flair for `rtl_433` installer helper + ## [0.1.2] - 2020-03-01 - Improved and rename the `install-rtl_433-app`. Fixed links in README to the script diff --git a/README.md b/README.md index 9c2c1ae..79b421b 100644 --- a/README.md +++ b/README.md @@ -34,25 +34,21 @@ rtl_433 -F json Success looks like the command running and capturing decoded messages from devices chirping. -#### Raspberry Pi firmware update - -Recommend updating your raspberry pi to latest firmware if you have an older RPi -you are using. This can help prevent USB resets forcing you to unplug/replug -the USB rtlsdrl: - -`sudo rpi-update` - ### Install the node -**recommended**: Install the node via the NodeRED palette manager. +**recommended**: +Install the node via the NodeRED palette manager. -**Local clone**: If you want to hack on the code you can clone this repository locally and run the following command in your Node-RED user directory - typically -`~/.node-red` +**Local clone**: +If you want to hack on the code you can clone this repository locally you can clone project +and install it into your local Node-RED user directory, which is typically `~/.node-red`. Example: ``` +cd ~/projects +git clone https://github.com/dayne/node-red-contrib-rtl_433 cd ~/.node-red -npm i node-red-contrib-rtl_433 +npm i ~/projects/node-red-contrib-rtl_433 ``` ### Usage @@ -61,6 +57,37 @@ Install the node and then start writing flows. More examples later once folks co * `config.frequency` can be used to pass a specific frequency for `rtl_433` listen on. + +## Debugging help + +This node is developed/tested on two primary platforms: Ubuntu x86 and Raspbian +on an RPi4. Here are a few notes people have tossed back on making their system +more stable: + +#### Raspberry Pi firmware update + +Recommend updating your raspberry pi to latest firmware if you have an older RPi +you are using. This can help prevent USB resets forcing you to unplug/replug +the USB rtlsdrl: + +`sudo rpi-update` + +#### rtl install failing: `usb_open error -3` + +The rtl installer helper app tries to make bootstrapping the `rtl_433` +dependancy easy on Debian/Ubuntu/Raspbian system. It is by no means perfect. + +``` +usb_open error -3 +Please fix the device permissions, e.g. by installing the udev rules file +rtl-sdr.rules +``` + +A possible fix is to copy https://github.com/keenerd/rtl-sdr/blob/master/rtl-sdr.rules +to /etc/udev/rules.d/rtl-sdr.rules and rebooting the pi. + +More debug discussion on this with @isramos at [issue #4](https://github.com/dayne/node-red-contrib-rtl_433/issues/2) + ### Credits This node is derived from the [`node-red-daemon`](https://github.com/node-red/node-red-nodes/blob/master/utility/daemon/daemon.js) node and focused on the specific command `rtl_433` usage. diff --git a/package.json b/package.json index 6396b06..58ace71 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "node-red-contrib-rtl_433", - "version": "0.1.2", + "version": "0.1.3", "description": "RTL_433 nodeRED node outputs message payloads from the rtl_433 tool.", "main": "rtl_433/rtl_433.js", "scripts": {