https://github.com/brainelectronics/be-modbus-wrapper

Custom brainelectronics Modbus helper module
https://github.com/brainelectronics/be-modbus-wrapper

custom helpers helpers-library modbus modbus-library modbus-master modbus-rtu modbus-serial modbus-tcp python python-package python3

Last synced: 6 days ago
JSON representation

Custom brainelectronics Modbus helper module

• Host: GitHub
• URL: https://github.com/brainelectronics/be-modbus-wrapper
• Owner: brainelectronics
• License: mit
• Created: 2022-09-09T10:41:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-01T17:35:24.000Z (over 3 years ago)
• Last Synced: 2025-12-26T07:50:14.263Z (5 months ago)
• Topics: custom, helpers, helpers-library, modbus, modbus-library, modbus-master, modbus-rtu, modbus-serial, modbus-tcp, python, python-package, python3
• Language: Python
• Homepage:
• Size: 52.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# BE Modbus Wrapper

[![Downloads](https://pepy.tech/badge/be-modbus-wrapper)](https://pepy.tech/project/be-modbus-wrapper)

![Release](https://img.shields.io/github/v/release/brainelectronics/be-modbus-wrapper?include_prereleases&color=success)

![Python](https://img.shields.io/badge/python3-Ok-green.svg)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![codecov](https://codecov.io/github/brainelectronics/be-modbus-wrapper/branch/main/graph/badge.svg)](https://app.codecov.io/github/brainelectronics/be-modbus-wrapper)

Custom brainelectronics python modbus wrapper

---------------

## General

Custom brainelectronics specific python modbus wrapper.

- [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

	- [Unittests](#unittests)

- [Credits](#credits)

## Installation

```bash

pip install be-modbus-wrapper

```

## Usage

```python

from be_modbus_wrapper import ModbusWrapper

```

## Contributing

### Unittests

Run the unittests locally with the following command after installing this

package in a virtual environment

```bash

# run all tests

nose2 --config tests/unittest.cfg

# run only one specific tests

nose2 tests.test_modbus_wrapper.TestModbusWrapper.test_load_modbus_registers_file

```

Generate the coverage files with

```bash

python create_report_dirs.py

coverage html

```

The coverage report is placed at `be-modbus-wrapper/reports/coverage/html/index.html`

## Credits

Based on the [PyPa sample project][ref-pypa-sample].

[ref-pypa-sample]: https://github.com/pypa/sampleproject