Lancaster University / BLE_API

Lancaster University's fork of the mbed BLE API. Lives on github, https://github.com/lancaster-university/BLE_API

Dependents:   microbit-dal microbit-dal microbit-ble-open microbit-dal ... more

Fork of BLE_API by Bluetooth Low Energy

ble/services/DeviceInformationService.h@936:a7bedf42bfb9, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 12:52:06 2015 +0000
Revision:
936:a7bedf42bfb9
Parent:
760:71b8617d95df
Child:
937:4932e700daf2
Synchronized with git rev 700850d1

Author: Irit Arkin

Minor edits

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 936:a7bedf42bfb9 24 * @brief BLE Device Information Service
rgrover1 936:a7bedf42bfb9 25 * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml
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 936:a7bedf42bfb9 31 * @brief Device Information Service Constructor: copies device-specific information
rgrover1 936:a7bedf42bfb9 32 * into the BLE stack.
rgrover1 712:b04b5db36865 33 *
rgrover1 712:b04b5db36865 34 * @param[ref] _ble
rgrover1 712:b04b5db36865 35 * BLE object for the underlying controller.
rgrover1 712:b04b5db36865 36 * @param[in] manufacturersName
rgrover1 936:a7bedf42bfb9 37 * The name of the manufacturer of the device.
rgrover1 712:b04b5db36865 38 * @param[in] modelNumber
rgrover1 936:a7bedf42bfb9 39 * The model number that is assigned by the device vendor.
rgrover1 712:b04b5db36865 40 * @param[in] serialNumber
rgrover1 936:a7bedf42bfb9 41 * The serial number for a particular instance of the device.
rgrover1 712:b04b5db36865 42 * @param[in] hardwareRevision
rgrover1 936:a7bedf42bfb9 43 * The hardware revision for the hardware within the device.
rgrover1 712:b04b5db36865 44 * @param[in] firmwareRevision
rgrover1 936:a7bedf42bfb9 45 * The device's firmware version.
rgrover1 712:b04b5db36865 46 * @param[in] softwareRevision
rgrover1 936:a7bedf42bfb9 47 * The device's software version.
rgrover1 712:b04b5db36865 48 */
rgrover1 712:b04b5db36865 49 DeviceInformationService(BLE &_ble,
rgrover1 712:b04b5db36865 50 const char *manufacturersName = NULL,
rgrover1 712:b04b5db36865 51 const char *modelNumber = NULL,
rgrover1 712:b04b5db36865 52 const char *serialNumber = NULL,
rgrover1 712:b04b5db36865 53 const char *hardwareRevision = NULL,
rgrover1 712:b04b5db36865 54 const char *firmwareRevision = NULL,
rgrover1 712:b04b5db36865 55 const char *softwareRevision = NULL) :
rgrover1 712:b04b5db36865 56 ble(_ble),
rgrover1 712:b04b5db36865 57 manufacturersNameStringCharacteristic(GattCharacteristic::UUID_MANUFACTURER_NAME_STRING_CHAR,
rgrover1 712:b04b5db36865 58 (uint8_t *)manufacturersName,
rgrover1 936:a7bedf42bfb9 59 (manufacturersName != NULL) ? strlen(manufacturersName) : 0, /* Min length */
rgrover1 936:a7bedf42bfb9 60 (manufacturersName != NULL) ? strlen(manufacturersName) : 0, /* Max length */
rgrover1 712:b04b5db36865 61 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 62 modelNumberStringCharacteristic(GattCharacteristic::UUID_MODEL_NUMBER_STRING_CHAR,
rgrover1 712:b04b5db36865 63 (uint8_t *)modelNumber,
rgrover1 936:a7bedf42bfb9 64 (modelNumber != NULL) ? strlen(modelNumber) : 0, /* Min length */
rgrover1 936:a7bedf42bfb9 65 (modelNumber != NULL) ? strlen(modelNumber) : 0, /* Max length */
rgrover1 712:b04b5db36865 66 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 67 serialNumberStringCharacteristic(GattCharacteristic::UUID_SERIAL_NUMBER_STRING_CHAR,
rgrover1 712:b04b5db36865 68 (uint8_t *)serialNumber,
rgrover1 936:a7bedf42bfb9 69 (serialNumber != NULL) ? strlen(serialNumber) : 0, /* Min length */
rgrover1 936:a7bedf42bfb9 70 (serialNumber != NULL) ? strlen(serialNumber) : 0, /* Max length */
rgrover1 712:b04b5db36865 71 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 72 hardwareRevisionStringCharacteristic(GattCharacteristic::UUID_HARDWARE_REVISION_STRING_CHAR,
rgrover1 712:b04b5db36865 73 (uint8_t *)hardwareRevision,
rgrover1 936:a7bedf42bfb9 74 (hardwareRevision != NULL) ? strlen(hardwareRevision) : 0, /* Min length */
rgrover1 936:a7bedf42bfb9 75 (hardwareRevision != NULL) ? strlen(hardwareRevision) : 0, /* Max length */
rgrover1 712:b04b5db36865 76 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 77 firmwareRevisionStringCharacteristic(GattCharacteristic::UUID_FIRMWARE_REVISION_STRING_CHAR,
rgrover1 712:b04b5db36865 78 (uint8_t *)firmwareRevision,
rgrover1 936:a7bedf42bfb9 79 (firmwareRevision != NULL) ? strlen(firmwareRevision) : 0, /* Min length */
rgrover1 936:a7bedf42bfb9 80 (firmwareRevision != NULL) ? strlen(firmwareRevision) : 0, /* Max length */
rgrover1 712:b04b5db36865 81 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
rgrover1 712:b04b5db36865 82 softwareRevisionStringCharacteristic(GattCharacteristic::UUID_SOFTWARE_REVISION_STRING_CHAR,
rgrover1 712:b04b5db36865 83 (uint8_t *)softwareRevision,
rgrover1 936:a7bedf42bfb9 84 (softwareRevision != NULL) ? strlen(softwareRevision) : 0, /* Min length */
rgrover1 936:a7bedf42bfb9 85 (softwareRevision != NULL) ? strlen(softwareRevision) : 0, /* Max length */
rgrover1 712:b04b5db36865 86 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ)
rgrover1 712:b04b5db36865 87 {
rgrover1 936:a7bedf42bfb9 88 static bool serviceAdded = false; /* We only add the information service once. */
rgrover1 712:b04b5db36865 89 if (serviceAdded) {
rgrover1 712:b04b5db36865 90 return;
rgrover1 712:b04b5db36865 91 }
rgrover1 712:b04b5db36865 92
rgrover1 712:b04b5db36865 93 GattCharacteristic *charTable[] = {&manufacturersNameStringCharacteristic,
rgrover1 712:b04b5db36865 94 &modelNumberStringCharacteristic,
rgrover1 712:b04b5db36865 95 &serialNumberStringCharacteristic,
rgrover1 712:b04b5db36865 96 &hardwareRevisionStringCharacteristic,
rgrover1 712:b04b5db36865 97 &firmwareRevisionStringCharacteristic,
rgrover1 712:b04b5db36865 98 &softwareRevisionStringCharacteristic};
rgrover1 712:b04b5db36865 99 GattService deviceInformationService(GattService::UUID_DEVICE_INFORMATION_SERVICE, charTable,
rgrover1 712:b04b5db36865 100 sizeof(charTable) / sizeof(GattCharacteristic *));
rgrover1 712:b04b5db36865 101
rgrover1 712:b04b5db36865 102 ble.addService(deviceInformationService);
rgrover1 712:b04b5db36865 103 serviceAdded = true;
rgrover1 712:b04b5db36865 104 }
rgrover1 712:b04b5db36865 105
rgrover1 712:b04b5db36865 106 protected:
rgrover1 712:b04b5db36865 107 BLE &ble;
rgrover1 712:b04b5db36865 108 GattCharacteristic manufacturersNameStringCharacteristic;
rgrover1 712:b04b5db36865 109 GattCharacteristic modelNumberStringCharacteristic;
rgrover1 712:b04b5db36865 110 GattCharacteristic serialNumberStringCharacteristic;
rgrover1 712:b04b5db36865 111 GattCharacteristic hardwareRevisionStringCharacteristic;
rgrover1 712:b04b5db36865 112 GattCharacteristic firmwareRevisionStringCharacteristic;
rgrover1 712:b04b5db36865 113 GattCharacteristic softwareRevisionStringCharacteristic;
rgrover1 712:b04b5db36865 114 };
rgrover1 712:b04b5db36865 115
rgrover1 712:b04b5db36865 116 #endif /* #ifndef __BLE_DEVICE_INFORMATION_SERVICE_H__*/