Data Structures
struct	nwk_indication_callback
Typedefs
typedef struct nwk_indication_callback	nwk_indication_callback_t
Functions
bool	nlde_data_request (uint8_t PairingRef, profile_id_t ProfileId, uint16_t VendorId, uint8_t nsduLength, uint8_t *nsdu, uint8_t TxOptions, uint8_t Handle, FUNC_PTR confirm_cb)
	NLDE-DATA.request primitive API.
void	nlde_data_indication (uint8_t PairingRef, profile_id_t ProfileId, uint16_t VendorId, uint8_t nsduLength, uint8_t *nsdu, uint8_t RxLinkQuality, uint8_t RxFlags)
	NLDE-DATA.indication primitive API.
void	nlde_data_confirm (nwk_enum_t Status, uint8_t PairingRef, profile_id_t ProfileId, uint8_t Handle)
	NLDE-DATA.confirm primitive API.
bool	nlme_auto_discovery_request (uint8_t RecAppCapabilities, dev_type_t RecDevTypeList[3], profile_id_t RecProfileIdList[7], uint32_t AutoDiscDuration, FUNC_PTR confirm_cb)
	NLME-AUTO-DISCOVERY.request primitive API.
void	nlme_auto_discovery_confirm (nwk_enum_t Status, uint64_t SrcIEEEAddr)
	NLME-AUTO-DISCOVERY.confirm primitive API.
void	nlme_comm_status_indication (nwk_enum_t Status, uint8_t PairingRef, uint16_t DstPANId, uint8_t DstAddrMode, uint64_t DstAddr)
	NLME-COMM-STATUS.indication primitive API.
bool	nlme_discovery_request (uint16_t DstPANId, uint16_t DstNwkAddr, 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], uint32_t DiscDuration, FUNC_PTR confirm_cb)
	NLME-DISCOVERY.request primitive API.
void	nlme_discovery_indication (nwk_enum_t Status, uint64_t SrcIEEEAddr, uint8_t OrgNodeCapabilities, uint16_t OrgVendorId, uint8_t OrgVendorString[7], uint8_t OrgAppCapabilities, uint8_t OrgUserString[15], dev_type_t OrgDevTypeList[3], profile_id_t OrgProfileIdList[7], dev_type_t SearchDevType, uint8_t RxLinkQuality)
	NLME-DISCOVERY.indication primitive API.
bool	nlme_discovery_response (nwk_enum_t Status, uint64_t DstIEEEAddr, uint8_t RecAppCapabilities, dev_type_t RecDevTypeList[3], profile_id_t RecProfileIdList[7], uint8_t DiscReqLQI)
	NLME-DISCOVERY.response primitive API.
void	nlme_discovery_confirm (nwk_enum_t Status, uint8_t NumNodes, node_desc_t *NodeDescList)
	NLME-DISCOVERY.confirm primitive API.
bool	nlme_get_request (nib_attribute_t NIBAttribute, uint8_t NIBAttributeIndex, FUNC_PTR confirm_cb)
	NLME-GET.request primitive API.
void	nlme_get_confirm (nwk_enum_t Status, nib_attribute_t NIBAttribute, uint8_t NIBAttributeIndex, void *NIBAttributeValue)
	NLME-GET.confirm primitive API.
bool	nlme_pair_request (uint8_t LogicalChannel, uint16_t DstPANId, uint64_t DstIEEEAddr, uint8_t OrgAppCapabilities, dev_type_t OrgDevTypeList[3], profile_id_t OrgProfileIdList[7], uint8_t KeyExTransferCount, FUNC_PTR confirm_cb)
	NLME-PAIR.request primitive API.
void	nlme_pair_indication (nwk_enum_t Status, uint16_t SrcPANId, uint64_t SrcIEEEAddr, uint8_t OrgNodeCapabilities, uint16_t OrgVendorId, uint8_t OrgVendorString[7], uint8_t OrgAppCapabilities, uint8_t OrgUserString[15], dev_type_t OrgDevTypeList[3], profile_id_t OrgProfileIdList[7], uint8_t KeyExTransferCount, uint8_t ProvPairingRef)
	NLME-PAIR.indication primitive API.
