Door Lock Server Callbacks

Collaboration diagram for Door Lock Server Callbacks:

Functions
void	tr_door_lock_server_init_cb (void)
	Callback fires when the door lock server cluster plugin is initialized.
zb_bool_t	tr_door_lock_server_lock_door_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t *pin_code)
	Callback that user can declare to handle door lock cluster lock door command.
zb_bool_t	tr_door_lock_server_unlock_door_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t *pin_code)
	Callback that user can declare to handle door lock cluster unlock door command.
zb_bool_t	tr_door_lock_server_set_pin_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint16_t user_id, zb_uint8_t user_status, zb_uint8_t user_type, zb_uint8_t *pin_code)
	Callback that user can declare to handle door lock cluster set pin command.
zb_bool_t	tr_door_lock_server_get_pin_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint16_t user_id)
	Callback that user can declare to handle door lock cluster get pin command.
zb_bool_t	tr_door_lock_server_clear_pin_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint16_t user_id)
	Callback that user can declare to handle door lock cluster clear pin command.
zb_bool_t	tr_door_lock_server_clear_all_pins_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle door lock cluster clear all pins command.
zb_bool_t	tr_door_lock_server_set_user_status_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint16_t user_id, zb_uint8_t user_status)
	Callback that user can declare to handle door lock cluster set user status command.
zb_bool_t	tr_door_lock_server_get_user_status_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint16_t user_id)
	Callback that user can declare to handle door lock cluster get user status command.
zb_bool_t	tr_door_lock_server_set_user_type_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint16_t user_id, zb_uint8_t user_type)
	Callback that user can declare to handle door lock cluster set user type command.
zb_bool_t	tr_door_lock_server_get_user_type_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint16_t user_id)
	Callback that user can declare to handle door lock cluster get user type command.
void	tr_door_lock_server_write_attr_cb (zb_uint8_t endpoint, zb_uint16_t attr_id, zb_uint8_t *new_value, zb_uint16_t manuf_code)
	Callback fires when a door lock server attribute is about to be written.

Detailed Description

---

---

Function Documentation

tr_door_lock_server_clear_all_pins_cb()

zb_bool_t tr_door_lock_server_clear_all_pins_cb

(

zb_zcl_parsed_hdr_t *

cmd_info

)

Callback that user can declare to handle door lock cluster clear all pins command.

Parameters

cmd_info

struct that contains zcl header info

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_clear_pin_cb()

zb_bool_t tr_door_lock_server_clear_pin_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint16_t	user_id )

Callback that user can declare to handle door lock cluster clear pin command.

Parameters

cmd_info	struct that contains zcl header info
user_id	user id for pin to clear

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_get_pin_cb()

zb_bool_t tr_door_lock_server_get_pin_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint16_t	user_id )

Callback that user can declare to handle door lock cluster get pin command.

Parameters

cmd_info	struct that contains zcl header info
user_id	user id for pin to return

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_get_user_status_cb()

zb_bool_t tr_door_lock_server_get_user_status_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint16_t	user_id )

Callback that user can declare to handle door lock cluster get user status command.

Parameters

cmd_info	struct that contains zcl header info
user_id	user id for status to get

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_get_user_type_cb()

zb_bool_t tr_door_lock_server_get_user_type_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint16_t	user_id )

Callback that user can declare to handle door lock cluster get user type command.

Parameters

cmd_info	struct that contains zcl header info
user_id	user id for type to get

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_init_cb()

void tr_door_lock_server_init_cb

(

void

)

Callback fires when the door lock server cluster plugin is initialized.

tr_door_lock_server_lock_door_cb()

zb_bool_t tr_door_lock_server_lock_door_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t *	pin_code )

Callback that user can declare to handle door lock cluster lock door command.

Parameters

cmd_info	struct that contains zcl header info
pin_code	pointer to the pin code octect string

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_set_pin_cb()

zb_bool_t tr_door_lock_server_set_pin_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint16_t	user_id,
		zb_uint8_t	user_status,
		zb_uint8_t	user_type,
		zb_uint8_t *	pin_code )

Callback that user can declare to handle door lock cluster set pin command.

Parameters

cmd_info	struct that contains zcl header info
user_id	id of the user for this pin code
user_status	status for this pin code
user_type	type for this pin code
pin_code	pointer to the pin code

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_set_user_status_cb()

zb_bool_t tr_door_lock_server_set_user_status_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint16_t	user_id,
		zb_uint8_t	user_status )

Callback that user can declare to handle door lock cluster set user status command.

Parameters

cmd_info	struct that contains zcl header info
user_id	user id for status to set
user_status	status to set

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_set_user_type_cb()

zb_bool_t tr_door_lock_server_set_user_type_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint16_t	user_id,
		zb_uint8_t	user_type )

Callback that user can declare to handle door lock cluster set user type command.

Parameters

cmd_info	struct that contains zcl header info
user_id	user id for type to set
user_type	type to set

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_unlock_door_cb()

zb_bool_t tr_door_lock_server_unlock_door_cb	(	zb_zcl_parsed_hdr_t *	cmd_info,
		zb_uint8_t *	pin_code )

Callback that user can declare to handle door lock cluster unlock door command.

Parameters

cmd_info	struct that contains zcl header info
pin_code	pointer to the pin code octect string

Returns

ZB_FALSE to allow framework to continue processing the command

tr_door_lock_server_write_attr_cb()

void tr_door_lock_server_write_attr_cb	(	zb_uint8_t	endpoint,
		zb_uint16_t	attr_id,
		zb_uint8_t *	new_value,
		zb_uint16_t	manuf_code )

Callback fires when a door lock server attribute is about to be written.

Parameters

endpoint	device endpoint
attr_id	ZCL attribute id
new_value	pointer to the new attribute value
manuf_code	manufacturer specific code