Detailed Description

darkroot-specific data structures

For more information on some of these types, you should get the darkroot subproject from the Meson project, and from there you can check it out locally and look through it.

See also: Darkroot

Typedefs
typedef aceBT_state_t	state_t
	Bluetooth radio state.

typedef ace_status_t	status_t
	Bluetooth API status codes.

typedef aceBT_bdAddr_t	bdAddr_t
	Bluetooth address.

typedef aceBT_bondState_t	bondState_t
	Bluetooth bond state.

typedef aceBT_UUIDType_t	UUIDType_t
	Bluetooth UUID types.

typedef aceBT_uuid_t	uuid_t
	Bluetooth UUID struct.

typedef aceBT_responseType_t	responseType_t
	Type of write operation for a BLE characteristic.

typedef aceBT_sessionHandle	sessionHandle
	Session handle for the lifetime of the Bluetooth application.

typedef aceBT_sessionType_t	sessionType_t
	Bluetooth session type (Classic, Low Energy, Dual)

typedef aceBT_bleConnHandle	bleConnHandle
	Connection handle for the lifetime of a Bluetooth connection.

typedef aceBT_bleConnState_t	bleConnState_t
	BLE connection state.

typedef aceBt_bleConnParam_t	bleConnParam_t
	BLE connection parameters.

typedef aceBT_bleConnRole_t	bleConnRole_t
	BLE connection role.

typedef aceBt_bleConnPriority_t	bleConnPriority_t
	BLE connection priority.

typedef aceBT_gattStatus_t	gattStatus_t
	BLE GATT status.

typedef aceBt_bleAppId_t	bleAppId_t
	BLE application type.

typedef aceBT_bleGattsService_t	bleGattsService_t
	Structure for a GATT Server service.

typedef aceBT_bleGattAttributeFormat	bleGattAttributeFormat
	BLE attribute format.

typedef aceBT_bleGattBlobValue_t	bleGattBlobValue_t
	BLE blob value.

typedef aceBT_bleGattCharacteristicsValue_t	bleGattCharacteristicsValue_t
	BLE GATT Characteristic.

typedef aceBT_bleGattDescriptor_t	bleGattDescriptor_t
	BLE GATT Descriptor.

typedef aceBT_bleGattRecord_t	bleGattRecord_t
	BLE GATT Record (ATT attributes)

typedef aceBT_bleGattServiceType_t	bleGattServiceType_t
	BLE GATT service type.

typedef aceBT_commonCallbacks_t	commonCallbacks_t
	Callback struct of common Classic/LE Bluetooth operations.

typedef aceBT_bleCallbacks_t	bleCallbacks_t
	Callback struct of LE Bluetooth operations.

typedef aceBT_bleGattClientCallbacks_t	bleGattClientCallbacks_t
	Callback struct of GATT Client Bluetooth operations.

MAC address
#define	MAC_ADDR_LEN ACEBT_MAC_ADDR_LEN
	MAC address length.

#define	MAC_ADDR_STR_LEN ACEBT_MAC_ADDR_STR_LEN
	MAC address string representation length (XX:XX:XX:XX:XX:XX)

BLE attribute format
Attribute format used for bleGattAttributeFormat
#define	BLE_FORMAT_UINT8 ACEBT_BLE_FORMAT_UINT8
	UINT8 format.

#define	BLE_FORMAT_UINT16 ACEBT_BLE_FORMAT_UINT16
	UINT16 format.

#define	BLE_FORMAT_UINT32 ACEBT_BLE_FORMAT_UINT32
	UINT32 format.

#define	BLE_FORMAT_SINT8 ACEBT_BLE_FORMAT_SINT8
	SINT8 format.

#define	BLE_FORMAT_SINT16 ACEBT_BLE_FORMAT_SINT16
	SINT16 format.

#define	BLE_FORMAT_SINT32 ACEBT_BLE_FORMAT_SINT32
	SINT32 format.

#define	BLE_FORMAT_SFLOAT ACEBT_BLE_FORMAT_SFLOAT
	SFLOAT format.