bool	nlme_pair_response (nwk_enum_t Status, uint16_t DstPANId, uint64_t DstIEEEAddr, uint8_t RecAppCapabilities, dev_type_t RecDevTypeList[3], profile_id_t RecProfileIdList[7], uint8_t ProvPairingRef)
	NLME-PAIR.response primitive API.
void	nlme_pair_confirm (nwk_enum_t Status, uint8_t PairingRef, uint16_t RecVendorId, uint8_t RecVendorString[7], uint8_t RecAppCapabilities, uint8_t RecUserString[15], dev_type_t RecDevTypeList[3], profile_id_t RecProfileIdList[7])
	NLME-PAIR.confirm primitive API.
bool	nlme_reset_request (bool SetDefaultNIB, FUNC_PTR confirm_cb)
	NLME-RESET.request primitive API.
void	nlme_reset_confirm (nwk_enum_t Status)
	NLME-RESET.confirm primitive API.
bool	nlme_rx_enable_request (uint32_t RxOnDuration, FUNC_PTR confirm_cb)
	NLME-RX-ENABLE.request primitive API.
void	nlme_rx_enable_confirm (nwk_enum_t Status)
	Confirmation callback pointer for NLME-RX-ENABLE request.
bool	nlme_set_request (nib_attribute_t NIBAttribute, uint8_t NIBAttributeIndex, uint8_t *NIBAttributeValue, FUNC_PTR confirm_cb)
	NLME-SET.request primitive API.
void	nlme_set_confirm (nwk_enum_t Status, nib_attribute_t NIBAttribute, uint8_t NIBAttributeIndex)
	NLME-SET.confirm primitive API.
bool	nlme_start_request (FUNC_PTR confirm_cb)
	NLME-START.request primitive API.
void	nlme_start_confirm (nwk_enum_t Status)
	NLME-START.confirm primitive API.
bool	nlme_unpair_request (uint8_t PairingRef, FUNC_PTR confirm_cb)
	NLME-UNPAIR.request primitive API.
void	nlme_unpair_indication (uint8_t PairingRef)
	NLME-UNPAIR.indication primitive API.
bool	nlme_unpair_response (uint8_t PairingRef)
	NLME-UNPAIR.response primitive API.
void	nlme_unpair_confirm (uint8_t Status, uint8_t PairingRef)
	NLME-UNPAIR.confirm primitive API.
bool	nlme_update_key_request (uint8_t PairingRef, uint8_t NewLinkKey[16], FUNC_PTR confirm_cb)
	NLME-UPDATE-KEY.request primitive API.
void	nlme_update_key_confirm (nwk_enum_t Status, uint8_t PairingRef)
	NLME-UPDATE-KEY.confirm primitive API.
bool	nwk_ch_agility_request (nwk_agility_mode_t AgilityMode, FUNC_PTR confirm_cb)
	Sets channel agility mode.
void	nwk_ch_agility_indication (uint8_t LogicalChannel)
	Indicates a channel agility event.
void	nwk_ch_agility_confirm (nwk_enum_t Status, bool ChannelChanged, uint8_t LogicalChannel)
	Confirms the previous channel agility request, i.e. nwk_ch_agility_req()
void	register_nwk_indication_callback (nwk_indication_callback_t *nwk_indication_cb)
	Registering network indication callback.

Detailed Description

With this group of functions, the stack provides the primitives as defined by the standard. The function and parameter names are aligned to those used by the standard. The callback functions (confirm and indication primitives) from the stack have a 'void' return value and the function calls (request and response primitives) to the stack return a boolean value. The return value is 'true' if the stack has accepted the function call. If there is no buffer avaivable to queue the command, the stack returns 'false'.

Typedef Documentation

typedef struct nwk_indication_callback nwk_indication_callback_t

struct for network indication callback. App should use this struct to register indication callback functions

Function Documentation

void nlde_data_confirm	(	nwk_enum_t	Status,
		uint8_t	PairingRef,
		profile_id_t	ProfileId,
		uint8_t	Handle
	)

NLDE-DATA.confirm primitive API.

The NLDE-DATA.confirm primitive is generated by the NWK layer entity in response to an NLDE-DATA.request primitive.

Parameters:

Status	Status for the handled data request
PairingRef	Pairing reference used for the data request
ProfileId	Profile Id used for the data request
Handle	Data retry handle

See also:: nlde_data_request

