Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md: fixed typo uumodbus -> umodbus #89

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

README.md: fixed typo uumodbus -> umodbus #89

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b635720
README.md: fixed typo uumodbus -> umodbus
vermaete Mar 31, 2024
da4aad5
README.md: fixed links of MarkDown files moved to docs directory
vermaete Mar 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ This is a quickstart to install the `micropython-modbus` library on a
MicroPython board.

A more detailed guide of the development environment can be found in
[SETUP](SETUP.md), further details about the usage can be found in
[USAGE](USAGE.md), descriptions for testing can be found in
[TESTING](TESTING.md) and several examples in [EXAMPLES](EXAMPLES.md)
[SETUP](docs/SETUP.md), further details about the usage can be found in
[USAGE](docs/USAGE.md), descriptions for testing can be found in
[TESTING](docs/TESTING.md) and several examples in [EXAMPLES](docs/EXAMPLES.md)

```bash
python3 -m venv .venv
Expand Down Expand Up @@ -100,12 +100,12 @@ After a successful installation of the package and reboot of the system as
described in the [installation section](#install-package-on-board-with-pip)
the following commands can be used to request a coil state of a target/client
device. Further usage examples can be found in the
[examples folder][ref-examples-folder] and in the [USAGE chapter](USAGE.md)
[examples folder][ref-examples-folder] and in the [USAGE chapter](docs/USAGE.md)

#### TCP

```python
from ummodbus.tcp import ModbusTCPMaster
from umodbus.tcp import ModbusTCPMaster

tcp_device = ModbusTCPMaster(
slave_ip='172.24.0.2', # IP address of the target/client/slave device
Expand Down Expand Up @@ -177,11 +177,11 @@ upip.install('micropython-brainelectronics-helpers')

Check also the README of the
[brainelectronics MicroPython modules][ref-github-be-mircopython-modules], the
[INSTALLATION](INSTALLATION.md) and the [SETUP](SETUP.md) guides.
[INSTALLATION](docs/INSTALLATION.md) and the [SETUP](docs/SETUP.md) guides.

## Usage

See [USAGE](USAGE.md) and [DOCUMENTATION](DOCUMENTATION.md)
See [USAGE](docs/USAGE.md) and [DOCUMENTATION](docs/DOCUMENTATION.md)

## Supported Modbus functions

Expand Down