ZigPC ZCL Command Parser

Listen to ZCL command messages received by Protocol Controller from its PAN nodes. More...

Modules
	ZigPC ZCL Command Parser Internal API
	Internal API for Command Parser logic.

Classes
struct	zigpc_zclcmdparse_identify_identify_query_response_t
	Data for Identify/IdentifyQueryResponse command. More...
struct	zigpc_zclcmdparse_groups_add_group_response_t
	Data for Groups/AddGroupResponse command. More...
struct	zigpc_zclcmdparse_groups_view_group_response_t
	Data for Groups/ViewGroupResponse command. More...
struct	zigpc_zclcmdparse_groups_get_group_membership_response_t
	Data for Groups/GetGroupMembershipResponse command. More...
struct	zigpc_zclcmdparse_groups_remove_group_response_t
	Data for Groups/RemoveGroupResponse command. More...
struct	zigpc_zclcmdparse_poll_control_check_in_response_t
	Data for PollControl/CheckInResponse command. More...
struct	zigpc_zclcmdparse_poll_control_fast_poll_stop_t
	Data for PollControl/FastPollStop command. More...
struct	zigpc_zclcmdparse_poll_control_set_long_poll_interval_t
	Data for PollControl/SetLongPollInterval command. More...
struct	zigpc_zclcmdparse_poll_control_set_short_poll_interval_t
	Data for PollControl/SetShortPollInterval command. More...
struct	zigpc_zclcmdparse_door_lock_lock_door_response_t
	Data for DoorLock/LockDoorResponse command. More...
struct	zigpc_zclcmdparse_door_lock_unlock_door_response_t
	Data for DoorLock/UnlockDoorResponse command. More...
struct	zigpc_zclcmdparse_door_lock_toggle_response_t
	Data for DoorLock/ToggleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_unlock_with_timeout_response_t
	Data for DoorLock/UnlockWithTimeoutResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_log_record_response_t
	Data for DoorLock/GetLogRecordResponse command. More...
struct	zigpc_zclcmdparse_door_lock_set_pin_code_response_t
	Data for DoorLock/SetPINCodeResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_pin_code_response_t
	Data for DoorLock/GetPINCodeResponse command. More...
struct	zigpc_zclcmdparse_door_lock_clear_pin_code_response_t
	Data for DoorLock/ClearPINCodeResponse command. More...
struct	zigpc_zclcmdparse_door_lock_clear_all_pin_codes_response_t
	Data for DoorLock/ClearAllPINCodesResponse command. More...
struct	zigpc_zclcmdparse_door_lock_set_user_status_response_t
	Data for DoorLock/SetUserStatusResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_user_status_response_t
	Data for DoorLock/GetUserStatusResponse command. More...
struct	zigpc_zclcmdparse_door_lock_set_weekday_schedule_response_t
	Data for DoorLock/SetWeekdayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_weekday_schedule_response_t
	Data for DoorLock/GetWeekdayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_clear_weekday_schedule_response_t
	Data for DoorLock/ClearWeekdayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_set_year_day_schedule_response_t
	Data for DoorLock/SetYearDayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_year_day_schedule_response_t
	Data for DoorLock/GetYearDayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_clear_year_day_schedule_response_t
	Data for DoorLock/ClearYearDayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_set_holiday_schedule_response_t
	Data for DoorLock/SetHolidayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_holiday_schedule_response_t
	Data for DoorLock/GetHolidayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_clear_holiday_schedule_response_t
	Data for DoorLock/ClearHolidayScheduleResponse command. More...
struct	zigpc_zclcmdparse_door_lock_set_user_type_response_t
	Data for DoorLock/SetUserTypeResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_user_type_response_t
	Data for DoorLock/GetUserTypeResponse command. More...
struct	zigpc_zclcmdparse_door_lock_set_rfid_code_response_t
	Data for DoorLock/SetRFIDCodeResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_rfid_code_response_t
	Data for DoorLock/GetRFIDCodeResponse command. More...
struct	zigpc_zclcmdparse_door_lock_clear_rfid_code_response_t
	Data for DoorLock/ClearRFIDCodeResponse command. More...
struct	zigpc_zclcmdparse_door_lock_clear_all_rfid_codes_response_t
	Data for DoorLock/ClearAllRFIDCodesResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_user_response_t
	Data for DoorLock/GetUserResponse command. More...
struct	zigpc_zclcmdparse_door_lock_operating_event_notification_t
	Data for DoorLock/OperatingEventNotification command. More...
struct	zigpc_zclcmdparse_door_lock_programming_event_notification_t
	Data for DoorLock/ProgrammingEventNotification command. More...
