Roy Want / BLE_API

Added an EddystoneURLConfigService in addition to UriBeaconConfigService. Updated README and converted comments that used UriBeacon to EddystoneURL in the EddystoneService.h

Dependents:   mbed_EddystoneURL_Beacon_ssci mbed_EddystoneURL_Beacon_ssci mbed_EddystoneURL_Beacon_ssci

Fork of BLE_API by Bluetooth Low Energy

ble/services/DeviceInformationService.h@797:13164356b568, 2015-08-19 (annotated)

Committer:
roywant
Date:
Wed Aug 19 04:27:52 2015 +0000
Revision:
797:13164356b568
Parent:
760:71b8617d95df 
Updated EddystoneURLConfigService.h : 1) lockedState now is a member of params.lockedState ; zeros are not the unlock value (and a valid key), this now passes the Validator, 2) After disconnect the timeADV is disabled, and ADV params recreated.

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 #ifndef __BLE_DEVICE_INFORMATION_SERVICE_H__
rgrover1 712:b04b5db36865 18 #define __BLE_DEVICE_INFORMATION_SERVICE_H__
rgrover1 712:b04b5db36865 19
rgrover1 712:b04b5db36865 20 #include "ble/BLE.h"
rgrover1 712:b04b5db36865 21
rgrover1 712:b04b5db36865 22 /**
rgrover1 712:b04b5db36865 23 * @class DeviceInformationService
rgrover1 712:b04b5db36865 24 * @brief BLE Device Information Service <br>
rgrover1 712:b04b5db36865 25 * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml <br>
rgrover1 712:b04b5db36865 26 * Manufacturer Name String Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.manufacturer_name_string.xml
rgrover1 712:b04b5db36865 27 */
rgrover1 712:b04b5db36865 28 class DeviceInformationService {
rgrover1 712:b04b5db36865 29 public:
rgrover1 712:b04b5db36865 30 /**
rgrover1 712:b04b5db36865 31 * @brief Device Information Service Constructor.
rgrover1 712:b04b5db36865 32 *
rgrover1 712:b04b5db36865 33 * @param[ref] _ble
rgrover1 712:b04b5db36865 34 * BLE object for the underlying controller.
rgrover1 712:b04b5db36865 35 * @param[in] manufacturersName
rgrover1 712:b04b5db36865 36 * This characteristic represents the name of the
rgrover1 712:b04b5db36865 37 * manufacturer of the device. The name is copied into the
rgrover1 712:b04b5db36865 38 * BLE stack during this constructor.
rgrover1 712:b04b5db36865 39 * @param[in] modelNumber
rgrover1 712:b04b5db36865 40 * This characteristic represents the model number that is
rgrover1 712:b04b5db36865 41 * assigned by the device vendor. The value is copied into
rgrover1 712:b04b5db36865 42 * the BLE stack during this constructor.
rgrover1 712:b04b5db36865 43 * @param[in] serialNumber
rgrover1 712:b04b5db36865 44 * This characteristic represents the serial number for a
rgrover1 712:b04b5db36865 45 * particular instance of the device. The value is copied
rgrover1 712:b04b5db36865 46 * into the BLE stack during this constructor.
rgrover1 712:b04b5db36865 47 * @param[in] hardwareRevision
rgrover1 712:b04b5db36865 48 * This characteristic represents the hardware revision for
rgrover1 712:b04b5db36865 49 * the hardware within the device. The value is copied
rgrover1 712:b04b5db36865 50 * into the BLE stack during this constructor.
rgrover1 712:b04b5db36865 51 * @param[in] firmwareRevision
rgrover1 712:b04b5db36865 52 * This characteristic represents the firmware revision for
rgrover1 712:b04b5db36865 53 * the firmware within the device. The value is copied
rgrover1 712:b04b5db36865 54 * into the BLE stack during this constructor.
rgrover1 712:b04b5db36865 55 * @param[in] softwareRevision
rgrover1 712:b04b5db36865 56 * This characteristic represents the software revision for
rgrover1 712:b04b5db36865 57 * the software within the device. The value is copied
rgrover1 712:b04b5db36865 58 * into the BLE stack during this constructor.
rgrover1 712:b04b5db36865 59 */
rgrover1 712:b04b5db36865 60 DeviceInformationService(BLE &_ble,
rgrover1 712:b04b5db36865 61 const char *manufacturersName = NULL,
rgrover1 712:b04b5db36865 62 const char *modelNumber = NULL,
rgrover1 712:b04b5db36865 63 const char *serialNumber = NULL,
rgrover1 712:b04b5db36865 64 const char *hardwareRevision = NULL,
rgrover1 712:b04b5db36865 65 const char *firmwareRevision = NULL,
rgrover1 712:b04b5db36865 66 const char *softwareRevision = NULL) :
rgrover1 712:b04b5db36865 67 ble(_ble),
rgrover1 712:b04b5db36865 68 manufacturersNameStringCharacteristic(GattCharacteristic::UUID_MANUFACTURER_NAME_STRING_CHAR,
rgrover1 712:b04b5db36865 69 (uint8_t *)manufacturersName,
rgrover1 712:b04b5db36865 70 (manufacturersName != NULL) ? strlen(manufacturersName) : 0, /* minLength */
rgrover1 712:b04b5db36865 71 (manufacturersName != NULL) ? strlen(manufacturersName) : 0, /* maxLength */
rgrover1 712:b04b5db36865 72 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 73 modelNumberStringCharacteristic(GattCharacteristic::UUID_MODEL_NUMBER_STRING_CHAR,
rgrover1 712:b04b5db36865 74 (uint8_t *)modelNumber,
rgrover1 712:b04b5db36865 75 (modelNumber != NULL) ? strlen(modelNumber) : 0, /* minLength */
rgrover1 712:b04b5db36865 76 (modelNumber != NULL) ? strlen(modelNumber) : 0, /* maxLength */
rgrover1 712:b04b5db36865 77 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 78 serialNumberStringCharacteristic(GattCharacteristic::UUID_SERIAL_NUMBER_STRING_CHAR,
rgrover1 712:b04b5db36865 79 (uint8_t *)serialNumber,
rgrover1 712:b04b5db36865 80 (serialNumber != NULL) ? strlen(serialNumber) : 0, /* minLength */
rgrover1 712:b04b5db36865 81 (serialNumber != NULL) ? strlen(serialNumber) : 0, /* maxLength */
rgrover1 712:b04b5db36865 82 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 83 hardwareRevisionStringCharacteristic(GattCharacteristic::UUID_HARDWARE_REVISION_STRING_CHAR,
rgrover1 712:b04b5db36865 84 (uint8_t *)hardwareRevision,
rgrover1 712:b04b5db36865 85 (hardwareRevision != NULL) ? strlen(hardwareRevision) : 0, /* minLength */
rgrover1 712:b04b5db36865 86 (hardwareRevision != NULL) ? strlen(hardwareRevision) : 0, /* maxLength */
rgrover1 712:b04b5db36865 87 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 88 firmwareRevisionStringCharacteristic(GattCharacteristic::UUID_FIRMWARE_REVISION_STRING_CHAR,
rgrover1 712:b04b5db36865 89 (uint8_t *)firmwareRevision,
rgrover1 712:b04b5db36865 90 (firmwareRevision != NULL) ? strlen(firmwareRevision) : 0, /* minLength */
rgrover1 712:b04b5db36865 91 (firmwareRevision != NULL) ? strlen(firmwareRevision) : 0, /* maxLength */
rgrover1 712:b04b5db36865 92 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 93 softwareRevisionStringCharacteristic(GattCharacteristic::UUID_SOFTWARE_REVISION_STRING_CHAR,
rgrover1 712:b04b5db36865 94 (uint8_t *)softwareRevision,
rgrover1 712:b04b5db36865 95 (softwareRevision != NULL) ? strlen(softwareRevision) : 0, /* minLength */
rgrover1 712:b04b5db36865 96 (softwareRevision != NULL) ? strlen(softwareRevision) : 0, /* maxLength */
rgrover1 712:b04b5db36865 97 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ)
rgrover1 712:b04b5db36865 98 {
rgrover1 760:71b8617d95df 99 static bool serviceAdded = false; /* We should only ever need to add the information service once. */
rgrover1 712:b04b5db36865 100 if (serviceAdded) {
rgrover1 712:b04b5db36865 101 return;
rgrover1 712:b04b5db36865 102 }
rgrover1 712:b04b5db36865 103
rgrover1 712:b04b5db36865 104 GattCharacteristic *charTable[] = {&manufacturersNameStringCharacteristic,
rgrover1 712:b04b5db36865 105 &modelNumberStringCharacteristic,
rgrover1 712:b04b5db36865 106 &serialNumberStringCharacteristic,
rgrover1 712:b04b5db36865 107 &hardwareRevisionStringCharacteristic,
rgrover1 712:b04b5db36865 108 &firmwareRevisionStringCharacteristic,
rgrover1 712:b04b5db36865 109 &softwareRevisionStringCharacteristic};
rgrover1 712:b04b5db36865 110 GattService deviceInformationService(GattService::UUID_DEVICE_INFORMATION_SERVICE, charTable,
rgrover1 712:b04b5db36865 111 sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 712:b04b5db36865 112
rgrover1 712:b04b5db36865 113 ble.addService(deviceInformationService);
rgrover1 712:b04b5db36865 114 serviceAdded = true;
rgrover1 712:b04b5db36865 115 }
rgrover1 712:b04b5db36865 116
rgrover1 712:b04b5db36865 117 protected:
rgrover1 712:b04b5db36865 118 BLE &ble;
rgrover1 712:b04b5db36865 119 GattCharacteristic manufacturersNameStringCharacteristic;
rgrover1 712:b04b5db36865 120 GattCharacteristic modelNumberStringCharacteristic;
rgrover1 712:b04b5db36865 121 GattCharacteristic serialNumberStringCharacteristic;
rgrover1 712:b04b5db36865 122 GattCharacteristic hardwareRevisionStringCharacteristic;
rgrover1 712:b04b5db36865 123 GattCharacteristic firmwareRevisionStringCharacteristic;
rgrover1 712:b04b5db36865 124 GattCharacteristic softwareRevisionStringCharacteristic;
rgrover1 712:b04b5db36865 125 };
rgrover1 712:b04b5db36865 126
rgrover1 712:b04b5db36865 127 #endif /* #ifndef __BLE_DEVICE_INFORMATION_SERVICE_H__*/