ble nano hid over gatt
Dependencies: BLE_API mbed-dev nRF51822
DeviceInformationService.h@86:e0fab77e669d, 2016-09-15 (annotated)
- Committer:
- cho45
- Date:
- Thu Sep 15 09:31:05 2016 +0900
- Revision:
- 86:e0fab77e669d
- Parent:
- 83:2e940d154f8b
support consumer keys
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
cho45 | 0:be89b5fdea09 | 1 | /* mbed Microcontroller Library |
cho45 | 0:be89b5fdea09 | 2 | * Copyright (c) 2006-2013 ARM Limited |
cho45 | 0:be89b5fdea09 | 3 | * |
cho45 | 0:be89b5fdea09 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
cho45 | 0:be89b5fdea09 | 5 | * you may not use this file except in compliance with the License. |
cho45 | 0:be89b5fdea09 | 6 | * You may obtain a copy of the License at |
cho45 | 0:be89b5fdea09 | 7 | * |
cho45 | 0:be89b5fdea09 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
cho45 | 0:be89b5fdea09 | 9 | * |
cho45 | 0:be89b5fdea09 | 10 | * Unless required by applicable law or agreed to in writing, software |
cho45 | 0:be89b5fdea09 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
cho45 | 0:be89b5fdea09 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
cho45 | 0:be89b5fdea09 | 13 | * See the License for the specific language governing permissions and |
cho45 | 0:be89b5fdea09 | 14 | * limitations under the License. |
cho45 | 0:be89b5fdea09 | 15 | */ |
cho45 | 0:be89b5fdea09 | 16 | |
cho45 | 0:be89b5fdea09 | 17 | #ifndef __BLE_DEVICE_INFORMATION_SERVICE_H__ |
cho45 | 0:be89b5fdea09 | 18 | #define __BLE_DEVICE_INFORMATION_SERVICE_H__ |
cho45 | 0:be89b5fdea09 | 19 | |
cho45 | 0:be89b5fdea09 | 20 | #include "ble/BLE.h" |
cho45 | 0:be89b5fdea09 | 21 | |
cho45 |
75:351d7ffe81d1 | 22 | // https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.pnp_id.xml |
cho45 |
75:351d7ffe81d1 | 23 | #pragma pack(push, 1) |
cho45 |
75:351d7ffe81d1 | 24 | typedef struct { |
cho45 |
83:2e940d154f8b | 25 | uint8_t vendorID_source; |
cho45 |
83:2e940d154f8b | 26 | uint16_t vendorID; |
cho45 |
83:2e940d154f8b | 27 | uint16_t productID; |
cho45 |
83:2e940d154f8b | 28 | uint16_t productVersion; |
cho45 |
75:351d7ffe81d1 | 29 | } PnPID_t; |
cho45 |
75:351d7ffe81d1 | 30 | #pragma pack(pop) |
cho45 |
75:351d7ffe81d1 | 31 | |
cho45 | 55:f01a31103685 | 32 | |
cho45 | 0:be89b5fdea09 | 33 | /** |
cho45 | 0:be89b5fdea09 | 34 | * @class DeviceInformationService |
cho45 | 0:be89b5fdea09 | 35 | * @brief BLE Device Information Service |
cho45 | 0:be89b5fdea09 | 36 | * Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml |
cho45 | 0:be89b5fdea09 | 37 | * Manufacturer Name String Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.manufacturer_name_string.xml |
cho45 | 0:be89b5fdea09 | 38 | */ |
cho45 | 0:be89b5fdea09 | 39 | class DeviceInformationService { |
cho45 | 0:be89b5fdea09 | 40 | public: |
cho45 | 0:be89b5fdea09 | 41 | /** |
cho45 | 0:be89b5fdea09 | 42 | * @brief Device Information Service Constructor: copies device-specific information |
cho45 | 0:be89b5fdea09 | 43 | * into the BLE stack. |
cho45 | 0:be89b5fdea09 | 44 | * |
cho45 | 0:be89b5fdea09 | 45 | * @param[in] _ble |
cho45 | 0:be89b5fdea09 | 46 | * A reference to a BLE object for the underlying controller. |
cho45 | 0:be89b5fdea09 | 47 | * @param[in] manufacturersName |
cho45 | 0:be89b5fdea09 | 48 | * The name of the manufacturer of the device. |
cho45 | 0:be89b5fdea09 | 49 | * @param[in] modelNumber |
cho45 | 0:be89b5fdea09 | 50 | * The model number that is assigned by the device vendor. |
cho45 | 0:be89b5fdea09 | 51 | * @param[in] serialNumber |
cho45 | 0:be89b5fdea09 | 52 | * The serial number for a particular instance of the device. |
cho45 | 0:be89b5fdea09 | 53 | * @param[in] hardwareRevision |
cho45 | 0:be89b5fdea09 | 54 | * The hardware revision for the hardware within the device. |
cho45 | 0:be89b5fdea09 | 55 | * @param[in] firmwareRevision |
cho45 | 0:be89b5fdea09 | 56 | * The device's firmware version. |
cho45 | 0:be89b5fdea09 | 57 | * @param[in] softwareRevision |
cho45 | 0:be89b5fdea09 | 58 | * The device's software version. |
cho45 | 0:be89b5fdea09 | 59 | */ |
cho45 |
83:2e940d154f8b | 60 | DeviceInformationService( |
cho45 |
83:2e940d154f8b | 61 | BLE &_ble, |
cho45 |
83:2e940d154f8b | 62 | const char *manufacturersName = NULL, |
cho45 |
83:2e940d154f8b | 63 | const char *modelNumber = NULL, |
cho45 |
83:2e940d154f8b | 64 | const char *serialNumber = NULL, |
cho45 |
83:2e940d154f8b | 65 | const char *hardwareRevision = NULL, |
cho45 |
83:2e940d154f8b | 66 | const char *firmwareRevision = NULL, |
cho45 |
83:2e940d154f8b | 67 | const char *softwareRevision = NULL, |
cho45 |
83:2e940d154f8b | 68 | const PnPID_t *pnpID = NULL |
cho45 |
83:2e940d154f8b | 69 | ) : |
cho45 |
83:2e940d154f8b | 70 | ble(_ble), |
cho45 |
83:2e940d154f8b | 71 | manufacturersNameStringCharacteristic( |
cho45 |
83:2e940d154f8b | 72 | GattCharacteristic::UUID_MANUFACTURER_NAME_STRING_CHAR, |
cho45 |
83:2e940d154f8b | 73 | (uint8_t *)manufacturersName, |
cho45 |
83:2e940d154f8b | 74 | (manufacturersName != NULL) ? strlen(manufacturersName) : 0, /* Min length */ |
cho45 |
83:2e940d154f8b | 75 | (manufacturersName != NULL) ? strlen(manufacturersName) : 0, /* Max length */ |
cho45 |
83:2e940d154f8b | 76 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ |
cho45 |
83:2e940d154f8b | 77 | ), |
cho45 |
83:2e940d154f8b | 78 | modelNumberStringCharacteristic( |
cho45 |
83:2e940d154f8b | 79 | GattCharacteristic::UUID_MODEL_NUMBER_STRING_CHAR, |
cho45 |
83:2e940d154f8b | 80 | (uint8_t *)modelNumber, |
cho45 |
83:2e940d154f8b | 81 | (modelNumber != NULL) ? strlen(modelNumber) : 0, /* Min length */ |
cho45 |
83:2e940d154f8b | 82 | (modelNumber != NULL) ? strlen(modelNumber) : 0, /* Max length */ |
cho45 |
83:2e940d154f8b | 83 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ |
cho45 |
83:2e940d154f8b | 84 | ), |
cho45 |
83:2e940d154f8b | 85 | serialNumberStringCharacteristic( |
cho45 |
83:2e940d154f8b | 86 | GattCharacteristic::UUID_SERIAL_NUMBER_STRING_CHAR, |
cho45 |
83:2e940d154f8b | 87 | (uint8_t *)serialNumber, |
cho45 |
83:2e940d154f8b | 88 | (serialNumber != NULL) ? strlen(serialNumber) : 0, /* Min length */ |
cho45 |
83:2e940d154f8b | 89 | (serialNumber != NULL) ? strlen(serialNumber) : 0, /* Max length */ |
cho45 |
83:2e940d154f8b | 90 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ |
cho45 |
83:2e940d154f8b | 91 | ), |
cho45 |
83:2e940d154f8b | 92 | hardwareRevisionStringCharacteristic( |
cho45 |
83:2e940d154f8b | 93 | GattCharacteristic::UUID_HARDWARE_REVISION_STRING_CHAR, |
cho45 |
83:2e940d154f8b | 94 | (uint8_t *)hardwareRevision, |
cho45 |
83:2e940d154f8b | 95 | (hardwareRevision != NULL) ? strlen(hardwareRevision) : 0, /* Min length */ |
cho45 |
83:2e940d154f8b | 96 | (hardwareRevision != NULL) ? strlen(hardwareRevision) : 0, /* Max length */ |
cho45 |
83:2e940d154f8b | 97 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ |
cho45 |
83:2e940d154f8b | 98 | ), |
cho45 |
83:2e940d154f8b | 99 | firmwareRevisionStringCharacteristic( |
cho45 |
83:2e940d154f8b | 100 | GattCharacteristic::UUID_FIRMWARE_REVISION_STRING_CHAR, |
cho45 |
83:2e940d154f8b | 101 | (uint8_t *)firmwareRevision, |
cho45 |
83:2e940d154f8b | 102 | (firmwareRevision != NULL) ? strlen(firmwareRevision) : 0, /* Min length */ |
cho45 |
83:2e940d154f8b | 103 | (firmwareRevision != NULL) ? strlen(firmwareRevision) : 0, /* Max length */ |
cho45 |
83:2e940d154f8b | 104 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ |
cho45 |
83:2e940d154f8b | 105 | ), |
cho45 |
83:2e940d154f8b | 106 | softwareRevisionStringCharacteristic( |
cho45 |
83:2e940d154f8b | 107 | GattCharacteristic::UUID_SOFTWARE_REVISION_STRING_CHAR, |
cho45 |
83:2e940d154f8b | 108 | (uint8_t *)softwareRevision, |
cho45 |
83:2e940d154f8b | 109 | (softwareRevision != NULL) ? strlen(softwareRevision) : 0, /* Min length */ |
cho45 |
83:2e940d154f8b | 110 | (softwareRevision != NULL) ? strlen(softwareRevision) : 0, /* Max length */ |
cho45 |
83:2e940d154f8b | 111 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ |
cho45 |
83:2e940d154f8b | 112 | ), |
cho45 |
83:2e940d154f8b | 113 | pnpIDCharacteristic( |
cho45 |
83:2e940d154f8b | 114 | GattCharacteristic::UUID_PNP_ID_CHAR, |
cho45 |
83:2e940d154f8b | 115 | const_cast<PnPID_t*>(pnpID) |
cho45 |
83:2e940d154f8b | 116 | ) |
cho45 |
83:2e940d154f8b | 117 | { |
cho45 |
83:2e940d154f8b | 118 | static bool serviceAdded = false; /* We only add the information service once. */ |
cho45 |
83:2e940d154f8b | 119 | if (serviceAdded) { |
cho45 |
83:2e940d154f8b | 120 | return; |
cho45 |
83:2e940d154f8b | 121 | } |
cho45 | 0:be89b5fdea09 | 122 | |
cho45 |
83:2e940d154f8b | 123 | // required for OS X bonding |
cho45 |
83:2e940d154f8b | 124 | pnpIDCharacteristic.requireSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM); |
cho45 | 0:be89b5fdea09 | 125 | |
cho45 |
83:2e940d154f8b | 126 | GattCharacteristic *charTable[] = { |
cho45 |
83:2e940d154f8b | 127 | &manufacturersNameStringCharacteristic, |
cho45 |
83:2e940d154f8b | 128 | &modelNumberStringCharacteristic, |
cho45 |
83:2e940d154f8b | 129 | &serialNumberStringCharacteristic, |
cho45 |
83:2e940d154f8b | 130 | &hardwareRevisionStringCharacteristic, |
cho45 |
83:2e940d154f8b | 131 | &firmwareRevisionStringCharacteristic, |
cho45 |
83:2e940d154f8b | 132 | &softwareRevisionStringCharacteristic, |
cho45 |
83:2e940d154f8b | 133 | &pnpIDCharacteristic}; |
cho45 |
83:2e940d154f8b | 134 | |
cho45 |
83:2e940d154f8b | 135 | GattService deviceInformationService( |
cho45 |
83:2e940d154f8b | 136 | GattService::UUID_DEVICE_INFORMATION_SERVICE, |
cho45 |
83:2e940d154f8b | 137 | charTable, |
cho45 |
83:2e940d154f8b | 138 | sizeof(charTable) / sizeof(GattCharacteristic *) |
cho45 |
83:2e940d154f8b | 139 | ); |
cho45 |
83:2e940d154f8b | 140 | |
cho45 |
83:2e940d154f8b | 141 | ble.addService(deviceInformationService); |
cho45 |
83:2e940d154f8b | 142 | serviceAdded = true; |
cho45 |
83:2e940d154f8b | 143 | } |
cho45 | 0:be89b5fdea09 | 144 | |
cho45 | 0:be89b5fdea09 | 145 | protected: |
cho45 |
83:2e940d154f8b | 146 | /** |
cho45 |
83:2e940d154f8b | 147 | * A reference to the BLE instance object to which the services and |
cho45 |
83:2e940d154f8b | 148 | * characteristics will be added. |
cho45 |
83:2e940d154f8b | 149 | */ |
cho45 |
83:2e940d154f8b | 150 | BLE &ble; |
cho45 |
83:2e940d154f8b | 151 | /** |
cho45 |
83:2e940d154f8b | 152 | * BLE characterising to allow BLE peers access to the manufacturer's name. |
cho45 |
83:2e940d154f8b | 153 | */ |
cho45 |
83:2e940d154f8b | 154 | GattCharacteristic manufacturersNameStringCharacteristic; |
cho45 |
83:2e940d154f8b | 155 | /** |
cho45 |
83:2e940d154f8b | 156 | * BLE characterising to allow BLE peers access to the model number. |
cho45 |
83:2e940d154f8b | 157 | */ |
cho45 |
83:2e940d154f8b | 158 | GattCharacteristic modelNumberStringCharacteristic; |
cho45 |
83:2e940d154f8b | 159 | /** |
cho45 |
83:2e940d154f8b | 160 | * BLE characterising to allow BLE peers access to the serial number. |
cho45 |
83:2e940d154f8b | 161 | */ |
cho45 |
83:2e940d154f8b | 162 | GattCharacteristic serialNumberStringCharacteristic; |
cho45 |
83:2e940d154f8b | 163 | /** |
cho45 |
83:2e940d154f8b | 164 | * BLE characterising to allow BLE peers access to the hardware revision string. |
cho45 |
83:2e940d154f8b | 165 | */ |
cho45 |
83:2e940d154f8b | 166 | GattCharacteristic hardwareRevisionStringCharacteristic; |
cho45 |
83:2e940d154f8b | 167 | /** |
cho45 |
83:2e940d154f8b | 168 | * BLE characterising to allow BLE peers access to the firmware revision string. |
cho45 |
83:2e940d154f8b | 169 | */ |
cho45 |
83:2e940d154f8b | 170 | GattCharacteristic firmwareRevisionStringCharacteristic; |
cho45 |
83:2e940d154f8b | 171 | /** |
cho45 |
83:2e940d154f8b | 172 | * BLE characterising to allow BLE peers access to the software revision string. |
cho45 |
83:2e940d154f8b | 173 | */ |
cho45 |
83:2e940d154f8b | 174 | GattCharacteristic softwareRevisionStringCharacteristic; |
cho45 |
83:2e940d154f8b | 175 | ReadOnlyGattCharacteristic<PnPID_t> pnpIDCharacteristic; |
cho45 | 0:be89b5fdea09 | 176 | }; |
cho45 | 0:be89b5fdea09 | 177 | |
cho45 |
83:2e940d154f8b | 178 | #endif /* #ifndef __BLE_DEVICE_INFORMATION_SERVICE_H__*/ |