minimalmodbus

Easy-to-use Modbus RTU and Modbus ASCII implementation for Python.

https://github.com/pyhys/minimalmodbus

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.0%) to scientific vocabulary

Keywords

communication-protocol fieldbus industrial-automation modbus modbus-ascii modbus-library modbus-master modbus-protocol modbus-rtu modbus-serial python
Last synced: 6 months ago · JSON representation ·

Repository

Easy-to-use Modbus RTU and Modbus ASCII implementation for Python.

Basic Info
  • Host: GitHub
  • Owner: pyhys
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 718 KB
Statistics
  • Stars: 337
  • Watchers: 20
  • Forks: 148
  • Open Issues: 22
  • Releases: 0
Topics
communication-protocol fieldbus industrial-automation modbus modbus-ascii modbus-library modbus-master modbus-protocol modbus-rtu modbus-serial python
Created over 10 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Changelog Contributing License Citation Authors

README.rst

===============================
MinimalModbus
===============================

.. image:: https://github.com/pyhys/minimalmodbus/actions/workflows/build.yml/badge.svg
        :target: https://github.com/pyhys/minimalmodbus/actions
        :alt: Build Status

.. image:: https://codecov.io/gh/pyhys/minimalmodbus/branch/master/graph/badge.svg?token=6TcwYCQJHF
        :target: https://codecov.io/gh/pyhys/minimalmodbus
        :alt: Test coverage report

.. image:: https://readthedocs.org/projects/minimalmodbus/badge/?version=master
        :target: https://readthedocs.org/projects/minimalmodbus/?badge=master
        :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/minimalmodbus.svg
        :target: https://pypi.org/project/minimalmodbus/
        :alt: PyPI page link


Easy-to-use Modbus RTU and Modbus ASCII implementation for Python.

Web resources
-------------

* **Documentation**: https://minimalmodbus.readthedocs.io
* Source code on **GitHub**: https://github.com/pyhys/minimalmodbus
* Python package index (PyPI) with download: https://pypi.org/project/minimalmodbus/

Other web pages:

* Readthedocs project page: https://readthedocs.org/projects/minimalmodbus/
* codecov.io project page: https://codecov.io/github/pyhys/minimalmodbus

Obsolete web pages:

* Old Travis CI build status page: https://travis-ci.org/pyhys/minimalmodbus
* Old Sourceforge documentation page: http://minimalmodbus.sourceforge.net/
* Old Sourceforge project page: https://sourceforge.net/projects/minimalmodbus
* Old Sourceforge repository: https://sourceforge.net/p/minimalmodbus/code/HEAD/tree/


Features
--------
MinimalModbus is an easy-to-use Python module for talking to instruments (slaves)
from a computer (master) using the Modbus protocol, and is intended to be running on the master.
The only dependence is the pySerial module (also pure Python).

There are convenience functions to handle floats, strings and long integers
(in different byte orders).

This software supports the 'Modbus RTU' and 'Modbus ASCII' serial communication
versions of the protocol, and is intended for use on Linux, OS X and Windows platforms.
It is open source, and has the Apache License, Version 2.0.

For Python 3.8 and later. Tested with Python 3.8, 3.9, 3.10, 3.11 and 3.12.

This package uses semantic versioning.

Owner

  • Name: Jonas Berg
  • Login: pyhys
  • Kind: user
  • Location: Sweden
  • Company: @rtlabs-com

Citation (CITATION.cff)

# YAML 1.2
---
authors:
  -
    family-names: Berg
    given-names: Jonas
cff-version: "1.1.0"
date-released: 2023-07-17
identifiers:
keywords:
  - Modbus
  - Python
license: "Apache License 2.0"
message: "If you use this software, please cite it using these metadata."
repository-code: "https://github.com/pyhys/minimalmodbus"
title: MinimalModbus
version: "2.1.1"
...

GitHub Events

Total
  • Issues event: 4
  • Watch event: 29
  • Issue comment event: 11
  • Pull request event: 1
  • Fork event: 3
Last Year
  • Issues event: 4
  • Watch event: 29
  • Issue comment event: 11
  • Pull request event: 1
  • Fork event: 3

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 370
  • Total Committers: 5
  • Avg Commits per committer: 74.0
  • Development Distribution Score (DDS): 0.492
Past Year
  • Commits: 16
  • Committers: 1
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jonas Berg p****s 188
Jonas Berg j****g@g****m 144
Jonas Berg p****s@u****t 32
claron c****n@f****4 4
Jonas Berg j****g@h****e 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 104
  • Total pull requests: 32
  • Average time to close issues: 10 months
  • Average time to close pull requests: 7 months
  • Total issue authors: 93
  • Total pull request authors: 15
  • Average comments per issue: 2.9
  • Average comments per pull request: 0.88
  • Merged pull requests: 17
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 3
  • Average time to close issues: 4 days
  • Average time to close pull requests: N/A
  • Issue authors: 3
  • Pull request authors: 2
  • Average comments per issue: 1.75
  • Average comments per pull request: 1.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • patfrench (4)
  • photron (2)
  • CrabbyPete (2)
  • j123b567 (2)
  • bmoneke (2)
  • KennethNielsen (2)
  • tr-gis (2)
  • rdpoor (2)
  • viewpointsa (1)
  • RobinGalipeau (1)
  • marvinosswald (1)
  • billyhuangyr (1)
  • draput (1)
  • amitrana3348 (1)
  • amandeep16 (1)
Pull Request Authors
  • pyhys (17)
  • susnicek (2)
  • TobiasSchaffner (2)
  • penguintamer (2)
  • zyura (1)
  • aulloa (1)
  • edgar-bonet (1)
  • russss (1)
  • HTKB-ZUC (1)
  • martijndegouw (1)
  • mrrs6 (1)
  • j123b567 (1)
  • jefersondeff (1)
  • SengerM (1)
  • wriswith (1)
Top Labels
Issue Labels
enhancement (12) Usage (7) bug (7)
Pull Request Labels
enhancement (9)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 46,446 last-month
  • Total dependent packages: 20
    (may contain duplicates)
  • Total dependent repositories: 88
    (may contain duplicates)
  • Total versions: 16
  • Total maintainers: 1
pypi.org: minimalmodbus

Easy-to-use Modbus RTU and Modbus ASCII implementation for Python

  • Versions: 15
  • Dependent Packages: 19
  • Dependent Repositories: 87
  • Downloads: 46,446 Last month
  • Docker Downloads: 0
Rankings
Dependent packages count: 0.7%
Downloads: 1.5%
Dependent repos count: 1.6%
Average: 2.5%
Docker downloads count: 3.5%
Stargazers count: 3.9%
Forks count: 4.1%
Maintainers (1)
Last synced: 6 months ago
conda-forge.org: minimalmodbus
  • Versions: 1
  • Dependent Packages: 1
  • Dependent Repositories: 1
Rankings
Forks count: 15.6%
Average: 23.3%
Dependent repos count: 24.2%
Stargazers count: 24.4%
Dependent packages count: 29.0%
Last synced: 6 months ago

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v1 composite
docs/requirements.txt pypi
  • pyserial *
  • sphinxcontrib-programoutput *
pyproject.toml pypi
  • pyserial >=3.0