void nlde_data_indication	(	uint8_t	PairingRef,
		profile_id_t	ProfileId,
		uint16_t	VendorId,
		uint8_t	nsduLength,
		uint8_t *	nsdu,
		uint8_t	RxLinkQuality,
		uint8_t	RxFlags
	)

NLDE-DATA.indication primitive API.

The NLDE-DATA.indication primitive is generated by the NLDE and issued to the application on receipt of a data frame at the local NWK layer entity.

Parameters:

PairingRef	Pairing reference attached to the incoming frame
ProfileId	Profile id used for the frame
VendorId	Vendor id used for the frame
nsduLength	Payload length
nsdu	Pointer to the network payload
RxLinkQuality	Link quality of the received frame
RxFlags	Receive flags

See also:: nlde_data_request, nlde_data_confirm

bool nlde_data_request	(	uint8_t	PairingRef,
		profile_id_t	ProfileId,
		uint16_t	VendorId,
		uint8_t	nsduLength,
		uint8_t *	nsdu,
		uint8_t	TxOptions,
		uint8_t	Handle,
		FUNC_PTR	confirm_cb
	)

NLDE-DATA.request primitive API.

The NLDE-DATA.request primitive requests the transfer of a data APDU (i.e. NSDU) from a local application entity to a peer application entity.

Parameters:

PairingRef	Pairing reference used for the data transmission
ProfileId	Profile Id used for the data transmission
VendorId	Vendor Id used for the data transmission
nsduLength	Length of the network payload
nsdu	Pointer to the payload
TxOptions	Transmission options
Handle	Data retry handle
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlde_data_confirm

void nlme_auto_discovery_confirm	(	nwk_enum_t	Status,
		uint64_t	SrcIEEEAddr
	)

NLME-AUTO-DISCOVERY.confirm primitive API.

The NLME-AUTO-DISCOVERY.confirm primitive allows the NLME to notify the application of the status of its request to enter auto discovery response mode.

Parameters:

Status	Status of the completed auto-discovery procedure
SrcIEEEAddr	Source IEEE address from which the discovery request was received.

See also:: nlme_auto_discovery_request

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

NLME-AUTO-DISCOVERY.request primitive API.

The NLME-AUTO-DISCOVERY.request primitive allows the application to request the NLME automatically handles the receipt of discovery request command frames.

Parameters:

RecAppCapabilities	Recipient application capabilities
RecDevTypeList	Recipient device type list
RecProfileIdList	Recipient profile id list
AutoDiscDuration	auto-discovery duration
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_auto_discovery_confirm

void nlme_comm_status_indication	(	nwk_enum_t	Status,
		uint8_t	PairingRef,
		uint16_t	DstPANId,
		uint8_t	DstAddrMode,
		uint64_t	DstAddr
	)

NLME-COMM-STATUS.indication primitive API.

The NLME-COMM-STATUS.indication primitive allows the NLME to notify the application of a communication status.

Parameters:

Status	Status of the transmission
PairingRef	Pairing reference used for the transmission
DstPANId	Destination PAN Id used for the transmission
DstAddrMode	Destination adress mode used for the transmission
DstAddr	Destination address used for the transmission

void nlme_discovery_confirm	(	nwk_enum_t	Status,
		uint8_t	NumNodes,
		node_desc_t *	NodeDescList
	)

NLME-DISCOVERY.confirm primitive API.

The NLME-DISCOVERY.confirm primitive allows the NLME to notify the application of the status of its request to perform a network discovery.

Parameters:

Status	The status of the network discovery attempt.
NumNodes	The number of discovered nodes in the NodeDescList parameter.
NodeDescList	The (pointer of) list of node descriptors discovered.

See also:: nlme_discovery_request

void nlme_discovery_indication	(	nwk_enum_t	Status,
		uint64_t	SrcIEEEAddr,
		uint8_t	OrgNodeCapabilities,
		uint16_t	OrgVendorId,
		uint8_t	OrgVendorString[7],
		uint8_t	OrgAppCapabilities,
		uint8_t	OrgUserString[15],
		dev_type_t	OrgDevTypeList[3],
		profile_id_t	OrgProfileIdList[7],
		dev_type_t	SearchDevType,
		uint8_t	RxLinkQuality
	)

NLME-DISCOVERY.indication primitive API.

