Aleksander Vognild Burkow / Puck

A library for easier setup and prototyping of new pucks, by collecting everything that is common for all pucks in one place.

Dependencies:   BLE_API nRF51822

Fork of Puck by Nordic Pucks

Puck.h@7:c07c01c2a741, 2014-07-24 (annotated)

Committer:
cristea
Date:
Thu Jul 24 09:25:42 2014 +0000
Revision:
7:c07c01c2a741
Parent:
6:211ffef3b88e
Child:
8:49ffd38fb401
Child:
9:ba0527c6b6d0
Hoist logging out of Puck.h; ; There was a problem with multiple definitions of functions in Puck.h if; used in two different files. The logger has been moved out so that we; have independent loggers for each file, which can have different verbosity.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sigveseb 3:5432b38585ea 1 #ifndef __PUCK_HPP__
sigveseb 3:5432b38585ea 2 #define __PUCK_HPP__
sigveseb 3:5432b38585ea 3
sigveseb 3:5432b38585ea 4 #include "BLEDevice.h"
sigveseb 3:5432b38585ea 5 #include <vector>
cristea 7:c07c01c2a741 6 #include "Log.h"
sigveseb 3:5432b38585ea 7
sigveseb 3:5432b38585ea 8 enum PuckState {
sigveseb 3:5432b38585ea 9 CONNECTING,
sigveseb 3:5432b38585ea 10 CONNECTED,
sigveseb 3:5432b38585ea 11 ADVERTISING,
sigveseb 3:5432b38585ea 12 DISCONNECTED
sigveseb 3:5432b38585ea 13 };
sigveseb 3:5432b38585ea 14
sigveseb 3:5432b38585ea 15 const UUID stringToUUID(const char* str);
sigveseb 3:5432b38585ea 16
sigveseb 3:5432b38585ea 17 typedef void (*CharacteristicWriteCallback)(uint8_t* value);
sigveseb 3:5432b38585ea 18
sigveseb 3:5432b38585ea 19 typedef struct {
sigveseb 3:5432b38585ea 20 const UUID* uuid;
sigveseb 3:5432b38585ea 21 std::vector<CharacteristicWriteCallback>* callbacks;
sigveseb 3:5432b38585ea 22 } CharacteristicWriteCallbacks;
sigveseb 3:5432b38585ea 23
sigveseb 3:5432b38585ea 24
sigveseb 3:5432b38585ea 25 class Puck {
sigveseb 3:5432b38585ea 26 private:
sigveseb 3:5432b38585ea 27 Puck() {}
sigveseb 3:5432b38585ea 28 Puck(const Puck&);
sigveseb 3:5432b38585ea 29 Puck& operator=(const Puck&);
sigveseb 3:5432b38585ea 30
sigveseb 3:5432b38585ea 31 BLEDevice ble;
sigveseb 3:5432b38585ea 32 uint8_t beaconPayload[25];
sigveseb 3:5432b38585ea 33 PuckState state;
sigveseb 3:5432b38585ea 34 std::vector<GattService*> services;
sigveseb 3:5432b38585ea 35 std::vector<GattCharacteristic*> characteristics;
sigveseb 3:5432b38585ea 36 std::vector<CharacteristicWriteCallbacks*> writeCallbacks;
sigveseb 3:5432b38585ea 37 std::vector<CharacteristicWriteCallback> pendingCallbackStack;
sigveseb 3:5432b38585ea 38 std::vector<uint8_t*> pendingCallbackParameterStack;
sigveseb 3:5432b38585ea 39
stiaje 4:91506772210d 40 GattCharacteristic **previousCharacteristics;
stiaje 4:91506772210d 41
sigveseb 3:5432b38585ea 42 public:
sigveseb 3:5432b38585ea 43 static Puck &getPuck();
sigveseb 3:5432b38585ea 44
stiaje 5:2f2a2ac6b231 45 BLEDevice &getBle() { return ble; }
sigveseb 3:5432b38585ea 46 PuckState getState() { return state; }
sigveseb 3:5432b38585ea 47 void setState(PuckState state);
sigveseb 3:5432b38585ea 48 void init(uint16_t minor);
sigveseb 3:5432b38585ea 49 void startAdvertising();
sigveseb 3:5432b38585ea 50 void stopAdvertising();
sigveseb 3:5432b38585ea 51 bool drive();
sigveseb 3:5432b38585ea 52 void onDataWritten(uint16_t handle);
sigveseb 3:5432b38585ea 53 void addCharacteristic(const UUID serviceUuid, const UUID characteristicUuid, int bytes, int properties = 0xA);
sigveseb 3:5432b38585ea 54 void onCharacteristicWrite(const UUID uuid, CharacteristicWriteCallback callback);
sigveseb 3:5432b38585ea 55 uint8_t* getCharacteristicValue(const UUID uuid);
sigveseb 3:5432b38585ea 56 };
sigveseb 3:5432b38585ea 57
sigveseb 3:5432b38585ea 58 Puck &Puck::getPuck() {
sigveseb 3:5432b38585ea 59 static Puck _puckSingletonInstance;
sigveseb 3:5432b38585ea 60 return _puckSingletonInstance;
sigveseb 3:5432b38585ea 61 }
sigveseb 3:5432b38585ea 62
sigveseb 3:5432b38585ea 63
sigveseb 3:5432b38585ea 64 void onDisconnection(void) {
sigveseb 3:5432b38585ea 65 LOG_INFO("Disconnected.\n");
sigveseb 3:5432b38585ea 66 Puck::getPuck().setState(DISCONNECTED);
sigveseb 3:5432b38585ea 67 }
sigveseb 3:5432b38585ea 68
sigveseb 3:5432b38585ea 69 void onConnection(void) {
sigveseb 3:5432b38585ea 70 LOG_INFO("Connected.\n");
sigveseb 3:5432b38585ea 71 Puck::getPuck().setState(CONNECTED);
sigveseb 3:5432b38585ea 72 }
sigveseb 3:5432b38585ea 73
sigveseb 3:5432b38585ea 74 void onDataWrittenCallback(uint16_t handle) {
sigveseb 3:5432b38585ea 75 Puck::getPuck().onDataWritten(handle);
sigveseb 3:5432b38585ea 76 }
sigveseb 3:5432b38585ea 77
sigveseb 3:5432b38585ea 78 bool isEqualUUID(const UUID* uuidA, const UUID uuidB) {
sigveseb 3:5432b38585ea 79 const uint8_t* uuidABase = uuidA->getBaseUUID();
sigveseb 3:5432b38585ea 80 const uint8_t* uuidBBase = uuidB.getBaseUUID();
sigveseb 3:5432b38585ea 81 if(uuidA->getShortUUID() != uuidB.getShortUUID()) {
sigveseb 3:5432b38585ea 82 return false;
sigveseb 3:5432b38585ea 83 }
sigveseb 3:5432b38585ea 84 for(int i = 0; i < 16; i++) {
sigveseb 3:5432b38585ea 85 if(uuidABase[i] != uuidBBase[i]) {
sigveseb 3:5432b38585ea 86 return false;
sigveseb 3:5432b38585ea 87 }
sigveseb 3:5432b38585ea 88 }
sigveseb 3:5432b38585ea 89 return true;
sigveseb 3:5432b38585ea 90 }
sigveseb 3:5432b38585ea 91
sigveseb 3:5432b38585ea 92 const UUID stringToUUID(const char* str) {
sigveseb 3:5432b38585ea 93 uint8_t array[16];
sigveseb 3:5432b38585ea 94 for(int i = 0; i < 16; i++) {
sigveseb 3:5432b38585ea 95 array[i] = str[i];
sigveseb 3:5432b38585ea 96 }
sigveseb 3:5432b38585ea 97 return UUID(array);
sigveseb 3:5432b38585ea 98 }
sigveseb 3:5432b38585ea 99
sigveseb 3:5432b38585ea 100 void Puck::setState(PuckState state) {
sigveseb 3:5432b38585ea 101 LOG_DEBUG("Changed state to %i\n", state);
sigveseb 3:5432b38585ea 102 this->state = state;
sigveseb 3:5432b38585ea 103 }
sigveseb 3:5432b38585ea 104
sigveseb 3:5432b38585ea 105 void Puck::init(uint16_t minor) {
sigveseb 3:5432b38585ea 106 /*
sigveseb 3:5432b38585ea 107 * The Beacon payload (encapsulated within the MSD advertising data structure)
sigveseb 3:5432b38585ea 108 * has the following composition:
sigveseb 3:5432b38585ea 109 * 128-Bit UUID = E2 0A 39 F4 73 F5 4B C4 A1 2F 17 D1 AD 07 A9 61
sigveseb 3:5432b38585ea 110 * Major/Minor = 1337 / XXXX
sigveseb 3:5432b38585ea 111 * Tx Power = C8
sigveseb 3:5432b38585ea 112 */
sigveseb 3:5432b38585ea 113 uint8_t beaconPayloadTemplate[] = {
sigveseb 3:5432b38585ea 114 0x00, 0x00, // Company identifier code (0x004C == Apple)
sigveseb 3:5432b38585ea 115 0x02, // ID
sigveseb 3:5432b38585ea 116 0x15, // length of the remaining payload
sigveseb 3:5432b38585ea 117 0xE2, 0x0A, 0x39, 0xF4, 0x73, 0xF5, 0x4B, 0xC4, // UUID
sigveseb 3:5432b38585ea 118 0xA1, 0x2F, 0x17, 0xD1, 0xAD, 0x07, 0xA9, 0x61,
sigveseb 3:5432b38585ea 119 0x13, 0x37, // the major value to differenciate a location (Our app requires 1337 as major number)
sigveseb 3:5432b38585ea 120 0x00, 0x00, // the minor value to differenciate a location (Change this to differentiate location pucks)
sigveseb 3:5432b38585ea 121 0xC8 // 2's complement of the Tx power (-56dB)
sigveseb 3:5432b38585ea 122 };
sigveseb 3:5432b38585ea 123 beaconPayloadTemplate[22] = minor >> 8;
sigveseb 3:5432b38585ea 124 beaconPayloadTemplate[23] = minor & 255;
sigveseb 3:5432b38585ea 125
sigveseb 3:5432b38585ea 126 for (int i=0; i < 25; i++) {
sigveseb 3:5432b38585ea 127 beaconPayload[i] = beaconPayloadTemplate[i];
sigveseb 3:5432b38585ea 128 }
sigveseb 3:5432b38585ea 129
sigveseb 3:5432b38585ea 130 ble.init();
sigveseb 3:5432b38585ea 131 LOG_VERBOSE("Inited BLEDevice.\n");
sigveseb 3:5432b38585ea 132 setState(DISCONNECTED);
sigveseb 3:5432b38585ea 133
sigveseb 3:5432b38585ea 134 ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED);
sigveseb 3:5432b38585ea 135 LOG_VERBOSE("Accumulate advertising payload: BREDR_NOT_SUPPORTED.\n");
sigveseb 3:5432b38585ea 136
sigveseb 3:5432b38585ea 137 ble.accumulateAdvertisingPayload(GapAdvertisingData::MANUFACTURER_SPECIFIC_DATA, beaconPayload, sizeof(beaconPayload));
sigveseb 3:5432b38585ea 138 LOG_VERBOSE("Accumulate advertising payload: beacon data.\n");
sigveseb 3:5432b38585ea 139
sigveseb 3:5432b38585ea 140 ble.setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
sigveseb 3:5432b38585ea 141 LOG_VERBOSE("Setting advertising type: ADV_CONNECTABLE_UNDIRECTED.\n");
sigveseb 3:5432b38585ea 142
sigveseb 3:5432b38585ea 143 int hundredMillisecondsInAdvertisingIntervalFormat = 160;
sigveseb 3:5432b38585ea 144 ble.setAdvertisingInterval(hundredMillisecondsInAdvertisingIntervalFormat);
sigveseb 3:5432b38585ea 145 LOG_VERBOSE("Set advertising interval: 160 (100 ms).\n");
sigveseb 3:5432b38585ea 146
sigveseb 3:5432b38585ea 147 ble.onDisconnection(onDisconnection);
sigveseb 3:5432b38585ea 148 ble.onConnection(onConnection);
sigveseb 3:5432b38585ea 149 ble.onDataWritten(onDataWrittenCallback);
sigveseb 3:5432b38585ea 150
sigveseb 3:5432b38585ea 151 for(int i = 0; i < services.size(); i++) {
sigveseb 3:5432b38585ea 152 ble.addService(*services[i]);
sigveseb 3:5432b38585ea 153 LOG_VERBOSE("Added service %x to BLEDevice\n", services[i]);
sigveseb 3:5432b38585ea 154 }
sigveseb 3:5432b38585ea 155
sigveseb 3:5432b38585ea 156 LOG_INFO("Inited puck as 0x%X.\n", minor);
sigveseb 3:5432b38585ea 157 }
sigveseb 3:5432b38585ea 158
sigveseb 3:5432b38585ea 159 void Puck::startAdvertising() {
sigveseb 3:5432b38585ea 160 ble.startAdvertising();
sigveseb 3:5432b38585ea 161 LOG_INFO("Starting to advertise.\n");
sigveseb 3:5432b38585ea 162 setState(ADVERTISING);
sigveseb 3:5432b38585ea 163 }
sigveseb 3:5432b38585ea 164
sigveseb 3:5432b38585ea 165 void Puck::stopAdvertising() {
sigveseb 3:5432b38585ea 166 if(state == ADVERTISING) {
sigveseb 3:5432b38585ea 167 ble.stopAdvertising();
sigveseb 3:5432b38585ea 168 LOG_INFO("Stopped advertising.\n");
sigveseb 3:5432b38585ea 169 setState(DISCONNECTED);
sigveseb 3:5432b38585ea 170 } else {
sigveseb 3:5432b38585ea 171 LOG_WARN("Tried to stop advertising, but advertising is already stopped!\n");
sigveseb 3:5432b38585ea 172 }
sigveseb 3:5432b38585ea 173 }
sigveseb 3:5432b38585ea 174
sigveseb 3:5432b38585ea 175
sigveseb 3:5432b38585ea 176 void Puck::addCharacteristic(const UUID serviceUuid, const UUID characteristicUuid, int bytes, int properties) {
sigveseb 3:5432b38585ea 177 MBED_ASSERT(bytes <= 20);
sigveseb 3:5432b38585ea 178
sigveseb 3:5432b38585ea 179 uint16_t size = sizeof(uint8_t) * bytes;
sigveseb 3:5432b38585ea 180 uint8_t* value = (uint8_t*) malloc(size);
sigveseb 3:5432b38585ea 181 GattCharacteristic* characteristic = new GattCharacteristic(characteristicUuid, value, size, size, properties);
sigveseb 3:5432b38585ea 182 characteristics.push_back(characteristic);
sigveseb 3:5432b38585ea 183 GattService* service = NULL;
sigveseb 3:5432b38585ea 184 int removeIndex = -1;
sigveseb 3:5432b38585ea 185 for(int i = 0; i < services.size(); i++) {
sigveseb 3:5432b38585ea 186 if(isEqualUUID(&services[i]->getUUID(), serviceUuid)) {
sigveseb 3:5432b38585ea 187 service = services[i];
sigveseb 3:5432b38585ea 188 removeIndex = i;
sigveseb 3:5432b38585ea 189 break;
sigveseb 3:5432b38585ea 190 }
sigveseb 3:5432b38585ea 191 }
sigveseb 3:5432b38585ea 192 GattCharacteristic** characteristics = NULL;
sigveseb 3:5432b38585ea 193 int characteristicsLength = 0;
sigveseb 3:5432b38585ea 194 if(service != NULL) {
sigveseb 3:5432b38585ea 195 characteristicsLength = service->getCharacteristicCount() + 1;
sigveseb 3:5432b38585ea 196 characteristics = (GattCharacteristic**) malloc(sizeof(GattCharacteristic*) * characteristicsLength);
sigveseb 3:5432b38585ea 197 for(int i = 0; i < characteristicsLength; i++) {
sigveseb 3:5432b38585ea 198 characteristics[i] = service->getCharacteristic(i);
sigveseb 3:5432b38585ea 199 }
sigveseb 3:5432b38585ea 200 services.erase(services.begin() + removeIndex);
sigveseb 3:5432b38585ea 201 delete service;
stiaje 4:91506772210d 202 free(previousCharacteristics);
sigveseb 3:5432b38585ea 203 } else {
sigveseb 3:5432b38585ea 204 characteristicsLength = 1;
sigveseb 3:5432b38585ea 205 characteristics = (GattCharacteristic**) malloc(sizeof(GattCharacteristic*) * characteristicsLength);
sigveseb 3:5432b38585ea 206 }
sigveseb 3:5432b38585ea 207 characteristics[characteristicsLength - 1] = characteristic;
stiaje 4:91506772210d 208 previousCharacteristics = characteristics;
sigveseb 3:5432b38585ea 209 service = new GattService(serviceUuid, characteristics, characteristicsLength);
sigveseb 3:5432b38585ea 210 services.push_back(service);
sigveseb 3:5432b38585ea 211 }
sigveseb 3:5432b38585ea 212
sigveseb 3:5432b38585ea 213 bool Puck::drive() {
sigveseb 3:5432b38585ea 214 ble.waitForEvent();
sigveseb 3:5432b38585ea 215 if(state == DISCONNECTED) {
sigveseb 3:5432b38585ea 216 startAdvertising();
sigveseb 3:5432b38585ea 217 }
sigveseb 3:5432b38585ea 218 while(pendingCallbackStack.size() > 0) {
sigveseb 3:5432b38585ea 219 LOG_VERBOSE("PendingCallbackStack size: %i\n", pendingCallbackStack.size());
sigveseb 3:5432b38585ea 220 pendingCallbackStack.back()(pendingCallbackParameterStack.back());
sigveseb 3:5432b38585ea 221 pendingCallbackStack.pop_back();
sigveseb 3:5432b38585ea 222 pendingCallbackParameterStack.pop_back();
sigveseb 3:5432b38585ea 223 LOG_VERBOSE("Callback fired\n");
sigveseb 3:5432b38585ea 224 }
sigveseb 3:5432b38585ea 225 return true;
sigveseb 3:5432b38585ea 226 }
sigveseb 3:5432b38585ea 227
sigveseb 3:5432b38585ea 228
sigveseb 3:5432b38585ea 229 void Puck::onCharacteristicWrite(const UUID uuid, CharacteristicWriteCallback callback) {
sigveseb 3:5432b38585ea 230 CharacteristicWriteCallbacks* cb = NULL;
sigveseb 3:5432b38585ea 231 for(int i = 0; i< writeCallbacks.size(); i++) {
sigveseb 3:5432b38585ea 232 if(isEqualUUID(writeCallbacks[i]->uuid, uuid)) {
sigveseb 3:5432b38585ea 233 cb = writeCallbacks[i];
sigveseb 3:5432b38585ea 234 break;
sigveseb 3:5432b38585ea 235 }
sigveseb 3:5432b38585ea 236 }
sigveseb 3:5432b38585ea 237 if(cb == NULL) {
sigveseb 3:5432b38585ea 238 cb = (CharacteristicWriteCallbacks*) malloc(sizeof(CharacteristicWriteCallbacks));
sigveseb 3:5432b38585ea 239 cb->uuid = &uuid;
sigveseb 3:5432b38585ea 240 cb->callbacks = new std::vector<CharacteristicWriteCallback>();
sigveseb 3:5432b38585ea 241 writeCallbacks.push_back(cb);
sigveseb 3:5432b38585ea 242 }
sigveseb 3:5432b38585ea 243 cb->callbacks->push_back(callback);
sigveseb 3:5432b38585ea 244 LOG_VERBOSE("Bound characteristic write callback (uuid: %x, callback: %x)\n", uuid, callback);
sigveseb 3:5432b38585ea 245 }
sigveseb 3:5432b38585ea 246
sigveseb 3:5432b38585ea 247
sigveseb 3:5432b38585ea 248 uint8_t* Puck::getCharacteristicValue(const UUID uuid) {
sigveseb 3:5432b38585ea 249 LOG_VERBOSE("Reading characteristic value for UUID %x\n", uuid);
sigveseb 3:5432b38585ea 250 for(int i = 0; i < characteristics.size(); i++) {
sigveseb 3:5432b38585ea 251 GattCharacteristic* characteristic = characteristics[i];
sigveseb 3:5432b38585ea 252 if(isEqualUUID(&characteristic->getUUID(), uuid)) {
sigveseb 3:5432b38585ea 253 return characteristic->getValuePtr();
sigveseb 3:5432b38585ea 254 }
sigveseb 3:5432b38585ea 255 }
sigveseb 3:5432b38585ea 256 LOG_WARN("Tried to read an unknown characteristic!");
sigveseb 3:5432b38585ea 257 return NULL;
sigveseb 3:5432b38585ea 258 }
sigveseb 3:5432b38585ea 259
sigveseb 3:5432b38585ea 260
sigveseb 3:5432b38585ea 261 void Puck::onDataWritten(uint16_t handle) {
sigveseb 3:5432b38585ea 262 for (int i = 0; i < characteristics.size(); i++) {
sigveseb 3:5432b38585ea 263 GattCharacteristic* characteristic = characteristics[i];
sigveseb 3:5432b38585ea 264 if (characteristic->getHandle() == handle) {
sigveseb 3:5432b38585ea 265 uint16_t maxLength = characteristic->getMaxLength();
sigveseb 3:5432b38585ea 266 ble.readCharacteristicValue(handle, characteristic->getValuePtr(), &maxLength);
sigveseb 3:5432b38585ea 267 for(int j = 0; j < writeCallbacks.size(); j++) {
sigveseb 3:5432b38585ea 268 CharacteristicWriteCallbacks* characteristicWriteCallbacks = writeCallbacks[j];
sigveseb 3:5432b38585ea 269 if(isEqualUUID(characteristicWriteCallbacks->uuid, characteristic->getUUID())) {
sigveseb 3:5432b38585ea 270 for(int k = 0; k < characteristicWriteCallbacks->callbacks->size(); k++) {
sigveseb 3:5432b38585ea 271 pendingCallbackStack.push_back(characteristicWriteCallbacks->callbacks->at(k));
sigveseb 3:5432b38585ea 272 pendingCallbackParameterStack.push_back(characteristic->getValuePtr());
sigveseb 3:5432b38585ea 273 }
sigveseb 3:5432b38585ea 274 }
sigveseb 3:5432b38585ea 275 return;
sigveseb 3:5432b38585ea 276 }
sigveseb 3:5432b38585ea 277 }
sigveseb 3:5432b38585ea 278 }
sigveseb 3:5432b38585ea 279 }
sigveseb 3:5432b38585ea 280
sigveseb 3:5432b38585ea 281
sigveseb 3:5432b38585ea 282
sigveseb 3:5432b38585ea 283 #endif // __PUCK_HPP__