Bugfix 105: Use Unit ID name #106
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
You might still want to consider this a breaking change, even though backwards compatibility was added, because Python doesn't have private code, so all the internal methods all changed, if you call them with named parameters (and not just positionally). All the unit tests, which are presumably the main API used, are backwards compatible. |
Modernizes the Modbus terminology by using "unit ID" throughout the codebase. This addresses issue sunspec#105 by: - Renaming parameters and variables to unit_id - Updating method signatures while maintaining backward compatibility - Revising documentation and comments to reflect current industry standards - Ensuring consistent terminology across the entire Modbus implementation This change improves code readability and aligns with current Modbus specification terminology while maintaining full backward compatibility.
Updates test cases to align with the modernized unit ID terminology. Ensures all tests properly exercise the updated API while maintaining complete test coverage include backward compatibility tests.
sgryphon
force-pushed
the
sgryphon/105-use-unit-id-name
branch
from
f9ce125 to
0deeff3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes issue #105
Change parameter name and internal references to Unit Identifier, to align with the current MODBUS standards.
Backwards compatibility added for old parameter name, with several test cases kept using the old name to verify it works.
Errors added where neither value is supplied and the field is mandatory (for RTU device). To do this the name parameter had to also be made optional, as it comes after unit_id (i.e. to preserve positional calls), so a check was added for it as well.
In both cases a deprecation warning was added if the old name was used.
Documentation updated for the new name, and most tests changed to use the new parameter name (some tests were left using the old name, to test the backwards compatibility, and some already used positional arguments).