Skip to content

Latest commit

 

History

History
214 lines (135 loc) · 6.37 KB

CHANGELOG.md

File metadata and controls

214 lines (135 loc) · 6.37 KB
Raw

Changelog

[v3.0.6] - 2024-12-11

Changed

  • Optimise modbus exception handling GH PR #79

Fixed

  • PySolarmanV5Async reconnect timeout GH PR #78

[v3.0.5] - 2024-12-04

Added

  • UDP Unicast Scanner by @githubDante. GH PR #73

Changed

  • Update tests to cater for more exceptions
  • Expose umodbus exceptions where available in V5FrameError exceptions

Fixed

  • PySolarmanV5Async connection timeout issue. GH PR #77

[v3.0.4] - 2024-08-22

Changed

  • lower async reconnect exception log level to debug - Thanks @davidrapan
  • Various code cleanups (black, lint)
  • Added build and twine to requirements-dev

Fixed

  • Add v3.0.3 release date to CHANGELOG.md (released version dated as UNRELEASED)

[v3.0.3] - 2024-08-01

Added

  • Workaround for inverter/data loggers with double CRC bug - Thanks to @githubDante and @davidrapan for help in getting to the bottom of this issue. This should enable support for devices that were previously supported by the old native parser in StephanJoubert/home_assistant_solarman HA integration (DEYE + possibly others?). See GH issue #62 for more info.
  • Standalone solarman V5 frame decoder added by @githubDante. See GH PR #63 for more info.
  • Various error handling and disconnection fixes added by @davidrapan. See GH PR #61 for more info.
  • Added @githubDante as a project collaborator (push/write permissions on Github)

Fixed

  • Apply proper light/dark theming to the packetdiag diagrams on Solarman V5 protocol docs (no more universal grey!)

[v3.0.2] - 2024-04-27

Added

  • Enhanced V5 frame validation - Thanks to @githubDante and @Dummy0815 for the PR This should resolve the issues with Deye microinverters and external AC relays. See GH PR #46 and GH PR #47 for more info.
  • Enhanced socket error handling - Thanks to @sofkaski for the PR. See GH PR #52 for more info.

Fixed

  • Assorted linter fixes. Thanks to @sofkaski for taking the time to resolve these. See GH PR #54 for more info.

[v3.0.1] - 2023-10-04

Fixed

  • Handle connection resets in sync library (already handled by async library). Thanks to @jlopez77 and @githubDante. See GH issue #44

[v3.0.0] - 2023-05-21

Fixed

  • MAJOR VERSION BUMP - v3.0.0

    v2.5.0 inadvertently introduced a breaking change and has been withdrawn.

    The breakage was introduced by GH PR #33 which moves the PySolarmanV5 socket communications to a worker thread. While this is a major improvement over the previous method, it requires that the disconnect() method is called to close the socket.

    Prior to this, the socket was implicitly closed when the PySolarmanV5 object was deferenced. Many dependent applications re-instantiate a new object for each poll. These applications will need to either remain on v2.4.0, or upgrade to v3.0.0 and ensure disconnect() is called to close the connection cleanly.

    Many thanks to @connesha for highlighting this breaking change in GH issue #39

  • Restore Windows compatibility which was broken in v2.5.0 GH PR#38

[v2.5.0] - 2023-05-10 [WITHDRAWN]

Added

  • async support (PySolarmanV5Aync) added by @githubDante in GH PR#28
  • Introduce sequence number on outgoing V5 request frames Enhance V5 frame validation to compare received checksum to expected value Many thanks to Michael Zanetti (@mzanetti) for highlighting this.
  • Added mock SolarmanV5 Server tests (thanks @githubDante)

Changed

  • Improved PySolarmanV5 socket/connection reliability (again, thanks @githubDante)
  • Migrate from setup.py to pyproject.toml
  • Revamp Makefile and add venv support

[v2.4.0] - 2022-07-19

Added

  • Add Sphinx/ReadTheDocs documentation
  • Add link to user-contributed list of supported data loggers/devices See GH issue #11
  • Add solarman_scan utility
  • Add error_correction mode
  • Implement Modbus Function Codes 15 and 22: write_multiple_coils() masked_write_holding_register()
  • Add optional Socket parameter

Changed

  • Tidy up pysolarmanv5 namespace; Move PySolarmanV5 class from pysolarmanv5.pysolarmanv5 to pysolarmanv5
  • Changed constructor parameters from int to bool where appropriate; Maintains backwards compatibility
  • Properly implement Logging. Old verbose parameter marked as deprecated

Fixed

  • Fix LICENSE typo in setup.py
  • Remove erroneous kwargs from write_holding_register()

[v2.3.0] - 2022-02-02

Changed

  • Improve V5 Frame documentation

Fixed

  • Removed erroneous shebang on pysolarmanv5.py
  • Fix traceback with write_holding_register() (See GH issue #2)

[v2.2.0] - 2022-01-15

Added

  • Added dependencies on Python 3.8 and uModbus
  • Implement Modbus Function Codes 01, 02 and 05

Changed

  • Remove binascii methods

Fixed

  • V5 Frame validation added in v2.1.0 corrected

[v2.1.0] - 2022-01-04

Changed

  • Add more robust validation for V5 frame replies

[v2.0.1] - 2021-12-29

Added

  • Add write_multiple_holding_registers() - function code 16

Changed

  • Minor typo fixes

[v2.0.0] - 2021-11-25

Added

  • Updated examples

Changed

  • Changed the return type of read_input_registers() and read_holding_registers() from an int to a list of ints.
  • The previous functionality is now provided by read_input_register_formatted() and read_holding_register_formatted()

Fixed

  • Bitshift and bitmask parameters now work correctly

[v1.0.0] - 2021-11-25

Added

  • Initial commit