Modules#
EmberAfPluginDoorLockServerLogEntry
EmberAfPluginDoorLockServerUser
EmberAfPluginDoorLockServerWeekdayScheduleEntry
EmberAfPluginDoorLockServerYeardayScheduleEntry
EmberAfPluginDoorLockServerHolidayScheduleEntry
EmberAfPluginDoorLockServerDisposableScheduleEntry
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.
API#
Add a log entry. Returns true if the entry was added. Note that the eventId parameter should be of type EmberAfDoorLockOperationEventCode or EmberAfDoorLockProgrammingEventCode.
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.
Unlocks the door with a pin.
Unlocks the door with RFID.
Macros#
API Documentation#
emberAfPluginDoorLockServerAddLogEntry#
bool emberAfPluginDoorLockServerAddLogEntry (EmberAfDoorLockEventType eventType, EmberAfDoorLockEventSource 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 EmberAfDoorLockOperationEventCode or EmberAfDoorLockProgrammingEventCode.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfDoorLockEventType | N/A | eventType | Event type Ver.: always |
| EmberAfDoorLockEventSource | 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
emberAfPluginDoorLockServerGetLogEntry#
bool emberAfPluginDoorLockServerGetLogEntry (uint16_t * entryId, EmberAfPluginDoorLockServerLogEntry * 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 |
| EmberAfPluginDoorLockServerLogEntry * | N/A | entry | pointer to log entry struct Ver.: always |
Returns
bool true if success
emberAfPluginDoorLockServerApplyPin#
EmberAfStatus emberAfPluginDoorLockServerApplyPin (uint8_t * pin, uint8_t pinLength)
Unlocks 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
EmberAfStatus status code
emberAfPluginDoorLockServerApplyRfid#
EmberAfStatus emberAfPluginDoorLockServerApplyRfid (uint8_t * rfid, uint8_t rfidLength)
Unlocks the door with RFID.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | N/A | rfid | Ver.: always |
| uint8_t | N/A | rfidLength | Ver.: always |
Returns
EmberAfStatus status code