struct	zigpc_zclcmdparse_door_lock_set_credential_response_t
	Data for DoorLock/SetCredentialResponse command. More...
struct	zigpc_zclcmdparse_door_lock_get_credential_status_response_t
	Data for DoorLock/GetCredentialStatusResponse command. More...
struct	zigpc_zclcmdparse_thermostat_get_weekly_schedule_response_t
	Data for Thermostat/GetWeeklyScheduleResponse command. More...
struct	zigpc_zclcmdparse_thermostat_get_relay_status_log_response_t
	Data for Thermostat/GetRelayStatusLogResponse command. More...
struct	zigpc_zclcmdparse_ias_zone_zone_status_change_notification_t
	Data for IASZone/ZoneStatusChangeNotification command. More...
struct	zigpc_zclcmdparse_ias_zone_zone_enroll_request_t
	Data for IASZone/ZoneEnrollRequest command. More...
struct	zigpc_zclcmdparse_electrical_measurement_get_profile_info_t
	Data for ElectricalMeasurement/GetProfileInfo command. More...
struct	zigpc_zclcmdparse_electrical_measurement_get_measurement_profile_t
	Data for ElectricalMeasurement/GetMeasurementProfile command. More...
union	zigpc_zclcmdparse_callback_data_t
	Container for the different types of command data that can be received. More...

Typedefs
typedef void(*	zigpc_zclcmdparse_callback_t) (const zigbee_eui64_t eui64, const zigbee_endpoint_id_t endpoint, const zigpc_zclcmdparse_callback_data_t *data)

Functions
sl_status_t	zigpc_zclcmdparse_setup (void)
	Initialize the command parser component. This function should Listen to gateway cluster commands received and initialize logic to parse the incoming messages. More...
sl_status_t	zigpc_zclcmdparse_register_callback (zcl_cluster_id_t cluster_id, zcl_command_id_t command_id, zigpc_zclcmdparse_callback_t callback)
	Register a callback when a particular command is parsed based on the ZCL Cluster ID + ZCL Command ID values passed in. More...
sl_status_t	zigpc_zclcmdparse_remove_callback (zcl_cluster_id_t cluster_id, zcl_command_id_t command_id, zigpc_zclcmdparse_callback_t callback)
	Remove a registered callback when a particular command is parsed based on the ZCL Cluster ID + ZCL Command ID values passed in. More...

Detailed Description

Listen to ZCL command messages received by Protocol Controller from its PAN nodes.

This component allows other components to listen to ZCL cluster command specific messages sent by PAN nodes to the Protocol Controller. This is done by using ZAP to generate the supported cluster and command handlers. If a callback is registered to a particular cluster/command combination the registered callback will be called with the associated command data.

Typedef Documentation

zigpc_zclcmdparse_callback_t

typedef void(* zigpc_zclcmdparse_callback_t) (const zigbee_eui64_t eui64, const zigbee_endpoint_id_t endpoint, const zigpc_zclcmdparse_callback_data_t *data)

Parameters

eui64	Device identifier
endpoint	Device endpoint identifier
data	Command data

Function Documentation

zigpc_zclcmdparse_register_callback()

sl_status_t zigpc_zclcmdparse_register_callback	(	zcl_cluster_id_t	cluster_id,
		zcl_command_id_t	command_id,
		zigpc_zclcmdparse_callback_t	callback
	)

Register a callback when a particular command is parsed based on the ZCL Cluster ID + ZCL Command ID values passed in.

Parameters

cluster_id	ZCL cluster ID value.
cluster_id	ZCL command ID value.
callback	Pointer to function that receives this type of callback.

Returns

sl_status_t SL_STATUS_OK if registration is successful. Error if not.

zigpc_zclcmdparse_remove_callback()

sl_status_t zigpc_zclcmdparse_remove_callback	(	zcl_cluster_id_t	cluster_id,
		zcl_command_id_t	command_id,
		zigpc_zclcmdparse_callback_t	callback
	)

Remove a registered callback when a particular command is parsed based on the ZCL Cluster ID + ZCL Command ID values passed in.

Parameters

cluster_id	ZCL cluster ID value.
cluster_id	ZCL command ID value.
callback	Pointer to function that receives this type of callback.

Returns

sl_status_t SL_STATUS_OK if registration is successful. Error if not.

zigpc_zclcmdparse_setup()

sl_status_t zigpc_zclcmdparse_setup

(

void

)

Initialize the command parser component. This function should Listen to gateway cluster commands received and initialize logic to parse the incoming messages.

Returns

sl_status_t SL_STATUS_OK if initialization is successful. Error if not.