Bluetooth Low Energy / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Dependents:   BLE_ANCS_SDAPI BLE_temperature BLE_HeartRate BLE_ANCS_SDAPI_IRC ... more

Overview

The BLE_API is a high level abstraction for using Bluetooth Low Energy on multiple platforms. For details and examples using the BLE_API please see the BLE_API Summary Page. Or click on the API Documentation tab above.

Supported Services

Supported services can be found in the BLE_API/services folder.

source/DiscoveredCharacteristic.cpp@969:61f13bc8edbf, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 12:52:35 2015 +0000
Revision:
969:61f13bc8edbf
Parent:
966:9451b90bbb66
Child:
970:b3e45745026d
Synchronized with git rev 184d29c3

Author: Vincent Coubard

Various enhancement:



Add SafeBool class which allow to easily declare a safe bool operator in

c++03.



CallChainOfFunctionPointerswithContext:

  - unify syntax of add

  - detach function now return true if a function has been detached and

    false otherwise

  - Explanations about function call operator

  - use safe bool idiom

  - explanations about iterator and why it is mutable



FunctionPointerWithContext:

  - fix call propagation

  - use safe bool idiom



Gap:

  - add documentation

  - onRadioNotification does mot call initRadioNotification anymore



GattClient:

  - documentation



GattServer:

  - documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 712:b04b5db36865 1 /* mbed Microcontroller Library
rgrover1 712:b04b5db36865 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 712:b04b5db36865 3 *
rgrover1 712:b04b5db36865 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 712:b04b5db36865 5 * you may not use this file except in compliance with the License.
rgrover1 712:b04b5db36865 6 * You may obtain a copy of the License at
rgrover1 712:b04b5db36865 7 *
rgrover1 712:b04b5db36865 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 712:b04b5db36865 9 *
rgrover1 712:b04b5db36865 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 712:b04b5db36865 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 712:b04b5db36865 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 712:b04b5db36865 13 * See the License for the specific language governing permissions and
rgrover1 712:b04b5db36865 14 * limitations under the License.
rgrover1 712:b04b5db36865 15 */
rgrover1 712:b04b5db36865 16
rgrover1 712:b04b5db36865 17 #include "ble/DiscoveredCharacteristic.h"
rgrover1 712:b04b5db36865 18 #include "ble/GattClient.h"
rgrover1 712:b04b5db36865 19
rgrover1 712:b04b5db36865 20 ble_error_t
rgrover1 712:b04b5db36865 21 DiscoveredCharacteristic::read(uint16_t offset) const
rgrover1 712:b04b5db36865 22 {
rgrover1 712:b04b5db36865 23 if (!props.read()) {
rgrover1 712:b04b5db36865 24 return BLE_ERROR_OPERATION_NOT_PERMITTED;
rgrover1 712:b04b5db36865 25 }
rgrover1 712:b04b5db36865 26
rgrover1 712:b04b5db36865 27 if (!gattc) {
rgrover1 712:b04b5db36865 28 return BLE_ERROR_INVALID_STATE;
rgrover1 712:b04b5db36865 29 }
rgrover1 712:b04b5db36865 30
rgrover1 712:b04b5db36865 31 return gattc->read(connHandle, valueHandle, offset);
rgrover1 712:b04b5db36865 32 }
rgrover1 712:b04b5db36865 33
rgrover1 969:61f13bc8edbf 34 struct OneShotReadCallback {
rgrover1 969:61f13bc8edbf 35 static void launch(GattClient* client, Gap::Handle_t connHandle,
rgrover1 969:61f13bc8edbf 36 GattAttribute::Handle_t handle, const GattClient::ReadCallback_t& cb) {
rgrover1 969:61f13bc8edbf 37 OneShotReadCallback* oneShot = new OneShotReadCallback(client, connHandle, handle, cb);
rgrover1 969:61f13bc8edbf 38 oneShot->attach();
rgrover1 969:61f13bc8edbf 39 // delete will be made when this callback is called
rgrover1 969:61f13bc8edbf 40 }
rgrover1 969:61f13bc8edbf 41
rgrover1 969:61f13bc8edbf 42 private:
rgrover1 969:61f13bc8edbf 43 OneShotReadCallback(GattClient* client, Gap::Handle_t connHandle,
rgrover1 969:61f13bc8edbf 44 GattAttribute::Handle_t handle, const GattClient::ReadCallback_t& cb) :
rgrover1 969:61f13bc8edbf 45 _client(client),
rgrover1 969:61f13bc8edbf 46 _connHandle(connHandle),
rgrover1 969:61f13bc8edbf 47 _handle(handle),
rgrover1 969:61f13bc8edbf 48 _callback(cb) { }
rgrover1 969:61f13bc8edbf 49
rgrover1 969:61f13bc8edbf 50 void attach() {
rgrover1 969:61f13bc8edbf 51 _client->onDataRead(makeFunctionPointer(this, &OneShotReadCallback::call));
rgrover1 969:61f13bc8edbf 52 }
rgrover1 969:61f13bc8edbf 53
rgrover1 969:61f13bc8edbf 54 void call(const GattReadCallbackParams* params) {
rgrover1 969:61f13bc8edbf 55 // verifiy that it is the right characteristic on the right connection
rgrover1 969:61f13bc8edbf 56 if (params->connHandle == _connHandle && params->handle == _handle) {
rgrover1 969:61f13bc8edbf 57 _callback(params);
rgrover1 969:61f13bc8edbf 58 _client->onDataRead().detach(makeFunctionPointer(this, &OneShotReadCallback::call));
rgrover1 969:61f13bc8edbf 59 delete this;
rgrover1 969:61f13bc8edbf 60 }
rgrover1 969:61f13bc8edbf 61 }
rgrover1 969:61f13bc8edbf 62
rgrover1 969:61f13bc8edbf 63 GattClient* _client;
rgrover1 969:61f13bc8edbf 64 Gap::Handle_t _connHandle;
rgrover1 969:61f13bc8edbf 65 GattAttribute::Handle_t _handle;
rgrover1 969:61f13bc8edbf 66 GattClient::ReadCallback_t _callback;
rgrover1 969:61f13bc8edbf 67 };
rgrover1 969:61f13bc8edbf 68
rgrover1 969:61f13bc8edbf 69 ble_error_t DiscoveredCharacteristic::read(uint16_t offset, const GattClient::ReadCallback_t& onRead) const {
rgrover1 969:61f13bc8edbf 70 ble_error_t error = read(offset);
rgrover1 969:61f13bc8edbf 71 if (error) {
rgrover1 969:61f13bc8edbf 72 return error;
rgrover1 969:61f13bc8edbf 73 }
rgrover1 969:61f13bc8edbf 74
rgrover1 969:61f13bc8edbf 75 OneShotReadCallback::launch(gattc, connHandle, valueHandle, onRead);
rgrover1 969:61f13bc8edbf 76
rgrover1 969:61f13bc8edbf 77 return error;
rgrover1 969:61f13bc8edbf 78 }
rgrover1 969:61f13bc8edbf 79
rgrover1 712:b04b5db36865 80 ble_error_t
rgrover1 712:b04b5db36865 81 DiscoveredCharacteristic::write(uint16_t length, const uint8_t *value) const
rgrover1 712:b04b5db36865 82 {
rgrover1 712:b04b5db36865 83 if (!props.write()) {
rgrover1 712:b04b5db36865 84 return BLE_ERROR_OPERATION_NOT_PERMITTED;
rgrover1 712:b04b5db36865 85 }
rgrover1 712:b04b5db36865 86
rgrover1 712:b04b5db36865 87 if (!gattc) {
rgrover1 712:b04b5db36865 88 return BLE_ERROR_INVALID_STATE;
rgrover1 712:b04b5db36865 89 }
rgrover1 712:b04b5db36865 90
rgrover1 712:b04b5db36865 91 return gattc->write(GattClient::GATT_OP_WRITE_REQ, connHandle, valueHandle, length, value);
rgrover1 712:b04b5db36865 92 }
rgrover1 712:b04b5db36865 93
rgrover1 712:b04b5db36865 94 ble_error_t
rgrover1 712:b04b5db36865 95 DiscoveredCharacteristic::writeWoResponse(uint16_t length, const uint8_t *value) const
rgrover1 712:b04b5db36865 96 {
rgrover1 712:b04b5db36865 97 if (!props.writeWoResp()) {
rgrover1 712:b04b5db36865 98 return BLE_ERROR_OPERATION_NOT_PERMITTED;
rgrover1 712:b04b5db36865 99 }
rgrover1 712:b04b5db36865 100
rgrover1 712:b04b5db36865 101 if (!gattc) {
rgrover1 712:b04b5db36865 102 return BLE_ERROR_INVALID_STATE;
rgrover1 712:b04b5db36865 103 }
rgrover1 712:b04b5db36865 104
rgrover1 712:b04b5db36865 105 return gattc->write(GattClient::GATT_OP_WRITE_CMD, connHandle, valueHandle, length, value);
rgrover1 712:b04b5db36865 106 }
rgrover1 712:b04b5db36865 107
rgrover1 969:61f13bc8edbf 108 struct OneShotWriteCallback {
rgrover1 969:61f13bc8edbf 109 static void launch(GattClient* client, Gap::Handle_t connHandle,
rgrover1 969:61f13bc8edbf 110 GattAttribute::Handle_t handle, const GattClient::WriteCallback_t& cb) {
rgrover1 969:61f13bc8edbf 111 OneShotWriteCallback* oneShot = new OneShotWriteCallback(client, connHandle, handle, cb);
rgrover1 969:61f13bc8edbf 112 oneShot->attach();
rgrover1 969:61f13bc8edbf 113 // delete will be made when this callback is called
rgrover1 969:61f13bc8edbf 114 }
rgrover1 969:61f13bc8edbf 115
rgrover1 969:61f13bc8edbf 116 private:
rgrover1 969:61f13bc8edbf 117 OneShotWriteCallback(GattClient* client, Gap::Handle_t connHandle,
rgrover1 969:61f13bc8edbf 118 GattAttribute::Handle_t handle, const GattClient::WriteCallback_t& cb) :
rgrover1 969:61f13bc8edbf 119 _client(client),
rgrover1 969:61f13bc8edbf 120 _connHandle(connHandle),
rgrover1 969:61f13bc8edbf 121 _handle(handle),
rgrover1 969:61f13bc8edbf 122 _callback(cb) { }
rgrover1 969:61f13bc8edbf 123
rgrover1 969:61f13bc8edbf 124 void attach() {
rgrover1 969:61f13bc8edbf 125 _client->onDataWritten(makeFunctionPointer(this, &OneShotWriteCallback::call));
rgrover1 969:61f13bc8edbf 126 }
rgrover1 969:61f13bc8edbf 127
rgrover1 969:61f13bc8edbf 128 void call(const GattWriteCallbackParams* params) {
rgrover1 969:61f13bc8edbf 129 // verifiy that it is the right characteristic on the right connection
rgrover1 969:61f13bc8edbf 130 if (params->connHandle == _connHandle && params->handle == _handle) {
rgrover1 969:61f13bc8edbf 131 _callback(params);
rgrover1 969:61f13bc8edbf 132 _client->onDataWritten().detach(makeFunctionPointer(this, &OneShotWriteCallback::call));
rgrover1 969:61f13bc8edbf 133 delete this;
rgrover1 969:61f13bc8edbf 134 }
rgrover1 969:61f13bc8edbf 135 }
rgrover1 969:61f13bc8edbf 136
rgrover1 969:61f13bc8edbf 137 GattClient* _client;
rgrover1 969:61f13bc8edbf 138 Gap::Handle_t _connHandle;
rgrover1 969:61f13bc8edbf 139 GattAttribute::Handle_t _handle;
rgrover1 969:61f13bc8edbf 140 GattClient::WriteCallback_t _callback;
rgrover1 969:61f13bc8edbf 141 };
rgrover1 969:61f13bc8edbf 142
rgrover1 969:61f13bc8edbf 143 ble_error_t DiscoveredCharacteristic::write(uint16_t length, const uint8_t *value, const GattClient::WriteCallback_t& onRead) const {
rgrover1 969:61f13bc8edbf 144 ble_error_t error = write(length, value);
rgrover1 969:61f13bc8edbf 145 if (error) {
rgrover1 969:61f13bc8edbf 146 return error;
rgrover1 969:61f13bc8edbf 147 }
rgrover1 969:61f13bc8edbf 148
rgrover1 969:61f13bc8edbf 149 OneShotWriteCallback::launch(gattc, connHandle, valueHandle, onRead);
rgrover1 969:61f13bc8edbf 150
rgrover1 969:61f13bc8edbf 151 return error;
rgrover1 969:61f13bc8edbf 152 }
rgrover1 969:61f13bc8edbf 153
rgrover1 712:b04b5db36865 154 ble_error_t
rgrover1 712:b04b5db36865 155 DiscoveredCharacteristic::discoverDescriptors(DescriptorCallback_t callback, const UUID &matchingUUID) const
rgrover1 712:b04b5db36865 156 {
rgrover1 712:b04b5db36865 157 return BLE_ERROR_NOT_IMPLEMENTED; /* TODO: this needs to be filled in. */
rgrover1 712:b04b5db36865 158 }