Jean-Philippe Brucker
HID-over-GATT implementation with the BLE API. This library allows to create devices such as mouse, keyboard or joystick, over Bluetooth Low Energy.
Dependents: BLENano_HID BLE_HID_MouseScrollDemo BLE_HID_KeyboardStreamDemo Shervs_TestKeyboard_TinyBLE ... more
The development repository is currently hosted on github. It contains examples and documentation. This is a snapshot of the library. The documentation can be read on github, or on docs.mbed.com.
Diff: HIDDeviceInformationService.h
- Revision:
- 3:4f8429a1905b
- Parent:
- 2:3d9adb26bdc5
--- a/HIDDeviceInformationService.h Thu Oct 29 16:48:26 2015 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,143 +0,0 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef __BLE_HID_DEVICE_INFORMATION_SERVICE_H__
-#define __BLE_HID_DEVICE_INFORMATION_SERVICE_H__
-
-#include "ble/BLE.h"
-
-#include "HID_types.h"
-
-/**
-* @class HIDDeviceInformationService
-* @brief BLE Device Information Service <br>
-* Service: https://developer.bluetooth.org/gatt/services/Pages/ServiceViewer.aspx?u=org.bluetooth.service.device_information.xml <br>
-* Manufacturer Name String Char: https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.manufacturer_name_string.xml
-*/
-class HIDDeviceInformationService {
-public:
- /**
- * @brief Device Information Service Constructor.
- *
- * @param[ref] _ble
- * BLE object for the underlying controller.
- * @param[in] manufacturersName
- * This characteristic represents the name of the
- * manufacturer of the device. The name is copied into the
- * BLE stack during this constructor.
- * @param[in] modelNumber
- * This characteristic represents the model number that is
- * assigned by the device vendor. The value is copied into
- * the BLE stack during this constructor.
- * @param[in] serialNumber
- * This characteristic represents the serial number for a
- * particular instance of the device. The value is copied
- * into the BLE stack during this constructor.
- * @param[in] hardwareRevision
- * This characteristic represents the hardware revision for
- * the hardware within the device. The value is copied
- * into the BLE stack during this constructor.
- * @param[in] firmwareRevision
- * This characteristic represents the firmware revision for
- * the firmware within the device. The value is copied
- * into the BLE stack during this constructor.
- * @param[in] softwareRevision
- * This characteristic represents the software revision for
- * the software within the device. The value is copied
- * into the BLE stack during this constructor.
- * @param[in] pnpID
- * This characteristic represents HID-specific information,
- * such as vendor id, product id and version.
- */
- HIDDeviceInformationService(BLE &_ble,
- const char *manufacturersName = NULL,
- const char *modelNumber = NULL,
- const char *serialNumber = NULL,
- const char *hardwareRevision = NULL,
- const char *firmwareRevision = NULL,
- const char *softwareRevision = NULL,
- PnPID_t *PnPID = NULL) :
- ble(_ble),
- manufacturersNameStringCharacteristic(GattCharacteristic::UUID_MANUFACTURER_NAME_STRING_CHAR,
- (uint8_t *)manufacturersName,
- (manufacturersName != NULL) ? strlen(manufacturersName) : 0, /* minLength */
- (manufacturersName != NULL) ? strlen(manufacturersName) : 0, /* maxLength */
- GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
- modelNumberStringCharacteristic(GattCharacteristic::UUID_MODEL_NUMBER_STRING_CHAR,
- (uint8_t *)modelNumber,
- (modelNumber != NULL) ? strlen(modelNumber) : 0, /* minLength */
- (modelNumber != NULL) ? strlen(modelNumber) : 0, /* maxLength */
- GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
- serialNumberStringCharacteristic(GattCharacteristic::UUID_SERIAL_NUMBER_STRING_CHAR,
- (uint8_t *)serialNumber,
- (serialNumber != NULL) ? strlen(serialNumber) : 0, /* minLength */
- (serialNumber != NULL) ? strlen(serialNumber) : 0, /* maxLength */
- GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
- hardwareRevisionStringCharacteristic(GattCharacteristic::UUID_HARDWARE_REVISION_STRING_CHAR,
- (uint8_t *)hardwareRevision,
- (hardwareRevision != NULL) ? strlen(hardwareRevision) : 0, /* minLength */
- (hardwareRevision != NULL) ? strlen(hardwareRevision) : 0, /* maxLength */
- GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
- firmwareRevisionStringCharacteristic(GattCharacteristic::UUID_FIRMWARE_REVISION_STRING_CHAR,
- (uint8_t *)firmwareRevision,
- (firmwareRevision != NULL) ? strlen(firmwareRevision) : 0, /* minLength */
- (firmwareRevision != NULL) ? strlen(firmwareRevision) : 0, /* maxLength */
- GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
- softwareRevisionStringCharacteristic(GattCharacteristic::UUID_SOFTWARE_REVISION_STRING_CHAR,
- (uint8_t *)softwareRevision,
- (softwareRevision != NULL) ? strlen(softwareRevision) : 0, /* minLength */
- (softwareRevision != NULL) ? strlen(softwareRevision) : 0, /* maxLength */
- GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ),
- pnpIDCharacteristic(GattCharacteristic::UUID_PNP_ID_CHAR,
- PnPID)
- {
- static bool serviceAdded = false; /* We should only ever need to add the heart rate service once. */
- if (serviceAdded) {
- return;
- }
-
- GattCharacteristic *charTable[] = {&manufacturersNameStringCharacteristic,
- &modelNumberStringCharacteristic,
- &serialNumberStringCharacteristic,
- &hardwareRevisionStringCharacteristic,
- &firmwareRevisionStringCharacteristic,
- &softwareRevisionStringCharacteristic,
- &pnpIDCharacteristic};
- GattService deviceInformationService(GattService::UUID_DEVICE_INFORMATION_SERVICE, charTable,
- sizeof(charTable) / sizeof(GattCharacteristic *));
-
- /*
- * This is a hack to make things work on MacOSX 10.10. I don't have the details, but MacOSX
- * 10.10 gets confused when only characteristics from HID Service require security...
- */
- pnpIDCharacteristic.requireSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM);
- ble.addService(deviceInformationService);
- serviceAdded = true;
- }
-
-protected:
- BLE &ble;
- GattCharacteristic manufacturersNameStringCharacteristic;
- GattCharacteristic modelNumberStringCharacteristic;
- GattCharacteristic serialNumberStringCharacteristic;
- GattCharacteristic hardwareRevisionStringCharacteristic;
- GattCharacteristic firmwareRevisionStringCharacteristic;
- GattCharacteristic softwareRevisionStringCharacteristic;
- ReadOnlyGattCharacteristic<PnPID_t> pnpIDCharacteristic;
-};
-
-#endif /* #ifndef __BLE_HID_DEVICE_INFORMATION_SERVICE_H__*/
-