ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
mbed-os/features/FEATURE_BLE/ble/BLE.h

1988 lines
79 KiB
C++
Raw Blame History

/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MBED_BLE_H__
#define MBED_BLE_H__
#include "BLERoles.h"
#include "blecommon.h"
#include "ble/Gap.h"
#include "ble/GattServer.h"
#include "ble/GattClient.h"
#include "ble/SecurityManager.h"
#include "ble/FunctionPointerWithContext.h"
#ifdef YOTTA_CFG_MBED_OS
#include "mbed-drivers/mbed_error.h"
#else
#include "platform/mbed_error.h"
#endif
#include "platform/mbed_toolchain.h"
/* Forward declaration for the implementation class */
class BLEInstanceBase;
/**
* @addtogroup ble
* @{
*/
/**
* Abstract away BLE-capable radio transceivers or SOCs.
*
* Instances of this class have three responsibilities:
* - Initialize the inner BLE subsystem.
* - Signal user code that BLE events are available and an API to process them.
* - Manage access to the instances abstracting each BLE layer:
* + GAP: Handle advertising and scan, as well as connection and
* disconnection.
* + GATTServer: API to construct and manage a GATT server, which connected peers can
* access.
* + GATTClient: API to interact with a peer GATT server.
* + SecurityManager: API to manage security.
*
* The user should not create BLE instances directly but rather access to the
* singleton(s) holding the BLE interfaces present in the system by using the
* static function Instance().
*
* @code
* #include "ble/BLE.h"
*
* BLE& ble_interface = BLE::Instance();
* @endcode
*
* Next, the signal handling/process mechanism should be set up. By design,
* Mbed BLE does not impose to the user an event handling/processing mechanism;
* however, it exposes APIs, which allows an application to compose its own:
* - onEventsToProcess(), which registers a callback that
* the BLE subsystem will call when there is an event ready to be processed.
* - processEvents(), which processes all the events present in the BLE subsystem.
*
* It is common to bind BLE event mechanism with Mbed EventQueue:
*
* @code
* #include <events/mbed_events.h>
* #include "ble/BLE.h"
*
* // declare the event queue, which the whole application will share.
* static EventQueue event_queue(4 * EVENTS_EVENT_SIZE);
*
* // Function invoked when there is a BLE event available.
* // Event processing is put into the event queue.
* void schedule_ble_processing(BLE::OnEventsToProcessCallbackContext* context) {
* event_queue.call(callback(&(context->ble), &BLE::processEvents));
* }
*
* int main()
* {
* BLE &ble_interface = BLE::Instance();
*
* // Bind event signaling to schedule_ble_processing
* ble_interface.onEventsToProcess(schedule_ble_processing);
*
* // Launch BLE initialisation
*
* // Dispatch events in the event queue
* event_queue.dispatch_forever();
* return 0;
* }
* @endcode
*
* Once the event processing mechanism is in place, the Bluetooth subsystem can
* be initialized with the init() function. That function accepts in input a
* callback, which will be invoked once the initialization process has finished.
*
* @code
* void on_ble_init_complete(BLE::InitializationCompleteCallbackContext *context)
* {
* BLE& ble_interface = context->ble;
* ble_error_t initialization_error = context->error;
*
* if (initialization_error) {
* // handle error
* return;
* }
*
* // The BLE interface can be accessed now.
* }
*
* int main() {
* BLE &ble_interface = BLE::Instance();
* ble_interface.onEventsToProcess(schedule_ble_processing);
*
* // Initialize the BLE interface
* ble_interface.init(on_ble_init_complete);
*
* event_queue.dispatch_forever();
* return 0;
* }
* @endcode
*/
class BLE {
public:
/**
* Opaque type used to store the ID of a BLE instance.
*/
typedef unsigned InstanceID_t;
/**
* The value of the BLE::InstanceID_t for the default BLE instance.
*/
static const InstanceID_t DEFAULT_INSTANCE = 0;
#ifndef YOTTA_CFG_BLE_INSTANCES_COUNT
/**
* The number of permitted BLE instances for the application.
*/
static const InstanceID_t NUM_INSTANCES = 1;
#else
/**
* The number of permitted BLE instances for the application.
*/
static const InstanceID_t NUM_INSTANCES = YOTTA_CFG_BLE_INSTANCES_COUNT;
#endif
/**
* Get a reference to the BLE singleton corresponding to a given interface.
*
* There is a static array of BLE singletons.
*
* @note Calling Instance() is preferred over constructing a BLE object
* directly because it returns references to singletons.
*
* @param[in] id BLE Instance ID to get.
*
* @return A reference to a single object.
*
* @pre id shall be less than NUM_INSTANCES.
*/
static BLE &Instance(InstanceID_t id = DEFAULT_INSTANCE);
/**
* Fetch the ID of a BLE instance.
*
* @return Instance id of this BLE instance.
*/
InstanceID_t getInstanceID(void) const
{
return instanceID;
}
/**
* Events to process event.
*
* Instances of OnEventsToProcessCallbackContext are passed to the event
* handler registered with onEventsToProcess().
*/
struct OnEventsToProcessCallbackContext {
/**
* The ble instance which have events to process.
*/
BLE &ble;
};
/**
* Events to process event handler
*/
typedef FunctionPointerWithContext<OnEventsToProcessCallbackContext *>
OnEventsToProcessCallback_t;
/**
* Register a callback called when the BLE stack has pending work.
*
* By registering a callback, application code can know when event processing
* has to be scheduled.
*
* @param on_event_cb Callback invoked when there are new events to process.
*/
void onEventsToProcess(const OnEventsToProcessCallback_t &on_event_cb);
/**
* Process ALL pending events living in the BLE stack and return once all
* events have been consumed.
*
* @see onEventsToProcess()
*/
void processEvents();
/**
* Initialization complete event.
*
* This event is generated at the end of the init() procedure and is passed
* to the completion callback passed to init().
*/
struct InitializationCompleteCallbackContext {
/**
* Reference to the BLE object that has been initialized
*/
BLE &ble;
/**
* Error status of the initialization.
*
* That value is set to BLE_ERROR_NONE if initialization completed
* successfully or the appropriate error code otherwise.
* */
ble_error_t error;
};
/**
* Initialization complete event handler.
*
* @note There are two versions of init(). In addition to the
* function-pointer, init() can also take an <Object, member> tuple as its
* callback target. In case of the latter, the following declaration doesn't
* apply.
*/
typedef void (*InitializationCompleteCallback_t)(
InitializationCompleteCallbackContext *context
);
/**
* Initialize the BLE controller/stack.
*
* init() hands control to the underlying BLE module to accomplish
* initialization. This initialization may tacitly depend on other hardware
* setup (such as clocks or power-modes) that happens early on during system
* startup. It may not be safe to call init() from a global static context
* where ordering is compiler-specific and can't be guaranteed - it is safe
* to call BLE::init() from within main().
*
* @param[in] completion_cb A callback for when initialization completes for
* a BLE instance. This is an optional parameter; if no callback is set up,
* the application can still determine the status of initialization using
* BLE::hasInitialized() (see below).
*
* @return BLE_ERROR_NONE if the initialization procedure started
* successfully.
*
* @note If init() returns BLE_ERROR_NONE, the underlying stack must invoke
* the initialization completion callback at some point.
*
* @note Nearly all BLE APIs would return BLE_ERROR_INITIALIZATION_INCOMPLETE
* if used on an instance before the corresponding transport is initialized.
*
* @note There are two versions of init(). In addition to the
* function-pointer, init() can also take an <Object, member> pair as its
* callback target.
*
* @attention This should be called before using anything else in the BLE
* API.
*/
ble_error_t init(InitializationCompleteCallback_t completion_cb = NULL)
{
FunctionPointerWithContext<InitializationCompleteCallbackContext *> callback(completion_cb);
return initImplementation(callback);
}
/**
* Initialize the BLE controller/stack.
*
* This is an alternate declaration for init(). This one takes an
* <Object, member> pair as its callback target.
*
* @param[in] object Object, which will be used to invoke the completion callback.
* @param[in] completion_cb Member function pointer, which will be invoked when
* initialization is complete.
*/
template<typename T>
ble_error_t init(T *object, void (T::*completion_cb)(InitializationCompleteCallbackContext *context))
{
FunctionPointerWithContext<InitializationCompleteCallbackContext *> callback(object, completion_cb);
return initImplementation(callback);
}
/**
* Indicate if the BLE instance has been initialized.
*
* @return true if initialization has completed for the underlying BLE
* transport.
*
* @note The application should set up a callback to signal completion of
* initialization when using init().
*/
bool hasInitialized(void) const;
/**
* Shut down the underlying stack, and reset state of this BLE instance.
*
* @return BLE_ERROR_NONE if the instance was shut down without error or the
* appropriate error code.
*
* @attention init() must be called afterward to reinstate services and
* GAP state. This API offers a way to repopulate the GATT database with new
* services and characteristics.
*/
ble_error_t shutdown(void);
/**
* This call allows the application to get the BLE stack version information.
*
* @return A pointer to a const string representing the version.
*
* @note The BLE API owns the string returned.
*/
const char *getVersion(void);
/**
* Accessor to Gap. All Gap-related functionality requires going through
* this accessor.
*
* @return A reference to a Gap object associated to this BLE instance.
*/
Gap &gap();
/**
* A const alternative to gap().
*
* @return A const reference to a Gap object associated to this BLE instance.
*/
const Gap &gap() const;
#if BLE_FEATURE_GATT_SERVER
/**
* Accessor to GattServer. All GattServer related functionality requires
* going through this accessor.
*
* @return A reference to a GattServer object associated to this BLE instance.
*/
GattServer &gattServer();
/**
* A const alternative to gattServer().
*
* @return A const reference to a GattServer object associated to this BLE
* instance.
*/
const GattServer &gattServer() const;
#endif // BLE_FEATURE_GATT_SERVER
#if BLE_FEATURE_GATT_CLIENT
/**
* Accessors to GattClient. All GattClient related functionality requires
* going through this accessor.
*
* @return A reference to a GattClient object associated to this BLE instance.
*/
GattClient &gattClient();
/**
* A const alternative to gattClient().
*
* @return A const reference to a GattClient object associated to this BLE
* instance.
*/
const GattClient &gattClient() const;
#endif // BLE_FEATURE_GATT_CLIENT
#if BLE_FEATURE_SECURITY
/**
* Accessors to SecurityManager. All SecurityManager-related functionality
* requires going through this accessor.
*
* @return A reference to a SecurityManager object associated to this BLE
* instance.
*/
SecurityManager &securityManager();
/**
* A const alternative to securityManager().
*
* @return A const reference to a SecurityManager object associated to this
* BLE instance.
*/
const SecurityManager &securityManager() const;
#endif // BLE_FEATURE_SECURITY
/**
* Translate error code into a printable string.
*
* @param[in] error Error code returned by BLE functions.
*
* @return A pointer to a const string describing the error.
*/
static const char *errorToString(ble_error_t error);
/*
* Deprecation alert!
* All of the following are deprecated and may be dropped in a future
* release. Documentation should refer to alternative APIs.
*/
public:
/**
* Constructor for a handle to a BLE instance (the BLE stack). BLE handles
* are thin wrappers around a transport object (that is, ptr. to
* BLEInstanceBase).
*
* @param[in] instanceID BLE Instance ID to get.
*
* It is better to create BLE objects as singletons accessed through the
* Instance() method. If multiple BLE handles are constructed for the same
* interface (using this constructor), they share the same underlying
* transport object.
*
* @deprecated Use the Instance() function instead of the constructor.
*/
MBED_DEPRECATED("Use BLE::Instance() instead of BLE constructor.")
BLE(InstanceID_t instanceID = DEFAULT_INSTANCE);
/**
* Yield control to the BLE stack or to other tasks waiting for events.
*
* This is a sleep function that returns when there is an application-specific
* interrupt. This is not interchangeable with WFE() considering that the
* MCU might wake up several times to service the stack before returning
* control to the caller.
*
* @deprecated This function blocks the CPU. Use the pair
* onEventsToProcess() and processEvents().
*/
MBED_DEPRECATED("Use BLE::processEvents() and BLE::onEventsToProcess().")
void waitForEvent(void);
/**
* Set the BTLE MAC address and type.
*
* @param[in] type Type of the address to set.
* @param[in] address Value of the address to set. It is ordered in
* little endian.
*
* @return BLE_ERROR_NONE on success.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::setAddress(). A former call to ble.setAddress(...) should be
* replaced with ble.gap().setAddress(...).
*/
MBED_DEPRECATED("Use ble.gap().setAddress(...)")
ble_error_t setAddress(
BLEProtocol::AddressType_t type,
const BLEProtocol::AddressBytes_t address
);
/**
* Fetch the Bluetooth Low Energy MAC address and type.
*
* @param[out] typeP Type of the current address set.
* @param[out] address Value of the current address.
*
* @return BLE_ERROR_NONE on success.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::getAddress(). A former call to ble.getAddress(...) should be
* replaced with ble.gap().getAddress(...).
*/
MBED_DEPRECATED("Use ble.gap().getAddress(...)")
ble_error_t getAddress(
BLEProtocol::AddressType_t *typeP, BLEProtocol::AddressBytes_t address
)
{
return gap().getAddress(typeP, address);
}
/**
* Set the GAP advertising mode to use for this device.
*
* @param[in] advType New type of advertising to use.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setAdvertisingType(). A former call to
* ble.setAdvertisingType(...) should be replaced with
* ble.gap().setAdvertisingType(...).
*/
MBED_DEPRECATED("Use ble.gap().setAdvertisingType(...)")
void setAdvertisingType(GapAdvertisingParams::AdvertisingType advType);
/**
* Set the advertising interval.
*
* @param[in] interval
* Advertising interval in units of milliseconds. Advertising
* is disabled if interval is 0. If interval is smaller than
* the minimum supported value, then the minimum supported
* value is used instead. This minimum value can be discovered
* using getMinAdvertisingInterval().
*
* This field must be set to 0 if connectionMode is equal
* to ADV_CONNECTABLE_DIRECTED.
*
* @note Decreasing this value allows central devices to detect a
* peripheral faster at the expense of more power being used by the radio
* due to the higher data transmit rate.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setAdvertisingInterval(). A former call to
* ble.setAdvertisingInterval(...) should be replaced with
* ble.gap().setAdvertisingInterval(...).
*
* @note WARNING: This API previously used 0.625ms as the unit for its
* 'interval' argument. That required an explicit conversion from
* milliseconds using Gap::MSEC_TO_GAP_DURATION_UNITS(). This conversion is
* no longer required as the new units are milliseconds. Any application
* code depending on the old semantics needs to be updated accordingly.
*/
MBED_DEPRECATED("Use ble.gap().setAdvertisingInterval(...)")
void setAdvertisingInterval(uint16_t interval);
/**
* Get the minimum advertising interval in milliseconds, which can be used
* for connectable advertising types.
*
* @return Minimum Advertising interval in milliseconds.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::getMinAdvertisingInterval(). A former call to
* ble.getMinAdvertisingInterval(...) should be replaced with
* ble.gap().getMinAdvertisingInterval(...).
*/
MBED_DEPRECATED("Use ble.gap().getMinAdvertisingInterval(...)")
uint16_t getMinAdvertisingInterval(void) const
{
return gap().getMinAdvertisingInterval();
}
/**
* Get the minimum advertising interval in milliseconds, which can be
* used for nonconnectable advertising type.
*
* @return Minimum Advertising interval in milliseconds for nonconnectible mode.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::MinNonConnectableAdvertisingInterval(). A former call to
* ble.getMinNonConnectableAdvertisingInterval(...) should be replaced with
* ble.gap().getMinNonConnectableAdvertisingInterval(...).
*/
MBED_DEPRECATED("Use ble.gap().getMinNonConnectableAdvertisingInterval(...)")
uint16_t getMinNonConnectableAdvertisingInterval(void) const
{
return gap().getMinNonConnectableAdvertisingInterval();
}
/**
* Get the maximum advertising interval in milliseconds.
*
* @return Maximum Advertising interval in milliseconds.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::getMaxAdvertisingInterval(). A former call to
* ble.getMaxAdvertisingInterval(...) should be replaced with
* ble.gap().getMaxAdvertisingInterval(...).
*/
MBED_DEPRECATED("Use ble.gap().getMaxAdvertisingInterval(...)")
uint16_t getMaxAdvertisingInterval(void) const
{
return gap().getMaxAdvertisingInterval();
}
/**
* Set the advertising duration.
*
* A timeout event is genenerated once the advertising period expired.
*
* @param[in] timeout
* Advertising timeout (in seconds) between 0x1 and 0x3FFF (1
* and 16383). Use 0 to disable the advertising timeout.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setAdvertisingTimeout(). A former call to
* ble.setAdvertisingTimeout(...) should be replaced with
* ble.gap().setAdvertisingTimeout(...).
*/
MBED_DEPRECATED("Use ble.gap().setAdvertisingTimeout(...)")
void setAdvertisingTimeout(uint16_t timeout);
/**
* Set up a particular, user-constructed set of advertisement parameters for
* the underlying stack. It would be uncommon for this API to be used
* directly; there are other APIs to tweak advertisement parameters
* individually (see above).
*
* @param[in] advParams The new advertising parameters.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setAdvertisingParams(). A former call to
* ble.setAdvertisingParams(...) should be replaced with
* ble.gap().setAdvertisingParams(...).
*/
MBED_DEPRECATED("Use ble.gap().setAdvertisingParams(...)")
void setAdvertisingParams(const GapAdvertisingParams &advParams);
/**
* Get the current advertising parameters.
*
* @return Read back advertising parameters. Useful for storing and
* restoring parameters rapidly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::getAdvertisingParams(). A former call to
* ble.getAdvertisingParams(...) should be replaced with
* ble.gap().getAdvertisingParams(...).
*/
MBED_DEPRECATED("Use ble.gap().getAdvertisingParams(...)")
const GapAdvertisingParams &getAdvertisingParams(void) const;
/**
* Accumulate an AD structure in the advertising payload. Please note that
* the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
* as an additional 31 bytes if the advertising payload is too
* small.
*
* @param[in] flags
* The flags to add. Please refer to
* GapAdvertisingData::Flags for valid flags. Multiple
* flags may be specified in combination.
*
* @return BLE_ERROR_NONE if the data was successfully added to the
* advertising payload.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::accumulateAdvertisingPayload(uint8_t). A former call to
* ble.accumulateAdvertisingPayload(flags) should be replaced with
* ble.gap().accumulateAdvertisingPayload(flags).
*/
MBED_DEPRECATED("Use ble.gap().accumulateAdvertisingPayload(flags)")
ble_error_t accumulateAdvertisingPayload(uint8_t flags);
/**
* Accumulate an AD structure in the advertising payload. Please note that
* the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
* as an additional 31 bytes if the advertising payload is too
* small.
*
* @param[in] app
* The appearance of the peripheral.
*
* @return BLE_ERROR_NONE if the data was successfully added to the
* advertising payload.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::accumulateAdvertisingPayload(GapAdvertisingData::Appearance).
* A former call to ble.accumulateAdvertisingPayload(appearance)
* should be replaced with
* ble.gap().accumulateAdvertisingPayload(appearance).
*/
MBED_DEPRECATED("Use ble.gap().accumulateAdvertisingPayload(appearance)")
ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::Appearance app);
/**
* Accumulate an AD structure in the advertising payload. Please note that
* the payload is limited to 31 bytes. The SCAN_RESPONSE message may be used
* as an additional 31 bytes if the advertising payload is too
* small.
*
* @param[in] power
* The max transmit power to be used by the controller. This
* is only a hint.
*
* @return BLE_ERROR_NONE if the data was successfully added to the
* advertising payload.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::accumulateAdvertisingPayloadTxPower(). A former call to
* ble.accumulateAdvertisingPayloadTxPower(txPower) should be replaced with
* ble.gap().accumulateAdvertisingPayloadTxPower(txPower).
*/
MBED_DEPRECATED("Use ble.gap().accumulateAdvertisingPayloadTxPower(...)")
ble_error_t accumulateAdvertisingPayloadTxPower(int8_t power);
/**
* Accumulate a variable length byte-stream as an AD structure in the
* advertising payload. Please note that the payload is limited to 31 bytes.
* The SCAN_RESPONSE message may be used as an additional 31 bytes if the
* advertising payload is too small.
*
* @param type The type that describes the variable length data.
* @param data Data bytes.
* @param len Data length.
*
* @return BLE_ERROR_NONE if the advertisement payload was updated based on
* matching AD type; otherwise, an appropriate error.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::accumulateAdvertisingPayload(GapAdvertisingData::DataType, const uint8_t, uint8_t).
* A former call to ble.accumulateAdvertisingPayload(...) should
* be replaced with ble.gap().accumulateAdvertisingPayload(...).
*/
MBED_DEPRECATED("Use ble.gap().accumulateAdvertisingPayload(...)")
ble_error_t accumulateAdvertisingPayload(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len);
/**
* Set up a particular, user-constructed advertisement payload for the
* underlying stack. It would be uncommon for this API to be used directly;
* there are other APIs to build an advertisement payload (see above).
*
* @param[in] advData Advertising data to set.
*
* @return BLE_ERROR_NONE if the advertising data was set successfully.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::setAdvertisingData(). A former call to
* ble.setAdvertisingData(...) should be replaced with
* ble.gap().setAdvertisingPayload(...).
*/
MBED_DEPRECATED("Use ble.gap().setAdvertisingData(...)")
ble_error_t setAdvertisingData(const GapAdvertisingData &advData);
/**
* Get a reference to the current advertising payload.
*
* @return Read back advertising data. Useful for storing and
* restoring payload.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::getAdvertisingData(). A former call to
* ble.getAdvertisingData(...) should be replaced with
* ble.gap().getAdvertisingPayload()(...).
*/
MBED_DEPRECATED("Use ble.gap().getAdvertisingData(...)")
const GapAdvertisingData &getAdvertisingData(void) const;
/**
* Reset any advertising payload prepared from prior calls to
* accumulateAdvertisingPayload(). This automatically propagates the re-
* initialized advertising payload to the underlying stack.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::clearAdvertisingPayload(). A former call to
* ble.clearAdvertisingPayload(...) should be replaced with
* ble.gap().clearAdvertisingPayload(...).
*/
MBED_DEPRECATED("Use ble.gap().clearAdvertisingPayload(...)")
void clearAdvertisingPayload(void);
/**
* Dynamically reset the accumulated advertising
* payload and scanResponse. The application must clear and re-
* accumulate a new advertising payload (and scanResponse) before using this
* API.
*
* @return BLE_ERROR_NONE when the advertising payload is set successfully.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::setAdvertisingPayload().
*
* @note The new APIs in Gap update the underlying advertisement payload
* implicitly.
*/
MBED_DEPRECATED("Use ble.gap().setAdvertisingPayload(...)")
ble_error_t setAdvertisingPayload(void);
/**
* Accumulate a variable length byte-stream as an AD structure in the
* scanResponse payload.
*
* @param[in] type The type that describes the variable length data.
* @param[in] data Data bytes.
* @param[in] len Data length.
*
* @return BLE_ERROR_NONE if the data was successfully added to the scan
* response payload.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::accumulateScanResponse(). A former call to
* ble.accumulateScanResponse(...) should be replaced with
* ble.gap().accumulateScanResponse(...).
*/
MBED_DEPRECATED("Use ble.gap().accumulateScanResponse(...)")
ble_error_t accumulateScanResponse(GapAdvertisingData::DataType type, const uint8_t *data, uint8_t len);
/**
* Reset any scan response prepared from prior calls to
* accumulateScanResponse().
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::clearScanResponse(). A former call to
* ble.clearScanResponse(...) should be replaced with
* ble.gap().clearScanResponse(...).
*/
MBED_DEPRECATED("Use ble.gap().clearScanResponse(...)")
void clearScanResponse(void);
/**
* Start advertising.
*
* @return BLE_ERROR_NONE if the advertising procedure successfully
* started.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::startAdvertising(). A former call to
* ble.startAdvertising(...) should be replaced with
* ble.gap().startAdvertising(...).
*/
MBED_DEPRECATED("Use ble.gap().startAdvertising(...)")
ble_error_t startAdvertising(void);
/**
* Stop advertising.
*
* @return BLE_ERROR_NONE if the advertising procedure has been successfully
* stopped.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::stopAdvertising(). A former call to
* ble.stopAdvertising(...) should be replaced with
* ble.gap().stopAdvertising(...).
*/
MBED_DEPRECATED("Use ble.gap().stopAdvertising(...)")
ble_error_t stopAdvertising(void);
/**
* Set up parameters for GAP scanning (observer mode).
*
* @param[in] interval
* Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
* @param[in] window
* Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
* @param[in] timeout
* Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables timeout.
* @param[in] activeScanning
* Set to True if active-scanning is required. This is used to fetch the
* scan response from a peer if possible.
*
* @return BLE_ERROR_NONE if the scan parameters were correctly set.
*
* The scanning window divided by the interval determines the duty cycle for
* scanning. For example, if the interval is 100ms and the window is 10ms,
* then the controller will scan for 10 percent of the time. It is possible
* to have the interval and window set to the same value. In this case,
* scanning is continuous, with a change of scanning frequency once every
* interval.
*
* Once the scanning parameters have been configured, scanning can be
* enabled by using startScan().
*
* @note The scan interval and window are recommendations to the BLE stack.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setScanParams(). A former call to
* ble.setScanParams(...) should be replaced with
* ble.gap().setScanParams(...).
*/
MBED_DEPRECATED("Use ble.gap().setScanParams(...)")
ble_error_t setScanParams(
uint16_t interval = GapScanningParams::SCAN_INTERVAL_MAX,
uint16_t window = GapScanningParams::SCAN_WINDOW_MAX,
uint16_t timeout = 0,
bool activeScanning = false
);
/**
* Set up the scanInterval parameter for GAP scanning (observer mode).
*
* @param[in] interval
* Scan interval (in milliseconds) [valid values lie between 2.5ms and 10.24s].
*
* @return BLE_ERROR_NONE if the scan interval was correctly set.
*
* The scanning window divided by the interval determines the duty cycle for
* scanning. For example, if the interval is 100ms and the window is 10ms,
* then the controller will scan for 10 percent of the time. It is possible
* to have the interval and window set to the same value. In this case,
* scanning is continuous, with a change of scanning frequency once every
* interval.
*
* Once the scanning parameters have been configured, scanning can be
* enabled by using startScan().
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setScanInterval(). A former call to
* ble.setScanInterval(interval) should be replaced with
* ble.gap().setScanInterval(interval).
*/
MBED_DEPRECATED("Use ble.gap().setScanInterval(...)")
ble_error_t setScanInterval(uint16_t interval);
/**
* Set up the scanWindow parameter for GAP scanning (observer mode).
*
* @param[in] window
* Scan Window (in milliseconds) [valid values lie between 2.5ms and 10.24s].
*
* @return BLE_ERROR_NONE if the scan window was correctly set.
*
* The scanning window divided by the interval determines the duty cycle for
* scanning. For example, if the interval is 100ms and the window is 10ms,
* then the controller will scan for 10 percent of the time. It is possible
* to have the interval and window set to the same value. In this case,
* scanning is continuous, with a change of scanning frequency once every
* interval.
*
* Once the scanning parameters have been configured, scanning can be
* enabled by using startScan().
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setScanWindow(). A former call to
* ble.setScanWindow(window) should be replaced with
* ble.gap().setScanWindow(window).
*/
MBED_DEPRECATED("Use ble.gap().setScanWindow(...)")
ble_error_t setScanWindow(uint16_t window);
/**
* Set up parameters for GAP scanning (observer mode).
*
* @param[in] timeout
* Scan timeout (in seconds) between 0x0001 and 0xFFFF; 0x0000 disables timeout.
*
* @return BLE_ERROR_NONE if the scan timeout was correctly set.
*
* The scanning window divided by the interval determines the duty cycle for
* scanning. For example, if the interval is 100ms and the window is 10ms,
* then the controller will scan for 10 percent of the time. It is possible
* to have the interval and window set to the same value. In this case,
* scanning is continuous, with a change of scanning frequency once every
* interval.
*
* Once the scanning parameters have been configured, scanning can be
* enabled by using startScan().
*
* @note The scan interval and window are recommendations to the BLE stack.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setScanTimeout(). A former call to
* ble.setScanTimeout(...) should be replaced with
* ble.gap().setScanTimeout(...).
*/
MBED_DEPRECATED("Use ble.gap().setScanTimeout(...)")
ble_error_t setScanTimeout(uint16_t timeout);
/**
* Set up parameters for GAP scanning (observer mode).
*
* @param[in] activeScanning
* Set to True if active-scanning is required. This is used to fetch the
* scan response from a peer if possible.
*
* Once the scanning parameters have been configured, scanning can be
* enabled by using startScan().
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::setActiveScan(). A former call to
* ble.setActiveScan(...) should be replaced with
* ble.gap().setActiveScanning(...).
*/
MBED_DEPRECATED("Use ble.gap().setActiveScan(...)")
void setActiveScan(bool activeScanning);
/**
* Start scanning (Observer Procedure) based on the parameters currently in
* effect.
*
* @param[in] callback
* The application-specific callback to be invoked upon
* receiving every advertisement report. This can be passed in
* as NULL, in which case scanning may not be enabled at all.
*
* @return BLE_ERROR_NONE if the device successfully started the scan
* procedure.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::startScan(). A former call to
* ble.startScan(callback) should be replaced with
* ble.gap().startScan(callback).
*/
MBED_DEPRECATED("Use ble.gap().startScan(callback)")
ble_error_t startScan(void (*callback)(const Gap::AdvertisementCallbackParams_t *params));
/**
* Start the scanning procedure.
*
* Packets received during the scan procedure are forwarded to the
* scan packet handler passed as argument to this function.
*
* @param[in] object Instance used to invoke @p callbackMember.
*
* @param[in] memberCallback Advertisement packet event handler. Upon
* reception of an advertising packet, the packet is forwarded to @p
* callback invoked from @p object.
*
* @return BLE_ERROR_NONE if the device successfully started the scan
* procedure.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::startScan(). A former call to
* ble.startScan(callback) should be replaced with
* ble.gap().startScan(object, callback).
*/
template<typename T>
MBED_DEPRECATED("Use ble.gap().startScan(object, callback)")
ble_error_t startScan(T *object, void (T::*memberCallback)(const Gap::AdvertisementCallbackParams_t *params));
/**
* Stop scanning. The current scanning parameters remain in effect.
*
* @return BLE_ERROR_NONE if successfully stopped scanning procedure.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::stopScan(). A former call to
* ble.stopScan() should be replaced with
* ble.gap().stopScan().
*/
MBED_DEPRECATED("Use ble.gap().stopScan()")
ble_error_t stopScan(void)
{
return gap().stopScan();
}
/**
* Create a connection (GAP Link Establishment).
*
* @param peerAddr
* 48-bit address, LSB format.
* @param peerAddrType
* Address type of the peer.
* @param connectionParams
* Connection parameters.
* @param scanParams
* Parameters to use while scanning for the peer.
*
* @return BLE_ERROR_NONE if connection establishment procedure is started
* successfully. The onConnection callback (if set) is invoked upon
* a connection event.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::connect(). A former call to
* ble.connect(...) should be replaced with
* ble.gap().connect(...).
*/
MBED_DEPRECATED("Use ble.gap().connect(...)")
ble_error_t connect(
const BLEProtocol::AddressBytes_t peerAddr,
BLEProtocol::AddressType_t peerAddrType = BLEProtocol::AddressType::RANDOM_STATIC,
const Gap::ConnectionParams_t *connectionParams = NULL,
const GapScanningParams *scanParams = NULL
);
/**
* This call initiates the disconnection procedure, and its completion is
* communicated to the application with an invocation of the
* onDisconnection callback.
*
* @param[in] connectionHandle
* @param[in] reason
* The reason for disconnection; sent back to the peer.
*
* @return BLE_ERROR_NONE if the disconnection procedure successfully
* started.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* GAP::disconnect(). A former call to
* ble.disconnect(...) should be replaced with
* ble.gap().disconnect(...).
*/
MBED_DEPRECATED("Use ble.gap().disconnect(...)")
ble_error_t disconnect(Gap::Handle_t connectionHandle, Gap::DisconnectionReason_t reason);
/**
* This call initiates the disconnection procedure, and its completion
* is communicated to the application with an invocation of the
* onDisconnection callback.
*
* @param reason
* The reason for disconnection; sent back to the peer.
*
* @return BLE_ERROR_NONE if the disconnection procedure successfully
* started.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::disconnect(). A former call to
* ble.disconnect(reason) should be replaced with
* ble.gap().disconnect(reason).
*
* @note This version of disconnect() doesn't take a connection handle. It
* works reliably only for stacks that are limited to a single
* connection.
*/
MBED_DEPRECATED("Use ble.gap().disconnect(...)")
ble_error_t disconnect(Gap::DisconnectionReason_t reason);
/**
* Returns the current Gap state of the device using a bitmask that
* describes whether the device is advertising or connected.
*
* @return The current GAP state of the device.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::getState(). A former call to
* ble.getGapState() should be replaced with
* ble.gap().getState().
*/
MBED_DEPRECATED("Use ble.gap().getState()")
Gap::GapState_t getGapState(void) const;
/**
* Get the GAP peripheral's preferred connection parameters. These are the
* defaults that the peripheral would like to have in a connection. The
* choice of the connection parameters is eventually up to the central.
*
* @param[out] params
* The structure where the parameters will be stored. The caller owns memory
* for this.
*
* @return BLE_ERROR_NONE if the parameters were successfully filled into
* the given structure pointed to by params.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::getPreferredConnectionParams(). A former call to
* ble.getPreferredConnectionParams() should be replaced with
* ble.gap().getPreferredConnectionParams().
*/
MBED_DEPRECATED("Use ble.gap().getPreferredConnectionParams(...)")
ble_error_t getPreferredConnectionParams(Gap::ConnectionParams_t *params)
{
return gap().getPreferredConnectionParams(params);
}
/**
* Set the GAP peripheral's preferred connection parameters. These are the
* defaults that the peripheral would like to have in a connection. The
* choice of the connection parameters is eventually up to the central.
*
* @param[in] params
* The structure containing the desired parameters.
*
* @return BLE_ERROR_NONE if the preferred connection parameters were set
* correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setPreferredConnectionParams(). A former call to
* ble.setPreferredConnectionParams() should be replaced with
* ble.gap().setPreferredConnectionParams().
*/
MBED_DEPRECATED("Use ble.gap().setPreferredConnectionParams(...)")
ble_error_t setPreferredConnectionParams(const Gap::ConnectionParams_t *params)
{
return gap().setPreferredConnectionParams(params);
}
/**
* Update connection parameters while in the peripheral role.
*
* @details In the peripheral role, this will send the corresponding L2CAP request to the connected peer and wait for
* the central to perform the procedure.
*
* @param[in] handle
* Connection Handle
* @param[in] params
* Pointer to desired connection parameters. If NULL is provided on a peripheral role,
* the parameters in the PPCP characteristic of the GAP service will be used instead.
*
* @return BLE_ERROR_NONE if the connection parameters were updated correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::updateConnectionParams(). A former call to
* ble.updateConnectionParams() should be replaced with
* ble.gap().updateConnectionParams().
*/
MBED_DEPRECATED("Use ble.gap().updateConnectionParams(...)")
ble_error_t updateConnectionParams(Gap::Handle_t handle, const Gap::ConnectionParams_t *params);
/**
* Set the device name characteristic in the Gap service.
*
* @param[in] deviceName
* The new value for the device-name. This is a UTF-8 encoded, <b>NULL-terminated</b> string.
*
* @return BLE_ERROR_NONE if the device name was set correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setDeviceName(). A former call to
* ble.setDeviceName() should be replaced with
* ble.gap().setDeviceName().
*/
MBED_DEPRECATED("Use ble.gap().setDeviceName(...)")
ble_error_t setDeviceName(const uint8_t *deviceName)
{
return gap().setDeviceName(deviceName);
}
/**
* Get the value of the device name characteristic in the Gap service.
*
* @param[out] deviceName
* Pointer to an empty buffer where the UTF-8 *non NULL-
* terminated* string will be placed. Set this
* value to NULL to obtain the deviceName-length
* from the 'length' parameter.
*
* @param[in,out] lengthP
* (on input) Length of the buffer pointed to by deviceName;
* (on output) the complete device name length (without the
* null terminator).
*
* @return BLE_ERROR_NONE if the device name was fetched correctly from the
* underlying BLE stack.
*
* @note If the device name is longer than the size of the supplied buffer,
* the length will return the complete device name length and not the
* number of bytes actually returned in deviceName. The application may
* use this information to retry with a suitable buffer size.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::getDeviceName(). A former call to
* ble.getDeviceName() should be replaced with
* ble.gap().getDeviceName().
*/
MBED_DEPRECATED("Use ble.gap().getDeviceName(...)")
ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP)
{
return gap().getDeviceName(deviceName, lengthP);
}
/**
* Set the appearance characteristic in the Gap service.
*
* @param[in] appearance
* The new value for the device-appearance.
*
* @return BLE_ERROR_NONE if the new appearance was set correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setAppearance(). A former call to
* ble.setAppearance() should be replaced with
* ble.gap().setAppearance().
*/
MBED_DEPRECATED("Use ble.gap().setAppearance(...)")
ble_error_t setAppearance(GapAdvertisingData::Appearance appearance)
{
return gap().setAppearance(appearance);
}
/**
* Get the appearance characteristic in the Gap service.
*
* @param[out] appearanceP
* The new value for the device-appearance.
*
* @return BLE_ERROR_NONE if the device-appearance was fetched correctly
* from the underlying BLE stack.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::getAppearance(). A former call to
* ble.getAppearance() should be replaced with
* ble.gap().getAppearance().
*/
MBED_DEPRECATED("Use ble.gap().getAppearance(...)")
ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP)
{
return gap().getAppearance(appearanceP);
}
/**
* Set the radio's transmit power.
*
* @param[in] txPower Radio transmit power in dBm.
*
* @return BLE_ERROR_NONE if the new radio's transmit power was set
* correctly.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::setTxPower(). A former call to
* ble.setTxPower() should be replaced with
* ble.gap().setTxPower().
*/
MBED_DEPRECATED("Use ble.gap().setTxPower(...)")
ble_error_t setTxPower(int8_t txPower);
/**
* Query the underlying stack for permitted arguments for setTxPower().
*
* @param[out] valueArrayPP
* Out parameter to receive the immutable array of Tx values.
* @param[out] countP
* Out parameter to receive the array's size.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::getPermittedTxPowerValues(). A former call to
* ble.getPermittedTxPowerValues() should be replaced with
* ble.gap().getPermittedTxPowerValues().
*/
MBED_DEPRECATED("Use ble.gap().getPermittedTxPowerValues(...)")
void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP);
#if BLE_FEATURE_GATT_SERVER
/**
* Add a service declaration to the local server ATT table. Also add the
* characteristics contained within.
*
* @param[in] service The service to be added; attribute handle of services,
* characteristic and characteristic descriptors are updated by the
* process.
*
* @return BLE_ERROR_NONE if the service was successfully added.
*
* @deprecated You should use the parallel API from GattServer directly, refer to
* GattServer::addService(). A former call
* to ble.addService() should be replaced with
* ble.gattServer().addService().
*/
MBED_DEPRECATED("Use ble.gattServer().addService(...)")
ble_error_t addService(GattService &service)
{
return gattServer().addService(service);
}
/**
* Read the value of a characteristic from the local GattServer.
*
* @param[in] attributeHandle
* Attribute handle for the value attribute of the characteristic.
* @param[out] buffer
* A buffer to hold the value being read.
* @param[in,out] lengthP
* Length of the buffer being supplied. If the attribute
* value is longer than the size of the supplied buffer,
* this variable will return the total attribute value length
* (excluding offset). The application may use this
* information to allocate a suitable buffer size.
*
* @return BLE_ERROR_NONE if a value was read successfully into the buffer.
*
* @deprecated You should use the parallel API from GattServer directly,
* GattServer::read(GattAttribute::Handle_t,uint8_t,uint16_t). A former call
* to ble.readCharacteristicValue() should be replaced with
* ble.gattServer().read().
*/
MBED_DEPRECATED("Use ble.gattServer().read(...)")
ble_error_t readCharacteristicValue(GattAttribute::Handle_t attributeHandle, uint8_t *buffer, uint16_t *lengthP)
{
return gattServer().read(attributeHandle, buffer, lengthP);
}
/**
* Read the value of a characteristic from the local GattServer.
*
* @param[in] connectionHandle
* Connection Handle.
* @param[in] attributeHandle
* Attribute handle for the value attribute of the characteristic.
* @param[out] buffer
* A buffer to hold the value being read.
* @param[in,out] lengthP
* Length of the buffer being supplied. If the attribute
* value is longer than the size of the supplied buffer,
* this variable will return the total attribute value length
* (excluding offset). The application may use this
* information to allocate a suitable buffer size.
*
* @return BLE_ERROR_NONE if a value was read successfully into the buffer.
*
* @note This API is a version of the above, with an additional connection handle
* parameter to allow fetches for connection-specific multivalued
* attributes (such as the CCCDs).
*
* @deprecated You should use the parallel API from GattServer directly, refer to
* GattServer::read(Gap::Handle_t,GattAttribute::Handle_t,uint8_t,uint16_t).
* A former call to ble.readCharacteristicValue() should be replaced with
* ble.gattServer().read().
*/
MBED_DEPRECATED("Use ble.gattServer().read(...)")
ble_error_t readCharacteristicValue(
Gap::Handle_t connectionHandle,
GattAttribute::Handle_t attributeHandle,
uint8_t *buffer,
uint16_t *lengthP
)
{
return gattServer().read(connectionHandle, attributeHandle, buffer, lengthP);
}
/**
* Update the value of a characteristic on the local GattServer.
*
* @param[in] attributeHandle
* Handle for the value attribute of the characteristic.
* @param[in] value
* A pointer to a buffer holding the new value.
* @param[in] size
* Size of the new value (in bytes).
* @param[in] localOnly
* Should this update be kept on the local
* GattServer regardless of the state of the
* notify/indicate flag in the CCCD for this
* characteristic? If set to true, no notification
* or indication is generated.
*
* @return BLE_ERROR_NONE if we have successfully set the value of the attribute.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::write(GattAttribute::Handle_t,const uint8_t,uint16_t,bool).
* A former call to ble.updateCharacteristicValue() should be replaced with
* ble.gattServer().write().
*/
MBED_DEPRECATED("Use ble.gattServer().write(...)")
ble_error_t updateCharacteristicValue(
GattAttribute::Handle_t attributeHandle,
const uint8_t *value,
uint16_t size,
bool localOnly = false
)
{
return gattServer().write(attributeHandle, value, size, localOnly);
}
/**
* Update the value of a characteristic on the local GattServer. A version
* of the above, with a connection handle parameter to allow updates
* for connection-specific multivalued attributes (such as the CCCDs).
*
* @param[in] connectionHandle
* Connection Handle.
* @param[in] attributeHandle
* Handle for the value attribute of the Characteristic.
* @param[in] value
* A pointer to a buffer holding the new value.
* @param[in] size
* Size of the new value (in bytes).
* @param[in] localOnly
* Should this update be kept on the local
* GattServer regardless of the state of the
* notify/indicate flag in the CCCD for this
* Characteristic? If set to true, no notification
* or indication is generated.
*
* @return BLE_ERROR_NONE if we have successfully set the value of the attribute.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::write(Gap::Handle_t,GattAttribute::Handle_t,const uint8_t,uint16_t,bool).
* A former call to ble.updateCharacteristicValue() should be replaced with
* ble.gattServer().write().
*/
MBED_DEPRECATED("Use ble.gattServer().write(...)")
ble_error_t updateCharacteristicValue(
Gap::Handle_t connectionHandle,
GattAttribute::Handle_t attributeHandle,
const uint8_t *value,
uint16_t size,
bool localOnly = false
)
{
return gattServer().write(connectionHandle, attributeHandle, value, size, localOnly);
}
#endif // BLE_FEATURE_GATT_SERVER
#if BLE_FEATURE_SECURITY
/**
* Enable the BLE stack's Security Manager. The Security Manager implements
* the cryptographic algorithms and protocol exchanges that allow two
* devices to securely exchange data and privately detect each other.
* Calling this API is a prerequisite for encryption and pairing (bonding).
*
* @param[in] enableBonding Allow for bonding.
* @param[in] requireMITM Require protection against man-in-the-middle attacks.
* @param[in] iocaps To specify the I/O capabilities of this peripheral,
* such as availability of a display or keyboard, to
* support out-of-band exchanges of security data.
* @param[in] passkey To specify a static passkey.
*
* @return BLE_ERROR_NONE on success.
*
* @deprecated You should use the parallel API from SecurityManager directly, refer to
* SecurityManager.init(). A former
* call to ble.initializeSecurity(...) should be replaced with
* ble.securityManager().init(...).
*/
MBED_DEPRECATED("Use ble.securityManager().init(...)")
ble_error_t initializeSecurity(
bool enableBonding = true,
bool requireMITM = true,
SecurityManager::SecurityIOCapabilities_t iocaps = SecurityManager::IO_CAPS_NONE,
const SecurityManager::Passkey_t passkey = NULL
)
{
return securityManager().init(enableBonding, requireMITM, iocaps, passkey);
}
/**
* Get the security status of a connection.
*
* @param[in] connectionHandle Handle to identify the connection.
* @param[out] securityStatusP Security status.
*
* @return BLE_SUCCESS or appropriate error code indicating the reason of failure.
*
* @deprecated You should use the parallel API from SecurityManager directly, refer to
* SecurityManager::getLinkSecurity(). A former
* call to ble.getLinkSecurity(...) should be replaced with
* ble.securityManager().getLinkSecurity(...).
*/
MBED_DEPRECATED("ble.securityManager().getLinkSecurity(...)")
ble_error_t getLinkSecurity(Gap::Handle_t connectionHandle, SecurityManager::LinkSecurityStatus_t *securityStatusP)
{
return securityManager().getLinkSecurity(connectionHandle, securityStatusP);
}
/**
* Delete all peer device context and all related bonding information from
* the database within the security manager.
*
* @retval BLE_ERROR_NONE On success; else returns an error code indicating the reason for the failure.
* @retval BLE_ERROR_INVALID_STATE If the API is called without module initialization or
* application registration.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::purgeAllBondingState(). A former
* call to ble.purgeAllBondingState() should be replaced with
* ble.securityManager().purgeAllBondingState().
*/
MBED_DEPRECATED("ble.securityManager().purgeAllBondingState(...)")
ble_error_t purgeAllBondingState(void)
{
return securityManager().purgeAllBondingState();
}
#endif // BLE_FEATURE_SECURITY
/**
* Set up a callback for timeout events. Refer to Gap::TimeoutSource_t for
* possible event types.
*
* @param[in] timeoutCallback Event handler being registered.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::onTimeout(). A former call
* to ble.onTimeout(callback) should be replaced with
* ble.gap().onTimeout(callback).
*/
MBED_DEPRECATED("ble.gap().onTimeout(callback)")
void onTimeout(Gap::TimeoutEventCallback_t timeoutCallback);
/**
* Set up a callback for connection events. Refer to Gap::ConnectionEventCallback_t.
*
* @param[in] connectionCallback Event handler being registered.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::onConnection(). A former call
* to ble.onConnection(callback) should be replaced with
* ble.gap().onConnection(callback).
*/
MBED_DEPRECATED("ble.gap().onConnection(callback)")
void onConnection(Gap::ConnectionEventCallback_t connectionCallback);
/**
* Append to a chain of callbacks to be invoked upon GAP disconnection.
*
* @param[in] disconnectionCallback Event handler being registered.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::onDisconnection(). A former call
* to ble.onDisconnection(callback) should be replaced with
* ble.gap().onDisconnection(callback).
*/
MBED_DEPRECATED("ble.gap().onDisconnectionComplete(callback)")
void onDisconnection(Gap::DisconnectionEventCallback_t disconnectionCallback);
/**
* The same as onDisconnection() but allows an object reference and member function
* to be added to the chain of callbacks.
*
* @param[in] tptr Instance used to invoke mptr.
* @param[in] mptr Event handler being registered.
*
* @deprecated You should use the parallel API from Gap directly and refer to
* Gap::onDisconnection(). A former call
* to ble.onDisconnection(callback) should be replaced with
* ble.gap().onDisconnection(callback).
*/
template<typename T>
MBED_DEPRECATED("ble.gap().onDisconnectionComplete(callback)")
void onDisconnection(T *tptr, void (T::*mptr)(const Gap::DisconnectionCallbackParams_t *))
{
gap().onDisconnection(tptr, mptr);
}
/**
* Radio Notification is a feature that enables ACTIVE and INACTIVE
* (nACTIVE) signals from the stack. These notify the application when the
* radio is in use. The signal is sent using software interrupt.
*
* The ACTIVE signal is sent before the radio event starts. The nACTIVE
* signal is sent at the end of the radio event. These signals can be used
* by the application programmer to synchronize application logic with radio
* activity. For example, the ACTIVE signal can be used to shut off external
* devices to manage peak current drawn during periods when the radio is on,
* or to trigger sensor data collection for transmission in the radio event.
*
* @param callback
* The application handler to be invoked in response to a radio
* ACTIVE/INACTIVE event.
*
* @deprecated You should use the parallel API from Gap directly, refer to
* Gap::onRadioNotification(). A former call
* to ble.onRadioNotification(...) should be replaced with
* ble.gap().onRadioNotification(...).
*/
MBED_DEPRECATED("ble.gap().onRadioNotification(...)")
void onRadioNotification(void (*callback)(bool));
#if BLE_FEATURE_GATT_SERVER
/**
* Add a callback for the GATT event DATA_SENT (which is triggered when
* updates are sent out by GATT in the form of notifications).
*
* @param[in] callback Event handler being registered.
*
* @note It is possible to chain together multiple onDataSent callbacks
* (potentially from different modules of an application) to receive updates
* to characteristics.
*
* @note It is also possible to set up a callback into a member function of
* some object.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onDataSent(). A former call
* to ble.onDataSent(...) should be replaced with
* ble.gattServer().onDataSent(...).
*/
MBED_DEPRECATED("ble.gattServer().onDataSent(...)")
void onDataSent(void (*callback)(unsigned count))
{
gattServer().onDataSent(callback);
}
/**
* The same as onDataSent() but allows an object reference and member function
* to be added to the chain of callbacks.
*
* @param[in] objPtr Pointer to the instance that is used to invoke the
* event handler.
* @param[in] memberPtr Event handler being registered. It is a member
* function.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onDataSent(). A former call
* to ble.onDataSent(...) should be replaced with
* ble.gattServer().onDataSent(...).
*/
template<typename T>
MBED_DEPRECATED("ble.gattServer().onDataSent(...)")
void onDataSent(T *objPtr, void (T::*memberPtr)(unsigned count))
{
gattServer().onDataSent(objPtr, memberPtr);
}
/**
* Set up a callback for when an attribute has its value updated by or at the
* connected peer. For a peripheral, this callback is triggered when the local
* GATT server has an attribute updated by a write command from the peer.
* For a Central, this callback is triggered when a response is received for
* a write request.
*
* @param[in] callback The event handler being registered.
*
* @note It is possible to chain together multiple onDataWritten callbacks
* (potentially from different modules of an application) to receive updates
* to characteristics. Many services, such as DFU and UART, add their own
* onDataWritten callbacks behind the scenes to trap interesting events.
*
* @note It is also possible to set up a callback into a member function of
* some object.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onDataWritten(). A former call
* to ble.onDataWritten(...) should be replaced with
* ble.gattServer().onDataWritten(...).
*/
MBED_DEPRECATED("ble.gattServer().onDataWritten(...)")
void onDataWritten(void (*callback)(const GattWriteCallbackParams *eventDataP))
{
gattServer().onDataWritten(callback);
}
/**
* The same as onDataWritten() but allows an object reference and member function
* to be added to the chain of callbacks.
*
* @param[in] objPtr Pointer to the instance that is used to invoke the
* event handler (@p memberPtr).
* @param[in] memberPtr Event handler being registered. It is a member
* function.
*
*
* @deprecated You should use the parallel API from GattServer directly, refer to
* GattServer::onDataWritten(). A former call
* to ble.onDataWritten(...) should be replaced with
* ble.gattServer().onDataWritten(...).
*/
template<typename T>
MBED_DEPRECATED("ble.gattServer().onDataWritten(...)")
void onDataWritten(T *objPtr, void (T::*memberPtr)(const GattWriteCallbackParams *context))
{
gattServer().onDataWritten(objPtr, memberPtr);
}
/**
* Set up a callback to be invoked on the peripheral when an attribute is
* being read by a remote client.
*
* @note This functionality may not be available on all underlying stacks.
* You could use GattCharacteristic::setReadAuthorizationCallback() as an
* alternative.
*
* @note It is possible to chain together multiple onDataRead callbacks
* (potentially from different modules of an application) to receive updates
* to characteristics. Services may add their own onDataRead callbacks
* behind the scenes to trap interesting events.
*
* @note It is also possible to set up a callback into a member function of
* some object.
*
* @param[in] callback Event handler being registered.
*
* @return BLE_ERROR_NOT_IMPLEMENTED if this functionality isn't available;
* else BLE_ERROR_NONE.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onDataRead(). A former call
* to ble.onDataRead(...) should be replaced with
* ble.gattServer().onDataRead(...).
*/
MBED_DEPRECATED("ble.gattServer().onDataRead(...)")
ble_error_t onDataRead(void (*callback)(const GattReadCallbackParams *eventDataP))
{
return gattServer().onDataRead(callback);
}
/**
* The same as onDataRead() but allows an object reference and member function
* to be added to the chain of callbacks.
*
* @param[in] objPtr Pointer to the instance that is used to invoke the
* event handler (@p memberPtr).
* @param[in] memberPtr Event handler being registered. It is a member
* function.
*
* @return BLE_ERROR_NOT_IMPLEMENTED if this functionality isn't available;
* else BLE_ERROR_NONE.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onDataRead(). A former call
* to ble.onDataRead(...) should be replaced with
* ble.gattServer().onDataRead(...).
*/
template<typename T>
MBED_DEPRECATED("ble.gattServer().onDataRead(...)")
ble_error_t onDataRead(T *objPtr, void (T::*memberPtr)(const GattReadCallbackParams *context))
{
return gattServer().onDataRead(objPtr, memberPtr);
}
/**
* Set up a callback for when notifications or indications are enabled for a
* characteristic on the local GattServer.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onUpdatesEnabled(). A former call
* to ble.onUpdatesEnabled(callback) should be replaced with
* ble.gattServer().onUpdatesEnabled(callback).
*/
MBED_DEPRECATED("ble.gattServer().onUpdatesEnabled(...)")
void onUpdatesEnabled(GattServer::EventCallback_t callback)
{
gattServer().onUpdatesEnabled(callback);
}
/**
* Set up a callback for when notifications or indications are disabled for a
* characteristic on the local GattServer.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onUpdatesDisabled(). A former call
* to ble.onUpdatesDisabled(callback) should be replaced with
* ble.gattServer().onUpdatesDisabled(callback).
*/
MBED_DEPRECATED("ble.gattServer().onUpdatesDisabled(...)")
void onUpdatesDisabled(GattServer::EventCallback_t callback)
{
gattServer().onUpdatesDisabled(callback);
}
/**
* Set up a callback for when the GATT server receives a response for an
* indication event sent previously.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from GattServer directly and refer to
* GattServer::onConfirmationReceived(). A former call
* to ble.onConfirmationReceived(callback) should be replaced with
* ble.gattServer().onConfirmationReceived(callback).
*/
MBED_DEPRECATED("ble.gattServer().onConfirmationReceived(...)")
void onConfirmationReceived(GattServer::EventCallback_t callback)
{
gattServer().onConfirmationReceived(callback);
}
#endif // BLE_FEATURE_GATT_SERVER
#if BLE_FEATURE_SECURITY
/**
* Set up a callback for when the security setup procedure (key generation
* and exchange) for a link has started. This will be skipped for bonded
* devices. The callback is passed in parameters received from the peer's
* security request: bool allowBonding, bool requireMITM and
* SecurityIOCapabilities_t.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onSecuritySetupInitiated(). A former
* call to ble.onSecuritySetupInitiated(callback) should be replaced with
* ble.securityManager().onSecuritySetupInitiated(callback).
*/
MBED_DEPRECATED("ble.securityManager().onSecuritySetupInitiated(callback)")
void onSecuritySetupInitiated(SecurityManager::SecuritySetupInitiatedCallback_t callback)
{
securityManager().onSecuritySetupInitiated(callback);
}
/**
* Set up a callback for when the security setup procedure (key generation
* and exchange) for a link has completed. This will be skipped for bonded
* devices. The callback is passed in the success/failure status of the
* security setup procedure.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onSecuritySetupCompleted(). A former
* call to ble.onSecuritySetupCompleted(callback) should be replaced with
* ble.securityManager().onSecuritySetupCompleted(callback).
*/
MBED_DEPRECATED("ble.securityManager().onSecuritySetupCompleted(callback)")
void onSecuritySetupCompleted(SecurityManager::SecuritySetupCompletedCallback_t callback)
{
securityManager().onSecuritySetupCompleted(callback);
}
/**
* Set up a callback for when a link with the peer is secured. For bonded
* devices, subsequent reconnections with a bonded peer will result only in
* this callback when the link is secured, and setup procedures will not
* occur unless the bonding information is either lost or deleted on either
* or both sides. The callback is passed in a SecurityManager::SecurityMode_t according
* to the level of security in effect for the secured link.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onLinkSecured(). A former
* call to ble.onLinkSecured(callback) should be replaced with
* ble.securityManager().onLinkSecured(callback).
*/
MBED_DEPRECATED("ble.securityManager().onLinkSecured(callback)")
void onLinkSecured(SecurityManager::LinkSecuredCallback_t callback)
{
securityManager().onLinkSecured(callback);
}
/**
* Set up a callback for successful bonding, meaning that link-specific security
* context is stored persistently for a peer device.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onSecurityContextStored(). A former
* call to ble.onSecurityContextStored(callback) should be replaced with
* ble.securityManager().onSecurityContextStored(callback).
*/
MBED_DEPRECATED("ble.securityManager().onSecurityContextStored(callback)")
void onSecurityContextStored(SecurityManager::HandleSpecificEvent_t callback)
{
securityManager().onSecurityContextStored(callback);
}
/**
* Set up a callback for when the passkey needs to be displayed on a
* peripheral with DISPLAY capability. This happens when security is
* configured to prevent man-in-the-middle attacks, and the peers need to exchange
* a passkey (or PIN) to authenticate the connection
* attempt.
*
* @param[in] callback Event handler being registered.
*
* @deprecated You should use the parallel API from SecurityManager directly and refer to
* SecurityManager::onPasskeyDisplay(). A former
* call to ble.onPasskeyDisplay(callback) should be replaced with
* ble.securityManager().onPasskeyDisplay(callback).
*/
MBED_DEPRECATED("ble.securityManager().onPasskeyDisplay(callback)")
void onPasskeyDisplay(SecurityManager::PasskeyDisplayCallback_t callback)
{
return securityManager().onPasskeyDisplay(callback);
}
#endif // BLE_FEATURE_SECURITY
private:
friend class BLEInstanceBase;
/**
* This function allows the BLE stack to signal that there is work to do and
* event processing should be done (BLE::processEvent()).
*
* @note This function should be called by the port of BLE_API. It is not
* meant to be used by end users.
*/
void signalEventsToProcess();
/**
* Implementation of init() [internal to BLE_API].
*
* The implementation is separated into a private method because it isn't
* suitable to be included in the header.
*/
ble_error_t initImplementation(
FunctionPointerWithContext<InitializationCompleteCallbackContext *> callback
);
private:
// Prevent copy construction and copy assignment of BLE.
BLE(const BLE &);
BLE &operator=(const BLE &);
private:
InstanceID_t instanceID;
BLEInstanceBase *transport; /* The device-specific backend */
OnEventsToProcessCallback_t whenEventsToProcess;
bool event_signaled;
};
/**
* @deprecated This type alias is retained for the sake of compatibility with
* older code. This will be dropped at some point.
*/
typedef BLE BLEDevice;
/**
* @namespace ble Entry namespace for all %BLE API definitions.
*/
/**
* @}
*/
#endif /* ifndef MBED_BLE_H__ */
Reference in New Issue View Git Blame Copy Permalink