Microbug / BLE_API_FOTA

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 BLE_API by Bluetooth Low Energy

GattCharacteristic.h@29:011e95ce78b8, 2014-01-16 (annotated)

Committer:
ktownsend
Date:
Thu Jan 16 22:29:53 2014 +0000
Revision:
29:011e95ce78b8
Parent:
27:4a83843f04b0
Child:
31:2c94f0501807
Added better radio abstraction layer, moved Gatt enums from blecommon.h to GattCharacteristic.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ktownsend 27:4a83843f04b0 1 /* mbed Microcontroller Library
ktownsend 27:4a83843f04b0 2 * Copyright (c) 2006-2013 ARM Limited
ktownsend 27:4a83843f04b0 3 *
ktownsend 27:4a83843f04b0 4 * Licensed under the Apache License, Version 2.0 (the "License");
ktownsend 27:4a83843f04b0 5 * you may not use this file except in compliance with the License.
ktownsend 27:4a83843f04b0 6 * You may obtain a copy of the License at
ktownsend 27:4a83843f04b0 7 *
ktownsend 27:4a83843f04b0 8 * http://www.apache.org/licenses/LICENSE-2.0
ktownsend 27:4a83843f04b0 9 *
ktownsend 27:4a83843f04b0 10 * Unless required by applicable law or agreed to in writing, software
ktownsend 27:4a83843f04b0 11 * distributed under the License is distributed on an "AS IS" BASIS,
ktownsend 27:4a83843f04b0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ktownsend 27:4a83843f04b0 13 * See the License for the specific language governing permissions and
ktownsend 27:4a83843f04b0 14 * limitations under the License.
ktownsend 27:4a83843f04b0 15 */
ktownsend 27:4a83843f04b0 16
ktownsend 27:4a83843f04b0 17
ktownsend 2:ffc5216bd2cc 18 #ifndef __GATT_CHARACTERISTIC_H__
ktownsend 2:ffc5216bd2cc 19 #define __GATT_CHARACTERISTIC_H__
ktownsend 2:ffc5216bd2cc 20
ktownsend 2:ffc5216bd2cc 21 #include "blecommon.h"
ktownsend 27:4a83843f04b0 22 #include "UUID.h"
ktownsend 2:ffc5216bd2cc 23
ktownsend 29:011e95ce78b8 24 /* ToDo: Update to use 16-bit or 128-bit UUIDs! */
ktownsend 29:011e95ce78b8 25
ktownsend 29:011e95ce78b8 26 /**************************************************************************/
ktownsend 29:011e95ce78b8 27 /*!
ktownsend 29:011e95ce78b8 28 \brief GATT characteristic
ktownsend 29:011e95ce78b8 29 */
ktownsend 29:011e95ce78b8 30 /**************************************************************************/
ktownsend 2:ffc5216bd2cc 31 class GattCharacteristic
ktownsend 2:ffc5216bd2cc 32 {
ktownsend 29:011e95ce78b8 33 public:
ktownsend 29:011e95ce78b8 34 /**************************************************************************/
ktownsend 29:011e95ce78b8 35 /*!
ktownsend 29:011e95ce78b8 36 \brief Standard GATT characteristic presentation format unit types.
ktownsend 29:011e95ce78b8 37 These unit types are used to decribe what the raw numeric
ktownsend 29:011e95ce78b8 38 data in a characteristic actually represents.
ktownsend 29:011e95ce78b8 39
ktownsend 29:011e95ce78b8 40 \note See https://developer.bluetooth.org/gatt/units/Pages/default.aspx
ktownsend 29:011e95ce78b8 41 */
ktownsend 29:011e95ce78b8 42 /**************************************************************************/
ktownsend 29:011e95ce78b8 43 typedef enum ble_gatt_unit_e
ktownsend 29:011e95ce78b8 44 {
ktownsend 29:011e95ce78b8 45 BLE_GATT_UNIT_NONE = 0x2700, /**< No specified unit type */
ktownsend 29:011e95ce78b8 46 BLE_GATT_UNIT_LENGTH_METRE = 0x2701, /**< Length, Metre */
ktownsend 29:011e95ce78b8 47 BLE_GATT_UNIT_MASS_KILOGRAM = 0x2702, /**< Mass, Kilogram */
ktownsend 29:011e95ce78b8 48 BLE_GATT_UNIT_TIME_SECOND = 0x2703, /**< Time, Second */
ktownsend 29:011e95ce78b8 49 BLE_GATT_UNIT_ELECTRIC_CURRENT_AMPERE = 0x2704, /**< Electric Current, Ampere */
ktownsend 29:011e95ce78b8 50 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_KELVIN = 0x2705, /**< Thermodynamic Temperature, Kelvin */
ktownsend 29:011e95ce78b8 51 BLE_GATT_UNIT_AMOUNT_OF_SUBSTANCE_MOLE = 0x2706, /**< Amount of Substance, Mole */
ktownsend 29:011e95ce78b8 52 BLE_GATT_UNIT_LUMINOUS_INTENSITY_CANDELA = 0x2707, /**< Luminous Intensity, Candela */
ktownsend 29:011e95ce78b8 53 BLE_GATT_UNIT_AREA_SQUARE_METRES = 0x2710, /**< Area, Square Metres */
ktownsend 29:011e95ce78b8 54 BLE_GATT_UNIT_VOLUME_CUBIC_METRES = 0x2711, /**< Volume, Cubic Metres*/
ktownsend 29:011e95ce78b8 55 BLE_GATT_UNIT_VELOCITY_METRES_PER_SECOND = 0x2712, /**< Velocity, Metres per Second*/
ktownsend 29:011e95ce78b8 56 BLE_GATT_UNIT_ACCELERATION_METRES_PER_SECOND_SQUARED = 0x2713, /**< Acceleration, Metres per Second Squared */
ktownsend 29:011e95ce78b8 57 BLE_GATT_UNIT_WAVENUMBER_RECIPROCAL_METRE = 0x2714, /**< Wave Number Reciprocal, Metre */
ktownsend 29:011e95ce78b8 58 BLE_GATT_UNIT_DENSITY_KILOGRAM_PER_CUBIC_METRE = 0x2715, /**< Density, Kilogram per Cubic Metre */
ktownsend 29:011e95ce78b8 59 BLE_GATT_UNIT_SURFACE_DENSITY_KILOGRAM_PER_SQUARE_METRE = 0x2716, /**< */
ktownsend 29:011e95ce78b8 60 BLE_GATT_UNIT_SPECIFIC_VOLUME_CUBIC_METRE_PER_KILOGRAM = 0x2717, /**< */
ktownsend 29:011e95ce78b8 61 BLE_GATT_UNIT_CURRENT_DENSITY_AMPERE_PER_SQUARE_METRE = 0x2718, /**< */
ktownsend 29:011e95ce78b8 62 BLE_GATT_UNIT_MAGNETIC_FIELD_STRENGTH_AMPERE_PER_METRE = 0x2719, /**< Magnetic Field Strength, Ampere per Metre */
ktownsend 29:011e95ce78b8 63 BLE_GATT_UNIT_AMOUNT_CONCENTRATION_MOLE_PER_CUBIC_METRE = 0x271A, /**< */
ktownsend 29:011e95ce78b8 64 BLE_GATT_UNIT_MASS_CONCENTRATION_KILOGRAM_PER_CUBIC_METRE = 0x271B, /**< */
ktownsend 29:011e95ce78b8 65 BLE_GATT_UNIT_LUMINANCE_CANDELA_PER_SQUARE_METRE = 0x271C, /**< */
ktownsend 29:011e95ce78b8 66 BLE_GATT_UNIT_REFRACTIVE_INDEX = 0x271D, /**< */
ktownsend 29:011e95ce78b8 67 BLE_GATT_UNIT_RELATIVE_PERMEABILITY = 0x271E, /**< */
ktownsend 29:011e95ce78b8 68 BLE_GATT_UNIT_PLANE_ANGLE_RADIAN = 0x2720, /**< */
ktownsend 29:011e95ce78b8 69 BLE_GATT_UNIT_SOLID_ANGLE_STERADIAN = 0x2721, /**< */
ktownsend 29:011e95ce78b8 70 BLE_GATT_UNIT_FREQUENCY_HERTZ = 0x2722, /**< Frequency, Hertz */
ktownsend 29:011e95ce78b8 71 BLE_GATT_UNIT_FORCE_NEWTON = 0x2723, /**< Force, Newton */
ktownsend 29:011e95ce78b8 72 BLE_GATT_UNIT_PRESSURE_PASCAL = 0x2724, /**< Pressure, Pascal */
ktownsend 29:011e95ce78b8 73 BLE_GATT_UNIT_ENERGY_JOULE = 0x2725, /**< Energy, Joule */
ktownsend 29:011e95ce78b8 74 BLE_GATT_UNIT_POWER_WATT = 0x2726, /**< Power, Watt */
ktownsend 29:011e95ce78b8 75 BLE_GATT_UNIT_ELECTRIC_CHARGE_COULOMB = 0x2727, /**< Electrical Charge, Coulomb */
ktownsend 29:011e95ce78b8 76 BLE_GATT_UNIT_ELECTRIC_POTENTIAL_DIFFERENCE_VOLT = 0x2728, /**< Electrical Potential Difference, Voltage */
ktownsend 29:011e95ce78b8 77 BLE_GATT_UNIT_CAPACITANCE_FARAD = 0x2729, /**< */
ktownsend 29:011e95ce78b8 78 BLE_GATT_UNIT_ELECTRIC_RESISTANCE_OHM = 0x272A, /**< */
ktownsend 29:011e95ce78b8 79 BLE_GATT_UNIT_ELECTRIC_CONDUCTANCE_SIEMENS = 0x272B, /**< */
ktownsend 29:011e95ce78b8 80 BLE_GATT_UNIT_MAGNETIC_FLEX_WEBER = 0x272C, /**< */
ktownsend 29:011e95ce78b8 81 BLE_GATT_UNIT_MAGNETIC_FLEX_DENSITY_TESLA = 0x272D, /**< */
ktownsend 29:011e95ce78b8 82 BLE_GATT_UNIT_INDUCTANCE_HENRY = 0x272E, /**< */
ktownsend 29:011e95ce78b8 83 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_CELSIUS = 0x272F, /**< */
ktownsend 29:011e95ce78b8 84 BLE_GATT_UNIT_LUMINOUS_FLUX_LUMEN = 0x2730, /**< */
ktownsend 29:011e95ce78b8 85 BLE_GATT_UNIT_ILLUMINANCE_LUX = 0x2731, /**< */
ktownsend 29:011e95ce78b8 86 BLE_GATT_UNIT_ACTIVITY_REFERRED_TO_A_RADIONUCLIDE_BECQUEREL = 0x2732, /**< */
ktownsend 29:011e95ce78b8 87 BLE_GATT_UNIT_ABSORBED_DOSE_GRAY = 0x2733, /**< */
ktownsend 29:011e95ce78b8 88 BLE_GATT_UNIT_DOSE_EQUIVALENT_SIEVERT = 0x2734, /**< */
ktownsend 29:011e95ce78b8 89 BLE_GATT_UNIT_CATALYTIC_ACTIVITY_KATAL = 0x2735, /**< */
ktownsend 29:011e95ce78b8 90 BLE_GATT_UNIT_DYNAMIC_VISCOSITY_PASCAL_SECOND = 0x2740, /**< */
ktownsend 29:011e95ce78b8 91 BLE_GATT_UNIT_MOMENT_OF_FORCE_NEWTON_METRE = 0x2741, /**< */
ktownsend 29:011e95ce78b8 92 BLE_GATT_UNIT_SURFACE_TENSION_NEWTON_PER_METRE = 0x2742, /**< */
ktownsend 29:011e95ce78b8 93 BLE_GATT_UNIT_ANGULAR_VELOCITY_RADIAN_PER_SECOND = 0x2743, /**< */
ktownsend 29:011e95ce78b8 94 BLE_GATT_UNIT_ANGULAR_ACCELERATION_RADIAN_PER_SECOND_SQUARED = 0x2744, /**< */
ktownsend 29:011e95ce78b8 95 BLE_GATT_UNIT_HEAT_FLUX_DENSITY_WATT_PER_SQUARE_METRE = 0x2745, /**< */
ktownsend 29:011e95ce78b8 96 BLE_GATT_UNIT_HEAT_CAPACITY_JOULE_PER_KELVIN = 0x2746, /**< */
ktownsend 29:011e95ce78b8 97 BLE_GATT_UNIT_SPECIFIC_HEAT_CAPACITY_JOULE_PER_KILOGRAM_KELVIN = 0x2747, /**< */
ktownsend 29:011e95ce78b8 98 BLE_GATT_UNIT_SPECIFIC_ENERGY_JOULE_PER_KILOGRAM = 0x2748, /**< */
ktownsend 29:011e95ce78b8 99 BLE_GATT_UNIT_THERMAL_CONDUCTIVITY_WATT_PER_METRE_KELVIN = 0x2749, /**< */
ktownsend 29:011e95ce78b8 100 BLE_GATT_UNIT_ENERGY_DENSITY_JOULE_PER_CUBIC_METRE = 0x274A, /**< */
ktownsend 29:011e95ce78b8 101 BLE_GATT_UNIT_ELECTRIC_FIELD_STRENGTH_VOLT_PER_METRE = 0x274B, /**< */
ktownsend 29:011e95ce78b8 102 BLE_GATT_UNIT_ELECTRIC_CHARGE_DENSITY_COULOMB_PER_CUBIC_METRE = 0x274C, /**< */
ktownsend 29:011e95ce78b8 103 BLE_GATT_UNIT_SURFACE_CHARGE_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274D, /**< */
ktownsend 29:011e95ce78b8 104 BLE_GATT_UNIT_ELECTRIC_FLUX_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274E, /**< */
ktownsend 29:011e95ce78b8 105 BLE_GATT_UNIT_PERMITTIVITY_FARAD_PER_METRE = 0x274F, /**< */
ktownsend 29:011e95ce78b8 106 BLE_GATT_UNIT_PERMEABILITY_HENRY_PER_METRE = 0x2750, /**< */
ktownsend 29:011e95ce78b8 107 BLE_GATT_UNIT_MOLAR_ENERGY_JOULE_PER_MOLE = 0x2751, /**< */
ktownsend 29:011e95ce78b8 108 BLE_GATT_UNIT_MOLAR_ENTROPY_JOULE_PER_MOLE_KELVIN = 0x2752, /**< */
ktownsend 29:011e95ce78b8 109 BLE_GATT_UNIT_EXPOSURE_COULOMB_PER_KILOGRAM = 0x2753, /**< */
ktownsend 29:011e95ce78b8 110 BLE_GATT_UNIT_ABSORBED_DOSE_RATE_GRAY_PER_SECOND = 0x2754, /**< */
ktownsend 29:011e95ce78b8 111 BLE_GATT_UNIT_RADIANT_INTENSITY_WATT_PER_STERADIAN = 0x2755, /**< */
ktownsend 29:011e95ce78b8 112 BLE_GATT_UNIT_RADIANCE_WATT_PER_SQUARE_METRE_STERADIAN = 0x2756, /**< */
ktownsend 29:011e95ce78b8 113 BLE_GATT_UNIT_CATALYTIC_ACTIVITY_CONCENTRATION_KATAL_PER_CUBIC_METRE = 0x2757, /**< */
ktownsend 29:011e95ce78b8 114 BLE_GATT_UNIT_TIME_MINUTE = 0x2760, /**< Time, Minute */
ktownsend 29:011e95ce78b8 115 BLE_GATT_UNIT_TIME_HOUR = 0x2761, /**< Time, Hour */
ktownsend 29:011e95ce78b8 116 BLE_GATT_UNIT_TIME_DAY = 0x2762, /**< Time, Day */
ktownsend 29:011e95ce78b8 117 BLE_GATT_UNIT_PLANE_ANGLE_DEGREE = 0x2763, /**< */
ktownsend 29:011e95ce78b8 118 BLE_GATT_UNIT_PLANE_ANGLE_MINUTE = 0x2764, /**< */
ktownsend 29:011e95ce78b8 119 BLE_GATT_UNIT_PLANE_ANGLE_SECOND = 0x2765, /**< */
ktownsend 29:011e95ce78b8 120 BLE_GATT_UNIT_AREA_HECTARE = 0x2766, /**< */
ktownsend 29:011e95ce78b8 121 BLE_GATT_UNIT_VOLUME_LITRE = 0x2767, /**< */
ktownsend 29:011e95ce78b8 122 BLE_GATT_UNIT_MASS_TONNE = 0x2768, /**< */
ktownsend 29:011e95ce78b8 123 BLE_GATT_UNIT_PRESSURE_BAR = 0x2780, /**< Pressure, Bar */
ktownsend 29:011e95ce78b8 124 BLE_GATT_UNIT_PRESSURE_MILLIMETRE_OF_MERCURY = 0x2781, /**< Pressure, Millimetre of Mercury */
ktownsend 29:011e95ce78b8 125 BLE_GATT_UNIT_LENGTH_ANGSTROM = 0x2782, /**< */
ktownsend 29:011e95ce78b8 126 BLE_GATT_UNIT_LENGTH_NAUTICAL_MILE = 0x2783, /**< */
ktownsend 29:011e95ce78b8 127 BLE_GATT_UNIT_AREA_BARN = 0x2784, /**< */
ktownsend 29:011e95ce78b8 128 BLE_GATT_UNIT_VELOCITY_KNOT = 0x2785, /**< */
ktownsend 29:011e95ce78b8 129 BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_NEPER = 0x2786, /**< */
ktownsend 29:011e95ce78b8 130 BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_BEL = 0x2787, /**< */
ktownsend 29:011e95ce78b8 131 BLE_GATT_UNIT_LENGTH_YARD = 0x27A0, /**< Length, Yard */
ktownsend 29:011e95ce78b8 132 BLE_GATT_UNIT_LENGTH_PARSEC = 0x27A1, /**< Length, Parsec */
ktownsend 29:011e95ce78b8 133 BLE_GATT_UNIT_LENGTH_INCH = 0x27A2, /**< Length, Inch */
ktownsend 29:011e95ce78b8 134 BLE_GATT_UNIT_LENGTH_FOOT = 0x27A3, /**< Length, Foot */
ktownsend 29:011e95ce78b8 135 BLE_GATT_UNIT_LENGTH_MILE = 0x27A4, /**< Length, Mile */
ktownsend 29:011e95ce78b8 136 BLE_GATT_UNIT_PRESSURE_POUND_FORCE_PER_SQUARE_INCH = 0x27A5, /**< */
ktownsend 29:011e95ce78b8 137 BLE_GATT_UNIT_VELOCITY_KILOMETRE_PER_HOUR = 0x27A6, /**< Velocity, Kilometre per Hour */
ktownsend 29:011e95ce78b8 138 BLE_GATT_UNIT_VELOCITY_MILE_PER_HOUR = 0x27A7, /**< Velocity, Mile per Hour */
ktownsend 29:011e95ce78b8 139 BLE_GATT_UNIT_ANGULAR_VELOCITY_REVOLUTION_PER_MINUTE = 0x27A8, /**< Angular Velocity, Revolution per Minute */
ktownsend 29:011e95ce78b8 140 BLE_GATT_UNIT_ENERGY_GRAM_CALORIE = 0x27A9, /**< Energy, Gram Calorie */
ktownsend 29:011e95ce78b8 141 BLE_GATT_UNIT_ENERGY_KILOGRAM_CALORIE = 0x27AA, /**< Energy, Kilogram Calorie */
ktownsend 29:011e95ce78b8 142 BLE_GATT_UNIT_ENERGY_KILOWATT_HOUR = 0x27AB, /**< Energy, Killowatt Hour */
ktownsend 29:011e95ce78b8 143 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_FAHRENHEIT = 0x27AC, /**< */
ktownsend 29:011e95ce78b8 144 BLE_GATT_UNIT_PERCENTAGE = 0x27AD, /**< Percentage */
ktownsend 29:011e95ce78b8 145 BLE_GATT_UNIT_PER_MILLE = 0x27AE, /**< */
ktownsend 29:011e95ce78b8 146 BLE_GATT_UNIT_PERIOD_BEATS_PER_MINUTE = 0x27AF, /**< */
ktownsend 29:011e95ce78b8 147 BLE_GATT_UNIT_ELECTRIC_CHARGE_AMPERE_HOURS = 0x27B0, /**< */
ktownsend 29:011e95ce78b8 148 BLE_GATT_UNIT_MASS_DENSITY_MILLIGRAM_PER_DECILITRE = 0x27B1, /**< */
ktownsend 29:011e95ce78b8 149 BLE_GATT_UNIT_MASS_DENSITY_MILLIMOLE_PER_LITRE = 0x27B2, /**< */
ktownsend 29:011e95ce78b8 150 BLE_GATT_UNIT_TIME_YEAR = 0x27B3, /**< Time, Year */
ktownsend 29:011e95ce78b8 151 BLE_GATT_UNIT_TIME_MONTH = 0x27B4, /**< Time, Month */
ktownsend 29:011e95ce78b8 152 BLE_GATT_UNIT_CONCENTRATION_COUNT_PER_CUBIC_METRE = 0x27B5, /**< */
ktownsend 29:011e95ce78b8 153 BLE_GATT_UNIT_IRRADIANCE_WATT_PER_SQUARE_METRE = 0x27B6 /**< */
ktownsend 29:011e95ce78b8 154 } ble_gatt_unit_t;
ktownsend 29:011e95ce78b8 155
ktownsend 29:011e95ce78b8 156 /**************************************************************************/
ktownsend 29:011e95ce78b8 157 /*!
ktownsend 29:011e95ce78b8 158 \brief Standard GATT number types
ktownsend 29:011e95ce78b8 159
ktownsend 29:011e95ce78b8 160 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.2
ktownsend 29:011e95ce78b8 161 \note See http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
ktownsend 29:011e95ce78b8 162 */
ktownsend 29:011e95ce78b8 163 /**************************************************************************/
ktownsend 29:011e95ce78b8 164 typedef enum ble_gatt_format_e
ktownsend 29:011e95ce78b8 165 {
ktownsend 29:011e95ce78b8 166 BLE_GATT_FORMAT_RFU = 0x00, /**< Reserved For Future Use. */
ktownsend 29:011e95ce78b8 167 BLE_GATT_FORMAT_BOOLEAN = 0x01, /**< Boolean. */
ktownsend 29:011e95ce78b8 168 BLE_GATT_FORMAT_2BIT = 0x02, /**< Unsigned 2-bit integer. */
ktownsend 29:011e95ce78b8 169 BLE_GATT_FORMAT_NIBBLE = 0x03, /**< Unsigned 4-bit integer. */
ktownsend 29:011e95ce78b8 170 BLE_GATT_FORMAT_UINT8 = 0x04, /**< Unsigned 8-bit integer. */
ktownsend 29:011e95ce78b8 171 BLE_GATT_FORMAT_UINT12 = 0x05, /**< Unsigned 12-bit integer. */
ktownsend 29:011e95ce78b8 172 BLE_GATT_FORMAT_UINT16 = 0x06, /**< Unsigned 16-bit integer. */
ktownsend 29:011e95ce78b8 173 BLE_GATT_FORMAT_UINT24 = 0x07, /**< Unsigned 24-bit integer. */
ktownsend 29:011e95ce78b8 174 BLE_GATT_FORMAT_UINT32 = 0x08, /**< Unsigned 32-bit integer. */
ktownsend 29:011e95ce78b8 175 BLE_GATT_FORMAT_UINT48 = 0x09, /**< Unsigned 48-bit integer. */
ktownsend 29:011e95ce78b8 176 BLE_GATT_FORMAT_UINT64 = 0x0A, /**< Unsigned 64-bit integer. */
ktownsend 29:011e95ce78b8 177 BLE_GATT_FORMAT_UINT128 = 0x0B, /**< Unsigned 128-bit integer. */
ktownsend 29:011e95ce78b8 178 BLE_GATT_FORMAT_SINT8 = 0x0C, /**< Signed 2-bit integer. */
ktownsend 29:011e95ce78b8 179 BLE_GATT_FORMAT_SINT12 = 0x0D, /**< Signed 12-bit integer. */
ktownsend 29:011e95ce78b8 180 BLE_GATT_FORMAT_SINT16 = 0x0E, /**< Signed 16-bit integer. */
ktownsend 29:011e95ce78b8 181 BLE_GATT_FORMAT_SINT24 = 0x0F, /**< Signed 24-bit integer. */
ktownsend 29:011e95ce78b8 182 BLE_GATT_FORMAT_SINT32 = 0x10, /**< Signed 32-bit integer. */
ktownsend 29:011e95ce78b8 183 BLE_GATT_FORMAT_SINT48 = 0x11, /**< Signed 48-bit integer. */
ktownsend 29:011e95ce78b8 184 BLE_GATT_FORMAT_SINT64 = 0x12, /**< Signed 64-bit integer. */
ktownsend 29:011e95ce78b8 185 BLE_GATT_FORMAT_SINT128 = 0x13, /**< Signed 128-bit integer. */
ktownsend 29:011e95ce78b8 186 BLE_GATT_FORMAT_FLOAT32 = 0x14, /**< IEEE-754 32-bit floating point. */
ktownsend 29:011e95ce78b8 187 BLE_GATT_FORMAT_FLOAT64 = 0x15, /**< IEEE-754 64-bit floating point. */
ktownsend 29:011e95ce78b8 188 BLE_GATT_FORMAT_SFLOAT = 0x16, /**< IEEE-11073 16-bit SFLOAT. */
ktownsend 29:011e95ce78b8 189 BLE_GATT_FORMAT_FLOAT = 0x17, /**< IEEE-11073 32-bit FLOAT. */
ktownsend 29:011e95ce78b8 190 BLE_GATT_FORMAT_DUINT16 = 0x18, /**< IEEE-20601 format. */
ktownsend 29:011e95ce78b8 191 BLE_GATT_FORMAT_UTF8S = 0x19, /**< UTF-8 string. */
ktownsend 29:011e95ce78b8 192 BLE_GATT_FORMAT_UTF16S = 0x1A, /**< UTF-16 string. */
ktownsend 29:011e95ce78b8 193 BLE_GATT_FORMAT_STRUCT = 0x1B /**< Opaque Structure. */
ktownsend 29:011e95ce78b8 194 } ble_gatt_format_t;
ktownsend 29:011e95ce78b8 195
ktownsend 29:011e95ce78b8 196 /**************************************************************************/
ktownsend 29:011e95ce78b8 197 /*!
ktownsend 29:011e95ce78b8 198 \brief Standard GATT characteritic properties
ktownsend 29:011e95ce78b8 199
ktownsend 29:011e95ce78b8 200 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.1.1
ktownsend 29:011e95ce78b8 201 and Section 3.3.3.1 for Extended Properties
ktownsend 29:011e95ce78b8 202 */
ktownsend 29:011e95ce78b8 203 /**************************************************************************/
ktownsend 29:011e95ce78b8 204 typedef enum ble_gatt_char_properties_e
ktownsend 29:011e95ce78b8 205 {
ktownsend 29:011e95ce78b8 206 BLE_GATT_CHAR_PROPERTIES_BROADCAST = 0x01, /**< Permits broadcasts of the Characteristic Value using Server Characteristic Configuration Descriptor. */
ktownsend 29:011e95ce78b8 207 BLE_GATT_CHAR_PROPERTIES_READ = 0x02, /**< Permits reads of the Characteristic Value. */
ktownsend 29:011e95ce78b8 208 BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE = 0x04, /**< Permits writes of the Characteristic Value without response. */
ktownsend 29:011e95ce78b8 209 BLE_GATT_CHAR_PROPERTIES_WRITE = 0x08, /**< Permits writes of the Characteristic Value with response. */
ktownsend 29:011e95ce78b8 210 BLE_GATT_CHAR_PROPERTIES_NOTIFY = 0x10, /**< Permits notifications of a Characteristic Value without acknowledgement. */
ktownsend 29:011e95ce78b8 211 BLE_GATT_CHAR_PROPERTIES_INDICATE = 0x20, /**< Permits indications of a Characteristic Value with acknowledgement. */
ktownsend 29:011e95ce78b8 212 BLE_GATT_CHAR_PROPERTIES_AUTHENTICATED_SIGNED_WRITES = 0x40, /**< Permits signed writes to the Characteristic Value. */
ktownsend 29:011e95ce78b8 213 BLE_GATT_CHAR_PROPERTIES_EXTENDED_PROPERTIES = 0x80 /**< Additional characteristic properties are defined in the Characteristic Extended Properties Descriptor */
ktownsend 29:011e95ce78b8 214 } ble_gatt_char_properties_t;
ktownsend 29:011e95ce78b8 215
ktownsend 29:011e95ce78b8 216 /**************************************************************************/
ktownsend 29:011e95ce78b8 217 /*!
ktownsend 29:011e95ce78b8 218 \brief GATT presentation format wrapper
ktownsend 29:011e95ce78b8 219
ktownsend 29:011e95ce78b8 220 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5
ktownsend 29:011e95ce78b8 221 \note See https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
ktownsend 29:011e95ce78b8 222 */
ktownsend 29:011e95ce78b8 223 /**************************************************************************/
ktownsend 29:011e95ce78b8 224 typedef struct PresentationFormat
ktownsend 29:011e95ce78b8 225 {
ktownsend 29:011e95ce78b8 226 uint8_t gatt_format; /**< Format of the value, see @ref ble_gatt_format_t. */
ktownsend 29:011e95ce78b8 227 int8_t exponent; /**< Exponent for integer data types. Ex. if Exponent = -3 and the char value is 3892, the actual value is 3.892 */
ktownsend 29:011e95ce78b8 228 uint16_t gatt_unit; /**< UUID from Bluetooth Assigned Numbers, see @ref ble_gatt_unit_t. */
ktownsend 29:011e95ce78b8 229 uint8_t gatt_namespace; /**< Namespace from Bluetooth Assigned Numbers, normally '1', see @ref BLE_GATT_CPF_NAMESPACES. */
ktownsend 29:011e95ce78b8 230 uint16_t gatt_nsdesc; /**< Namespace description from Bluetooth Assigned Numbers, normally '0', see @ref BLE_GATT_CPF_NAMESPACES. */
ktownsend 29:011e95ce78b8 231 } presentation_format_t;
ktownsend 29:011e95ce78b8 232
ktownsend 29:011e95ce78b8 233 GattCharacteristic(uint16_t uuid=0, uint16_t minLen=1, uint16_t maxLen=1, uint8_t properties=0);
ktownsend 29:011e95ce78b8 234 virtual ~GattCharacteristic(void);
ktownsend 29:011e95ce78b8 235
ktownsend 29:011e95ce78b8 236 uint16_t uuid; /* Characteristic UUID */
ktownsend 29:011e95ce78b8 237 uint16_t lenMin; /* Minimum length of the value */
ktownsend 29:011e95ce78b8 238 uint16_t lenMax; /* Maximum length of the value */
ktownsend 29:011e95ce78b8 239 uint8_t handle;
ktownsend 29:011e95ce78b8 240 uint8_t properties;
ktownsend 29:011e95ce78b8 241
ktownsend 29:011e95ce78b8 242 private:
ktownsend 2:ffc5216bd2cc 243 };
ktownsend 2:ffc5216bd2cc 244
ktownsend 2:ffc5216bd2cc 245 #endif