Door Lock Server#
API and Callbacks for the Door Lock Cluster Server Component.
Silicon Labs implementation of the Door Lock server cluster. This is an incomplete component implementation. It does all of the mandatory and optional behavior in the Door Lock cluster needed to pass the Door Lock cluster tests. It does not store user and schedule tables in persistent memory, check user pin activation against user status or user schedule, or offer callbacks and component options to the application for further customization of functionality.
Modules#
sl_zigbee_af_plugin_door_lock_server_log_entry_t
sl_zigbee_af_plugin_door_lock_server_user_t
sl_zigbee_af_plugin_door_lock_server_weekday_schedule_entry_t
sl_zigbee_af_plugin_door_lock_server_yearday_schedule_entry_t
sl_zigbee_af_plugin_door_lock_server_holiday_schedule_entry_t
sl_zigbee_af_plugin_door_lock_server_disposable_schedule_entry_t
API#
Add a log entry. Returns true if the entry was added. Note that the eventId parameter should be of type sl_zigbee_af_door_lock_operation_event_code_t or sl_zigbee_af_door_lock_programming_event_code_t.
Get a log entry associated with the entry ID. If the entry ID does not exist, the most recent entry is returned and the entryId parameter is updated. The entryId is a 1-based index into an array of log entries in order to match GetLogRecord ZCL command. This will return true if the entry was successfully returned.
Unlock the door with a pin.
Unlock the door with RFID.
Macros#
API Documentation#
sl_zigbee_af_door_lock_server_add_log_entry#
bool sl_zigbee_af_door_lock_server_add_log_entry (sl_zigbee_af_door_lock_event_type_t eventType, sl_zigbee_af_door_lock_event_source_t source, uint8_t eventId, uint16_t userId, uint8_t pinLength, uint8_t * pin)
Add a log entry. Returns true if the entry was added. Note that the eventId parameter should be of type sl_zigbee_af_door_lock_operation_event_code_t or sl_zigbee_af_door_lock_programming_event_code_t.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_door_lock_event_type_t | N/A | eventType | Event type Ver.: always |
| sl_zigbee_af_door_lock_event_source_t | N/A | source | Event source Ver.: always |
| uint8_t | N/A | eventId | Ver.: always |
| uint16_t | N/A | userId | Ver.: always |
| uint8_t | N/A | pinLength | Ver.: always |
| uint8_t * | N/A | pin | Ver.: always |
Returns
bool true if success
sl_zigbee_af_door_lock_server_get_log_entry#
bool sl_zigbee_af_door_lock_server_get_log_entry (uint16_t * entryId, sl_zigbee_af_plugin_door_lock_server_log_entry_t * entry)
Get a log entry associated with the entry ID. If the entry ID does not exist, the most recent entry is returned and the entryId parameter is updated. The entryId is a 1-based index into an array of log entries in order to match GetLogRecord ZCL command. This will return true if the entry was successfully returned.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t * | N/A | entryId | Ver.: always |
| sl_zigbee_af_plugin_door_lock_server_log_entry_t * | N/A | entry | pointer to log entry struct Ver.: always |
Returns
bool true if success
sl_zigbee_af_door_lock_server_apply_pin#
sl_zigbee_af_status_t sl_zigbee_af_door_lock_server_apply_pin (uint8_t * pin, uint8_t pinLength)
Unlock the door with a pin.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | N/A | pin | Ver.: always |
| uint8_t | N/A | pinLength | Ver.: always |
Returns
sl_zigbee_af_status_t status code
sl_zigbee_af_door_lock_server_apply_rfid#
sl_zigbee_af_status_t sl_zigbee_af_door_lock_server_apply_rfid (uint8_t * rfid, uint8_t rfidLength)
Unlock the door with RFID.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | N/A | rfid | Ver.: always |
| uint8_t | N/A | rfidLength | Ver.: always |
Returns
sl_zigbee_af_status_t status code