Austin Blackstone / BLE_API

Fixes to BLE_API for mbedOS Alpha1 release. Mostly relating to doxygen fixes.

Fork of BLE_API by Bluetooth Low Energy

public/GattServer.h@108:c85ab5f1eca0, 2014-07-24 (annotated)

Committer:
Rohit Grover
Date:
Thu Jul 24 15:38:15 2014 +0100
Revision:
108:c85ab5f1eca0
Parent:
106:a20be740075d
Child:
114:f1ede142a78f
add APIs for get/setDeviceName(), get/setAppearance(), getVersion(), and setTxPower().

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 106:a20be740075d 1 /* mbed Microcontroller Library
Rohit Grover 106:a20be740075d 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 106:a20be740075d 3 *
Rohit Grover 106:a20be740075d 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 106:a20be740075d 5 * you may not use this file except in compliance with the License.
Rohit Grover 106:a20be740075d 6 * You may obtain a copy of the License at
Rohit Grover 106:a20be740075d 7 *
Rohit Grover 106:a20be740075d 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 106:a20be740075d 9 *
Rohit Grover 106:a20be740075d 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 106:a20be740075d 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 106:a20be740075d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 106:a20be740075d 13 * See the License for the specific language governing permissions and
Rohit Grover 106:a20be740075d 14 * limitations under the License.
Rohit Grover 106:a20be740075d 15 */
Rohit Grover 106:a20be740075d 16
Rohit Grover 106:a20be740075d 17 #ifndef __GATT_SERVER_H__
Rohit Grover 106:a20be740075d 18 #define __GATT_SERVER_H__
Rohit Grover 106:a20be740075d 19
Rohit Grover 106:a20be740075d 20 #include "mbed.h"
Rohit Grover 106:a20be740075d 21 #include "blecommon.h"
Rohit Grover 106:a20be740075d 22 #include "GattService.h"
Rohit Grover 106:a20be740075d 23 #include "GattServerEvents.h"
Rohit Grover 106:a20be740075d 24
Rohit Grover 106:a20be740075d 25 /**************************************************************************/
Rohit Grover 106:a20be740075d 26 /*!
Rohit Grover 106:a20be740075d 27 \brief
Rohit Grover 106:a20be740075d 28 The base class used to abstract GATT Server functionality to a specific
Rohit Grover 106:a20be740075d 29 radio transceiver, SOC or BLE Stack.
Rohit Grover 106:a20be740075d 30 */
Rohit Grover 106:a20be740075d 31 /**************************************************************************/
Rohit Grover 106:a20be740075d 32 class GattServer
Rohit Grover 106:a20be740075d 33 {
Rohit Grover 106:a20be740075d 34 public:
Rohit Grover 106:a20be740075d 35 /* These functions must be defined in the sub-class */
Rohit Grover 106:a20be740075d 36 virtual ble_error_t addService(GattService &) = 0;
Rohit Grover 106:a20be740075d 37 virtual ble_error_t readValue(uint16_t handle, uint8_t buffer[], uint16_t *const lengthP) = 0;
Rohit Grover 106:a20be740075d 38 virtual ble_error_t updateValue(uint16_t, uint8_t[], uint16_t, bool localOnly = false) = 0;
Rohit Grover 108:c85ab5f1eca0 39 virtual ble_error_t setDeviceName(const uint8_t *deviceName) = 0;
Rohit Grover 108:c85ab5f1eca0 40 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) = 0;
Rohit Grover 108:c85ab5f1eca0 41 virtual ble_error_t setAppearance(uint16_t appearance) = 0;
Rohit Grover 108:c85ab5f1eca0 42 virtual ble_error_t getAppearance(uint16_t *appearanceP) = 0;
Rohit Grover 106:a20be740075d 43
Rohit Grover 106:a20be740075d 44 // ToDo: For updateValue, check the CCCD to see if the value we are
Rohit Grover 106:a20be740075d 45 // updating has the notify or indicate bits sent, and if BOTH are set
Rohit Grover 106:a20be740075d 46 // be sure to call sd_ble_gatts_hvx() twice with notify then indicate!
Rohit Grover 106:a20be740075d 47 // Strange use case, but valid and must be covered!
Rohit Grover 106:a20be740075d 48
Rohit Grover 106:a20be740075d 49 /* Event callback handlers. */
Rohit Grover 106:a20be740075d 50 typedef void (*EventCallback_t)(uint16_t attributeHandle);
Rohit Grover 106:a20be740075d 51 typedef void (*ServerEventCallback_t)(void); /* independent of any particular attribute */
Rohit Grover 106:a20be740075d 52 void setOnDataSent(ServerEventCallback_t callback) {
Rohit Grover 106:a20be740075d 53 onDataSent = callback;
Rohit Grover 106:a20be740075d 54 }
Rohit Grover 106:a20be740075d 55 void setOnDataWritten(EventCallback_t callback) {
Rohit Grover 106:a20be740075d 56 onDataWritten = callback;
Rohit Grover 106:a20be740075d 57 }
Rohit Grover 106:a20be740075d 58 void setOnUpdatesEnabled(EventCallback_t callback) {
Rohit Grover 106:a20be740075d 59 onUpdatesEnabled = callback;
Rohit Grover 106:a20be740075d 60 }
Rohit Grover 106:a20be740075d 61 void setOnUpdatesDisabled(EventCallback_t callback) {
Rohit Grover 106:a20be740075d 62 onUpdatesDisabled = callback;
Rohit Grover 106:a20be740075d 63 }
Rohit Grover 106:a20be740075d 64 void setOnConfirmationReceived(EventCallback_t callback) {
Rohit Grover 106:a20be740075d 65 onConfirmationReceived = callback;
Rohit Grover 106:a20be740075d 66 }
Rohit Grover 106:a20be740075d 67
Rohit Grover 106:a20be740075d 68 void handleEvent(GattServerEvents::gattEvent_e type, uint16_t charHandle) {
Rohit Grover 106:a20be740075d 69 switch (type) {
Rohit Grover 106:a20be740075d 70 case GattServerEvents::GATT_EVENT_DATA_WRITTEN:
Rohit Grover 106:a20be740075d 71 if (onDataWritten) {
Rohit Grover 106:a20be740075d 72 onDataWritten(charHandle);
Rohit Grover 106:a20be740075d 73 }
Rohit Grover 106:a20be740075d 74 break;
Rohit Grover 106:a20be740075d 75 case GattServerEvents::GATT_EVENT_UPDATES_ENABLED:
Rohit Grover 106:a20be740075d 76 if (onUpdatesEnabled) {
Rohit Grover 106:a20be740075d 77 onUpdatesEnabled(charHandle);
Rohit Grover 106:a20be740075d 78 }
Rohit Grover 106:a20be740075d 79 break;
Rohit Grover 106:a20be740075d 80 case GattServerEvents::GATT_EVENT_UPDATES_DISABLED:
Rohit Grover 106:a20be740075d 81 if (onUpdatesDisabled) {
Rohit Grover 106:a20be740075d 82 onUpdatesDisabled(charHandle);
Rohit Grover 106:a20be740075d 83 }
Rohit Grover 106:a20be740075d 84 break;
Rohit Grover 106:a20be740075d 85 case GattServerEvents::GATT_EVENT_CONFIRMATION_RECEIVED:
Rohit Grover 106:a20be740075d 86 if (onConfirmationReceived) {
Rohit Grover 106:a20be740075d 87 onConfirmationReceived(charHandle);
Rohit Grover 106:a20be740075d 88 }
Rohit Grover 106:a20be740075d 89 break;
Rohit Grover 106:a20be740075d 90 }
Rohit Grover 106:a20be740075d 91 }
Rohit Grover 106:a20be740075d 92
Rohit Grover 106:a20be740075d 93 void handleEvent(GattServerEvents::gattEvent_e type) {
Rohit Grover 106:a20be740075d 94 switch (type) {
Rohit Grover 106:a20be740075d 95 case GattServerEvents::GATT_EVENT_DATA_SENT:
Rohit Grover 106:a20be740075d 96 if (onDataSent) {
Rohit Grover 106:a20be740075d 97 onDataSent();
Rohit Grover 106:a20be740075d 98 }
Rohit Grover 106:a20be740075d 99 break;
Rohit Grover 106:a20be740075d 100 default:
Rohit Grover 106:a20be740075d 101 break;
Rohit Grover 106:a20be740075d 102 }
Rohit Grover 106:a20be740075d 103 }
Rohit Grover 106:a20be740075d 104
Rohit Grover 106:a20be740075d 105 protected:
Rohit Grover 106:a20be740075d 106 GattServer() : serviceCount(0), characteristicCount(0), onDataSent(NULL), onDataWritten(NULL), onUpdatesEnabled(NULL), onUpdatesDisabled(NULL), onConfirmationReceived(NULL) {
Rohit Grover 106:a20be740075d 107 /* empty */
Rohit Grover 106:a20be740075d 108 }
Rohit Grover 106:a20be740075d 109
Rohit Grover 106:a20be740075d 110 protected:
Rohit Grover 106:a20be740075d 111 uint8_t serviceCount;
Rohit Grover 106:a20be740075d 112 uint8_t characteristicCount;
Rohit Grover 106:a20be740075d 113
Rohit Grover 106:a20be740075d 114 private:
Rohit Grover 106:a20be740075d 115 ServerEventCallback_t onDataSent;
Rohit Grover 106:a20be740075d 116 EventCallback_t onDataWritten;
Rohit Grover 106:a20be740075d 117 EventCallback_t onUpdatesEnabled;
Rohit Grover 106:a20be740075d 118 EventCallback_t onUpdatesDisabled;
Rohit Grover 106:a20be740075d 119 EventCallback_t onConfirmationReceived;
Rohit Grover 106:a20be740075d 120 };
Rohit Grover 106:a20be740075d 121
Rohit Grover 106:a20be740075d 122 #endif // ifndef __GATT_SERVER_H__