The NLME-DISCOVERY.indication primitive allows the NLME to notify the application that a discovery request command has been received.

Parameters:

Status	The status of the pairing table.
SrcIEEEAddr	The IEEE address of the device requesting the discovery.
OrgNodeCapabilities	The capabilities of the originator of the discovery request.
OrgVendorId	The vendor identifier of the originator of the discovery request.
OrgVendorString	The vendor string of the originator of the discovery request.
OrgAppCapabilities	The application capabilities of the originator of the discovery request.
OrgUserString	The user defined identification string of the originator of the discovery request.
OrgDevTypeList	The list of device types supported by the originator of the discovery request.
OrgProfileIdList	The list of profile identifiers supported by the originator of the discovery request.
SearchDevType	The device type being discovered. If this is 0xff, any type is being requested.
RxLinkQuality	LQI value of the discovery request command frame.

See also:: nlme_discovery_request, nlme_discovery_confirm, nlme_discovery_response

bool nlme_discovery_request	(	uint16_t	DstPANId,
		uint16_t	DstNwkAddr,
		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],
		uint32_t	DiscDuration,
		FUNC_PTR	confirm_cb
	)

NLME-DISCOVERY.request primitive API.

The NLME-DISCOVERY.request primitive allows the application to request the NLME discover other devices of interest operating in the POS of the device.

Parameters:

DstPANId	The PAN identifier of the destination device for the discovery. This value can be set to 0xffff to indicate a wildcard.
DstNwkAddr	The address of the destination device for the discovery. This value can be set to 0xffff to indicate a wildcard.
OrgAppCapabilities	The application capabilities of the node.
OrgDevTypeList	The list of device types supported by the node.
OrgProfileIdList	The list of profile identifiers disclosed as supported by the node.
SearchDevType	The device type to discover. This value can be set to 0xff to indicate a wildcard.
DiscProfileIdListSize	The number of profile identifiers contained in the DiscProfileIdList parameter.
DiscProfileIdList	The list of profile identifiers against which profile identifiers contained in received discovery response command frames will be matched for acceptance.
DiscDuration	The maximum number of MAC symbols to wait for discovery responses.
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_discovery_confirm

bool nlme_discovery_response	(	nwk_enum_t	Status,
		uint64_t	DstIEEEAddr,
		uint8_t	RecAppCapabilities,
		dev_type_t	RecDevTypeList[3],
		profile_id_t	RecProfileIdList[7],
		uint8_t	DiscReqLQI
	)

NLME-DISCOVERY.response primitive API.

The NLME-DISCOVERY.response primitive allows the application to request that the NLME respond to the discovery request command.

Parameters:

Status	The status of the discovery request.
DstIEEEAddr	The IEEE address of the device requesting discovery.
RecAppCapabilities	The application capabilities of the node issuing this primitive.
RecDevTypeList	The list of device types supported by the node issuing this primitive.
RecProfileIdList	The list of profile identifiers supported by the node issuing this primitive.
DiscReqLQI	The LQI value from the associated NLME-DISCOVERY.indication primitive.

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_discovery_indication

void nlme_get_confirm	(	nwk_enum_t	Status,
		nib_attribute_t	NIBAttribute,
		uint8_t	NIBAttributeIndex,
		void *	NIBAttributeValue
	)

NLME-GET.confirm primitive API.

The NLME-GET.confirm primitive allows the NLME to notify the application of the status of its request for the value of a NIB attribute.

Parameters:

Status	The status of the request for NIB attribute information.
NIBAttribute	The identifier of the NIB attribute that was read.
NIBAttributeIndex	The index within the table or array of the specified NIB attribute that was read.
NIBAttributeValue	The value of the NIB attribute that was read.

See also:: nlme_get_request, nwk_get_nib_attribute_size

bool nlme_get_request	(	nib_attribute_t	NIBAttribute,
		uint8_t	NIBAttributeIndex,
		FUNC_PTR	confirm_cb
	)

NLME-GET.request primitive API.

The NLME-GET.request primitive allows the application to request the value of a NIB attribute from the NLME.

Parameters:

NIBAttribute	The identifier of the NIB attribute to read.
NIBAttributeIndex	The index within the table or array of the specified NIB attribute to read.
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_get_confirm

