https://github.com/alexarch21/rfxtrx2mqtt

RFXCOM rfxtrx433 to MQTT bridge driver
https://github.com/alexarch21/rfxtrx2mqtt

mqtt rfxcom rfxtrx433

Last synced: 3 months ago
JSON representation

RFXCOM rfxtrx433 to MQTT bridge driver

• Host: GitHub
• URL: https://github.com/alexarch21/rfxtrx2mqtt
• Owner: alexarch21
• License: mit
• Created: 2023-08-05T22:49:07.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-21T23:13:28.000Z (over 1 year ago)
• Last Synced: 2024-10-08T16:23:10.549Z (4 months ago)
• Topics: mqtt, rfxcom, rfxtrx433
• Language: JavaScript
• Homepage:
• Size: 13.7 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rfxtrx2mqtt

RFXTRX2MQTT is an MQTT bridge driver for the RFXCOM rfxtrx433 RF modem written in NodeJS and using the node-rfxcom library.

## Install

First make sure NodeJS is installed. You can install NodeJS on a Raspberry Pi (or on other Debian-like systems) using the instructions here: https://pimylifeup.com/raspberry-pi-node

Clone this repository and run:

`npm install`

## Configuration

The driver is configured using a file called `configuration.yaml` that must be present in the directory of the driver. An example configuration is provided. Customize it as needed.

## Running

To start the driver go into the install directory and run:

`node ./rfxcom.js`

## Scanning for RF devices

Calling `node ./rfxcom.js --scan` will scan the 433MHz band for devices with a supported protocol and will list the results as they come in. Adding the `--new` flag will only list devices that are not yet defined in your current configuration.yaml.

Calling `node ./rfxcom.js --stream` will show a realtime stream of RF devices as they communicate with the RFXCOM. This will also show command names for remote controls and switches, as well as device RSSI.

## MQTT configuration

This is obviously dependent on the home automation platform you are using. Visit [this thread here](https://community.home-assistant.io/t/new-rfxcom-to-mqtt-driver/602091) at the Home Assistant forums for more information about the format of the MQTT topics. While the information is partially Home Assistant specific, the explanations about MQTT topic structure applies to all platforms.

## Supported devices

TODO. 

Right now a lot of temperature, humidity, rain, wind and integrated weather station sensors (including Oregon Scientific). Also lighting2 protocol switches, remotes and relays (DIO, CHACON, KlikAanKlikUit, HomeEasy, etc) and lighting5 protocol (OTIO, Conrad RSL). More to come.