pb_pairing.h File Reference

Declarations of API functions to access push button pairing functionality.

Id:

pb_pairing.h 24049 2010-10-29 14:20:25Z uwalter

Author

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

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

#include "rf4ce.h"

Functions
bool	pbp_org_pair_request (uint8_t OrgAppCapabilities, dev_type_t OrgDevTypeList[3], profile_id_t OrgProfileIdList[7], dev_type_t SearchDevType, uint8_t DiscProfileIdListSize, profile_id_t DiscProfileIdList[7])
	Recipient pair request; target use. More...
void	pbp_pair_confirm (nwk_enum_t Status, uint8_t PairingRef)
	Push button pairing confirm; target and controller use. More...

bool pbp_org_pair_request	(	uint8_t	OrgAppCapabilities,
		dev_type_t	OrgDevTypeList[3],
		profile_id_t	OrgProfileIdList[7],
		dev_type_t	SearchDevType,
		uint8_t	DiscProfileIdListSize,
		profile_id_t	DiscProfileIdList[7]
	)

Recipient pair request; target use.

The push button pairing recipient pair request allows a target to start the push button pairing procedure; auto-discovery and incoming pairing handling.

Parameters

RecAppCapabilities	Application capabilities of the device issuing the request
RecDevTypeList	Supported device type list
RecProfileIdList	Supported profile id list

Returns

true if command could be handled; else false Allow pairing from application; target use

The allow pairing function provides information about the incoming pairing request. It is a hook to handle application specific requirements during the pairing procedure.

Parameters

Status	Status of the pair indication; here NWK_SUCCESS or NWK_DUPLICATE_PAIRING
SrcIEEEAddr	IEEE address of the device requesting the pair
OrgVendorId	Vendor id of the device requesting the pair
OrgVendorString	Vendor string of the device requesting the pair
OrgUserString	User string of the device requesting the pair
KeyExTransferCount	Key exchange transfer count of the incoming pair request

Returns

true if pairing is granted; else false Originator push pairing request; controller use

The push button pairing request allows a controller to start the push pairing procedure; discovery and pair request handling.

Parameters

OrgAppCapabilities	Application capabilities of the device issuing the request
OrgDevTypeList	Supported device type list
OrgProfileIdList	Supported profile id list
SearchDevType	Device type that should be searched for
DiscProfileIdListSize	Profile id list size
DiscProfileIdList	Profile id list

Returns

true if command could be handled; else false

Referenced by nlme_start_confirm().

void pbp_pair_confirm	(	nwk_enum_t	Status,
		uint8_t	PairingRef
	)

Push button pairing confirm; target and controller use.

The push button pairing confirm is a callback that provides the status of the push pairing request.

Parameters

Status	Status of the last pairing transaction
PairingRef	If pairing was successful, PairingRef contains assigned pairing reference.

References aplcMinTargetBlackoutPeriod_us, FUNC_PTR, indicate_fault_behavior(), NWK_SUCCESS, pairing_ref, pal_timer_start(), start_cmd_disc_cb(), T_LED_TIMER, and TIMEOUT_RELATIVE.