Developing with ZBOSS for Zigbee
Data Structures | |
| union | zb_zgpd_addr_u |
| ZGPD address. More... | |
| struct | zb_zgpd_id_s |
| ZGPD identification info (ZGPD ID) More... | |
| struct | zgp_attr_record_s |
| struct | zgp_data_point_desc_options_s |
| struct | zgp_data_point_desc_s |
| struct | zgp_report_desc_options_s |
| struct | zgp_report_desc_s |
| struct | zgp_report_desc_pairing_config_s |
| struct | zb_zgp_gpd_cmds_list_s |
| GPD CommandID list. More... | |
| struct | zb_zgp_cluster_list_s |
| GPD Cluster List. More... | |
Macros | |
| #define | ZGP_ENDPOINT 242 |
| #define | ZGP_ATTR_OPT_GET_REMAINING_LEN(opt) ((opt) & 0xFU) |
| #define | ZGP_ATTR_OPT_GET_REPORTED(opt) (((opt) >> 4U) & 0x1U) |
| #define | ZGP_ATTR_OPT_GET_VAL_PRESENT(opt) (((opt) >> 5U) & 0x1U) |
| #define | ZB_APP_DESCR_ATTR_VAL_SIZE 8U |
| #define | ZB_APP_DESCR_ATTR_REC_SIZE 4U |
| #define | SIZE_BY_APP_ID(app_id) (((app_id) == ZB_ZGP_APP_ID_0000) ? 4U : 8U) |
| #define | ZGPD_ID_SIZE(zgpd_id) SIZE_BY_APP_ID((zgpd_id)->app_id) |
| #define | ZB_ZGPD_IDS_ARE_EQUAL(id1, id2) |
| #define | ZB_ZGP_SRC_ID_UNSPECIFIED 0x00000000U |
| #define | ZB_ZGP_SRC_ID_ALL (zb_uint32_t)(~0u) |
| #define | ZB_INIT_ZGPD_ID(zgpd_id) |
| #define | ZB_ZGPD_IS_SPECIFIED(zgpd_id) |
| #define | ZB_MAKE_ZGPD_ID(zgpd_id, s_app_id, s_endpoint, s_addr) |
| #define | ZB_GPDF_CMD_IS_SCENE_CMD(_cmd_id) |
| #define | ZB_GPDF_CMD_IS_RECALL_SCENE(_cmd_id) |
| #define | ZB_GPDF_CMD_IS_STORE_SCENE(_cmd_id) |
| #define SIZE_BY_APP_ID | ( | app_id | ) | (((app_id) == ZB_ZGP_APP_ID_0000) ? 4U : 8U) |
| #define ZB_APP_DESCR_ATTR_REC_SIZE 4U |
| #define ZB_APP_DESCR_ATTR_VAL_SIZE 8U |
| #define ZB_GPDF_CMD_IS_RECALL_SCENE | ( | _cmd_id | ) |
| #define ZB_GPDF_CMD_IS_SCENE_CMD | ( | _cmd_id | ) |
| #define ZB_GPDF_CMD_IS_STORE_SCENE | ( | _cmd_id | ) |
| #define ZB_INIT_ZGPD_ID | ( | zgpd_id | ) |
| #define ZB_MAKE_ZGPD_ID | ( | zgpd_id, | |
| s_app_id, | |||
| s_endpoint, | |||
| s_addr | |||
| ) |
| #define ZB_ZGP_SRC_ID_ALL (zb_uint32_t)(~0u) |
| #define ZB_ZGP_SRC_ID_UNSPECIFIED 0x00000000U |
| #define ZB_ZGPD_IDS_ARE_EQUAL | ( | id1, | |
| id2 | |||
| ) |
| #define ZB_ZGPD_IS_SPECIFIED | ( | zgpd_id | ) |
| #define ZGP_ATTR_OPT_GET_REMAINING_LEN | ( | opt | ) | ((opt) & 0xFU) |
| #define ZGP_ATTR_OPT_GET_REPORTED | ( | opt | ) | (((opt) >> 4U) & 0x1U) |
| #define ZGP_ATTR_OPT_GET_VAL_PRESENT | ( | opt | ) | (((opt) >> 5U) & 0x1U) |
| #define ZGP_ENDPOINT 242 |
| #define ZGPD_ID_SIZE | ( | zgpd_id | ) | SIZE_BY_APP_ID((zgpd_id)->app_id) |
| typedef enum zb_zgp_app_id_e zb_zgp_app_id_t |
| typedef struct zb_zgp_cluster_list_s zb_zgp_cluster_list_t |
| typedef void( * zb_zgp_comm_req_cb_t) (zb_zgpd_id_t *zgpd_id, zb_uint8_t device_id, zb_uint16_t manuf_id, zb_uint16_t manuf_model_id, zb_ieee_addr_t ieee_addr) |
Commissioning request callback type.
Commissioning request callback notifies application about commissioning attempt from ZGPD. Callback is called when ZGPD sends commissioning frame. Callback provides to user ZGPD ID and ZGPD Device ID. Based on these parameters user application should decide whether commissioning procedure should be continued or not.
Commissioning request callback should be set during ZGP initialization using ZB_ZGP_REGISTER_COMM_REQ_CB macro. If callback is not registered, then ZBOSS accepts all incoming commissioning attempts.
| zgpd_id | [in] ZGPD ID |
| device_id | [in] ZGPD device ID |
| manuf_id | [in] Manufacturer ID (meaningful if device_id = 0xFE or 0xFF) |
| manuf_model_id | [in] Manufacturer model ID (meaningful if device_id = 0xFE or 0xFF) |
| ieee_addr | [in] ZGPD long IEEE address if available, otherwise filled with zeroes |
| typedef enum zb_zgp_comm_status_e zb_zgp_comm_status_t |
Possible commissioning result.
| typedef struct zb_zgp_gpd_cmds_list_s zb_zgp_gpd_cmds_list_t |
| typedef enum zb_zgp_mode_change_reason_e zb_zgp_mode_change_reason_t |
GP Sink mode change reason.
| typedef enum zb_zgp_mode_e zb_zgp_mode_t |
Current mode of ZGP endpoint.
| typedef union zb_zgpd_addr_u zb_zgpd_addr_t |
ZGPD address.
ZGPD is identified in network whether by SrcId or its IEEE address.
| typedef enum zb_zgpd_dev_id_e zb_zgpd_dev_id_t |
Possible ZGPD device identifiers.
| typedef struct zb_zgpd_id_s zb_zgpd_id_t |
ZGPD identification info (ZGPD ID)
ZGPD is identified by SrcId if ApplicationID is ZB_ZGP_APP_ID_0000. Otherwise, ZGPD is identified by its IEEE address.
Manufacturer-specific device identifiers for GreanPeak.
| typedef struct zgp_attr_record_s zgp_attr_record_t |
| typedef enum zgp_communication_mode_e zgp_communication_mode_t |
Values of gpsCommunicationMode attribute Table 27
| typedef struct zgp_data_point_desc_options_s zgp_data_point_desc_options_t |
| typedef struct zgp_data_point_desc_s zgp_data_point_desc_t |
| typedef struct zgp_report_desc_options_s zgp_report_desc_options_t |
| typedef struct zgp_report_desc_pairing_config_s zgp_report_desc_pairing_config_t |
| typedef struct zgp_report_desc_s zgp_report_desc_t |
| enum zb_zgp_app_id_e |
| enum zb_zgp_comm_status_e |
Possible commissioning result.
| Enumerator | |
|---|---|
| ZB_ZGP_COMMISSIONING_COMPLETED | Commissioning with some device completed successfully |
| ZB_ZGP_COMMISSIONING_FAILED | Commissioning failed. The reason can be:
|
| ZB_ZGP_COMMISSIONING_TIMED_OUT | Commissioning failed, because of timeout |
| ZB_ZGP_COMMISSIONING_NO_MATCH_ERROR | No functionality match with commissioning device is found. Maybe matching table is not provided by user application |
| ZB_ZGP_COMMISSIONING_INTERNAL_ERROR | Commissioning failed, because some internal error occurred in stack. This type of error is recoverable, so next commissioning attempt can be successful |
| ZB_ZGP_COMMISSIONING_EXTERNAL_ERROR | Commissioning failed, because some external error has occurred. Normal functioning of ZGP subsystem is not possible (e.g. physical operational channel can't be obtained) |
| ZB_ZGP_COMMISSIONING_CANCELLED_BY_USER | User cancelled commissioning by calling zb_zgps_stop_commissioning() |
| ZB_ZGP_ZGPD_DECOMMISSIONED | ZGPD sent Decommissioning command |
| enum zb_zgp_endpoint_e |
| enum zb_zgp_mode_e |
ZGPD GP Pairing Configuration action sub-field of the Actions field enum.
Table 34 – Values of the Action sub-field of the Actions field
The gpSharedSecurityKeyType attribute can take the following values from Table 48: Table 48 - Values of gpSecurityKeyType
See also Table 12 - Mapping between the gpSecurityKeyType and the SecurityKey sub-field of the Extended NWK Frame Control field
ZGP security level type.
| enum zb_zgpd_cmd_id_e |
Command identifiers sent from or to ZGPD.
| enum zb_zgpd_dev_id_e |
Possible ZGPD device identifiers.
Manufacturer-specific device identifiers for GreanPeak.