Changelog
=========

`1.5.0 <https://github.com/gavinying/modpoll/compare/v1.4.1...v1.5.0>`__ (2025-03-13)
-------------------------------------------------------------------------------------

Features
~~~~~~~~

-  Update docker compose to conform to new specification
   (`abc55aa <https://github.com/gavinying/modpoll/commit/abc55aa363d76dc35b6a9731e31ab4b551a7b435>`__)

Bug Fixes
~~~~~~~~~

-  CI pipelines issue with wrong poetry version
   (`14d0563 <https://github.com/gavinying/modpoll/commit/14d0563f0928b4dd0673290660bf56908090c836>`__)
-  Install specific version of plugins
   (`98af91c <https://github.com/gavinying/modpoll/commit/98af91c5dcf241754e05182e4865595ea9d5a381>`__)
-  Wrong poll size in docs
   (`4ad6dbf <https://github.com/gavinying/modpoll/commit/4ad6dbfeabeaa8f5e9fdbe7dfeb240c6eb6ecab1>`__)

Reverts
~~~~~~~

-  Install poetry before cache check
   (`2041db7 <https://github.com/gavinying/modpoll/commit/2041db7c3e583e3acb75bc3b7836db46efa2589d>`__)

Documentation
~~~~~~~~~~~~~

-  Add description for polling string reference example
   (`3bb8ade <https://github.com/gavinying/modpoll/commit/3bb8adeb4ca09bed05bf87cb8271dc02bfc8a585>`__)
-  Update screenshots
   (`e44ac1a <https://github.com/gavinying/modpoll/commit/e44ac1a33cb3806a665103e1e304e909c1a2f73a>`__)

.. _section-1:

`1.4.1 <https://github.com/gavinying/modpoll/compare/v1.4.0...v1.4.1>`__ (2025-01-03)
-------------------------------------------------------------------------------------

.. _bug-fixes-1:

Bug Fixes
~~~~~~~~~

-  Eastron meter config issue
   (`d58ed36 <https://github.com/gavinying/modpoll/commit/d58ed36e1bc75be72e4d14ffbcf16f41f7958386>`__)

.. _documentation-1:

Documentation
~~~~~~~~~~~~~

-  Add reference scale usage in examples
   (`8b4319c <https://github.com/gavinying/modpoll/commit/8b4319c014be71bb5ac121888cc7dd9b8f552765>`__),
   closes `#75 <https://github.com/gavinying/modpoll/issues/75>`__

.. _section-2:

`1.4.0 <https://github.com/gavinying/modpoll/compare/v1.3.3...v1.4.0>`__ (2024-11-15)
-------------------------------------------------------------------------------------

.. _features-1:

Features
~~~~~~~~

-  Add example config for Eastron SDM120
   (`#72 <https://github.com/gavinying/modpoll/issues/72>`__)
   (`2dde6b9 <https://github.com/gavinying/modpoll/commit/2dde6b9b413a1c7fba19ba88dc8f1e7df8287c25>`__)
-  Allow HEX number in configuration file
   (`#70 <https://github.com/gavinying/modpoll/issues/70>`__)
   (`6324269 <https://github.com/gavinying/modpoll/commit/63242699b75b5169abc8064c1546faa92a8754de>`__)
-  Publish MQTT message for each single reference.
   (`adb869f <https://github.com/gavinying/modpoll/commit/adb869faeb375ec92d1158bd87c0389de7eceb09>`__)

.. _bug-fixes-2:

Bug Fixes
~~~~~~~~~

-  Rename doc include config_template.csv
   (`#73 <https://github.com/gavinying/modpoll/issues/73>`__)
   (`8003ff3 <https://github.com/gavinying/modpoll/commit/8003ff33a42143766223f2b02307cd17409b4059>`__)

.. _section-3:

`1.3.3 <https://github.com/gavinying/modpoll/compare/v1.3.2...v1.3.3>`__ (2024-10-15)
-------------------------------------------------------------------------------------

.. _bug-fixes-3:

Bug Fixes
~~~~~~~~~

-  CI docs pipeline issue
   (`ada4089 <https://github.com/gavinying/modpoll/commit/ada4089df1bb3063641820274a2c476d4a421321>`__)

.. _section-4:

`1.3.2 <https://github.com/gavinying/modpoll/compare/v1.3.1...v1.3.2>`__ (2024-10-15)
-------------------------------------------------------------------------------------

.. _bug-fixes-4:

Bug Fixes
~~~~~~~~~

-  CI pipeline issue
   (`9386455 <https://github.com/gavinying/modpoll/commit/9386455652025ea300dfdef5034738fa8936a66e>`__)

.. _section-5:

`1.3.1 <https://github.com/gavinying/modpoll/compare/v1.3.0...v1.3.1>`__ (2024-10-14)
-------------------------------------------------------------------------------------

.. _bug-fixes-5:

Bug Fixes
~~~~~~~~~

-  Arguments mqtt-qos doesn’t work for publish
   (`0a65d0a <https://github.com/gavinying/modpoll/commit/0a65d0ad1efe5067c080f7dd02afc1a8cb3c8478>`__)
-  Zsh parse error due to the special character used in
   mqtt-publish-topic-pattern.
   (`98230e8 <https://github.com/gavinying/modpoll/commit/98230e8e78c77e7a0334d101ac990f53e599ce1d>`__)

