bo
/
modbusmqtt
1
0
Fork 0
Code Releases Activity

Document Docker builds

main
Bo Jeanes 2022-09-18 14:23:45 +10:00
parent e5e7176bc3
commit 58299828b1
2 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -6,9 +6,10 @@ View the appropriate READMEs in each package directory for details about each.
## [`modbus-mqtt`](./modbus-mqtt) ## [`modbus-mqtt`](./modbus-mqtt)
![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg) [![Docker](https://img.shields.io/docker/v/bjeanes/modbus-mqtt?label=docker)](https://hub.docker.com/r/bjeanes/modbus-mqtt)
![docs.rs](https://img.shields.io/docsrs/modbus-mqtt) [![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg)](https://crates.io/crates/modbus-mqtt)
![Crates.io](https://img.shields.io/crates/l/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. 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.

24
modbus-mqtt/README.md
View File

@ -1,8 +1,9 @@
# ModbusMQTT # ModbusMQTT
![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg) [![Docker](https://img.shields.io/docker/v/bjeanes/modbus-mqtt?label=docker)](https://hub.docker.com/r/bjeanes/modbus-mqtt)
![docs.rs](https://img.shields.io/docsrs/modbus-mqtt) [![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg)](https://crates.io/crates/modbus-mqtt)
![Crates.io](https://img.shields.io/crates/l/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)
A bridge between Modbus devices and MQTT. A bridge between Modbus devices and MQTT.
@ -21,11 +22,26 @@ NOTE: For the time being, this does not support MQTTv5.
## Installing ## Installing
### From Source
For now, `cargo install` is the easiest way to install. Either run it in a checkout for the latest development version, or run `cargo install modbus-mqtt` to install the latest release version. For now, `cargo install` is the easiest way to install. Either run it in a checkout for the latest development version, or run `cargo install modbus-mqtt` to install the latest release version.
### Pre-compiled
If you don't want to set up the Rust toolchain, you can likely found built binaries as build artifacts in the [GitHub Actions tab above](https://github.com/bjeanes/modbus-mqtt/actions?query=is%3Asuccess+branch%3Amain+workflow%3ACI). If you don't want to set up the Rust toolchain, you can likely found built binaries as build artifacts in the [GitHub Actions tab above](https://github.com/bjeanes/modbus-mqtt/actions?query=is%3Asuccess+branch%3Amain+workflow%3ACI).
In the future, there will also be Docker images made available for convenience. ### Docker
```sh-session
$ docker run -it --rm bjeanes/modbus-mqtt:edge --help
```
Tags:
* `v#`, `v#.#`, `v#.#.#` - semver releases (`major.minor.patch`)
* `latest` - corresponds to most recently semver-tagged build
* `edge` - latest buildable branch from `main`, likely unstable
* `*-alpine` - alpine versions of above
## Running ## Running