Project generated with PyScaffold https://gitlab.com/nee2c/mbsim-core/badges/master/pipeline.svgDocumentation Status

mbsim-core

Core package for mbsim to deal with some of the boiler plate necessary for prototyping.

This is the module that will allow you to quickly make prototypes and simulate modbus devices and clients.

If you are developing software for production environment, I strongly recommend to use pymodbus directly.

Installation

To install mbsim you can install from gitlab package registry

or

use pip pip install mbsim-core

Usage

We have created a couple of examples to demonstrate making modbus simulators. They can be found here

Main Package

The command line utils can be found in the package mbsim. This package will have utils for modbus server and clients.

Making Changes & Contributing

This project uses pre-commit, please make sure to install it before making any changes:

pip install pre-commit
cd mbsim-core
pre-commit install

It is a good idea to update the hooks to the latest version:

pre-commit autoupdate

Don’t forget to tell your contributors to also install and use pre-commit.

Note

This project has been set up using PyScaffold 4.1.1. For details and usage information on PyScaffold see https://pyscaffold.org/.