rfxtrx-mqtt 0.0.post1.dev1

A Python package for processing RFXtrx data with MQTT support and automation integration.

RFXtrx-mqtt - Process & Automate RFXtrx Data with MQTT

rfxtrx-mqtt is a Python package that processes and decodes RFXtrx data from a serial device, converting it into JSON. It supports MQTT for seamless integration with home automation platforms like OpenHAB and Home Assistant.

🔧 Features

✅ Decodes RFXtrx data into JSON format
✅ Supports multiple device types (Lighting, Temperature, Humidity, Security, Blinds, etc.)
✅ Command-line interface (rfxtrx CLI)
✅ Flexible callback functions for real-time data processing
✅ Configurable serial device parameters
✅ Built-in MQTT support for automation platforms

---

📦 Installation

Install via PyPI

pip install -r requirements.txt

Install from GitHub (Development Version)

git clone https://github.com/FredrikBlix/rfxtrx-mqtt.git
cd rfxtrx-mqtt
pip install -r requirements.txt

---

🚀 Usage

🔹 Running the rfx-dump Command

rfx-dump --help

✅ Example: Read from /dev/ttyUSB0 (default settings)

rfx-dump

✅ Example: Specify device and baud rate

rfx-dump --device /dev/ttyUSB1 --baudrate 115200

✅ Example: Publish RFXtrx data to MQTT

rfx-mqtt --device /dev/ttyUSB0 --mqtt-host localhost --mqtt-port 1883 --mqtt-topic rfxtrx

✅ Example: Subscribe to MQTT topic

rfx-mqtt-sub --mqtt-host localhost --mqtt-topic rfxtrx/#

✅ Example: Manually publish MQTT message

rfx-mqtt-pub --mqtt-host localhost --mqtt-topic rfxtrx --data '{"device_id": "1a41", "unit_code": 1, "command": "On"}'

---

🏠 Home Automation Integration

Home Assistant

To integrate rfx-mqtt with Home Assistant, configure an MQTT sensor in configuration.yaml:

mqtt:
    sensor:
        - name: "RFXtrx Lighting Sensor"
          state_topic: "rfxtrx/Lighting1"
          value_template: "{{ value_json.command }}"

Restart Home Assistant after adding this configuration.

OpenHAB

To integrate rfx-mqtt with OpenHAB, use the MQTT binding and add the following to mqtt.things:

Thing mqtt:topic:rfxtrx "RFXtrx" {
    Channels:
        Type string : lighting1 "Lighting1 Command" [ stateTopic="rfxtrx/Lighting1" ]
}

Then, define an Item in mqtt.items:

String RFXtrx_Lighting "RFXtrx Light" {channel="mqtt:topic:rfxtrx:lighting1"}

Restart OpenHAB after making these changes.

---

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

🤝 Contributing

We welcome contributions! To get started:

1. Fork the repository on GitHub
2. Clone your forked repo

   git clone https://github.com/YOUR_USERNAME/rfx-mqtt.git
   cd rfx-mqtt
   

3. Create a feature branch

   git checkout -b feature-name
   

4. Make your changes, commit, and push

   git add .
   git commit -m "Added new feature"
   git push origin feature-name
   

5. Submit a pull request! 🎉

---

🚀 Thank you for using rfx-mqtt! If you find this project useful, give it a ⭐ on GitHub!