Skip to content

Matter OperationalState CountdownTime #147705

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

Matter OperationalState CountdownTime #147705

wants to merge 1 commit into from
+135 −0

Conversation

lboue
Copy link
Contributor

@lboue lboue commented Jun 28, 2025 •
edited
Loading

Proposed change

Matter OperationalState CountdownTime. This attribute SHALL represent the estimated time left before the operation is completed, in seconds.
Used for appliances like MWO or Dishwasher.

It can be tested with this example:
https://github.com/tomasmcguinness/matter-esp32-acme-dishwasher

image

Specs

This attribute SHALL represent the estimated time left before the operation is completed, in seconds.
A value of 0 (zero) means that the operation has completed.
A value of null represents that there is no time currently defined until operation completion. This MAY happen, for example, because no operation is in progress or because the completion time is unknown.
Changes to this attribute SHALL only be marked as reportable in the following cases:
• If it has changed due to a change in the CurrentPhase or OperationalState attributes, or
• When it changes from 0 to any other value and vice versa, or
• When it changes from null to any other value and vice versa, or
• When it increases, or
• When there is any increase or decrease in the estimated time remaining that was due to progressing insight of the server’s control logic, or
• When it changes at a rate significantly different from one unit per second.
Changes to this attribute merely due to the normal passage of time with no other dynamic change of device state SHALL NOT be reported.
As this attribute is not being reported during a regular countdown, clients SHOULD NOT rely on the reporting of this attribute in order to keep track of the remaining duration.

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:
  • Link to developer documentation pull request:
  • Link to frontend 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @home-assistant/matter, mind taking a look at this pull request as it has been labeled with an integration (matter) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of matter 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 matter 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.

@lboue lboue marked this pull request as ready for review June 28, 2025 07:32
@lboue lboue requested a review from a team as a code owner June 28, 2025 07:32
MartinHjelmare
MartinHjelmare reviewed Jun 28, 2025
View reviewed changes
homeassistant/components/matter/sensor.py
translation_key="countdown_time",
native_unit_of_measurement=UnitOfTime.SECONDS,
suggested_unit_of_measurement=UnitOfTime.MINUTES,
device_class=SensorDeviceClass.DURATION,
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this be a timestamp sensor instead? According to the specs it is not reported changed due to normal passage of time (ie a decrease of 1 / s) but only for significant changes, like recalculation in server, increase of time, going from or to 0 etc.

If we use a duration sensor instead of a timestamp sensor this sensor will have the wrong state for the whole duration after the first report until it reaches 0.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, the way it works is quite special.
You mean do a calculation to determine the timestamp of the end time?

Copy link
Member

Choose a reason for hiding this comment

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

Yes.

@MartinHjelmare MartinHjelmare marked this pull request as draft June 28, 2025 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MartinHjelmare MartinHjelmare MartinHjelmare left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
cla-signed has-tests integration: matter new-feature Quality Scale: No score small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lboue @MartinHjelmare