Welcome to MinimalModbus’ documentation!

Documentation built using Sphinx Jul 17, 2023 for MinimalModbus version 2.1.1.

Contents:

• MinimalModbus
  • Web resources
  • Features
• Installation
  • Dependencies
  • Alternate installation on Linux
  • If everything else fails
• Usage
  • General on Modbus protocol
  • Typical hardware
  • Typical usage
  • Default values
  • Confusing Modbus register addresses
  • Using multiple instruments
  • Closing serial port after each call
  • Handling communication errors
  • Byte order for floating point values and long integers
  • Subclassing
  • Extending
• API for MinimalModbus
• Modbus details
  • Modbus data types
  • Some extensions not covered by the official standard
  • Implemented functions
  • Byte order for data stored in serveral registers
  • Modbus implementation details
  • Reading individual bits from a 16-bit register
  • Known deviations from the standard
  • MODBUS ASCII format
  • Manual testing of Modbus equipment
• Serial communication
  • Timing of the serial communications
  • RS-485 introduction
  • Controlling the RS485 transmitter
  • Controlling the RS-485 transceiver from userspace
• Debug mode
  • Debug mode
• Trouble shooting
  • No communication
  • Local echo
  • Empty bytes added in the beginning or the end on the received message
  • Serial adaptors not recognized
  • Known issues
  • Issues when running under Windows
  • Support
• Detailed usage documentation
  • Interactive usage
  • Making drivers for specific instruments
  • Using this module as part of a measurement system
  • Handling extra 0xFE byte after some messages
  • Install or uninstalling a distribution
  • Setting the PYTHONPATH
  • Including MinimalModbus in a Yocto build
• Developer documentation
  • Design considerations
  • General driver structure
  • Number conversion to and from bytes
  • Unit testing
  • Making sure that error messages are informative for the user
  • Recording communication data for unittesting
  • Using the dummy serial port
  • Data encoding in Python2 and Python3
  • Extending MinimalModbus
  • Other useful internal functions
  • Generate documentation
  • Webpage
  • Codecov.io
  • Notes on distribution
  • Preparation for release
  • Useful development tools
  • Git usage
  • Sphinx usage
  • TODO
• Contributing / Report bugs
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
• Credits
  • Development Lead
  • Contributors
• Related software
• History
  • Release 2.1.1 (2023-07-17)
  • Release 2.1.0 (2023-07-17)
  • Release 2.0.1 (2021-08-11)
  • Release 2.0.0 (2021-08-10)
  • Release 1.0.2 (2019-08-11)
  • Release 1.0.1 (2019-08-10)
  • Release 1.0.0 (2019-08-10)
  • Release 0.7 (2015-07-30)
  • Release 0.6 (2014-06-22)
  • Release 0.5 (2014-03-23)
  • Release 0.4 (2012-09-08)
  • Release 0.3.2 (2012-01-25)
  • Release 0.3.1 (2012-01-24)
  • Release 0.3 (2012-01-23)
  • Release 0.2 (2011-08-19)
  • Release 0.1 (2011-06-16)
• Internal documentation
  • Documentation for dummy_serial (which is a serial port mock)
  • Internal documentation for MinimalModbus
  • Internal documentation for unit testing of MinimalModbus
  • Internal documentation for hardware testing of MinimalModbus using DTB4824

Indices and tables

• Index
• Module Index
• Search Page