modbus2mqtt
v0.17.2
Published
server for modbus2mqtt for REST API of configuration and publishing modbus values to mqtt
Maintainers
Readme
modbus2mqtt
Bridge between Modbus devices and MQTT with automatic Home Assistant discovery.
Overview
modbus2mqtt enables seamless integration of Modbus devices (RTU/TCP) into your smart home system via MQTT. It features a user-friendly web interface, automatic Home Assistant discovery, and community-driven device specifications.
Key Features:
- Web-based configuration UI
- Modbus RTU & TCP support
- MQTT integration with Home Assistant discovery
- Community device specifications
- Real-time monitoring
Quick Start
Installation
Choose your preferred method:
- Home Assistant Add-on
- Docker - Recommended for most users
- Proxmox LXC - Alpine Linux package for Proxmox containers
Usage
After installation, access the web interface at http://localhost:3000 and follow the Getting Started Guide.
Documentation
- Getting Started - First steps and basic configuration
- Contributing - How to contribute to the project
- Installation Guides:
For complete documentation, see the docs/ directory.
Contributing
We welcome contributions! See the Contributing Guide for details on:
- Setting up your development environment (Development Guide)
- Code style and testing requirements
- Submitting pull requests
Quick start for developers:
git clone https://github.com/modbus2mqtt/server.git
cd server
npm install
npm run build.dev
npm testSupport
- Documentation - Comprehensive guides
- GitHub Issues - Bug reports and feature requests
- GitHub Discussions - Community support
License
MIT License - see LICENSE for details.
Built with ❤️ by the modbus2mqtt community
