Push button pairing (PBP) API Functions

Functions
bool	pbp_rec_pair_request (uint8_t RecAppCapabilities, dev_type_t RecDevTypeList[3], profile_id_t RecProfileIdList[7], FUNC_PTR confirm_cb)
	Recipient pair request; target use.
bool	pbp_allow_pairing (nwk_enum_t Status, uint64_t SrcIEEEAddr, uint16_t OrgVendorId, uint8_t OrgVendorString[7], uint8_t OrgUserString[15], uint8_t KeyExTransferCount)
	Allow pairing from application; target use.
void	pbp_rec_pair_confirm (nwk_enum_t Status, uint8_t PairingRef)
	Push button pairing confirm; target and controller use.
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], FUNC_PTR confirm_cb)
	Originator push pairing request; controller use.
void	pbp_org_pair_confirm (nwk_enum_t Status, uint8_t PairingRef)
	Push button pairing confirm; target and controller use.

---

Detailed Description

With this group of functions, the stack provides the API functions that handle functionality regarding the push button pairing (PBP) procedure.

---

Function Documentation

bool pbp_allow_pairing	(	nwk_enum_t	Status,
		uint64_t	SrcIEEEAddr,
		uint16_t	OrgVendorId,
		uint8_t	OrgVendorString[7],
		uint8_t	OrgUserString[15],
		uint8_t	KeyExTransferCount
	)

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

void pbp_org_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.

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],
		FUNC_PTR	confirm_cb
	)

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
confirm_cb	Call back pointer for the confirmation

Returns:

true if command could be handled; else false

void pbp_rec_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.

bool pbp_rec_pair_request	(	uint8_t	RecAppCapabilities,
		dev_type_t	RecDevTypeList[3],
		profile_id_t	RecProfileIdList[7],
		FUNC_PTR	confirm_cb
	)

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
confirm_cb	Call back pointer for the confirmation

Returns:

true if command could be handled; else false