Qi Yao / LinkNode---test123

test code 123

Dependencies:   mbed

Fork of LinkNode-Test by Qi Yao

nRF51822_Science_Journal/BLE_API/ble/GattCharacteristic.h@0:1ad0e04b1bc5, 2016-09-01 (annotated)

Committer:
youkee
Date:
Thu Sep 01 05:14:03 2016 +0000
Revision:
0:1ad0e04b1bc5
change internal time from 1s to 200ms

Who changed what in which revision?

UserRevisionLine numberNew contents of line
youkee 0:1ad0e04b1bc5 1 /* mbed Microcontroller Library
youkee 0:1ad0e04b1bc5 2 * Copyright (c) 2006-2013 ARM Limited
youkee 0:1ad0e04b1bc5 3 *
youkee 0:1ad0e04b1bc5 4 * Licensed under the Apache License, Version 2.0 (the "License");
youkee 0:1ad0e04b1bc5 5 * you may not use this file except in compliance with the License.
youkee 0:1ad0e04b1bc5 6 * You may obtain a copy of the License at
youkee 0:1ad0e04b1bc5 7 *
youkee 0:1ad0e04b1bc5 8 * http://www.apache.org/licenses/LICENSE-2.0
youkee 0:1ad0e04b1bc5 9 *
youkee 0:1ad0e04b1bc5 10 * Unless required by applicable law or agreed to in writing, software
youkee 0:1ad0e04b1bc5 11 * distributed under the License is distributed on an "AS IS" BASIS,
youkee 0:1ad0e04b1bc5 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
youkee 0:1ad0e04b1bc5 13 * See the License for the specific language governing permissions and
youkee 0:1ad0e04b1bc5 14 * limitations under the License.
youkee 0:1ad0e04b1bc5 15 */
youkee 0:1ad0e04b1bc5 16
youkee 0:1ad0e04b1bc5 17 #ifndef __GATT_CHARACTERISTIC_H__
youkee 0:1ad0e04b1bc5 18 #define __GATT_CHARACTERISTIC_H__
youkee 0:1ad0e04b1bc5 19
youkee 0:1ad0e04b1bc5 20 #include "Gap.h"
youkee 0:1ad0e04b1bc5 21 #include "SecurityManager.h"
youkee 0:1ad0e04b1bc5 22 #include "GattAttribute.h"
youkee 0:1ad0e04b1bc5 23 #include "GattCallbackParamTypes.h"
youkee 0:1ad0e04b1bc5 24 #include "FunctionPointerWithContext.h"
youkee 0:1ad0e04b1bc5 25
youkee 0:1ad0e04b1bc5 26 class GattCharacteristic {
youkee 0:1ad0e04b1bc5 27 public:
youkee 0:1ad0e04b1bc5 28 enum {
youkee 0:1ad0e04b1bc5 29 UUID_BATTERY_LEVEL_STATE_CHAR = 0x2A1B,
youkee 0:1ad0e04b1bc5 30 UUID_BATTERY_POWER_STATE_CHAR = 0x2A1A,
youkee 0:1ad0e04b1bc5 31 UUID_REMOVABLE_CHAR = 0x2A3A,
youkee 0:1ad0e04b1bc5 32 UUID_SERVICE_REQUIRED_CHAR = 0x2A3B,
youkee 0:1ad0e04b1bc5 33 UUID_ALERT_CATEGORY_ID_CHAR = 0x2A43,
youkee 0:1ad0e04b1bc5 34 UUID_ALERT_CATEGORY_ID_BIT_MASK_CHAR = 0x2A42,
youkee 0:1ad0e04b1bc5 35 UUID_ALERT_LEVEL_CHAR = 0x2A06,
youkee 0:1ad0e04b1bc5 36 UUID_ALERT_NOTIFICATION_CONTROL_POINT_CHAR = 0x2A44,
youkee 0:1ad0e04b1bc5 37 UUID_ALERT_STATUS_CHAR = 0x2A3F,
youkee 0:1ad0e04b1bc5 38 UUID_BATTERY_LEVEL_CHAR = 0x2A19,
youkee 0:1ad0e04b1bc5 39 UUID_BLOOD_PRESSURE_FEATURE_CHAR = 0x2A49,
youkee 0:1ad0e04b1bc5 40 UUID_BLOOD_PRESSURE_MEASUREMENT_CHAR = 0x2A35,
youkee 0:1ad0e04b1bc5 41 UUID_BODY_SENSOR_LOCATION_CHAR = 0x2A38,
youkee 0:1ad0e04b1bc5 42 UUID_BOOT_KEYBOARD_INPUT_REPORT_CHAR = 0x2A22,
youkee 0:1ad0e04b1bc5 43 UUID_BOOT_KEYBOARD_OUTPUT_REPORT_CHAR = 0x2A32,
youkee 0:1ad0e04b1bc5 44 UUID_BOOT_MOUSE_INPUT_REPORT_CHAR = 0x2A33,
youkee 0:1ad0e04b1bc5 45 UUID_CURRENT_TIME_CHAR = 0x2A2B,
youkee 0:1ad0e04b1bc5 46 UUID_DATE_TIME_CHAR = 0x2A08,
youkee 0:1ad0e04b1bc5 47 UUID_DAY_DATE_TIME_CHAR = 0x2A0A,
youkee 0:1ad0e04b1bc5 48 UUID_DAY_OF_WEEK_CHAR = 0x2A09,
youkee 0:1ad0e04b1bc5 49 UUID_DST_OFFSET_CHAR = 0x2A0D,
youkee 0:1ad0e04b1bc5 50 UUID_EXACT_TIME_256_CHAR = 0x2A0C,
youkee 0:1ad0e04b1bc5 51 UUID_FIRMWARE_REVISION_STRING_CHAR = 0x2A26,
youkee 0:1ad0e04b1bc5 52 UUID_GLUCOSE_FEATURE_CHAR = 0x2A51,
youkee 0:1ad0e04b1bc5 53 UUID_GLUCOSE_MEASUREMENT_CHAR = 0x2A18,
youkee 0:1ad0e04b1bc5 54 UUID_GLUCOSE_MEASUREMENT_CONTEXT_CHAR = 0x2A34,
youkee 0:1ad0e04b1bc5 55 UUID_HARDWARE_REVISION_STRING_CHAR = 0x2A27,
youkee 0:1ad0e04b1bc5 56 UUID_HEART_RATE_CONTROL_POINT_CHAR = 0x2A39,
youkee 0:1ad0e04b1bc5 57 UUID_HEART_RATE_MEASUREMENT_CHAR = 0x2A37,
youkee 0:1ad0e04b1bc5 58 UUID_HID_CONTROL_POINT_CHAR = 0x2A4C,
youkee 0:1ad0e04b1bc5 59 UUID_HID_INFORMATION_CHAR = 0x2A4A,
youkee 0:1ad0e04b1bc5 60 UUID_HUMIDITY_CHAR = 0x2A6F,
youkee 0:1ad0e04b1bc5 61 UUID_IEEE_REGULATORY_CERTIFICATION_DATA_LIST_CHAR = 0x2A2A,
youkee 0:1ad0e04b1bc5 62 UUID_INTERMEDIATE_CUFF_PRESSURE_CHAR = 0x2A36,
youkee 0:1ad0e04b1bc5 63 UUID_INTERMEDIATE_TEMPERATURE_CHAR = 0x2A1E,
youkee 0:1ad0e04b1bc5 64 UUID_LOCAL_TIME_INFORMATION_CHAR = 0x2A0F,
youkee 0:1ad0e04b1bc5 65 UUID_MANUFACTURER_NAME_STRING_CHAR = 0x2A29,
youkee 0:1ad0e04b1bc5 66 UUID_MEASUREMENT_INTERVAL_CHAR = 0x2A21,
youkee 0:1ad0e04b1bc5 67 UUID_MODEL_NUMBER_STRING_CHAR = 0x2A24,
youkee 0:1ad0e04b1bc5 68 UUID_UNREAD_ALERT_CHAR = 0x2A45,
youkee 0:1ad0e04b1bc5 69 UUID_NEW_ALERT_CHAR = 0x2A46,
youkee 0:1ad0e04b1bc5 70 UUID_PNP_ID_CHAR = 0x2A50,
youkee 0:1ad0e04b1bc5 71 UUID_PRESSURE_CHAR = 0x2A6D,
youkee 0:1ad0e04b1bc5 72 UUID_PROTOCOL_MODE_CHAR = 0x2A4E,
youkee 0:1ad0e04b1bc5 73 UUID_RECORD_ACCESS_CONTROL_POINT_CHAR = 0x2A52,
youkee 0:1ad0e04b1bc5 74 UUID_REFERENCE_TIME_INFORMATION_CHAR = 0x2A14,
youkee 0:1ad0e04b1bc5 75 UUID_REPORT_CHAR = 0x2A4D,
youkee 0:1ad0e04b1bc5 76 UUID_REPORT_MAP_CHAR = 0x2A4B,
youkee 0:1ad0e04b1bc5 77 UUID_RINGER_CONTROL_POINT_CHAR = 0x2A40,
youkee 0:1ad0e04b1bc5 78 UUID_RINGER_SETTING_CHAR = 0x2A41,
youkee 0:1ad0e04b1bc5 79 UUID_SCAN_INTERVAL_WINDOW_CHAR = 0x2A4F,
youkee 0:1ad0e04b1bc5 80 UUID_SCAN_REFRESH_CHAR = 0x2A31,
youkee 0:1ad0e04b1bc5 81 UUID_SERIAL_NUMBER_STRING_CHAR = 0x2A25,
youkee 0:1ad0e04b1bc5 82 UUID_SOFTWARE_REVISION_STRING_CHAR = 0x2A28,
youkee 0:1ad0e04b1bc5 83 UUID_SUPPORTED_NEW_ALERT_CATEGORY_CHAR = 0x2A47,
youkee 0:1ad0e04b1bc5 84 UUID_SUPPORTED_UNREAD_ALERT_CATEGORY_CHAR = 0x2A48,
youkee 0:1ad0e04b1bc5 85 UUID_SYSTEM_ID_CHAR = 0x2A23,
youkee 0:1ad0e04b1bc5 86 UUID_TEMPERATURE_CHAR = 0x2A6E,
youkee 0:1ad0e04b1bc5 87 UUID_TEMPERATURE_MEASUREMENT_CHAR = 0x2A1C,
youkee 0:1ad0e04b1bc5 88 UUID_TEMPERATURE_TYPE_CHAR = 0x2A1D,
youkee 0:1ad0e04b1bc5 89 UUID_TIME_ACCURACY_CHAR = 0x2A12,
youkee 0:1ad0e04b1bc5 90 UUID_TIME_SOURCE_CHAR = 0x2A13,
youkee 0:1ad0e04b1bc5 91 UUID_TIME_UPDATE_CONTROL_POINT_CHAR = 0x2A16,
youkee 0:1ad0e04b1bc5 92 UUID_TIME_UPDATE_STATE_CHAR = 0x2A17,
youkee 0:1ad0e04b1bc5 93 UUID_TIME_WITH_DST_CHAR = 0x2A11,
youkee 0:1ad0e04b1bc5 94 UUID_TIME_ZONE_CHAR = 0x2A0E,
youkee 0:1ad0e04b1bc5 95 UUID_TX_POWER_LEVEL_CHAR = 0x2A07,
youkee 0:1ad0e04b1bc5 96 UUID_CSC_FEATURE_CHAR = 0x2A5C,
youkee 0:1ad0e04b1bc5 97 UUID_CSC_MEASUREMENT_CHAR = 0x2A5B,
youkee 0:1ad0e04b1bc5 98 UUID_RSC_FEATURE_CHAR = 0x2A54,
youkee 0:1ad0e04b1bc5 99 UUID_RSC_MEASUREMENT_CHAR = 0x2A53
youkee 0:1ad0e04b1bc5 100 };
youkee 0:1ad0e04b1bc5 101
youkee 0:1ad0e04b1bc5 102 /**************************************************************************/
youkee 0:1ad0e04b1bc5 103 /*!
youkee 0:1ad0e04b1bc5 104 \brief Standard GATT characteristic presentation format unit types.
youkee 0:1ad0e04b1bc5 105 These unit types are used to describe what the raw numeric
youkee 0:1ad0e04b1bc5 106 data in a characteristic actually represents.
youkee 0:1ad0e04b1bc5 107
youkee 0:1ad0e04b1bc5 108 \note See https://developer.bluetooth.org/gatt/units/Pages/default.aspx
youkee 0:1ad0e04b1bc5 109 */
youkee 0:1ad0e04b1bc5 110 /**************************************************************************/
youkee 0:1ad0e04b1bc5 111 enum {
youkee 0:1ad0e04b1bc5 112 BLE_GATT_UNIT_NONE = 0x2700, /**< No specified unit type. */
youkee 0:1ad0e04b1bc5 113 BLE_GATT_UNIT_LENGTH_METRE = 0x2701, /**< Length, metre. */
youkee 0:1ad0e04b1bc5 114 BLE_GATT_UNIT_MASS_KILOGRAM = 0x2702, /**< Mass, kilogram. */
youkee 0:1ad0e04b1bc5 115 BLE_GATT_UNIT_TIME_SECOND = 0x2703, /**< Time, second. */
youkee 0:1ad0e04b1bc5 116 BLE_GATT_UNIT_ELECTRIC_CURRENT_AMPERE = 0x2704, /**< Electric current, ampere. */
youkee 0:1ad0e04b1bc5 117 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_KELVIN = 0x2705, /**< Thermodynamic temperature, kelvin. */
youkee 0:1ad0e04b1bc5 118 BLE_GATT_UNIT_AMOUNT_OF_SUBSTANCE_MOLE = 0x2706, /**< Amount of substance, mole. */
youkee 0:1ad0e04b1bc5 119 BLE_GATT_UNIT_LUMINOUS_INTENSITY_CANDELA = 0x2707, /**< Luminous intensity, candela. */
youkee 0:1ad0e04b1bc5 120 BLE_GATT_UNIT_AREA_SQUARE_METRES = 0x2710, /**< Area, square metres. */
youkee 0:1ad0e04b1bc5 121 BLE_GATT_UNIT_VOLUME_CUBIC_METRES = 0x2711, /**< Volume, cubic metres. */
youkee 0:1ad0e04b1bc5 122 BLE_GATT_UNIT_VELOCITY_METRES_PER_SECOND = 0x2712, /**< Velocity, metres per second. */
youkee 0:1ad0e04b1bc5 123 BLE_GATT_UNIT_ACCELERATION_METRES_PER_SECOND_SQUARED = 0x2713, /**< Acceleration, metres per second squared. */
youkee 0:1ad0e04b1bc5 124 BLE_GATT_UNIT_WAVENUMBER_RECIPROCAL_METRE = 0x2714, /**< Wave number reciprocal, metre. */
youkee 0:1ad0e04b1bc5 125 BLE_GATT_UNIT_DENSITY_KILOGRAM_PER_CUBIC_METRE = 0x2715, /**< Density, kilogram per cubic metre. */
youkee 0:1ad0e04b1bc5 126 BLE_GATT_UNIT_SURFACE_DENSITY_KILOGRAM_PER_SQUARE_METRE = 0x2716, /**< */
youkee 0:1ad0e04b1bc5 127 BLE_GATT_UNIT_SPECIFIC_VOLUME_CUBIC_METRE_PER_KILOGRAM = 0x2717, /**< */
youkee 0:1ad0e04b1bc5 128 BLE_GATT_UNIT_CURRENT_DENSITY_AMPERE_PER_SQUARE_METRE = 0x2718, /**< */
youkee 0:1ad0e04b1bc5 129 BLE_GATT_UNIT_MAGNETIC_FIELD_STRENGTH_AMPERE_PER_METRE = 0x2719, /**< Magnetic field strength, ampere per metre. */
youkee 0:1ad0e04b1bc5 130 BLE_GATT_UNIT_AMOUNT_CONCENTRATION_MOLE_PER_CUBIC_METRE = 0x271A, /**< */
youkee 0:1ad0e04b1bc5 131 BLE_GATT_UNIT_MASS_CONCENTRATION_KILOGRAM_PER_CUBIC_METRE = 0x271B, /**< */
youkee 0:1ad0e04b1bc5 132 BLE_GATT_UNIT_LUMINANCE_CANDELA_PER_SQUARE_METRE = 0x271C, /**< */
youkee 0:1ad0e04b1bc5 133 BLE_GATT_UNIT_REFRACTIVE_INDEX = 0x271D, /**< */
youkee 0:1ad0e04b1bc5 134 BLE_GATT_UNIT_RELATIVE_PERMEABILITY = 0x271E, /**< */
youkee 0:1ad0e04b1bc5 135 BLE_GATT_UNIT_PLANE_ANGLE_RADIAN = 0x2720, /**< */
youkee 0:1ad0e04b1bc5 136 BLE_GATT_UNIT_SOLID_ANGLE_STERADIAN = 0x2721, /**< */
youkee 0:1ad0e04b1bc5 137 BLE_GATT_UNIT_FREQUENCY_HERTZ = 0x2722, /**< Frequency, hertz. */
youkee 0:1ad0e04b1bc5 138 BLE_GATT_UNIT_FORCE_NEWTON = 0x2723, /**< Force, newton. */
youkee 0:1ad0e04b1bc5 139 BLE_GATT_UNIT_PRESSURE_PASCAL = 0x2724, /**< Pressure, pascal. */
youkee 0:1ad0e04b1bc5 140 BLE_GATT_UNIT_ENERGY_JOULE = 0x2725, /**< Energy, joule. */
youkee 0:1ad0e04b1bc5 141 BLE_GATT_UNIT_POWER_WATT = 0x2726, /**< Power, watt. */
youkee 0:1ad0e04b1bc5 142 BLE_GATT_UNIT_ELECTRIC_CHARGE_COULOMB = 0x2727, /**< Electrical charge, coulomb. */
youkee 0:1ad0e04b1bc5 143 BLE_GATT_UNIT_ELECTRIC_POTENTIAL_DIFFERENCE_VOLT = 0x2728, /**< Electrical potential difference, voltage. */
youkee 0:1ad0e04b1bc5 144 BLE_GATT_UNIT_CAPACITANCE_FARAD = 0x2729, /**< */
youkee 0:1ad0e04b1bc5 145 BLE_GATT_UNIT_ELECTRIC_RESISTANCE_OHM = 0x272A, /**< */
youkee 0:1ad0e04b1bc5 146 BLE_GATT_UNIT_ELECTRIC_CONDUCTANCE_SIEMENS = 0x272B, /**< */
youkee 0:1ad0e04b1bc5 147 BLE_GATT_UNIT_MAGNETIC_FLEX_WEBER = 0x272C, /**< */
youkee 0:1ad0e04b1bc5 148 BLE_GATT_UNIT_MAGNETIC_FLEX_DENSITY_TESLA = 0x272D, /**< */
youkee 0:1ad0e04b1bc5 149 BLE_GATT_UNIT_INDUCTANCE_HENRY = 0x272E, /**< */
youkee 0:1ad0e04b1bc5 150 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_CELSIUS = 0x272F, /**< */
youkee 0:1ad0e04b1bc5 151 BLE_GATT_UNIT_LUMINOUS_FLUX_LUMEN = 0x2730, /**< */
youkee 0:1ad0e04b1bc5 152 BLE_GATT_UNIT_ILLUMINANCE_LUX = 0x2731, /**< */
youkee 0:1ad0e04b1bc5 153 BLE_GATT_UNIT_ACTIVITY_REFERRED_TO_A_RADIONUCLIDE_BECQUEREL = 0x2732, /**< */
youkee 0:1ad0e04b1bc5 154 BLE_GATT_UNIT_ABSORBED_DOSE_GRAY = 0x2733, /**< */
youkee 0:1ad0e04b1bc5 155 BLE_GATT_UNIT_DOSE_EQUIVALENT_SIEVERT = 0x2734, /**< */
youkee 0:1ad0e04b1bc5 156 BLE_GATT_UNIT_CATALYTIC_ACTIVITY_KATAL = 0x2735, /**< */
youkee 0:1ad0e04b1bc5 157 BLE_GATT_UNIT_DYNAMIC_VISCOSITY_PASCAL_SECOND = 0x2740, /**< */
youkee 0:1ad0e04b1bc5 158 BLE_GATT_UNIT_MOMENT_OF_FORCE_NEWTON_METRE = 0x2741, /**< */
youkee 0:1ad0e04b1bc5 159 BLE_GATT_UNIT_SURFACE_TENSION_NEWTON_PER_METRE = 0x2742, /**< */
youkee 0:1ad0e04b1bc5 160 BLE_GATT_UNIT_ANGULAR_VELOCITY_RADIAN_PER_SECOND = 0x2743, /**< */
youkee 0:1ad0e04b1bc5 161 BLE_GATT_UNIT_ANGULAR_ACCELERATION_RADIAN_PER_SECOND_SQUARED = 0x2744, /**< */
youkee 0:1ad0e04b1bc5 162 BLE_GATT_UNIT_HEAT_FLUX_DENSITY_WATT_PER_SQUARE_METRE = 0x2745, /**< */
youkee 0:1ad0e04b1bc5 163 BLE_GATT_UNIT_HEAT_CAPACITY_JOULE_PER_KELVIN = 0x2746, /**< */
youkee 0:1ad0e04b1bc5 164 BLE_GATT_UNIT_SPECIFIC_HEAT_CAPACITY_JOULE_PER_KILOGRAM_KELVIN = 0x2747, /**< */
youkee 0:1ad0e04b1bc5 165 BLE_GATT_UNIT_SPECIFIC_ENERGY_JOULE_PER_KILOGRAM = 0x2748, /**< */
youkee 0:1ad0e04b1bc5 166 BLE_GATT_UNIT_THERMAL_CONDUCTIVITY_WATT_PER_METRE_KELVIN = 0x2749, /**< */
youkee 0:1ad0e04b1bc5 167 BLE_GATT_UNIT_ENERGY_DENSITY_JOULE_PER_CUBIC_METRE = 0x274A, /**< */
youkee 0:1ad0e04b1bc5 168 BLE_GATT_UNIT_ELECTRIC_FIELD_STRENGTH_VOLT_PER_METRE = 0x274B, /**< */
youkee 0:1ad0e04b1bc5 169 BLE_GATT_UNIT_ELECTRIC_CHARGE_DENSITY_COULOMB_PER_CUBIC_METRE = 0x274C, /**< */
youkee 0:1ad0e04b1bc5 170 BLE_GATT_UNIT_SURFACE_CHARGE_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274D, /**< */
youkee 0:1ad0e04b1bc5 171 BLE_GATT_UNIT_ELECTRIC_FLUX_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274E, /**< */
youkee 0:1ad0e04b1bc5 172 BLE_GATT_UNIT_PERMITTIVITY_FARAD_PER_METRE = 0x274F, /**< */
youkee 0:1ad0e04b1bc5 173 BLE_GATT_UNIT_PERMEABILITY_HENRY_PER_METRE = 0x2750, /**< */
youkee 0:1ad0e04b1bc5 174 BLE_GATT_UNIT_MOLAR_ENERGY_JOULE_PER_MOLE = 0x2751, /**< */
youkee 0:1ad0e04b1bc5 175 BLE_GATT_UNIT_MOLAR_ENTROPY_JOULE_PER_MOLE_KELVIN = 0x2752, /**< */
youkee 0:1ad0e04b1bc5 176 BLE_GATT_UNIT_EXPOSURE_COULOMB_PER_KILOGRAM = 0x2753, /**< */
youkee 0:1ad0e04b1bc5 177 BLE_GATT_UNIT_ABSORBED_DOSE_RATE_GRAY_PER_SECOND = 0x2754, /**< */
youkee 0:1ad0e04b1bc5 178 BLE_GATT_UNIT_RADIANT_INTENSITY_WATT_PER_STERADIAN = 0x2755, /**< */
youkee 0:1ad0e04b1bc5 179 BLE_GATT_UNIT_RADIANCE_WATT_PER_SQUARE_METRE_STERADIAN = 0x2756, /**< */
youkee 0:1ad0e04b1bc5 180 BLE_GATT_UNIT_CATALYTIC_ACTIVITY_CONCENTRATION_KATAL_PER_CUBIC_METRE = 0x2757, /**< */
youkee 0:1ad0e04b1bc5 181 BLE_GATT_UNIT_TIME_MINUTE = 0x2760, /**< Time, minute. */
youkee 0:1ad0e04b1bc5 182 BLE_GATT_UNIT_TIME_HOUR = 0x2761, /**< Time, hour. */
youkee 0:1ad0e04b1bc5 183 BLE_GATT_UNIT_TIME_DAY = 0x2762, /**< Time, day. */
youkee 0:1ad0e04b1bc5 184 BLE_GATT_UNIT_PLANE_ANGLE_DEGREE = 0x2763, /**< */
youkee 0:1ad0e04b1bc5 185 BLE_GATT_UNIT_PLANE_ANGLE_MINUTE = 0x2764, /**< */
youkee 0:1ad0e04b1bc5 186 BLE_GATT_UNIT_PLANE_ANGLE_SECOND = 0x2765, /**< */
youkee 0:1ad0e04b1bc5 187 BLE_GATT_UNIT_AREA_HECTARE = 0x2766, /**< */
youkee 0:1ad0e04b1bc5 188 BLE_GATT_UNIT_VOLUME_LITRE = 0x2767, /**< */
youkee 0:1ad0e04b1bc5 189 BLE_GATT_UNIT_MASS_TONNE = 0x2768, /**< */
youkee 0:1ad0e04b1bc5 190 BLE_GATT_UNIT_PRESSURE_BAR = 0x2780, /**< Pressure, bar. */
youkee 0:1ad0e04b1bc5 191 BLE_GATT_UNIT_PRESSURE_MILLIMETRE_OF_MERCURY = 0x2781, /**< Pressure, millimetre of mercury. */
youkee 0:1ad0e04b1bc5 192 BLE_GATT_UNIT_LENGTH_ANGSTROM = 0x2782, /**< */
youkee 0:1ad0e04b1bc5 193 BLE_GATT_UNIT_LENGTH_NAUTICAL_MILE = 0x2783, /**< */
youkee 0:1ad0e04b1bc5 194 BLE_GATT_UNIT_AREA_BARN = 0x2784, /**< */
youkee 0:1ad0e04b1bc5 195 BLE_GATT_UNIT_VELOCITY_KNOT = 0x2785, /**< */
youkee 0:1ad0e04b1bc5 196 BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_NEPER = 0x2786, /**< */
youkee 0:1ad0e04b1bc5 197 BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_BEL = 0x2787, /**< */
youkee 0:1ad0e04b1bc5 198 BLE_GATT_UNIT_LENGTH_YARD = 0x27A0, /**< Length, yard. */
youkee 0:1ad0e04b1bc5 199 BLE_GATT_UNIT_LENGTH_PARSEC = 0x27A1, /**< Length, parsec. */
youkee 0:1ad0e04b1bc5 200 BLE_GATT_UNIT_LENGTH_INCH = 0x27A2, /**< Length, inch. */
youkee 0:1ad0e04b1bc5 201 BLE_GATT_UNIT_LENGTH_FOOT = 0x27A3, /**< Length, foot. */
youkee 0:1ad0e04b1bc5 202 BLE_GATT_UNIT_LENGTH_MILE = 0x27A4, /**< Length, mile. */
youkee 0:1ad0e04b1bc5 203 BLE_GATT_UNIT_PRESSURE_POUND_FORCE_PER_SQUARE_INCH = 0x27A5, /**< */
youkee 0:1ad0e04b1bc5 204 BLE_GATT_UNIT_VELOCITY_KILOMETRE_PER_HOUR = 0x27A6, /**< Velocity, kilometre per hour. */
youkee 0:1ad0e04b1bc5 205 BLE_GATT_UNIT_VELOCITY_MILE_PER_HOUR = 0x27A7, /**< Velocity, mile per hour. */
youkee 0:1ad0e04b1bc5 206 BLE_GATT_UNIT_ANGULAR_VELOCITY_REVOLUTION_PER_MINUTE = 0x27A8, /**< Angular Velocity, revolution per minute. */
youkee 0:1ad0e04b1bc5 207 BLE_GATT_UNIT_ENERGY_GRAM_CALORIE = 0x27A9, /**< Energy, gram calorie. */
youkee 0:1ad0e04b1bc5 208 BLE_GATT_UNIT_ENERGY_KILOGRAM_CALORIE = 0x27AA, /**< Energy, kilogram calorie. */
youkee 0:1ad0e04b1bc5 209 BLE_GATT_UNIT_ENERGY_KILOWATT_HOUR = 0x27AB, /**< Energy, killowatt hour. */
youkee 0:1ad0e04b1bc5 210 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_FAHRENHEIT = 0x27AC, /**< */
youkee 0:1ad0e04b1bc5 211 BLE_GATT_UNIT_PERCENTAGE = 0x27AD, /**< Percentage. */
youkee 0:1ad0e04b1bc5 212 BLE_GATT_UNIT_PER_MILLE = 0x27AE, /**< */
youkee 0:1ad0e04b1bc5 213 BLE_GATT_UNIT_PERIOD_BEATS_PER_MINUTE = 0x27AF, /**< */
youkee 0:1ad0e04b1bc5 214 BLE_GATT_UNIT_ELECTRIC_CHARGE_AMPERE_HOURS = 0x27B0, /**< */
youkee 0:1ad0e04b1bc5 215 BLE_GATT_UNIT_MASS_DENSITY_MILLIGRAM_PER_DECILITRE = 0x27B1, /**< */
youkee 0:1ad0e04b1bc5 216 BLE_GATT_UNIT_MASS_DENSITY_MILLIMOLE_PER_LITRE = 0x27B2, /**< */
youkee 0:1ad0e04b1bc5 217 BLE_GATT_UNIT_TIME_YEAR = 0x27B3, /**< Time, year. */
youkee 0:1ad0e04b1bc5 218 BLE_GATT_UNIT_TIME_MONTH = 0x27B4, /**< Time, month. */
youkee 0:1ad0e04b1bc5 219 BLE_GATT_UNIT_CONCENTRATION_COUNT_PER_CUBIC_METRE = 0x27B5, /**< */
youkee 0:1ad0e04b1bc5 220 BLE_GATT_UNIT_IRRADIANCE_WATT_PER_SQUARE_METRE = 0x27B6 /**< */
youkee 0:1ad0e04b1bc5 221 };
youkee 0:1ad0e04b1bc5 222
youkee 0:1ad0e04b1bc5 223 /**************************************************************************/
youkee 0:1ad0e04b1bc5 224 /*!
youkee 0:1ad0e04b1bc5 225 \brief Standard GATT number types.
youkee 0:1ad0e04b1bc5 226
youkee 0:1ad0e04b1bc5 227 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.2
youkee 0:1ad0e04b1bc5 228 \note See http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
youkee 0:1ad0e04b1bc5 229 */
youkee 0:1ad0e04b1bc5 230 /**************************************************************************/
youkee 0:1ad0e04b1bc5 231 enum {
youkee 0:1ad0e04b1bc5 232 BLE_GATT_FORMAT_RFU = 0x00, /**< Reserved for future use. */
youkee 0:1ad0e04b1bc5 233 BLE_GATT_FORMAT_BOOLEAN = 0x01, /**< Boolean. */
youkee 0:1ad0e04b1bc5 234 BLE_GATT_FORMAT_2BIT = 0x02, /**< Unsigned 2-bit integer. */
youkee 0:1ad0e04b1bc5 235 BLE_GATT_FORMAT_NIBBLE = 0x03, /**< Unsigned 4-bit integer. */
youkee 0:1ad0e04b1bc5 236 BLE_GATT_FORMAT_UINT8 = 0x04, /**< Unsigned 8-bit integer. */
youkee 0:1ad0e04b1bc5 237 BLE_GATT_FORMAT_UINT12 = 0x05, /**< Unsigned 12-bit integer. */
youkee 0:1ad0e04b1bc5 238 BLE_GATT_FORMAT_UINT16 = 0x06, /**< Unsigned 16-bit integer. */
youkee 0:1ad0e04b1bc5 239 BLE_GATT_FORMAT_UINT24 = 0x07, /**< Unsigned 24-bit integer. */
youkee 0:1ad0e04b1bc5 240 BLE_GATT_FORMAT_UINT32 = 0x08, /**< Unsigned 32-bit integer. */
youkee 0:1ad0e04b1bc5 241 BLE_GATT_FORMAT_UINT48 = 0x09, /**< Unsigned 48-bit integer. */
youkee 0:1ad0e04b1bc5 242 BLE_GATT_FORMAT_UINT64 = 0x0A, /**< Unsigned 64-bit integer. */
youkee 0:1ad0e04b1bc5 243 BLE_GATT_FORMAT_UINT128 = 0x0B, /**< Unsigned 128-bit integer. */
youkee 0:1ad0e04b1bc5 244 BLE_GATT_FORMAT_SINT8 = 0x0C, /**< Signed 2-bit integer. */
youkee 0:1ad0e04b1bc5 245 BLE_GATT_FORMAT_SINT12 = 0x0D, /**< Signed 12-bit integer. */
youkee 0:1ad0e04b1bc5 246 BLE_GATT_FORMAT_SINT16 = 0x0E, /**< Signed 16-bit integer. */
youkee 0:1ad0e04b1bc5 247 BLE_GATT_FORMAT_SINT24 = 0x0F, /**< Signed 24-bit integer. */
youkee 0:1ad0e04b1bc5 248 BLE_GATT_FORMAT_SINT32 = 0x10, /**< Signed 32-bit integer. */
youkee 0:1ad0e04b1bc5 249 BLE_GATT_FORMAT_SINT48 = 0x11, /**< Signed 48-bit integer. */
youkee 0:1ad0e04b1bc5 250 BLE_GATT_FORMAT_SINT64 = 0x12, /**< Signed 64-bit integer. */
youkee 0:1ad0e04b1bc5 251 BLE_GATT_FORMAT_SINT128 = 0x13, /**< Signed 128-bit integer. */
youkee 0:1ad0e04b1bc5 252 BLE_GATT_FORMAT_FLOAT32 = 0x14, /**< IEEE-754 32-bit floating point. */
youkee 0:1ad0e04b1bc5 253 BLE_GATT_FORMAT_FLOAT64 = 0x15, /**< IEEE-754 64-bit floating point. */
youkee 0:1ad0e04b1bc5 254 BLE_GATT_FORMAT_SFLOAT = 0x16, /**< IEEE-11073 16-bit SFLOAT. */
youkee 0:1ad0e04b1bc5 255 BLE_GATT_FORMAT_FLOAT = 0x17, /**< IEEE-11073 32-bit FLOAT. */
youkee 0:1ad0e04b1bc5 256 BLE_GATT_FORMAT_DUINT16 = 0x18, /**< IEEE-20601 format. */
youkee 0:1ad0e04b1bc5 257 BLE_GATT_FORMAT_UTF8S = 0x19, /**< UTF-8 string. */
youkee 0:1ad0e04b1bc5 258 BLE_GATT_FORMAT_UTF16S = 0x1A, /**< UTF-16 string. */
youkee 0:1ad0e04b1bc5 259 BLE_GATT_FORMAT_STRUCT = 0x1B /**< Opaque Structure. */
youkee 0:1ad0e04b1bc5 260 };
youkee 0:1ad0e04b1bc5 261
youkee 0:1ad0e04b1bc5 262 /**************************************************************************/
youkee 0:1ad0e04b1bc5 263 /*!
youkee 0:1ad0e04b1bc5 264 \brief Standard GATT characteristic properties.
youkee 0:1ad0e04b1bc5 265
youkee 0:1ad0e04b1bc5 266 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.1.1
youkee 0:1ad0e04b1bc5 267 and Section 3.3.3.1 for Extended Properties
youkee 0:1ad0e04b1bc5 268 */
youkee 0:1ad0e04b1bc5 269 /**************************************************************************/
youkee 0:1ad0e04b1bc5 270 enum Properties_t {
youkee 0:1ad0e04b1bc5 271 BLE_GATT_CHAR_PROPERTIES_NONE = 0x00,
youkee 0:1ad0e04b1bc5 272 BLE_GATT_CHAR_PROPERTIES_BROADCAST = 0x01, /**< Permits broadcasts of the characteristic value using the Server Characteristic Configuration descriptor. */
youkee 0:1ad0e04b1bc5 273 BLE_GATT_CHAR_PROPERTIES_READ = 0x02, /**< Permits reads of the characteristic value. */
youkee 0:1ad0e04b1bc5 274 BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE = 0x04, /**< Permits writes of the characteristic value without response. */
youkee 0:1ad0e04b1bc5 275 BLE_GATT_CHAR_PROPERTIES_WRITE = 0x08, /**< Permits writes of the characteristic value with response. */
youkee 0:1ad0e04b1bc5 276 BLE_GATT_CHAR_PROPERTIES_NOTIFY = 0x10, /**< Permits notifications of a characteristic value without acknowledgment. */
youkee 0:1ad0e04b1bc5 277 BLE_GATT_CHAR_PROPERTIES_INDICATE = 0x20, /**< Permits indications of a characteristic value with acknowledgment. */
youkee 0:1ad0e04b1bc5 278 BLE_GATT_CHAR_PROPERTIES_AUTHENTICATED_SIGNED_WRITES = 0x40, /**< Permits signed writes to the characteristic value. */
youkee 0:1ad0e04b1bc5 279 BLE_GATT_CHAR_PROPERTIES_EXTENDED_PROPERTIES = 0x80 /**< Additional characteristic properties are defined in the Characteristic Extended Properties descriptor */
youkee 0:1ad0e04b1bc5 280 };
youkee 0:1ad0e04b1bc5 281
youkee 0:1ad0e04b1bc5 282 /**************************************************************************/
youkee 0:1ad0e04b1bc5 283 /*!
youkee 0:1ad0e04b1bc5 284 \brief GATT presentation format wrapper
youkee 0:1ad0e04b1bc5 285
youkee 0:1ad0e04b1bc5 286 \note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5
youkee 0:1ad0e04b1bc5 287 \note See https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
youkee 0:1ad0e04b1bc5 288 */
youkee 0:1ad0e04b1bc5 289 /**************************************************************************/
youkee 0:1ad0e04b1bc5 290 struct PresentationFormat_t {
youkee 0:1ad0e04b1bc5 291 uint8_t gatt_format; /**< Format of the value; see @ref ble_gatt_format_t. */
youkee 0:1ad0e04b1bc5 292 int8_t exponent; /**< Exponent for integer data types. Example: if Exponent = -3 and the char value is 3892, the actual value is 3.892 */
youkee 0:1ad0e04b1bc5 293 uint16_t gatt_unit; /**< UUID from Bluetooth Assigned Numbers; see @ref ble_gatt_unit_t. */
youkee 0:1ad0e04b1bc5 294 uint8_t gatt_namespace; /**< Namespace from Bluetooth Assigned Numbers, normally '1'; see @ref BLE_GATT_CPF_NAMESPACES. */
youkee 0:1ad0e04b1bc5 295 uint16_t gatt_nsdesc; /**< Namespace description from Bluetooth Assigned Numbers, normally '0'; see @ref BLE_GATT_CPF_NAMESPACES. */
youkee 0:1ad0e04b1bc5 296 };
youkee 0:1ad0e04b1bc5 297
youkee 0:1ad0e04b1bc5 298 /**
youkee 0:1ad0e04b1bc5 299 * @brief Creates a new GattCharacteristic using the specified 16-bit
youkee 0:1ad0e04b1bc5 300 * UUID, value length, and properties.
youkee 0:1ad0e04b1bc5 301 *
youkee 0:1ad0e04b1bc5 302 * @note The UUID value must be unique in the service and is normally >1.
youkee 0:1ad0e04b1bc5 303 *
youkee 0:1ad0e04b1bc5 304 * @param[in] uuid
youkee 0:1ad0e04b1bc5 305 * The UUID to use for this characteristic.
youkee 0:1ad0e04b1bc5 306 * @param[in] valuePtr
youkee 0:1ad0e04b1bc5 307 * The memory holding the initial value. The value is copied
youkee 0:1ad0e04b1bc5 308 * into the stack when the enclosing service is added, and
youkee 0:1ad0e04b1bc5 309 * is thereafter maintained internally by the stack.
youkee 0:1ad0e04b1bc5 310 * @param[in] len
youkee 0:1ad0e04b1bc5 311 * The length in bytes of this characteristic's value.
youkee 0:1ad0e04b1bc5 312 * @param[in] maxLen
youkee 0:1ad0e04b1bc5 313 * The max length in bytes of this characteristic's value.
youkee 0:1ad0e04b1bc5 314 * @param[in] hasVariableLen
youkee 0:1ad0e04b1bc5 315 * Whether the attribute's value length changes over time.
youkee 0:1ad0e04b1bc5 316 * @param[in] props
youkee 0:1ad0e04b1bc5 317 * The 8-bit field containing the characteristic's properties.
youkee 0:1ad0e04b1bc5 318 * @param[in] descriptors
youkee 0:1ad0e04b1bc5 319 * A pointer to an array of descriptors to be included within
youkee 0:1ad0e04b1bc5 320 * this characteristic. The memory for the descriptor array is
youkee 0:1ad0e04b1bc5 321 * owned by the caller, and should remain valid at least until
youkee 0:1ad0e04b1bc5 322 * the enclosing service is added to the GATT table.
youkee 0:1ad0e04b1bc5 323 * @param[in] numDescriptors
youkee 0:1ad0e04b1bc5 324 * The number of descriptors in the previous array.
youkee 0:1ad0e04b1bc5 325 *
youkee 0:1ad0e04b1bc5 326 * @NOTE: If valuePtr == NULL, length == 0, and properties == READ
youkee 0:1ad0e04b1bc5 327 * for the value attribute of a characteristic, then that particular
youkee 0:1ad0e04b1bc5 328 * characteristic may be considered optional and dropped while
youkee 0:1ad0e04b1bc5 329 * instantiating the service with the underlying BLE stack.
youkee 0:1ad0e04b1bc5 330 */
youkee 0:1ad0e04b1bc5 331 GattCharacteristic(const UUID &uuid,
youkee 0:1ad0e04b1bc5 332 uint8_t *valuePtr = NULL,
youkee 0:1ad0e04b1bc5 333 uint16_t len = 0,
youkee 0:1ad0e04b1bc5 334 uint16_t maxLen = 0,
youkee 0:1ad0e04b1bc5 335 uint8_t props = BLE_GATT_CHAR_PROPERTIES_NONE,
youkee 0:1ad0e04b1bc5 336 GattAttribute *descriptors[] = NULL,
youkee 0:1ad0e04b1bc5 337 unsigned numDescriptors = 0,
youkee 0:1ad0e04b1bc5 338 bool hasVariableLen = true) :
youkee 0:1ad0e04b1bc5 339 _valueAttribute(uuid, valuePtr, len, maxLen, hasVariableLen),
youkee 0:1ad0e04b1bc5 340 _properties(props),
youkee 0:1ad0e04b1bc5 341 _requiredSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK),
youkee 0:1ad0e04b1bc5 342 _descriptors(descriptors),
youkee 0:1ad0e04b1bc5 343 _descriptorCount(numDescriptors),
youkee 0:1ad0e04b1bc5 344 enabledReadAuthorization(false),
youkee 0:1ad0e04b1bc5 345 enabledWriteAuthorization(false),
youkee 0:1ad0e04b1bc5 346 readAuthorizationCallback(),
youkee 0:1ad0e04b1bc5 347 writeAuthorizationCallback() {
youkee 0:1ad0e04b1bc5 348 /* empty */
youkee 0:1ad0e04b1bc5 349 }
youkee 0:1ad0e04b1bc5 350
youkee 0:1ad0e04b1bc5 351 public:
youkee 0:1ad0e04b1bc5 352 /**
youkee 0:1ad0e04b1bc5 353 * Set up the minimum security (mode and level) requirements for access to the characteristic's value attribute.
youkee 0:1ad0e04b1bc5 354 *
youkee 0:1ad0e04b1bc5 355 * @param securityMode Can be one of encryption or signing, with or without protection for man in the middle attacks (MITM).
youkee 0:1ad0e04b1bc5 356 */
youkee 0:1ad0e04b1bc5 357 void requireSecurity(SecurityManager::SecurityMode_t securityMode) {
youkee 0:1ad0e04b1bc5 358 _requiredSecurity = securityMode;
youkee 0:1ad0e04b1bc5 359 }
youkee 0:1ad0e04b1bc5 360
youkee 0:1ad0e04b1bc5 361 public:
youkee 0:1ad0e04b1bc5 362 /**
youkee 0:1ad0e04b1bc5 363 * Authorization.
youkee 0:1ad0e04b1bc5 364 */
youkee 0:1ad0e04b1bc5 365 void setWriteAuthorizationCallback(void (*callback)(GattWriteAuthCallbackParams *)) {
youkee 0:1ad0e04b1bc5 366 writeAuthorizationCallback.attach(callback);
youkee 0:1ad0e04b1bc5 367 enabledWriteAuthorization = true;
youkee 0:1ad0e04b1bc5 368 }
youkee 0:1ad0e04b1bc5 369 template <typename T>
youkee 0:1ad0e04b1bc5 370 void setWriteAuthorizationCallback(T *object, void (T::*member)(GattWriteAuthCallbackParams *)) {
youkee 0:1ad0e04b1bc5 371 writeAuthorizationCallback.attach(object, member);
youkee 0:1ad0e04b1bc5 372 enabledWriteAuthorization = true;
youkee 0:1ad0e04b1bc5 373 }
youkee 0:1ad0e04b1bc5 374 void setReadAuthorizationCallback(void (*callback)(GattReadAuthCallbackParams *)) {
youkee 0:1ad0e04b1bc5 375 readAuthorizationCallback.attach(callback);
youkee 0:1ad0e04b1bc5 376 enabledReadAuthorization = true;
youkee 0:1ad0e04b1bc5 377 }
youkee 0:1ad0e04b1bc5 378 template <typename T>
youkee 0:1ad0e04b1bc5 379 void setReadAuthorizationCallback(T *object, void (T::*member)(GattReadAuthCallbackParams *)) {
youkee 0:1ad0e04b1bc5 380 readAuthorizationCallback.attach(object, member);
youkee 0:1ad0e04b1bc5 381 enabledReadAuthorization = true;
youkee 0:1ad0e04b1bc5 382 }
youkee 0:1ad0e04b1bc5 383
youkee 0:1ad0e04b1bc5 384 /**
youkee 0:1ad0e04b1bc5 385 * Helper function meant to be called from the guts of the BLE stack to
youkee 0:1ad0e04b1bc5 386 * determine the authorization reply for a write request.
youkee 0:1ad0e04b1bc5 387 * @param params To capture the context of the write-auth request. Also contains an out-parameter for reply.
youkee 0:1ad0e04b1bc5 388 * @return true if the write is authorized to proceed.
youkee 0:1ad0e04b1bc5 389 */
youkee 0:1ad0e04b1bc5 390 GattAuthCallbackReply_t authorizeWrite(GattWriteAuthCallbackParams *params) {
youkee 0:1ad0e04b1bc5 391 if (!isWriteAuthorizationEnabled()) {
youkee 0:1ad0e04b1bc5 392 return AUTH_CALLBACK_REPLY_SUCCESS;
youkee 0:1ad0e04b1bc5 393 }
youkee 0:1ad0e04b1bc5 394
youkee 0:1ad0e04b1bc5 395 params->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS; /* Initialized to no-error by default. */
youkee 0:1ad0e04b1bc5 396 writeAuthorizationCallback.call(params);
youkee 0:1ad0e04b1bc5 397 return params->authorizationReply;
youkee 0:1ad0e04b1bc5 398 }
youkee 0:1ad0e04b1bc5 399
youkee 0:1ad0e04b1bc5 400 /**
youkee 0:1ad0e04b1bc5 401 * Helper function meant to be called from the guts of the BLE stack to
youkee 0:1ad0e04b1bc5 402 * determine the authorization reply for a read request.
youkee 0:1ad0e04b1bc5 403 * @param params To capture the context of the read-auth request.
youkee 0:1ad0e04b1bc5 404 *
youkee 0:1ad0e04b1bc5 405 * @NOTE: To authorize or deny the read the params->authorizationReply field
youkee 0:1ad0e04b1bc5 406 * should be set to true (authorize) or false (deny).
youkee 0:1ad0e04b1bc5 407 *
youkee 0:1ad0e04b1bc5 408 * If the read is approved and params->data is unchanged (NULL),
youkee 0:1ad0e04b1bc5 409 * the current characteristic value will be used.
youkee 0:1ad0e04b1bc5 410 *
youkee 0:1ad0e04b1bc5 411 * If the read is approved, a new value can be provided by setting
youkee 0:1ad0e04b1bc5 412 * the params->data pointer and params->len fields.
youkee 0:1ad0e04b1bc5 413 *
youkee 0:1ad0e04b1bc5 414 * @return true if the read is authorized to proceed.
youkee 0:1ad0e04b1bc5 415 */
youkee 0:1ad0e04b1bc5 416 GattAuthCallbackReply_t authorizeRead(GattReadAuthCallbackParams *params) {
youkee 0:1ad0e04b1bc5 417 if (!isReadAuthorizationEnabled()) {
youkee 0:1ad0e04b1bc5 418 return AUTH_CALLBACK_REPLY_SUCCESS;
youkee 0:1ad0e04b1bc5 419 }
youkee 0:1ad0e04b1bc5 420
youkee 0:1ad0e04b1bc5 421 params->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS; /* Initialized to no-error by default. */
youkee 0:1ad0e04b1bc5 422 readAuthorizationCallback.call(params);
youkee 0:1ad0e04b1bc5 423 return params->authorizationReply;
youkee 0:1ad0e04b1bc5 424 }
youkee 0:1ad0e04b1bc5 425
youkee 0:1ad0e04b1bc5 426 /* accessors */
youkee 0:1ad0e04b1bc5 427 public:
youkee 0:1ad0e04b1bc5 428 GattAttribute& getValueAttribute() {return _valueAttribute; }
youkee 0:1ad0e04b1bc5 429 const GattAttribute& getValueAttribute() const {return _valueAttribute; }
youkee 0:1ad0e04b1bc5 430 GattAttribute::Handle_t getValueHandle(void) const {return getValueAttribute().getHandle();}
youkee 0:1ad0e04b1bc5 431 uint8_t getProperties(void) const {return _properties; }
youkee 0:1ad0e04b1bc5 432 SecurityManager::SecurityMode_t getRequiredSecurity() const {return _requiredSecurity; }
youkee 0:1ad0e04b1bc5 433 uint8_t getDescriptorCount(void) const {return _descriptorCount; }
youkee 0:1ad0e04b1bc5 434 bool isReadAuthorizationEnabled() const {return enabledReadAuthorization; }
youkee 0:1ad0e04b1bc5 435 bool isWriteAuthorizationEnabled() const {return enabledWriteAuthorization; }
youkee 0:1ad0e04b1bc5 436
youkee 0:1ad0e04b1bc5 437 GattAttribute *getDescriptor(uint8_t index) {
youkee 0:1ad0e04b1bc5 438 if (index >= _descriptorCount) {
youkee 0:1ad0e04b1bc5 439 return NULL;
youkee 0:1ad0e04b1bc5 440 }
youkee 0:1ad0e04b1bc5 441
youkee 0:1ad0e04b1bc5 442 return _descriptors[index];
youkee 0:1ad0e04b1bc5 443 }
youkee 0:1ad0e04b1bc5 444
youkee 0:1ad0e04b1bc5 445 private:
youkee 0:1ad0e04b1bc5 446 GattAttribute _valueAttribute;
youkee 0:1ad0e04b1bc5 447 uint8_t _properties;
youkee 0:1ad0e04b1bc5 448 SecurityManager::SecurityMode_t _requiredSecurity;
youkee 0:1ad0e04b1bc5 449 GattAttribute **_descriptors;
youkee 0:1ad0e04b1bc5 450 uint8_t _descriptorCount;
youkee 0:1ad0e04b1bc5 451
youkee 0:1ad0e04b1bc5 452 bool enabledReadAuthorization;
youkee 0:1ad0e04b1bc5 453 bool enabledWriteAuthorization;
youkee 0:1ad0e04b1bc5 454 FunctionPointerWithContext<GattReadAuthCallbackParams *> readAuthorizationCallback;
youkee 0:1ad0e04b1bc5 455 FunctionPointerWithContext<GattWriteAuthCallbackParams *> writeAuthorizationCallback;
youkee 0:1ad0e04b1bc5 456
youkee 0:1ad0e04b1bc5 457 private:
youkee 0:1ad0e04b1bc5 458 /* Disallow copy and assignment. */
youkee 0:1ad0e04b1bc5 459 GattCharacteristic(const GattCharacteristic &);
youkee 0:1ad0e04b1bc5 460 GattCharacteristic& operator=(const GattCharacteristic &);
youkee 0:1ad0e04b1bc5 461 };
youkee 0:1ad0e04b1bc5 462
youkee 0:1ad0e04b1bc5 463 template <typename T>
youkee 0:1ad0e04b1bc5 464 class ReadOnlyGattCharacteristic : public GattCharacteristic {
youkee 0:1ad0e04b1bc5 465 public:
youkee 0:1ad0e04b1bc5 466 ReadOnlyGattCharacteristic<T>(const UUID &uuid,
youkee 0:1ad0e04b1bc5 467 T *valuePtr,
youkee 0:1ad0e04b1bc5 468 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
youkee 0:1ad0e04b1bc5 469 GattAttribute *descriptors[] = NULL,
youkee 0:1ad0e04b1bc5 470 unsigned numDescriptors = 0) :
youkee 0:1ad0e04b1bc5 471 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
youkee 0:1ad0e04b1bc5 472 BLE_GATT_CHAR_PROPERTIES_READ | additionalProperties, descriptors, numDescriptors, false) {
youkee 0:1ad0e04b1bc5 473 /* empty */
youkee 0:1ad0e04b1bc5 474 }
youkee 0:1ad0e04b1bc5 475 };
youkee 0:1ad0e04b1bc5 476
youkee 0:1ad0e04b1bc5 477 template <typename T>
youkee 0:1ad0e04b1bc5 478 class WriteOnlyGattCharacteristic : public GattCharacteristic {
youkee 0:1ad0e04b1bc5 479 public:
youkee 0:1ad0e04b1bc5 480 WriteOnlyGattCharacteristic<T>(const UUID &uuid,
youkee 0:1ad0e04b1bc5 481 T *valuePtr,
youkee 0:1ad0e04b1bc5 482 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
youkee 0:1ad0e04b1bc5 483 GattAttribute *descriptors[] = NULL,
youkee 0:1ad0e04b1bc5 484 unsigned numDescriptors = 0) :
youkee 0:1ad0e04b1bc5 485 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
youkee 0:1ad0e04b1bc5 486 BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
youkee 0:1ad0e04b1bc5 487 /* empty */
youkee 0:1ad0e04b1bc5 488 }
youkee 0:1ad0e04b1bc5 489 };
youkee 0:1ad0e04b1bc5 490
youkee 0:1ad0e04b1bc5 491 template <typename T>
youkee 0:1ad0e04b1bc5 492 class ReadWriteGattCharacteristic : public GattCharacteristic {
youkee 0:1ad0e04b1bc5 493 public:
youkee 0:1ad0e04b1bc5 494 ReadWriteGattCharacteristic<T>(const UUID &uuid,
youkee 0:1ad0e04b1bc5 495 T *valuePtr,
youkee 0:1ad0e04b1bc5 496 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
youkee 0:1ad0e04b1bc5 497 GattAttribute *descriptors[] = NULL,
youkee 0:1ad0e04b1bc5 498 unsigned numDescriptors = 0) :
youkee 0:1ad0e04b1bc5 499 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
youkee 0:1ad0e04b1bc5 500 BLE_GATT_CHAR_PROPERTIES_READ | BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
youkee 0:1ad0e04b1bc5 501 /* empty */
youkee 0:1ad0e04b1bc5 502 }
youkee 0:1ad0e04b1bc5 503 };
youkee 0:1ad0e04b1bc5 504
youkee 0:1ad0e04b1bc5 505 template <typename T, unsigned NUM_ELEMENTS>
youkee 0:1ad0e04b1bc5 506 class WriteOnlyArrayGattCharacteristic : public GattCharacteristic {
youkee 0:1ad0e04b1bc5 507 public:
youkee 0:1ad0e04b1bc5 508 WriteOnlyArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
youkee 0:1ad0e04b1bc5 509 T valuePtr[NUM_ELEMENTS],
youkee 0:1ad0e04b1bc5 510 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
youkee 0:1ad0e04b1bc5 511 GattAttribute *descriptors[] = NULL,
youkee 0:1ad0e04b1bc5 512 unsigned numDescriptors = 0) :
youkee 0:1ad0e04b1bc5 513 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
youkee 0:1ad0e04b1bc5 514 BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
youkee 0:1ad0e04b1bc5 515 /* empty */
youkee 0:1ad0e04b1bc5 516 }
youkee 0:1ad0e04b1bc5 517 };
youkee 0:1ad0e04b1bc5 518
youkee 0:1ad0e04b1bc5 519 template <typename T, unsigned NUM_ELEMENTS>
youkee 0:1ad0e04b1bc5 520 class ReadOnlyArrayGattCharacteristic : public GattCharacteristic {
youkee 0:1ad0e04b1bc5 521 public:
youkee 0:1ad0e04b1bc5 522 ReadOnlyArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
youkee 0:1ad0e04b1bc5 523 T valuePtr[NUM_ELEMENTS],
youkee 0:1ad0e04b1bc5 524 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
youkee 0:1ad0e04b1bc5 525 GattAttribute *descriptors[] = NULL,
youkee 0:1ad0e04b1bc5 526 unsigned numDescriptors = 0) :
youkee 0:1ad0e04b1bc5 527 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
youkee 0:1ad0e04b1bc5 528 BLE_GATT_CHAR_PROPERTIES_READ | additionalProperties, descriptors, numDescriptors, false) {
youkee 0:1ad0e04b1bc5 529 /* empty */
youkee 0:1ad0e04b1bc5 530 }
youkee 0:1ad0e04b1bc5 531 };
youkee 0:1ad0e04b1bc5 532
youkee 0:1ad0e04b1bc5 533 template <typename T, unsigned NUM_ELEMENTS>
youkee 0:1ad0e04b1bc5 534 class ReadWriteArrayGattCharacteristic : public GattCharacteristic {
youkee 0:1ad0e04b1bc5 535 public:
youkee 0:1ad0e04b1bc5 536 ReadWriteArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
youkee 0:1ad0e04b1bc5 537 T valuePtr[NUM_ELEMENTS],
youkee 0:1ad0e04b1bc5 538 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
youkee 0:1ad0e04b1bc5 539 GattAttribute *descriptors[] = NULL,
youkee 0:1ad0e04b1bc5 540 unsigned numDescriptors = 0) :
youkee 0:1ad0e04b1bc5 541 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
youkee 0:1ad0e04b1bc5 542 BLE_GATT_CHAR_PROPERTIES_READ | BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
youkee 0:1ad0e04b1bc5 543 /* empty */
youkee 0:1ad0e04b1bc5 544 }
youkee 0:1ad0e04b1bc5 545 };
youkee 0:1ad0e04b1bc5 546
youkee 0:1ad0e04b1bc5 547 #endif // ifndef __GATT_CHARACTERISTIC_H__