#define	BLE_FORMAT_FLOAT ACEBT_BLE_FORMAT_FLOAT
	FLOAT format.

#define	BLE_FORMAT_BLOB ACEBT_BLE_FORMAT_BLOB
	BLOB format.

Macro Definition Documentation

◆ BLE_FORMAT_BLOB

#define BLE_FORMAT_BLOB ACEBT_BLE_FORMAT_BLOB

BLOB format.

Definition at line 79 of file kindlebt_defines.h.

◆ BLE_FORMAT_FLOAT

#define BLE_FORMAT_FLOAT ACEBT_BLE_FORMAT_FLOAT

FLOAT format.

Definition at line 77 of file kindlebt_defines.h.

◆ BLE_FORMAT_SFLOAT

#define BLE_FORMAT_SFLOAT ACEBT_BLE_FORMAT_SFLOAT

SFLOAT format.

Definition at line 75 of file kindlebt_defines.h.

◆ BLE_FORMAT_SINT16

#define BLE_FORMAT_SINT16 ACEBT_BLE_FORMAT_SINT16

SINT16 format.

Definition at line 71 of file kindlebt_defines.h.

◆ BLE_FORMAT_SINT32

#define BLE_FORMAT_SINT32 ACEBT_BLE_FORMAT_SINT32

SINT32 format.

Definition at line 73 of file kindlebt_defines.h.

◆ BLE_FORMAT_SINT8

#define BLE_FORMAT_SINT8 ACEBT_BLE_FORMAT_SINT8

SINT8 format.

Definition at line 69 of file kindlebt_defines.h.

◆ BLE_FORMAT_UINT16

#define BLE_FORMAT_UINT16 ACEBT_BLE_FORMAT_UINT16

UINT16 format.

Definition at line 65 of file kindlebt_defines.h.

◆ BLE_FORMAT_UINT32

#define BLE_FORMAT_UINT32 ACEBT_BLE_FORMAT_UINT32

UINT32 format.

Definition at line 67 of file kindlebt_defines.h.

◆ BLE_FORMAT_UINT8

#define BLE_FORMAT_UINT8 ACEBT_BLE_FORMAT_UINT8

UINT8 format.

Definition at line 63 of file kindlebt_defines.h.

◆ MAC_ADDR_LEN

#define MAC_ADDR_LEN ACEBT_MAC_ADDR_LEN

MAC address length.

Definition at line 48 of file kindlebt_defines.h.

◆ MAC_ADDR_STR_LEN

#define MAC_ADDR_STR_LEN ACEBT_MAC_ADDR_STR_LEN

MAC address string representation length (XX:XX:XX:XX:XX:XX)

Definition at line 52 of file kindlebt_defines.h.

Typedef Documentation

◆ bdAddr_t

typedef aceBT_bdAddr_t bdAddr_t

Bluetooth address.

Definition at line 93 of file kindlebt_defines.h.

◆ bleAppId_t

typedef aceBt_bleAppId_t bleAppId_t

BLE application type.

Definition at line 150 of file kindlebt_defines.h.

◆ bleCallbacks_t

typedef aceBT_bleCallbacks_t bleCallbacks_t

Callback struct of LE Bluetooth operations.

Remarks: For a list of available callbacks, search for the original type in Darkroot

Definition at line 199 of file kindlebt_defines.h.

◆ bleConnHandle

typedef aceBT_bleConnHandle bleConnHandle

Connection handle for the lifetime of a Bluetooth connection.

Definition at line 125 of file kindlebt_defines.h.

◆ bleConnParam_t

typedef aceBt_bleConnParam_t bleConnParam_t

BLE connection parameters.

Definition at line 133 of file kindlebt_defines.h.

◆ bleConnPriority_t

typedef aceBt_bleConnPriority_t bleConnPriority_t

BLE connection priority.

Definition at line 141 of file kindlebt_defines.h.

◆ bleConnRole_t

