BLE#

This module includes the platform abstraction for BLE Host communication.

The platform needs to implement Bluetooth LE 4.2 or higher.

Modules#

otBleLinkCapabilities

otBleRadioPacket

Typedefs#

typedef struct otBleLinkCapabilities

otBleLinkCapabilities

Represent BLE link capabilities.

typedef struct otBleRadioPacket

otBleRadioPacket

Represents a BLE packet.

Functions#

otError

otPlatBleEnable(otInstance *aInstance)

Enable the Bluetooth Low Energy radio.

otError

otPlatBleDisable(otInstance *aInstance)

Disable the Bluetooth Low Energy radio.

otError

otPlatBleGetAdvertisementBuffer(otInstance *aInstance, uint8_t **aAdvertisementBuffer)

Gets BLE Advertising buffer.

otError

otPlatBleGapAdvSetData(otInstance *aInstance, uint8_t *aAdvertisementData, uint16_t aAdvertisementLen)

Sets BLE Advertising data.

otError

otPlatBleGapAdvStart(otInstance *aInstance, uint16_t aInterval)

Starts BLE Advertising procedure.

otError

otPlatBleGapAdvStop(otInstance *aInstance)

Stops BLE Advertising procedure.

void

otPlatBleGapOnConnected(otInstance *aInstance, uint16_t aConnectionId)

The BLE driver calls this method to notify OpenThread that a BLE Central Device has been connected.

void

otPlatBleGapOnDisconnected(otInstance *aInstance, uint16_t aConnectionId)

The BLE driver calls this method to notify OpenThread that the BLE Central Device has been disconnected.

otError

otPlatBleGapDisconnect(otInstance *aInstance)

Disconnects BLE connection.

otError

otPlatBleGattMtuGet(otInstance *aInstance, uint16_t *aMtu)

Reads currently use value of ATT_MTU.

void

otPlatBleGattOnMtuUpdate(otInstance *aInstance, uint16_t aMtu)

The BLE driver calls this method to notify OpenThread that ATT_MTU has been updated.

otError

otPlatBleGattServerIndicate(otInstance *aInstance, uint16_t aHandle, const otBleRadioPacket *aPacket)

Sends ATT Handle Value Indication.

void

otPlatBleGattServerOnWriteRequest(otInstance *aInstance, uint16_t aHandle, const otBleRadioPacket *aPacket)

The BLE driver calls this method to notify OpenThread that an ATT Write Request packet has been received.

void

otPlatBleGetLinkCapabilities(otInstance *aInstance, otBleLinkCapabilities *aBleLinkCapabilities)

Function to retrieve from platform BLE link capabilities.

bool

otPlatBleSupportsMultiRadio(otInstance *aInstance)

Function to retrieve from platform multiradio support of BLE and IEEE.

Macros#

#define

OT_BLE_TIMESLOT_UNIT 625

Time slot duration on PHY layer in microseconds (0.625ms).

#define

OT_BLE_ADV_INTERVAL_MIN 0x0020

Minimum allowed interval for advertising packet in OT_BLE_ADV_INTERVAL_UNIT units (20ms).

#define

OT_BLE_ADV_INTERVAL_MAX 0x4000

Maximum allowed interval for advertising packet in OT_BLE_ADV_INTERVAL_UNIT units (10.24s).

#define

OT_BLE_ADV_INTERVAL_DEFAULT 100

Default interval for advertising packet (ms).

#define

OT_BLE_ADV_INTERVAL_UNIT OT_BLE_TIMESLOT_UNIT

Unit used to calculate interval duration (0.625ms).

#define

OT_BLE_ATT_MTU_MAX 67

Maximum allowed ATT MTU size (must be >= 23).

#define

OT_BLE_DEFAULT_POWER 0

Default power value for BLE.

#define

OT_TOBLE_SERVICE_UUID 0xfffb

TOBLE service UUID.

Typedef Documentation#

otBleLinkCapabilities#

typedef struct otBleLinkCapabilities otBleLinkCapabilities

Represent BLE link capabilities.

otBleRadioPacket#

typedef struct otBleRadioPacket otBleRadioPacket

Represents a BLE packet.

Function Documentation#

otPlatBleEnable#

otError otPlatBleEnable (otInstance * aInstance)

Enable the Bluetooth Low Energy radio.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.

Note

BLE Device should use the highest ATT_MTU supported that does not exceed OT_BLE_ATT_MTU_MAX octets.

otPlatBleDisable#

otError otPlatBleDisable (otInstance * aInstance)

Disable the Bluetooth Low Energy radio.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.

When disabled, the BLE stack will flush event queues and not generate new events. The BLE peripheral is turned off or put into a low power sleep state. Any dynamic memory used by the stack should be released, but static memory may remain reserved.

otPlatBleGetAdvertisementBuffer#

