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.

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

Update outdated documentation #55

Merged
merged 21 commits into from
Jan 10, 2023

Conversation

brainelectronics
Copy link
Owner

Added

Changed

Fixed

@brainelectronics brainelectronics added bug Something isn't working documentation Improvements or additions to documentation internal Internal change, not affecting distribution labels Jan 9, 2023
@brainelectronics brainelectronics added this to the Documentation milestone Jan 9, 2023
@brainelectronics brainelectronics self-assigned this Jan 9, 2023
@brainelectronics brainelectronics linked an issue Jan 9, 2023 that may be closed by this pull request
@brainelectronics
Copy link
Owner Author

Hey @beyonlo and @toddkarin here are the updated beautiful docs. Let me know whether this resolves #54 😃

https://micropython-modbus--55.org.readthedocs.build/en/55/

@brainelectronics
Copy link
Owner Author

@beyonlo
Copy link

beyonlo commented Jan 10, 2023

@brainelectronics

Excellent! I liked it so much! Beautiful docs and very useful 🎉

Some possible suggestions/improvements:

  1. On the manually installation, a option is to put a example with mpremote as well, together that rshell example. As mpremote become a standard use, maybe is a good idea. mpremote cp -r umodbus/ :

  2. On the Structure, on the ISTS (INPUT STATUS) are using in some comments input registers instead input status or discrete inputs. Shouldn't use input registers to be used just for the IREGS (INPUT REGISTERS)?

A extra note: About that behaviour where the callback print always signed False, maybe a way to solve is to put on the JSON structure a option "signed" [False, True] configured by user, like as the "val" and "len". So the Slave/Client use that to know if print/use signed False or True.

@brainelectronics brainelectronics merged commit 8de96e9 into develop Jan 10, 2023
@brainelectronics brainelectronics deleted the bugfix/update-outdated-documentation branch January 10, 2023 22:00
hmaerki pushed a commit to hmaerki/fork_micropython-modbus that referenced this pull request Dec 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation internal Internal change, not affecting distribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation for mip usage
2 participants