v2.1.0

Release: Persistence, Docs, and Improvements

Summary

This release adds persistent storage for Modbus register state, accompanying tests, configuration, and documentation improvements. It also includes maintenance updates such as logging adjustments, version bumps, and repository-level community and security documents.

Highlights

• Persistence: new register persistence library integrated into the server to save and restore register state across restarts.
• Tests: unit tests covering the persistence behavior.
• Configuration: persistence settings added to src/app/modbus_server.json and example configuration files.
• Docs & Community: added SECURITY.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, and arc42 architecture documentation/diagrams.
• Maintenance: logger tweaks, version increases, and improved .gitignore entries.

What's New

• New library: src/app/lib/register_persistence/__init__.py — handles efficient storage and restore of register state.
• Graceful save: src/app/modbus_server.py now triggers a persistence save on graceful shutdown to avoid state loss.
• New tests: tests/test_register_persistence.py validates persistence logic and edge cases.
• Example updates: examples/test.json, examples/abb_coretec_example.json, and examples/udp.json updated to reflect new config and removed deprecated fields.

Upgrade & Migration Notes

• Persistence is opt-in via configuration in src/app/modbus_server.json. Review the persistence section in the config and the examples/ before enabling in production.
• Deployments should allow sufficient time for graceful shutdown so the server can complete persistence writes.
• When enabled, the server will create or update on-disk persistence files according to the configured path; ensure appropriate file permissions and storage availability.

Compatibility & Caveats

• No changes to core Modbus protocol handling — this release only augments lifecycle behavior with persistence.
• Default runtime behavior remains unchanged if persistence is not enabled.
• Storage format and on-disk files are managed by the new library; future releases may include migrations if the format changes.

What's Changed

• Add persistent storage feature by @cybcon in #51

Full Changelog: v2.0.0...v2.1.0

v2.0.0

Summary

This release upgrades the Modbus Server project to PyModbus v3.11 and includes several maintenance updates and improvements.

Key Changes

Dependency Upgrades

• PyModbus v3.11: Major version upgrade with updated API and imports
  • Changed from pymodbus.server.sync to pymodbus.server module imports
  • Updated datastore imports: removed deprecated ModbusSlaveContext, now using ModbusDeviceContext
  • Updated device module path: pymodbus.device → pymodbus.pdu.device
  • Adjusted function signatures and data block handling to match new API

Infrastructure Updates

• Alpine base image: Updated from 3.23.2 to 3.23.3 (security & patch updates)
• Version bump: 1.4.1 → 2.0.0 (reflects major PyModbus upgrade)
• Copyright year: Updated to 2026

Feature Removals

• Removed zeroMode configuration: The deprecated zeroMode option has been removed from both the configuration file and the codebase. This simplification aligns with PyModbus v3.11 standards and reduces unnecessary complexity.

Documentation & CI/CD Improvements

• CI/CD workflow enhancement: Updated GitHub Actions test workflow to install dependencies from dedicated tests/requirements.txt file, improving setup clarity and maintainability
• Improved configuration handling: Updated default config file path logic for better portability
• Added Copilot Instructions: New .github/copilot-instructions.md with comprehensive project documentation including architecture, build commands, conventions, and configuration guidelines
• Updated documentation: README and code comments reflect new version and removed features

Code Quality

• Updated docstring format and type hints throughout modbus_server.py
• Enhanced error handling documentation

What's Changed

• Feature/maintenance versions by @cybcon in #49
• Feature/upgrade pymodbus by @cybcon in #50

Full Changelog: v1.4.1...v2.0.0

v1.4.1

What's Changed

• Add section as hint for own docker builds by @cybcon in #45
• upgrade versions by @cybcon in #48

Full Changelog: v1.4.0...v1.4.1

v1.4.0

What's Changed

• fix version and copyright year by @cybcon in #40
• Add badges by @cybcon in #42
• Feature/modbus udp by @cybcon in #43

Full Changelog: v1.3.2...v1.4.0

v1.3.2

What's Changed

• Fixing version in README by @cybcon in #35
• Add permission to write to registry by @cybcon in #36
• Upgrade alpine base image, and python version by @cybcon in #39

Full Changelog: v1.3.1...v1.3.2

v1.3.1

What's Changed

• Create FUNDING.yml by @cybcon in #30
• refactor: Add unit testing and refactor code to follow Python standards. by @bvanelli in #31
• Upgrade Alpine and package versions, increase app version by @cybcon in #34

New Contributors

• @bvanelli made their first contribution in #31

Full Changelog: v1.3.0...v1.3.1

v1.3.0

What's Changed

• Try to add functionality test by @cybcon in #29

Full Changelog: v1.2.0...v1.3.0

v1.2.0

What's Changed

• Fix Link to dockerhub by @cybcon in #25
• Add Donate Button by @cybcon in #26
• Allow integer values in register types 3 and 4 by @cybcon in #27

Full Changelog: v1.1.5...v1.2.0

v1.1.5

What's Changed

• add link to dockerfile by @cybcon in #21
• Enhance readme by @cybcon in #22
• Change log severity by @cybcon in #24

Full Changelog: v1.1.4...v1.1.5

v1.1.4

What's Changed

• Fixing link to example by @cybcon in #17
• Fix coils and discrete input register initialization by @cybcon in #20

Full Changelog: v1.1.3...v1.1.4