otError otPlatBleGetAdvertisementBuffer (otInstance * aInstance, uint8_t ** aAdvertisementBuffer, aAdvertisementLen)

Gets BLE Advertising buffer.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint8_t **	[in]	aAdvertisementBuffer	The formatted TCAT advertisement frame.
	[in]	aAdvertisementLen	The TCAT advertisement frame length.

Note

This function shall be used only for BLE Peripheral role. Returned buffer should have enough space to fit max advertisement defined by specification.

otPlatBleGapAdvSetData#

otError otPlatBleGapAdvSetData (otInstance * aInstance, uint8_t * aAdvertisementData, uint16_t aAdvertisementLen)

Sets BLE Advertising data.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint8_t *	[in]	aAdvertisementData	The formatted TCAT advertisement frame.
uint16_t	[in]	aAdvertisementLen	The TCAT advertisement frame length.

Note

This function shall be used only for BLE Peripheral role.

otPlatBleGapAdvStart#

otError otPlatBleGapAdvStart (otInstance * aInstance, uint16_t aInterval)

Starts BLE Advertising procedure.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint16_t	[in]	aInterval	The interval between subsequent advertising packets in OT_BLE_ADV_INTERVAL_UNIT units. Shall be within OT_BLE_ADV_INTERVAL_MIN and OT_BLE_ADV_INTERVAL_MAX range or OT_BLE_ADV_INTERVAL_DEFAULT for a default value set at compile time.

The BLE device shall use undirected advertising with no filter applied. A single BLE Advertising packet must be sent on all advertising channels (37, 38 and 39).

Note

This function shall be used only for BLE Peripheral role.

otPlatBleGapAdvStop#

otError otPlatBleGapAdvStop (otInstance * aInstance)

Stops BLE Advertising procedure.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.

Note

This function shall be used only for BLE Peripheral role.

otPlatBleGapOnConnected#

void otPlatBleGapOnConnected (otInstance * aInstance, uint16_t aConnectionId)

The BLE driver calls this method to notify OpenThread that a BLE Central Device has been connected.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint16_t	[in]	aConnectionId	The identifier of the open connection.

otPlatBleGapOnDisconnected#

void otPlatBleGapOnDisconnected (otInstance * aInstance, uint16_t aConnectionId)

The BLE driver calls this method to notify OpenThread that the BLE Central Device has been disconnected.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint16_t	[in]	aConnectionId	The identifier of the closed connection.

otPlatBleGapDisconnect#

otError otPlatBleGapDisconnect (otInstance * aInstance)

Disconnects BLE connection.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.

The BLE device shall use the Remote User Terminated Connection (0x13) reason code when disconnecting from the peer BLE device..

otPlatBleGattMtuGet#

otError otPlatBleGattMtuGet (otInstance * aInstance, uint16_t * aMtu)

Reads currently use value of ATT_MTU.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint16_t *	[out]	aMtu	A pointer to output the current ATT_MTU value.

otPlatBleGattOnMtuUpdate#

void otPlatBleGattOnMtuUpdate (otInstance * aInstance, uint16_t aMtu)

The BLE driver calls this method to notify OpenThread that ATT_MTU has been updated.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint16_t	[in]	aMtu	The updated ATT_MTU value.

otPlatBleGattServerIndicate#

otError otPlatBleGattServerIndicate (otInstance * aInstance, uint16_t aHandle, const otBleRadioPacket * aPacket)

Sends ATT Handle Value Indication.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint16_t	[in]	aHandle	The handle of the attribute to be indicated.
const otBleRadioPacket *	[in]	aPacket	A pointer to the packet contains value to be indicated.

Note

This function shall be used only for GATT Server.

otPlatBleGattServerOnWriteRequest#

void otPlatBleGattServerOnWriteRequest (otInstance * aInstance, uint16_t aHandle, const otBleRadioPacket * aPacket)

The BLE driver calls this method to notify OpenThread that an ATT Write Request packet has been received.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
uint16_t	[in]	aHandle	The handle of the attribute to be written.
const otBleRadioPacket *	[in]	aPacket	A pointer to the packet contains value to be written to the attribute.

Note

This function shall be used only for GATT Server.

otPlatBleGetLinkCapabilities#

void otPlatBleGetLinkCapabilities (otInstance * aInstance, otBleLinkCapabilities * aBleLinkCapabilities)

Function to retrieve from platform BLE link capabilities.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.
otBleLinkCapabilities *	[out]	aBleLinkCapabilities	The pointer to retrieve the BLE ling capabilities.

otPlatBleSupportsMultiRadio#

bool otPlatBleSupportsMultiRadio (otInstance * aInstance)

Function to retrieve from platform multiradio support of BLE and IEEE.

Parameters

Type	Direction	Argument Name	Description
otInstance *	[in]	aInstance	The OpenThread instance structure.