HIDDeviceInformationService.h

/* 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 "USBHID_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] 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,
                             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),
        pnpIDCharacteristic(GattCharacteristic::UUID_PNP_ID_CHAR,
                            PnPID)
    {
        static bool serviceAdded = false; /* We should only ever need to add the service once. */
        if (serviceAdded) {
            return;
        }

        /*
         * 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...
         */
        manufacturersNameStringCharacteristic.requireSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM);
        modelNumberStringCharacteristic.requireSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM);
        pnpIDCharacteristic.requireSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM);

        GattCharacteristic *charTable[] = {
                                            &manufacturersNameStringCharacteristic,
                                            &modelNumberStringCharacteristic,
                                            &pnpIDCharacteristic};
        GattService         deviceInformationService(GattService::UUID_DEVICE_INFORMATION_SERVICE, charTable,
                                                     sizeof(charTable) / sizeof(GattCharacteristic *));

        ble.addService(deviceInformationService);
        serviceAdded = true;
    }

protected:
    BLE                 &ble;
    GattCharacteristic  manufacturersNameStringCharacteristic;
    GattCharacteristic  modelNumberStringCharacteristic;
    ReadOnlyGattCharacteristic<PnPID_t>  pnpIDCharacteristic;
};

#endif /* #ifndef __BLE_HID_DEVICE_INFORMATION_SERVICE_H__*/