Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add all missing docstrings and typing hints, improve docs, fix some but not all bugs #39

Merged
merged 33 commits into from
Dec 27, 2022
Merged

Add all missing docstrings and typing hints, improve docs, fix some but not all bugs #39

merged 33 commits into from
Dec 27, 2022

Commits on Dec 16, 2022

  1. add private functions to documentation, improve summary

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    3fa00ee View commit details
    Browse the repository at this point in the history

  2. reorder API documentation modules

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    e81b68a View commit details
    Browse the repository at this point in the history

  3. add doc strings and typing hints in common module, see #27

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    cb36e4f View commit details
    Browse the repository at this point in the history

  4. add description to all constant modbus values

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    9beeda2 View commit details
    Browse the repository at this point in the history

  5. add docstrings and summary for modbus module, see also #27

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    ed0f82d View commit details
    Browse the repository at this point in the history

  6. add doc strings and typing hints in serial module, see #27

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    ae6ef0f View commit details
    Browse the repository at this point in the history

  7. add doc strings and typing hints in tcp module, see #27

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    0e315ac View commit details
    Browse the repository at this point in the history

  8. validate reponse data of write_multiple_registers with respect to val… 

    …ue signing in TCP and Serial modules, contribute to #23
    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    745e939 View commit details
    Browse the repository at this point in the history

  9. add doc strings and typing hints in functions module, see #27

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    c6c61cb View commit details
    Browse the repository at this point in the history

  10. enable reading more than 8 coils in a row, fix #36

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    7e75392 View commit details
    Browse the repository at this point in the history

  11. add example coil definition with more than 8 coils to verify fix of #36

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    a0fde44 View commit details
    Browse the repository at this point in the history

  12. add test for reading more than 8 coils in a row to verify fix of #36

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    fabb9d9 View commit details
    Browse the repository at this point in the history

  13. add negative HREG value in example JSON

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    23e3280 View commit details
    Browse the repository at this point in the history

  14. add test for reading a negative holding register value

    @brainelectronics
    brainelectronics committed Dec 16, 2022
    Configuration menu
    Copy the full SHA
    99f0c6d View commit details
    Browse the repository at this point in the history

Commits on Dec 17, 2022

  1. fix writing multiple coils in TCP, resolve #22

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    16869a4 View commit details
    Browse the repository at this point in the history

  2. add test to verify write multiple coils fix #22, #38 is still open an… 

    …d valid
    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    0cbb444 View commit details
    Browse the repository at this point in the history

  3. document usage of coil reading and writing, relates to #15 and #22

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    c5ccd28 View commit details
    Browse the repository at this point in the history

  4. document usage of discrete input reading

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    f0d06e1 View commit details
    Browse the repository at this point in the history

  5. comment unused common function data_as_registers

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    0b80c6a View commit details
    Browse the repository at this point in the history

  6. fix writing multiple registers in TCP, resolve #23

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    9b0662b View commit details
    Browse the repository at this point in the history

  7. add test to verify write multiple registers fix #23

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    75c1b7e View commit details
    Browse the repository at this point in the history

  8. document usage of holding register reading and writing, relates to #23

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    dcb537c View commit details
    Browse the repository at this point in the history

  9. add is_bound property to TCPServer class

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    ce220e1 View commit details
    Browse the repository at this point in the history

  10. document usage of input registers reading

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    d0b1415 View commit details
    Browse the repository at this point in the history

  11. simplify _process_write_access logic of TCP client

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    dd6deca View commit details
    Browse the repository at this point in the history

  12. update changelog

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    072f5c2 View commit details
    Browse the repository at this point in the history

  13. remove not yet ready modbus register files, accidentially added

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    4ab4d1c View commit details
    Browse the repository at this point in the history

  14. use MSB and LSB data properly in bytes_to_bool unit test, see #36

    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    53c6694 View commit details
    Browse the repository at this point in the history

  15. remove unused functions data_as_bits and data_as_registers from commo… 

    …n module
    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    debf453 View commit details
    Browse the repository at this point in the history

  16. hightlight notes and warnings of Usage documentation in Sphinx suppor… 

    …ted way
    @brainelectronics
    brainelectronics committed Dec 17, 2022
    Configuration menu
    Copy the full SHA
    3e8a376 View commit details
    Browse the repository at this point in the history

Commits on Dec 27, 2022

  1. return only requested amount of registers during read request, contri… 

    …butes to #35
    @brainelectronics
    brainelectronics committed Dec 27, 2022
    Configuration menu
    Copy the full SHA
    c1e51cb View commit details
    Browse the repository at this point in the history

  2. add unittest for reading coils, holding registers, input registers an… 

    …d discrete inputs partially, contributes to #35
    @brainelectronics
    brainelectronics committed Dec 27, 2022
    Configuration menu
    Copy the full SHA
    9934dd3 View commit details
    Browse the repository at this point in the history

  3. update changelog and mention partial data request fix, see #35

    @brainelectronics
    brainelectronics committed Dec 27, 2022
    Configuration menu
    Copy the full SHA
    b177204 View commit details
    Browse the repository at this point in the history