From b635720c2ded589545294ecd73f25db6fe281e9d Mon Sep 17 00:00:00 2001 From: Jan Vermaete Date: Sun, 31 Mar 2024 19:47:13 +0200 Subject: [PATCH 1/2] README.md: fixed typo uumodbus -> umodbus Signed-off-by: Jan Vermaete --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e03ab8e..0e1cdad 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ device. Further usage examples can be found in the #### 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 From da4aad5e3a173baa9e8f229f85f2a074f02b09e1 Mon Sep 17 00:00:00 2001 From: Jan Vermaete Date: Sun, 31 Mar 2024 20:58:29 +0200 Subject: [PATCH 2/2] README.md: fixed links of MarkDown files moved to docs directory Signed-off-by: Jan Vermaete --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0e1cdad..7e5ec57 100644 --- a/README.md +++ b/README.md @@ -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 @@ -100,7 +100,7 @@ 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 @@ -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