modbusmqtt/README.md

# ModbusMQTT

This repository is a workspace for developing ModbusMQTT and the crates developed in the course of the project.

View the appropriate READMEs in each package directory for details about each.

## [`modbus-mqtt`](./modbus-mqtt)

[![Docker](https://img.shields.io/docker/v/bjeanes/modbus-mqtt?label=docker)](https://hub.docker.com/r/bjeanes/modbus-mqtt)
[![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg)](https://crates.io/crates/modbus-mqtt)
[![docs.rs](https://img.shields.io/docsrs/modbus-mqtt)](https://docs.rs/modbus-mqtt/latest/modbus_mqtt/)
![license](https://img.shields.io/crates/l/modbus-mqtt)

ModbusMQTT is a bridge between Modbus devices and MQTT. It aims to allow the operator to generically expose any compatible Modbus device as though its API were MQTT.

## [`sungrow-winets`](./sungrow-winets)

![Crates.io](https://img.shields.io/crates/v/sungrow-winets.svg)
![docs.rs](https://img.shields.io/docsrs/sungrow-winets.svg)
![Crates.io](https://img.shields.io/crates/l/sungrow-winets)

This is a barebones API client for reading and writing settings for Sungrow solar and hybrid inverters equipped with a WiNet-S communications module. Its only known use is `tokio_modbus-winets` (see below).

## [`tokio_modbus-winets`](./tokio_modbus-winets)

![Crates.io](https://img.shields.io/crates/v/tokio_modbus-winets.svg)
![docs.rs](https://img.shields.io/docsrs/tokio_modbus-winets)
![Crates.io](https://img.shields.io/crates/l/tokio_modbus-winets)

This wraps `sungrow-winets` client in the appropriate traits from [`tokio-modbus`](https://crates.io/crates/tokio-modbus) to allow accessing the Modbus registers which the Sungrow WiNet-S dongle exposes. The reason for this is simply that Sungrow's TCP Modbus support is buggy and inconsistent (though improving).
Rough connectivity and idea 2022-07-17 10:41:56 +10:00			`# ModbusMQTT`

Expand READMEs 2022-09-09 17:36:39 +10:00			`This repository is a workspace for developing ModbusMQTT and the crates developed in the course of the project.`
Rough connectivity and idea 2022-07-17 10:41:56 +10:00
Expand READMEs 2022-09-09 17:36:39 +10:00			`View the appropriate READMEs in each package directory for details about each.`
Rough connectivity and idea 2022-07-17 10:41:56 +10:00
Link to package folders 2022-09-11 18:37:57 +10:00			## [`modbus-mqtt`](./modbus-mqtt)
Rough connectivity and idea 2022-07-17 10:41:56 +10:00
Document Docker builds 2022-09-18 14:23:45 +10:00			`[![Docker](https://img.shields.io/docker/v/bjeanes/modbus-mqtt?label=docker)](https://hub.docker.com/r/bjeanes/modbus-mqtt)`
			`[![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg)](https://crates.io/crates/modbus-mqtt)`
			`[![docs.rs](https://img.shields.io/docsrs/modbus-mqtt)](https://docs.rs/modbus-mqtt/latest/modbus_mqtt/)`
			`![license](https://img.shields.io/crates/l/modbus-mqtt)`
Rough connectivity and idea 2022-07-17 10:41:56 +10:00
Expand READMEs 2022-09-09 17:36:39 +10:00			`ModbusMQTT is a bridge between Modbus devices and MQTT. It aims to allow the operator to generically expose any compatible Modbus device as though its API were MQTT.`
Rough connectivity and idea 2022-07-17 10:41:56 +10:00
Link to package folders 2022-09-11 18:37:57 +10:00			## [`sungrow-winets`](./sungrow-winets)
Rough connectivity and idea 2022-07-17 10:41:56 +10:00
Expand READMEs 2022-09-09 17:36:39 +10:00			`![Crates.io](https://img.shields.io/crates/v/sungrow-winets.svg)`
			`![docs.rs](https://img.shields.io/docsrs/sungrow-winets.svg)`
			`![Crates.io](https://img.shields.io/crates/l/sungrow-winets)`
Rewrite & refactor (#4) 2022-09-09 17:01:19 +10:00
Expand READMEs 2022-09-09 17:36:39 +10:00			This is a barebones API client for reading and writing settings for Sungrow solar and hybrid inverters equipped with a WiNet-S communications module. Its only known use is `tokio_modbus-winets` (see below).
Rewrite & refactor (#4) 2022-09-09 17:01:19 +10:00
Link to package folders 2022-09-11 18:37:57 +10:00			## [`tokio_modbus-winets`](./tokio_modbus-winets)
Rewrite & refactor (#4) 2022-09-09 17:01:19 +10:00
Expand READMEs 2022-09-09 17:36:39 +10:00			`![Crates.io](https://img.shields.io/crates/v/tokio_modbus-winets.svg)`
			`![docs.rs](https://img.shields.io/docsrs/tokio_modbus-winets)`
			`![Crates.io](https://img.shields.io/crates/l/tokio_modbus-winets)`
Rewrite & refactor (#4) 2022-09-09 17:01:19 +10:00
Link to package folders 2022-09-11 18:37:57 +10:00			This wraps `sungrow-winets` client in the appropriate traits from [`tokio-modbus`](https://crates.io/crates/tokio-modbus) to allow accessing the Modbus registers which the Sungrow WiNet-S dongle exposes. The reason for this is simply that Sungrow's TCP Modbus support is buggy and inconsistent (though improving).