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

Consequently ignore empty MQTT state payloads and set state to unknown on "None" payload #117813

Merged
merged 5 commits into from
May 24, 2024

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented May 20, 2024

Breaking change

The behavior on processing empty and "None" state payloads for MQTT entities has been made more predictable for alarm_control_panel, climate, cover, device_tracker, lock, select, valve and water_heater items,

  • A "None" (str) for a state payload generally means that the state becomes unknown.
  • An empty payload is ignored.

Previously a "None" state could be considered invalid or was just ignored.

Proposed change

See also breaking change section. The handling of empty payloads and payloads rendering to "None" are handled more consequently now.

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
  • 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:

@home-assistant
Copy link

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

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign mqtt Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@jbouwh jbouwh marked this pull request as draft May 20, 2024 19:18
@jbouwh jbouwh marked this pull request as ready for review May 20, 2024 19:34
frenck
frenck previously requested changes May 24, 2024
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

@jbouwh A wild merge conflict appeared out of nowhere... Could you take a look? 🙈

../Frenck

@home-assistant home-assistant bot marked this pull request as draft May 24, 2024 19:22
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@jbouwh jbouwh marked this pull request as ready for review May 24, 2024 22:17
@home-assistant home-assistant bot requested a review from frenck May 24, 2024 22:17
@jbouwh jbouwh marked this pull request as draft May 24, 2024 22:18
@jbouwh jbouwh marked this pull request as ready for review May 24, 2024 23:00
@jbouwh jbouwh dismissed frenck’s stale review May 24, 2024 23:01

rebased and resolved merge conflicts

@jbouwh
Copy link
Contributor Author

jbouwh commented May 24, 2024

Thanks!

@jbouwh jbouwh merged commit 01f3a5a into dev May 24, 2024
38 checks passed
@jbouwh jbouwh deleted the mqtt-payload-none branch May 24, 2024 23:29
@github-actions github-actions bot locked and limited conversation to collaborators May 26, 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.

4 participants