Skip to content
This repository has been archived by the owner on Jul 4, 2023. It is now read-only.

nuvlaedge/peripheral-manager-modbus

Repository files navigation

ℹ️ This component has moved ➡️

It is now part of 👉 nuvlaedge/nuvlaedge 👈.


NuvlaEdge Peripheral Manager for Modbus devices

NOTE: only compatible with TCP mode

Maintenance GitHub issues Docker pulls Docker image size

CI

This repository contains the source code for the NuvlaEdge Peripheral Manager for Modbus devices - this microservice is responsible for the discovery, categorization and management of all NuvlaEdge Modbus peripherals.

This microservice is an integral component of the NuvlaEdge Engine.


NOTE: this microservice is part of a loosely coupled architecture, thus when deployed by itself, it might not provide all of its functionalities. Please refer to https://github.com/nuvlaedge/deployment for a fully functional deployment


Build the NuvlaEdge Peripheral Manager for Modbus devices

This repository is already linked with Travis CI, so with every commit, a new Docker image is released.

There is a POM file which is responsible for handling the multi-architecture and stage-specific builds.

If you're developing and testing locally in your own machine, simply run docker build . or even deploy the microservice via the local compose files to have your changes built into a new Docker image, and saved into your local filesystem.

If you're developing in a non-master branch, please push your changes to the respective branch, and wait for Travis CI to finish the automated build. You'll find your Docker image in the nuvladev organization in Docker hub, names as nuvladev/peripheral-manager-modbus:<branch>.

Deploy the NuvlaEdge Peripheral Manager for Modbus devices

The NuvlaEdge Peripheral Manager for Modbus will only work if a Nuvla endpoint is provided and a NuvlaEdge has been added in Nuvla.

Why? Because this microservice has been built to report directly to Nuvla. Every Modbus device will be registered in Nuvla and associated with an existing NuvlaEdge.

Prerequisites

  • Docker (version 18 or higher)
  • Docker Compose (version 1.23.2 or higher)
  • Linux

Launching the NuvlaEdge Peripheral Manager for Modbus devices

Simply run docker-compose up --build

If Nuvla is running on localhost

Simply run docker-compose -f docker-compose.localhost.yml up --build

Testing

This microservice is completely automated, meaning that as long as all the proper environment variables have been correctly set and the right dependencies have been met, the respective Docker container will start by itself and automatically start registering peripherals into Nuvla, in real-time.

Contributing

This is an open-source project, so all community contributions are more than welcome. Please read CONTRIBUTING.md

Copyright

Copyright © 2021, SixSq SA