.. _section-6:

`1.3.0 <https://github.com/gavinying/modpoll/compare/v1.2.0...v1.3.0>`__ (2024-10-13)
-------------------------------------------------------------------------------------

.. _features-2:

Features
~~~~~~~~

-  Optimize code to make it more object oriented
   (`7195e29 <https://github.com/gavinying/modpoll/commit/7195e297b5e658b05bb1c7c75c2d02f2ab886331>`__)
-  Remove importlib-metadata dependency since we drop support for
   pre-python3.8 environments.
   (`36a6fd4 <https://github.com/gavinying/modpoll/commit/36a6fd43e81512af819cd7e00cdef4385e56e7ca>`__)
-  Support running multiple master instances
   (`#64 <https://github.com/gavinying/modpoll/issues/64>`__)
   (`c44b597 <https://github.com/gavinying/modpoll/commit/c44b597f45a1c9fd8b3b49562d74f959d21cd1f0>`__)

.. _bug-fixes-6:

Bug Fixes
~~~~~~~~~

-  Adjust delay to every loop iteration
   (`e368922 <https://github.com/gavinying/modpoll/commit/e368922b925bcdf602d42716d2a72631f1134639>`__)
-  Allow github action to read the PR title and add labels
   (`22cb7c8 <https://github.com/gavinying/modpoll/commit/22cb7c8dce284675193865c8fe399320bb0f2636>`__)

.. _section-7:

`1.2.0 <https://github.com/gavinying/modpoll/compare/v1.1.0...v1.2.0>`__ (2024-08-25)
-------------------------------------------------------------------------------------

.. _features-3:

Features
~~~~~~~~

-  Introduce MQTT topic pattern to replace the existing MQTT topic
   prefix.
   (`58d3f67 <https://github.com/gavinying/modpoll/commit/58d3f6719b7c78b0c17cfb60ca7013e5f8d1bccb>`__)
-  Add docker compose for better developer experience.
   (`01f15e8 <https://github.com/gavinying/modpoll/commit/01f15e8d140eadf3413471463fbb26cd7d8fc175>`__)

.. _bug-fixes-7:

Bug Fixes
~~~~~~~~~

-  Validate action issue
   (`f8ef12e <https://github.com/gavinying/modpoll/commit/f8ef12e018009ec1c8b4d554829156e93c9a5b98>`__)
-  Typos
   (`9349864 <https://github.com/gavinying/modpoll/commit/9349864c5712fad3da9218d8f8b72529da5e03fa>`__)

.. _section-8:

`1.1.0 <https://github.com/gavinying/modpoll/compare/1.0.0...v1.1.0>`__ (2024-08-03)
------------------------------------------------------------------------------------

.. _features-4:

Features
~~~~~~~~

-  add docker run commands for dev
   (`074d51e <https://github.com/gavinying/modpoll/commit/074d51e6196ca342d71c103e55a9c9e72cd3462b>`__)
-  add test cases for pytest
   (`99fc461 <https://github.com/gavinying/modpoll/commit/99fc4613034e8aac1a24a760bfe395467a554092>`__)
-  support paho v2
   (`#52 <https://github.com/gavinying/modpoll/issues/52>`__)
   (`3e6681a <https://github.com/gavinying/modpoll/commit/3e6681a56497672c664a200e95728d7202a1964f>`__)

.. _bug-fixes-8:

Bug Fixes
~~~~~~~~~

-  allow user defined docker registry
   (`38acfcc <https://github.com/gavinying/modpoll/commit/38acfcc16f8143fe91e716ff734d4e96e8cc9035>`__)
-  device list is not properly used
   (`1824bed <https://github.com/gavinying/modpoll/commit/1824bede7a4085cf31243a261a7e074ad506c453>`__)
-  duplications in ci actions
   (`db5c667 <https://github.com/gavinying/modpoll/commit/db5c667138afa4d0226b77655a4abe179bce866a>`__)
-  paho v2 changes in callbacks
   (`09316f8 <https://github.com/gavinying/modpoll/commit/09316f8e8c247148d22f1b56a60fd35d6072ab6f>`__)
-  poetry warning
   (`44ec61f <https://github.com/gavinying/modpoll/commit/44ec61fd159e89b630ded9674c0a535cd1ba1a60>`__)
-  Unexpected input for release-please
   (`24703fe <https://github.com/gavinying/modpoll/commit/24703fe098379016447ab50ab89276e0f0f734ef>`__)

.. _documentation-2:

Documentation
~~~~~~~~~~~~~

-  update CHANGELOG.md
   (`73fcc01 <https://github.com/gavinying/modpoll/commit/73fcc010cb0ddbf4a1aa149ac28a354cd1bc5c39>`__)

.. _section-9:

`1.0.0 <https://github.com/gavinying/modpoll/compare/0.8.4...1.0.0>`__ (2024-07-11)
-----------------------------------------------------------------------------------

⚠ BREAKING CHANGES
~~~~~~~~~~~~~~~~~~

-  Release v1.0.0

.. _features-5:

Features
~~~~~~~~

-  Support Modbus RTU/TCP/UDP devices

-  Poll data from multiple Modbus devices

-  Publish data to MQTT broker for remote debugging

-  Log data for further investigation

-  Provide docker solution for continuous data polling in production