void nlme_pair_confirm	(	nwk_enum_t	Status,
		uint8_t	PairingRef,
		uint16_t	RecVendorId,
		uint8_t	RecVendorString[7],
		uint8_t	RecAppCapabilities,
		uint8_t	RecUserString[15],
		dev_type_t	RecDevTypeList[3],
		profile_id_t	RecProfileIdList[7]
	)

NLME-PAIR.confirm primitive API.

The NLME-PAIR.confirm primitive allows the NLME to notify the application of the status of its request to pair with another device.

Parameters:

Status	The status of the pair attempt.
PairingRef	The pairing table reference for this pairing link.
RecVendorId	The vendor identifier of the originator of the pair response.
RecVendorString	The vendor string of the originator of the pair response.
RecAppCapabilities	The application capabilities of the originator of the pair response.
RecUserString	The user defined identification string of the originator of the pair response.
RecDevTypeList	The list of device types supported by the originator of the pair response.
RecProfileIdList	The list of profile identifiers supported by the originator of the pair response.

See also:: nlme_pair_request

void nlme_pair_indication	(	nwk_enum_t	Status,
		uint16_t	SrcPANId,
		uint64_t	SrcIEEEAddr,
		uint8_t	OrgNodeCapabilities,
		uint16_t	OrgVendorId,
		uint8_t	OrgVendorString[7],
		uint8_t	OrgAppCapabilities,
		uint8_t	OrgUserString[15],
		dev_type_t	OrgDevTypeList[3],
		profile_id_t	OrgProfileIdList[7],
		uint8_t	KeyExTransferCount,
		uint8_t	ProvPairingRef
	)

NLME-PAIR.indication primitive API.

The NLME-PAIR.indication primitive allows the NLME to notify the application of the reception of a pairing request command.

Parameters:

Status	The status of the provisional pairing.
SrcPANId	The PAN identifier of the device requesting the pair.
SrcIEEEAddr	The IEEE address of the device requesting the pair.
OrgNodeCapabilities	The capabilities of the originator of the pair request.
OrgVendorId	The vendor identifier of the originator of the pair request.
OrgVendorString	The vendor string of the originator of the pair request.
OrgAppCapabilities	The application capabilities of the originator of the pair request.
OrgUserString	The user defined identification string of the originator of the pair request.
OrgDevTypeList	The list of device types supported by the originator of the pair request.
OrgProfileIdList	The list of profile identifiers supported by the originator of the pair request.
KeyExTransferCount	The number of transfers being requested to exchange the link key.
ProvPairingRef	The pairing reference that will be used if this pairing request is successful.

See also:: nlme_pair_request, nlme_pair_response

bool nlme_pair_request	(	uint8_t	LogicalChannel,
		uint16_t	DstPANId,
		uint64_t	DstIEEEAddr,
		uint8_t	OrgAppCapabilities,
		dev_type_t	OrgDevTypeList[3],
		profile_id_t	OrgProfileIdList[7],
		uint8_t	KeyExTransferCount,
		FUNC_PTR	confirm_cb
	)

NLME-PAIR.request primitive API.

The NLME-PAIR.request primitive allows the application to request the NLME pair with another device. This primitive would normally be issued following a discovery operation via the NLME-DISCOVERY.request primitive.

Parameters:

LogicalChannel	The logical channel of the device with which to pair.
DstPANId	The PAN identifier of the device with which to pair.
DstIEEEAddr	The IEEE address of the device with which to pair.
OrgAppCapabilities	The application capabilities of the node issuing this primitive.
OrgDevTypeList	The list of device types supported by the node issuing this primitive.
OrgProfileIdList	The list of profile identifiers supported by the node issuing this primitive.
KeyExTransferCount	The number of transfers the target should use to exchange the link key with the pairing originator.
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_pair_confirm

bool nlme_pair_response	(	nwk_enum_t	Status,
		uint16_t	DstPANId,
		uint64_t	DstIEEEAddr,
		uint8_t	RecAppCapabilities,
		dev_type_t	RecDevTypeList[3],
		profile_id_t	RecProfileIdList[7],
		uint8_t	ProvPairingRef
	)

NLME-PAIR.response primitive API.

The NLME-PAIR.response primitive allows the application to request that the NLME respond to a pairing request command.

Parameters:

