2.3.3-rc31.dev59

Fixed

• Add link to RTU documentation examples from RTU examples files and root README, relates to #7
• Add missing ESP32, RP2 and pyboard pin usage for RTU in examples and documentation, relates to #7 and #17
• Add missing issue template file, see #46

2.3.2

Added

• Installation instructions for mip usage on MicroPython 1.19.1 or newer, see #44
• Manual testing Dockerfile
• INSTALLATION, TESTING and EXAMPLES files for simpler docs structure

Changed

• Split SETUP into INSTALLATION
• Split USAGE into TESTING and EXAMPLES
• Use callback to reset register data in RTU client example
• Update docs copyright year to 2023
• Use fakes machine module instead of classic Mock in docs config file

Fixed

• Basic RTU host example in root README uses correct init values, optional parameters are listed after mandatory ones
• Remove outdated warning sections about #35 bug from USAGE

2.3.1

Added

• Unittest to read multiple coils at any location if defined as list, verifies #35
• Unittests to write a single coil or multiple coils at any location if defined as list, verifies fix #15 and #24

Fixed

• All configured register of a client can be accessed and modified individually, see #35
• Resolved overlapping register positions in example JSON file
• Register length of EXAMPLE_IREG in TCP and RTU examples corrected to 1 instead of 2

2.3.1-rc26.dev53

Added

• Unittest to read multiple coils at any location if defined as list, verifies #35
• Unittests to write a single coil or multiple coils at any location if defined as list, verifies fix #15 and #24

Fixed

• All configured register of a client can be accessed and modified individually, see #35
• Resolved overlapping register positions in example JSON file
• Register length of EXAMPLE_IREG in TCP and RTU examples corrected to 1 instead of 2

2.3.0

Added

• Custom callback functions can be registered on client (ModbusRTU or ModbusTCP) side with new parameters on_set_cb and on_get_cb available from modbus.py functions add_coil and add_hreg. Functions add_ist and add_ireg support only on_get_cb, see #31
• Example callback usage shown in TCP client example
• Documentation for callback functions in USAGE

Changed

• Typing hint Callable is now subscriptable

2.3.0-rc25.dev51

Added

• Custom callback functions can be registered on client (ModbusRTU or ModbusTCP) side with new parameters on_set_cb and on_get_cb available from modbus.py functions add_coil and add_hreg. Functions add_ist and add_ireg support only on_get_cb, see #31
• Example callback usage shown in TCP client example
• Documentation for callback functions in USAGE

Changed

• Typing hint Callable is now subscriptable

2.3.0-rc22.dev51

Added

• Custom callback functions can be registered on client (ModbusRTU or ModbusTCP) side with new parameters on_set_cb and on_get_cb available from modbus.py functions add_coil and add_hreg. Functions add_ist and add_ireg support only on_get_cb, see #31
• Example callback usage shown in TCP client example
• Documentation for callback functions in USAGE

Changed

• Typing hint Callable is now subscriptable

2.2.0

Added

• Fake machine module with UART and Pin class to be used on Unix MicroPython container for RTU tests and examples, see #47
• RTU host example script
• RTU docker compose file and RTU docker compose file test based in MicroPython 1.18 image
• RTU client Dockerfile and RTU host Dockerfile based on MicroPython 1.18 image
• Initial RTU examples unittest
• RTU example section for Client and Host in USAGE

Changed

• Outsourced the following common functions of serial.py and tcp.py into CommonModbusFunctions of common.py:

  • read_coils
  • read_discrete_inputs
  • read_holding_registers
  • read_input_registers
  • write_single_coil
  • write_single_register
  • write_multiple_coils
  • write_multiple_registers

• Inherit from CommonModbusFunctions in Serial of serial.py and in TCP of of tcp.py

• Extended RTU client example for Docker usage to load all registers from example JSON file

• Update internal functions parameter name from slave_id to slave_addr of TCP's _create_mbap_hdr and _validate_resp_hdr function to be the same as in Serial

• Update Modbus function documentation from TCP specific to common module in USAGE file

• Renamed docker files:

  • Dockerfile.client -> Dockerfile.client_tcp
  • Dockerfile.host -> Dockerfile.host_tcp
  • Dockerfile.test_tcp_example -> Dockerfile.test_examples

2.2.0-rc21.dev48

Added

• Fake machine module with UART and Pin class to be used on Unix MicroPython container for RTU tests and examples, see #47
• RTU host example script
• RTU docker compose file and RTU docker compose file test based in MicroPython 1.18 image
• RTU client Dockerfile and RTU host Dockerfile based on MicroPython 1.18 image
• Initial RTU examples unittest
• RTU example section for Client and Host in USAGE

Changed

• Outsourced the following common functions of serial.py and tcp.py into CommonModbusFunctions of common.py:

• read_coils

• read_discrete_inputs

• read_holding_registers

• read_input_registers

• write_single_coil

• write_single_register

• write_multiple_coils

• write_multiple_registers

• Inherit from CommonModbusFunctions in Serial of serial.py and in TCP of of tcp.py

• Extended RTU client example for Docker usage to load all registers from example JSON file

• Update internal functions parameter name from slave_id to slave_addr of TCP's _create_mbap_hdr and _validate_resp_hdr function to be the same as in Serial

• Update Modbus function documentation from TCP specific to common module in USAGE file

• Renamed docker files:

• Dockerfile.client -> Dockerfile.client_tcp

• Dockerfile.host -> Dockerfile.host_tcp

• Dockerfile.test_tcp_example -> Dockerfile.test_examples

2.1.3

Fixed

• uart_id can be specified during init of ModbusRTU and Serial class and is no longer hardcoded to 1, but set as 1 by default to ensure backwards compability, see #7 and #43
• RTU Client example and USAGE documentation updated with new uart_id parameter