Add asyncio support

.github/workflows/test.yml

@@ -40,10 +40,24 @@ jobs:
       - name: Lint with yamllint
         run: |
           yamllint .
-      - name: Install deploy dependencies
+      - name: Validate package version file
+        # the package version file has to be always up to date as mip is using
+        # the file directly from the repo. On a PyPi package the version file
+        # is updated and then packed
         run: |
-          python -m pip install --upgrade pip
-          if [ -f requirements-deploy.txt ]; then pip install -r requirements-deploy.txt; fi
+          changelog2version \
+            --changelog_file changelog.md \
+            --version_file umodbus/version.py \
+            --version_file_type py \
+            --validate \
+            --debug
+      - name: Validate mip package file
+        run: |
+          upy-package \
+            --setup_file setup.py \
+            --package_changelog_file changelog.md \
+            --package_file package.json \
+            --validate
       - name: Execute tests
         run: |
           docker build --tag micropython-test --file Dockerfile.tests .
@@ -59,13 +73,12 @@ jobs:
       - name: Run Client/Host RTU test
         run: |
           docker compose -f docker-compose-rtu-test.yaml up --build --exit-code-from micropython-host
+      - name: Install deploy dependencies
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements-deploy.txt ]; then pip install -r requirements-deploy.txt; fi
       - name: Build package
         run: |
