Code Monkey home page Code Monkey logo

rfxcom2mqtt's Introduction

RFXCOM2MQTT

RFXCOM

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.

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

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

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 sguernion/rfxcom2mqtt .

rfxcom2mqtt's People

Contributors

legobas avatar sguernion avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.