typedef aceBT_bleConnRole_t bleConnRole_t

BLE connection role.

Definition at line 137 of file kindlebt_defines.h.

◆ bleConnState_t

typedef aceBT_bleConnState_t bleConnState_t

BLE connection state.

Definition at line 129 of file kindlebt_defines.h.

◆ bleGattAttributeFormat

typedef aceBT_bleGattAttributeFormat bleGattAttributeFormat

BLE attribute format.

Definition at line 158 of file kindlebt_defines.h.

◆ bleGattBlobValue_t

typedef aceBT_bleGattBlobValue_t bleGattBlobValue_t

BLE blob value.

When reading/writing a characteristic value/descriptor, data will be given through this struct.

Definition at line 165 of file kindlebt_defines.h.

◆ bleGattCharacteristicsValue_t

typedef aceBT_bleGattCharacteristicsValue_t bleGattCharacteristicsValue_t

BLE GATT Characteristic.

Definition at line 169 of file kindlebt_defines.h.

◆ bleGattClientCallbacks_t

typedef aceBT_bleGattClientCallbacks_t bleGattClientCallbacks_t

Callback struct of GATT Client Bluetooth operations.

Remarks: For a list of available callbacks, search for the original type in Darkroot

Definition at line 206 of file kindlebt_defines.h.

◆ bleGattDescriptor_t

typedef aceBT_bleGattDescriptor_t bleGattDescriptor_t

BLE GATT Descriptor.

Definition at line 173 of file kindlebt_defines.h.

◆ bleGattRecord_t

typedef aceBT_bleGattRecord_t bleGattRecord_t

BLE GATT Record (ATT attributes)

Definition at line 177 of file kindlebt_defines.h.

◆ bleGattServiceType_t

typedef aceBT_bleGattServiceType_t bleGattServiceType_t

BLE GATT service type.

Definition at line 181 of file kindlebt_defines.h.

◆ bleGattsService_t

typedef aceBT_bleGattsService_t bleGattsService_t

Structure for a GATT Server service.

Definition at line 154 of file kindlebt_defines.h.

◆ bondState_t

typedef aceBT_bondState_t bondState_t

Bluetooth bond state.

Definition at line 97 of file kindlebt_defines.h.

◆ commonCallbacks_t

typedef aceBT_commonCallbacks_t commonCallbacks_t

Callback struct of common Classic/LE Bluetooth operations.

Remarks: For a list of available callbacks, search for the original type in Darkroot

Note: Generally no function expects this struct directly, but rather this struct is embedded into the BLE/Classic callbacks structs (such as bleCallbacks_t)

Definition at line 192 of file kindlebt_defines.h.

◆ gattStatus_t

typedef aceBT_gattStatus_t gattStatus_t

BLE GATT status.

Definition at line 146 of file kindlebt_defines.h.

◆ responseType_t

typedef aceBT_responseType_t responseType_t

Type of write operation for a BLE characteristic.

Definition at line 111 of file kindlebt_defines.h.

◆ sessionHandle

typedef aceBT_sessionHandle sessionHandle

Session handle for the lifetime of the Bluetooth application.

Definition at line 116 of file kindlebt_defines.h.

◆ sessionType_t

typedef aceBT_sessionType_t sessionType_t

Bluetooth session type (Classic, Low Energy, Dual)

Definition at line 120 of file kindlebt_defines.h.

◆ state_t

typedef aceBT_state_t state_t

Bluetooth radio state.

Definition at line 85 of file kindlebt_defines.h.

◆ status_t

typedef ace_status_t status_t

Bluetooth API status codes.

Definition at line 89 of file kindlebt_defines.h.

◆ uuid_t

typedef aceBT_uuid_t uuid_t

Bluetooth UUID struct.

The length will depend on the chosen UUIDType_t

Definition at line 107 of file kindlebt_defines.h.

◆ UUIDType_t

typedef aceBT_UUIDType_t UUIDType_t

Bluetooth UUID types.

Definition at line 101 of file kindlebt_defines.h.