Skip to content

Conversation

hicklin
Copy link
Contributor

@hicklin hicklin commented Oct 10, 2025

This PR adds an out-of-band API to the OnOff cluster. This allows users to interact with the OnOff state machine when events or user interactions occur outside Matter.

This API provides devices two ways of interacting with the OnOffHandler.

  1. Request the OnOffHandler to update its state according to the current state of the device. For example; when a user physically interacts with the device, immediately changing its state.
  2. Request the OnOffHandler to issue an On or Off command. For example; a soft interaction with the device causing the device to request a change in the state. This takes advantage of the transition logic implemented by Matter, ensuring consistent behaviour across all interactions methods.

Copy link
Contributor

Summary of Changes

Hello @hicklin, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the OnOff cluster by introducing an out-of-band API, allowing physical device interactions or external events to seamlessly integrate with the Matter state machine. This ensures that the device's Matter representation accurately reflects its real-world state, whether through direct state synchronization or by leveraging Matter's transition logic for consistent behavior.

Highlights

  • Out-of-Band API for OnOff Cluster: Introduced a new API that allows external physical interactions or events to directly update or request changes to the Matter OnOff state machine, ensuring consistent behavior.
  • New OutOfBandMessage Enum: Added an OutOfBandMessage enum with Update, On, and Off variants to represent different types of external notifications to the OnOff handler.
  • Extended OnOffHooks Trait: The OnOffHooks trait now includes an async fn run method, enabling device-specific implementations to provide continuous out-of-band notifications to the OnOffHandler.
  • Refactored OnOffHandler Logic: The OnOffHandler was updated to process these new out-of-band messages, including a dedicated update method to synchronize the Matter state with the physical device state without triggering Matter commands. Its main run loop now concurrently listens for both internal and external state changes.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces an out-of-band API to the OnOff cluster, allowing for interaction with the cluster's state machine from outside of Matter, for instance, due to physical device interactions. The changes include a new OutOfBandMessage enum, updates to the OnOffHooks trait with a new run method, and modifications to the cluster's state machine to handle these new interactions. The implementation looks solid, but there are a couple of high-severity issues related to duplicate data version notifications that should be addressed. I've also pointed out some minor typos in comments.

@hicklin hicklin force-pushed the on_off_out_of_band_api branch from 0f71e10 to b4d27a7 Compare October 10, 2025 13:06
@hicklin hicklin requested a review from ivmarkov October 10, 2025 13:13
@ivmarkov
Copy link
Contributor

LGTM.

@hicklin hicklin merged commit ca6158d into project-chip:main Oct 10, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants