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 |
| struct | advertising_data_status_t |
| Used to indicate if the packet is complete and if it's truncated. More... | |
| struct | advertising_event_t |
| Properties of an advertising event. More... | |
| struct | advertising_filter_policy_t |
| Advertising policy filter modes. More... | |
| struct | advertising_type_t |
| Encapsulates the peripheral advertising modes. More... | |
| 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 | 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... | |
| struct | Bounded |
| Restrict values of an integer type to a defined range. More... | |
| struct | byte_array_t |
| Model fixed size array values. More... | |
| struct | central_privay_configuration_t |
| Privacy configuration of the central role. More... | |
| struct | clock_accuracy_t |
| Accuracy of the master clock. More... | |
| struct | coded_symbol_per_bit_t |
| Type describing the number of symbols per bit in le coded PHY. More... | |
| struct | connection_role_t |
| Enumeration of GAP roles. 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... | |
| struct | disconnection_reason_t |
| Enumeration of disconnection reasons received in a disconnection event. More... | |
| struct | DisconnectionCompleteEvent |
| Event produced when a disconnection is complete. More... | |
| struct | duplicates_filter_t |
| Scanning policy filter mode. More... | |
| struct | Duration |
| Model BLE durations. More... | |
| class | Gap |
| Define device discovery, connection and link management procedures. More... | |
| struct | initiator_filter_policy_t |
| Filter policy that you can use during connection initiation. 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... | |
| struct | local_disconnection_reason_t |
| Enumeration of disconnection reasons that should be transmited to the peer. More... | |
| struct | own_address_type_t |
| Type used to model the own address used during the following GAP operations: advertising, scanning and initiating. 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... | |
| struct | peripheral_privacy_configuration_t |
| Privacy Configuration of the peripheral role. 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... | |
| struct | scanning_filter_policy_t |
| Scanning policy filter mode. 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... | |
| struct | StaticInterface |
| Static Interface helper class. More... | |
| struct | target_peer_address_type_t |
| Type of an address to connect to. More... | |
| struct | UpdateConnectionParametersRequestEvent |
| Event received when a peer wants to change the connection parameters. 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 Duration< uint32_t, 625, Range< 0x20, 0xFFFFFF > > | adv_interval_t |
| Time interval between two advertisements. More... | |
| typedef Duration< uint16_t, 10000, Range< 0x00, 0xFFFF >, Value< uint16_t, 0x0000 > > | adv_duration_t |
| Advertising process duration. More... | |
| typedef Duration< uint16_t, 10000, Range< 0x00, 0xFFFF >, Value< uint16_t, 0x0000 > > | scan_duration_t |
| Scan process duration. More... | |
| typedef Duration< uint16_t, 1280000, Range< 0x00, 0xFFFF > > | scan_period_t |
| Time interval between two scan processes. More... | |
| typedef Duration< uint16_t, 625, Range< 0x04, 0xFFFF > > | scan_interval_t |
| Time interval between two scans. More... | |
| typedef Duration< uint16_t, 625, Range< 0x04, 0xFFFF > > | scan_window_t |
| Duration of a scan. More... | |
| typedef Duration< uint16_t, 1250, Range< 0x06, 0x0C80 > > | conn_interval_t |
| Time interval between two connection events. More... | |
| typedef Duration< uint16_t, 10000, Range< 0x0A, 0x0C80 > > | supervision_timeout_t |
| Time after which a connection is loss of devices have not exchanged data. More... | |
| typedef Duration< uint16_t, 625, Range< 0, 0xFFFF > > | conn_event_length_t |
| Duration of a connection event. More... | |
| typedef Duration< uint16_t, 10000, Range< 0x0A, 0x4000 > > | sync_timeout_t |
| Time after which a periodic sync link is considered lost if the receiver hasn't received anything from the advertiser. More... | |
| typedef Duration< uint16_t, 1250, Range< 0x06, 0xFFFF > > | periodic_interval_t |
| Interval between two periodic advertising events. More... | |
| typedef Bounded< uint16_t, 0, 0x01F3 > | slave_latency_t |
| Number of connection events that can be skipped by the slave. More... | |
| typedef uint8_t | advertising_handle_t |
| Handle of an advertising set. More... | |
| typedef uint16_t | periodic_sync_handle_t |
| Handle of a sync representing a periodic advertiser. More... | |
| typedef uint8_t | advertising_sid_t |
| Identify an advertising SID. More... | |
| typedef int8_t | rssi_t |
| Received signal strength. More... | |
| typedef int8_t | advertising_power_t |
| Describe the advertising power. More... | |
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 91 of file 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 86 of file BLETypes.h.
| typedef byte_array_t<32> dhkey_t |
Diffie-Hellman key.
Definition at line 465 of file BLETypes.h.
| typedef byte_array_t<2> ediv_t |
Used to identify LTK for legacy pairing connections.
Definition at line 450 of file BLETypes.h.
| typedef byte_array_t<16> encryption_block_t |
data to be encrypted
Definition at line 459 of file BLETypes.h.
| typedef byte_array_t<16> irk_t |
128 bit keys used by paired devices
Definition at line 445 of file BLETypes.h.
| typedef Duration<uint32_t, 1> microsecond_t |
Type that represents micro seconds.
Definition at line 252 of file Duration.h.
| typedef Duration<uint32_t, 1000 * microsecond_t::TIME_BASE> millisecond_t |
Type that represents milliseconds.
Definition at line 257 of file Duration.h.
| typedef byte_array_t<16> oob_confirm_t |
secure connections oob confirmation value
Definition at line 456 of file BLETypes.h.
| typedef byte_array_t<16> oob_lesc_value_t |
secure connections oob random 128 value
Definition at line 455 of file BLETypes.h.
| typedef byte_array_t<16> oob_tk_t |
Out of band data exchanged during pairing.
legacy pairing TK
Definition at line 454 of file BLETypes.h.
| typedef uint32_t passkey_num_t |
Passkey stored as a number.
Definition at line 234 of file BLETypes.h.
| typedef byte_array_t<32> public_key_coord_t |
public key coordinate, two of which define the public key
Definition at line 462 of file BLETypes.h.
| typedef Duration<uint32_t, 1000 * millisecond_t::TIME_BASE> second_t |
Type that represents seconds.
Definition at line 262 of file Duration.h.
| typedef uint32_t sign_count_t |
counter for signed data writes done by GattClient
Definition at line 468 of file 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 153 of file BLETypes.h.
| bool ble::is_all_zeros | ( | byte_array_class & | byte_array | ) |
Returns true if every byte is equal to zero.
Definition at line 311 of file 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 439 of file 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 426 of file BLETypes.h.
| void ble::set_all_zeros | ( | byte_array_class & | byte_array | ) |
Zero out all bytes.
Definition at line 324 of file BLETypes.h.
|
static |
Special advertising set handle used as return or parameter to signify an invalid handle.
Definition at line 44 of file BLETypes.h.
|
static |
Special advertising set handle used for the legacy advertising set.
Definition at line 41 of file BLETypes.h.
|
static |
Maximum advertising data length that can fit in a legacy PDU.
Definition at line 47 of file BLETypes.h.