Skip to content

Add pymodbus exception handling and isolate pymodbus to class modbusHub#49052

Merged
balloob merged 1 commit intohome-assistant:devfrom
janiversen:issue_40936
Apr 19, 2021
Merged

Add pymodbus exception handling and isolate pymodbus to class modbusHub#49052
balloob merged 1 commit intohome-assistant:devfrom
janiversen:issue_40936

Conversation

@janiversen
Copy link
Copy Markdown
Member

@janiversen janiversen commented Apr 11, 2021

Breaking change

Proposed change

Add pymodbus exception handling directly in the class modbusHub in order to isolate the pymodbus library.

This has 2 consequences:

  • platforms using modbusHub do not receive exceptions, but may receive None
  • Testing of the pymodbus library are limited to class pymodbus (see PR Test pymodbus #49053).

The old code could deliver wrong data during startup, especially if the device were slow to connect, this
Should now be history.

STATE_UNAVIALABLE was not set in all platforms, so sometimes there were not data, but HA was not made aware
That the data was invalid.

There is a major rewrite of the test_modbus.py module, submitted in the next PR, to thoroughly test exceptions/writes etc.

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link
Copy Markdown

Hey there @adamchengtkc, @vzahradnik, mind taking a look at this pull request as its been labeled with an integration (modbus) you are listed as a codeowner for? Thanks!
(message by CodeOwnersMention)

This was referenced Apr 11, 2021
@MartinHjelmare MartinHjelmare changed the title add pymodbus exception handling and isolate pymodbus to class modbusHub Add pymodbus exception handling and isolate pymodbus to class modbusHub Apr 11, 2021
Comment thread homeassistant/components/modbus/modbus.py Outdated
@janiversen
Copy link
Copy Markdown
Member Author

Update to newest dev which includes changes to modbus.

@balloob balloob merged commit eb9ba52 into home-assistant:dev Apr 19, 2021
@janiversen janiversen deleted the issue_40936 branch April 19, 2021 18:29
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

4 participants