Status	The status of the pairing request.
DstPANId	The PAN identifier of the device requesting the pair.
DstIEEEAddr	The IEEE address of the device requesting the pair.
RecAppCapabilities	The application capabilities of the node issuing this primitive.
RecDevTypeList	The list of device types supported by the node issuing this primitive.
RecProfileIdList	The list of profile identifiers supported by the node issuing this primitive.
ProvPairingRef	The reference to the provisional pairing entry if the pair was accepted.

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_pair_indication

void nlme_reset_confirm ( nwk_enum_t Status )

NLME-RESET.confirm primitive API.

The NLME-RESET.confirm primitive allows the NLME to notify the application of the status of its request to reset the NWK layer.

Parameters:

Status The status of the reset request.

See also:: nlme_reset_request

bool nlme_reset_request	(	bool	SetDefaultNIB,
		FUNC_PTR	confirm_cb
	)

NLME-RESET.request primitive API.

The NLME-RESET.request primitive allows the application entity to request a reset of the NWK layer.

Parameters:

SetDefaultNIB	If TRUE, the NWK layer is reset and all NIB attributes are set to their default values. If FALSE, the NWK layer is reset but all NIB attributes retain their values prior to the generation of the NLME-RESET.request primitive.
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_reset_confirm

void nlme_rx_enable_confirm ( nwk_enum_t Status )

Confirmation callback pointer for NLME-RX-ENABLE request.

The NLME-RX-ENABLE.confirm primitive reports the results of the attempt to enable or disable the receiver.

Parameters:

Status The result of the request to enable or disable the receiver.

See also:: nlme_rx_enable_request

bool nlme_rx_enable_request	(	uint32_t	RxOnDuration,
		FUNC_PTR	confirm_cb
	)

NLME-RX-ENABLE.request primitive API.

The NLME-RX-ENABLE.request primitive allows the application to request that the receiver is either enabled (for a finite period or until further notice) or disabled.

Parameters:

RxOnDuration The number of MAC symbols for which the receiver is to be enabled. To activate power saving mode, this value should correspond to the value of nwkActivePeriod and nwkActivePeriod should not be equal to 0x000000. If this parameter is equal to 0x000000, the receiver is disabled, allowing the node to enter dormant power save mode. If this parameter is equal to 0xffffff, the receiver is enabled, allowing the node to come out of power save mode.

confirm_cb Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_rx_enable_confirm

void nlme_set_confirm	(	nwk_enum_t	Status,
		nib_attribute_t	NIBAttribute,
		uint8_t	NIBAttributeIndex
	)

NLME-SET.confirm primitive API.

The NLME-SET.confirm primitive allows the NLME to notify the application of the status of its request to change the value of a NIB attribute.

Parameters:

Status	The status of the request to set PIB attribute information.
NIBAttribute	The identifier of the NIB attribute that was written.
NIBAttributeIndex	The index within the table or array of the specified NIB attribute that was written.

See also:: nlme_set_request

bool nlme_set_request	(	nib_attribute_t	NIBAttribute,
		uint8_t	NIBAttributeIndex,
		uint8_t *	NIBAttributeValue,
		FUNC_PTR	confirm_cb
	)

NLME-SET.request primitive API.

The NLME-SET.request primitive allows the application to request the NLME change the value of a NIB attribute.

Parameters:

NIBAttribute	The identifier of the NIB attribute to write.
NIBAttributeIndex	The index within the table or array of the specified NIB attribute to write.
NIBAttributeValue	The value of the indicated attribute to write.
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_set_confirm

void nlme_start_confirm ( nwk_enum_t Status )

NLME-START.confirm primitive API.

The NLME-START.confirm primitive allows the NLME to notify the application of the status of its request to start a network.

Parameters:

Status The status of the start attempt.

See also:: nlme_start_request

bool nlme_start_request ( FUNC_PTR confirm_cb )

NLME-START.request primitive API.

The NLME-START.request primitive allows the application to request the NLME start a network.

Parameters:

confirm_cb Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_start_confirm

void nlme_unpair_confirm	(	uint8_t	Status,
		uint8_t	PairingRef
	)

NLME-UNPAIR.confirm primitive API.

The NLME-UNPAIR.confirm primitive allows the NLME to notify the application of the status of its request to remove a pair with another device.

