High level Bluetooth Low Energy API and radio abstraction layer

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

Auto generated API documentation and code listings for BLE_API


Address_t BLE address
AddressType < A simple container for the enumeration of address-types for Protocol addresses
Gap::AdvertisementCallbackParams_t Structure containing data and metadata of a scanned advertising packet
base Base class for all intances of SafeBool
BatteryService BLE Battery Service
BLE The base class used to abstract away BLE-capable radio transceivers or SOCs, so that the BLE API can work with any radio transparently
BLEInstanceBase The interface for the transport object to be created by the target library's createBLEInstance()
CallChainOfFunctionPointersWithContext< ContextType > Group one or more functions in an instance of a CallChainOfFunctionPointersWithContext , then call them in sequence using CallChainOfFunctionPointersWithContext::call()
CharacteristicDescriptorDiscovery Contain all definitions of callbacks and callbacks parameters types related to characteristic descriptor discovery
Gap::ConnectionCallbackParams_t Encapsulates the parameters of a connection
Gap::ConnectionParams_t Structure containing GAP connection parameters
DeviceInformationService BLE Device Information Service Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml Manufacturer Name String Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.manufacturer_name_string.xml
DFUService Device Firmware Update Service
Gap::DisconnectionCallbackParams_t Structure that encapsulates information about a disconnection event
DiscoveredCharacteristic Representation of a characteristic discovered during a GattClient discovery procedure (see GattClient::launchServiceDiscovery )
DiscoveredCharacteristicDescriptor Representation of a descriptor discovered during a GattClient discovery procedure (see GattClient::discoverCharacteristicDescriptors or DiscoveredCharacteristic::discoverDescriptors )
DiscoveredService Type for holding information about the service and the characteristics found during the discovery process
CharacteristicDescriptorDiscovery::DiscoveryCallbackParams_t Parameter type of CharacteristicDescriptorDiscovery::DiscoveryCallback_t
Eddystone Eddystone Configuration Service
EddystoneConfigService Eddystone Configuration Service
EnvironmentalService BLE Environmental Service
FunctionPointerWithContext< ContextType > A class for storing and calling a pointer to a static or member void function that takes a context
GapAdvertisingData This class provides several helper functions to generate properly formatted GAP Advertising and Scan Response data payloads
GapAdvertisingParams This class provides a wrapper for the core advertising parameters, including the advertising type (Connectable Undirected, Non Connectable Undirected and so on), as well as the advertising and timeout intervals
GapEvents The base class used to abstract away the callback events that can be triggered with the GAP
Gap::GapState_t Describes the current state of the device (more than one bit can be set)
GattAttribute Instances of this class encapsulate the data that belongs to a Bluetooth Low Energy attribute
GattHVXCallbackParams For encapsulating handle-value update events (notifications or indications) generated at the remote server
GattServerEvents The base class used to abstract away the callback events that can be triggered with the GATT Server
HealthThermometerService BLE Health Thermometer Service
HeartRateService BLE Service for HeartRate
iBeacon IBeacon Service
BLE::InitializationCompleteCallbackContext The context provided to init-completion-callbacks (see init() below)
LinkLossService This service defines behavior when a link is lost between two devices
BLE::OnEventsToProcessCallbackContext Parameters provided to the callback registered by onEventsToProcess when there is events to process
GattCharacteristic::PresentationFormat_t GATT presentation format wrapper
DiscoveredCharacteristic::Properties_t Structure that encapsulates the properties of a discovered characteristic
ReadOnlyArrayGattCharacteristic< T, NUM_ELEMENTS > Helper class to construct a read-only GattCharacteristic with an array value
ReadOnlyGattCharacteristic< T > Helper class to construct a read-only GattCharacteristic
ReadWriteArrayGattCharacteristic< T, NUM_ELEMENTS > Helper class to construct a readable and writable GattCharacteristic with an array value
ReadWriteGattCharacteristic< T > Helper class to construct a readable and writable GattCharacteristic
SafeBool< T > Template class SafeBool use CRTP to made boolean conversion easy and correct
CharacteristicDescriptorDiscovery::TerminationCallbackParams_t Parameter type of CharacteristicDescriptorDiscovery::TerminationCallback_t
UARTService BLE Service to enable UART over BLE
URIBeaconConfigService UriBeacon Configuration Service
UUID An instance of this class represents a Universally Unique Identifier ( UUID ) in the BLE API
Gap::Whitelist_t Representation of a Bluetooth Low Enery Whitelist containing addresses
WriteOnlyArrayGattCharacteristic< T, NUM_ELEMENTS > Helper class to construct a write-only GattCharacteristic with an array value
WriteOnlyGattCharacteristic< T > Helper class to construct a write-only GattCharacteristic


BatteryService.h [code]
BLE.cpp [code]
BLE.h [code]
blecommon.h [code]
BLEInstanceBase.cpp [code]
BLEInstanceBase.h [code]
BLEProtocol.h [code]
CallChainOfFunctionPointersWithContext.h [code]
CharacteristicDescriptorDiscovery.h [code]
deprecate.h [code]
DeviceInformationService.h [code]
DFUService.cpp [code]
DFUService.h [code]
DiscoveredCharacteristic.cpp [code]
DiscoveredCharacteristic.h [code]
DiscoveredCharacteristicDescriptor.h [code]
DiscoveredService.h [code]
EddystoneConfigService.h [code]
EddystoneService.h [code]
EnvironmentalService.h [code]
FunctionPointerWithContext.h [code]
Gap.h [code]
GapAdvertisingData.h [code]
GapAdvertisingParams.h [code]
GapEvents.h [code]
GapScanningParams.cpp [code]
GapScanningParams.h [code]
GattAttribute.h [code]
GattCallbackParamTypes.h [code]
GattCharacteristic.h [code]
GattClient.h [code]
GattServer.h [code]
GattServerEvents.h [code]
GattService.h [code]
HealthThermometerService.h [code]
HeartRateService.h [code]
iBeacon.h [code]
LinkLossService.h [code]
SafeBool.h [code]
SecurityManager.h [code]
ServiceDiscovery.h [code]
UARTService.cpp [code]
UARTService.h [code]
URIBeaconConfigService.cpp [code]
URIBeaconConfigService.h [code]
UUID.h [code]


BLEProtocol A common namespace for types and constants used everywhere in BLE API