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/Gap.h@240:20df772f2374, 2014-12-08 (annotated)

Committer:
mbedAustin
Date:
Mon Dec 08 20:51:17 2014 +0000
Revision:
240:20df772f2374
Parent:
146:543877bb1f52 
updated documenatation to UriBeacon;

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 __GAP_H__
Rohit Grover 106:a20be740075d 18 #define __GAP_H__
Rohit Grover 106:a20be740075d 19
Rohit Grover 106:a20be740075d 20 #include "GapAdvertisingData.h"
Rohit Grover 106:a20be740075d 21 #include "GapAdvertisingParams.h"
Rohit Grover 106:a20be740075d 22 #include "GapEvents.h"
Rohit Grover 106:a20be740075d 23
rgrover1 143:8bdf577b1598 24 class Gap {
Rohit Grover 106:a20be740075d 25 public:
Rohit Grover 106:a20be740075d 26 typedef enum addr_type_e {
Rohit Grover 106:a20be740075d 27 ADDR_TYPE_PUBLIC = 0,
Rohit Grover 106:a20be740075d 28 ADDR_TYPE_RANDOM_STATIC,
Rohit Grover 106:a20be740075d 29 ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE,
Rohit Grover 106:a20be740075d 30 ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE
Rohit Grover 106:a20be740075d 31 } addr_type_t;
Rohit Grover 106:a20be740075d 32
Rohit Grover 123:fede41ce9407 33 static const unsigned ADDR_LEN = 6;
rgrover1 140:407d134c179d 34 typedef uint8_t address_t[ADDR_LEN];
Rohit Grover 123:fede41ce9407 35
Rohit Grover 117:0fb20195102b 36 /**
rgrover1 143:8bdf577b1598 37 * Enumeration for disconnection reasons. The values for these reasons are
Rohit Grover 117:0fb20195102b 38 * derived from Nordic's implementation; but the reasons are meant to be
Rohit Grover 117:0fb20195102b 39 * independent of the transport. If you are returned a reason which is not
Rohit Grover 117:0fb20195102b 40 * covered by this enumeration, then please refer to the underlying
Rohit Grover 117:0fb20195102b 41 * transport library.
Rohit Grover 117:0fb20195102b 42 */
Rohit Grover 116:ca826083980e 43 enum DisconnectionReason_t {
Rohit Grover 117:0fb20195102b 44 REMOTE_USER_TERMINATED_CONNECTION = 0x13,
Rohit Grover 117:0fb20195102b 45 LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
Rohit Grover 117:0fb20195102b 46 CONN_INTERVAL_UNACCEPTABLE = 0x3B,
Rohit Grover 116:ca826083980e 47 };
Rohit Grover 116:ca826083980e 48
Rohit Grover 106:a20be740075d 49 /* Describes the current state of the device (more than one bit can be set) */
Rohit Grover 106:a20be740075d 50 typedef struct GapState_s {
Rohit Grover 106:a20be740075d 51 unsigned advertising : 1; /**< peripheral is currently advertising */
Rohit Grover 106:a20be740075d 52 unsigned connected : 1; /**< peripheral is connected to a central */
Rohit Grover 106:a20be740075d 53 } GapState_t;
Rohit Grover 106:a20be740075d 54
Rohit Grover 106:a20be740075d 55 typedef uint16_t Handle_t;
Rohit Grover 106:a20be740075d 56
Rohit Grover 106:a20be740075d 57 typedef struct {
rgrover1 140:407d134c179d 58 uint16_t minConnectionInterval; /**< Minimum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 140:407d134c179d 59 uint16_t maxConnectionInterval; /**< Maximum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 140:407d134c179d 60 uint16_t slaveLatency; /**< Slave Latency in number of connection events, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 140:407d134c179d 61 uint16_t connectionSupervisionTimeout; /**< Connection Supervision Timeout in 10 ms units, see @ref BLE_GAP_CP_LIMITS.*/
Rohit Grover 106:a20be740075d 62 } ConnectionParams_t;
Rohit Grover 106:a20be740075d 63
rgrover1 146:543877bb1f52 64 static const uint16_t UNIT_1_25_MS = 1250; /**< Number of microseconds in 1.25 milliseconds. */
rgrover1 146:543877bb1f52 65 static const uint16_t UNIT_0_625_MS = 650; /**< Number of microseconds in 0.625 milliseconds. */
rgrover1 140:407d134c179d 66 static uint16_t MSEC_TO_GAP_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 140:407d134c179d 67 return (durationInMillis * 1000) / UNIT_1_25_MS;
rgrover1 140:407d134c179d 68 }
rgrover1 146:543877bb1f52 69 static uint16_t MSEC_TO_ADVERTISEMENT_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 146:543877bb1f52 70 return (durationInMillis * 1000) / UNIT_0_625_MS;
rgrover1 146:543877bb1f52 71 }
rgrover1 140:407d134c179d 72
rgrover1 142:42f038a81ea7 73 typedef void (*EventCallback_t)(void);
rgrover1 142:42f038a81ea7 74 typedef void (*ConnectionEventCallback_t)(Handle_t, addr_type_t peerAddrType, const address_t peerAddr, const ConnectionParams_t *);
rgrover1 142:42f038a81ea7 75 typedef void (*DisconnectionEventCallback_t)(Handle_t, DisconnectionReason_t);
rgrover1 142:42f038a81ea7 76
rgrover1 142:42f038a81ea7 77 friend class BLEDevice;
rgrover1 142:42f038a81ea7 78 private:
Rohit Grover 106:a20be740075d 79 /* These functions must be defined in the sub-class */
rgrover1 140:407d134c179d 80 virtual ble_error_t setAddress(addr_type_t type, const address_t address) = 0;
rgrover1 140:407d134c179d 81 virtual ble_error_t getAddress(addr_type_t *typeP, address_t address) = 0;
Rohit Grover 106:a20be740075d 82 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &) = 0;
rgrover1 140:407d134c179d 83 virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0;
rgrover1 140:407d134c179d 84 virtual ble_error_t stopAdvertising(void) = 0;
rgrover1 140:407d134c179d 85 virtual ble_error_t disconnect(DisconnectionReason_t reason) = 0;
rgrover1 140:407d134c179d 86 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) = 0;
rgrover1 140:407d134c179d 87 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) = 0;
rgrover1 140:407d134c179d 88 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) = 0;
Rohit Grover 106:a20be740075d 89
rgrover1 140:407d134c179d 90 virtual ble_error_t setDeviceName(const uint8_t *deviceName) = 0;
Rohit Grover 116:ca826083980e 91 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) = 0;
rgrover1 140:407d134c179d 92 virtual ble_error_t setAppearance(uint16_t appearance) = 0;
rgrover1 140:407d134c179d 93 virtual ble_error_t getAppearance(uint16_t *appearanceP) = 0;
Rohit Grover 116:ca826083980e 94
rgrover1 142:42f038a81ea7 95 private:
rgrover1 142:42f038a81ea7 96 /* Event callback handlers */
rgrover1 142:42f038a81ea7 97 void setOnTimeout(EventCallback_t callback) {onTimeout = callback;}
rgrover1 142:42f038a81ea7 98 void setOnConnection(ConnectionEventCallback_t callback) {onConnection = callback;}
rgrover1 142:42f038a81ea7 99 void setOnDisconnection(DisconnectionEventCallback_t callback) {onDisconnection = callback;}
Rohit Grover 106:a20be740075d 100
rgrover1 142:42f038a81ea7 101 GapState_t getState(void) const {
rgrover1 142:42f038a81ea7 102 return state;
Rohit Grover 106:a20be740075d 103 }
rgrover1 140:407d134c179d 104
rgrover1 142:42f038a81ea7 105 protected:
rgrover1 142:42f038a81ea7 106 Gap() : state(), onTimeout(NULL), onConnection(NULL), onDisconnection(NULL) {
rgrover1 142:42f038a81ea7 107 /* empty */
Rohit Grover 106:a20be740075d 108 }
rgrover1 140:407d134c179d 109
rgrover1 142:42f038a81ea7 110 public:
rgrover1 140:407d134c179d 111 void processConnectionEvent(Handle_t handle, addr_type_t type, const address_t addr, const ConnectionParams_t *params) {
Rohit Grover 116:ca826083980e 112 state.connected = 1;
Rohit Grover 116:ca826083980e 113 if (onConnection) {
rgrover1 140:407d134c179d 114 onConnection(handle, type, addr, params);
Rohit Grover 116:ca826083980e 115 }
Rohit Grover 116:ca826083980e 116 }
Rohit Grover 116:ca826083980e 117
Rohit Grover 116:ca826083980e 118 void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) {
Rohit Grover 116:ca826083980e 119 state.connected = 0;
Rohit Grover 116:ca826083980e 120 if (onDisconnection) {
Rohit Grover 116:ca826083980e 121 onDisconnection(handle, reason);
Rohit Grover 106:a20be740075d 122 }
Rohit Grover 106:a20be740075d 123 }
Rohit Grover 106:a20be740075d 124
Rohit Grover 106:a20be740075d 125 void processEvent(GapEvents::gapEvent_e type) {
Rohit Grover 106:a20be740075d 126 switch (type) {
Rohit Grover 106:a20be740075d 127 case GapEvents::GAP_EVENT_TIMEOUT:
Rohit Grover 106:a20be740075d 128 state.advertising = 0;
Rohit Grover 106:a20be740075d 129 if (onTimeout) {
Rohit Grover 106:a20be740075d 130 onTimeout();
Rohit Grover 106:a20be740075d 131 }
Rohit Grover 106:a20be740075d 132 break;
Rohit Grover 106:a20be740075d 133 }
Rohit Grover 106:a20be740075d 134 }
Rohit Grover 106:a20be740075d 135
Rohit Grover 106:a20be740075d 136 protected:
rgrover1 140:407d134c179d 137 GapState_t state;
Rohit Grover 106:a20be740075d 138
Rohit Grover 106:a20be740075d 139 private:
Rohit Grover 116:ca826083980e 140 EventCallback_t onTimeout;
Rohit Grover 116:ca826083980e 141 ConnectionEventCallback_t onConnection;
Rohit Grover 116:ca826083980e 142 DisconnectionEventCallback_t onDisconnection;
rgrover1 142:42f038a81ea7 143
rgrover1 142:42f038a81ea7 144 private:
rgrover1 143:8bdf577b1598 145 /* disallow copy and assignment */
rgrover1 142:42f038a81ea7 146 Gap(const Gap &);
rgrover1 142:42f038a81ea7 147 Gap& operator=(const Gap &);
Rohit Grover 106:a20be740075d 148 };
Rohit Grover 106:a20be740075d 149
rgrover1 126:fdebe4d5d62f 150 #endif // ifndef __GAP_H__