-          changelog2version \
-            --changelog_file changelog.md \
-            --version_file umodbus/version.py \
-            --version_file_type py \
-            --debug
           python setup.py sdist
           rm dist/*.orig
       - name: Test built package

.gitmodules

@@ -3,4 +3,4 @@
 	# changed to https due to RTD build issue
 	# see https://github.com/readthedocs/readthedocs.org/issues/4043
 	# url = [email protected]:brainelectronics/python-modules.git
-	url = https://github.com/brainelectronics/python-modules.git
+	url = https://github.com/brainelectronics/python-modules.git

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+---
+
+# To install pre-commit hooks, install `pre-commit` and activate it here:
+#     pip3 install pre-commit
+#     pre-commit install
+#
+default_stages:
+  - commit
+  - push
+  - manual
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+  - repo: https://github.com/brainelectronics/micropython-package-validation
+    rev: 0.5.0
+    hooks:
+      - id: upy-package
+        args:
+          - "--setup_file=setup.py"
+          - "--package_changelog_file=changelog.md"
+          - "--package_file=package.json"
+          - "--validate"
+  - repo: https://github.com/brainelectronics/changelog2version
+    rev: 0.10.0
+    hooks:
+      - id: changelog2version
+        args:
+          - "--changelog_file=changelog.md"
+          - "--version_file=umodbus/version.py"
+          - "--validate"

Dockerfile.client_rtu

@@ -10,6 +10,4 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 
-RUN micropython-dev -m upip install micropython-ulogging
-
 CMD [ "micropython-dev", "-m", "examples/rtu_client_example.py" ]

Dockerfile.client_tcp

@@ -10,6 +10,4 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 
-RUN micropython-dev -m upip install micropython-ulogging
-
 CMD [ "micropython-dev", "-m", "examples/tcp_client_example.py" ]

Dockerfile.host_rtu

@@ -10,6 +10,4 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 
-RUN micropython-dev -m upip install micropython-ulogging
-
 CMD [ "micropython-dev", "-m", "examples/rtu_host_example.py" ]

Dockerfile.host_tcp

@@ -10,6 +10,4 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 
-RUN micropython-dev -m upip install micropython-ulogging
-
 CMD [ "micropython-dev", "-m", "examples/tcp_host_example.py" ]

Dockerfile.test_examples

@@ -11,5 +11,3 @@ FROM micropython/unix:v1.18
 # COPY ./ /home
 # COPY umodbus /root/.micropython/lib/umodbus
 # COPY mpy_unittest.py /root/.micropython/lib/mpy_unittest.py
-
-RUN micropython-dev -m upip install micropython-ulogging

Dockerfile.tests

@@ -12,8 +12,8 @@ COPY ./ /home
 COPY registers/example.json /home/tests/test-registers.json
 COPY umodbus /root/.micropython/lib/umodbus
 COPY mpy_unittest.py /root/.micropython/lib/mpy_unittest.py
+COPY tests/ulogging.py /root/.micropython/lib/ulogging.py
 
-RUN micropython-dev -m upip install micropython-ulogging
 RUN micropython-dev -c "import mpy_unittest as unittest; unittest.main('tests')"
 
 ENTRYPOINT ["/bin/bash"]

Dockerfile.tests_manually

@@ -12,7 +12,6 @@ COPY ./ /home
 COPY registers/example.json /home/tests/test-registers.json
 COPY umodbus /root/.micropython/lib/umodbus
 COPY mpy_unittest.py /root/.micropython/lib/mpy_unittest.py
-
-RUN micropython-dev -m upip install micropython-ulogging
+COPY tests/ulogging.py /root/.micropython/lib/ulogging.py
 
 ENTRYPOINT ["/bin/bash"]

changelog.md

@@ -15,6 +15,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <!-- ## [Unreleased] -->
 
 ## Released
+## [3.0.0] - 2024-07-01
+### Added
+- Add support for async TCP and RTU client and server, see #5
+- Add `CommonRTUFunctions` class to [serial.py](umodbus/serial.py) as an abstract class for use by the RTU client and server
+- Add `Async` versions of existing synchronous classes (e.g. `AsyncModbusRTU`, `AsyncTCP`, etc.)
+
+### Changed
+- `ists`, `iregs`, `coils` and `hregs` use the type `KeysView` instead of `dict_keys`
+- `Serial` class cleaned up, now mainly for requesting data from Modbus RTU masters (e.g. from `ModbusRTU`)
+- Refactor examples, now examples need the `common` directory contents to be present as well to run
+
+## [2.3.7] - 2023-07-19
+### Fixed
+- Add a single character wait time after flush to avoid timing issues with RTU control pin, see #68 and #72
+
+## [2.3.6] - 2023-07-19
+### Added
+- Add contribution guideline, see #67
+- Content of `package.json` is validated on each test workflow run
+- Precommit hooks for `package.json` and package version file validation, yaml style, flake8 and trailing whitespace checks, contributes to #67
+
+### Changed
+- `umodbus/version.py` file is validated against the latest changelog entry before running all tests and testing the package creation
+- `ulogging` placed into `tests` folder instead of installing it with deprecated `upip` in all Docker containers
+
+### Fixed
+- Added missing empty line in several files
+
+## [2.3.5] - 2023-07-01
+### Fixed
+- Time between RS485 control pin raise and UART transmission reduced by 80% from 1000us to 200us
+- The RS485 control pin is lowered as fast as possible by using `time.sleep_us()` instead of `machine.idle()` which uses an IRQ on the order of milliseconds. This kept the control pin active longer than necessary, causing the response message to be missed at higher baud rates. This applies only to MicroPython firmwares below v1.20.0
+- The following fixes were provided by @wpyoga
+- RS485 control pin handling fixed by using UART `flush` function, see #68
+- Invalid CRC while reading multiple coils and fixed, see #50 and #52
+
 ## [2.3.4] - 2023-03-20
 ### Added
 - `package.json` for `mip` installation with MicroPython v1.19.1 or newer
@@ -282,8 +318,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - PEP8 style issues on all files of [`lib/uModbus`](lib/uModbus)
 
 <!-- Links -->
-[Unreleased]: https://github.com/brainelectronics/micropython-modbus/compare/2.3.4...develop
+[Unreleased]: https://github.com/brainelectronics/micropython-modbus/compare/2.3.7...develop
 
+[2.3.7]: https://github.com/brainelectronics/micropython-modbus/tree/2.3.7
+[2.3.6]: https://github.com/brainelectronics/micropython-modbus/tree/2.3.6
+[2.3.5]: https://github.com/brainelectronics/micropython-modbus/tree/2.3.5
 [2.3.4]: https://github.com/brainelectronics/micropython-modbus/tree/2.3.4
 [2.3.3]: https://github.com/brainelectronics/micropython-modbus/tree/2.3.3
 [2.3.2]: https://github.com/brainelectronics/micropython-modbus/tree/2.3.2

docker-compose-rtu-test.yaml

@@ -20,6 +20,7 @@ services:
       - ./registers:/home/registers
       - ./umodbus:/root/.micropython/lib/umodbus
       - ./fakes:/usr/lib/micropython
+      - ./tests/ulogging.py:/root/.micropython/lib/ulogging.py
     expose:
       - "65433"
     ports:
@@ -41,6 +42,7 @@ services:
       - ./umodbus:/root/.micropython/lib/umodbus
       - ./fakes:/usr/lib/micropython
       - ./mpy_unittest.py:/root/.micropython/lib/mpy_unittest.py
+      - ./tests/ulogging.py:/root/.micropython/lib/ulogging.py
     depends_on:
       - micropython-client
     command:

docker-compose-rtu.yaml

@@ -19,6 +19,7 @@ services:
       - ./:/home
       - ./umodbus:/root/.micropython/lib/umodbus
       - ./fakes:/usr/lib/micropython
+      - ./tests/ulogging.py:/root/.micropython/lib/ulogging.py
     expose:
       - "65433"
     ports:
@@ -39,6 +40,7 @@ services:
       - ./:/home
       - ./umodbus:/root/.micropython/lib/umodbus
       - ./fakes:/usr/lib/micropython
+      - ./tests/ulogging.py:/root/.micropython/lib/ulogging.py
     depends_on:
       - micropython-client
     networks:

docker-compose-tcp-test.yaml

@@ -19,6 +19,7 @@ services:
       - ./:/home
       - ./registers:/home/registers
       - ./umodbus:/root/.micropython/lib/umodbus
+      - ./tests/ulogging.py:/root/.micropython/lib/ulogging.py
     expose:
       - "502"
     ports:
@@ -39,6 +40,7 @@ services:
       - ./:/home
       - ./umodbus:/root/.micropython/lib/umodbus
       - ./mpy_unittest.py:/root/.micropython/lib/mpy_unittest.py
+      - ./tests/ulogging.py:/root/.micropython/lib/ulogging.py
     depends_on:
       - micropython-client
     command: