Skip to content

Latest commit

 

History

History
58 lines (47 loc) · 4.36 KB

README.md

File metadata and controls

58 lines (47 loc) · 4.36 KB

Device Modbus Go

Build Status Code Coverage Go Report Card GitHub Latest Dev Tag) GitHub Latest Stable Tag) GitHub License GitHub go.mod Go version GitHub Pull Requests GitHub Contributors GitHub Committers GitHub Commit Activity

Warning
The main branch of this repository contains work-in-progress development code for the upcoming release, and is not guaranteed to be stable or working. It is only compatible with the main branch of edgex-compose which uses the Docker images built from the main branch of this repo and other repos.

The source for the latest release can be found at Releases.

Overview

Modbus Micro Service - device service for connecting Modbus devices to EdgeX.

Build with NATS Messaging

Currently, the NATS Messaging capability (NATS MessageBus) is opt-in at build time. This means that the published Docker images do not include the NATS messaging capability.

The following make commands will build the local binary or local Docker image with NATS messaging capability included.

make build-nats
make docker-nats

The locally built Docker image can then be used in place of the published Docker image in your compose file. See Compose Builder nat-bus option to generate compose file for NATS and local dev images.

Usage

Users can refer to the document to learn how to use this device service.

Example Profile and Device

The ProfilesDir and DevicesDir in the configuration.yaml are empty string by default. To use the example Profile and Device in this repository, please fill './res/profiles' and './res/devices' to ProfilesDir and DevicesDir respectively. modbus.test.device.profile.yml and modbus.test.devices.yaml will be loaded and created when the Device Service starts up. Users can modify those files or add additional Profile YAML to meet their needs.

Modbus Simulator

Build and run the Modbus simulator

$ cd simulator
$ go build
$ ./simulator 
Modbus TCP address: 0.0.0.0:1502 
Start up a Modbus TCP simulator.

Packaging

For docker, please refer to the Dockerfile and Docker Compose Builder scripts.

Modbus RTU Usage

Users can refer to the document to set up the Modbus RTU device.

Community

License

Apache-2.0