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

mbsim

A Modbus Simulator

This is the command line to to control mbsim. There is a addon system for mbsim.

Installation

To install mbsim you can install from gitlab package registry

or

use pip pip install mbsim

Usages

mbsim [-h] [-l {DEBUG,INFO,ERROR,WARNING,CRITICAL}] {sim,ui} ...

mbsim ui {ui1,ui2,...} # a ui addon need to be installed for this command

mbsim sim [-h] {tcp,udp,rtu} ...

mbsim sim tcp [-h] [-a SIM_ADDRESS] [-p SIM_PORT]

mbsim sim udp [-h] [-a SIM_ADDRESS] [-p SIM_PORT]

mbsim sim rtu [-h] [-b SIM_BUAD] [--bytesize SIM_BYTE]
  [-s SIM_STOPBITS] [-p {N,O,E}] [-t SIM_TIMEOUT]
  [-x {0,1}] [-r {0,1}]
  [path]

Addons

mbsim looks for the following entry points under the group mbsim_command and mbsim_ui.

Under mbsim_ui will call the function to start the ui

Under mbsim_command will call the function and pass parser from argparse and expect a function to be returned that is expecting a Namespace from argparse

For examples see sim and ui

Note

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