ON Semiconductor / mbed-os

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.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/FEATURE_BLE/ble/GattCharacteristic.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1 /* mbed Microcontroller Library
group-onsemi 0:098463de4c5d 2 * Copyright (c) 2006-2013 ARM Limited
group-onsemi 0:098463de4c5d 3 *
group-onsemi 0:098463de4c5d 4 * Licensed under the Apache License, Version 2.0 (the "License");
group-onsemi 0:098463de4c5d 5 * you may not use this file except in compliance with the License.
group-onsemi 0:098463de4c5d 6 * You may obtain a copy of the License at
group-onsemi 0:098463de4c5d 7 *
group-onsemi 0:098463de4c5d 8 * http://www.apache.org/licenses/LICENSE-2.0
group-onsemi 0:098463de4c5d 9 *
group-onsemi 0:098463de4c5d 10 * Unless required by applicable law or agreed to in writing, software
group-onsemi 0:098463de4c5d 11 * distributed under the License is distributed on an "AS IS" BASIS,
group-onsemi 0:098463de4c5d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-onsemi 0:098463de4c5d 13 * See the License for the specific language governing permissions and
group-onsemi 0:098463de4c5d 14 * limitations under the License.
group-onsemi 0:098463de4c5d 15 */
group-onsemi 0:098463de4c5d 16
group-onsemi 0:098463de4c5d 17 #ifndef __GATT_CHARACTERISTIC_H__
group-onsemi 0:098463de4c5d 18 #define __GATT_CHARACTERISTIC_H__
group-onsemi 0:098463de4c5d 19
group-onsemi 0:098463de4c5d 20 #include "Gap.h"
group-onsemi 0:098463de4c5d 21 #include "SecurityManager.h"
group-onsemi 0:098463de4c5d 22 #include "GattAttribute.h"
group-onsemi 0:098463de4c5d 23 #include "GattCallbackParamTypes.h"
group-onsemi 0:098463de4c5d 24 #include "FunctionPointerWithContext.h"
group-onsemi 0:098463de4c5d 25
group-onsemi 0:098463de4c5d 26 class GattCharacteristic {
group-onsemi 0:098463de4c5d 27 public:
group-onsemi 0:098463de4c5d 28 enum {
group-onsemi 0:098463de4c5d 29 UUID_BATTERY_LEVEL_STATE_CHAR = 0x2A1B,
group-onsemi 0:098463de4c5d 30 UUID_BATTERY_POWER_STATE_CHAR = 0x2A1A,
group-onsemi 0:098463de4c5d 31 UUID_REMOVABLE_CHAR = 0x2A3A,
group-onsemi 0:098463de4c5d 32 UUID_SERVICE_REQUIRED_CHAR = 0x2A3B,
group-onsemi 0:098463de4c5d 33 UUID_ALERT_CATEGORY_ID_CHAR = 0x2A43,
group-onsemi 0:098463de4c5d 34 UUID_ALERT_CATEGORY_ID_BIT_MASK_CHAR = 0x2A42,
group-onsemi 0:098463de4c5d 35 UUID_ALERT_LEVEL_CHAR = 0x2A06,
group-onsemi 0:098463de4c5d 36 UUID_ALERT_NOTIFICATION_CONTROL_POINT_CHAR = 0x2A44,
group-onsemi 0:098463de4c5d 37 UUID_ALERT_STATUS_CHAR = 0x2A3F,
group-onsemi 0:098463de4c5d 38 UUID_BATTERY_LEVEL_CHAR = 0x2A19,
group-onsemi 0:098463de4c5d 39 UUID_BLOOD_PRESSURE_FEATURE_CHAR = 0x2A49,
group-onsemi 0:098463de4c5d 40 UUID_BLOOD_PRESSURE_MEASUREMENT_CHAR = 0x2A35,
group-onsemi 0:098463de4c5d 41 UUID_BODY_SENSOR_LOCATION_CHAR = 0x2A38,
group-onsemi 0:098463de4c5d 42 UUID_BOOT_KEYBOARD_INPUT_REPORT_CHAR = 0x2A22,
group-onsemi 0:098463de4c5d 43 UUID_BOOT_KEYBOARD_OUTPUT_REPORT_CHAR = 0x2A32,
group-onsemi 0:098463de4c5d 44 UUID_BOOT_MOUSE_INPUT_REPORT_CHAR = 0x2A33,
group-onsemi 0:098463de4c5d 45 UUID_CURRENT_TIME_CHAR = 0x2A2B,
group-onsemi 0:098463de4c5d 46 UUID_DATE_TIME_CHAR = 0x2A08,
group-onsemi 0:098463de4c5d 47 UUID_DAY_DATE_TIME_CHAR = 0x2A0A,
group-onsemi 0:098463de4c5d 48 UUID_DAY_OF_WEEK_CHAR = 0x2A09,
group-onsemi 0:098463de4c5d 49 UUID_DST_OFFSET_CHAR = 0x2A0D,
group-onsemi 0:098463de4c5d 50 UUID_EXACT_TIME_256_CHAR = 0x2A0C,
group-onsemi 0:098463de4c5d 51 UUID_FIRMWARE_REVISION_STRING_CHAR = 0x2A26,
group-onsemi 0:098463de4c5d 52 UUID_GLUCOSE_FEATURE_CHAR = 0x2A51,
group-onsemi 0:098463de4c5d 53 UUID_GLUCOSE_MEASUREMENT_CHAR = 0x2A18,
group-onsemi 0:098463de4c5d 54 UUID_GLUCOSE_MEASUREMENT_CONTEXT_CHAR = 0x2A34,
group-onsemi 0:098463de4c5d 55 UUID_HARDWARE_REVISION_STRING_CHAR = 0x2A27,
group-onsemi 0:098463de4c5d 56 UUID_HEART_RATE_CONTROL_POINT_CHAR = 0x2A39,
group-onsemi 0:098463de4c5d 57 UUID_HEART_RATE_MEASUREMENT_CHAR = 0x2A37,
group-onsemi 0:098463de4c5d 58 UUID_HID_CONTROL_POINT_CHAR = 0x2A4C,
group-onsemi 0:098463de4c5d 59 UUID_HID_INFORMATION_CHAR = 0x2A4A,
group-onsemi 0:098463de4c5d 60 UUID_HUMIDITY_CHAR = 0x2A6F,
group-onsemi 0:098463de4c5d 61 UUID_IEEE_REGULATORY_CERTIFICATION_DATA_LIST_CHAR = 0x2A2A,
group-onsemi 0:098463de4c5d 62 UUID_INTERMEDIATE_CUFF_PRESSURE_CHAR = 0x2A36,
group-onsemi 0:098463de4c5d 63 UUID_INTERMEDIATE_TEMPERATURE_CHAR = 0x2A1E,
group-onsemi 0:098463de4c5d 64 UUID_LOCAL_TIME_INFORMATION_CHAR = 0x2A0F,
group-onsemi 0:098463de4c5d 65 UUID_MANUFACTURER_NAME_STRING_CHAR = 0x2A29,
group-onsemi 0:098463de4c5d 66 UUID_MEASUREMENT_INTERVAL_CHAR = 0x2A21,
group-onsemi 0:098463de4c5d 67 UUID_MODEL_NUMBER_STRING_CHAR = 0x2A24,
group-onsemi 0:098463de4c5d 68 UUID_UNREAD_ALERT_CHAR = 0x2A45,
group-onsemi 0:098463de4c5d 69 UUID_NEW_ALERT_CHAR = 0x2A46,
group-onsemi 0:098463de4c5d 70 UUID_PNP_ID_CHAR = 0x2A50,
group-onsemi 0:098463de4c5d 71 UUID_PRESSURE_CHAR = 0x2A6D,
group-onsemi 0:098463de4c5d 72 UUID_PROTOCOL_MODE_CHAR = 0x2A4E,
group-onsemi 0:098463de4c5d 73 UUID_RECORD_ACCESS_CONTROL_POINT_CHAR = 0x2A52,
group-onsemi 0:098463de4c5d 74 UUID_REFERENCE_TIME_INFORMATION_CHAR = 0x2A14,
group-onsemi 0:098463de4c5d 75 UUID_REPORT_CHAR = 0x2A4D,
group-onsemi 0:098463de4c5d 76 UUID_REPORT_MAP_CHAR = 0x2A4B,
group-onsemi 0:098463de4c5d 77 UUID_RINGER_CONTROL_POINT_CHAR = 0x2A40,
group-onsemi 0:098463de4c5d 78 UUID_RINGER_SETTING_CHAR = 0x2A41,
group-onsemi 0:098463de4c5d 79 UUID_SCAN_INTERVAL_WINDOW_CHAR = 0x2A4F,
group-onsemi 0:098463de4c5d 80 UUID_SCAN_REFRESH_CHAR = 0x2A31,
group-onsemi 0:098463de4c5d 81 UUID_SERIAL_NUMBER_STRING_CHAR = 0x2A25,
group-onsemi 0:098463de4c5d 82 UUID_SOFTWARE_REVISION_STRING_CHAR = 0x2A28,
group-onsemi 0:098463de4c5d 83 UUID_SUPPORTED_NEW_ALERT_CATEGORY_CHAR = 0x2A47,
group-onsemi 0:098463de4c5d 84 UUID_SUPPORTED_UNREAD_ALERT_CATEGORY_CHAR = 0x2A48,
group-onsemi 0:098463de4c5d 85 UUID_SYSTEM_ID_CHAR = 0x2A23,
group-onsemi 0:098463de4c5d 86 UUID_TEMPERATURE_CHAR = 0x2A6E,
group-onsemi 0:098463de4c5d 87 UUID_TEMPERATURE_MEASUREMENT_CHAR = 0x2A1C,
group-onsemi 0:098463de4c5d 88 UUID_TEMPERATURE_TYPE_CHAR = 0x2A1D,
group-onsemi 0:098463de4c5d 89 UUID_TIME_ACCURACY_CHAR = 0x2A12,
group-onsemi 0:098463de4c5d 90 UUID_TIME_SOURCE_CHAR = 0x2A13,
group-onsemi 0:098463de4c5d 91 UUID_TIME_UPDATE_CONTROL_POINT_CHAR = 0x2A16,
group-onsemi 0:098463de4c5d 92 UUID_TIME_UPDATE_STATE_CHAR = 0x2A17,
group-onsemi 0:098463de4c5d 93 UUID_TIME_WITH_DST_CHAR = 0x2A11,
group-onsemi 0:098463de4c5d 94 UUID_TIME_ZONE_CHAR = 0x2A0E,
group-onsemi 0:098463de4c5d 95 UUID_TX_POWER_LEVEL_CHAR = 0x2A07,
group-onsemi 0:098463de4c5d 96 UUID_CSC_FEATURE_CHAR = 0x2A5C,
group-onsemi 0:098463de4c5d 97 UUID_CSC_MEASUREMENT_CHAR = 0x2A5B,
group-onsemi 0:098463de4c5d 98 UUID_RSC_FEATURE_CHAR = 0x2A54,
group-onsemi 0:098463de4c5d 99 UUID_RSC_MEASUREMENT_CHAR = 0x2A53
group-onsemi 0:098463de4c5d 100 };
group-onsemi 0:098463de4c5d 101
group-onsemi 0:098463de4c5d 102 /**
group-onsemi 0:098463de4c5d 103 * @brief Standard GATT characteristic presentation format unit types.
group-onsemi 0:098463de4c5d 104 * These unit types are used to describe what the raw numeric
group-onsemi 0:098463de4c5d 105 * data in a characteristic actually represents.
group-onsemi 0:098463de4c5d 106 *
group-onsemi 0:098463de4c5d 107 * @note See https://developer.bluetooth.org/gatt/units/Pages/default.aspx
group-onsemi 0:098463de4c5d 108 */
group-onsemi 0:098463de4c5d 109 enum {
group-onsemi 0:098463de4c5d 110 BLE_GATT_UNIT_NONE = 0x2700, /**< No specified unit type. */
group-onsemi 0:098463de4c5d 111 BLE_GATT_UNIT_LENGTH_METRE = 0x2701, /**< Length, metre. */
group-onsemi 0:098463de4c5d 112 BLE_GATT_UNIT_MASS_KILOGRAM = 0x2702, /**< Mass, kilogram. */
group-onsemi 0:098463de4c5d 113 BLE_GATT_UNIT_TIME_SECOND = 0x2703, /**< Time, second. */
group-onsemi 0:098463de4c5d 114 BLE_GATT_UNIT_ELECTRIC_CURRENT_AMPERE = 0x2704, /**< Electric current, ampere. */
group-onsemi 0:098463de4c5d 115 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_KELVIN = 0x2705, /**< Thermodynamic temperature, kelvin. */
group-onsemi 0:098463de4c5d 116 BLE_GATT_UNIT_AMOUNT_OF_SUBSTANCE_MOLE = 0x2706, /**< Amount of substance, mole. */
group-onsemi 0:098463de4c5d 117 BLE_GATT_UNIT_LUMINOUS_INTENSITY_CANDELA = 0x2707, /**< Luminous intensity, candela. */
group-onsemi 0:098463de4c5d 118 BLE_GATT_UNIT_AREA_SQUARE_METRES = 0x2710, /**< Area, square metres. */
group-onsemi 0:098463de4c5d 119 BLE_GATT_UNIT_VOLUME_CUBIC_METRES = 0x2711, /**< Volume, cubic metres. */
group-onsemi 0:098463de4c5d 120 BLE_GATT_UNIT_VELOCITY_METRES_PER_SECOND = 0x2712, /**< Velocity, metres per second. */
group-onsemi 0:098463de4c5d 121 BLE_GATT_UNIT_ACCELERATION_METRES_PER_SECOND_SQUARED = 0x2713, /**< Acceleration, metres per second squared. */
group-onsemi 0:098463de4c5d 122 BLE_GATT_UNIT_WAVENUMBER_RECIPROCAL_METRE = 0x2714, /**< Wave number reciprocal, metre. */
group-onsemi 0:098463de4c5d 123 BLE_GATT_UNIT_DENSITY_KILOGRAM_PER_CUBIC_METRE = 0x2715, /**< Density, kilogram per cubic metre. */
group-onsemi 0:098463de4c5d 124 BLE_GATT_UNIT_SURFACE_DENSITY_KILOGRAM_PER_SQUARE_METRE = 0x2716, /**< */
group-onsemi 0:098463de4c5d 125 BLE_GATT_UNIT_SPECIFIC_VOLUME_CUBIC_METRE_PER_KILOGRAM = 0x2717, /**< */
group-onsemi 0:098463de4c5d 126 BLE_GATT_UNIT_CURRENT_DENSITY_AMPERE_PER_SQUARE_METRE = 0x2718, /**< */
group-onsemi 0:098463de4c5d 127 BLE_GATT_UNIT_MAGNETIC_FIELD_STRENGTH_AMPERE_PER_METRE = 0x2719, /**< Magnetic field strength, ampere per metre. */
group-onsemi 0:098463de4c5d 128 BLE_GATT_UNIT_AMOUNT_CONCENTRATION_MOLE_PER_CUBIC_METRE = 0x271A, /**< */
group-onsemi 0:098463de4c5d 129 BLE_GATT_UNIT_MASS_CONCENTRATION_KILOGRAM_PER_CUBIC_METRE = 0x271B, /**< */
group-onsemi 0:098463de4c5d 130 BLE_GATT_UNIT_LUMINANCE_CANDELA_PER_SQUARE_METRE = 0x271C, /**< */
group-onsemi 0:098463de4c5d 131 BLE_GATT_UNIT_REFRACTIVE_INDEX = 0x271D, /**< */
group-onsemi 0:098463de4c5d 132 BLE_GATT_UNIT_RELATIVE_PERMEABILITY = 0x271E, /**< */
group-onsemi 0:098463de4c5d 133 BLE_GATT_UNIT_PLANE_ANGLE_RADIAN = 0x2720, /**< */
group-onsemi 0:098463de4c5d 134 BLE_GATT_UNIT_SOLID_ANGLE_STERADIAN = 0x2721, /**< */
group-onsemi 0:098463de4c5d 135 BLE_GATT_UNIT_FREQUENCY_HERTZ = 0x2722, /**< Frequency, hertz. */
group-onsemi 0:098463de4c5d 136 BLE_GATT_UNIT_FORCE_NEWTON = 0x2723, /**< Force, newton. */
group-onsemi 0:098463de4c5d 137 BLE_GATT_UNIT_PRESSURE_PASCAL = 0x2724, /**< Pressure, pascal. */
group-onsemi 0:098463de4c5d 138 BLE_GATT_UNIT_ENERGY_JOULE = 0x2725, /**< Energy, joule. */
group-onsemi 0:098463de4c5d 139 BLE_GATT_UNIT_POWER_WATT = 0x2726, /**< Power, watt. */
group-onsemi 0:098463de4c5d 140 BLE_GATT_UNIT_ELECTRIC_CHARGE_COULOMB = 0x2727, /**< Electrical charge, coulomb. */
group-onsemi 0:098463de4c5d 141 BLE_GATT_UNIT_ELECTRIC_POTENTIAL_DIFFERENCE_VOLT = 0x2728, /**< Electrical potential difference, voltage. */
group-onsemi 0:098463de4c5d 142 BLE_GATT_UNIT_CAPACITANCE_FARAD = 0x2729, /**< */
group-onsemi 0:098463de4c5d 143 BLE_GATT_UNIT_ELECTRIC_RESISTANCE_OHM = 0x272A, /**< */
group-onsemi 0:098463de4c5d 144 BLE_GATT_UNIT_ELECTRIC_CONDUCTANCE_SIEMENS = 0x272B, /**< */
group-onsemi 0:098463de4c5d 145 BLE_GATT_UNIT_MAGNETIC_FLEX_WEBER = 0x272C, /**< */
group-onsemi 0:098463de4c5d 146 BLE_GATT_UNIT_MAGNETIC_FLEX_DENSITY_TESLA = 0x272D, /**< */
group-onsemi 0:098463de4c5d 147 BLE_GATT_UNIT_INDUCTANCE_HENRY = 0x272E, /**< */
group-onsemi 0:098463de4c5d 148 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_CELSIUS = 0x272F, /**< */
group-onsemi 0:098463de4c5d 149 BLE_GATT_UNIT_LUMINOUS_FLUX_LUMEN = 0x2730, /**< */
group-onsemi 0:098463de4c5d 150 BLE_GATT_UNIT_ILLUMINANCE_LUX = 0x2731, /**< */
group-onsemi 0:098463de4c5d 151 BLE_GATT_UNIT_ACTIVITY_REFERRED_TO_A_RADIONUCLIDE_BECQUEREL = 0x2732, /**< */
group-onsemi 0:098463de4c5d 152 BLE_GATT_UNIT_ABSORBED_DOSE_GRAY = 0x2733, /**< */
group-onsemi 0:098463de4c5d 153 BLE_GATT_UNIT_DOSE_EQUIVALENT_SIEVERT = 0x2734, /**< */
group-onsemi 0:098463de4c5d 154 BLE_GATT_UNIT_CATALYTIC_ACTIVITY_KATAL = 0x2735, /**< */
group-onsemi 0:098463de4c5d 155 BLE_GATT_UNIT_DYNAMIC_VISCOSITY_PASCAL_SECOND = 0x2740, /**< */
group-onsemi 0:098463de4c5d 156 BLE_GATT_UNIT_MOMENT_OF_FORCE_NEWTON_METRE = 0x2741, /**< */
group-onsemi 0:098463de4c5d 157 BLE_GATT_UNIT_SURFACE_TENSION_NEWTON_PER_METRE = 0x2742, /**< */
group-onsemi 0:098463de4c5d 158 BLE_GATT_UNIT_ANGULAR_VELOCITY_RADIAN_PER_SECOND = 0x2743, /**< */
group-onsemi 0:098463de4c5d 159 BLE_GATT_UNIT_ANGULAR_ACCELERATION_RADIAN_PER_SECOND_SQUARED = 0x2744, /**< */
group-onsemi 0:098463de4c5d 160 BLE_GATT_UNIT_HEAT_FLUX_DENSITY_WATT_PER_SQUARE_METRE = 0x2745, /**< */
group-onsemi 0:098463de4c5d 161 BLE_GATT_UNIT_HEAT_CAPACITY_JOULE_PER_KELVIN = 0x2746, /**< */
group-onsemi 0:098463de4c5d 162 BLE_GATT_UNIT_SPECIFIC_HEAT_CAPACITY_JOULE_PER_KILOGRAM_KELVIN = 0x2747, /**< */
group-onsemi 0:098463de4c5d 163 BLE_GATT_UNIT_SPECIFIC_ENERGY_JOULE_PER_KILOGRAM = 0x2748, /**< */
group-onsemi 0:098463de4c5d 164 BLE_GATT_UNIT_THERMAL_CONDUCTIVITY_WATT_PER_METRE_KELVIN = 0x2749, /**< */
group-onsemi 0:098463de4c5d 165 BLE_GATT_UNIT_ENERGY_DENSITY_JOULE_PER_CUBIC_METRE = 0x274A, /**< */
group-onsemi 0:098463de4c5d 166 BLE_GATT_UNIT_ELECTRIC_FIELD_STRENGTH_VOLT_PER_METRE = 0x274B, /**< */
group-onsemi 0:098463de4c5d 167 BLE_GATT_UNIT_ELECTRIC_CHARGE_DENSITY_COULOMB_PER_CUBIC_METRE = 0x274C, /**< */
group-onsemi 0:098463de4c5d 168 BLE_GATT_UNIT_SURFACE_CHARGE_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274D, /**< */
group-onsemi 0:098463de4c5d 169 BLE_GATT_UNIT_ELECTRIC_FLUX_DENSITY_COULOMB_PER_SQUARE_METRE = 0x274E, /**< */
group-onsemi 0:098463de4c5d 170 BLE_GATT_UNIT_PERMITTIVITY_FARAD_PER_METRE = 0x274F, /**< */
group-onsemi 0:098463de4c5d 171 BLE_GATT_UNIT_PERMEABILITY_HENRY_PER_METRE = 0x2750, /**< */
group-onsemi 0:098463de4c5d 172 BLE_GATT_UNIT_MOLAR_ENERGY_JOULE_PER_MOLE = 0x2751, /**< */
group-onsemi 0:098463de4c5d 173 BLE_GATT_UNIT_MOLAR_ENTROPY_JOULE_PER_MOLE_KELVIN = 0x2752, /**< */
group-onsemi 0:098463de4c5d 174 BLE_GATT_UNIT_EXPOSURE_COULOMB_PER_KILOGRAM = 0x2753, /**< */
group-onsemi 0:098463de4c5d 175 BLE_GATT_UNIT_ABSORBED_DOSE_RATE_GRAY_PER_SECOND = 0x2754, /**< */
group-onsemi 0:098463de4c5d 176 BLE_GATT_UNIT_RADIANT_INTENSITY_WATT_PER_STERADIAN = 0x2755, /**< */
group-onsemi 0:098463de4c5d 177 BLE_GATT_UNIT_RADIANCE_WATT_PER_SQUARE_METRE_STERADIAN = 0x2756, /**< */
group-onsemi 0:098463de4c5d 178 BLE_GATT_UNIT_CATALYTIC_ACTIVITY_CONCENTRATION_KATAL_PER_CUBIC_METRE = 0x2757, /**< */
group-onsemi 0:098463de4c5d 179 BLE_GATT_UNIT_TIME_MINUTE = 0x2760, /**< Time, minute. */
group-onsemi 0:098463de4c5d 180 BLE_GATT_UNIT_TIME_HOUR = 0x2761, /**< Time, hour. */
group-onsemi 0:098463de4c5d 181 BLE_GATT_UNIT_TIME_DAY = 0x2762, /**< Time, day. */
group-onsemi 0:098463de4c5d 182 BLE_GATT_UNIT_PLANE_ANGLE_DEGREE = 0x2763, /**< */
group-onsemi 0:098463de4c5d 183 BLE_GATT_UNIT_PLANE_ANGLE_MINUTE = 0x2764, /**< */
group-onsemi 0:098463de4c5d 184 BLE_GATT_UNIT_PLANE_ANGLE_SECOND = 0x2765, /**< */
group-onsemi 0:098463de4c5d 185 BLE_GATT_UNIT_AREA_HECTARE = 0x2766, /**< */
group-onsemi 0:098463de4c5d 186 BLE_GATT_UNIT_VOLUME_LITRE = 0x2767, /**< */
group-onsemi 0:098463de4c5d 187 BLE_GATT_UNIT_MASS_TONNE = 0x2768, /**< */
group-onsemi 0:098463de4c5d 188 BLE_GATT_UNIT_PRESSURE_BAR = 0x2780, /**< Pressure, bar. */
group-onsemi 0:098463de4c5d 189 BLE_GATT_UNIT_PRESSURE_MILLIMETRE_OF_MERCURY = 0x2781, /**< Pressure, millimetre of mercury. */
group-onsemi 0:098463de4c5d 190 BLE_GATT_UNIT_LENGTH_ANGSTROM = 0x2782, /**< */
group-onsemi 0:098463de4c5d 191 BLE_GATT_UNIT_LENGTH_NAUTICAL_MILE = 0x2783, /**< */
group-onsemi 0:098463de4c5d 192 BLE_GATT_UNIT_AREA_BARN = 0x2784, /**< */
group-onsemi 0:098463de4c5d 193 BLE_GATT_UNIT_VELOCITY_KNOT = 0x2785, /**< */
group-onsemi 0:098463de4c5d 194 BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_NEPER = 0x2786, /**< */
group-onsemi 0:098463de4c5d 195 BLE_GATT_UNIT_LOGARITHMIC_RADIO_QUANTITY_BEL = 0x2787, /**< */
group-onsemi 0:098463de4c5d 196 BLE_GATT_UNIT_LENGTH_YARD = 0x27A0, /**< Length, yard. */
group-onsemi 0:098463de4c5d 197 BLE_GATT_UNIT_LENGTH_PARSEC = 0x27A1, /**< Length, parsec. */
group-onsemi 0:098463de4c5d 198 BLE_GATT_UNIT_LENGTH_INCH = 0x27A2, /**< Length, inch. */
group-onsemi 0:098463de4c5d 199 BLE_GATT_UNIT_LENGTH_FOOT = 0x27A3, /**< Length, foot. */
group-onsemi 0:098463de4c5d 200 BLE_GATT_UNIT_LENGTH_MILE = 0x27A4, /**< Length, mile. */
group-onsemi 0:098463de4c5d 201 BLE_GATT_UNIT_PRESSURE_POUND_FORCE_PER_SQUARE_INCH = 0x27A5, /**< */
group-onsemi 0:098463de4c5d 202 BLE_GATT_UNIT_VELOCITY_KILOMETRE_PER_HOUR = 0x27A6, /**< Velocity, kilometre per hour. */
group-onsemi 0:098463de4c5d 203 BLE_GATT_UNIT_VELOCITY_MILE_PER_HOUR = 0x27A7, /**< Velocity, mile per hour. */
group-onsemi 0:098463de4c5d 204 BLE_GATT_UNIT_ANGULAR_VELOCITY_REVOLUTION_PER_MINUTE = 0x27A8, /**< Angular Velocity, revolution per minute. */
group-onsemi 0:098463de4c5d 205 BLE_GATT_UNIT_ENERGY_GRAM_CALORIE = 0x27A9, /**< Energy, gram calorie. */
group-onsemi 0:098463de4c5d 206 BLE_GATT_UNIT_ENERGY_KILOGRAM_CALORIE = 0x27AA, /**< Energy, kilogram calorie. */
group-onsemi 0:098463de4c5d 207 BLE_GATT_UNIT_ENERGY_KILOWATT_HOUR = 0x27AB, /**< Energy, killowatt hour. */
group-onsemi 0:098463de4c5d 208 BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_DEGREE_FAHRENHEIT = 0x27AC, /**< */
group-onsemi 0:098463de4c5d 209 BLE_GATT_UNIT_PERCENTAGE = 0x27AD, /**< Percentage. */
group-onsemi 0:098463de4c5d 210 BLE_GATT_UNIT_PER_MILLE = 0x27AE, /**< */
group-onsemi 0:098463de4c5d 211 BLE_GATT_UNIT_PERIOD_BEATS_PER_MINUTE = 0x27AF, /**< */
group-onsemi 0:098463de4c5d 212 BLE_GATT_UNIT_ELECTRIC_CHARGE_AMPERE_HOURS = 0x27B0, /**< */
group-onsemi 0:098463de4c5d 213 BLE_GATT_UNIT_MASS_DENSITY_MILLIGRAM_PER_DECILITRE = 0x27B1, /**< */
group-onsemi 0:098463de4c5d 214 BLE_GATT_UNIT_MASS_DENSITY_MILLIMOLE_PER_LITRE = 0x27B2, /**< */
group-onsemi 0:098463de4c5d 215 BLE_GATT_UNIT_TIME_YEAR = 0x27B3, /**< Time, year. */
group-onsemi 0:098463de4c5d 216 BLE_GATT_UNIT_TIME_MONTH = 0x27B4, /**< Time, month. */
group-onsemi 0:098463de4c5d 217 BLE_GATT_UNIT_CONCENTRATION_COUNT_PER_CUBIC_METRE = 0x27B5, /**< */
group-onsemi 0:098463de4c5d 218 BLE_GATT_UNIT_IRRADIANCE_WATT_PER_SQUARE_METRE = 0x27B6 /**< */
group-onsemi 0:098463de4c5d 219 };
group-onsemi 0:098463de4c5d 220
group-onsemi 0:098463de4c5d 221 /**
group-onsemi 0:098463de4c5d 222 * @brief Standard GATT number types.
group-onsemi 0:098463de4c5d 223 *
group-onsemi 0:098463de4c5d 224 * @note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.2.
group-onsemi 0:098463de4c5d 225 *
group-onsemi 0:098463de4c5d 226 * @note See http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
group-onsemi 0:098463de4c5d 227 */
group-onsemi 0:098463de4c5d 228 enum {
group-onsemi 0:098463de4c5d 229 BLE_GATT_FORMAT_RFU = 0x00, /**< Reserved for future use. */
group-onsemi 0:098463de4c5d 230 BLE_GATT_FORMAT_BOOLEAN = 0x01, /**< Boolean. */
group-onsemi 0:098463de4c5d 231 BLE_GATT_FORMAT_2BIT = 0x02, /**< Unsigned 2-bit integer. */
group-onsemi 0:098463de4c5d 232 BLE_GATT_FORMAT_NIBBLE = 0x03, /**< Unsigned 4-bit integer. */
group-onsemi 0:098463de4c5d 233 BLE_GATT_FORMAT_UINT8 = 0x04, /**< Unsigned 8-bit integer. */
group-onsemi 0:098463de4c5d 234 BLE_GATT_FORMAT_UINT12 = 0x05, /**< Unsigned 12-bit integer. */
group-onsemi 0:098463de4c5d 235 BLE_GATT_FORMAT_UINT16 = 0x06, /**< Unsigned 16-bit integer. */
group-onsemi 0:098463de4c5d 236 BLE_GATT_FORMAT_UINT24 = 0x07, /**< Unsigned 24-bit integer. */
group-onsemi 0:098463de4c5d 237 BLE_GATT_FORMAT_UINT32 = 0x08, /**< Unsigned 32-bit integer. */
group-onsemi 0:098463de4c5d 238 BLE_GATT_FORMAT_UINT48 = 0x09, /**< Unsigned 48-bit integer. */
group-onsemi 0:098463de4c5d 239 BLE_GATT_FORMAT_UINT64 = 0x0A, /**< Unsigned 64-bit integer. */
group-onsemi 0:098463de4c5d 240 BLE_GATT_FORMAT_UINT128 = 0x0B, /**< Unsigned 128-bit integer. */
group-onsemi 0:098463de4c5d 241 BLE_GATT_FORMAT_SINT8 = 0x0C, /**< Signed 2-bit integer. */
group-onsemi 0:098463de4c5d 242 BLE_GATT_FORMAT_SINT12 = 0x0D, /**< Signed 12-bit integer. */
group-onsemi 0:098463de4c5d 243 BLE_GATT_FORMAT_SINT16 = 0x0E, /**< Signed 16-bit integer. */
group-onsemi 0:098463de4c5d 244 BLE_GATT_FORMAT_SINT24 = 0x0F, /**< Signed 24-bit integer. */
group-onsemi 0:098463de4c5d 245 BLE_GATT_FORMAT_SINT32 = 0x10, /**< Signed 32-bit integer. */
group-onsemi 0:098463de4c5d 246 BLE_GATT_FORMAT_SINT48 = 0x11, /**< Signed 48-bit integer. */
group-onsemi 0:098463de4c5d 247 BLE_GATT_FORMAT_SINT64 = 0x12, /**< Signed 64-bit integer. */
group-onsemi 0:098463de4c5d 248 BLE_GATT_FORMAT_SINT128 = 0x13, /**< Signed 128-bit integer. */
group-onsemi 0:098463de4c5d 249 BLE_GATT_FORMAT_FLOAT32 = 0x14, /**< IEEE-754 32-bit floating point. */
group-onsemi 0:098463de4c5d 250 BLE_GATT_FORMAT_FLOAT64 = 0x15, /**< IEEE-754 64-bit floating point. */
group-onsemi 0:098463de4c5d 251 BLE_GATT_FORMAT_SFLOAT = 0x16, /**< IEEE-11073 16-bit SFLOAT. */
group-onsemi 0:098463de4c5d 252 BLE_GATT_FORMAT_FLOAT = 0x17, /**< IEEE-11073 32-bit FLOAT. */
group-onsemi 0:098463de4c5d 253 BLE_GATT_FORMAT_DUINT16 = 0x18, /**< IEEE-20601 format. */
group-onsemi 0:098463de4c5d 254 BLE_GATT_FORMAT_UTF8S = 0x19, /**< UTF-8 string. */
group-onsemi 0:098463de4c5d 255 BLE_GATT_FORMAT_UTF16S = 0x1A, /**< UTF-16 string. */
group-onsemi 0:098463de4c5d 256 BLE_GATT_FORMAT_STRUCT = 0x1B /**< Opaque Structure. */
group-onsemi 0:098463de4c5d 257 };
group-onsemi 0:098463de4c5d 258
group-onsemi 0:098463de4c5d 259 /*!
group-onsemi 0:098463de4c5d 260 * @brief Standard GATT characteristic properties.
group-onsemi 0:098463de4c5d 261 *
group-onsemi 0:098463de4c5d 262 * @note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.1.1
group-onsemi 0:098463de4c5d 263 * and Section 3.3.3.1 for Extended Properties.
group-onsemi 0:098463de4c5d 264 */
group-onsemi 0:098463de4c5d 265 enum Properties_t {
group-onsemi 0:098463de4c5d 266 BLE_GATT_CHAR_PROPERTIES_NONE = 0x00,
group-onsemi 0:098463de4c5d 267 BLE_GATT_CHAR_PROPERTIES_BROADCAST = 0x01, /**< Permits broadcasts of the characteristic value using the Server Characteristic Configuration descriptor. */
group-onsemi 0:098463de4c5d 268 BLE_GATT_CHAR_PROPERTIES_READ = 0x02, /**< Permits reads of the characteristic value. */
group-onsemi 0:098463de4c5d 269 BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE = 0x04, /**< Permits writes of the characteristic value without response. */
group-onsemi 0:098463de4c5d 270 BLE_GATT_CHAR_PROPERTIES_WRITE = 0x08, /**< Permits writes of the characteristic value with response. */
group-onsemi 0:098463de4c5d 271 BLE_GATT_CHAR_PROPERTIES_NOTIFY = 0x10, /**< Permits notifications of a characteristic value without acknowledgment. */
group-onsemi 0:098463de4c5d 272 BLE_GATT_CHAR_PROPERTIES_INDICATE = 0x20, /**< Permits indications of a characteristic value with acknowledgment. */
group-onsemi 0:098463de4c5d 273 BLE_GATT_CHAR_PROPERTIES_AUTHENTICATED_SIGNED_WRITES = 0x40, /**< Permits signed writes to the characteristic value. */
group-onsemi 0:098463de4c5d 274 BLE_GATT_CHAR_PROPERTIES_EXTENDED_PROPERTIES = 0x80 /**< Additional characteristic properties are defined in the Characteristic Extended Properties descriptor */
group-onsemi 0:098463de4c5d 275 };
group-onsemi 0:098463de4c5d 276
group-onsemi 0:098463de4c5d 277 /**
group-onsemi 0:098463de4c5d 278 * @brief GATT presentation format wrapper.
group-onsemi 0:098463de4c5d 279 *
group-onsemi 0:098463de4c5d 280 * @note See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.
group-onsemi 0:098463de4c5d 281 *
group-onsemi 0:098463de4c5d 282 * @note See https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
group-onsemi 0:098463de4c5d 283 */
group-onsemi 0:098463de4c5d 284 struct PresentationFormat_t {
group-onsemi 0:098463de4c5d 285 uint8_t gatt_format; /**< Format of the value. */
group-onsemi 0:098463de4c5d 286 int8_t exponent; /**< Exponent for integer data types. Example: if Exponent = -3 and the char value is 3892, the actual value is 3.892 */
group-onsemi 0:098463de4c5d 287 uint16_t gatt_unit; /**< UUID from Bluetooth Assigned Numbers. */
group-onsemi 0:098463de4c5d 288 uint8_t gatt_namespace; /**< Namespace from Bluetooth Assigned Numbers, normally '1'. */
group-onsemi 0:098463de4c5d 289 uint16_t gatt_nsdesc; /**< Namespace description from Bluetooth Assigned Numbers, normally '0'. */
group-onsemi 0:098463de4c5d 290 };
group-onsemi 0:098463de4c5d 291
group-onsemi 0:098463de4c5d 292 /**
group-onsemi 0:098463de4c5d 293 * @brief Creates a new GattCharacteristic using the specified 16-bit
group-onsemi 0:098463de4c5d 294 * UUID, value length, and properties.
group-onsemi 0:098463de4c5d 295 *
group-onsemi 0:098463de4c5d 296 * @param[in] uuid
group-onsemi 0:098463de4c5d 297 * The UUID to use for this characteristic.
group-onsemi 0:098463de4c5d 298 * @param[in] valuePtr
group-onsemi 0:098463de4c5d 299 * The memory holding the initial value. The value is copied
group-onsemi 0:098463de4c5d 300 * into the stack when the enclosing service is added, and
group-onsemi 0:098463de4c5d 301 * is thereafter maintained internally by the stack.
group-onsemi 0:098463de4c5d 302 * @param[in] len
group-onsemi 0:098463de4c5d 303 * The length in bytes of this characteristic's value.
group-onsemi 0:098463de4c5d 304 * @param[in] maxLen
group-onsemi 0:098463de4c5d 305 * The max length in bytes of this characteristic's value.
group-onsemi 0:098463de4c5d 306 * @param[in] props
group-onsemi 0:098463de4c5d 307 * The 8-bit field containing the characteristic's properties.
group-onsemi 0:098463de4c5d 308 * @param[in] descriptors
group-onsemi 0:098463de4c5d 309 * A pointer to an array of descriptors to be included within
group-onsemi 0:098463de4c5d 310 * this characteristic. The memory for the descriptor array is
group-onsemi 0:098463de4c5d 311 * owned by the caller, and should remain valid at least until
group-onsemi 0:098463de4c5d 312 * the enclosing service is added to the GATT table.
group-onsemi 0:098463de4c5d 313 * @param[in] numDescriptors
group-onsemi 0:098463de4c5d 314 * The number of descriptors in the previous array.
group-onsemi 0:098463de4c5d 315 * @param[in] hasVariableLen
group-onsemi 0:098463de4c5d 316 * Whether the attribute's value length changes over time.
group-onsemi 0:098463de4c5d 317 *
group-onsemi 0:098463de4c5d 318 * @note The UUID value must be unique in the service and is normally >1.
group-onsemi 0:098463de4c5d 319 *
group-onsemi 0:098463de4c5d 320 * @note If valuePtr == NULL, length == 0, and properties == READ
group-onsemi 0:098463de4c5d 321 * for the value attribute of a characteristic, then that particular
group-onsemi 0:098463de4c5d 322 * characteristic may be considered optional and dropped while
group-onsemi 0:098463de4c5d 323 * instantiating the service with the underlying BLE stack.
group-onsemi 0:098463de4c5d 324 */
group-onsemi 0:098463de4c5d 325 GattCharacteristic(const UUID &uuid,
group-onsemi 0:098463de4c5d 326 uint8_t *valuePtr = NULL,
group-onsemi 0:098463de4c5d 327 uint16_t len = 0,
group-onsemi 0:098463de4c5d 328 uint16_t maxLen = 0,
group-onsemi 0:098463de4c5d 329 uint8_t props = BLE_GATT_CHAR_PROPERTIES_NONE,
group-onsemi 0:098463de4c5d 330 GattAttribute *descriptors[] = NULL,
group-onsemi 0:098463de4c5d 331 unsigned numDescriptors = 0,
group-onsemi 0:098463de4c5d 332 bool hasVariableLen = true) :
group-onsemi 0:098463de4c5d 333 _valueAttribute(uuid, valuePtr, len, maxLen, hasVariableLen),
group-onsemi 0:098463de4c5d 334 _properties(props),
group-onsemi 0:098463de4c5d 335 _requiredSecurity(SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK),
group-onsemi 0:098463de4c5d 336 _descriptors(descriptors),
group-onsemi 0:098463de4c5d 337 _descriptorCount(numDescriptors),
group-onsemi 0:098463de4c5d 338 enabledReadAuthorization(false),
group-onsemi 0:098463de4c5d 339 enabledWriteAuthorization(false),
group-onsemi 0:098463de4c5d 340 readAuthorizationCallback(),
group-onsemi 0:098463de4c5d 341 writeAuthorizationCallback() {
group-onsemi 0:098463de4c5d 342 /* empty */
group-onsemi 0:098463de4c5d 343 }
group-onsemi 0:098463de4c5d 344
group-onsemi 0:098463de4c5d 345 public:
group-onsemi 0:098463de4c5d 346 /**
group-onsemi 0:098463de4c5d 347 * Set up the minimum security (mode and level) requirements for access to
group-onsemi 0:098463de4c5d 348 * the characteristic's value attribute.
group-onsemi 0:098463de4c5d 349 *
group-onsemi 0:098463de4c5d 350 * @param[in] securityMode
group-onsemi 0:098463de4c5d 351 * Can be one of encryption or signing, with or without
group-onsemi 0:098463de4c5d 352 * protection for man in the middle attacks (MITM).
group-onsemi 0:098463de4c5d 353 */
group-onsemi 0:098463de4c5d 354 void requireSecurity(SecurityManager::SecurityMode_t securityMode) {
group-onsemi 0:098463de4c5d 355 _requiredSecurity = securityMode;
group-onsemi 0:098463de4c5d 356 }
group-onsemi 0:098463de4c5d 357
group-onsemi 0:098463de4c5d 358 public:
group-onsemi 0:098463de4c5d 359 /**
group-onsemi 0:098463de4c5d 360 * Set up callback that will be triggered before the GATT Client is allowed
group-onsemi 0:098463de4c5d 361 * to write this characteristic. The handler will determine the
group-onsemi 0:098463de4c5d 362 * authorization reply for the write.
group-onsemi 0:098463de4c5d 363 *
group-onsemi 0:098463de4c5d 364 * @param[in] callback
group-onsemi 0:098463de4c5d 365 * Event handler being registered.
group-onsemi 0:098463de4c5d 366 */
group-onsemi 0:098463de4c5d 367 void setWriteAuthorizationCallback(void (*callback)(GattWriteAuthCallbackParams *)) {
group-onsemi 0:098463de4c5d 368 writeAuthorizationCallback.attach(callback);
group-onsemi 0:098463de4c5d 369 enabledWriteAuthorization = true;
group-onsemi 0:098463de4c5d 370 }
group-onsemi 0:098463de4c5d 371
group-onsemi 0:098463de4c5d 372 /**
group-onsemi 0:098463de4c5d 373 * Same as GattCharacrteristic::setWriteAuthorizationCallback(), but allows
group-onsemi 0:098463de4c5d 374 * the possibility to add an object reference and member function as
group-onsemi 0:098463de4c5d 375 * handler for connection event callbacks.
group-onsemi 0:098463de4c5d 376 *
group-onsemi 0:098463de4c5d 377 * @param[in] object
group-onsemi 0:098463de4c5d 378 * Pointer to the object of a class defining the member callback
group-onsemi 0:098463de4c5d 379 * function (@p member).
group-onsemi 0:098463de4c5d 380 * @param[in] member
group-onsemi 0:098463de4c5d 381 * The member callback (within the context of an object) to be
group-onsemi 0:098463de4c5d 382 * invoked.
group-onsemi 0:098463de4c5d 383 */
group-onsemi 0:098463de4c5d 384 template <typename T>
group-onsemi 0:098463de4c5d 385 void setWriteAuthorizationCallback(T *object, void (T::*member)(GattWriteAuthCallbackParams *)) {
group-onsemi 0:098463de4c5d 386 writeAuthorizationCallback.attach(object, member);
group-onsemi 0:098463de4c5d 387 enabledWriteAuthorization = true;
group-onsemi 0:098463de4c5d 388 }
group-onsemi 0:098463de4c5d 389
group-onsemi 0:098463de4c5d 390 /**
group-onsemi 0:098463de4c5d 391 * Set up callback that will be triggered before the GATT Client is allowed
group-onsemi 0:098463de4c5d 392 * to read this characteristic. The handler will determine the
group-onsemi 0:098463de4c5d 393 * authorizaion reply for the read.
group-onsemi 0:098463de4c5d 394 *
group-onsemi 0:098463de4c5d 395 * @param[in] callback
group-onsemi 0:098463de4c5d 396 * Event handler being registered.
group-onsemi 0:098463de4c5d 397 */
group-onsemi 0:098463de4c5d 398 void setReadAuthorizationCallback(void (*callback)(GattReadAuthCallbackParams *)) {
group-onsemi 0:098463de4c5d 399 readAuthorizationCallback.attach(callback);
group-onsemi 0:098463de4c5d 400 enabledReadAuthorization = true;
group-onsemi 0:098463de4c5d 401 }
group-onsemi 0:098463de4c5d 402
group-onsemi 0:098463de4c5d 403 /**
group-onsemi 0:098463de4c5d 404 * Same as GattCharacrteristic::setReadAuthorizationCallback(), but allows
group-onsemi 0:098463de4c5d 405 * the possibility to add an object reference and member function as
group-onsemi 0:098463de4c5d 406 * handler for connection event callbacks.
group-onsemi 0:098463de4c5d 407 *
group-onsemi 0:098463de4c5d 408 * @param[in] object
group-onsemi 0:098463de4c5d 409 * Pointer to the object of a class defining the member callback
group-onsemi 0:098463de4c5d 410 * function (@p member).
group-onsemi 0:098463de4c5d 411 * @param[in] member
group-onsemi 0:098463de4c5d 412 * The member callback (within the context of an object) to be
group-onsemi 0:098463de4c5d 413 * invoked.
group-onsemi 0:098463de4c5d 414 */
group-onsemi 0:098463de4c5d 415 template <typename T>
group-onsemi 0:098463de4c5d 416 void setReadAuthorizationCallback(T *object, void (T::*member)(GattReadAuthCallbackParams *)) {
group-onsemi 0:098463de4c5d 417 readAuthorizationCallback.attach(object, member);
group-onsemi 0:098463de4c5d 418 enabledReadAuthorization = true;
group-onsemi 0:098463de4c5d 419 }
group-onsemi 0:098463de4c5d 420
group-onsemi 0:098463de4c5d 421 /**
group-onsemi 0:098463de4c5d 422 * Helper that calls the registered handler to determine the authorization
group-onsemi 0:098463de4c5d 423 * reply for a write request. This function is meant to be called from the
group-onsemi 0:098463de4c5d 424 * BLE stack specific implementation.
group-onsemi 0:098463de4c5d 425 *
group-onsemi 0:098463de4c5d 426 * @param[in] params
group-onsemi 0:098463de4c5d 427 * To capture the context of the write-auth request. Also
group-onsemi 0:098463de4c5d 428 * contains an out-parameter for reply.
group-onsemi 0:098463de4c5d 429 *
group-onsemi 0:098463de4c5d 430 * @return A GattAuthCallbackReply_t value indicating whether authorization
group-onsemi 0:098463de4c5d 431 * is granted.
group-onsemi 0:098463de4c5d 432 */
group-onsemi 0:098463de4c5d 433 GattAuthCallbackReply_t authorizeWrite(GattWriteAuthCallbackParams *params) {
group-onsemi 0:098463de4c5d 434 if (!isWriteAuthorizationEnabled()) {
group-onsemi 0:098463de4c5d 435 return AUTH_CALLBACK_REPLY_SUCCESS;
group-onsemi 0:098463de4c5d 436 }
group-onsemi 0:098463de4c5d 437
group-onsemi 0:098463de4c5d 438 params->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS; /* Initialized to no-error by default. */
group-onsemi 0:098463de4c5d 439 writeAuthorizationCallback.call(params);
group-onsemi 0:098463de4c5d 440 return params->authorizationReply;
group-onsemi 0:098463de4c5d 441 }
group-onsemi 0:098463de4c5d 442
group-onsemi 0:098463de4c5d 443 /**
group-onsemi 0:098463de4c5d 444 * Helper that calls the registered handler to determine the authorization
group-onsemi 0:098463de4c5d 445 * reply for a read request. This function is meant to be called from the
group-onsemi 0:098463de4c5d 446 * BLE stack specific implementation.
group-onsemi 0:098463de4c5d 447 *
group-onsemi 0:098463de4c5d 448 * @param[in] params
group-onsemi 0:098463de4c5d 449 * To capture the context of the read-auth request.
group-onsemi 0:098463de4c5d 450 *
group-onsemi 0:098463de4c5d 451 * @return A GattAuthCallbackReply_t value indicating whether authorization
group-onsemi 0:098463de4c5d 452 * is granted.
group-onsemi 0:098463de4c5d 453 *
group-onsemi 0:098463de4c5d 454 * @note To authorize or deny the read the params->authorizationReply field
group-onsemi 0:098463de4c5d 455 * should be set to true (authorize) or false (deny).
group-onsemi 0:098463de4c5d 456 *
group-onsemi 0:098463de4c5d 457 * @note If the read is approved and params->data is unchanged (NULL),
group-onsemi 0:098463de4c5d 458 * the current characteristic value will be used.
group-onsemi 0:098463de4c5d 459 *
group-onsemi 0:098463de4c5d 460 * @note If the read is approved, a new value can be provided by setting
group-onsemi 0:098463de4c5d 461 * the params->data pointer and params->len fields.
group-onsemi 0:098463de4c5d 462 */
group-onsemi 0:098463de4c5d 463 GattAuthCallbackReply_t authorizeRead(GattReadAuthCallbackParams *params) {
group-onsemi 0:098463de4c5d 464 if (!isReadAuthorizationEnabled()) {
group-onsemi 0:098463de4c5d 465 return AUTH_CALLBACK_REPLY_SUCCESS;
group-onsemi 0:098463de4c5d 466 }
group-onsemi 0:098463de4c5d 467
group-onsemi 0:098463de4c5d 468 params->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS; /* Initialized to no-error by default. */
group-onsemi 0:098463de4c5d 469 readAuthorizationCallback.call(params);
group-onsemi 0:098463de4c5d 470 return params->authorizationReply;
group-onsemi 0:098463de4c5d 471 }
group-onsemi 0:098463de4c5d 472
group-onsemi 0:098463de4c5d 473 public:
group-onsemi 0:098463de4c5d 474 /**
group-onsemi 0:098463de4c5d 475 * Get the characteristic's value attribute.
group-onsemi 0:098463de4c5d 476 *
group-onsemi 0:098463de4c5d 477 * @return A reference to the characteristic's value attribute.
group-onsemi 0:098463de4c5d 478 */
group-onsemi 0:098463de4c5d 479 GattAttribute& getValueAttribute() {
group-onsemi 0:098463de4c5d 480 return _valueAttribute;
group-onsemi 0:098463de4c5d 481 }
group-onsemi 0:098463de4c5d 482
group-onsemi 0:098463de4c5d 483 /**
group-onsemi 0:098463de4c5d 484 * A const alternative to GattCharacteristic::getValueAttribute().
group-onsemi 0:098463de4c5d 485 *
group-onsemi 0:098463de4c5d 486 * @return A const reference to the characteristic's value attribute.
group-onsemi 0:098463de4c5d 487 */
group-onsemi 0:098463de4c5d 488 const GattAttribute& getValueAttribute() const {
group-onsemi 0:098463de4c5d 489 return _valueAttribute;
group-onsemi 0:098463de4c5d 490 }
group-onsemi 0:098463de4c5d 491
group-onsemi 0:098463de4c5d 492 /**
group-onsemi 0:098463de4c5d 493 * Get the characteristic's value attribute handle in the ATT table.
group-onsemi 0:098463de4c5d 494 *
group-onsemi 0:098463de4c5d 495 * @return The value attribute handle.
group-onsemi 0:098463de4c5d 496 *
group-onsemi 0:098463de4c5d 497 * @note The attribute handle is typically assigned by the underlying BLE
group-onsemi 0:098463de4c5d 498 * stack.
group-onsemi 0:098463de4c5d 499 */
group-onsemi 0:098463de4c5d 500 GattAttribute::Handle_t getValueHandle(void) const {
group-onsemi 0:098463de4c5d 501 return getValueAttribute().getHandle();
group-onsemi 0:098463de4c5d 502 }
group-onsemi 0:098463de4c5d 503
group-onsemi 0:098463de4c5d 504 /**
group-onsemi 0:098463de4c5d 505 * Get the characteristic's propertied. Refer to
group-onsemi 0:098463de4c5d 506 * GattCharacteristic::Properties_t.
group-onsemi 0:098463de4c5d 507 *
group-onsemi 0:098463de4c5d 508 * @return The characteristic's properties.
group-onsemi 0:098463de4c5d 509 */
group-onsemi 0:098463de4c5d 510 uint8_t getProperties(void) const {
group-onsemi 0:098463de4c5d 511 return _properties;
group-onsemi 0:098463de4c5d 512 }
group-onsemi 0:098463de4c5d 513
group-onsemi 0:098463de4c5d 514 /**
group-onsemi 0:098463de4c5d 515 * Get the characteristic's required security.
group-onsemi 0:098463de4c5d 516 *
group-onsemi 0:098463de4c5d 517 * @return The characteristic's required security.
group-onsemi 0:098463de4c5d 518 */
group-onsemi 0:098463de4c5d 519 SecurityManager::SecurityMode_t getRequiredSecurity() const {
group-onsemi 0:098463de4c5d 520 return _requiredSecurity;
group-onsemi 0:098463de4c5d 521 }
group-onsemi 0:098463de4c5d 522
group-onsemi 0:098463de4c5d 523 /**
group-onsemi 0:098463de4c5d 524 * Get the total number of descriptors within this characteristic.
group-onsemi 0:098463de4c5d 525 *
group-onsemi 0:098463de4c5d 526 * @return The total number of descriptors.
group-onsemi 0:098463de4c5d 527 */
group-onsemi 0:098463de4c5d 528 uint8_t getDescriptorCount(void) const {
group-onsemi 0:098463de4c5d 529 return _descriptorCount;
group-onsemi 0:098463de4c5d 530 }
group-onsemi 0:098463de4c5d 531
group-onsemi 0:098463de4c5d 532 /**
group-onsemi 0:098463de4c5d 533 * Check whether read authorization is enabled i.e. check whether a
group-onsemi 0:098463de4c5d 534 * read authorization callback was previously registered. Refer to
group-onsemi 0:098463de4c5d 535 * GattCharacteristic::setReadAuthorizationCallback().
group-onsemi 0:098463de4c5d 536 *
group-onsemi 0:098463de4c5d 537 * @return true if read authorization is enabled, false otherwise.
group-onsemi 0:098463de4c5d 538 */
group-onsemi 0:098463de4c5d 539 bool isReadAuthorizationEnabled() const {
group-onsemi 0:098463de4c5d 540 return enabledReadAuthorization;
group-onsemi 0:098463de4c5d 541 }
group-onsemi 0:098463de4c5d 542
group-onsemi 0:098463de4c5d 543 /**
group-onsemi 0:098463de4c5d 544 * Check whether write authorization is enabled i.e. check whether a
group-onsemi 0:098463de4c5d 545 * write authorization callback was previously registered. Refer to
group-onsemi 0:098463de4c5d 546 * GattCharacteristic::setReadAuthorizationCallback().
group-onsemi 0:098463de4c5d 547 *
group-onsemi 0:098463de4c5d 548 * @return true if write authorization is enabled, false otherwise.
group-onsemi 0:098463de4c5d 549 */
group-onsemi 0:098463de4c5d 550 bool isWriteAuthorizationEnabled() const {
group-onsemi 0:098463de4c5d 551 return enabledWriteAuthorization;
group-onsemi 0:098463de4c5d 552 }
group-onsemi 0:098463de4c5d 553
group-onsemi 0:098463de4c5d 554 /**
group-onsemi 0:098463de4c5d 555 * Get this characteristic's descriptor at a specific index.
group-onsemi 0:098463de4c5d 556 *
group-onsemi 0:098463de4c5d 557 * @param[in] index
group-onsemi 0:098463de4c5d 558 * The descriptor's index.
group-onsemi 0:098463de4c5d 559 *
group-onsemi 0:098463de4c5d 560 * @return A pointer the requested descriptor if @p index contains a valid
group-onsemi 0:098463de4c5d 561 * descriptor, or NULL otherwise.
group-onsemi 0:098463de4c5d 562 */
group-onsemi 0:098463de4c5d 563 GattAttribute *getDescriptor(uint8_t index) {
group-onsemi 0:098463de4c5d 564 if (index >= _descriptorCount) {
group-onsemi 0:098463de4c5d 565 return NULL;
group-onsemi 0:098463de4c5d 566 }
group-onsemi 0:098463de4c5d 567
group-onsemi 0:098463de4c5d 568 return _descriptors[index];
group-onsemi 0:098463de4c5d 569 }
group-onsemi 0:098463de4c5d 570
group-onsemi 0:098463de4c5d 571 private:
group-onsemi 0:098463de4c5d 572 /**
group-onsemi 0:098463de4c5d 573 * Attribute that contains the actual value of this characteristic.
group-onsemi 0:098463de4c5d 574 */
group-onsemi 0:098463de4c5d 575 GattAttribute _valueAttribute;
group-onsemi 0:098463de4c5d 576 /**
group-onsemi 0:098463de4c5d 577 * The characteristic's properties. Refer to
group-onsemi 0:098463de4c5d 578 * GattCharacteristic::Properties_t.
group-onsemi 0:098463de4c5d 579 */
group-onsemi 0:098463de4c5d 580 uint8_t _properties;
group-onsemi 0:098463de4c5d 581 /**
group-onsemi 0:098463de4c5d 582 * The characteristic's required security.
group-onsemi 0:098463de4c5d 583 */
group-onsemi 0:098463de4c5d 584 SecurityManager::SecurityMode_t _requiredSecurity;
group-onsemi 0:098463de4c5d 585 /**
group-onsemi 0:098463de4c5d 586 * The characteristic's descriptor attributes.
group-onsemi 0:098463de4c5d 587 */
group-onsemi 0:098463de4c5d 588 GattAttribute **_descriptors;
group-onsemi 0:098463de4c5d 589 /**
group-onsemi 0:098463de4c5d 590 * The number of descriptors in this characteristic.
group-onsemi 0:098463de4c5d 591 */
group-onsemi 0:098463de4c5d 592 uint8_t _descriptorCount;
group-onsemi 0:098463de4c5d 593
group-onsemi 0:098463de4c5d 594 /**
group-onsemi 0:098463de4c5d 595 * Whether read authorization is enabled i.e. whether there is a registered
group-onsemi 0:098463de4c5d 596 * callback to determine read authorization reply.
group-onsemi 0:098463de4c5d 597 */
group-onsemi 0:098463de4c5d 598 bool enabledReadAuthorization;
group-onsemi 0:098463de4c5d 599 /**
group-onsemi 0:098463de4c5d 600 * Whether write authorization is enabled i.e. whether there is a registered
group-onsemi 0:098463de4c5d 601 * callback to determine write authorization reply.
group-onsemi 0:098463de4c5d 602 */
group-onsemi 0:098463de4c5d 603 bool enabledWriteAuthorization;
group-onsemi 0:098463de4c5d 604 /**
group-onsemi 0:098463de4c5d 605 * The registered callback handler for read authorization reply.
group-onsemi 0:098463de4c5d 606 */
group-onsemi 0:098463de4c5d 607 FunctionPointerWithContext<GattReadAuthCallbackParams *> readAuthorizationCallback;
group-onsemi 0:098463de4c5d 608 /**
group-onsemi 0:098463de4c5d 609 * The registered callback handler for write authorization reply.
group-onsemi 0:098463de4c5d 610 */
group-onsemi 0:098463de4c5d 611 FunctionPointerWithContext<GattWriteAuthCallbackParams *> writeAuthorizationCallback;
group-onsemi 0:098463de4c5d 612
group-onsemi 0:098463de4c5d 613 private:
group-onsemi 0:098463de4c5d 614 /* Disallow copy and assignment. */
group-onsemi 0:098463de4c5d 615 GattCharacteristic(const GattCharacteristic &);
group-onsemi 0:098463de4c5d 616 GattCharacteristic& operator=(const GattCharacteristic &);
group-onsemi 0:098463de4c5d 617 };
group-onsemi 0:098463de4c5d 618
group-onsemi 0:098463de4c5d 619 /**
group-onsemi 0:098463de4c5d 620 * Helper class to construct a read-only GattCharacteristic.
group-onsemi 0:098463de4c5d 621 */
group-onsemi 0:098463de4c5d 622 template <typename T>
group-onsemi 0:098463de4c5d 623 class ReadOnlyGattCharacteristic : public GattCharacteristic {
group-onsemi 0:098463de4c5d 624 public:
group-onsemi 0:098463de4c5d 625 /**
group-onsemi 0:098463de4c5d 626 * Construct a ReadOnlyGattCharacteristic.
group-onsemi 0:098463de4c5d 627 *
group-onsemi 0:098463de4c5d 628 * @param[in] uuid
group-onsemi 0:098463de4c5d 629 * The characteristic's UUID.
group-onsemi 0:098463de4c5d 630 * @param[in] valuePtr
group-onsemi 0:098463de4c5d 631 * Pointer to the characterisitic's initial value.
group-onsemi 0:098463de4c5d 632 * @param[in] additionalProperties
group-onsemi 0:098463de4c5d 633 * Additional characterisitic properties. By default, the
group-onsemi 0:098463de4c5d 634 * properties are set to
group-onsemi 0:098463de4c5d 635 * Properties_t::BLE_GATT_CHAR_PROPERTIES_READ.
group-onsemi 0:098463de4c5d 636 * @param[in] descriptors
group-onsemi 0:098463de4c5d 637 * An array of pointers to descriptors to be added to the new
group-onsemi 0:098463de4c5d 638 * characteristic.
group-onsemi 0:098463de4c5d 639 * @param[in] numDescriptors
group-onsemi 0:098463de4c5d 640 * The total number of descriptors in @p descriptors.
group-onsemi 0:098463de4c5d 641 *
group-onsemi 0:098463de4c5d 642 * @note Instances of ReadOnlyGattCharacteristic have a fixed length
group-onsemi 0:098463de4c5d 643 * attribute value that equals sizeof(T). For a variable length
group-onsemi 0:098463de4c5d 644 * alternative use GattCharacteristic directly.
group-onsemi 0:098463de4c5d 645 */
group-onsemi 0:098463de4c5d 646 ReadOnlyGattCharacteristic<T>(const UUID &uuid,
group-onsemi 0:098463de4c5d 647 T *valuePtr,
group-onsemi 0:098463de4c5d 648 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
group-onsemi 0:098463de4c5d 649 GattAttribute *descriptors[] = NULL,
group-onsemi 0:098463de4c5d 650 unsigned numDescriptors = 0) :
group-onsemi 0:098463de4c5d 651 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
group-onsemi 0:098463de4c5d 652 BLE_GATT_CHAR_PROPERTIES_READ | additionalProperties, descriptors, numDescriptors, false) {
group-onsemi 0:098463de4c5d 653 /* empty */
group-onsemi 0:098463de4c5d 654 }
group-onsemi 0:098463de4c5d 655 };
group-onsemi 0:098463de4c5d 656
group-onsemi 0:098463de4c5d 657 /**
group-onsemi 0:098463de4c5d 658 * Helper class to construct a write-only GattCharacteristic.
group-onsemi 0:098463de4c5d 659 */
group-onsemi 0:098463de4c5d 660 template <typename T>
group-onsemi 0:098463de4c5d 661 class WriteOnlyGattCharacteristic : public GattCharacteristic {
group-onsemi 0:098463de4c5d 662 public:
group-onsemi 0:098463de4c5d 663 /**
group-onsemi 0:098463de4c5d 664 * Construct a WriteOnlyGattCharacteristic.
group-onsemi 0:098463de4c5d 665 *
group-onsemi 0:098463de4c5d 666 * @param[in] uuid
group-onsemi 0:098463de4c5d 667 * The characteristic's UUID.
group-onsemi 0:098463de4c5d 668 * @param[in] valuePtr
group-onsemi 0:098463de4c5d 669 * Pointer to the characterisitic's initial value.
group-onsemi 0:098463de4c5d 670 * @param[in] additionalProperties
group-onsemi 0:098463de4c5d 671 * Additional characterisitic properties. By default, the
group-onsemi 0:098463de4c5d 672 * properties are set to
group-onsemi 0:098463de4c5d 673 * Properties_t::BLE_GATT_CHAR_PROPERTIES_WRITE.
group-onsemi 0:098463de4c5d 674 * @param[in] descriptors
group-onsemi 0:098463de4c5d 675 * An array of pointers to descriptors to be added to the new
group-onsemi 0:098463de4c5d 676 * characteristic.
group-onsemi 0:098463de4c5d 677 * @param[in] numDescriptors
group-onsemi 0:098463de4c5d 678 * The total number of descriptors in @p descriptors.
group-onsemi 0:098463de4c5d 679 *
group-onsemi 0:098463de4c5d 680 * @note Instances of WriteOnlyGattCharacteristic have variable length
group-onsemi 0:098463de4c5d 681 * attribute value with maximum size equal to sizeof(T). For a fixed length
group-onsemi 0:098463de4c5d 682 * alternative use GattCharacteristic directly.
group-onsemi 0:098463de4c5d 683 */
group-onsemi 0:098463de4c5d 684 WriteOnlyGattCharacteristic<T>(const UUID &uuid,
group-onsemi 0:098463de4c5d 685 T *valuePtr,
group-onsemi 0:098463de4c5d 686 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
group-onsemi 0:098463de4c5d 687 GattAttribute *descriptors[] = NULL,
group-onsemi 0:098463de4c5d 688 unsigned numDescriptors = 0) :
group-onsemi 0:098463de4c5d 689 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
group-onsemi 0:098463de4c5d 690 BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
group-onsemi 0:098463de4c5d 691 /* empty */
group-onsemi 0:098463de4c5d 692 }
group-onsemi 0:098463de4c5d 693 };
group-onsemi 0:098463de4c5d 694
group-onsemi 0:098463de4c5d 695 /**
group-onsemi 0:098463de4c5d 696 * Helper class to construct a readable and writable GattCharacteristic.
group-onsemi 0:098463de4c5d 697 */
group-onsemi 0:098463de4c5d 698 template <typename T>
group-onsemi 0:098463de4c5d 699 class ReadWriteGattCharacteristic : public GattCharacteristic {
group-onsemi 0:098463de4c5d 700 public:
group-onsemi 0:098463de4c5d 701 /**
group-onsemi 0:098463de4c5d 702 * Construct a ReadWriteGattCharacteristic.
group-onsemi 0:098463de4c5d 703 *
group-onsemi 0:098463de4c5d 704 * @param[in] uuid
group-onsemi 0:098463de4c5d 705 * The characteristic's UUID.
group-onsemi 0:098463de4c5d 706 * @param[in] valuePtr
group-onsemi 0:098463de4c5d 707 * Pointer to the characterisitic's initial value.
group-onsemi 0:098463de4c5d 708 * @param[in] additionalProperties
group-onsemi 0:098463de4c5d 709 * Additional characterisitic properties. By default, the
group-onsemi 0:098463de4c5d 710 * properties are set to
group-onsemi 0:098463de4c5d 711 * Properties_t::BLE_GATT_CHAR_PROPERTIES_WRITE |
group-onsemi 0:098463de4c5d 712 * Properties_t::BLE_GATT_CHAR_PROPERTIES_READ.
group-onsemi 0:098463de4c5d 713 * @param[in] descriptors
group-onsemi 0:098463de4c5d 714 * An array of pointers to descriptors to be added to the new
group-onsemi 0:098463de4c5d 715 * characteristic.
group-onsemi 0:098463de4c5d 716 * @param[in] numDescriptors
group-onsemi 0:098463de4c5d 717 * The total number of descriptors in @p descriptors.
group-onsemi 0:098463de4c5d 718 *
group-onsemi 0:098463de4c5d 719 * @note Instances of ReadWriteGattCharacteristic have variable length
group-onsemi 0:098463de4c5d 720 * attribute value with maximum size equal to sizeof(T). For a fixed length
group-onsemi 0:098463de4c5d 721 * alternative use GattCharacteristic directly.
group-onsemi 0:098463de4c5d 722 */
group-onsemi 0:098463de4c5d 723 ReadWriteGattCharacteristic<T>(const UUID &uuid,
group-onsemi 0:098463de4c5d 724 T *valuePtr,
group-onsemi 0:098463de4c5d 725 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
group-onsemi 0:098463de4c5d 726 GattAttribute *descriptors[] = NULL,
group-onsemi 0:098463de4c5d 727 unsigned numDescriptors = 0) :
group-onsemi 0:098463de4c5d 728 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T), sizeof(T),
group-onsemi 0:098463de4c5d 729 BLE_GATT_CHAR_PROPERTIES_READ | BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
group-onsemi 0:098463de4c5d 730 /* empty */
group-onsemi 0:098463de4c5d 731 }
group-onsemi 0:098463de4c5d 732 };
group-onsemi 0:098463de4c5d 733
group-onsemi 0:098463de4c5d 734 /**
group-onsemi 0:098463de4c5d 735 * Helper class to construct a write-only GattCharacteristic with an array
group-onsemi 0:098463de4c5d 736 * value.
group-onsemi 0:098463de4c5d 737 */
group-onsemi 0:098463de4c5d 738 template <typename T, unsigned NUM_ELEMENTS>
group-onsemi 0:098463de4c5d 739 class WriteOnlyArrayGattCharacteristic : public GattCharacteristic {
group-onsemi 0:098463de4c5d 740 public:
group-onsemi 0:098463de4c5d 741 /**
group-onsemi 0:098463de4c5d 742 * Construct a WriteOnlyGattCharacteristic.
group-onsemi 0:098463de4c5d 743 *
group-onsemi 0:098463de4c5d 744 * @param[in] uuid
group-onsemi 0:098463de4c5d 745 * The characteristic's UUID.
group-onsemi 0:098463de4c5d 746 * @param[in] valuePtr
group-onsemi 0:098463de4c5d 747 * Pointer to an array of length NUM_ELEMENTS containing the
group-onsemi 0:098463de4c5d 748 * characteristic's intitial value.
group-onsemi 0:098463de4c5d 749 * @param[in] additionalProperties
group-onsemi 0:098463de4c5d 750 * Additional characterisitic properties. By default, the
group-onsemi 0:098463de4c5d 751 * properties are set to
group-onsemi 0:098463de4c5d 752 * Properties_t::BLE_GATT_CHAR_PROPERTIES_WRITE.
group-onsemi 0:098463de4c5d 753 * @param[in] descriptors
group-onsemi 0:098463de4c5d 754 * An array of pointers to descriptors to be added to the new
group-onsemi 0:098463de4c5d 755 * characteristic.
group-onsemi 0:098463de4c5d 756 * @param[in] numDescriptors
group-onsemi 0:098463de4c5d 757 * The total number of descriptors in @p descriptors.
group-onsemi 0:098463de4c5d 758 *
group-onsemi 0:098463de4c5d 759 * @note Instances of WriteOnlyGattCharacteristic have variable length
group-onsemi 0:098463de4c5d 760 * attribute value with maximum size equal to sizeof(T) * NUM_ELEMENTS.
group-onsemi 0:098463de4c5d 761 * For a fixed length alternative use GattCharacteristic directly.
group-onsemi 0:098463de4c5d 762 */
group-onsemi 0:098463de4c5d 763 WriteOnlyArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
group-onsemi 0:098463de4c5d 764 T valuePtr[NUM_ELEMENTS],
group-onsemi 0:098463de4c5d 765 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
group-onsemi 0:098463de4c5d 766 GattAttribute *descriptors[] = NULL,
group-onsemi 0:098463de4c5d 767 unsigned numDescriptors = 0) :
group-onsemi 0:098463de4c5d 768 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
group-onsemi 0:098463de4c5d 769 BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
group-onsemi 0:098463de4c5d 770 /* empty */
group-onsemi 0:098463de4c5d 771 }
group-onsemi 0:098463de4c5d 772 };
group-onsemi 0:098463de4c5d 773
group-onsemi 0:098463de4c5d 774 /**
group-onsemi 0:098463de4c5d 775 * Helper class to construct a read-only GattCharacteristic with an array
group-onsemi 0:098463de4c5d 776 * value.
group-onsemi 0:098463de4c5d 777 */
group-onsemi 0:098463de4c5d 778 template <typename T, unsigned NUM_ELEMENTS>
group-onsemi 0:098463de4c5d 779 class ReadOnlyArrayGattCharacteristic : public GattCharacteristic {
group-onsemi 0:098463de4c5d 780 public:
group-onsemi 0:098463de4c5d 781 /**
group-onsemi 0:098463de4c5d 782 * Construct a ReadOnlyGattCharacteristic.
group-onsemi 0:098463de4c5d 783 *
group-onsemi 0:098463de4c5d 784 * @param[in] uuid
group-onsemi 0:098463de4c5d 785 * The characteristic's UUID.
group-onsemi 0:098463de4c5d 786 * @param[in] valuePtr
group-onsemi 0:098463de4c5d 787 * Pointer to an array of length NUM_ELEMENTS containing the
group-onsemi 0:098463de4c5d 788 * characteristic's intitial value.
group-onsemi 0:098463de4c5d 789 * @param[in] additionalProperties
group-onsemi 0:098463de4c5d 790 * Additional characterisitic properties. By default, the
group-onsemi 0:098463de4c5d 791 * properties are set to
group-onsemi 0:098463de4c5d 792 * Properties_t::BLE_GATT_CHAR_PROPERTIES_READ.
group-onsemi 0:098463de4c5d 793 * @param[in] descriptors
group-onsemi 0:098463de4c5d 794 * An array of pointers to descriptors to be added to the new
group-onsemi 0:098463de4c5d 795 * characteristic.
group-onsemi 0:098463de4c5d 796 * @param[in] numDescriptors
group-onsemi 0:098463de4c5d 797 * The total number of descriptors in @p descriptors.
group-onsemi 0:098463de4c5d 798 *
group-onsemi 0:098463de4c5d 799 * @note Instances of ReadOnlyGattCharacteristic have fixed length
group-onsemi 0:098463de4c5d 800 * attribute value that equals sizeof(T) * NUM_ELEMENTS.
group-onsemi 0:098463de4c5d 801 * For a variable length alternative use GattCharacteristic directly.
group-onsemi 0:098463de4c5d 802 */
group-onsemi 0:098463de4c5d 803 ReadOnlyArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
group-onsemi 0:098463de4c5d 804 T valuePtr[NUM_ELEMENTS],
group-onsemi 0:098463de4c5d 805 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
group-onsemi 0:098463de4c5d 806 GattAttribute *descriptors[] = NULL,
group-onsemi 0:098463de4c5d 807 unsigned numDescriptors = 0) :
group-onsemi 0:098463de4c5d 808 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
group-onsemi 0:098463de4c5d 809 BLE_GATT_CHAR_PROPERTIES_READ | additionalProperties, descriptors, numDescriptors, false) {
group-onsemi 0:098463de4c5d 810 /* empty */
group-onsemi 0:098463de4c5d 811 }
group-onsemi 0:098463de4c5d 812 };
group-onsemi 0:098463de4c5d 813
group-onsemi 0:098463de4c5d 814 /**
group-onsemi 0:098463de4c5d 815 * Helper class to construct a readable and writable GattCharacteristic with an array
group-onsemi 0:098463de4c5d 816 * value.
group-onsemi 0:098463de4c5d 817 */
group-onsemi 0:098463de4c5d 818 template <typename T, unsigned NUM_ELEMENTS>
group-onsemi 0:098463de4c5d 819 class ReadWriteArrayGattCharacteristic : public GattCharacteristic {
group-onsemi 0:098463de4c5d 820 public:
group-onsemi 0:098463de4c5d 821 /**
group-onsemi 0:098463de4c5d 822 * Construct a ReadWriteGattCharacteristic.
group-onsemi 0:098463de4c5d 823 *
group-onsemi 0:098463de4c5d 824 * @param[in] uuid
group-onsemi 0:098463de4c5d 825 * The characteristic's UUID.
group-onsemi 0:098463de4c5d 826 * @param[in] valuePtr
group-onsemi 0:098463de4c5d 827 * Pointer to an array of length NUM_ELEMENTS containing the
group-onsemi 0:098463de4c5d 828 * characteristic's intitial value.
group-onsemi 0:098463de4c5d 829 * @param[in] additionalProperties
group-onsemi 0:098463de4c5d 830 * Additional characterisitic properties. By default, the
group-onsemi 0:098463de4c5d 831 * properties are set to
group-onsemi 0:098463de4c5d 832 * Properties_t::BLE_GATT_CHAR_PROPERTIES_WRITE |
group-onsemi 0:098463de4c5d 833 * Properties_t::BLE_GATT_CHAR_PROPERTIES_READ.
group-onsemi 0:098463de4c5d 834 * @param[in] descriptors
group-onsemi 0:098463de4c5d 835 * An array of pointers to descriptors to be added to the new
group-onsemi 0:098463de4c5d 836 * characteristic.
group-onsemi 0:098463de4c5d 837 * @param[in] numDescriptors
group-onsemi 0:098463de4c5d 838 * The total number of descriptors in @p descriptors.
group-onsemi 0:098463de4c5d 839 *
group-onsemi 0:098463de4c5d 840 * @note Instances of ReadWriteGattCharacteristic have variable length
group-onsemi 0:098463de4c5d 841 * attribute value with maximum size equal to sizeof(T) * NUM_ELEMENTS.
group-onsemi 0:098463de4c5d 842 * For a fixed length alternative use GattCharacteristic directly.
group-onsemi 0:098463de4c5d 843 */
group-onsemi 0:098463de4c5d 844 ReadWriteArrayGattCharacteristic<T, NUM_ELEMENTS>(const UUID &uuid,
group-onsemi 0:098463de4c5d 845 T valuePtr[NUM_ELEMENTS],
group-onsemi 0:098463de4c5d 846 uint8_t additionalProperties = BLE_GATT_CHAR_PROPERTIES_NONE,
group-onsemi 0:098463de4c5d 847 GattAttribute *descriptors[] = NULL,
group-onsemi 0:098463de4c5d 848 unsigned numDescriptors = 0) :
group-onsemi 0:098463de4c5d 849 GattCharacteristic(uuid, reinterpret_cast<uint8_t *>(valuePtr), sizeof(T) * NUM_ELEMENTS, sizeof(T) * NUM_ELEMENTS,
group-onsemi 0:098463de4c5d 850 BLE_GATT_CHAR_PROPERTIES_READ | BLE_GATT_CHAR_PROPERTIES_WRITE | additionalProperties, descriptors, numDescriptors) {
group-onsemi 0:098463de4c5d 851 /* empty */
group-onsemi 0:098463de4c5d 852 }
group-onsemi 0:098463de4c5d 853 };
group-onsemi 0:098463de4c5d 854
group-onsemi 0:098463de4c5d 855 #endif /* ifndef __GATT_CHARACTERISTIC_H__ */