Digi XBee(R) ANSI C Host Library
Data Structures
Here are the data structures with brief descriptions:
[detail level 12]
 C_sxa_sock_hdr_t
 C_xbee_reg_descr_t
 Caddr64Typedef used to hold a 64-bit IEEE address, represented as 8 bytes, 4 16-bit values or 2 32-bit values
 Cebl_file_header_tUnion of header formats for all Ember firmware images
 Cem2xx_header_tHeader for EM2XX-based firmware images
 Cem3xx_header_tHeader for EM3XX-based firmware images
 Cgpio_xbee_t
 CJSInt64
 Cmbedtls_aes_contextThe AES context-type definition
 Cmbedtls_ctr_drbg_contextThe CTR_DRBG context structure
 Cmbedtls_entropy_contextEntropy context structure
 Cmbedtls_entropy_source_stateEntropy source state
 Cmbedtls_mpiMPI structure
 Cmbedtls_platform_contextThe platform context structure
 Cmbedtls_sha256_contextThe SHA-256 context structure
 Cmicro_info_tStructure used to hold table of micro_info values from EM3XX header
 CNGHex
 Cplatform_info_tStructure used to hold table of plat_info values from EM3XX header
 Cpxbee_ota_tStructure for tracking state of over-the-air update
 Csocket_t
 CSRPUser
 CSRPVerifier
 Csxa_cached_group_tCached register group value
 Csxa_node_tThis structure and the attendant functions provide a useful layer for Rabbit applications who wish to use a simplified interface to the XBee API
 Cwpan_address_tSingle structure to hold an 802.15.4 device's 64-bit IEEE/MAC address and 16-bit network address
 Cwpan_cluster_table_entry_tInformation on each cluster associated with an endpoint
 Cwpan_conversation_tUsed to track conversations (outstanding requests) on an endpoint
 Cwpan_dev_tStructure used by the WPAN/ZigBee layers
 Cwpan_endpoint_table_entry_tInformation on each endpoint on this device
 Cwpan_envelope_tThe "envelope" is used to gather all necessary information about a given frame on the network
 Cwpan_ep_state_tVolatile part of an endpoint record used to track conversations (requests waiting for responses)
 Cxbee_at_cmd_tDatatype used for passing and storing XBee AT Commands
 Cxbee_atcmd_reg_tEntry for table of XBee registers to query at startup
 Cxbee_cbuf_tCircular buffer used by transparent serial cluster handler
 Cxbee_cmd_request_tThis structure is used to keep track of outstanding local and remote AT requests
 Cxbee_cmd_response_tStructure used to pass AT Command responses to registered callback handlers
 Cxbee_comm_dl_t
 Cxbee_comm_reg_t
 Cxbee_command_list_context_tContext data passed to command list processor
 Cxbee_dev_t
 Cxbee_dispatch_table_entry_t
 Cxbee_frame_at_response_tUseful typedef for casting either a local or remote response frame
 Cxbee_frame_create_source_route_tXBEE_FRAME_CREATE_SOURCE_ROUTE (0x21)
 Cxbee_frame_io_response_t< XBEE_FRAME_IO_RESPONSE (0x92) ATSH and ATSL of sender ATMY value of sender
 Cxbee_frame_local_at_resp_tResponse to an AT Command sent to the local serially-connected XBee
 Cxbee_frame_modem_status_t< XBEE_FRAME_MODEM_STATUS (0x8A) See XBEE_MODEM_STATUS_*
 Cxbee_frame_node_id_tFormat of 0x95 frames received from XBee
 Cxbee_frame_receive_explicit_tFormat of XBee API frame type 0x91 (XBEE_FRAME_RECEIVE_EXPLICIT); received from XBee by host
 Cxbee_frame_receive_ipv4_tFormat of XBee API frame type 0xB0 (XBEE_FRAME_RECEIVE_IPV4); received from XBee by host
 Cxbee_frame_receive_sms_tFormat of XBee API frame type 0x9F (XBEE_FRAME_RECEIVE_SMS); received from XBee by host
 Cxbee_frame_receive_tFormat of XBee API frame type 0x90 (XBEE_FRAME_RECEIVE); received from XBee by host
 Cxbee_frame_register_device_status_t< XBEE_FRAME_REGISTER_DEVICE_STATUS (0xA4) ID of REGISTER_DEVICE frame result of operation
 Cxbee_frame_remote_at_resp_tResponse to an AT Command sent to a remote XBee
 Cxbee_frame_route_many_to_one_req_tThe many-to-one route request indicator frame is sent out the serial port whenever a many-to-one route request is received
 Cxbee_frame_route_record_indicator_tXBEE_FRAME_ROUTE_RECORD_INDICATOR (0xA1)
 Cxbee_frame_secure_session_resp_tFrame format for Secure Session Response
 Cxbee_frame_sock_bind_listen_tFormat of XBee API frame type 0x46 (XBEE_FRAME_SOCK_BIND_LISTEN)
 Cxbee_frame_sock_close_tFormat of XBee API frame type 0x43 (XBEE_FRAME_SOCK_CLOSE)
 Cxbee_frame_sock_create_tFormat of XBee API frame type 0x40 (XBEE_FRAME_SOCK_CREATE)
 Cxbee_frame_sock_ipv4_client_tFormat of XBee API frame type 0xCC (XBEE_FRAME_SOCK_IPV4_CLIENT); sent from XBee to host for new connections on a listening socket
 Cxbee_frame_sock_option_resp_tFormat of XBee API frame type 0xC1 (XBEE_FRAME_SOCK_OPTION_RESP); sent from XBee to host
 Cxbee_frame_sock_receive_from_tFormat of XBee API frame type 0xCE (XBEE_FRAME_SOCK_RECEIVE_FROM); sent from XBee to host when a datagram arrives on a bound UDP socket
 Cxbee_frame_sock_receive_tFormat of XBee API frame type 0xCD (XBEE_FRAME_SOCK_RECEIVE); sent from XBee to host when data arrives on a connected socket
 Cxbee_frame_sock_shared_resp_tFormat of multiple XBee API frame types sent from XBee to host: 0xC0 (XBEE_FRAME_SOCK_CREATE_RESP) 0xC2 (XBEE_FRAME_SOCK_CONNECT_RESP) 0xC3 (XBEE_FRAME_SOCK_CLOSE_RESP) 0xC6 (XBEE_FRAME_SOCK_LISTEN_RESP)
 Cxbee_frame_sock_state_tFormat of XBee API frame type 0xCF (XBEE_FRAME_SOCK_STATE); sent from XBee to host when a socket's state changes
 Cxbee_frame_transmit_sms_tFormat of XBee API frame type 0x1F (XBEE_FRAME_TRANSMIT_SMS); sent from host to XBee
 Cxbee_frame_transmit_status_t< XBEE_FRAME_TRANSMIT_STATUS (0x8B)
 Cxbee_frame_tx_status_t< XBEE_FRAME_TX_STATUS (0x89)
 Cxbee_frame_user_data_rx_tFormat of XBee API frame type 0xAD (XBEE_FRAME_USER_DATA_RX); received from XBee by host
 Cxbee_frame_xms_ss_auth_failed_tFrame format for Extended Modem Status: Secure Session Auth Failed
 Cxbee_frame_xms_ss_ended_tFrame format for Extended Modem Status: Secure Session Ended
 Cxbee_frame_xms_ss_established_tFrame format for Extended Modem Status: Secure Session Established
 Cxbee_frame_xms_ss_header_tHeader for Extended Modem Status
 Cxbee_fs_req_dir_read_tFormat for the payload of "Directory Read/Close" File System Requests
 Cxbee_fs_req_file_close_tFormat for the payload of "File Close" File System Request
 Cxbee_fs_req_file_open_tFormat for the payload of "File Open" File System Request
 Cxbee_fs_req_file_read_tFormat for the payload of "File Read" File System Request
 Cxbee_fs_req_file_write_tFormat for the payload of "File Write" File System Request
 Cxbee_fs_req_path_and_name_tFormat for the payload of File System Request with path_id and name:
 Cxbee_fw_buffer_t
 Cxbee_fw_oem_state_t
 Cxbee_fw_source_t
 Cxbee_gen3_extended_ver_t
 Cxbee_gen3_page_ver0_t< XBEE_GEN3_CMD_UPLOAD_PAGE
 Cxbee_gen3_page_ver1_t< XBEE_GEN3_CMD_UPLOAD_PAGE
 Cxbee_gen3_update_t
 Cxbee_gpm_flash_info_t
 Cxbee_gpm_frame_t< variable-length data field
 Cxbee_gpm_request_header_t< one of GPM_CMD_* varies by command block number addressed in the GPM byte index within the addressed GPM block number of bytes in the data field (WRITE) or requested for a READ
 Cxbee_gpm_response_header_t< one of GPM_CMD_*, same as cmd_id in request indication whether command was successful block number addressed in the GPM byte index within the addressed GPM block number of bytes in the data field
 Cxbee_header_at_request_tUseful typedef to create either a local or remote request frame
 Cxbee_header_file_system_req_tFrame format for the header of File System Request frame
 Cxbee_header_file_system_resp_tFrame format for the header of File System Response frame
 Cxbee_header_local_at_req_tHeader for AT Commands sent to the local (serially-attached) XBee
 Cxbee_header_local_at_resp_tXBEE_FRAME_LOCAL_AT_RESPONSE (0x88)
 Cxbee_header_register_device_t< XBEE_FRAME_REGISTER_DEVICE (0x24) ID to match REGISTER_DEVICE_STATUS frame 64-bit address of destination devices set to WPAN_NET_ADDR_UNDEFINED (0xFFFE) options for join, XBEE_REG_DEV_OPT_xxx
 Cxbee_header_remote_at_req_tHeader to AT Commands sent to a remote XBee on the network
 Cxbee_header_remote_at_resp_tXBEE_FRAME_REMOTE_AT_RESPONSE (0x97)
 Cxbee_header_remote_fs_req_tFrame format for the header of Remote File System Request frame
 Cxbee_header_remote_fs_resp_tFrame format for the header of Remote File System Response frame
 Cxbee_header_secure_session_req_tFrame format for the header of Secure Session Control frame
 Cxbee_header_sock_connect_tHeader of XBee API frame type 0x42 (XBEE_FRAME_SOCK_CONNECT); sent from host to XBee
 Cxbee_header_sock_option_req_tHeader of XBee API frame type 0x41 (XBEE_FRAME_SOCK_OPTION_REQ); sent from host to XBee
 Cxbee_header_sock_send_tHeader of XBee API frame type 0x44 (XBEE_FRAME_SOCK_SEND); sent from host to XBee
 Cxbee_header_sock_sendto_tHeader of XBee API frame type 0x45 (XBEE_FRAME_SOCK_SENDTO); sent from host to XBee
 Cxbee_header_transmit_explicit_tFormat of XBee API frame type 0x11 (XBEE_FRAME_TRANSMIT_EXPLICIT); sent from host to XBee
 Cxbee_header_transmit_ipv4_tHeader of XBee API frame type 0x20 (XBEE_FRAME_TRANSMIT_IPV4); sent from host to XBee
 Cxbee_header_transmit_sms_t< XBEE_FRAME_TRANSMIT_SMS (0x1F)
 Cxbee_header_transmit_tFormat of XBee API frame type 0x10 (XBEE_FRAME_TRANSMIT); sent from host to XBee
 Cxbee_header_user_data_tx_tHeader of XBee API frame type 0x2D (XBEE_FRAME_USER_DATA_TX); sent from host to XBee
 Cxbee_io_t
 Cxbee_ipv4_envelope_t
 Cxbee_node_id1_t< ATMY value [0xFFFE on DigiMesh] ATSH and ATSL null-terminated ATNI value (variable length)
 Cxbee_node_id2_t< ATMP value [0xFFFE on DigiMesh]
 Cxbee_node_id_tParsed Node ID in host-byte-order and fixed length fields
 Cxbee_oem_header_t
 Cxbee_payload_fs_dir_entry_tFormat for a directory entry in a Directory Read Response
 Cxbee_payload_fs_file_open_resp_tFormat for the payload of File System Response: File Open
 Cxbee_payload_fs_file_rw_resp_tFormat for the payload of File System Response: File Read/File Write
 Cxbee_payload_fs_volume_resp_tFormat for the payload of File System Response: Volume Stat/Format
 Cxbee_scan_response_t
 Cxbee_scan_zigbee_response_t
 Cxbee_serial_t
 Cxbee_xmodem_state_tStructure used to track the state of an Xmodem send
 Czcl40_t40-bit unsigned in host-byte-order
 Czcl48_t48-bit unsigned in host-byte-order
 Czcl_array_tIf a zcl_attribute_base_t has a type of ZCL_TYPE_ARRAY, its .value points to this structure
 Czcl_attrib_tGeneral format for an attribute, used for Write Attributes and Report Attributes commands
 Czcl_attribute_base_tBasic structure for storing a list of attributes in a cluster
 Czcl_attribute_full_tUse this structure for attributes with min/max values or the need to have a read/write function
 Czcl_attribute_minmax_t
 Czcl_attribute_tree_t
 Czcl_attribute_write_rec_t
 Czcl_basic_dev_infoGlobal used to hold values referenced by zcl_basic_attributes[]
 Czcl_binary_output_attr_t
 Czcl_binary_output_t
 Czcl_client_read_t
 Czcl_comm_reset_startup_param_t
 Czcl_comm_restart_device_cmd_t
 Czcl_comm_restore_startup_param_t
 Czcl_comm_save_startup_param_t
 Czcl_comm_startup_attr_t
 Czcl_comm_startup_param_t
 Czcl_comm_state_t
 Czcl_command_tStructure populated by zcl_command_build() with the ZCL header from a received ZCL command frame
 Czcl_date_tDate (for ZCL_TYPE_TIME_DATE Data Type)
 Czcl_default_response_tUsed for ZCL_CMD_DEFAULT_RESP
 Czcl_discover_attrib_resp_tUsed for ZCL_CMD_DISCOVER_ATTRIB_RESP
 Czcl_discover_attrib_tUsed for ZCL_CMD_DISCOVER_ATTRIB
 Czcl_header_common_tCommon portion of ZCL header (appears after optional Manufacturer Code)
 Czcl_header_nomfg_tZLC header structure used when building a normal (non-manufacturer-specific response frame
 Czcl_header_response_tZCL header structure used for building response frames that may or may not be manufacturer-specific
 Czcl_header_tGeneral header for casting onto an incoming frame
 Czcl_header_withmfg_tZLC header structure used when building a manufacturer-specific response frame
 Czcl_ota_element_ecdsa_cert_tSub-element with the certificate used to generate the OTA file's signature
 Czcl_ota_element_ecdsa_signature_tSub-element with signature for the entire file, must be last in the file
 Czcl_ota_element_integrity_code_tSub-element with a hash value to verify the integrity of the OTA file
 Czcl_ota_element_tHeader of sub-elements in OTA Upgrade File following zcl_ota_file_header_t
 Czcl_ota_file_header_tOTA Upgrade File Header
 Czcl_ota_image_block_req_t< upgrade image identification
 Czcl_ota_image_block_resp_t< upgrade image identification
 Czcl_ota_image_id_tCommon sequence of fields appearing in multiple frame formats
 Czcl_ota_image_notify_t< new image identification
 Czcl_ota_image_page_req_t< upgrade image identification
 Czcl_ota_query_next_image_req_t< current image identification
 Czcl_ota_query_next_image_resp_t< new image identification
 Czcl_ota_upgrade_end_req_t< upgrade image identification
 Czcl_ota_upgrade_end_resp_t< upgrade image identification
 Czcl_ota_upgrade_source_tDatatype for providing an OTA Upgrade Image to a client
 Czcl_read_struct_attrib_t
 Czcl_rec_attrib_report_tUsed for ZCL_CMD_DISCOVER_ATTRIB_RESP
 Czcl_rec_read_attrib_array_resp_t< one of ZCL_TYPE_ARRAY, ZCL_TYPE_SET, ZCL_TYPE_BAG
 Czcl_rec_read_attrib_error_resp_t
 Czcl_rec_read_attrib_resp_tUsed for ZCL_CMD_READ_ATTRIB_RESP
 Czcl_rec_read_attrib_struct_resp_t< always ZCL_TYPE_STRUCT number of elements to follow mult
 Czcl_rec_read_report_cfg_t
 Czcl_rec_report_error_resp_t
 Czcl_rec_report_receive_resp_t
 Czcl_rec_report_receive_t
 Czcl_rec_report_send_resp_t
 Czcl_rec_report_send_t
 Czcl_rec_reporting_config_t
 Czcl_rec_reporting_status_t
 Czcl_rec_write_attrib_status_tUsed for ZCL_CMD_WRITE_ATTRIB_RESP
 Czcl_rec_write_struct_attrib_resp_t
 Czcl_rec_write_struct_attrib_t
 Czcl_selector_t
 Czcl_struct_element_tA zcl_struct_t contains an array of these elements, describing each element in the structure and its offset from the zcl_struct_t.base_address
 Czcl_struct_tIf a zcl_attribute_base_t has a type of ZCL_TYPE_STRUCT, its .value points to this structure
 Czcl_timeofday_tTime of Day (for ZCL_TYPE_TIME_TIMEOFDAY Data Type)
 Czdo_active_ep_req_tFrame format for ZDO Active_EP request
 Czdo_active_ep_rsp_header_tHeader for ZDO Active_EP response, followed by .ep_count uint8_t endpoints
 Czdo_bind_address_req_tFrame format for a ZDO Bind Request with an IEEE address and endpoint as the destination (header.dst_addr_mode == ZDO_BIND_DST_MODE_ADDR)
 Czdo_bind_group_req_tFrame format for a ZDO Bind Request with a group address as the destination (header.dst_addr_mode == ZDO_BIND_DST_MODE_GROUP)
 Czdo_bind_req_header_t
 Czdo_bind_req_t
 Czdo_complex_desc_req_tFrame format for ZDO Complex_Desc request
 Czdo_device_annce_tFrame format for a ZDO Device_annce announcement
 Czdo_ieee_addr_req_tFrame format for ZDO IEEE_addr request
 Czdo_match_desc_out_clust_tSecond half of Match_Desc request
 Czdo_match_desc_req_tHeader for ZDO Match_Desc request
 Czdo_match_desc_rsp_header_tHeader for ZDO Match_Desc response, followed by .match_length uint8_t endpoints
 Czdo_mgmt_leave_req_tFrame format for a ZDO Management Leave Request
 Czdo_mgmt_leave_rsp_t
 Czdo_node_desc_req_tFrame format for ZDO Node_Desc request
 Czdo_node_desc_resp_t< see ZDO_STATUS_* macros
 Czdo_node_desc_tFrame format for ZDO Node_Desc response
 Czdo_nwk_addr_req_tFrame format for ZDO NKW_addr request
 Czdo_nwk_addr_rsp_header_t
 Czdo_power_desc_req_tFrame format for ZDO Power_Desc request
 Czdo_power_desc_rsp_tFrame format for ZDO Power_Desc response
 Czdo_power_desc_tFormat for ZDO PowerDescriptor
 Czdo_simple_desc_header_tHeader for ZDO SimpleDescriptor (part of a Simple_Desc response), followed by uint8_t input cluster count, multiple uint16_t input cluster IDs, uint8_t output cluster count, multiple uint16_t output cluster IDs
 Czdo_simple_desc_req_tFrame format for ZDO Simple_Desc request
 Czdo_simple_desc_resp_header_tHeader for ZDO Simple_Desc response, followed by a SimpleDescriptor
 Czdo_user_desc_req_tFrame format for ZDO Complex_Desc request