Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of LinkNode-Test by
GattCharacteristic.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 __GATT_CHARACTERISTIC_H__ 00018 #define __GATT_CHARACTERISTIC_H__ 00019 00020 #include "Gap.h" 00021 #include "SecurityManager.h" 00022 #include "GattAttribute.h" 00023 #include "GattCallbackParamTypes.h" 00024 #include "FunctionPointerWithContext.h" 00025 00026 class GattCharacteristic { 00027 public: 00028 enum { 00029 UUID_BATTERY_LEVEL_STATE_CHAR = 0x2A1B, 00030 UUID_BATTERY_POWER_STATE_CHAR = 0x2A1A, 00031 UUID_REMOVABLE_CHAR = 0x2A3A, 00032 UUID_SERVICE_REQUIRED_CHAR = 0x2A3B, 00033 UUID_ALERT_CATEGORY_ID_CHAR = 0x2A43, 00034 UUID_ALERT_CATEGORY_ID_BIT_MASK_CHAR = 0x2A42, 00035 UUID_ALERT_LEVEL_CHAR = 0x2A06, 00036 UUID_ALERT_NOTIFICATION_CONTROL_POINT_CHAR = 0x2A44, 00037 UUID_ALERT_STATUS_CHAR = 0x2A3F, 00038 UUID_BATTERY_LEVEL_CHAR = 0x2A19, 00039 UUID_BLOOD_PRESSURE_FEATURE_CHAR = 0x2A49, 00040 UUID_BLOOD_PRESSURE_MEASUREMENT_CHAR = 0x2A35, 00041 UUID_BODY_SENSOR_LOCATION_CHAR = 0x2A38, 00042 UUID_BOOT_KEYBOARD_INPUT_REPORT_CHAR = 0x2A22, 00043 UUID_BOOT_KEYBOARD_OUTPUT_REPORT_CHAR = 0x2A32, 00044 UUID_BOOT_MOUSE_INPUT_REPORT_CHAR = 0x2A33, 00045 UUID_CURRENT_TIME_CHAR = 0x2A2B, 00046 UUID_DATE_TIME_CHAR = 0x2A08, 00047 UUID_DAY_DATE_TIME_CHAR = 0x2A0A, 00048 UUID_DAY_OF_WEEK_CHAR = 0x2A09, 00049 UUID_DST_OFFSET_CHAR = 0x2A0D, 00050 UUID_EXACT_TIME_256_CHAR = 0x2A0C, 00051 UUID_FIRMWARE_REVISION_STRING_CHAR = 0x2A26, 00052 UUID_GLUCOSE_FEATURE_CHAR = 0x2A51, 00053 UUID_GLUCOSE_MEASUREMENT_CHAR = 0x2A18, 00054 UUID_GLUCOSE_MEASUREMENT_CONTEXT_CHAR = 0x2A34, 00055 UUID_HARDWARE_REVISION_STRING_CHAR = 0x2A27, 00056 UUID_HEART_RATE_CONTROL_POINT_CHAR = 0x2A39, 00057 UUID_HEART_RATE_MEASUREMENT_CHAR = 0x2A37, 00058 UUID_HID_CONTROL_POINT_CHAR = 0x2A4C, 00059 UUID_HID_INFORMATION_CHAR = 0x2A4A, 00060 UUID_HUMIDITY_CHAR = 0x2A6F, 00061 UUID_IEEE_REGULATORY_CERTIFICATION_DATA_LIST_CHAR = 0x2A2A, 00062 UUID_INTERMEDIATE_CUFF_PRESSURE_CHAR = 0x2A36, 00063 UUID_INTERMEDIATE_TEMPERATURE_CHAR = 0x2A1E, 00064 UUID_LOCAL_TIME_INFORMATION_CHAR = 0x2A0F, 00065 UUID_MANUFACTURER_NAME_STRING_CHAR = 0x2A29, 00066 UUID_MEASUREMENT_INTERVAL_CHAR = 0x2A21, 00067 UUID_MODEL_NUMBER_STRING_CHAR = 0x2A24, 00068 UUID_UNREAD_ALERT_CHAR = 0x2A45, 00069 UUID_NEW_ALERT_CHAR = 0x2A46, 00070 UUID_PNP_ID_CHAR = 0x2A50, 00071 UUID_PRESSURE_CHAR = 0x2A6D, 00072 UUID_PROTOCOL_MODE_CHAR = 0x2A4E, 00073 UUID_RECORD_ACCESS_CONTROL_POINT_CHAR = 0x2A52, 00074 UUID_REFERENCE_TIME_INFORMATION_CHAR = 0x2A14, 00075 UUID_REPORT_CHAR = 0x2A4D, 00076 UUID_REPORT_MAP_CHAR = 0x2A4B, 00077 UUID_RINGER_CONTROL_POINT_CHAR = 0x2A40, 00078 UUID_RINGER_SETTING_CHAR = 0x2A41, 00079 UUID_SCAN_INTERVAL_WINDOW_CHAR = 0x2A4F, 00080 UUID_SCAN_REFRESH_CHAR = 0x2A31, 00081 UUID_SERIAL_NUMBER_STRING_CHAR = 0x2A25, 00082 UUID_SOFTWARE_REVISION_STRING_CHAR = 0x2A28, 00083 UUID_SUPPORTED_NEW_ALERT_CATEGORY_CHAR = 0x2A47, 00084 UUID_SUPPORTED_UNREAD_ALERT_CATEGORY_CHAR = 0x2A48, 00085 UUID_SYSTEM_ID_CHAR = 0x2A23, 00086 UUID_TEMPERATURE_CHAR = 0x2A6E, 00087 UUID_TEMPERATURE_MEASUREMENT_CHAR = 0x2A1C, 00088 UUID_TEMPERATURE_TYPE_CHAR = 0x2A1D, 00089 UUID_TIME_ACCURACY_CHAR = 0x2A12, 00090 UUID_TIME_SOURCE_CHAR = 0x2A13, 00091 UUID_TIME_UPDATE_CONTROL_POINT_CHAR = 0x2A16, 00092 UUID_TIME_UPDATE_STATE_CHAR = 0x2A17, 00093 UUID_TIME_WITH_DST_CHAR = 0x2A11, 00094 UUID_TIME_ZONE_CHAR = 0x2A0E, 00095 UUID_TX_POWER_LEVEL_CHAR = 0x2A07, 00096 UUID_CSC_FEATURE_CHAR = 0x2A5C, 00097 UUID_CSC_MEASUREMENT_CHAR = 0x2A5B, 00098 UUID_RSC_FEATURE_CHAR = 0x2A54, 00099 UUID_RSC_MEASUREMENT_CHAR = 0x2A53 00100 }; 00101 00102 /**************************************************************************/ 00103 /*! 00104 \brief Standard GATT characteristic presentation format unit types. 00105 These unit types are used to describe what the raw numeric 00106 data in a characteristic actually represents. 00107 00108 \note See https://developer.bluetooth.org/gatt/units/Pages/default.aspx 00109 */ 00110 /**************************************************************************/ 00111 enum { 00112 BLE_GATT_UNIT_NONE = 0x2700, /**< No specified unit type. */ 00113 BLE_GATT_UNIT_LENGTH_METRE = 0x2701, /**< Length, metre. */ 00114 BLE_GATT_UNIT_MASS_KILOGRAM = 0x2702, /**< Mass, kilogram. */ 00115 BLE_GATT_UNIT_TIME_SECOND = 0x2703, /**< Time, second. */ 00116 BLE_GATT_UNIT_ELECTRIC_CURRENT_AMPERE = 0x2704, /**< Electric current, ampere. */ 00117 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_KELVIN = 0x2705, /**< Thermodynamic temperature, kelvin. */ 00118 BLE_GATT_UNIT_AMOUNT_OF_SUBSTANCE_MOLE = 0x2706, /**< Amount of substance, mole. */ 00119 BLE_GATT_UNIT_LUMINOUS_INTENSITY_CANDELA = 0x2707, /**< Luminous intensity, candela. */ 00120 BLE_GATT_UNIT_AREA_SQUARE_METRES = 0x2710, /**< Area, square metres. */ 00121 BLE_GATT_UNIT_VOLUME_CUBIC_METRES = 0x2711, /**< Volume, cubic metres. */ 00122 BLE_GATT_UNIT_VELOCITY_METRES_PER_SECOND = 0x2712, /**< Velocity, metres per second. */ 00123 BLE_GATT_UNIT_ACCELERATION_METRES_PER_SECOND_SQUARED = 0x2713, /**< Acceleration, metres per second squared. */ 00124 BLE_GATT_UNIT_WAVENUMBER_RECIPROCAL_METRE = 0x2714, /**< Wave number reciprocal, metre. */ 00125 BLE_GATT_UNIT_DENSITY_KILOGRAM_PER_CUBIC_METRE = 0x2715, /**< Density, kilogram per cubic metre. */ 00126 BLE_GATT_UNIT_SURFACE_DENSITY_KILOGRAM_PER_SQUARE_METRE = 0x2716, /**< */ 00127 BLE_GATT_UNIT_SPECIFIC_VOLUME_CUBIC_METRE_PER_KILOGRAM = 0x2717, /**< */ 00128 BLE_GATT_UNIT_CURRENT_DENSITY_AMPERE_PER_SQUARE_METRE = 0x2718, /**< */ 00129 BLE_GATT_UNIT_MAGNETIC_FIELD_STRENGTH_AMPERE_PER_METRE = 0x2719, /**< Magnetic field strength, ampere per metre. */ 00130 BLE_GATT_UNIT_AMOUNT_CONCENTRATION_MOLE_PER_CUBIC_METRE = 0x271A, /**< */ 00131 BLE_GATT_UNIT_MASS_CONCENTRATION_KILOGRAM_PER_CUBIC_METRE = 0x271B, /**< */ 00132 BLE_GATT_UNIT_LUMINANCE_CANDELA_PER_SQUARE_METRE = 0x271C, /**< */ 00133 BLE_GATT_UNIT_REFRACTIVE_INDEX = 0x271D, /**< */ 00134 BLE_GATT_UNIT_RELATIVE_PERMEABILITY = 0x271E, /**< */ 00135 BLE_GATT_UNIT_PLANE_ANGLE_RADIAN = 0x2720, /**< */ 00136 BLE_GATT_UNIT_SOLID_ANGLE_STERADIAN = 0x2721, /**< */ 00137 BLE_GATT_UNIT_FREQUENCY_HERTZ = 0x2722, /**< Frequency, hertz. */ 00138 BLE_GATT_UNIT_FORCE_NEWTON = 0x2723, /**< Force, newton. */ 00139 BLE_GATT_UNIT_PRESSURE_PASCAL = 0x2724, /**< Pressure, pascal. */ 00140 BLE_GATT_UNIT_ENERGY_JOULE = 0x2725, /**< Energy, joule. */ 00141 BLE_GATT_UNIT_POWER_WATT = 0x2726, /**< Power, watt. */ 00142 BLE_GATT_UNIT_ELECTRIC_CHARGE_COULOMB = 0x2727, /**< Electrical charge, coulomb. */ 00143 BLE_GATT_UNIT_ELECTRIC_POTENTIAL_DIFFERENCE_VOLT = 0x2728, /**< Electrical potential difference, voltage. */ 00144 BLE_GATT_UNIT_CAPACITANCE_FARAD = 0x2729, /**< */ 00145 BLE_GATT_UNIT_ELECTRIC_RESISTANCE_OHM = 0x272A, /**< */ 00146 BLE_GATT_UNIT_ELECTRIC_CONDUCTANCE_SIEMENS = 0x272B, /**< */ 00147 BLE_GATT_UNIT_MAGNETIC_FLEX_WEBER = 0x272C, /**< */ 00148 BLE_GATT_UNIT_MAGNETIC_FLEX_DENSITY_TESLA = 0x272D, /**< */ 00149 BLE_GATT_UNIT_INDUCTANCE_HENRY = 0x272E, /**< */ 00150 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_CELSIUS = 0x272F, /**< */ 00151 BLE_GATT_UNIT_LUMINOUS_FLUX_LUMEN = 0x2730, /**< */ 00152 BLE_GATT_UNIT_ILLUMINANCE_LUX = 0x2731, /**< */ 00153 BLE_GATT_UNIT_ACTIVITY_REFERRED_TO_A_RADIONUCLIDE_BECQUEREL = 0x2732, /**< */ 00154 BLE_GATT_UNIT_ABSORBED_DOSE_GRAY = 0x2733, /**< */ 00155 BLE_GATT_UNIT_DOSE_EQUIVALENT_SIEVERT = 0x2734, /**< */ 00156 BLE_GATT_UNIT_CATALYTIC_ACTIVITY_KATAL = 0x2735, /**< */ 00157 BLE_GATT_UNIT_DYNAMIC_VISCOSITY_PASCAL_SECOND = 0x2740, /**< */ 00158 BLE_GATT_UNIT_MOMENT_OF_FORCE_NEWTON_METRE = 0x2741, /**< */ 00159 BLE_GATT_UNIT_SURFACE_TENSION_NEWTON_PER_METRE = 0x2742, /**< */ 00160 BLE_GATT_UNIT_ANGULAR_VELOCITY_RADIAN_PER_SECOND = 0x2743, /**< */ 00161 BLE_GATT_UNIT_ANGULAR_ACCELERATION_RADIAN_PER_SECOND_SQUARED = 0x2744, /**< */ 00162 BLE_GATT_UNIT_HEAT_FLUX_DENSITY_WATT_PER_SQUARE_METRE = 0x2745, /**< */ 00163 BLE_GATT_UNIT_HEAT_CAPACITY_JOULE_PER_KELVIN = 0x2746, /**< */ 00164 BLE_GATT_UNIT_SPECIFIC_HEAT_CAPACITY_JOULE_PER_KILOGRAM_KELVIN = 0x2747, /**< */ 00165 BLE_GATT_UNIT_SPECIFIC_ENERGY_JOULE_PER_KILOGRAM = 0x2748, /**< */ 00166 BLE_GATT_UNIT_THERMAL_CONDUCTIVITY_WATT_PER_METRE_KELVIN = 0x2749, /**< */ 00167 BLE_GATT_UNIT_ENERGY_DENSITY_JOULE_PER_CUBIC_METRE = 0x274A, /**< */ 00168 BLE_GATT_UNIT_ELECTRIC_FIELD_STRENGTH_VOLT_PER_METRE = 0x274B, /**< */ 00169 BLE_GATT_UNIT_ELECTRIC_CHARGE_DENSITY_COULOMB_PER_CUBIC_METRE = 0x274C, /**< */ 00170 BLE_GATT_UNIT_SURFACE_CHARGE_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274D, /**< */ 00171 BLE_GATT_UNIT_ELECTRIC_FLUX_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274E, /**< */ 00172 BLE_GATT_UNIT_PERMITTIVITY_FARAD_PER_METRE = 0x274F, /**< */ 00173 BLE_GATT_UNIT_PERMEABILITY_HENRY_PER_METRE = 0x2750, /**< */ 00174 BLE_GATT_UNIT_MOLAR_ENERGY_JOULE_PER_MOLE = 0x2751, /**< */ 00175 BLE_GATT_UNIT_MOLAR_ENTROPY_JOULE_PER_MOLE_KELVIN = 0x2752, /**< */ 00176 BLE_GATT_UNIT_EXPOSURE_COULOMB_PER_KILOGRAM = 0x2753, /**< */ 00177 BLE_GATT_UNIT_ABSORBED_DOSE_RATE_GRAY_PER_SECOND = 0x2754, /**< */ 00178 BLE_GATT_UNIT_RADIANT_INTENSITY_WATT_PER_STERADIAN = 0x2755, /**< */ 00179 BLE_GATT_UNIT_RADIANCE_WATT_PER_SQUARE_METRE_STERADIAN = 0x2756, /**< */ 00180 BLE_GATT_UNIT_CATALYTIC_ACTIVITY_CONCENTRATION_KATAL_PER_CUBIC_METRE = 0x2757, /**< */ 00181 BLE_GATT_UNIT_TIME_MINUTE = 0x2760, /**< Time, minute. */ 00182 BLE_GATT_UNIT_TIME_HOUR = 0x2761, /**< Time, hour. */ 00183 BLE_GATT_UNIT_TIME_DAY = 0x2762, /**< Time, day. */ 00184 BLE_GATT_UNIT_PLANE_ANGLE_DEGREE = 0x2763, /**< */ 00185 BLE_GATT_UNIT_PLANE_ANGLE_MINUTE = 0x2764, /**< */ 00186 BLE_GATT_UNIT_PLANE_ANGLE_SECOND = 0x2765, /**< */ 00187 BLE_GATT_UNIT_AREA_HECTARE = 0x2766, /**< */ 00188 BLE_GATT_UNIT_VOLUME_LITRE = 0x2767, /**< */ 00189 BLE_GATT_UNIT_MASS_TONNE = 0x2768, /**< */ 00190 BLE_GATT_UNIT_PRESSURE_BAR = 0x2780, /**< Pressure, bar. */ 00191 BLE_GATT_UNIT_PRESSURE_MILLIMETRE_OF_MERCURY = 0x2781, /**< Pressure, millimetre of mercury. */ 00192 BLE_GATT_UNIT_LENGTH_ANGSTROM = 0x2782, /**< */ 00193 BLE_GATT_UNIT_LENGTH_NAUTICAL_MILE = 0x2783, /**< */ 00194 BLE_GATT_UNIT_AREA_BARN = 0x2784, /**< */ 00195 BLE_GATT_UNIT_VELOCITY_KNOT = 0x2785, /**< */ 00196 BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_NEPER = 0x2786, /**< */ 00197 BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_BEL = 0x2787, /**< */ 00198 BLE_GATT_UNIT_LENGTH_YARD = 0x27A0, /**< Length, yard. */ 00199 BLE_GATT_UNIT_LENGTH_PARSEC = 0x27A1, /**< Length, parsec. */ 00200 BLE_GATT_UNIT_LENGTH_INCH = 0x27A2, /**< Length, inch. */ 00201 BLE_GATT_UNIT_LENGTH_FOOT = 0x27A3, /**< Length, foot. */ 00202 BLE_GATT_UNIT_LENGTH_MILE = 0x27A4, /**< Length, mile. */ 00203 BLE_GATT_UNIT_PRESSURE_POUND_FORCE_PER_SQUARE_INCH = 0x27A5, /**< */ 00204 BLE_GATT_UNIT_VELOCITY_KILOMETRE_PER_HOUR = 0x27A6, /**< Velocity, kilometre per hour. */ 00205 BLE_GATT_UNIT_VELOCITY_MILE_PER_HOUR = 0x27A7, /**< Velocity, mile per hour. */ 00206 BLE_GATT_UNIT_ANGULAR_VELOCITY_REVOLUTION_PER_MINUTE = 0x27A8, /**< Angular Velocity, revolution per minute. */ 00207 BLE_GATT_UNIT_ENERGY_GRAM_CALORIE = 0x27A9, /**< Energy, gram calorie. */ 00208 BLE_GATT_UNIT_ENERGY_KILOGRAM_CALORIE = 0x27AA, /**< Energy, kilogram calorie. */ 00209 BLE_GATT_UNIT_ENERGY_KILOWATT_HOUR = 0x27AB, /**< Energy, killowatt hour. */ 00210 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_FAHRENHEIT = 0x27AC, /**< */ 00211 BLE_GATT_UNIT_PERCENTAGE = 0x27AD, /**< Percentage. */ 00212 BLE_GATT_UNIT_PER_MILLE = 0x27AE, /**< */ 00213 BLE_GATT_UNIT_PERIOD_BEATS_PER_MINUTE = 0x27AF, /**< */ 00214 BLE_GATT_UNIT_ELECTRIC_CHARGE_AMPERE_HOURS = 0x27B0, /**< */ 00215 BLE_GATT_UNIT_MASS_DENSITY_MILLIGRAM_PER_DECILITRE = 0x27B1, /**< */ 00216 BLE_GATT_UNIT_MASS_DENSITY_MILLIMOLE_PER_LITRE = 0x27B2, /**< */ 00217 BLE_GATT_UNIT_TIME_YEAR = 0x27B3, /**< Time, year. */ 00218 BLE_GATT_UNIT_TIME_MONTH = 0x27B4, /**< Time, month. */ 00219 BLE_GATT_UNIT_CONCENTRATION_COUNT_PER_CUBIC_METRE = 0x27B5, /**< */ 00220 BLE_GATT_UNIT_IRRADIANCE_WATT_PER_SQUARE_METRE = 0x27B6 /**< */ 00221 }; 00222 00223 /**************************************************************************/ 00224 /*! 00225 \brief Standard GATT number types. 00226 00227 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.2 00228 \note See http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml 00229 */ 00230 /**************************************************************************/ 00231 enum { 00232 BLE_GATT_FORMAT_RFU = 0x00, /**< Reserved for future use. */ 00233 BLE_GATT_FORMAT_BOOLEAN = 0x01, /**< Boolean. */ 00234 BLE_GATT_FORMAT_2BIT = 0x02, /**< Unsigned 2-bit integer. */ 00235 BLE_GATT_FORMAT_NIBBLE = 0x03, /**< Unsigned 4-bit integer. */ 00236 BLE_GATT_FORMAT_UINT8 = 0x04, /**< Unsigned 8-bit integer. */ 00237 BLE_GATT_FORMAT_UINT12 = 0x05, /**< Unsigned 12-bit integer. */ 00238 BLE_GATT_FORMAT_UINT16 = 0x06, /**< Unsigned 16-bit integer. */ 00239 BLE_GATT_FORMAT_UINT24 = 0x07, /**< Unsigned 24-bit integer. */ 00240 BLE_GATT_FORMAT_UINT32 = 0x08, /**< Unsigned 32-bit integer. */ 00241 BLE_GATT_FORMAT_UINT48 = 0x09, /**< Unsigned 48-bit integer. */ 00242 BLE_GATT_FORMAT_UINT64 = 0x0A, /**< Unsigned 64-bit integer. */ 00243 BLE_GATT_FORMAT_UINT128 = 0x0B, /**< Unsigned 128-bit integer. */ 00244 BLE_GATT_FORMAT_SINT8 = 0x0C, /**< Signed 2-bit integer. */ 00245 BLE_GATT_FORMAT_SINT12 = 0x0D, /**< Signed 12-bit integer. */ 00246 BLE_GATT_FORMAT_SINT16 = 0x0E, /**< Signed 16-bit integer. */ 00247 BLE_GATT_FORMAT_SINT24 = 0x0F, /**< Signed 24-bit integer. */ 00248 BLE_GATT_FORMAT_SINT32 = 0x10, /**< Signed 32-bit integer. */ 00249 BLE_GATT_FORMAT_SINT48 = 0x11, /**< Signed 48-bit integer. */ 00250 BLE_GATT_FORMAT_SINT64 = 0x12, /**< Signed 64-bit integer. */ 00251 BLE_GATT_FORMAT_SINT128 = 0x13, /**< Signed 128-bit integer. */ 00252 BLE_GATT_FORMAT_FLOAT32 = 0x14, /**< IEEE-754 32-bit floating point. */ 00253 BLE_GATT_FORMAT_FLOAT64 = 0x15, /**< IEEE-754 64-bit floating point. */ 00254 BLE_GATT_FORMAT_SFLOAT = 0x16, /**< IEEE-11073 16-bit SFLOAT. */ 00255 BLE_GATT_FORMAT_FLOAT = 0x17, /**< IEEE-11073 32-bit FLOAT. */ 00256 BLE_GATT_FORMAT_DUINT16 = 0x18, /**< IEEE-20601 format. */ 00257 BLE_GATT_FORMAT_UTF8S = 0x19, /**< UTF-8 string. */ 00258 BLE_GATT_FORMAT_UTF16S = 0x1A, /**< UTF-16 string. */ 00259 BLE_GATT_FORMAT_STRUCT = 0x1B /**< Opaque Structure. */ 00260 }; 00261 00262 /**************************************************************************/ 00263 /*! 00264 \brief Standard GATT characteristic properties. 00265 00266 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.1.1 00267 and Section 3.3.3.1 for Extended Properties 00268 */ 00269 /**************************************************************************/ 00270 enum Properties_t { 00271 BLE_GATT_CHAR_PROPERTIES_NONE = 0x00, 00272 BLE_GATT_CHAR_PROPERTIES_BROADCAST = 0x01, /**< Permits broadcasts of the characteristic value using the Server Characteristic Configuration descriptor. */ 00273 BLE_GATT_CHAR_PROPERTIES_READ = 0x02, /**< Permits reads of the characteristic value. */ 00274 BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE = 0x04, /**< Permits writes of the characteristic value without response. */ 00275 BLE_GATT_CHAR_PROPERTIES_WRITE = 0x08, /**< Permits writes of the characteristic value with response. */ 00276 BLE_GATT_CHAR_PROPERTIES_NOTIFY = 0x10, /**< Permits notifications of a characteristic value without acknowledgment. */ 00277 BLE_GATT_CHAR_PROPERTIES_INDICATE = 0x20, /**< Permits indications of a characteristic value with acknowledgment. */ 00278 BLE_GATT_CHAR_PROPERTIES_AUTHENTICATED_SIGNED_WRITES = 0x40, /**< Permits signed writes to the characteristic value. */ 00279 BLE_GATT_CHAR_PROPERTIES_EXTENDED_PROPERTIES = 0x80 /**< Additional characteristic properties are defined in the Characteristic Extended Properties descriptor */ 00280 }; 00281 00282 /**************************************************************************/ 00283 /*! 00284 \brief GATT presentation format wrapper 00285 00286 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5 00287 \note See https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml 00288 */ 00289 /**************************************************************************/ 00290 struct PresentationFormat_t { 00291 uint8_t gatt_format; /**< Format of the value; see @ref ble_gatt_format_t. */ 00292 int8_t exponent; /**< Exponent for integer data types. Example: if Exponent = -3 and the char value is 3892, the actual value is 3.892 */ 00293 uint16_t gatt_unit; /**< UUID from Bluetooth Assigned Numbers; see @ref ble_gatt_unit_t. */ 00294 uint8_t gatt_namespace; /**< Namespace from Bluetooth Assigned Numbers, normally '1'; see @ref BLE_GATT_CPF_NAMESPACES. */ 00295 uint16_t gatt_nsdesc; /**< Namespace description from Bluetooth Assigned Numbers, normally '0'; see @ref BLE_GATT_CPF_NAMESPACES. */ 00296 }; 00297 00298 /** 00299 * @brief Creates a new GattCharacteristic using the specified 16-bit 00300 * UUID, value length, and properties. 00301 * 00302 * @note The UUID value must be unique in the service and is normally >1. 00303 * 00304 * @param[in] uuid 00305 * The UUID to use for this characteristic. 00306 * @param[in] valuePtr 00307 * The memory holding the initial value. The value is copied 00308 * into the stack when the enclosing service is added, and 00309 * is thereafter maintained internally by the stack. 00310 * @param[in] len 00311 * The length in bytes of this characteristic's value. 00312 * @param[in] maxLen 00313 * The max length in bytes of this characteristic's value. 00314 * @param[in] hasVariableLen 00315 * Whether the attribute's value length changes over time. 00316 * @param[in] props 00317 * The 8-bit field containing the characteristic's properties. 00318 * @param[in] descriptors 00319 * A pointer to an array of descriptors to be included within 00320 * this characteristic. The memory for the descriptor array is 00321 * owned by the caller, and should remain valid at least until 00322 * the enclosing service is added to the GATT table. 00323 * @param[in] numDescriptors 00324 * The number of descriptors in the previous array. 00325 * 00326 * @NOTE: If valuePtr == NULL, length == 0, and properties == READ 00327 * for the value attribute of a characteristic, then that particular 00328 * characteristic may be considered optional and dropped while 00329 * instantiating the service with the underlying BLE stack. 00330 */ 00331 GattCharacteristic(const UUID &uuid, 00332 uint8_t *valuePtr = NULL, 00333 uint16_t len = 0, 00334 uint16_t maxLen = 0, 00335 uint8_t props = BLE_GATT_CHAR_PROPERTIES_NONE, 00336 GattAttribute *descriptors[] = NULL, 00337 unsigned numDescriptors = 0, 00338 bool hasVariableLen = true) : 00339 _valueAttribute(uuid, valuePtr, len, maxLen, hasVariableLen), 00340 _properties(props), 00341 _requiredSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK), 00342 _descriptors(descriptors), 00343 _descriptorCount(numDescriptors), 00344 enabledReadAuthorization(false), 00345 enabledWriteAuthorization(false), 00346 readAuthorizationCallback(), 00347 writeAuthorizationCallback() { 00348 /* empty */ 00349 } 00350 00351 public: 00352 /** 00353 * Set up the minimum security (mode and level) requirements for access to the characteristic's value attribute. 00354 * 00355 * @param securityMode Can be one of encryption or signing, with or without protection for man in the middle attacks (MITM). 00356 */ 00357 void requireSecurity(SecurityManager::SecurityMode_t securityMode) { 00358 _requiredSecurity = securityMode; 00359 } 00360 00361 public: 00362 /** 00363 * Authorization. 00364 */ 00365 void setWriteAuthorizationCallback(void (*callback)(GattWriteAuthCallbackParams *)) { 00366 writeAuthorizationCallback.attach(callback); 00367 enabledWriteAuthorization = true; 00368 } 00369 template <typename T> 00370 void setWriteAuthorizationCallback(T *object, void (T::*member)(GattWriteAuthCallbackParams *)) { 00371 writeAuthorizationCallback.attach(object, member); 00372 enabledWriteAuthorization = true; 00373 } 00374 void setReadAuthorizationCallback(void (*callback)(GattReadAuthCallbackParams *)) { 00375 readAuthorizationCallback.attach(callback); 00376 enabledReadAuthorization = true; 00377 } 00378 template <typename T> 00379 void setReadAuthorizationCallback(T *object, void (T::*member)(GattReadAuthCallbackParams *)) { 00380 readAuthorizationCallback.attach(object, member); 00381 enabledReadAuthorization = true; 00382 } 00383 00384 /** 00385 * Helper function meant to be called from the guts of the BLE stack to 00386 * determine the authorization reply for a write request. 00387 * @param params To capture the context of the write-auth request. Also contains an out-parameter for reply. 00388 * @return true if the write is authorized to proceed. 00389 */ 00390 GattAuthCallbackReply_t authorizeWrite(GattWriteAuthCallbackParams *params) { 00391 if (!isWriteAuthorizationEnabled()) { 00392 return AUTH_CALLBACK_REPLY_SUCCESS; 00393 } 00394 00395 params->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS; /* Initialized to no-error by default. */ 00396 writeAuthorizationCallback.call(params); 00397 return params->authorizationReply; 00398 } 00399 00400 /** 00401 * Helper function meant to be called from the guts of the BLE stack to 00402 * determine the authorization reply for a read request. 00403 * @param params To capture the context of the read-auth request. 00404 * 00405 * @NOTE: To authorize or deny the read the params->authorizationReply field 00406 * should be set to true (authorize) or false (deny). 00407 * 00408 * If the read is approved and params->data is unchanged (NULL), 00409 * the current characteristic value will be used. 00410 * 00411 * If the read is approved, a new value can be provided by setting 00412 * the params->data pointer and params->len fields. 00413 * 00414 * @return true if the read is authorized to proceed. 00415 */ 00416 GattAuthCallbackReply_t authorizeRead(GattReadAuthCallbackParams *params) { 00417 if (!isReadAuthorizationEnabled()) { 00418 return AUTH_CALLBACK_REPLY_SUCCESS; 00419 } 00420 00421 params->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS; /* Initialized to no-error by default. */ 00422 readAuthorizationCallback.call(params); 00423 return params->authorizationReply; 00424 } 00425 00426 /* accessors */ 00427 public: 00428 GattAttribute& getValueAttribute() {return _valueAttribute; } 00429 const GattAttribute& getValueAttribute() const {return _valueAttribute; } 00430 GattAttribute::Handle_t getValueHandle(void) const {return getValueAttribute().getHandle();} 00431 uint8_t getProperties(void) const {return _properties; } 00432 SecurityManager::SecurityMode_t getRequiredSecurity() const {return _requiredSecurity; } 00433 uint8_t getDescriptorCount(void) const {return _descriptorCount; } 00434 bool isReadAuthorizationEnabled() const {return enabledReadAuthorization; } 00435 bool isWriteAuthorizationEnabled() const {return enabledWriteAuthorization; } 00436 00437 GattAttribute *getDescriptor(uint8_t index) { 00438 if (index >= _descriptorCount) { 00439 return NULL; 00440 } 00441 00442 return _descriptors[index]; 00443 } 00444 00445 private: 00446 GattAttribute _valueAttribute; 00447 uint8_t _properties; 00448 SecurityManager::SecurityMode_t _requiredSecurity; 00449 GattAttribute **_descriptors; 00450 uint8_t _descriptorCount; 00451 00452 bool enabledReadAuthorization; 00453 bool enabledWriteAuthorization; 00454 FunctionPointerWithContext<GattReadAuthCallbackParams *> readAuthorizationCallback; 00455 FunctionPointerWithContext<GattWriteAuthCallbackParams *> writeAuthorizationCallback; 00456 00457 private: 00458 /* Disallow copy and assignment. */ 00459 GattCharacteristic(const GattCharacteristic &); 00460 GattCharacteristic& operator=(const GattCharacteristic &); 00461 }; 00462 00463 template <typename T> 00464 class ReadOnlyGattCharacteristic : public GattCharacteristic { 00465 public: 00466 ReadOnlyGattCharacteristic<T>(const UUID &uuid, 00467 T *valuePtr, 00468 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE, 00469 GattAttribute *descriptors[] = NULL, 00470 unsigned numDescriptors = 0) : 00471 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T), 00472 BLE_GATT_CHAR_PROPERTIES_READ | additionalProperties, descriptors, numDescriptors, false) { 00473 /* empty */ 00474 } 00475 }; 00476 00477 template <typename T> 00478 class WriteOnlyGattCharacteristic : public GattCharacteristic { 00479 public: 00480 WriteOnlyGattCharacteristic<T>(const UUID &uuid, 00481 T *valuePtr, 00482 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE, 00483 GattAttribute *descriptors[] = NULL, 00484 unsigned numDescriptors = 0) : 00485 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T), 00486 BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) { 00487 /* empty */ 00488 } 00489 }; 00490 00491 template <typename T> 00492 class ReadWriteGattCharacteristic : public GattCharacteristic { 00493 public: 00494 ReadWriteGattCharacteristic<T>(const UUID &uuid, 00495 T *valuePtr, 00496 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE, 00497 GattAttribute *descriptors[] = NULL, 00498 unsigned numDescriptors = 0) : 00499 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T), 00500 BLE_GATT_CHAR_PROPERTIES_READ | BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) { 00501 /* empty */ 00502 } 00503 }; 00504 00505 template <typename T, unsigned NUM_ELEMENTS> 00506 class WriteOnlyArrayGattCharacteristic : public GattCharacteristic { 00507 public: 00508 WriteOnlyArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid, 00509 T valuePtr[NUM_ELEMENTS], 00510 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE, 00511 GattAttribute *descriptors[] = NULL, 00512 unsigned numDescriptors = 0) : 00513 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS, 00514 BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) { 00515 /* empty */ 00516 } 00517 }; 00518 00519 template <typename T, unsigned NUM_ELEMENTS> 00520 class ReadOnlyArrayGattCharacteristic : public GattCharacteristic { 00521 public: 00522 ReadOnlyArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid, 00523 T valuePtr[NUM_ELEMENTS], 00524 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE, 00525 GattAttribute *descriptors[] = NULL, 00526 unsigned numDescriptors = 0) : 00527 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS, 00528 BLE_GATT_CHAR_PROPERTIES_READ | additionalProperties, descriptors, numDescriptors, false) { 00529 /* empty */ 00530 } 00531 }; 00532 00533 template <typename T, unsigned NUM_ELEMENTS> 00534 class ReadWriteArrayGattCharacteristic : public GattCharacteristic { 00535 public: 00536 ReadWriteArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid, 00537 T valuePtr[NUM_ELEMENTS], 00538 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE, 00539 GattAttribute *descriptors[] = NULL, 00540 unsigned numDescriptors = 0) : 00541 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS, 00542 BLE_GATT_CHAR_PROPERTIES_READ | BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) { 00543 /* empty */ 00544 } 00545 }; 00546 00547 #endif // ifndef __GATT_CHARACTERISTIC_H__
Generated on Tue Jul 12 2022 16:00:20 by
