Simon Cooksey
Pinned to some recent date
Diff: features/FEATURE_BLE/ble/GattCharacteristic.h
- Revision:
- 0:fb7af294d5d9
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/features/FEATURE_BLE/ble/GattCharacteristic.h Thu Nov 17 16:43:53 2016 +0000
@@ -0,0 +1,855 @@
+/* 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 __GATT_CHARACTERISTIC_H__
+#define __GATT_CHARACTERISTIC_H__
+
+#include "Gap.h"
+#include "SecurityManager.h"
+#include "GattAttribute.h"
+#include "GattCallbackParamTypes.h"
+#include "FunctionPointerWithContext.h"
+
+class GattCharacteristic {
+public:
+ enum {
+ UUID_BATTERY_LEVEL_STATE_CHAR = 0x2A1B,
+ UUID_BATTERY_POWER_STATE_CHAR = 0x2A1A,
+ UUID_REMOVABLE_CHAR = 0x2A3A,
+ UUID_SERVICE_REQUIRED_CHAR = 0x2A3B,
+ UUID_ALERT_CATEGORY_ID_CHAR = 0x2A43,
+ UUID_ALERT_CATEGORY_ID_BIT_MASK_CHAR = 0x2A42,
+ UUID_ALERT_LEVEL_CHAR = 0x2A06,
+ UUID_ALERT_NOTIFICATION_CONTROL_POINT_CHAR = 0x2A44,
+ UUID_ALERT_STATUS_CHAR = 0x2A3F,
+ UUID_BATTERY_LEVEL_CHAR = 0x2A19,
+ UUID_BLOOD_PRESSURE_FEATURE_CHAR = 0x2A49,
+ UUID_BLOOD_PRESSURE_MEASUREMENT_CHAR = 0x2A35,
+ UUID_BODY_SENSOR_LOCATION_CHAR = 0x2A38,
+ UUID_BOOT_KEYBOARD_INPUT_REPORT_CHAR = 0x2A22,
+ UUID_BOOT_KEYBOARD_OUTPUT_REPORT_CHAR = 0x2A32,
+ UUID_BOOT_MOUSE_INPUT_REPORT_CHAR = 0x2A33,
+ UUID_CURRENT_TIME_CHAR = 0x2A2B,
+ UUID_DATE_TIME_CHAR = 0x2A08,
+ UUID_DAY_DATE_TIME_CHAR = 0x2A0A,
+ UUID_DAY_OF_WEEK_CHAR = 0x2A09,
+ UUID_DST_OFFSET_CHAR = 0x2A0D,
+ UUID_EXACT_TIME_256_CHAR = 0x2A0C,
+ UUID_FIRMWARE_REVISION_STRING_CHAR = 0x2A26,
+ UUID_GLUCOSE_FEATURE_CHAR = 0x2A51,
+ UUID_GLUCOSE_MEASUREMENT_CHAR = 0x2A18,
+ UUID_GLUCOSE_MEASUREMENT_CONTEXT_CHAR = 0x2A34,
+ UUID_HARDWARE_REVISION_STRING_CHAR = 0x2A27,
+ UUID_HEART_RATE_CONTROL_POINT_CHAR = 0x2A39,
+ UUID_HEART_RATE_MEASUREMENT_CHAR = 0x2A37,
+ UUID_HID_CONTROL_POINT_CHAR = 0x2A4C,
+ UUID_HID_INFORMATION_CHAR = 0x2A4A,
+ UUID_HUMIDITY_CHAR = 0x2A6F,
+ UUID_IEEE_REGULATORY_CERTIFICATION_DATA_LIST_CHAR = 0x2A2A,
+ UUID_INTERMEDIATE_CUFF_PRESSURE_CHAR = 0x2A36,
+ UUID_INTERMEDIATE_TEMPERATURE_CHAR = 0x2A1E,
+ UUID_LOCAL_TIME_INFORMATION_CHAR = 0x2A0F,
+ UUID_MANUFACTURER_NAME_STRING_CHAR = 0x2A29,
+ UUID_MEASUREMENT_INTERVAL_CHAR = 0x2A21,
+ UUID_MODEL_NUMBER_STRING_CHAR = 0x2A24,
+ UUID_UNREAD_ALERT_CHAR = 0x2A45,
+ UUID_NEW_ALERT_CHAR = 0x2A46,
+ UUID_PNP_ID_CHAR = 0x2A50,
+ UUID_PRESSURE_CHAR = 0x2A6D,
+ UUID_PROTOCOL_MODE_CHAR = 0x2A4E,
+ UUID_RECORD_ACCESS_CONTROL_POINT_CHAR = 0x2A52,
+ UUID_REFERENCE_TIME_INFORMATION_CHAR = 0x2A14,
+ UUID_REPORT_CHAR = 0x2A4D,
+ UUID_REPORT_MAP_CHAR = 0x2A4B,
+ UUID_RINGER_CONTROL_POINT_CHAR = 0x2A40,
+ UUID_RINGER_SETTING_CHAR = 0x2A41,
+ UUID_SCAN_INTERVAL_WINDOW_CHAR = 0x2A4F,
+ UUID_SCAN_REFRESH_CHAR = 0x2A31,
+ UUID_SERIAL_NUMBER_STRING_CHAR = 0x2A25,
+ UUID_SOFTWARE_REVISION_STRING_CHAR = 0x2A28,
+ UUID_SUPPORTED_NEW_ALERT_CATEGORY_CHAR = 0x2A47,
+ UUID_SUPPORTED_UNREAD_ALERT_CATEGORY_CHAR = 0x2A48,
+ UUID_SYSTEM_ID_CHAR = 0x2A23,
+ UUID_TEMPERATURE_CHAR = 0x2A6E,
+ UUID_TEMPERATURE_MEASUREMENT_CHAR = 0x2A1C,
+ UUID_TEMPERATURE_TYPE_CHAR = 0x2A1D,
+ UUID_TIME_ACCURACY_CHAR = 0x2A12,
+ UUID_TIME_SOURCE_CHAR = 0x2A13,
+ UUID_TIME_UPDATE_CONTROL_POINT_CHAR = 0x2A16,
+ UUID_TIME_UPDATE_STATE_CHAR = 0x2A17,
+ UUID_TIME_WITH_DST_CHAR = 0x2A11,
+ UUID_TIME_ZONE_CHAR = 0x2A0E,
+ UUID_TX_POWER_LEVEL_CHAR = 0x2A07,
+ UUID_CSC_FEATURE_CHAR = 0x2A5C,
+ UUID_CSC_MEASUREMENT_CHAR = 0x2A5B,
+ UUID_RSC_FEATURE_CHAR = 0x2A54,
+ UUID_RSC_MEASUREMENT_CHAR = 0x2A53
+ };
+
+ /**
+ * @brief Standard GATT characteristic presentation format unit types.
+ * These unit types are used to describe what the raw numeric
+ * data in a characteristic actually represents.
+ *
+ * @note See https://developer.bluetooth.org/gatt/units/Pages/default.aspx
+ */
+ enum {
+ BLE_GATT_UNIT_NONE = 0x2700, /**< No specified unit type. */
+ BLE_GATT_UNIT_LENGTH_METRE = 0x2701, /**< Length, metre. */
+ BLE_GATT_UNIT_MASS_KILOGRAM = 0x2702, /**< Mass, kilogram. */
+ BLE_GATT_UNIT_TIME_SECOND = 0x2703, /**< Time, second. */
+ BLE_GATT_UNIT_ELECTRIC_CURRENT_AMPERE = 0x2704, /**< Electric current, ampere. */
+ BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_KELVIN = 0x2705, /**< Thermodynamic temperature, kelvin. */
+ BLE_GATT_UNIT_AMOUNT_OF_SUBSTANCE_MOLE = 0x2706, /**< Amount of substance, mole. */
+ BLE_GATT_UNIT_LUMINOUS_INTENSITY_CANDELA = 0x2707, /**< Luminous intensity, candela. */
+ BLE_GATT_UNIT_AREA_SQUARE_METRES = 0x2710, /**< Area, square metres. */
+ BLE_GATT_UNIT_VOLUME_CUBIC_METRES = 0x2711, /**< Volume, cubic metres. */
+ BLE_GATT_UNIT_VELOCITY_METRES_PER_SECOND = 0x2712, /**< Velocity, metres per second. */
+ BLE_GATT_UNIT_ACCELERATION_METRES_PER_SECOND_SQUARED = 0x2713, /**< Acceleration, metres per second squared. */
+ BLE_GATT_UNIT_WAVENUMBER_RECIPROCAL_METRE = 0x2714, /**< Wave number reciprocal, metre. */
+ BLE_GATT_UNIT_DENSITY_KILOGRAM_PER_CUBIC_METRE = 0x2715, /**< Density, kilogram per cubic metre. */
+ BLE_GATT_UNIT_SURFACE_DENSITY_KILOGRAM_PER_SQUARE_METRE = 0x2716, /**< */
+ BLE_GATT_UNIT_SPECIFIC_VOLUME_CUBIC_METRE_PER_KILOGRAM = 0x2717, /**< */
+ BLE_GATT_UNIT_CURRENT_DENSITY_AMPERE_PER_SQUARE_METRE = 0x2718, /**< */
+ BLE_GATT_UNIT_MAGNETIC_FIELD_STRENGTH_AMPERE_PER_METRE = 0x2719, /**< Magnetic field strength, ampere per metre. */
+ BLE_GATT_UNIT_AMOUNT_CONCENTRATION_MOLE_PER_CUBIC_METRE = 0x271A, /**< */
+ BLE_GATT_UNIT_MASS_CONCENTRATION_KILOGRAM_PER_CUBIC_METRE = 0x271B, /**< */
+ BLE_GATT_UNIT_LUMINANCE_CANDELA_PER_SQUARE_METRE = 0x271C, /**< */
+ BLE_GATT_UNIT_REFRACTIVE_INDEX = 0x271D, /**< */
+ BLE_GATT_UNIT_RELATIVE_PERMEABILITY = 0x271E, /**< */
+ BLE_GATT_UNIT_PLANE_ANGLE_RADIAN = 0x2720, /**< */
+ BLE_GATT_UNIT_SOLID_ANGLE_STERADIAN = 0x2721, /**< */
+ BLE_GATT_UNIT_FREQUENCY_HERTZ = 0x2722, /**< Frequency, hertz. */
+ BLE_GATT_UNIT_FORCE_NEWTON = 0x2723, /**< Force, newton. */
+ BLE_GATT_UNIT_PRESSURE_PASCAL = 0x2724, /**< Pressure, pascal. */
+ BLE_GATT_UNIT_ENERGY_JOULE = 0x2725, /**< Energy, joule. */
+ BLE_GATT_UNIT_POWER_WATT = 0x2726, /**< Power, watt. */
+ BLE_GATT_UNIT_ELECTRIC_CHARGE_COULOMB = 0x2727, /**< Electrical charge, coulomb. */
+ BLE_GATT_UNIT_ELECTRIC_POTENTIAL_DIFFERENCE_VOLT = 0x2728, /**< Electrical potential difference, voltage. */
+ BLE_GATT_UNIT_CAPACITANCE_FARAD = 0x2729, /**< */
+ BLE_GATT_UNIT_ELECTRIC_RESISTANCE_OHM = 0x272A, /**< */
+ BLE_GATT_UNIT_ELECTRIC_CONDUCTANCE_SIEMENS = 0x272B, /**< */
+ BLE_GATT_UNIT_MAGNETIC_FLEX_WEBER = 0x272C, /**< */
+ BLE_GATT_UNIT_MAGNETIC_FLEX_DENSITY_TESLA = 0x272D, /**< */
+ BLE_GATT_UNIT_INDUCTANCE_HENRY = 0x272E, /**< */
+ BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_CELSIUS = 0x272F, /**< */
+ BLE_GATT_UNIT_LUMINOUS_FLUX_LUMEN = 0x2730, /**< */
+ BLE_GATT_UNIT_ILLUMINANCE_LUX = 0x2731, /**< */
+ BLE_GATT_UNIT_ACTIVITY_REFERRED_TO_A_RADIONUCLIDE_BECQUEREL = 0x2732, /**< */
+ BLE_GATT_UNIT_ABSORBED_DOSE_GRAY = 0x2733, /**< */
+ BLE_GATT_UNIT_DOSE_EQUIVALENT_SIEVERT = 0x2734, /**< */
+ BLE_GATT_UNIT_CATALYTIC_ACTIVITY_KATAL = 0x2735, /**< */
+ BLE_GATT_UNIT_DYNAMIC_VISCOSITY_PASCAL_SECOND = 0x2740, /**< */
+ BLE_GATT_UNIT_MOMENT_OF_FORCE_NEWTON_METRE = 0x2741, /**< */
+ BLE_GATT_UNIT_SURFACE_TENSION_NEWTON_PER_METRE = 0x2742, /**< */
+ BLE_GATT_UNIT_ANGULAR_VELOCITY_RADIAN_PER_SECOND = 0x2743, /**< */
+ BLE_GATT_UNIT_ANGULAR_ACCELERATION_RADIAN_PER_SECOND_SQUARED = 0x2744, /**< */
+ BLE_GATT_UNIT_HEAT_FLUX_DENSITY_WATT_PER_SQUARE_METRE = 0x2745, /**< */
+ BLE_GATT_UNIT_HEAT_CAPACITY_JOULE_PER_KELVIN = 0x2746, /**< */
+ BLE_GATT_UNIT_SPECIFIC_HEAT_CAPACITY_JOULE_PER_KILOGRAM_KELVIN = 0x2747, /**< */
+ BLE_GATT_UNIT_SPECIFIC_ENERGY_JOULE_PER_KILOGRAM = 0x2748, /**< */
+ BLE_GATT_UNIT_THERMAL_CONDUCTIVITY_WATT_PER_METRE_KELVIN = 0x2749, /**< */
+ BLE_GATT_UNIT_ENERGY_DENSITY_JOULE_PER_CUBIC_METRE = 0x274A, /**< */
+ BLE_GATT_UNIT_ELECTRIC_FIELD_STRENGTH_VOLT_PER_METRE = 0x274B, /**< */
+ BLE_GATT_UNIT_ELECTRIC_CHARGE_DENSITY_COULOMB_PER_CUBIC_METRE = 0x274C, /**< */
+ BLE_GATT_UNIT_SURFACE_CHARGE_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274D, /**< */
+ BLE_GATT_UNIT_ELECTRIC_FLUX_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274E, /**< */
+ BLE_GATT_UNIT_PERMITTIVITY_FARAD_PER_METRE = 0x274F, /**< */
+ BLE_GATT_UNIT_PERMEABILITY_HENRY_PER_METRE = 0x2750, /**< */
+ BLE_GATT_UNIT_MOLAR_ENERGY_JOULE_PER_MOLE = 0x2751, /**< */
+ BLE_GATT_UNIT_MOLAR_ENTROPY_JOULE_PER_MOLE_KELVIN = 0x2752, /**< */
+ BLE_GATT_UNIT_EXPOSURE_COULOMB_PER_KILOGRAM = 0x2753, /**< */
+ BLE_GATT_UNIT_ABSORBED_DOSE_RATE_GRAY_PER_SECOND = 0x2754, /**< */
+ BLE_GATT_UNIT_RADIANT_INTENSITY_WATT_PER_STERADIAN = 0x2755, /**< */
+ BLE_GATT_UNIT_RADIANCE_WATT_PER_SQUARE_METRE_STERADIAN = 0x2756, /**< */
+ BLE_GATT_UNIT_CATALYTIC_ACTIVITY_CONCENTRATION_KATAL_PER_CUBIC_METRE = 0x2757, /**< */
+ BLE_GATT_UNIT_TIME_MINUTE = 0x2760, /**< Time, minute. */
+ BLE_GATT_UNIT_TIME_HOUR = 0x2761, /**< Time, hour. */
+ BLE_GATT_UNIT_TIME_DAY = 0x2762, /**< Time, day. */
+ BLE_GATT_UNIT_PLANE_ANGLE_DEGREE = 0x2763, /**< */
+ BLE_GATT_UNIT_PLANE_ANGLE_MINUTE = 0x2764, /**< */
+ BLE_GATT_UNIT_PLANE_ANGLE_SECOND = 0x2765, /**< */
+ BLE_GATT_UNIT_AREA_HECTARE = 0x2766, /**< */
+ BLE_GATT_UNIT_VOLUME_LITRE = 0x2767, /**< */
+ BLE_GATT_UNIT_MASS_TONNE = 0x2768, /**< */
+ BLE_GATT_UNIT_PRESSURE_BAR = 0x2780, /**< Pressure, bar. */
+ BLE_GATT_UNIT_PRESSURE_MILLIMETRE_OF_MERCURY = 0x2781, /**< Pressure, millimetre of mercury. */
+ BLE_GATT_UNIT_LENGTH_ANGSTROM = 0x2782, /**< */
+ BLE_GATT_UNIT_LENGTH_NAUTICAL_MILE = 0x2783, /**< */
+ BLE_GATT_UNIT_AREA_BARN = 0x2784, /**< */
+ BLE_GATT_UNIT_VELOCITY_KNOT = 0x2785, /**< */
+ BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_NEPER = 0x2786, /**< */
+ BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_BEL = 0x2787, /**< */
+ BLE_GATT_UNIT_LENGTH_YARD = 0x27A0, /**< Length, yard. */
+ BLE_GATT_UNIT_LENGTH_PARSEC = 0x27A1, /**< Length, parsec. */
+ BLE_GATT_UNIT_LENGTH_INCH = 0x27A2, /**< Length, inch. */
+ BLE_GATT_UNIT_LENGTH_FOOT = 0x27A3, /**< Length, foot. */
+ BLE_GATT_UNIT_LENGTH_MILE = 0x27A4, /**< Length, mile. */
+ BLE_GATT_UNIT_PRESSURE_POUND_FORCE_PER_SQUARE_INCH = 0x27A5, /**< */
+ BLE_GATT_UNIT_VELOCITY_KILOMETRE_PER_HOUR = 0x27A6, /**< Velocity, kilometre per hour. */
+ BLE_GATT_UNIT_VELOCITY_MILE_PER_HOUR = 0x27A7, /**< Velocity, mile per hour. */
+ BLE_GATT_UNIT_ANGULAR_VELOCITY_REVOLUTION_PER_MINUTE = 0x27A8, /**< Angular Velocity, revolution per minute. */
+ BLE_GATT_UNIT_ENERGY_GRAM_CALORIE = 0x27A9, /**< Energy, gram calorie. */
+ BLE_GATT_UNIT_ENERGY_KILOGRAM_CALORIE = 0x27AA, /**< Energy, kilogram calorie. */
+ BLE_GATT_UNIT_ENERGY_KILOWATT_HOUR = 0x27AB, /**< Energy, killowatt hour. */
+ BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_FAHRENHEIT = 0x27AC, /**< */
+ BLE_GATT_UNIT_PERCENTAGE = 0x27AD, /**< Percentage. */
+ BLE_GATT_UNIT_PER_MILLE = 0x27AE, /**< */
+ BLE_GATT_UNIT_PERIOD_BEATS_PER_MINUTE = 0x27AF, /**< */
+ BLE_GATT_UNIT_ELECTRIC_CHARGE_AMPERE_HOURS = 0x27B0, /**< */
+ BLE_GATT_UNIT_MASS_DENSITY_MILLIGRAM_PER_DECILITRE = 0x27B1, /**< */
+ BLE_GATT_UNIT_MASS_DENSITY_MILLIMOLE_PER_LITRE = 0x27B2, /**< */
+ BLE_GATT_UNIT_TIME_YEAR = 0x27B3, /**< Time, year. */
+ BLE_GATT_UNIT_TIME_MONTH = 0x27B4, /**< Time, month. */
+ BLE_GATT_UNIT_CONCENTRATION_COUNT_PER_CUBIC_METRE = 0x27B5, /**< */
+ BLE_GATT_UNIT_IRRADIANCE_WATT_PER_SQUARE_METRE = 0x27B6 /**< */
+ };
+
+ /**
+ * @brief Standard GATT number types.
+ *
+ * @note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.2.
+ *
+ * @note See http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
+ */
+ enum {
+ BLE_GATT_FORMAT_RFU = 0x00, /**< Reserved for future use. */
+ BLE_GATT_FORMAT_BOOLEAN = 0x01, /**< Boolean. */
+ BLE_GATT_FORMAT_2BIT = 0x02, /**< Unsigned 2-bit integer. */
+ BLE_GATT_FORMAT_NIBBLE = 0x03, /**< Unsigned 4-bit integer. */
+ BLE_GATT_FORMAT_UINT8 = 0x04, /**< Unsigned 8-bit integer. */
+ BLE_GATT_FORMAT_UINT12 = 0x05, /**< Unsigned 12-bit integer. */
+ BLE_GATT_FORMAT_UINT16 = 0x06, /**< Unsigned 16-bit integer. */
+ BLE_GATT_FORMAT_UINT24 = 0x07, /**< Unsigned 24-bit integer. */
+ BLE_GATT_FORMAT_UINT32 = 0x08, /**< Unsigned 32-bit integer. */
+ BLE_GATT_FORMAT_UINT48 = 0x09, /**< Unsigned 48-bit integer. */
+ BLE_GATT_FORMAT_UINT64 = 0x0A, /**< Unsigned 64-bit integer. */
+ BLE_GATT_FORMAT_UINT128 = 0x0B, /**< Unsigned 128-bit integer. */
+ BLE_GATT_FORMAT_SINT8 = 0x0C, /**< Signed 2-bit integer. */
+ BLE_GATT_FORMAT_SINT12 = 0x0D, /**< Signed 12-bit integer. */
+ BLE_GATT_FORMAT_SINT16 = 0x0E, /**< Signed 16-bit integer. */
+ BLE_GATT_FORMAT_SINT24 = 0x0F, /**< Signed 24-bit integer. */
+ BLE_GATT_FORMAT_SINT32 = 0x10, /**< Signed 32-bit integer. */
+ BLE_GATT_FORMAT_SINT48 = 0x11, /**< Signed 48-bit integer. */
+ BLE_GATT_FORMAT_SINT64 = 0x12, /**< Signed 64-bit integer. */
+ BLE_GATT_FORMAT_SINT128 = 0x13, /**< Signed 128-bit integer. */
+ BLE_GATT_FORMAT_FLOAT32 = 0x14, /**< IEEE-754 32-bit floating point. */
+ BLE_GATT_FORMAT_FLOAT64 = 0x15, /**< IEEE-754 64-bit floating point. */
+ BLE_GATT_FORMAT_SFLOAT = 0x16, /**< IEEE-11073 16-bit SFLOAT. */
+ BLE_GATT_FORMAT_FLOAT = 0x17, /**< IEEE-11073 32-bit FLOAT. */
+ BLE_GATT_FORMAT_DUINT16 = 0x18, /**< IEEE-20601 format. */
+ BLE_GATT_FORMAT_UTF8S = 0x19, /**< UTF-8 string. */
+ BLE_GATT_FORMAT_UTF16S = 0x1A, /**< UTF-16 string. */
+ BLE_GATT_FORMAT_STRUCT = 0x1B /**< Opaque Structure. */
+ };
+
+ /*!
+ * @brief Standard GATT characteristic properties.
+ *
+ * @note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.1.1
+ * and Section 3.3.3.1 for Extended Properties.
+ */
+ enum Properties_t {
+ BLE_GATT_CHAR_PROPERTIES_NONE = 0x00,
+ BLE_GATT_CHAR_PROPERTIES_BROADCAST = 0x01, /**< Permits broadcasts of the characteristic value using the Server Characteristic Configuration descriptor. */
+ BLE_GATT_CHAR_PROPERTIES_READ = 0x02, /**< Permits reads of the characteristic value. */
+ BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE = 0x04, /**< Permits writes of the characteristic value without response. */
+ BLE_GATT_CHAR_PROPERTIES_WRITE = 0x08, /**< Permits writes of the characteristic value with response. */
+ BLE_GATT_CHAR_PROPERTIES_NOTIFY = 0x10, /**< Permits notifications of a characteristic value without acknowledgment. */
+ BLE_GATT_CHAR_PROPERTIES_INDICATE = 0x20, /**< Permits indications of a characteristic value with acknowledgment. */
+ BLE_GATT_CHAR_PROPERTIES_AUTHENTICATED_SIGNED_WRITES = 0x40, /**< Permits signed writes to the characteristic value. */
+ BLE_GATT_CHAR_PROPERTIES_EXTENDED_PROPERTIES = 0x80 /**< Additional characteristic properties are defined in the Characteristic Extended Properties descriptor */
+ };
+
+ /**
+ * @brief GATT presentation format wrapper.
+ *
+ * @note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.
+ *
+ * @note See https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
+ */
+ struct PresentationFormat_t {
+ uint8_t gatt_format; /**< Format of the value. */
+ int8_t exponent; /**< Exponent for integer data types. Example: if Exponent = -3 and the char value is 3892, the actual value is 3.892 */
+ uint16_t gatt_unit; /**< UUID from Bluetooth Assigned Numbers. */
+ uint8_t gatt_namespace; /**< Namespace from Bluetooth Assigned Numbers, normally '1'. */
+ uint16_t gatt_nsdesc; /**< Namespace description from Bluetooth Assigned Numbers, normally '0'. */
+ };
+
+ /**
+ * @brief Creates a new GattCharacteristic using the specified 16-bit
+ * UUID, value length, and properties.
+ *
+ * @param[in] uuid
+ * The UUID to use for this characteristic.
+ * @param[in] valuePtr
+ * The memory holding the initial value. The value is copied
+ * into the stack when the enclosing service is added, and
+ * is thereafter maintained internally by the stack.
+ * @param[in] len
+ * The length in bytes of this characteristic's value.
+ * @param[in] maxLen
+ * The max length in bytes of this characteristic's value.
+ * @param[in] props
+ * The 8-bit field containing the characteristic's properties.
+ * @param[in] descriptors
+ * A pointer to an array of descriptors to be included within
+ * this characteristic. The memory for the descriptor array is
+ * owned by the caller, and should remain valid at least until
+ * the enclosing service is added to the GATT table.
+ * @param[in] numDescriptors
+ * The number of descriptors in the previous array.
+ * @param[in] hasVariableLen
+ * Whether the attribute's value length changes over time.
+ *
+ * @note The UUID value must be unique in the service and is normally >1.
+ *
+ * @note If valuePtr == NULL, length == 0, and properties == READ
+ * for the value attribute of a characteristic, then that particular
+ * characteristic may be considered optional and dropped while
+ * instantiating the service with the underlying BLE stack.
+ */
+ GattCharacteristic(const UUID &uuid,
+ uint8_t *valuePtr = NULL,
+ uint16_t len = 0,
+ uint16_t maxLen = 0,
+ uint8_t props = BLE_GATT_CHAR_PROPERTIES_NONE,
+ GattAttribute *descriptors[] = NULL,
+ unsigned numDescriptors = 0,
+ bool hasVariableLen = true) :
+ _valueAttribute(uuid, valuePtr, len, maxLen, hasVariableLen),
+ _properties(props),
+ _requiredSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK),
+ _descriptors(descriptors),
+ _descriptorCount(numDescriptors),
+ enabledReadAuthorization(false),
+ enabledWriteAuthorization(false),
+ readAuthorizationCallback(),
+ writeAuthorizationCallback() {
+ /* empty */
+ }
+
+public:
+ /**
+ * Set up the minimum security (mode and level) requirements for access to
+ * the characteristic's value attribute.
+ *
+ * @param[in] securityMode
+ * Can be one of encryption or signing, with or without
+ * protection for man in the middle attacks (MITM).
+ */
+ void requireSecurity(SecurityManager::SecurityMode_t securityMode) {
+ _requiredSecurity = securityMode;
+ }
+
+public:
+ /**
+ * Set up callback that will be triggered before the GATT Client is allowed
+ * to write this characteristic. The handler will determine the
+ * authorization reply for the write.
+ *
+ * @param[in] callback
+ * Event handler being registered.
+ */
+ void setWriteAuthorizationCallback(void (*callback)(GattWriteAuthCallbackParams *)) {
+ writeAuthorizationCallback.attach(callback);
+ enabledWriteAuthorization = true;
+ }
+
+ /**
+ * Same as GattCharacrteristic::setWriteAuthorizationCallback(), but allows
+ * the possibility to add an object reference and member function as
+ * handler for connection event callbacks.
+ *
+ * @param[in] object
+ * Pointer to the object of a class defining the member callback
+ * function (@p member).
+ * @param[in] member
+ * The member callback (within the context of an object) to be
+ * invoked.
+ */
+ template <typename T>
+ void setWriteAuthorizationCallback(T *object, void (T::*member)(GattWriteAuthCallbackParams *)) {
+ writeAuthorizationCallback.attach(object, member);
+ enabledWriteAuthorization = true;
+ }
+
+ /**
+ * Set up callback that will be triggered before the GATT Client is allowed
+ * to read this characteristic. The handler will determine the
+ * authorizaion reply for the read.
+ *
+ * @param[in] callback
+ * Event handler being registered.
+ */
+ void setReadAuthorizationCallback(void (*callback)(GattReadAuthCallbackParams *)) {
+ readAuthorizationCallback.attach(callback);
+ enabledReadAuthorization = true;
+ }
+
+ /**
+ * Same as GattCharacrteristic::setReadAuthorizationCallback(), but allows
+ * the possibility to add an object reference and member function as
+ * handler for connection event callbacks.
+ *
+ * @param[in] object
+ * Pointer to the object of a class defining the member callback
+ * function (@p member).
+ * @param[in] member
+ * The member callback (within the context of an object) to be
+ * invoked.
+ */
+ template <typename T>
+ void setReadAuthorizationCallback(T *object, void (T::*member)(GattReadAuthCallbackParams *)) {
+ readAuthorizationCallback.attach(object, member);
+ enabledReadAuthorization = true;
+ }
+
+ /**
+ * Helper that calls the registered handler to determine the authorization
+ * reply for a write request. This function is meant to be called from the
+ * BLE stack specific implementation.
+ *
+ * @param[in] params
+ * To capture the context of the write-auth request. Also
+ * contains an out-parameter for reply.
+ *
+ * @return A GattAuthCallbackReply_t value indicating whether authorization
+ * is granted.
+ */
+ GattAuthCallbackReply_t authorizeWrite(GattWriteAuthCallbackParams *params) {
+ if (!isWriteAuthorizationEnabled()) {
+ return AUTH_CALLBACK_REPLY_SUCCESS;
+ }
+
+ params->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS; /* Initialized to no-error by default. */
+ writeAuthorizationCallback.call(params);
+ return params->authorizationReply;
+ }
+
+ /**
+ * Helper that calls the registered handler to determine the authorization
+ * reply for a read request. This function is meant to be called from the
+ * BLE stack specific implementation.
+ *
+ * @param[in] params
+ * To capture the context of the read-auth request.
+ *
+ * @return A GattAuthCallbackReply_t value indicating whether authorization
+ * is granted.
+ *
+ * @note To authorize or deny the read the params->authorizationReply field
+ * should be set to true (authorize) or false (deny).
+ *
+ * @note If the read is approved and params->data is unchanged (NULL),
+ * the current characteristic value will be used.
+ *
+ * @note If the read is approved, a new value can be provided by setting
+ * the params->data pointer and params->len fields.
+ */
+ GattAuthCallbackReply_t authorizeRead(GattReadAuthCallbackParams *params) {
+ if (!isReadAuthorizationEnabled()) {
+ return AUTH_CALLBACK_REPLY_SUCCESS;
+ }
+
+ params->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS; /* Initialized to no-error by default. */
+ readAuthorizationCallback.call(params);
+ return params->authorizationReply;
+ }
+
+public:
+ /**
+ * Get the characteristic's value attribute.
+ *
+ * @return A reference to the characteristic's value attribute.
+ */
+ GattAttribute& getValueAttribute() {
+ return _valueAttribute;
+ }
+
+ /**
+ * A const alternative to GattCharacteristic::getValueAttribute().
+ *
+ * @return A const reference to the characteristic's value attribute.
+ */
+ const GattAttribute& getValueAttribute() const {
+ return _valueAttribute;
+ }
+
+ /**
+ * Get the characteristic's value attribute handle in the ATT table.
+ *
+ * @return The value attribute handle.
+ *
+ * @note The attribute handle is typically assigned by the underlying BLE
+ * stack.
+ */
+ GattAttribute::Handle_t getValueHandle(void) const {
+ return getValueAttribute().getHandle();
+ }
+
+ /**
+ * Get the characteristic's propertied. Refer to
+ * GattCharacteristic::Properties_t.
+ *
+ * @return The characteristic's properties.
+ */
+ uint8_t getProperties(void) const {
+ return _properties;
+ }
+
+ /**
+ * Get the characteristic's required security.
+ *
+ * @return The characteristic's required security.
+ */
+ SecurityManager::SecurityMode_t getRequiredSecurity() const {
+ return _requiredSecurity;
+ }
+
+ /**
+ * Get the total number of descriptors within this characteristic.
+ *
+ * @return The total number of descriptors.
+ */
+ uint8_t getDescriptorCount(void) const {
+ return _descriptorCount;
+ }
+
+ /**
+ * Check whether read authorization is enabled i.e. check whether a
+ * read authorization callback was previously registered. Refer to
+ * GattCharacteristic::setReadAuthorizationCallback().
+ *
+ * @return true if read authorization is enabled, false otherwise.
+ */
+ bool isReadAuthorizationEnabled() const {
+ return enabledReadAuthorization;
+ }
+
+ /**
+ * Check whether write authorization is enabled i.e. check whether a
+ * write authorization callback was previously registered. Refer to
+ * GattCharacteristic::setReadAuthorizationCallback().
+ *
+ * @return true if write authorization is enabled, false otherwise.
+ */
+ bool isWriteAuthorizationEnabled() const {
+ return enabledWriteAuthorization;
+ }
+
+ /**
+ * Get this characteristic's descriptor at a specific index.
+ *
+ * @param[in] index
+ * The descriptor's index.
+ *
+ * @return A pointer the requested descriptor if @p index contains a valid
+ * descriptor, or NULL otherwise.
+ */
+ GattAttribute *getDescriptor(uint8_t index) {
+ if (index >= _descriptorCount) {
+ return NULL;
+ }
+
+ return _descriptors[index];
+ }
+
+private:
+ /**
+ * Attribute that contains the actual value of this characteristic.
+ */
+ GattAttribute _valueAttribute;
+ /**
+ * The characteristic's properties. Refer to
+ * GattCharacteristic::Properties_t.
+ */
+ uint8_t _properties;
+ /**
+ * The characteristic's required security.
+ */
+ SecurityManager::SecurityMode_t _requiredSecurity;
+ /**
+ * The characteristic's descriptor attributes.
+ */
+ GattAttribute **_descriptors;
+ /**
+ * The number of descriptors in this characteristic.
+ */
+ uint8_t _descriptorCount;
+
+ /**
+ * Whether read authorization is enabled i.e. whether there is a registered
+ * callback to determine read authorization reply.
+ */
+ bool enabledReadAuthorization;
+ /**
+ * Whether write authorization is enabled i.e. whether there is a registered
+ * callback to determine write authorization reply.
+ */
+ bool enabledWriteAuthorization;
+ /**
+ * The registered callback handler for read authorization reply.
+ */
+ FunctionPointerWithContext<GattReadAuthCallbackParams *> readAuthorizationCallback;
+ /**
+ * The registered callback handler for write authorization reply.
+ */
+ FunctionPointerWithContext<GattWriteAuthCallbackParams *> writeAuthorizationCallback;
+
+private:
+ /* Disallow copy and assignment. */
+ GattCharacteristic(const GattCharacteristic &);
+ GattCharacteristic& operator=(const GattCharacteristic &);
+};
+
+/**
+ * Helper class to construct a read-only GattCharacteristic.
+ */
+template <typename T>
+class ReadOnlyGattCharacteristic : public GattCharacteristic {
+public:
+ /**
+ * Construct a ReadOnlyGattCharacteristic.
+ *
+ * @param[in] uuid
+ * The characteristic's UUID.
+ * @param[in] valuePtr
+ * Pointer to the characterisitic's initial value.
+ * @param[in] additionalProperties
+ * Additional characterisitic properties. By default, the
+ * properties are set to
+ * Properties_t::BLE_GATT_CHAR_PROPERTIES_READ.
+ * @param[in] descriptors
+ * An array of pointers to descriptors to be added to the new
+ * characteristic.
+ * @param[in] numDescriptors
+ * The total number of descriptors in @p descriptors.
+ *
+ * @note Instances of ReadOnlyGattCharacteristic have a fixed length
+ * attribute value that equals sizeof(T). For a variable length
+ * alternative use GattCharacteristic directly.
+ */
+ ReadOnlyGattCharacteristic<T>(const UUID &uuid,
+ T *valuePtr,
+ uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
+ GattAttribute *descriptors[] = NULL,
+ unsigned numDescriptors = 0) :
+ GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
+ BLE_GATT_CHAR_PROPERTIES_READ | additionalProperties, descriptors, numDescriptors, false) {
+ /* empty */
+ }
+};
+
+/**
+ * Helper class to construct a write-only GattCharacteristic.
+ */
+template <typename T>
+class WriteOnlyGattCharacteristic : public GattCharacteristic {
+public:
+ /**
+ * Construct a WriteOnlyGattCharacteristic.
+ *
+ * @param[in] uuid
+ * The characteristic's UUID.
+ * @param[in] valuePtr
+ * Pointer to the characterisitic's initial value.
+ * @param[in] additionalProperties
+ * Additional characterisitic properties. By default, the
+ * properties are set to
+ * Properties_t::BLE_GATT_CHAR_PROPERTIES_WRITE.
+ * @param[in] descriptors
+ * An array of pointers to descriptors to be added to the new
+ * characteristic.
+ * @param[in] numDescriptors
+ * The total number of descriptors in @p descriptors.
+ *
+ * @note Instances of WriteOnlyGattCharacteristic have variable length
+ * attribute value with maximum size equal to sizeof(T). For a fixed length
+ * alternative use GattCharacteristic directly.
+ */
+ WriteOnlyGattCharacteristic<T>(const UUID &uuid,
+ T *valuePtr,
+ uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
+ GattAttribute *descriptors[] = NULL,
+ unsigned numDescriptors = 0) :
+ GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
+ BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
+ /* empty */
+ }
+};
+
+/**
+ * Helper class to construct a readable and writable GattCharacteristic.
+ */
+template <typename T>
+class ReadWriteGattCharacteristic : public GattCharacteristic {
+public:
+ /**
+ * Construct a ReadWriteGattCharacteristic.
+ *
+ * @param[in] uuid
+ * The characteristic's UUID.
+ * @param[in] valuePtr
+ * Pointer to the characterisitic's initial value.
+ * @param[in] additionalProperties
+ * Additional characterisitic properties. By default, the
+ * properties are set to
+ * Properties_t::BLE_GATT_CHAR_PROPERTIES_WRITE |
+ * Properties_t::BLE_GATT_CHAR_PROPERTIES_READ.
+ * @param[in] descriptors
+ * An array of pointers to descriptors to be added to the new
+ * characteristic.
+ * @param[in] numDescriptors
+ * The total number of descriptors in @p descriptors.
+ *
+ * @note Instances of ReadWriteGattCharacteristic have variable length
+ * attribute value with maximum size equal to sizeof(T). For a fixed length
+ * alternative use GattCharacteristic directly.
+ */
+ ReadWriteGattCharacteristic<T>(const UUID &uuid,
+ T *valuePtr,
+ uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
+ GattAttribute *descriptors[] = NULL,
+ unsigned numDescriptors = 0) :
+ GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
+ BLE_GATT_CHAR_PROPERTIES_READ | BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
+ /* empty */
+ }
+};
+
+/**
+ * Helper class to construct a write-only GattCharacteristic with an array
+ * value.
+ */
+template <typename T, unsigned NUM_ELEMENTS>
+class WriteOnlyArrayGattCharacteristic : public GattCharacteristic {
+public:
+ /**
+ * Construct a WriteOnlyGattCharacteristic.
+ *
+ * @param[in] uuid
+ * The characteristic's UUID.
+ * @param[in] valuePtr
+ * Pointer to an array of length NUM_ELEMENTS containing the
+ * characteristic's intitial value.
+ * @param[in] additionalProperties
+ * Additional characterisitic properties. By default, the
+ * properties are set to
+ * Properties_t::BLE_GATT_CHAR_PROPERTIES_WRITE.
+ * @param[in] descriptors
+ * An array of pointers to descriptors to be added to the new
+ * characteristic.
+ * @param[in] numDescriptors
+ * The total number of descriptors in @p descriptors.
+ *
+ * @note Instances of WriteOnlyGattCharacteristic have variable length
+ * attribute value with maximum size equal to sizeof(T) * NUM_ELEMENTS.
+ * For a fixed length alternative use GattCharacteristic directly.
+ */
+ WriteOnlyArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
+ T valuePtr[NUM_ELEMENTS],
+ uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
+ GattAttribute *descriptors[] = NULL,
+ unsigned numDescriptors = 0) :
+ GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
+ BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
+ /* empty */
+ }
+};
+
+/**
+ * Helper class to construct a read-only GattCharacteristic with an array
+ * value.
+ */
+template <typename T, unsigned NUM_ELEMENTS>
+class ReadOnlyArrayGattCharacteristic : public GattCharacteristic {
+public:
+ /**
+ * Construct a ReadOnlyGattCharacteristic.
+ *
+ * @param[in] uuid
+ * The characteristic's UUID.
+ * @param[in] valuePtr
+ * Pointer to an array of length NUM_ELEMENTS containing the
+ * characteristic's intitial value.
+ * @param[in] additionalProperties
+ * Additional characterisitic properties. By default, the
+ * properties are set to
+ * Properties_t::BLE_GATT_CHAR_PROPERTIES_READ.
+ * @param[in] descriptors
+ * An array of pointers to descriptors to be added to the new
+ * characteristic.
+ * @param[in] numDescriptors
+ * The total number of descriptors in @p descriptors.
+ *
+ * @note Instances of ReadOnlyGattCharacteristic have fixed length
+ * attribute value that equals sizeof(T) * NUM_ELEMENTS.
+ * For a variable length alternative use GattCharacteristic directly.
+ */
+ ReadOnlyArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
+ T valuePtr[NUM_ELEMENTS],
+ uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
+ GattAttribute *descriptors[] = NULL,
+ unsigned numDescriptors = 0) :
+ GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
+ BLE_GATT_CHAR_PROPERTIES_READ | additionalProperties, descriptors, numDescriptors, false) {
+ /* empty */
+ }
+};
+
+/**
+ * Helper class to construct a readable and writable GattCharacteristic with an array
+ * value.
+ */
+template <typename T, unsigned NUM_ELEMENTS>
+class ReadWriteArrayGattCharacteristic : public GattCharacteristic {
+public:
+ /**
+ * Construct a ReadWriteGattCharacteristic.
+ *
+ * @param[in] uuid
+ * The characteristic's UUID.
+ * @param[in] valuePtr
+ * Pointer to an array of length NUM_ELEMENTS containing the
+ * characteristic's intitial value.
+ * @param[in] additionalProperties
+ * Additional characterisitic properties. By default, the
+ * properties are set to
+ * Properties_t::BLE_GATT_CHAR_PROPERTIES_WRITE |
+ * Properties_t::BLE_GATT_CHAR_PROPERTIES_READ.
+ * @param[in] descriptors
+ * An array of pointers to descriptors to be added to the new
+ * characteristic.
+ * @param[in] numDescriptors
+ * The total number of descriptors in @p descriptors.
+ *
+ * @note Instances of ReadWriteGattCharacteristic have variable length
+ * attribute value with maximum size equal to sizeof(T) * NUM_ELEMENTS.
+ * For a fixed length alternative use GattCharacteristic directly.
+ */
+ ReadWriteArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
+ T valuePtr[NUM_ELEMENTS],
+ uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
+ GattAttribute *descriptors[] = NULL,
+ unsigned numDescriptors = 0) :
+ GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
+ BLE_GATT_CHAR_PROPERTIES_READ | BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
+ /* empty */
+ }
+};
+
+#endif /* ifndef __GATT_CHARACTERISTIC_H__ */