Developing with ZBOSS for Zigbee
Data Structures | |
| struct | zb_zll_commissioning_scan_req_s |
| Parsed Scan request payload representation. More... | |
| struct | zb_zll_commissioning_ep_info_s |
| Endpoint information for parsed Commissioning.ScanResponse representation. More... | |
| struct | zb_zll_commissioning_scan_res_s |
| Parsed Commissioning.ScanResponse structure. More... | |
| struct | zb_zll_commissioning_device_information_req_s |
| Parsed Commissioning.DeviceInformationRequest payload. More... | |
| struct | zb_zll_commissioning_device_information_common_res_s |
| Parsed permanent part of the Commissioning.DeviceInformationResponse payload. More... | |
| struct | zb_zll_commissioning_device_information_ep_info_res_s |
| Parsed device information record from the Commissioning.DeviceInformationResponse payload. More... | |
| struct | zb_zll_commissioning_identify_req_s |
| Parsed Commissioning.IdentifyRequest payload. More... | |
| struct | zb_zll_commissioning_identify_req_param_s |
| Identify request parameters. More... | |
| struct | zb_zll_commissioning_reset_to_fn_s |
| Parsed Commissioning.ResetToFactoryNewRequest payload. More... | |
| struct | zb_zll_commissioning_network_start_req_s |
| Parsed Commissioning.NetworkStartRequest payload. More... | |
| struct | zb_zll_commissioning_network_start_res_s |
| Parsed Commissioning.NetworkStartResponse payload. More... | |
| struct | zb_zll_commissioning_network_join_router_req_s |
| Parsed Commissioning.NetworkJoinRouterRequest payload. More... | |
| struct | zb_zll_commissioning_network_join_router_res_s |
| Parsed Commissioning.NetworkJoinRouterResponse payload. More... | |
| struct | zb_zll_commissioning_network_join_end_device_req_s |
| Parsed Commissioning.NetworkJoinEndDeviceRequest payload. More... | |
| struct | zb_zll_commissioning_network_join_end_device_res_s |
| Parsed Commissioning.NetworkJoinEndDeviceResponse payload. More... | |
| struct | zb_zll_commissioning_network_update_req_s |
| Parsed Commissioning.NetworkUpdateRequest payload. More... | |
| struct | zb_zll_commissioning_get_group_ids_req_s |
| Parsed Commissioning.GetGroupIdentifiersRequest payload. More... | |
| struct | zb_zll_commissioning_get_group_ids_res_permanent_s |
| Parsed Commissioning.GetGroupIdentifiersResponse payload. More... | |
| struct | zb_zll_commissioning_group_info_record_s |
| Group information record for Commissioning.GetGroupIdentifiersResponse command. More... | |
| struct | zb_zll_commissioning_get_endpoint_list_req_s |
| Parsed Commissioning.GetEndpointListRequest payload. More... | |
| struct | zb_zll_commissioning_get_endpoint_list_res_s |
| Parsed Commissioning.GetEndpointListResponse payload. More... | |
| struct | zb_zll_commissioning_endpoint_info_record_s |
| Endpoint information record for Commissioning.GetEndpointListResponse command. More... | |
| struct | zb_zll_commissioning_endpoint_information_s |
| Parsed Commissioning.EndpointInformation payload. More... | |
Macros | |
| #define | ZB_ZCL_TOUCHLINK_COMMISSIONING_CLUSTER_REVISION_DEFAULT ((zb_uint16_t)0x0003u) |
| Default value for Touchlink Commissioning cluster revision global attribute. More... | |
| #define | ZB_ZCL_DECLARE_TOUCHLINK_COMMISSIONING_ATTR_LIST(attr_list) |
| Declare attribute list for Touchlink Commissioning cluster (only cluster revision attribute) More... | |
| #define | ZB_ZLL_PRIMARY_CHANNEL_MASK ((1l << 11) | (1l << 15) | (1l << 20) | (1l << 25)) |
| First primary Touchlink channels mask. More... | |
| #define | ZB_ZLL_MIN_ADDR_RANGE 100 |
| Configurable parameters: minimum address range that maybe assigned during commissioning. More... | |
| #define | ZB_ZLL_DEFAULT_ADDR_RANGE 1000 |
| Configurable parameters: default address range that is assigned during commissioning. More... | |
| #define | ZB_ZLL_MIN_GROUP_ID_RANGE 100 |
| Configurable parameters: minimum group id range that maybe assigned during commissioning. More... | |
| #define | ZB_ZLL_DEFAULT_GROUP_ID_RANGE 1000 |
| Configurable parameters: default group id range that is assigned during commissioning. More... | |
| #define | ZB_ZLL_APLC_INTRP_TRANSID_LIFETIME ( ZB_MILLISECONDS_TO_BEACON_INTERVAL(8000)) |
| aplcInterPANTransIdLifetime constant value. More... | |
| #define | ZB_ZLL_APLC_SCAN_TIME_BASE_DURATION ( ZB_MILLISECONDS_TO_BEACON_INTERVAL(250)) |
| aplcScanTimeBaseDuration constant value. More... | |
| #define | ZB_ZLL_APLC_RX_WINDOW_DURATION (ZB_MILLISECONDS_TO_BEACON_INTERVAL(5000)) |
| aplcRxWindowDuration constant value. More... | |
| #define | ZB_ZLL_APLC_MIN_STARTUP_DELAY_TIME (ZB_MILLISECONDS_TO_BEACON_INTERVAL(2000)) |
| aplcMinStartupDelayTime constant value. More... | |
| #define | ZB_ZLL_REPORT_ATTR_COUNT 0 |
Touchlink Commissioning cluster commands | |
| enum | zb_zll_commissioning_touchlink_cmd_e { ZB_ZLL_CMD_COMMISSIONING_SCAN_REQ = 0x00, ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_REQ = 0x02, ZB_ZLL_CMD_COMMISSIONING_IDENTIFY_REQ = 0x06, ZB_ZLL_CMD_COMMISSIONING_RESET_TO_FACTORY_NEW_REQ = 0x07, ZB_ZLL_CMD_COMMISSIONING_NETWORK_START_REQ = 0x10, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_REQ = 0x12, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_REQ = 0x14, ZB_ZLL_CMD_COMMISSIONING_NETWORK_UPDATE_REQ = 0x16 } |
| Touchlink commissioning cluster command identifiers. More... | |
| enum | zb_zll_commissioning_utility_cmd_e { ZB_ZLL_CMD_COMMISSIONING_GET_GROUP_IDENTIFIERS_REQUEST = 0x41, ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_REQUEST = 0x42 } |
| Touchlink commissioning cluster utility command identifiers. More... | |
| enum | zb_zll_commissioning_touchlink_cmd_resp_e { ZB_ZLL_CMD_COMMISSIONING_SCAN_RES = 0x01, ZB_ZLL_CMD_COMMISSIONING_DEVICE_INFORMATION_RES = 0x03, ZB_ZLL_CMD_COMMISSIONING_NETWORK_START_RES = 0x11, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_ROUTER_RES = 0x13, ZB_ZLL_CMD_COMMISSIONING_NETWORK_JOIN_END_DEVICE_RES = 0x15 } |
| Touchlink commissioning cluster response command identifiers. More... | |
| enum | zb_zll_commissioning_utility_cmd_resp_e { ZB_ZLL_CMD_COMMISSIONING_ENDPOINT_INFORMATION = 0x40, ZB_ZLL_CMD_COMMISSIONING_GET_GROUP_IDENTIFIERS_RESPONSE = 0x41, ZB_ZLL_CMD_COMMISSIONING_GET_ENDPOINT_LIST_RESPONSE = 0x42 } |
| Touchlink commissioning cluster utility response command identifiers. More... | |
| enum | zb_zll_info_e { ZB_ZLL_INFO_FACTORY_NEW = 0x01, ZB_ZLL_INFO_ADDR_ASSIGNMENT = 0x02, ZB_ZLL_INFO_TOUCHLINK_INITIATOR = 0x10, ZB_ZLL_INFO_TOUCHLINK_PRIOR = 0x20 } |
| Touchlink information bit values. More... | |
| typedef struct zb_zll_commissioning_scan_req_s | zb_zll_commissioning_scan_req_t |
| Parsed Scan request payload representation. More... | |
| typedef struct zb_zll_commissioning_ep_info_s | zb_zll_commissioning_ep_info_t |
| Endpoint information for parsed Commissioning.ScanResponse representation. More... | |
| typedef struct zb_zll_commissioning_scan_res_s | zb_zll_commissioning_scan_res_t |
| Parsed Commissioning.ScanResponse structure. More... | |
| typedef struct zb_zll_commissioning_device_information_req_s | zb_zll_commissioning_device_information_req_t |
| Parsed Commissioning.DeviceInformationRequest payload. More... | |
| typedef struct zb_zll_commissioning_device_information_common_res_s | zb_zll_commissioning_device_information_common_res_t |
| Parsed permanent part of the Commissioning.DeviceInformationResponse payload. More... | |
| typedef struct zb_zll_commissioning_device_information_ep_info_res_s | zb_zll_commissioning_device_information_ep_info_res_t |
| Parsed device information record from the Commissioning.DeviceInformationResponse payload. More... | |
| typedef struct zb_zll_commissioning_identify_req_s | zb_zll_commissioning_identify_req_t |
| Parsed Commissioning.IdentifyRequest payload. More... | |
| typedef struct zb_zll_commissioning_identify_req_param_s | zb_zll_commissioning_identify_req_param_t |
| Identify request parameters. More... | |
| typedef struct zb_zll_commissioning_reset_to_fn_s | zb_zll_commissioning_reset_to_fn_t |
| Parsed Commissioning.ResetToFactoryNewRequest payload. More... | |
| typedef struct zb_zll_commissioning_network_start_req_s | zb_zll_commissioning_network_start_req_t |
| Parsed Commissioning.NetworkStartRequest payload. More... | |
| typedef struct zb_zll_commissioning_network_start_res_s | zb_zll_commissioning_network_start_res_t |
| Parsed Commissioning.NetworkStartResponse payload. More... | |
| typedef struct zb_zll_commissioning_network_join_router_req_s | zb_zll_commissioning_network_join_router_req_t |
| Parsed Commissioning.NetworkJoinRouterRequest payload. More... | |
| typedef struct zb_zll_commissioning_network_join_router_res_s | zb_zll_commissioning_network_join_router_res_t |
| Parsed Commissioning.NetworkJoinRouterResponse payload. More... | |
| typedef struct zb_zll_commissioning_network_join_end_device_req_s | zb_zll_commissioning_network_join_end_device_req_t |
| Parsed Commissioning.NetworkJoinEndDeviceRequest payload. More... | |
| typedef struct zb_zll_commissioning_network_join_end_device_res_s | zb_zll_commissioning_network_join_end_device_res_t |
| Parsed Commissioning.NetworkJoinEndDeviceResponse payload. More... | |
| typedef struct zb_zll_commissioning_network_update_req_s | zb_zll_commissioning_network_update_req_t |
| Parsed Commissioning.NetworkUpdateRequest payload. More... | |
| typedef struct zb_zll_commissioning_get_group_ids_req_s | zb_zll_commissioning_get_group_ids_req_t |
| Parsed Commissioning.GetGroupIdentifiersRequest payload. More... | |
| typedef struct zb_zll_commissioning_get_group_ids_res_permanent_s | zb_zll_commissioning_get_group_ids_res_permanent_t |
| Parsed Commissioning.GetGroupIdentifiersResponse payload. More... | |
| typedef struct zb_zll_commissioning_group_info_record_s | zb_zll_commissioning_group_info_record_t |
| Group information record for Commissioning.GetGroupIdentifiersResponse command. More... | |
| typedef struct zb_zll_commissioning_get_endpoint_list_req_s | zb_zll_commissioning_get_endpoint_list_req_t |
| Parsed Commissioning.GetEndpointListRequest payload. More... | |
| typedef struct zb_zll_commissioning_get_endpoint_list_res_s | zb_zll_commissioning_get_endpoint_list_res_t |
| Parsed Commissioning.GetEndpointListResponse payload. More... | |
| typedef struct zb_zll_commissioning_endpoint_info_record_s | zb_zll_commissioning_endpoint_info_record_t |
| Endpoint information record for Commissioning.GetEndpointListResponse command. More... | |
| typedef struct zb_zll_commissioning_endpoint_information_s | zb_zll_commissioning_endpoint_information_t |
| Parsed Commissioning.EndpointInformation payload. More... | |
| zb_uint8_t | zb_zll_get_info_current_value (void) |
| Get Touchlink Info current value. More... | |
| void | zb_zll_commissioning_send_scan_req (zb_bufid_t buffer, zb_callback_t callback) |
| Schedules Commissioning.ScanRequest sending. More... | |
| zb_ret_t | zb_zll_identify (zb_uint8_t param) |
| Sets up Identify request and schedules it for sending. Checks transaction state, identify period acceptability, fills in and schedules for sending command packet. More... | |
| #define | ZB_ZLL_ZB_INFO_CURRENT_VALUE() zb_zll_get_info_current_value() |
| #define | ZB_ZLL_DEVICE_INFO_GET_FACTORY_NEW(zll_info) ((zll_info) & ZB_ZLL_INFO_FACTORY_NEW) |
| Check is Touchlink device factory new. More... | |
| #define | ZB_ZLL_IS_FACTORY_NEW() (ZB_ZLL_DEVICE_INFO_GET_FACTORY_NEW(ZLL_DEVICE_INFO().zll_info)) |
| Check is current Touchlink device factory new. More... | |
| #define | ZB_ZLL_SET_FACTORY_NEW() (ZLL_DEVICE_INFO().zll_info |= ZB_ZLL_INFO_FACTORY_NEW) |
| Set current Touchlink device is factory new. More... | |
| #define | ZB_ZLL_CLEAR_FACTORY_NEW() (ZLL_DEVICE_INFO().zll_info &= ~ZB_ZLL_INFO_FACTORY_NEW) |
| Set current Touchlink device is not factory new. More... | |
| #define | ZB_ZLL_DEVICE_INFO_GET_ADDR_ASSIGNMENT(zll_info) ((zll_info) & ZB_ZLL_INFO_ADDR_ASSIGNMENT) |
| Check is Touchlink device capable of address assignment. More... | |
| #define | ZB_ZLL_IS_ADDR_ASSIGNMENT() (ZB_ZLL_DEVICE_INFO_GET_ADDR_ASSIGNMENT(ZLL_DEVICE_INFO().zll_info)) |
| Check is current Touchlink device capable of address assignment. More... | |
| #define | ZB_ZLL_DEVICE_INFO_GET_LINK_INITIATOR(zll_info) ((zll_info) & ZB_ZLL_INFO_TOUCHLINK_INITIATOR) |
| Check is Touchlink device a link initiator. More... | |
| #define | ZB_ZLL_IS_LINK_INITIATOR() (ZB_ZLL_DEVICE_INFO_GET_LINK_INITIATOR(ZLL_DEVICE_INFO().zll_info)) |
| Check is current Touchlink device a link initiator. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_SCAN_REQ(buffer, callback) zb_zll_commissioning_send_scan_req(buffer, callback) |
| #define | ZB_ZLL_COMMISSIONING_GET_SCAN_REQ(data_ptr, buffer, status) |
| Parses Commissioning.ScanRequest payload. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_SCAN_RES( buffer, seq_num, callback, status) |
| Schedules Commissioning.ScanResponse sending. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_SCAN_RES(data_ptr, buffer, status) |
| Parses Commissioning.ScanResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_REQ( buffer, start_index, dst_addr, callback, status) |
| Schedules sending Commissioning.DeviceInformationRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_REQ(data_ptr, buffer, status) |
| Parses Commissioning.DeviceInformationRequest. More... | |
| #define | ZB_ZLL_COMMISSIONING_DEVICE_INFO_MAX_RECORDS 0x05 |
| Maximum number of device information records in the response. More... | |
| #define | ZB_ZLL_COMMISSIONING_INIT_DEVICE_INFO_RES( buffer, data_ptr, tsn, start_index, n_devs_reported) |
| Starts filling in Commissioning.DeviceInformationResponse command. More... | |
| #define | ZB_ZLL_COMMISSIONING_ADD_EP_INFO_DEVICE_INFO_RES( data_ptr, ep_id_, profile, device, version_, n_group_ids, sort_) |
| Add next device information record into Commissioning.DeviceInformationResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_RES(buffer, data_ptr, dst_addr, callback, status) (status) = ZB_ZLL_SEND_PACKET(buffer, data_ptr, dst_addr, callback) |
| Schedules Commissioning.DeviceInformationResponse for sending. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_RES(data_ptr, buffer, status) |
| Parses Commissioning.DeviceInformationResponse permanent part. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_DEVICE_INFO_RES(data_ptr, buffer, status) |
| #define | ZB_ZLL_COMMISSIONING_SEND_IDENTIFY_REQ( buffer, p_identify_duration, ieee_addr, callback, status) |
| Schedules sending Commissioning.IdentifyRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ(data_ptr, buffer, status) |
| Parses Commissioning.IdentifyRequest. More... | |
| #define | ZB_ZLL_IDENTIFY_STOP 0 |
| "Exit identify mode" constant for Identify request. More... | |
| #define | ZB_ZLL_IDENTIFY_DEFAULT_TIME 0xffff |
| "Identify for default period" constant for Identify request. More... | |
| #define | ZB_ZLL_COMMISSIONING_FILL_IDENTIFY_REQ(buffer, address, period, status) |
| Fills in appropriate structures and starts identify request sending process. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ_PARAM(data_ptr, buffer) |
| Extract Identify request parameters from the buffer. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_RESET_TO_FN_REQ( buffer, dst_addr, callback, status) |
| Schedules sending Commissioning.ResetToFactoryNewRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_RESET_TO_FN_REQ(data_ptr, buffer, status) |
| Parses Commissioning.ResetToFactoryNewRequest. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_REQ( buffer, ext_pan_id_, key_index, encrypted_nwk_key, logical_channel, pan_id_, nwk_addr, grp_ids_begin, grp_ids_end, free_nwk_addrs_begin_, free_nwk_addrs_end_, free_group_ids_begin_, free_group_ids_end_, dst_addr, callback, status) |
| Schedules sending Commissioning.NetworkStartRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NETWORK_START_REQ(data_ptr, buffer, status) |
| Parses Commissioning.NetworkStartRequest. More... | |
| #define | ZB_ZLL_NETWORK_UPDATE_ID ((zb_uint8_t)0) |
| The only acceptable value for network update identifier field in the network start response. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_RES( buffer, seq_num, nwk_status, ext_pan_id_, pan_id_, channel_, dst_addr, callback, status_) |
| Schedules Commissioning.NetworkStartResponse sending. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NETWORK_START_RES(data_ptr, buffer, op_status) |
| Parses Commissioning.NetworkStartResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_REQ( buffer, key_index, encrypted_nwk_key, nwk_addr, grp_ids_begin, grp_ids_end, free_nwk_addrs_begin_, free_nwk_addrs_end_, free_group_ids_begin_, free_group_ids_end_, dst_addr, callback, status) |
| Schedules sending Commissioning.NetworkJoinRouterRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_REQ(data_ptr, buffer, status) |
| Parses Commissioning.NetworkJoinRouterRequest. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_RES( buffer, nwk_status, tsn, dst_addr, callback, status) |
| Schedules sending Commissioning.NetworkJoinRouterResponse command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_RES(data_ptr, buffer, op_status) |
| Parses Commissioning.NetworkJoinRouterResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_REQ( buffer, key_index, encrypted_nwk_key, logical_channel, nwk_addr, grp_ids_begin, grp_ids_end, free_nwk_addrs_begin_, free_nwk_addrs_end_, free_group_ids_begin_, free_group_ids_end_, dst_addr, callback, status) |
| Schedules sending Commissioning.NetworkJoinEndDeviceRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_REQ(data_ptr, buffer, status) |
| Parses Commissioning.NetworkJoinEndDeviceRequest. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_RES( buffer, nwk_status, tsn, dst_addr, callback, status) |
| Schedules sending Commissioning.NetworkJoinEndDeviceResponse command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_RES(data_ptr, buffer, op_status) |
| Parses Commissioning.NetworkJoinEndDeviceResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL( buffer, nwk_addr, dst_addr, logical_channel, callback, status) |
| Schedules sending Commissioning.NetworkUpdateRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ( buffer, nwk_addr, dst_addr, callback, status) |
| Schedules sending Commissioning.NetworkUpdateRequest command. (send command with current value of channel from pib cache) More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NETWORK_UPDATE_REQ(data_ptr, buffer, status) |
| Parses Commissioning.NetworkUpdateRequest. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_REQ( buffer, start_index, dst_addr, dst_ep, ep, callback) |
| Schedules sending Commissioning.GetGroupIdentifiersRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_REQ(data_ptr, buffer, status) |
| Parses Commissioning.GetGroupIdentifiersRequest. More... | |
| #define | ZB_ZLL_COMMISSIONING_GROUP_INFO_GROUP_TYPE_VALUE 0x00 |
| Group type value for group_type field of zb_zll_commissioning_group_info_record_s. More... | |
| #define | ZB_ZLL_COMMISSIONING_INIT_GET_GROUP_ID_RES( buffer, data_ptr, total_, start_index, count_, tsn) |
| Fills in mandatory part of Commissioning.GetGroupIdentifiersResponse payload. More... | |
| #define | ZB_ZLL_COMMISSIONING_ADD_GROUP_INFO_GET_GROUP_ID_RES(data_ptr, grp_id, grp_type) |
| #define | ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_RES(buffer, data_ptr, addr, dst_ep, ep, callback) |
| #define | ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_RES(data_ptr, buffer, status) |
| Parses permanent part of Commissioning.GetGroupIdentifiersResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NEXT_GROUP_INFO_GET_GROUP_ID_RES(data_ptr, buffer, status) |
| Extracts next group information record from Commissioning.GetGroupIdentifiersResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_REQ( buffer, start_index, addr, dst_ep, ep, callback) |
| Schedules sending Commissioning.GetEndpointListRequest command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_REQ(data_ptr, buffer, status) |
| Parses Commissioning.GetEndpointListRequest. More... | |
| #define | ZB_ZLL_COMMISSIONING_INIT_GET_EP_LIST_RES( buffer, total_, start_index, count_, tsn, data_ptr) |
| Fills in mandatory part of Commissioning.GetGroupIdentifiersResponse payload. More... | |
| #define | ZB_ZLL_COMMISSIONING_ADD_EP_INFO_GET_EP_LIST_RES(data_ptr, addr, ep, profile, device, version_id) |
| #define | ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_RES(buffer, data_ptr, dst_addr, dst_ep, ep, callback) |
| #define | ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_RES(data_ptr, buffer, status) |
| Parses permanent part of Commissioning.GetEndpointListResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_GET_EP_LIST_RES(data_ptr, buffer, status) |
| Extracts next endpoint information record from Commissioning.GetEndpointListResponse. More... | |
| #define | ZB_ZLL_COMMISSIONING_SEND_EP_INFO( buffer, endpoint_id, profile, device, version_, dst_addr, dst_ep, ep, callback) |
| Schedules sending Commissioning.EndpointInformation command. More... | |
| #define | ZB_ZLL_COMMISSIONING_GET_EP_INFO(data_ptr, buffer, status) |
| Parses Commissioning.EndpointInformation. More... | |
Touchlink Commissioning cluster
| #define ZB_ZCL_DECLARE_TOUCHLINK_COMMISSIONING_ATTR_LIST | ( | attr_list | ) |
Declare attribute list for Touchlink Commissioning cluster (only cluster revision attribute)
| attr_list | - attribute list name |
| #define ZB_ZCL_TOUCHLINK_COMMISSIONING_CLUSTER_REVISION_DEFAULT ((zb_uint16_t)0x0003u) |
Default value for Touchlink Commissioning cluster revision global attribute.
| #define ZB_ZLL_APLC_INTRP_TRANSID_LIFETIME ( ZB_MILLISECONDS_TO_BEACON_INTERVAL(8000)) |
aplcInterPANTransIdLifetime constant value.
| #define ZB_ZLL_APLC_MIN_STARTUP_DELAY_TIME (ZB_MILLISECONDS_TO_BEACON_INTERVAL(2000)) |
aplcMinStartupDelayTime constant value.
| #define ZB_ZLL_APLC_RX_WINDOW_DURATION (ZB_MILLISECONDS_TO_BEACON_INTERVAL(5000)) |
aplcRxWindowDuration constant value.
| #define ZB_ZLL_APLC_SCAN_TIME_BASE_DURATION ( ZB_MILLISECONDS_TO_BEACON_INTERVAL(250)) |
aplcScanTimeBaseDuration constant value.
| #define ZB_ZLL_CLEAR_FACTORY_NEW | ( | ) | (ZLL_DEVICE_INFO().zll_info &= ~ZB_ZLL_INFO_FACTORY_NEW) |
Set current Touchlink device is not factory new.
| #define ZB_ZLL_COMMISSIONING_ADD_EP_INFO_DEVICE_INFO_RES | ( | data_ptr, | |
| ep_id_, | |||
| profile, | |||
| device, | |||
| version_, | |||
| n_group_ids, | |||
| sort_ | |||
| ) |
Add next device information record into Commissioning.DeviceInformationResponse.
| data_ptr | [IN] - pointer to contain address right after the added record's tail. |
| ep_id_ | [IN] - endpoint identifier of the sub-device. |
| profile | [IN] - profile identifier of the sub-device. |
| device | [IN] - device identifier. |
| version_ | [IN] of the device. |
| n_group_ids | [IN] - group identifier count. |
| sort_ | [IN] - endpoint info sort flag. |
| #define ZB_ZLL_COMMISSIONING_ADD_EP_INFO_GET_EP_LIST_RES | ( | data_ptr, | |
| addr, | |||
| ep, | |||
| profile, | |||
| device, | |||
| version_id | |||
| ) |
| #define ZB_ZLL_COMMISSIONING_ADD_GROUP_INFO_GET_GROUP_ID_RES | ( | data_ptr, | |
| grp_id, | |||
| grp_type | |||
| ) |
| #define ZB_ZLL_COMMISSIONING_DEVICE_INFO_MAX_RECORDS 0x05 |
Maximum number of device information records in the response.
| #define ZB_ZLL_COMMISSIONING_FILL_IDENTIFY_REQ | ( | buffer, | |
| address, | |||
| period, | |||
| status | |||
| ) |
Fills in appropriate structures and starts identify request sending process.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| address | [IN] - IEEE address of the target device. |
| period | [IN] - time to identify. |
| status | [OUT] - status of the operation. |
| #define ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.DeviceInformationRequest.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_device_information_req_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_DEVICE_INFO_RES | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.DeviceInformationResponse permanent part.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_device_information_common_res_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_EP_INFO | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.EndpointInformation.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_endpoint_information_s. |
| buffer | containing the packet (by pointer). |
| status | - status read parameters - see zb_zcl_parse_status_e |
| #define ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.GetEndpointListRequest.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_get_endpoint_list_req_s. |
| status | - status read parameters - see zb_zcl_parse_status_e |
| buffer | containing the packet (by pointer). |
| #define ZB_ZLL_COMMISSIONING_GET_GET_EP_LIST_RES | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses permanent part of Commissioning.GetEndpointListResponse.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_get_endpoint_list_res_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.GetGroupIdentifiersRequest.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_get_group_ids_req_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_GET_GROUP_ID_RES | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses permanent part of Commissioning.GetGroupIdentifiersResponse.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_get_group_ids_res_permanent_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.IdentifyRequest.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_identify_req_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_IDENTIFY_REQ_PARAM | ( | data_ptr, | |
| buffer | |||
| ) |
Extract Identify request parameters from the buffer.
| data_ptr | [OUT] - pointer to a memory region to put request parameters to. Must be capable of storing value of type zb_zll_commissioning_identify_req_param_s. |
| buffer | [IN] - index zb_bufid_t of the buffer containing request parameters (as a tail parameter). |
| #define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.NetworkJoinEndDeviceRequest.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_network_join_end_device_req_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ED_RES | ( | data_ptr, | |
| buffer, | |||
| op_status | |||
| ) |
Parses Commissioning.NetworkJoinEndDeviceResponse.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_network_join_end_device_res_s. |
| buffer | containing the packet (by pointer). |
| op_status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.NetworkJoinRouterRequest.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_network_join_router_req_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NETWORK_JOIN_ROUTER_RES | ( | data_ptr, | |
| buffer, | |||
| op_status | |||
| ) |
Parses Commissioning.NetworkJoinRouterResponse.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_network_join_router_res_s. |
| buffer | containing the packet (by pointer). |
| op_status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NETWORK_START_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.NetworkStartRequest.
| data_ptr | [OUT] - pointer to a variable of type zb_zll_commissioning_network_start_req_s. |
| buffer | [IN] - index zb_bufid_t of the buffer containing the packet. |
| status | [OUT] - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NETWORK_START_RES | ( | data_ptr, | |
| buffer, | |||
| op_status | |||
| ) |
Parses Commissioning.NetworkStartResponse.
| data_ptr | [OUT] - pointer to a variable of type zb_zll_commissioning_network_start_res_s that will contain parsed information. |
| buffer | [IN] - index zb_bufid_t of the buffer containing the packet. |
| op_status | [OUT] - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NETWORK_UPDATE_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.NetworkUpdateRequest.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_network_update_req_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_DEVICE_INFO_RES | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses next device description record in Commissioning.DeviceInformationResponse payload.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_device_information_ep_info_res_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NEXT_EP_INFO_GET_EP_LIST_RES | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Extracts next endpoint information record from Commissioning.GetEndpointListResponse.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_endpoint_info_record_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_NEXT_GROUP_INFO_GET_GROUP_ID_RES | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Extracts next group information record from Commissioning.GetGroupIdentifiersResponse.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_group_info_record_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_RESET_TO_FN_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.ResetToFactoryNewRequest.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_reset_to_fn_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_SCAN_REQ | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.ScanRequest payload.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_scan_req_s. |
| buffer | with the Commissioning.ScanRequest payload. |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GET_SCAN_RES | ( | data_ptr, | |
| buffer, | |||
| status | |||
| ) |
Parses Commissioning.ScanResponse.
| data_ptr | - pointer to a variable of type zb_zll_commissioning_scan_res_s. |
| buffer | containing the packet (by pointer). |
| status | - variable to put parse status to (see zb_zcl_parse_status_t). |
| #define ZB_ZLL_COMMISSIONING_GROUP_INFO_GROUP_TYPE_VALUE 0x00 |
Group type value for group_type field of zb_zll_commissioning_group_info_record_s.
| #define ZB_ZLL_COMMISSIONING_INIT_DEVICE_INFO_RES | ( | buffer, | |
| data_ptr, | |||
| tsn, | |||
| start_index, | |||
| n_devs_reported | |||
| ) |
Starts filling in Commissioning.DeviceInformationResponse command.
| buffer | to put packet to (by pointer). |
| data_ptr | - pointer to contain address right after the response's permanent part's tail. |
| tsn | - ZCL transaction sequence number. |
| start_index | - index of the first reported device. |
| n_devs_reported | - number of reported devices. |
| #define ZB_ZLL_COMMISSIONING_INIT_GET_EP_LIST_RES | ( | buffer, | |
| total_, | |||
| start_index, | |||
| count_, | |||
| tsn, | |||
| data_ptr | |||
| ) |
Fills in mandatory part of Commissioning.GetGroupIdentifiersResponse payload.
| buffer | to put packet to (by pointer). |
| total_ | - all count endpoint list |
| start_index | - Index at which to start returning endpoint list. |
| count_ | - count of endpoints in this payload. |
| tsn | [IN] - ZCL transaction sequence number. |
| data_ptr | - pointer to contain address right after the response's permanent part's tail. |
| #define ZB_ZLL_COMMISSIONING_INIT_GET_GROUP_ID_RES | ( | buffer, | |
| data_ptr, | |||
| total_, | |||
| start_index, | |||
| count_, | |||
| tsn | |||
| ) |
Fills in mandatory part of Commissioning.GetGroupIdentifiersResponse payload.
| buffer | to put packet to (by pointer). |
| data_ptr | - pointer to contain address right after the response's permanent part's tail. |
| total_ | - all count group identifiers |
| start_index | - Index at which to start returning group identifiers. |
| count_ | - count of identifiers in this payload. |
| tsn | [IN] - ZCL transaction sequence number. |
| #define ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_REQ | ( | buffer, | |
| start_index, | |||
| dst_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.DeviceInformationRequest command.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| start_index | [IN] - device index to start reporting with. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_DEVICE_INFO_RES | ( | buffer, | |
| data_ptr, | |||
| dst_addr, | |||
| callback, | |||
| status | |||
| ) | (status) = ZB_ZLL_SEND_PACKET(buffer, data_ptr, dst_addr, callback) |
Schedules Commissioning.DeviceInformationResponse for sending.
| buffer | [IN] - index zb_bufid_t of the buffer containing payload. |
| data_ptr | [IN] - pointer to the payload's tail. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to call upon packet confirm. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_EP_INFO | ( | buffer, | |
| endpoint_id, | |||
| profile, | |||
| device, | |||
| version_, | |||
| dst_addr, | |||
| dst_ep, | |||
| ep, | |||
| callback | |||
| ) |
Schedules sending Commissioning.EndpointInformation command.
| buffer | to put packet to (by pointer). |
| endpoint_id | - endpoint identifier. |
| profile | - profile identifier. |
| device | - device identifier. |
| version_ | - device version. |
| dst_addr | - IEEE device address to send packet to. |
| dst_ep | - endpoint of device to send packet to. |
| ep | - endpoint of target device. |
| callback | to schedule on packet send confirmation. |
| #define ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_REQ | ( | buffer, | |
| start_index, | |||
| addr, | |||
| dst_ep, | |||
| ep, | |||
| callback | |||
| ) |
Schedules sending Commissioning.GetEndpointListRequest command.
| buffer | to put packet to (by pointer). |
| start_index | - Index at which to start returning group identifiers. |
| addr | - IEEE device address to send packet to. |
| dst_ep | - endpoint of device to send packet to. |
| ep | - endpoint of target device. |
| callback | to schedule on packet send confirmation. |
| #define ZB_ZLL_COMMISSIONING_SEND_GET_EP_LIST_RES | ( | buffer, | |
| data_ptr, | |||
| dst_addr, | |||
| dst_ep, | |||
| ep, | |||
| callback | |||
| ) |
| #define ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_REQ | ( | buffer, | |
| start_index, | |||
| dst_addr, | |||
| dst_ep, | |||
| ep, | |||
| callback | |||
| ) |
Schedules sending Commissioning.GetGroupIdentifiersRequest command.
| buffer | to put packet to (by pointer). |
| start_index | - Rindex at which to start returning group identifiers. |
| dst_addr | - IEEE device address to send packet to. |
| dst_ep | - endpoint of device to send packet to. |
| ep | - endpoint of target device. |
| callback | to schedule on packet send confirmation. |
| #define ZB_ZLL_COMMISSIONING_SEND_GET_GROUP_ID_RES | ( | buffer, | |
| data_ptr, | |||
| addr, | |||
| dst_ep, | |||
| ep, | |||
| callback | |||
| ) |
| #define ZB_ZLL_COMMISSIONING_SEND_IDENTIFY_REQ | ( | buffer, | |
| p_identify_duration, | |||
| ieee_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.IdentifyRequest command.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| p_identify_duration | [IN] - period to identify. |
| ieee_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_REQ | ( | buffer, | |
| key_index, | |||
| encrypted_nwk_key, | |||
| logical_channel, | |||
| nwk_addr, | |||
| grp_ids_begin, | |||
| grp_ids_end, | |||
| free_nwk_addrs_begin_, | |||
| free_nwk_addrs_end_, | |||
| free_group_ids_begin_, | |||
| free_group_ids_end_, | |||
| dst_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.NetworkJoinEndDeviceRequest command.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| key_index | [IN] - index of the field to be used in the encrypted network key field. |
| encrypted_nwk_key | [IN] - encrypted network key. |
| logical_channel | [IN] - Touchlink channel to be used for the new network. |
| nwk_addr | [IN] - short network address for the recipient. |
| grp_ids_begin | [IN] - group identifiers begin field. |
| grp_ids_end | [IN] - group identifiers end field. |
| free_nwk_addrs_begin_ | [IN] - free network addresses begin field. |
| free_nwk_addrs_end_ | [IN] - free network addresses end field. |
| free_group_ids_begin_ | [IN] - free group identifiers begin field. |
| free_group_ids_end_ | [IN] - free group identifiers end field. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ED_RES | ( | buffer, | |
| nwk_status, | |||
| tsn, | |||
| dst_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.NetworkJoinEndDeviceResponse command.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| nwk_status | [IN] - network join end device result. |
| tsn | [IN] - ZCL transaction sequence number. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_REQ | ( | buffer, | |
| key_index, | |||
| encrypted_nwk_key, | |||
| nwk_addr, | |||
| grp_ids_begin, | |||
| grp_ids_end, | |||
| free_nwk_addrs_begin_, | |||
| free_nwk_addrs_end_, | |||
| free_group_ids_begin_, | |||
| free_group_ids_end_, | |||
| dst_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.NetworkJoinRouterRequest command.
| buffer | to put packet to (by pointer). |
| key_index | [IN] - index of the field to be used in the encrypted network key field. |
| encrypted_nwk_key | [IN] - encrypted network key. |
| nwk_addr | [IN] - short network address for the recipient. |
| grp_ids_begin | [IN] - group identifiers begin field. |
| grp_ids_end | [IN] - group identifiers end field. |
| free_nwk_addrs_begin_ | [IN] - free network addresses begin field. |
| free_nwk_addrs_end_ | [IN] - free network addresses end field. |
| free_group_ids_begin_ | [IN] - free group identifiers begin field. |
| free_group_ids_end_ | [IN] - free group identifiers end field. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_NETWORK_JOIN_ROUTER_RES | ( | buffer, | |
| nwk_status, | |||
| tsn, | |||
| dst_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.NetworkJoinRouterResponse command.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| nwk_status | [IN] - network join router operation status. |
| tsn | [IN] - ZCL transaction sequence number. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_REQ | ( | buffer, | |
| ext_pan_id_, | |||
| key_index, | |||
| encrypted_nwk_key, | |||
| logical_channel, | |||
| pan_id_, | |||
| nwk_addr, | |||
| grp_ids_begin, | |||
| grp_ids_end, | |||
| free_nwk_addrs_begin_, | |||
| free_nwk_addrs_end_, | |||
| free_group_ids_begin_, | |||
| free_group_ids_end_, | |||
| dst_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.NetworkStartRequest command.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| ext_pan_id_ | [IN] - extended Pan ID of the new network. |
| key_index | [IN] - index of the field to be used in the encrypted network key field. |
| encrypted_nwk_key | [IN] - encrypted network key. |
| logical_channel | [IN] - Touchlink channel to be used for the new network. |
| pan_id_ | [IN] - new network Pan ID. |
| nwk_addr | [IN] - short network address for the recipient. |
| grp_ids_begin | [IN] - group identifiers begin field. |
| grp_ids_end | [IN] - group identifiers end field. |
| free_nwk_addrs_begin_ | [IN] - free network addresses begin field. |
| free_nwk_addrs_end_ | [IN] - free network addresses end field. |
| free_group_ids_begin_ | [IN] - free group identifiers begin field. |
| free_group_ids_end_ | [IN] - free group identifiers end field. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_NETWORK_START_RES | ( | buffer, | |
| seq_num, | |||
| nwk_status, | |||
| ext_pan_id_, | |||
| pan_id_, | |||
| channel_, | |||
| dst_addr, | |||
| callback, | |||
| status_ | |||
| ) |
Schedules Commissioning.NetworkStartResponse sending.
| buffer | [IN] - index zb_bufid_t of the buffer containing payload. |
| seq_num | [IN] - ZCL transaction sequence number. |
| nwk_status | [IN] - network start request result. |
| ext_pan_id_ | [IN] - extended Pan ID of the network to be started. |
| pan_id_ | [IN] - Pan ID of the network to be started. |
| channel_ | [IN] - channel number network will be started on. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status_ | [OUT] - packet send schedule status. |
| #define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ | ( | buffer, | |
| nwk_addr, | |||
| dst_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.NetworkUpdateRequest command. (send command with current value of channel from pib cache)
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| nwk_addr | [IN] - network address assigned to the target. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_NETWORK_UPDATE_REQ_WITH_CHANNEL | ( | buffer, | |
| nwk_addr, | |||
| dst_addr, | |||
| logical_channel, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.NetworkUpdateRequest command.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| nwk_addr | [IN] - network address assigned to the target. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| logical_channel | [IN] - channel number. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_RESET_TO_FN_REQ | ( | buffer, | |
| dst_addr, | |||
| callback, | |||
| status | |||
| ) |
Schedules sending Commissioning.ResetToFactoryNewRequest command.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| dst_addr | [IN] - IEEE device address to send packet to. |
| callback | [IN] - callback to schedule on packet send confirmation. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_COMMISSIONING_SEND_SCAN_REQ | ( | buffer, | |
| callback | |||
| ) | zb_zll_commissioning_send_scan_req(buffer, callback) |
| #define ZB_ZLL_COMMISSIONING_SEND_SCAN_RES | ( | buffer, | |
| seq_num, | |||
| callback, | |||
| status | |||
| ) |
Schedules Commissioning.ScanResponse sending.
| buffer | [IN] - index zb_bufid_t of the buffer to put packet to. |
| seq_num | [IN] - ZCL sequence number. |
| callback | [IN] - callback to call upon packet confirm. |
| status | [OUT] - packet send schedule status (see zb_ret_t). |
| #define ZB_ZLL_DEFAULT_ADDR_RANGE 1000 |
Configurable parameters: default address range that is assigned during commissioning.
| #define ZB_ZLL_DEFAULT_GROUP_ID_RANGE 1000 |
Configurable parameters: default group id range that is assigned during commissioning.
| #define ZB_ZLL_DEVICE_INFO_GET_ADDR_ASSIGNMENT | ( | zll_info | ) | ((zll_info) & ZB_ZLL_INFO_ADDR_ASSIGNMENT) |
Check is Touchlink device capable of address assignment.
| #define ZB_ZLL_DEVICE_INFO_GET_FACTORY_NEW | ( | zll_info | ) | ((zll_info) & ZB_ZLL_INFO_FACTORY_NEW) |
Check is Touchlink device factory new.
| #define ZB_ZLL_DEVICE_INFO_GET_LINK_INITIATOR | ( | zll_info | ) | ((zll_info) & ZB_ZLL_INFO_TOUCHLINK_INITIATOR) |
Check is Touchlink device a link initiator.
| #define ZB_ZLL_IDENTIFY_DEFAULT_TIME 0xffff |
"Identify for default period" constant for Identify request.
| #define ZB_ZLL_IDENTIFY_STOP 0 |
"Exit identify mode" constant for Identify request.
| #define ZB_ZLL_IS_ADDR_ASSIGNMENT | ( | ) | (ZB_ZLL_DEVICE_INFO_GET_ADDR_ASSIGNMENT(ZLL_DEVICE_INFO().zll_info)) |
Check is current Touchlink device capable of address assignment.
| #define ZB_ZLL_IS_FACTORY_NEW | ( | ) | (ZB_ZLL_DEVICE_INFO_GET_FACTORY_NEW(ZLL_DEVICE_INFO().zll_info)) |
Check is current Touchlink device factory new.
| #define ZB_ZLL_IS_LINK_INITIATOR | ( | ) | (ZB_ZLL_DEVICE_INFO_GET_LINK_INITIATOR(ZLL_DEVICE_INFO().zll_info)) |
Check is current Touchlink device a link initiator.
| #define ZB_ZLL_MIN_ADDR_RANGE 100 |
Configurable parameters: minimum address range that maybe assigned during commissioning.
| #define ZB_ZLL_MIN_GROUP_ID_RANGE 100 |
Configurable parameters: minimum group id range that maybe assigned during commissioning.
| #define ZB_ZLL_NETWORK_UPDATE_ID ((zb_uint8_t)0) |
The only acceptable value for network update identifier field in the network start response.
| #define ZB_ZLL_PRIMARY_CHANNEL_MASK ((1l << 11) | (1l << 15) | (1l << 20) | (1l << 25)) |
First primary Touchlink channels mask.
| #define ZB_ZLL_REPORT_ATTR_COUNT 0 |
No attributes for reporting in Touchlink profile.
| #define ZB_ZLL_SET_FACTORY_NEW | ( | ) | (ZLL_DEVICE_INFO().zll_info |= ZB_ZLL_INFO_FACTORY_NEW) |
Set current Touchlink device is factory new.
| #define ZB_ZLL_ZB_INFO_CURRENT_VALUE | ( | ) | zb_zll_get_info_current_value() |
| typedef struct zb_zll_commissioning_device_information_common_res_s zb_zll_commissioning_device_information_common_res_t |
Parsed permanent part of the Commissioning.DeviceInformationResponse payload.
| typedef struct zb_zll_commissioning_device_information_ep_info_res_s zb_zll_commissioning_device_information_ep_info_res_t |
Parsed device information record from the Commissioning.DeviceInformationResponse payload.
| typedef struct zb_zll_commissioning_device_information_req_s zb_zll_commissioning_device_information_req_t |
Parsed Commissioning.DeviceInformationRequest payload.
| typedef struct zb_zll_commissioning_endpoint_info_record_s zb_zll_commissioning_endpoint_info_record_t |
Endpoint information record for Commissioning.GetEndpointListResponse command.
| typedef struct zb_zll_commissioning_endpoint_information_s zb_zll_commissioning_endpoint_information_t |
Parsed Commissioning.EndpointInformation payload.
| typedef struct zb_zll_commissioning_ep_info_s zb_zll_commissioning_ep_info_t |
Endpoint information for parsed Commissioning.ScanResponse representation.
| typedef struct zb_zll_commissioning_get_endpoint_list_req_s zb_zll_commissioning_get_endpoint_list_req_t |
Parsed Commissioning.GetEndpointListRequest payload.
| typedef struct zb_zll_commissioning_get_endpoint_list_res_s zb_zll_commissioning_get_endpoint_list_res_t |
Parsed Commissioning.GetEndpointListResponse payload.
Parsed Commissioning.GetGroupIdentifiersRequest payload.
| typedef struct zb_zll_commissioning_get_group_ids_res_permanent_s zb_zll_commissioning_get_group_ids_res_permanent_t |
Parsed Commissioning.GetGroupIdentifiersResponse payload.
Group information record for Commissioning.GetGroupIdentifiersResponse command.
Identify request parameters.
Parsed Commissioning.IdentifyRequest payload.
| typedef struct zb_zll_commissioning_network_join_end_device_req_s zb_zll_commissioning_network_join_end_device_req_t |
Parsed Commissioning.NetworkJoinEndDeviceRequest payload.
| typedef struct zb_zll_commissioning_network_join_end_device_res_s zb_zll_commissioning_network_join_end_device_res_t |
Parsed Commissioning.NetworkJoinEndDeviceResponse payload.
| typedef struct zb_zll_commissioning_network_join_router_req_s zb_zll_commissioning_network_join_router_req_t |
Parsed Commissioning.NetworkJoinRouterRequest payload.
| typedef struct zb_zll_commissioning_network_join_router_res_s zb_zll_commissioning_network_join_router_res_t |
Parsed Commissioning.NetworkJoinRouterResponse payload.
Parsed Commissioning.NetworkStartRequest payload.
Parsed Commissioning.NetworkStartResponse payload.
Parsed Commissioning.NetworkUpdateRequest payload.
Parsed Commissioning.ResetToFactoryNewRequest payload.
| typedef struct zb_zll_commissioning_scan_req_s zb_zll_commissioning_scan_req_t |
Parsed Scan request payload representation.
| typedef struct zb_zll_commissioning_scan_res_s zb_zll_commissioning_scan_res_t |
Parsed Commissioning.ScanResponse structure.
Touchlink commissioning cluster command identifiers.
Touchlink commissioning cluster response command identifiers.
| enum zb_zll_info_e |
| void zb_zll_commissioning_send_scan_req | ( | zb_bufid_t | buffer, |
| zb_callback_t | callback | ||
| ) |
Schedules Commissioning.ScanRequest sending.
| buffer | to use for packet creation. |
| callback | to call upon packet confirmation. |
| zb_uint8_t zb_zll_get_info_current_value | ( | void | ) |
Get Touchlink Info current value.
| zb_ret_t zb_zll_identify | ( | zb_uint8_t | param | ) |
Sets up Identify request and schedules it for sending. Checks transaction state, identify period acceptability, fills in and schedules for sending command packet.
| param | [IN] - reference to the packet buffer containing zb_zll_commissioning_identify_req_param_s structure as parameter. |