@rfxcom2mqtt/rfxcom2mqtt v1.0.0

RFXCOM2MQTT

RFXCOM to MQTT bridge for RFXtrx433 devices

All received RFXCOM events are published to the MQTT rfxcom2mqtt/devices/\<id> topic. It is up to the MQTT receiver to filter these messages or to have a register/learning/pairing mechanism.

Getting started

The documentation provides you all the information needed to get up and running! Make sure you don't skip sections if this is your first visit, as there might be important details in there for you.

Usage

Home Assistant Integration

The easiest way to integrate Rfxcom2MQTT with Home Assistant is by using MQTT discovery. This allows Rfxcom2MQTT to automatically add devices to Home Assistant.

Configuration

See example config.yml

List of available commands: DeviceCommands

MQTT Topics and Messages

Healthcheck

If healthcheck is enabled in the config, the rfxcom status will checked every minute. In case of an error the node process will exit. If installed in docker the container will try to restart try to reconnect to the RFXCOM device.

Dependencies:

The RFXCOM Node library for the communication with the RFXCOM RFXtrx433 433.92MHz Transceiver.

The MQTT.js library for sending and receiving MQTT messages.

Development

nvm install 18.18
nvm use 18.18
npm install

ts-node src/dev.ts

build docker image

Build a local image

docker-compose build

build multi Arch image

docker buildx build \ 
--platform linux/amd64,linux/arm/v7 \
--push \
-t rfxcom2mqtt/rfxcom2mqtt .