Entry namespace for all BLE API definitions. More...
Data Structures | |
| struct | address_t |
| MAC address data type. More... | |
| struct | adv_data_appearance_t |
| Enumeration of values for the adv_data_type_t::APPEARANCE. More... | |
| struct | adv_data_flags_t |
| Set of advertising flags. More... | |
| struct | adv_data_type_t |
| class | AdvertisingDataBuilder |
| Build advertising data. More... | |
| class | AdvertisingDataParser |
| Parse and iterate over advertising data. More... | |
| class | AdvertisingDataSimpleBuilder |
| Build advertising data. More... | |
| struct | AdvertisingEndEvent |
| Event produced when advertising ends. More... | |
| class | AdvertisingParameters |
| Parameters defining the advertising process. More... | |
| struct | AdvertisingReportEvent |
| Event generated when an advertising packet is seen during passive scanning or a scan response is received during active scanning. More... | |
| struct | AdvertisingStartEvent |
| Event produced when advertising start. More... | |
| class | AP3CordioHCIDriver |
| class | AP3CordioHCITransportDriver |
| struct | att_security_requirement_t |
| Security requirement that can be attached to an attribute operation. More... | |
| struct | attribute_handle_range_t |
| Inclusive range of GATT attributes handles. More... | |
| class | BLE |
| Abstract away BLE-capable radio transceivers or SOCs. More... | |
| struct | Bounded |
| Restrict values of an integer type to a defined range. More... | |
| struct | buf_pool_desc_t |
| Contain description of the memory pool used by the Cordio stack. More... | |
| struct | byte_array_t |
| Model fixed size array values. More... | |
| struct | coded_symbol_per_bit_t |
| Type describing the number of symbols per bit in le coded PHY. More... | |
| struct | ConnectionCompleteEvent |
| Event generated when a connection initiation ends (successfully or not). More... | |
| class | ConnectionParameters |
| Parameters defining the connection initiation process. More... | |
| struct | ConnectionParametersUpdateCompleteEvent |
| Event received when connection parameters have been updated. More... | |
| struct | controller_supported_features_t |
| Features supported by the controller. More... | |
| class | CordioHCIDriver |
| Base class of the HCI driver use by the BLE port of the Cordio stack. More... | |
| class | CordioHCITransportDriver |
| Base class of the HCI transport driver. More... | |
| struct | DisconnectionCompleteEvent |
| Event produced when a disconnection is complete. More... | |
| struct | Duration |
| Model BLE durations. More... | |
| class | Gap |
| Define device discovery, connection and link management procedures. More... | |
| class | GattClient |
| Define procedures required for interacting with a distant GATT server. More... | |
| class | GattServer |
| Construct and operates a GATT server. More... | |
| class | H4TransportDriver |
| Implementation of the H4 driver. More... | |
| struct | io_capability_t |
| Type that describe the IO capability of a device; it is used during Pairing Feature exchange. More... | |
| struct | link_encryption_t |
| Type that describes link's encryption state. More... | |
| class | NRFCordioHCIDriver |
| Nordic port of CordioHCIDriver. More... | |
| class | NRFCordioHCITransportDriver |
| Nordic port of CordioHCITransportDriver. More... | |
| struct | pairing_failure_t |
| Type that describe a pairing failure. More... | |
| class | PasskeyAscii |
| Passkey stored as a string of digits. More... | |
| struct | peer_address_type_t |
| Type that describes a peer device address type. More... | |
| struct | PeriodicAdvertisingReportEvent |
| Event generated when periodic advertising packet is received. More... | |
| struct | PeriodicAdvertisingSyncEstablishedEvent |
| Event generated when you first receive a periodic advertisement. More... | |
| struct | PeriodicAdvertisingSyncLoss |
| Event generated when periodic advertising sync is lost. More... | |
| class | phy_set_t |
| Type that describe a set of PHY(sical) transports. More... | |
| struct | phy_t |
| Type that describes a bluetooth PHY(sical) transport. More... | |
| struct | random_address_type_t |
| Type that describes a random device address type. More... | |
| struct | SafeEnum |
| Helper class used to define safe enumerations. More... | |
| class | ScanParameters |
| Parameters defining the scan process. More... | |
| struct | ScanRequestEvent |
| Event produced when a peer requests a scan response from the advertiser. More... | |
| struct | ScanTimeoutEvent |
| Event generated when scan times out. More... | |
| class | SecurityManager |
| Overview. More... | |
| struct | UpdateConnectionParametersRequestEvent |
| Event received when a peer wants to change the connection parameters. More... | |
| struct | whitelist_t |
| Representation of a whitelist of addresses. More... | |
Typedefs | |
| typedef uintptr_t | connection_handle_t |
| Opaque reference to a connection. More... | |
| typedef uint16_t | attribute_handle_t |
| Reference to an attribute in a GATT database. More... | |
| typedef uint32_t | passkey_num_t |
| Passkey stored as a number. More... | |
| typedef byte_array_t< 16 > | irk_t |
| 128 bit keys used by paired devices More... | |
| typedef byte_array_t< 2 > | ediv_t |
| Used to identify LTK for legacy pairing connections. More... | |
| typedef byte_array_t< 16 > | oob_tk_t |
| Out of band data exchanged during pairing. More... | |
| typedef byte_array_t< 16 > | oob_lesc_value_t |
| secure connections oob random 128 value More... | |
| typedef byte_array_t< 16 > | oob_confirm_t |
| secure connections oob confirmation value More... | |
| typedef byte_array_t< 16 > | encryption_block_t |
| data to be encrypted More... | |
| typedef byte_array_t< 32 > | public_key_coord_t |
| public key coordinate, two of which define the public key More... | |
| typedef byte_array_t< 32 > | dhkey_t |
| Diffie-Hellman key. More... | |
| typedef uint32_t | sign_count_t |
| counter for signed data writes done by GattClient More... | |
| typedef Duration< uint32_t, 1 > | microsecond_t |
| Type that represents micro seconds. More... | |
| typedef Duration< uint32_t, 1000 *microsecond_t::TIME_BASE > | millisecond_t |
| Type that represents milliseconds. More... | |
| typedef Duration< uint32_t, 1000 *millisecond_t::TIME_BASE > | second_t |
| Type that represents seconds. More... | |
| typedef FunctionPointerWithContext< const GattReadCallbackParams * > | ReadCallback_t |
| Attribute read event handler. More... | |
| typedef CallChainOfFunctionPointersWithContext< const GattReadCallbackParams * > | ReadCallbackChain_t |
| Callchain of attribute read event handlers. More... | |
| typedef FunctionPointerWithContext< const GattWriteCallbackParams * > | WriteCallback_t |
| Attribute write event handler. More... | |
| typedef CallChainOfFunctionPointersWithContext< const GattWriteCallbackParams * > | WriteCallbackChain_t |
| Callchain of attribute write event handlers. More... | |
Enumerations |
Functions | |
| static attribute_handle_range_t | attribute_handle_range (attribute_handle_t begin, attribute_handle_t end) |
| Construct an attribute_handle_range_t from its first and last attribute handle. More... | |
| template<class byte_array_class > | |
| bool | is_all_zeros (byte_array_class &byte_array) |
| Returns true if every byte is equal to zero. More... | |
| template<class byte_array_class > | |
| void | set_all_zeros (byte_array_class &byte_array) |
| Zero out all bytes. More... | |
| template<size_t Size> | |
| Span< uint8_t, Size > | make_Span (byte_array_t< Size > &src) |
| Construct a fixed size Span from a byte_array_t. More... | |
| template<size_t Size> | |
| Span< const uint8_t, Size > | make_const_Span (const byte_array_t< Size > &src) |
| Construct a fixed size Span from a const byte_array_t. More... | |
Variables | |
| static const advertising_handle_t | LEGACY_ADVERTISING_HANDLE = 0x00 |
| Special advertising set handle used for the legacy advertising set. More... | |
| static const advertising_handle_t | INVALID_ADVERTISING_HANDLE = 0xFF |
| Special advertising set handle used as return or parameter to signify an invalid handle. More... | |
| static const uint8_t | LEGACY_ADVERTISING_MAX_SIZE = 0x1F |
| Maximum advertising data length that can fit in a legacy PDU. More... | |
Entry namespace for all BLE API definitions.
| typedef uint16_t attribute_handle_t |
Reference to an attribute in a GATT database.
Definition at line 95 of file common/BLETypes.h.
| typedef uintptr_t connection_handle_t |
Opaque reference to a connection.
Internally a connection handle is an unsigned integer capable of holding a pointer.
The real type (either a pointer to an object or an integer) is opaque for users and platform dependent.
Definition at line 90 of file common/BLETypes.h.
| typedef byte_array_t<32> dhkey_t |
Diffie-Hellman key.
Definition at line 472 of file common/BLETypes.h.
| typedef byte_array_t<2> ediv_t |
Used to identify LTK for legacy pairing connections.
Definition at line 457 of file common/BLETypes.h.
| typedef byte_array_t<16> encryption_block_t |
data to be encrypted
Definition at line 466 of file common/BLETypes.h.
| typedef byte_array_t<16> irk_t |
128 bit keys used by paired devices
Definition at line 452 of file common/BLETypes.h.
| typedef Duration<uint32_t, 1> microsecond_t |
Type that represents micro seconds.
Definition at line 298 of file Duration.h.
| typedef Duration<uint32_t, 1000 * microsecond_t::TIME_BASE> millisecond_t |
Type that represents milliseconds.
Definition at line 303 of file Duration.h.
| typedef byte_array_t<16> oob_confirm_t |
secure connections oob confirmation value
Definition at line 463 of file common/BLETypes.h.
| typedef byte_array_t<16> oob_lesc_value_t |
secure connections oob random 128 value
Definition at line 462 of file common/BLETypes.h.
| typedef byte_array_t<16> oob_tk_t |
Out of band data exchanged during pairing.
legacy pairing TK
Definition at line 461 of file common/BLETypes.h.
| typedef uint32_t passkey_num_t |
Passkey stored as a number.
Definition at line 239 of file common/BLETypes.h.
| typedef byte_array_t<32> public_key_coord_t |
public key coordinate, two of which define the public key
Definition at line 469 of file common/BLETypes.h.
| typedef FunctionPointerWithContext<const GattReadCallbackParams *> ReadCallback_t |
Attribute read event handler.
Definition at line 417 of file gatt/GattCallbackParamTypes.h.
Callchain of attribute read event handlers.
Definition at line 422 of file gatt/GattCallbackParamTypes.h.
| typedef Duration<uint32_t, 1000 * millisecond_t::TIME_BASE> second_t |
Type that represents seconds.
Definition at line 308 of file Duration.h.
| typedef uint32_t sign_count_t |
counter for signed data writes done by GattClient
Definition at line 475 of file common/BLETypes.h.
| typedef FunctionPointerWithContext<const GattWriteCallbackParams *> WriteCallback_t |
Attribute write event handler.
Definition at line 429 of file gatt/GattCallbackParamTypes.h.
| typedef CallChainOfFunctionPointersWithContext<const GattWriteCallbackParams *> WriteCallbackChain_t |
Callchain of attribute write event handlers.
Definition at line 436 of file gatt/GattCallbackParamTypes.h.
| enum Keypress_t |
events sent and received when passkey is being entered
Definition at line 906 of file common/BLETypes.h.
|
static |
Construct an attribute_handle_range_t from its first and last attribute handle.
| [in] | begin | Handle at the beginning of the range. |
| [in] | end | Handle at the end of the range. |
Definition at line 157 of file common/BLETypes.h.
| bool ble::is_all_zeros | ( | byte_array_class & | byte_array | ) |
Returns true if every byte is equal to zero.
Definition at line 316 of file common/BLETypes.h.
| Span<const uint8_t, Size> ble::make_const_Span | ( | const byte_array_t< Size > & | src | ) |
Construct a fixed size Span from a const byte_array_t.
| src | byte_array_t to create a Span from. |
src. Definition at line 446 of file common/BLETypes.h.
| Span<uint8_t, Size> ble::make_Span | ( | byte_array_t< Size > & | src | ) |
Construct a fixed size Span from a byte_array_t.
| src | byte_array_t to create a Span from. |
src. Definition at line 433 of file common/BLETypes.h.
| void ble::set_all_zeros | ( | byte_array_class & | byte_array | ) |
Zero out all bytes.
Definition at line 330 of file common/BLETypes.h.
|
static |
Special advertising set handle used as return or parameter to signify an invalid handle.
Definition at line 48 of file common/BLETypes.h.
|
static |
Special advertising set handle used for the legacy advertising set.
Definition at line 45 of file common/BLETypes.h.
|
static |
Maximum advertising data length that can fit in a legacy PDU.
Definition at line 51 of file common/BLETypes.h.