Microcontroller Wireless Solutions


Vendor specific data transmission API Functions

Functions

bool vendor_data_request (uint8_t PairingRef, profile_id_t ProfileId, uint16_t VendorId, uint8_t nsduLength, uint8_t *nsdu, uint8_t TxOptions)
 Vendor data request.
void vendor_data_ind (uint8_t PairingRef, uint16_t VendorId, uint8_t nsduLength, uint8_t *nsdu, uint8_t RxLinkQuality, uint8_t RxFlags)
 Vendor data indication.
void vendor_data_confirm (nwk_enum_t Status, uint8_t PairingRef, profile_id_t ProfileId, uint8_t Handle)
 Vendor data confirm.
void vendor_app_alive_req (void)
 Vendor data alive request.

Detailed Description

With this group of functions, the stack provides the API functions that handle functionality regarding vendor specific data exchange.


Function Documentation

void vendor_app_alive_req ( void  )

Vendor data alive request.

Hook for the application indicating that an alive request command was received.

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

Vendor data confirm.

Callback function indicating status of the request

Parameters:
StatusStatus of the request
PairingRefPairing reference used for the transmission
HandleData retry handle
void vendor_data_ind ( uint8_t  PairingRef,
uint16_t  VendorId,
uint8_t  nsduLength,
uint8_t *  nsdu,
uint8_t  RxLinkQuality,
uint8_t  RxFlags 
)

Vendor data indication.

Callback function indicating incoming vendor data.

Parameters:
PairingRefPairing reference of the sender
VendorIdVendor id used for the transmission
nsduLengthLength of the payload data
nsduPointer to the payload data
RxLinkQualityLQI of the incoming frame
RxFlagsOptions used for transmission
Returns:
true if command could be handled; else false
bool vendor_data_request ( uint8_t  PairingRef,
profile_id_t  ProfileId,
uint16_t  VendorId,
uint8_t  nsduLength,
uint8_t *  nsdu,
uint8_t  TxOptions 
)

Vendor data request.

The vendor data request allows a device to send a vendor specific data frame.

Parameters:
PairingRefPairing reference of the recipient of the transmission
ProfileIdProfile id used for the transmission
VendorIdVendor id used for the transmission
nsduLengthLength of the payload data
nsduPointer to the payload data
TxOptionsTransit options
Returns:
true if command could be handled; else false