Parameters:

Status	The status of the unpair attempt.
PairingRef	The pairing table reference for this pairing link.

See also:: nlme_unpair_request

void nlme_unpair_indication ( uint8_t PairingRef )

NLME-UNPAIR.indication primitive API.

The NLME-UNPAIR.indication primitive allows the NLME to notify the application of the removal of a pairing link by another device.

Parameters:

PairingRef The pairing table reference that has been removed from the pairing table.

See also:: nlme_unpair_response

bool nlme_unpair_request	(	uint8_t	PairingRef,
		FUNC_PTR	confirm_cb
	)

NLME-UNPAIR.request primitive API.

The NLME-UNPAIR.request primitive allows the application to request the NLME removes a pairing link with another device both in the local and remote pairing tables.

Parameters:

PairingRef	The reference into the local pairing table of the entry that is to be removed.
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_unpair_confirm

bool nlme_unpair_response ( uint8_t PairingRef )

NLME-UNPAIR.response primitive API.

The NLME-UNPAIR.response primitive allows the application to notify the NLME that the pairing link indicated via the NLME-UNPAIR.indication primitive can be removed from the pairing table.

Parameters:

PairingRef The reference into the local pairing table of the entry that is to be removed.

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_unpair_indication

void nlme_update_key_confirm	(	nwk_enum_t	Status,
		uint8_t	PairingRef
	)

NLME-UPDATE-KEY.confirm primitive API.

The NLME-UPDATE-KEY.confirm primitive allows the NLME to notify the application of the status of its request to change the security link key of a pairing table entry.

Parameters:

Status	The status of the request to update the security link key.
PairingRef	The reference into the local pairing table of the entry whose key is to be updated.

See also:: nlme_update_key_request

bool nlme_update_key_request	(	uint8_t	PairingRef,
		uint8_t	NewLinkKey[16],
		FUNC_PTR	confirm_cb
	)

NLME-UPDATE-KEY.request primitive API.

The NLME-UPDATE-KEY.request primitive allows the application to request the NLME change the security link key of an entry in the pairing table.

Parameters:

PairingRef	The reference into the local pairing table of the entry whose key is to be updated.
NewLinkKey	The security link key to replace the key in the pairing table.
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nlme_update_key_confirm

void nwk_ch_agility_confirm	(	nwk_enum_t	Status,
		bool	ChannelChanged,
		uint8_t	LogicalChannel
	)

Confirms the previous channel agility request, i.e. nwk_ch_agility_req()

Parameters:

Status	Result of last request NWK_SUCCESS Channel agility request is performed successfully. NWK_NOT_PERMITTED Channel agility is not permitted, because power save mode is currently enabled.
ChannelChanged	True if channel changed due to agility feature
LogicalChannel	Current channel

See also:: nwk_ch_agility_request

void nwk_ch_agility_indication ( uint8_t LogicalChannel )

Indicates a channel agility event.

The function indicates that a channel agility event has occured, i.e. the base channel has been changed automatically. The new channel is indicated by the parameter LogicalChannel.

Parameters:

LogicalChannel New/Current channel.

See also:: nwk_ch_agility_request

bool nwk_ch_agility_request	(	nwk_agility_mode_t	AgilityMode,
		FUNC_PTR	confirm_cb
	)

Sets channel agility mode.

The function configures the channel agility mode. Parameters of the channel agility feature, like ScanInterval, EdThreshold, IndicationCountThreshold and AutoChannelMode, can be set via NLME-SET.request. If power save mode is enabled, the channel agility mode is suspended until power save mode is left again.

Parameters:

AgilityMode	Channel agility mode: AG_ONE_SHOT - scans once AG_PERIODIC - starts periodic scanning AG_STOP - stops periodic scanning
confirm_cb	Call back pointer for the confirmation

Returns:: true if request has been added to NHLE-NWK queue successfully; else false

See also:: nwk_ch_agility_confirm

void register_nwk_indication_callback ( nwk_indication_callback_t * nwk_indication_cb )

Registering network indication callback.

The application/profile needs to register the network indication callback functions so that the corresponding function will get called by the network layer on receiving the indication

Parameters:

nwk_indication_callback_t nwk_indication_cb

See also:: nwk_indication_callback_t

		Microcontroller Wireless Solutions

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation