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

Modbus, allow received int to be a float. #110648

Merged
merged 2 commits into from Feb 15, 2024
Merged

Conversation

janiversen
Copy link
Member

@janiversen janiversen commented Feb 15, 2024

Breaking change

Proposed change

Configuration "datatype: INT*", means the modbus integration receives an int (in 1 or multiple registers depending on type), without anymore configuration the value is passed to core as an int.

However Configuration "scale: 0,01" divides the value by 100, and turns it into a float that are send to core, likewise "precision: 2" adds 2 decimal places and turns it into a float.

This works nicely with the current version, except for virtual devices...this PR corrects that problem.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@janiversen janiversen marked this pull request as ready for review February 15, 2024 15:01
@janiversen janiversen added this to the 2024.2.2 milestone Feb 15, 2024
Comment on lines +202 to +203
if self._precision > 0 or self._scale != int(self._scale):
self._value_is_int = False
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the default precision not be 2 if the returned value is not an int?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes and no, that is being set in line 199. The default of 2 is if the user configures e.g. "datatype: float", not what's being returned.

The user can configure "precision: 3" and "datatype: int32" then the returned value will e.g. be "1.000"
The user can configure "scale: 0.001" and "datatype:int32" then value 123 would be returned as 1.23

This is however not what is happening here, in this case user have configured e.g. "datatype: int16" and "precision: 2" or "scale: 0.001" that means that the returned value is no longer and int but a float, and hence "self._value_is_int = False" is correct.

Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM,
Thnx @janiversen 👍

@janiversen janiversen merged commit 286c98d into home-assistant:dev Feb 15, 2024
53 checks passed
@janiversen janiversen deleted the bug branch February 15, 2024 17:22
@frenck frenck mentioned this pull request Feb 16, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Feb 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants