Repository navigation
MATTER-5857: Update the API Reference section of the documentation #72
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
Merged
Michael Duggan (miduggan24)
merged 12 commits into
doccurator/2.9.2
from
docs/MATTER-5857
Sep 24, 2026
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
57d3684
refactor api reference docspace
miduggan24 9e24fbe
Apply batched suggestions from code review
miduggan24 dc093a7
apply common edits across app files
miduggan24 5dcf8c8
Apply batched suggestions from code review
miduggan24 7f9f705
Update sld295-matter-api-reference/air-quality-sensor-app.md
miduggan24 43e287a
fix formatting issues from batch application
miduggan24 688f2d2
Apply batched suggestions from code review
miduggan24 a6cef78
Apply batched suggestions from code review
miduggan24 ef658ff
Apply batched suggestions from code review
miduggan24 5adfc9d
apply review comment
miduggan24 71e8603
Apply batched suggestions from code review
miduggan24 dc794bf
fix formatting issue from code review
miduggan24 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Air Quality Sensor Application Override APIs | ||
|
|
||
| To override any of the following hooks, declare the corresponding `*Impl()` method in `CustomerAppTask.h` and implement it in `CustomerAppTask.cpp`. Ensure that the method signature matches the declaration in `autogen/AppTaskImpl.h`. | ||
|
|
||
| ## AppTask | ||
|
|
||
| | Override | Public API | Default behavior | | ||
| |---|---|---| | ||
| | `AppInitImpl` | `AppInit` | Registers the button callback, configures the LCD UI, and initializes the air quality sensor. | | ||
| | `InitAirQualitySensorImpl` | `InitAirQualitySensor` | Creates the periodic sensor timer, initializes the sensor hardware when available, and starts sampling. | | ||
| | `GetAirQualityValueImpl` | `GetAirQualityValue` | Reads the value from the onboard air quality sensor. If the sensor is unavailable, returns a simulated value. | | ||
| | `ButtonEventHandlerImpl` | `ButtonEventHandler` | Routes function-button events to the base application handler. | | ||
| | `SensorTimerEventHandlerImpl` | `SensorTimerEventHandler` | Reads the sensor value and schedules an update to the Air Quality attribute. | | ||
| | `DMPostAttributeChangeCallbackImpl` | `DMPostAttributeChangeCallback` | Logs changes to the Identify attribute. | |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Base Platform Application Override APIs | ||
|
|
||
| To override any of the following hooks, declare the corresponding `*Impl()` method in `CustomerAppTask.h` and implement it in `CustomerAppTask.cpp`. Ensure that the method signature matches the declaration in `autogen/AppTaskImpl.h`. | ||
|
|
||
| ## AppTask | ||
|
|
||
| | Override | Public API | Default behavior | | ||
| |---|---|---| | ||
| | `AppInitImpl` | `AppInit` | Registers the button callback, initializes the LED, and shows the demo UI or QR code when enabled. | | ||
| | `ButtonEventHandlerImpl` | `ButtonEventHandler` | Routes user-action button events to `ApplicationEventHandler` and function-button events to the base application handler. | | ||
| | `ApplicationEventHandlerImpl` | `ApplicationEventHandler` | Toggles the LED when the user-action button is pressed. | | ||
| | `OnEnterActiveModeImpl` | `OnEnterActiveMode` | Updates the demo UI when the ICD server enters active mode. Available when `CHIP_CONFIG_ENABLE_ICD_SERVER` is enabled. | | ||
| | `OnEnterIdleModeImpl` | `OnEnterIdleMode` | Updates the demo UI when the ICD server enters idle mode. Available when `CHIP_CONFIG_ENABLE_ICD_SERVER` is enabled. | | ||
| | `OnTransitionToIdleImpl` | `OnTransitionToIdle` | Logs the transition while the ICD server moves to idle mode. Available when `CHIP_CONFIG_ENABLE_ICD_SERVER` is enabled. | | ||
| | `OnICDModeChangeImpl` | `OnICDModeChange` | Logs changes between Short Idle Time (SIT) and Long Idle Time (LIT) operating modes. Available when `CHIP_CONFIG_ENABLE_ICD_SERVER` is enabled. | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Closure Application Override APIs | ||
|
|
||
| To override any of the following AppTask hooks, declare the corresponding `*Impl()` method in `CustomerAppTask.h` and implement it in `CustomerAppTask.cpp`. Ensure that the method signature matches the declaration in `autogen/AppTaskImpl.h`. | ||
|
|
||
| ## AppTask | ||
|
|
||
| | Override | Public API | Default behavior | | ||
| |---|---|---| | ||
| | `AppInitImpl` | `AppInit` | Registers the button callback, initializes the display, and initializes Closure Manager. | | ||
| | `ButtonEventHandlerImpl` | `ButtonEventHandler` | Routes closure button presses to `ClosureButtonActionEventHandler` and function button events to the base application handler. | | ||
| | `ClosureButtonActionEventHandlerImpl` | `ClosureButtonActionEventHandler` | Stops motion if a closure action is in progress; otherwise, it starts a MoveTo toward the opposite position. | | ||
| | `DMPostAttributeChangeCallbackImpl` | `DMPostAttributeChangeCallback` | Logs Identify attribute changes. | | ||
| | `DMClosureControlClusterAttributeChangedCallbackImpl` | `DMClosureControlClusterAttributeChangedCallback` | Refreshes the UI when Closure Control `MainState` or `OverallCurrentState` changes. | | ||
| | `DMClosureDimensionClusterAttributeChangedCallbackImpl` | `DMClosureDimensionClusterAttributeChangedCallback` | Logs Closure Dimension attribute changes. | | ||
|
|
||
| ## ClosureManager | ||
|
|
||
| These APIs use the Closure app's separate manager override chain. Declare and | ||
| implement the corresponding `*Impl()` methods in `CustomerAppManager`, which | ||
| derives from `ClosureManagerImpl<CustomerAppManager>`. Use | ||
| `autogen/ClosureManagerImpl.h` for exact signatures. Do not place these | ||
| overrides in `CustomerAppTask`. | ||
|
|
||
| | Override | Public API | Default behavior | | ||
| |---|---|---| | ||
| | `InitImpl` | `Init` | Initializes the closure timer, closure endpoints, and panel endpoints. | | ||
| | `OnCalibrateCommandImpl` | `OnCalibrateCommand` | Validates and starts an asynchronous closure calibration. | | ||
| | `OnMoveToCommandImpl` | `OnMoveToCommand` | Validates a MoveTo command and sets overall panel targets. | | ||
| | `OnStopCommandImpl` | `OnStopCommand` | Stops the active closure operation and completes the stop action. | | ||
| | `OnSetTargetCommandImpl` | `OnSetTargetCommand` | Validates a SetTarget command and sets the selected panel target. | | ||
| | `OnStepCommandImpl` | `OnStepCommand` | Validates a Step command and sets the selected panel step target. | | ||
| | `HandleClosureActionCompleteImpl` | `HandleClosureActionComplete` | Finalizes a completed calibrate, stop, move, or unlatch action. | | ||
| | `HandleClosureMotionActionImpl` | `HandleClosureMotionAction` | Advances closure panels toward their target positions. | | ||
| | `HandleClosureUnlatchActionImpl` | `HandleClosureUnlatchAction` | Updates closure and panel states for an unlatch action. | | ||
| | `GetPanelNextPositionImpl` | `GetPanelNextPosition` | Calculates the next position between a panel's current and target positions. | | ||
| | `HandlePanelSetTargetActionImpl` | `HandlePanelSetTargetAction` | Advances one panel toward a SetTarget position. | | ||
| | `HandlePanelUnlatchActionImpl` | `HandlePanelUnlatchAction` | Updates one panel for an unlatch action. | | ||
| | `HandlePanelStepActionImpl` | `HandlePanelStepAction` | Applies a Step action to one panel. | |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.