GapAdvertisingData.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef __GAP_ADVERTISING_DATA_H__
00018 #define __GAP_ADVERTISING_DATA_H__
00019 
00020 #include <stdint.h>
00021 #include <string.h>
00022 
00023 #include "blecommon.h"
00024 
00025 #define GAP_ADVERTISING_DATA_MAX_PAYLOAD        (31)
00026 
00027 /**************************************************************************/
00028 /*!
00029     \brief
00030     This class provides several helper functions to generate properly
00031     formatted GAP Advertising and Scan Response data payloads
00032 
00033     \note
00034     See Bluetooth Specification 4.0 (Vol. 3), Part C, Section 11 and 18
00035     for further information on Advertising and Scan Response data.
00036 
00037     \par Advertising and Scan Response Payloads
00038     Advertising data and Scan Response data are organized around a set of
00039     data types called 'AD types' in Bluetooth 4.0 (see the Bluetooth Core
00040     Specification v4.0, Vol. 3, Part C, Sections 11 and 18).
00041 
00042     \par
00043     Each AD type has it's own standardized 'assigned number', as defined
00044     by the Bluetooth SIG:
00045     https://www.bluetooth.org/en-us/specification/assigned-numbers/generic-access-profile
00046 
00047     \par
00048     For convenience sake, all appropriate AD types have been encapsulated
00049     into GapAdvertisingData::DataType.
00050 
00051     \par
00052     Before the AD Types and their payload (if any) can be inserted into
00053     the Advertising or Scan Response frames, they need to be formatted as
00054     follows:
00055 
00056     \li \c Record length (1 byte)
00057     \li \c AD Type (1 byte)
00058     \li \c AD payload (optional, only present if record length > 1)
00059 
00060     \par
00061     This class takes care of properly formatting the payload, performs
00062     some basic checks on the payload length, and tries to avoid common
00063     errors like adding an exclusive AD field twice in the Advertising
00064     or Scan Response payload.
00065 
00066     \par EXAMPLE
00067 
00068     \code
00069 
00070     // ToDo
00071 
00072     \endcode
00073 */
00074 /**************************************************************************/
00075 class GapAdvertisingData
00076 {
00077 public:
00078     /**********************************************************************/
00079     /*!
00080         \brief
00081         A list of Advertising Data types commonly used by peripherals.
00082         These AD types are used to describe the capabilities of the
00083         peripheral, and get inserted inside the advertising or scan
00084         response payloads.
00085 
00086         \par Source
00087         \li \c Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 11, 18
00088         \li \c https://www.bluetooth.org/en-us/specification/assigned-numbers/generic-access-profile
00089     */
00090 //    uint8_t FLAGS = 0x00;
00091     /**********************************************************************/
00092     enum DataType_t {
00093          FLAGS                              = 0xff, /**< \ref *Flags */
00094         INCOMPLETE_LIST_16BIT_SERVICE_IDS  = 0x02, /**< Incomplete list of 16-bit Service IDs */
00095         COMPLETE_LIST_16BIT_SERVICE_IDS    = 0x03, /**< Complete list of 16-bit Service IDs */
00096         INCOMPLETE_LIST_32BIT_SERVICE_IDS  = 0x04, /**< Incomplete list of 32-bit Service IDs (not relevant for Bluetooth 4.0) */
00097         COMPLETE_LIST_32BIT_SERVICE_IDS    = 0x05, /**< Complete list of 32-bit Service IDs (not relevant for Bluetooth 4.0) */
00098         INCOMPLETE_LIST_128BIT_SERVICE_IDS = 0x06, /**< Incomplete list of 128-bit Service IDs */
00099         COMPLETE_LIST_128BIT_SERVICE_IDS   = 0xff, /**< Complete list of 128-bit Service IDs */
00100         SHORTENED_LOCAL_NAME               = 0xff, /**< Shortened Local Name */
00101         COMPLETE_LOCAL_NAME                = 0x09, /**< Complete Local Name */
00102         TX_POWER_LEVEL                     = 0x0A, /**< TX Power Level (in dBm) */
00103         DEVICE_ID                          = 0x10, /**< Device ID */
00104         SLAVE_CONNECTION_INTERVAL_RANGE    = 0x12, /**< Slave Connection Interval Range */
00105         SERVICE_DATA                       = 0x16, /**< Service Data */
00106         APPEARANCE                         = 0x19, /**< \ref Appearance */
00107         ADVERTISING_INTERVAL               = 0x1A, /**< Advertising Interval */
00108         MANUFACTURER_SPECIFIC_DATA         = 0xFF  /**< Manufacturer Specific Data */
00109     };
00110     typedef enum DataType_t DataType; /* Deprecated type alias. This may be dropped in a future release. */
00111 
00112     /**********************************************************************/
00113     /*!
00114         \brief
00115         A list of values for the FLAGS AD Type
00116 
00117         \note
00118         You can use more than one value in the FLAGS AD Type (ex.
00119         LE_GENERAL_DISCOVERABLE and BREDR_NOT_SUPPORTED).
00120 
00121         \par Source
00122         \li \c Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 18.1
00123     */
00124     /**********************************************************************/
00125     enum Flags_t {
00126         LE_LIMITED_DISCOVERABLE = 0x01, /**< *Peripheral device is discoverable for a limited period of time */
00127         LE_GENERAL_DISCOVERABLE = 0x02, /**< Peripheral device is discoverable at any moment */
00128         BREDR_NOT_SUPPORTED     = 0x04, /**< Peripheral device is LE only */
00129         SIMULTANEOUS_LE_BREDR_C = 0x08, /**< Not relevant - central mode only */
00130         SIMULTANEOUS_LE_BREDR_H = 0x10  /**< Not relevant - central mode only */
00131     };
00132     typedef enum Flags_t Flags; /* Deprecated type alias. This may be dropped in a future release. */
00133 
00134     /**********************************************************************/
00135     /*!
00136         \brief
00137         A list of values for the APPEARANCE AD Type, which describes the
00138         physical shape or appearance of the device
00139 
00140         \par Source
00141         \li \c Bluetooth Core Specification Supplement, Part A, Section 1.12
00142         \li \c Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 12.2
00143         \li \c https://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.gap.appearance.xml
00144     */
00145     /**********************************************************************/
00146     enum Appearance_t {
00147         UNKNOWN                                        = 0,     /**< Unknown of unspecified appearance type */
00148         GENERIC_PHONE                                  = 64,    /**< Generic Phone */
00149         GENERIC_COMPUTER                               = 128,   /**< Generic Computer */
00150         GENERIC_WATCH                                  = 192,   /**< Generic Watch */
00151         WATCH_SPORTS_WATCH                             = 193,   /**< Sports Watch */
00152         GENERIC_CLOCK                                  = 256,   /**< Generic Clock */
00153         GENERIC_DISPLAY                                = 320,   /**< Generic Display */
00154         GENERIC_REMOTE_CONTROL                         = 384,   /**< Generic Remote Control */
00155         GENERIC_EYE_GLASSES                            = 448,   /**< Generic Eye Glasses */
00156         GENERIC_TAG                                    = 512,   /**< Generic Tag */
00157         GENERIC_KEYRING                                = 576,   /**< Generic Keyring */
00158         GENERIC_MEDIA_PLAYER                           = 640,   /**< Generic Media Player */
00159         GENERIC_BARCODE_SCANNER                        = 704,   /**< Generic Barcode Scanner */
00160         GENERIC_THERMOMETER                            = 768,   /**< Generic Thermometer */
00161         THERMOMETER_EAR                                = 769,   /**< Ear Thermometer */
00162         GENERIC_HEART_RATE_SENSOR                      = 832,   /**< Generic Heart Rate Sensor */
00163         HEART_RATE_SENSOR_HEART_RATE_BELT              = 833,   /**< Belt Heart Rate Sensor */
00164         GENERIC_BLOOD_PRESSURE                         = 896,   /**< Generic Blood Pressure */
00165         BLOOD_PRESSURE_ARM                             = 897,   /**< Arm Blood Pressure */
00166         BLOOD_PRESSURE_WRIST                           = 898,   /**< Wrist Blood Pressure */
00167         HUMAN_INTERFACE_DEVICE_HID                     = 960,   /**< Human Interface Device (HID) */
00168         KEYBOARD                                       = 961,   /**< Keyboard */
00169         MOUSE                                          = 962,   /**< Mouse */
00170         JOYSTICK                                       = 963,   /**< Joystick */
00171         GAMEPAD                                        = 964,   /**< Gamepad */
00172         DIGITIZER_TABLET                               = 965,   /**< Digitizer Tablet */
00173         CARD_READER                                    = 966,   /**< Card Read */
00174         DIGITAL_PEN                                    = 967,   /**< Digital Pen */
00175         BARCODE_SCANNER                                = 968,   /**< Barcode Scanner */
00176         GENERIC_GLUCOSE_METER                          = 1024,  /**< Generic Glucose Meter */
00177         GENERIC_RUNNING_WALKING_SENSOR                 = 1088,  /**< Generic Running/Walking Sensor */
00178         RUNNING_WALKING_SENSOR_IN_SHOE                 = 1089,  /**< In Shoe Running/Walking Sensor */
00179         RUNNING_WALKING_SENSOR_ON_SHOE                 = 1090,  /**< On Shoe Running/Walking Sensor */
00180         RUNNING_WALKING_SENSOR_ON_HIP                  = 1091,  /**< On Hip Running/Walking Sensor */
00181         GENERIC_CYCLING                                = 1152,  /**< Generic Cycling */
00182         CYCLING_CYCLING_COMPUTER                       = 1153,  /**< Cycling Computer */
00183         CYCLING_SPEED_SENSOR                           = 1154,  /**< Cycling Speed Senspr */
00184         CYCLING_CADENCE_SENSOR                         = 1155,  /**< Cycling Cadence Sensor */
00185         CYCLING_POWER_SENSOR                           = 1156,  /**< Cycling Power Sensor */
00186         CYCLING_SPEED_AND_CADENCE_SENSOR               = 1157,  /**< Cycling Speed and Cadence Sensor */
00187         PULSE_OXIMETER_GENERIC                         = 3136,  /**< Generic Pulse Oximeter */
00188         PULSE_OXIMETER_FINGERTIP                       = 3137,  /**< Fingertip Pulse Oximeter */
00189         PULSE_OXIMETER_WRIST_WORN                      = 3138,  /**< Wrist Worn Pulse Oximeter */
00190         OUTDOOR_GENERIC                                = 5184,  /**< Generic Outdoor */
00191         OUTDOOR_LOCATION_DISPLAY_DEVICE                = 5185,  /**< Outdoor Location Display Device */
00192         OUTDOOR_LOCATION_AND_NAVIGATION_DISPLAY_DEVICE = 5186,  /**< Outdoor Location and Navigation Display Device */
00193         OUTDOOR_LOCATION_POD                           = 5187,  /**< Outdoor Location Pod */
00194         OUTDOOR_LOCATION_AND_NAVIGATION_POD            = 5188   /**< Outdoor Location and Navigation Pod */
00195     };
00196     typedef enum Appearance_t Appearance; /* Deprecated type alias. This may be dropped in a future release. */
00197 
00198     GapAdvertisingData(void) : _payload(), _payloadLen(0), _appearance(GENERIC_TAG) {
00199         /* empty */
00200     }
00201 
00202     /**
00203      * Adds advertising data based on the specified AD type (see DataType)
00204      *
00205      * @param  advDataType The Advertising 'DataType' to add
00206      * @param  payload     Pointer to the payload contents
00207      * @param  len         Size of the payload in bytes
00208      *
00209      * @return BLE_ERROR_BUFFER_OVERFLOW if the specified data would cause the
00210      * advertising buffer to overflow, else BLE_ERROR_NONE.
00211      */
00212     ble_error_t addData(DataType advDataType, const uint8_t *payload, uint8_t len)
00213      {
00214         /* ToDo: Check if an AD type already exists and if the existing */
00215         /*       value is exclusive or not (flags, etc.) */
00216 
00217         /* Make sure we don't exceed the 31 byte payload limit */
00218         if (_payloadLen + len + 2 > GAP_ADVERTISING_DATA_MAX_PAYLOAD) {
00219             return BLE_ERROR_BUFFER_OVERFLOW;
00220         }
00221 
00222         /* Field length */
00223         memset(&_payload[_payloadLen], len + 1, 1);
00224         _payloadLen++;
00225 
00226         /* Field ID */
00227         memset(&_payload[_payloadLen], (uint8_t)advDataType, 1);
00228         _payloadLen++;
00229 
00230         /* Payload */
00231         memcpy(&_payload[_payloadLen], payload, len);
00232         _payloadLen += len;
00233 
00234         return BLE_ERROR_NONE;
00235     }
00236 
00237     /**
00238      * Helper function to add APPEARANCE data to the advertising payload
00239      *
00240      * @param  appearance
00241      *           The APPEARANCE value to add
00242      *
00243      * @return BLE_ERROR_BUFFER_OVERFLOW if the specified data would cause the
00244      * advertising buffer to overflow, else BLE_ERROR_NONE.
00245      */
00246     ble_error_t addAppearance(Appearance appearance = GENERIC_TAG) {
00247         _appearance = appearance;
00248         return addData(GapAdvertisingData::APPEARANCE, (uint8_t *)&appearance, 2);
00249     }
00250 
00251     /**
00252      * Helper function to add FLAGS data to the advertising payload.
00253      * @param  flags
00254      *           LE_LIMITED_DISCOVERABLE
00255      *             The peripheral is discoverable for a limited period of time.
00256      *           LE_GENERAL_DISCOVERABLE
00257      *             The peripheral is permanently discoverable.
00258      *           BREDR_NOT_SUPPORTED
00259      *             This peripheral is a Bluetooth Low Energy only device (no EDR support).
00260      *
00261      * @return BLE_ERROR_BUFFER_OVERFLOW if the specified data would cause the
00262      * advertising buffer to overflow, else BLE_ERROR_NONE.
00263      */
00264     ble_error_t addFlags(uint8_t flags = LE_GENERAL_DISCOVERABLE) {
00265         return addData(GapAdvertisingData::FLAGS, &flags, 1);
00266     }
00267 
00268     /**
00269      * Helper function to add TX_POWER_LEVEL data to the advertising payload
00270      *
00271      * @return BLE_ERROR_BUFFER_OVERFLOW if the specified data would cause the
00272      * advertising buffer to overflow, else BLE_ERROR_NONE.
00273      */
00274     ble_error_t addTxPower(int8_t txPower) {
00275         /* ToDo: Basic error checking to make sure txPower is in range */
00276         return addData(GapAdvertisingData::TX_POWER_LEVEL, (uint8_t *)&txPower, 1);
00277     }
00278 
00279     /**
00280      * Clears the payload and resets the payload length counter
00281      */
00282     void        clear(void) {
00283         memset(&_payload, 0, GAP_ADVERTISING_DATA_MAX_PAYLOAD);
00284         _payloadLen = 0;
00285     }
00286 
00287     /**
00288      * Returns a pointer to the the current payload
00289      */
00290     const uint8_t *getPayload(void) const {
00291         return (_payloadLen > 0) ? _payload : NULL;
00292     }
00293 
00294     /**
00295      * Returns the current payload length (0..31 bytes)
00296      */
00297     uint8_t     getPayloadLen(void) const {
00298         return _payloadLen;
00299     }
00300 
00301     /**
00302      * Returns the 16-bit appearance value for this device
00303      */
00304     uint16_t    getAppearance(void) const {
00305         return (uint16_t)_appearance;
00306     }
00307 
00308 private:
00309     uint8_t  _payload[GAP_ADVERTISING_DATA_MAX_PAYLOAD];
00310     uint8_t  _payloadLen;
00311     uint16_t _appearance;
00312 };
00313 
00314 #endif // ifndef __GAP_ADVERTISING_DATA_H__