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

Solve modbus binary slave problem #82338

Merged
merged 2 commits into from
Nov 26, 2022
Merged

Conversation

janiversen
Copy link
Member

Breaking change

Proposed change

#77029 reported a problem with the slave option, but actually the problem was deeper.

Corrected binary_sensor, with/without slaves (in general indexing was wrong).

Added tests to secure it all works.

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

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
  • The code has been formatted using Black (black --fast 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:

@home-assistant
Copy link

Hey there @adamchengtkc, @vzahradnik, mind taking a look at this pull request as it has been labeled with an integration (modbus) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of modbus can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Change the title of the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign modbus Removes the current integration label and assignees on the issue, add the integration domain after the command.

Copy link
Contributor

@bonzini bonzini left a comment

Choose a reason for hiding this comment

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

The bulk of the change is to treat result.bits as an array of bools, which matches how pymodbus works.

I think the & 1 is not necessary, but it is okay to use it for consistency between the coil/discrete input cases on one hand and the holding/input register cases on the other hand.

@janiversen
Copy link
Member Author

@frenck Thanks for merging my modbus PRs getting rid of bugs. Would be real nice if this one could get merged as well and be part of 2022.12.

self._attr_is_on = bool(result.bits[0] & 1)
else:
self._result = result.registers
self._attr_is_on = bool(result.registers[0] & 1)
Copy link
Contributor

Choose a reason for hiding this comment

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

These calculations does not match how it's done done the callback below?

Copy link
Member Author

Choose a reason for hiding this comment

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

It is actually the same, let me explain:

  • the primary sensor gets one of 2 arrays (bits/registers), and sets self._result which is sent to the coordinator, so that the slaves only have 1 array.
  • the primary sensor always uses registers/bits index 0, whereas slaves uses index 1-n.
  • the calculation itself is identical: bool( & 1)

I hope that explains things.

Copy link
Contributor

Choose a reason for hiding this comment

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

Move the is_on calculation outside if the if clause and use self._result as variable instead, then code will be identical in both cases and match slave sensor.

homeassistant/components/modbus/binary_sensor.py Outdated Show resolved Hide resolved
self._attr_is_on = bool(result.bits[0] & 1)
else:
self._result = result.registers
self._attr_is_on = bool(result.registers[0] & 1)
Copy link
Contributor

Choose a reason for hiding this comment

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

Move the is_on calculation outside if the if clause and use self._result as variable instead, then code will be identical in both cases and match slave sensor.

@janiversen
Copy link
Member Author

All done and rebased on newest dev.

@janiversen janiversen merged commit 8ed4ce6 into home-assistant:dev Nov 26, 2022
@janiversen
Copy link
Member Author

thanks @elupus

@janiversen janiversen deleted the issue_77029 branch November 26, 2022 10:12
@github-actions github-actions bot locked and limited conversation to collaborators Nov 27, 2022
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.

Modbus Binary slave inputs not working
3 participants