gdp.h File Reference

API for ZID profile.

Author

Microchip Technology Inc: http://www.microchip.com

Support: https://www.microchip.com/support/

#include "rf4ce.h"
#include "nwk_internal.h"
#include "gdp_config.h"

Data Structures
struct	gdp_conf_complete_req_ind_tag
struct	gdp_generic_response_req_ind_tag
struct	gdp_get_attr_req_ind_tag
struct	gdp_get_attrrsp_req_ind_tag
struct	gdp_msg_struct_tag
struct	gdp_push_attr_req_ind_tag

Macros
#define	aplcMaxResponseWaitTime   200 /* ms as per GDP*/
	The maximum time a device shall wait for a response command frame following a request command frame. More...
#define	aplcMaxResponseWaitTime_us   (aplcMaxResponseWaitTime * 1000UL)
#define	aplcMaxRxOnWaitTime   100 /* ms as per GDP */
#define	aplcMaxRxOnWaitTime_us   (aplcMaxRxOnWaitTime * 1000UL)
#define	GDP_COMMAND_FRAME_BIT   0x40
#define	GDP_CONF_TX_OPTIONS
#define	GDP_PENDING_DATA_BIT   0x80
#define	PROFILE_ID   PROFILE_ID_ZID

Typedefs
typedef enum gdp_attribute_status_tag	gdp_attribute_status_t
typedef enum gdp_cmd_code_tag	gdp_cmd_code_t
	ZID command codes. More...
typedef struct gdp_conf_complete_req_ind_tag	gdp_conf_complete_req_ind_t
typedef struct gdp_generic_response_req_ind_tag	gdp_generic_response_req_ind_t
typedef struct gdp_get_attr_req_ind_tag	gdp_get_attr_req_ind_t
typedef struct gdp_get_attrrsp_req_ind_tag	gdp_get_attrrsp_req_ind_t
typedef void(*	gdp_heartbeat_confirm_cb_t )(nwk_enum_t Status, uint8_t PairingRef)
typedef struct gdp_msg_struct_tag	gdp_msg_struct_t
typedef struct gdp_push_attr_req_ind_tag	gdp_push_attr_req_ind_t
typedef enum gdp_response_code_tag	gdp_response_code_t
	Handshake response code. More...
typedef enum gdp_state_tag	gdp_state_t

Enumerations
enum	gdp_attribute_status_tag {   GDP_ATTRIBUTE_SUCCESS = 0x00,   GDP_UNSUPPORTED_ATTRIBUTE,   GDP_ILLEGAL_REQUEST }
enum	gdp_cmd_code_tag {   GENERIC_RESPONSE = 0x00,   CONFIGURATION_COMPLETE,   HEART_BEAT,   GET_ATTRIBUTES,   GET_ATTRIBUTES_RESPONSE,   PUSH_ATTRIBUTES }
	ZID command codes. More...
enum	gdp_response_code_tag {   GDP_SUCCESSFUL = 0x00,   GDP_UNSUPPORTED_REQUEST,   GDP_INVALID_PARAMETER,   GDP_CONFIGURATION_FAILURE,   ZID_INVALID_REPORT_ID = 0x40,   ZID_MISSING_FRAGMENT = 0x41 }
	Handshake response code. More...
enum	gdp_state_tag {   GDP_STATE_IDLE,   GDP_SENDING_HEARTBEAT,   GDP_SENDING_GET_ATTRIBUTES_RESPONSE,   GDP_SENDING_GENERIC_RESPONSE,   GDP_WAITING_FOR_ATTRIBUTE_RESPONSE,   GDP_WAITING_FOR_GENERIC_RESPONSE }

Functions
void	gdp_confirm (uint8_t PairingRef, nwk_enum_t status)
void	gdp_indication (gdp_msg_struct_t *gdp_msg, uint8_t rxlinkquality, uint8_t rxflags)
void	gdp_init (void)
	struct for zrc indication callback. More...
bool	gdp_request (gdp_msg_struct_t *gdp_msg)

#define aplcMaxResponseWaitTime   200 /* ms as per GDP*/

The maximum time a device shall wait for a response command frame following a request command frame.

#define aplcMaxResponseWaitTime_us   (aplcMaxResponseWaitTime * 1000UL)

#define aplcMaxRxOnWaitTime   100 /* ms as per GDP */

#define aplcMaxRxOnWaitTime_us   (aplcMaxRxOnWaitTime * 1000UL)

#define GDP_COMMAND_FRAME_BIT   0x40

#define GDP_CONF_TX_OPTIONS

Value:

(TXO_UNICAST | TXO_DST_ADDR_IEEE |  \
	TXO_ACK_REQ | TXO_SEC_REQ | TXO_MULTI_CH | \
	TXO_CH_NOT_SPEC | TXO_VEND_NOT_SPEC)

#define GDP_PENDING_DATA_BIT   0x80

#define PROFILE_ID   PROFILE_ID_ZID

typedef enum gdp_attribute_status_tag gdp_attribute_status_t

typedef enum gdp_cmd_code_tag gdp_cmd_code_t

ZID command codes.

typedef struct gdp_conf_complete_req_ind_tag gdp_conf_complete_req_ind_t

typedef struct gdp_generic_response_req_ind_tag gdp_generic_response_req_ind_t

typedef struct gdp_get_attr_req_ind_tag gdp_get_attr_req_ind_t

typedef struct gdp_get_attrrsp_req_ind_tag gdp_get_attrrsp_req_ind_t

typedef void(* gdp_heartbeat_confirm_cb_t)(nwk_enum_t Status, uint8_t PairingRef)

typedef struct gdp_msg_struct_tag gdp_msg_struct_t

typedef struct gdp_push_attr_req_ind_tag gdp_push_attr_req_ind_t

typedef enum gdp_response_code_tag gdp_response_code_t

Handshake response code.

typedef enum gdp_state_tag gdp_state_t

enum gdp_attribute_status_tag

Enumerator
GDP_ATTRIBUTE_SUCCESS
GDP_UNSUPPORTED_ATTRIBUTE
GDP_ILLEGAL_REQUEST

enum gdp_cmd_code_tag

ZID command codes.

Enumerator
GENERIC_RESPONSE
CONFIGURATION_COMPLETE
HEART_BEAT
GET_ATTRIBUTES
GET_ATTRIBUTES_RESPONSE
PUSH_ATTRIBUTES

enum gdp_response_code_tag

Handshake response code.

Enumerator
GDP_SUCCESSFUL
GDP_UNSUPPORTED_REQUEST
GDP_INVALID_PARAMETER
GDP_CONFIGURATION_FAILURE
ZID_INVALID_REPORT_ID
ZID_MISSING_FRAGMENT

enum gdp_state_tag

Enumerator
GDP_STATE_IDLE
GDP_SENDING_HEARTBEAT
GDP_SENDING_GET_ATTRIBUTES_RESPONSE
GDP_SENDING_GENERIC_RESPONSE
GDP_WAITING_FOR_ATTRIBUTE_RESPONSE
GDP_WAITING_FOR_GENERIC_RESPONSE

void gdp_confirm	(	uint8_t	PairingRef,
		nwk_enum_t	status
	)

void gdp_indication	(	gdp_msg_struct_t *	gdp_msg,
		uint8_t	rxlinkquality,
		uint8_t	rxflags
	)

bool gdp_request

(

gdp_msg_struct_t *

gdp_msg

)