Hugo Pristauz / Mbed 2 deprecated S14_TOF_Detector

TOF based Presence Detector

Dependencies:   BLE_API X_NUCLEO_6180XA1 X_NUCLEO_IDB0XA1 mbed

Fork of BLE_HeartRate_IDB0XA1 by ST

bricks/characteristic.h@29:eceecbe28088, 2018-08-20 (annotated)

Committer:
hux
Date:
Mon Aug 20 16:43:10 2018 +0000
Revision:
29:eceecbe28088
made in Shanghai

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hux 29:eceecbe28088 1 // characteristic.h - an easy to use overloaded characteristic class
hux 29:eceecbe28088 2 //
hux 29:eceecbe28088 3 // Synopsis:
hux 29:eceecbe28088 4 //
hux 29:eceecbe28088 5 // Characteristic<type> myCharacteristic(col,uuid,mode);
hux 29:eceecbe28088 6 // Characteristic<type> myCharacteristic(col,uuid,mode,name);
hux 29:eceecbe28088 7 // Characteristic<type> myCharacteristic(col,uuid,mode,name,inidata);
hux 29:eceecbe28088 8 // Characteristic<type> myCharacteristic(col,uuid,mode,inidata);
hux 29:eceecbe28088 9 //
hux 29:eceecbe28088 10 // Declaration of a characteristic, specifying value type, UUID and access mode,
hux 29:eceecbe28088 11 // optionally providing a name (user descriptor) and initial data.
hux 29:eceecbe28088 12 //
hux 29:eceecbe28088 13 // col: Collection, to which the constructed characteristic is automati-
hux 29:eceecbe28088 14 // cally added. After construction and adding all characteristics to
hux 29:eceecbe28088 15 // a collection this collection is passed to a service constructor,
hux 29:eceecbe28088 16 // which gets thus knowledge about all characteristics which have to
hux 29:eceecbe28088 17 // be involved in the service
hux 29:eceecbe28088 18 //
hux 29:eceecbe28088 19 // uuid: A unique universal ID which identifies the characteristic
hux 29:eceecbe28088 20 //
hux 29:eceecbe28088 21 // mode: A string comprising zero or more mode characters which
hux 29:eceecbe28088 22 // define possible properties of the characteristic.
hux 29:eceecbe28088 23 //
hux 29:eceecbe28088 24 // "" no properties
hux 29:eceecbe28088 25 // "b" broadcast
hux 29:eceecbe28088 26 // "r" read access
hux 29:eceecbe28088 27 // "s" send & pray (write without response)
hux 29:eceecbe28088 28 // "w" write access (with feedback)
hux 29:eceecbe28088 29 // "n" notification (no client confirmation)
hux 29:eceecbe28088 30 // "i" indication (with client confirmation)
hux 29:eceecbe28088 31 // "a" authentication signed write
hux 29:eceecbe28088 32 // "x" extended access
hux 29:eceecbe28088 33 //
hux 29:eceecbe28088 34 // name: An optional name provided in terms of a user descriptor. If this
hux 29:eceecbe28088 35 // argument is omitted the user descriptor is not created.
hux 29:eceecbe28088 36 //
hux 29:eceecbe28088 37 // inidata: A pointer to a variable containing initializing data for the
hux 29:eceecbe28088 38 // characteristic. If the inidata argument is not provided, an
hux 29:eceecbe28088 39 // implicit initialization is performed which clears the characte-
hux 29:eceecbe28088 40 // ristic (all bytes set to 0). As a concluding remark it needs to
hux 29:eceecbe28088 41 // be noted that the implicite initialozation works only for
hux 29:eceecbe28088 42 // sizeof(Type) <= SIZE_INIBUFFER (defined in "bricks/types.h")
hux 29:eceecbe28088 43 //
hux 29:eceecbe28088 44 //
hux 29:eceecbe28088 45 // Example 1: A protocol might be declared as a class as follows
hux 29:eceecbe28088 46 //
hux 29:eceecbe28088 47 // Collection col; // collection used during setup
hux 29:eceecbe28088 48 //
hux 29:eceecbe28088 49 // Characteristic<ObjectId> id(col,0x2AC3,"rw","ID");
hux 29:eceecbe28088 50 // Characteristic<ObjectName> name(col,0x2ABE,"rw","Name");
hux 29:eceecbe28088 51 // Characteristic<Digital> presence(col,0x2A56,"r","Presence");
hux 29:eceecbe28088 52 //
hux 29:eceecbe28088 53 // Service presenceDetection(col,0xA001); // instantiate service
hux 29:eceecbe28088 54 //
hux 29:eceecbe28088 55 // onSetup(Blob &blue)
hux 29:eceecbe28088 56 // {
hux 29:eceecbe28088 57 // blue.service(presenceDetection); // add service
hux 29:eceecbe28088 58 // }
hux 29:eceecbe28088 59 //
hux 29:eceecbe28088 60 // Example 2: service definition by means of a service definition class
hux 29:eceecbe28088 61 //
hux 29:eceecbe28088 62 // class PresenceDetector
hux 29:eceecbe28088 63 // {
hux 29:eceecbe28088 64 // public:
hux 29:eceecbe28088 65 // Collection col; // collection used during setup
hux 29:eceecbe28088 66 //
hux 29:eceecbe28088 67 // Characteristic<ObjectId> id; // ID of presence detector
hux 29:eceecbe28088 68 // Characteristic<ObjectName> name; // name of presence detector
hux 29:eceecbe28088 69 // Characteristic<Digital> presence; // digital presence value
hux 29:eceecbe28088 70 // Characteristic<DateTime> timestamp; // last detection change's time
hux 29:eceecbe28088 71 // Characteristic<ObjectName> layout; // name of model railway layout
hux 29:eceecbe28088 72 //
hux 29:eceecbe28088 73 // Service presenceDetection; // the service
hux 29:eceecbe28088 74 //
hux 29:eceecbe28088 75 // public:
hux 29:eceecbe28088 76 // PresenceDetector(Blob &blue, cost UUID uuid) :
hux 29:eceecbe28088 77 // list; // init service list
hux 29:eceecbe28088 78 // id(list,0x2AC3,"rw","ID"), // instantiate characteristic
hux 29:eceecbe28088 79 // name(list,0x2ABE,"rw","Name"), // instantiate characteristic
hux 29:eceecbe28088 80 // presence(list,0x2A56,"r","Presence"),// instantiate characteristic
hux 29:eceecbe28088 81 // timestamp(list,0x2A08,"r","Timestamp"),// instantiate characteristic
hux 29:eceecbe28088 82 // layout(list,0x2ABE,"rw","Layout"), // instantiate characteristic
hux 29:eceecbe28088 83 // presenceDetection(list,uuid) // instantiate service
hux 29:eceecbe28088 84 // {
hux 29:eceecbe28088 85 // blue.service(presenceDetection); // add service
hux 29:eceecbe28088 86 // }
hux 29:eceecbe28088 87 // };
hux 29:eceecbe28088 88 //
hux 29:eceecbe28088 89 #ifndef _CHARACTERISTIC_H_
hux 29:eceecbe28088 90 #define _CHARACTERISTIC_H_
hux 29:eceecbe28088 91
hux 29:eceecbe28088 92 #include "ble/BLE.h"
hux 29:eceecbe28088 93 #include "ble/Gap.h"
hux 29:eceecbe28088 94 #include "bricks/types.h"
hux 29:eceecbe28088 95 #include "bricks/collection.h"
hux 29:eceecbe28088 96 #include "bricks/descriptor.h"
hux 29:eceecbe28088 97
hux 29:eceecbe28088 98 // the following #define is helpful if characteristics are defined on base
hux 29:eceecbe28088 99 // of the BLE API (the tedious way)
hux 29:eceecbe28088 100
hux 29:eceecbe28088 101 #define UserDescriptor(name,attribute,descriptor,text) \
hux 29:eceecbe28088 102 static char *name = text; \
hux 29:eceecbe28088 103 static GattAttribute attribute(0x2901,(uint8_t*)name,strlen(name),strlen(name)); \
hux 29:eceecbe28088 104 static GattAttribute *descriptor[] = {&attribute};
hux 29:eceecbe28088 105
hux 29:eceecbe28088 106 // the declaration of Characteristics needs the availability of an
hux 29:eceecbe28088 107 // initializing buffer in the default case
hux 29:eceecbe28088 108
hux 29:eceecbe28088 109 extern IniBuffer characteristicInidata; // to initialize a characteristic
hux 29:eceecbe28088 110
hux 29:eceecbe28088 111 // class definition of a characteristic initializer
hux 29:eceecbe28088 112
hux 29:eceecbe28088 113 class CharacteristicInitializer // provides pointers to initialized data
hux 29:eceecbe28088 114 {
hux 29:eceecbe28088 115 private:
hux 29:eceecbe28088 116 IniBuffer inibuf; // initialized data
hux 29:eceecbe28088 117
hux 29:eceecbe28088 118 public:
hux 29:eceecbe28088 119 ObjectId *pObjectId() { return (ObjectId*) &inibuf; }
hux 29:eceecbe28088 120 ObjectName *pObjectName() { return (ObjectName*) &inibuf; }
hux 29:eceecbe28088 121 Bool *pBool() { return (Bool*) &inibuf; }
hux 29:eceecbe28088 122 Digital *pDigital() { return (Digital*) &inibuf; }
hux 29:eceecbe28088 123 DateTime *pDateTime() { return (DateTime*) &inibuf; }
hux 29:eceecbe28088 124 Buffer *pBuffer() { return (Buffer*) &inibuf; }
hux 29:eceecbe28088 125
hux 29:eceecbe28088 126 public:
hux 29:eceecbe28088 127 CharacteristicInitializer() // constructor
hux 29:eceecbe28088 128 {
hux 29:eceecbe28088 129 memset(inibuf,0,sizeof(IniBuffer));
hux 29:eceecbe28088 130
hux 29:eceecbe28088 131 // besides of the local inibuf also initialize the global
hux 29:eceecbe28088 132 // init buffer characteristicInidata;
hux 29:eceecbe28088 133
hux 29:eceecbe28088 134 memset(characteristicInidata,0,sizeof(IniBuffer));
hux 29:eceecbe28088 135 }
hux 29:eceecbe28088 136 };
hux 29:eceecbe28088 137
hux 29:eceecbe28088 138 // definition of class Characteristic
hux 29:eceecbe28088 139
hux 29:eceecbe28088 140 class Service;
hux 29:eceecbe28088 141
hux 29:eceecbe28088 142 template <typename Type>
hux 29:eceecbe28088 143 class Characteristic : public GattCharacteristic
hux 29:eceecbe28088 144 {
hux 29:eceecbe28088 145 private:
hux 29:eceecbe28088 146 void init() // initialize inibuffer
hux 29:eceecbe28088 147 {
hux 29:eceecbe28088 148 static int initialized = 0;
hux 29:eceecbe28088 149
hux 29:eceecbe28088 150 if (!initialized) // clear init data buffer
hux 29:eceecbe28088 151 { initialized = 1;
hux 29:eceecbe28088 152 memset(characteristicInidata,0,sizeof(IniBuffer));
hux 29:eceecbe28088 153 }
hux 29:eceecbe28088 154 }
hux 29:eceecbe28088 155
hux 29:eceecbe28088 156 private:
hux 29:eceecbe28088 157 UserDescriptor descriptor; // characteristic's user descriptor
hux 29:eceecbe28088 158
hux 29:eceecbe28088 159 uint8_t getmask(const char *pmask)
hux 29:eceecbe28088 160 {
hux 29:eceecbe28088 161 uint8_t mask = 0;
hux 29:eceecbe28088 162
hux 29:eceecbe28088 163 for(;*pmask;pmask++)
hux 29:eceecbe28088 164 { switch (*pmask)
hux 29:eceecbe28088 165 {
hux 29:eceecbe28088 166 case 'b': // broad cast
hux 29:eceecbe28088 167 mask = mask | BLE_GATT_CHAR_PROPERTIES_BROADCAST;
hux 29:eceecbe28088 168 break;
hux 29:eceecbe28088 169 case 'r': // read
hux 29:eceecbe28088 170 mask = mask | BLE_GATT_CHAR_PROPERTIES_READ;
hux 29:eceecbe28088 171 break;
hux 29:eceecbe28088 172 case 's': // send (& pray)
hux 29:eceecbe28088 173 mask = mask | BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE;
hux 29:eceecbe28088 174 break;
hux 29:eceecbe28088 175 case 'w': // write
hux 29:eceecbe28088 176 mask = mask | BLE_GATT_CHAR_PROPERTIES_WRITE;
hux 29:eceecbe28088 177 break;
hux 29:eceecbe28088 178 case 'n': // notify
hux 29:eceecbe28088 179 mask = mask | BLE_GATT_CHAR_PROPERTIES_NOTIFY;
hux 29:eceecbe28088 180 break;
hux 29:eceecbe28088 181 case 'i': // indicate
hux 29:eceecbe28088 182 mask = mask | BLE_GATT_CHAR_PROPERTIES_INDICATE;
hux 29:eceecbe28088 183 break;
hux 29:eceecbe28088 184 case 'a': // authenticated signed write
hux 29:eceecbe28088 185 mask = mask | BLE_GATT_CHAR_PROPERTIES_AUTHENTICATED_SIGNED_WRITES;
hux 29:eceecbe28088 186 break;
hux 29:eceecbe28088 187 case 'x': // extended properties
hux 29:eceecbe28088 188 mask = mask | BLE_GATT_CHAR_PROPERTIES_EXTENDED_PROPERTIES;
hux 29:eceecbe28088 189 break;
hux 29:eceecbe28088 190 }
hux 29:eceecbe28088 191 }
hux 29:eceecbe28088 192 return mask;
hux 29:eceecbe28088 193 }
hux 29:eceecbe28088 194 /*
hux 29:eceecbe28088 195 public:
hux 29:eceecbe28088 196 Characteristic<Type> (Service &service, UUID uuid, const char *mode,
hux 29:eceecbe28088 197 Type *valuePtr = (Type*)&characteristicInidata) :
hux 29:eceecbe28088 198 GattCharacteristic(uuid,
hux 29:eceecbe28088 199 reinterpret_cast<uint8_t*> (valuePtr),
hux 29:eceecbe28088 200 sizeof(Type),
hux 29:eceecbe28088 201 sizeof(Type),
hux 29:eceecbe28088 202 getmask(mode),
hux 29:eceecbe28088 203 NULL, // descriptor list
hux 29:eceecbe28088 204 0, // number of descriptors
hux 29:eceecbe28088 205 false),
hux 29:eceecbe28088 206 descriptor("") // construct descriptor
hux 29:eceecbe28088 207 {
hux 29:eceecbe28088 208 init(); // assure initializing
hux 29:eceecbe28088 209
hux 29:eceecbe28088 210 // there is a potential danger that we use implicite initializing
hux 29:eceecbe28088 211 // with sizeof(Type) > sizeof(inibuffer). This must be prevented!
hux 29:eceecbe28088 212
hux 29:eceecbe28088 213 int feasible = (sizeof(Type) <= sizeof(IniBuffer));
hux 29:eceecbe28088 214 if (feasible || valuePtr != (Type*)&characteristicInidata)
hux 29:eceecbe28088 215 {
hux 29:eceecbe28088 216 service.add(this); // add to service
hux 29:eceecbe28088 217 } // otherwise just ignore!
hux 29:eceecbe28088 218 }
hux 29:eceecbe28088 219 */
hux 29:eceecbe28088 220 public:
hux 29:eceecbe28088 221 Characteristic<Type> (Service &service, UUID uuid, const char *mode,
hux 29:eceecbe28088 222 const char *name, Type *valuePtr = (Type*)&characteristicInidata) :
hux 29:eceecbe28088 223 GattCharacteristic(uuid,
hux 29:eceecbe28088 224 reinterpret_cast<uint8_t*> (valuePtr),
hux 29:eceecbe28088 225 sizeof(Type),
hux 29:eceecbe28088 226 sizeof(Type),
hux 29:eceecbe28088 227 getmask(mode),
hux 29:eceecbe28088 228 descriptor.plist, // descriptor list
hux 29:eceecbe28088 229 1, // number of descriptors
hux 29:eceecbe28088 230 false),
hux 29:eceecbe28088 231 descriptor(name) // construct descriptor
hux 29:eceecbe28088 232 {
hux 29:eceecbe28088 233 init(); // assure initializing
hux 29:eceecbe28088 234
hux 29:eceecbe28088 235 // there is a potential danger that we use implicite initializing
hux 29:eceecbe28088 236 // with sizeof(Type) > sizeof(inibuffer). This must be prevented!
hux 29:eceecbe28088 237
hux 29:eceecbe28088 238 int feasible = (sizeof(Type) <= sizeof(IniBuffer));
hux 29:eceecbe28088 239 if (feasible || valuePtr != (Type*)&characteristicInidata)
hux 29:eceecbe28088 240 {
hux 29:eceecbe28088 241 service.add(this); // add to service
hux 29:eceecbe28088 242 } // otherwise just ignore!
hux 29:eceecbe28088 243 }
hux 29:eceecbe28088 244 };
hux 29:eceecbe28088 245
hux 29:eceecbe28088 246
hux 29:eceecbe28088 247 #endif // _CHARACTERISTIC_H_