Lock 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 |
|---|---|---|
|
| Registers the button callback, initializes the lock, and synchronizes the Door Lock cluster state. |
|
| Initializes the lock state, credential storage, actuator timers, and the Door Lock server. |
|
| Routes lock-action and function-button events. |
|
| Converts a lock-button press into a lock or unlock action. |
|
| Schedules the transition from the unlatched state to the unlocked state when the unlatch timer expires. |
|
| Completes the actuator movement, updates the Door Lock state, and processes any pending request. |
|
| Starts the lock, unlock, or unlatch action carried by an application event. |
|
| Drains a staged Door Lock request and passes it to the application task. |
|
| Queues, completes, or starts a Door Lock request according to actuator state. |
|
| Changes an unlatched lock to the unlocked state and stages an unlock request. |
|
| Responds to Door Lock |
|
| Validates a Lock command and stages a request for the locked state. |
|
| Validates an Unlock command and stages an unlock or unlatch request, depending on Unbolt support. |
|
| Validates an Unbolt command and stages a request for the unlocked state. |
|
| Retrieves credential data for the Door Lock server. |
|
| Persists credential data for the Door Lock server. |
|
| Retrieves user data for the Door Lock server. |
|
| Persists user data for the Door Lock server. |
|
| Retrieves a user's weekday schedule. |
|
| Persists a user's weekday schedule. |
|
| Retrieves a user's year-day schedule. |
|
| Persists a user's year-day schedule. |
|
| Retrieves a holiday schedule. |
|
| Persists a holiday schedule. |
|
| Starts a lock action when automatic relocking occurs. |