GattCharacteristic Class Reference

Standard GATT characteritic properties.

Note:

See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.1.1 and Section 3.3.3.1 for Extended Properties

Standard GATT number types.

Note:

See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.2

See http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml

Standard GATT characteristic presentation format unit types. These unit types are used to decribe what the raw numeric data in a characteristic actually represents.

Note:

See https://developer.bluetooth.org/gatt/units/Pages/default.aspx

GATT presentation format wrapper.

Note:

See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5

See https://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml

Standard GATT characteritic properties.

Note:

See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.1.1 and Section 3.3.3.1 for Extended Properties

Enumerator:

BLE_GATT_CHAR_PROPERTIES_BROADCAST	Permits broadcasts of the Characteristic Value using Server Characteristic Configuration Descriptor.
BLE_GATT_CHAR_PROPERTIES_READ	Permits reads of the Characteristic Value.
BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE	Permits writes of the Characteristic Value without response.
BLE_GATT_CHAR_PROPERTIES_WRITE	Permits writes of the Characteristic Value with response.
BLE_GATT_CHAR_PROPERTIES_NOTIFY	Permits notifications of a Characteristic Value without acknowledgement.
BLE_GATT_CHAR_PROPERTIES_INDICATE	Permits indications of a Characteristic Value with acknowledgement.
BLE_GATT_CHAR_PROPERTIES_AUTHENTICATED_SIGNED_WRITES	Permits signed writes to the Characteristic Value.
BLE_GATT_CHAR_PROPERTIES_EXTENDED_PROPERTIES	Additional characteristic properties are defined in the Characteristic Extended Properties Descriptor.

Definition at line 272 of file GattCharacteristic.h.

Standard GATT number types.

Note:

See Bluetooth Specification 4.0 (Vol. 3), Part G, Section 3.3.3.5.2

See http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml

Enumerator:

BLE_GATT_FORMAT_RFU	Reserved For Future Use.
BLE_GATT_FORMAT_BOOLEAN	Boolean.
BLE_GATT_FORMAT_2BIT	Unsigned 2-bit integer.
BLE_GATT_FORMAT_NIBBLE	Unsigned 4-bit integer.
BLE_GATT_FORMAT_UINT8	Unsigned 8-bit integer.
BLE_GATT_FORMAT_UINT12	Unsigned 12-bit integer.
BLE_GATT_FORMAT_UINT16	Unsigned 16-bit integer.
BLE_GATT_FORMAT_UINT24	Unsigned 24-bit integer.
BLE_GATT_FORMAT_UINT32	Unsigned 32-bit integer.
BLE_GATT_FORMAT_UINT48	Unsigned 48-bit integer.
BLE_GATT_FORMAT_UINT64	Unsigned 64-bit integer.
BLE_GATT_FORMAT_UINT128	Unsigned 128-bit integer.
BLE_GATT_FORMAT_SINT8	Signed 2-bit integer.
BLE_GATT_FORMAT_SINT12	Signed 12-bit integer.
BLE_GATT_FORMAT_SINT16	Signed 16-bit integer.
BLE_GATT_FORMAT_SINT24	Signed 24-bit integer.
BLE_GATT_FORMAT_SINT32	Signed 32-bit integer.
BLE_GATT_FORMAT_SINT48	Signed 48-bit integer.
BLE_GATT_FORMAT_SINT64	Signed 64-bit integer.
BLE_GATT_FORMAT_SINT128	Signed 128-bit integer.
BLE_GATT_FORMAT_FLOAT32	IEEE-754 32-bit floating point.
BLE_GATT_FORMAT_FLOAT64	IEEE-754 64-bit floating point.
BLE_GATT_FORMAT_SFLOAT	IEEE-11073 16-bit SFLOAT.
BLE_GATT_FORMAT_FLOAT	IEEE-11073 32-bit FLOAT.
BLE_GATT_FORMAT_DUINT16	IEEE-20601 format.
BLE_GATT_FORMAT_UTF8S	UTF-8 string.
BLE_GATT_FORMAT_UTF16S	UTF-16 string.
BLE_GATT_FORMAT_STRUCT	Opaque Structure.

Definition at line 233 of file GattCharacteristic.h.

Standard GATT characteristic presentation format unit types. These unit types are used to decribe what the raw numeric data in a characteristic actually represents.

Note:

See https://developer.bluetooth.org/gatt/units/Pages/default.aspx

Enumerator:

BLE_GATT_UNIT_NONE	No specified unit type.
BLE_GATT_UNIT_LENGTH_METRE	Length, Metre.
BLE_GATT_UNIT_MASS_KILOGRAM	Mass, Kilogram.
BLE_GATT_UNIT_TIME_SECOND	Time, Second.
BLE_GATT_UNIT_ELECTRIC_CURRENT_AMPERE	Electric Current, Ampere.
BLE_GATT_UNIT_THERMODYNAMIC_TEMPERATURE_KELVIN	Thermodynamic Temperature, Kelvin.
BLE_GATT_UNIT_AMOUNT_OF_SUBSTANCE_MOLE	Amount of Substance, Mole.
BLE_GATT_UNIT_LUMINOUS_INTENSITY_CANDELA	Luminous Intensity, Candela.
BLE_GATT_UNIT_AREA_SQUARE_METRES	Area, Square Metres.
BLE_GATT_UNIT_VOLUME_CUBIC_METRES	Volume, Cubic Metres.
BLE_GATT_UNIT_VELOCITY_METRES_PER_SECOND	Velocity, Metres per Second.
BLE_GATT_UNIT_ACCELERATION_METRES_PER_SECOND_SQUARED	Acceleration, Metres per Second Squared.
BLE_GATT_UNIT_WAVENUMBER_RECIPROCAL_METRE	Wave Number Reciprocal, Metre.
BLE_GATT_UNIT_DENSITY_KILOGRAM_PER_CUBIC_METRE	Density, Kilogram per Cubic Metre.
BLE_GATT_UNIT_MAGNETIC_FIELD_STRENGTH_AMPERE_PER_METRE	Magnetic Field Strength, Ampere per Metre.
BLE_GATT_UNIT_FREQUENCY_HERTZ	Frequency, Hertz.
BLE_GATT_UNIT_FORCE_NEWTON	Force, Newton.
BLE_GATT_UNIT_PRESSURE_PASCAL	Pressure, Pascal.
BLE_GATT_UNIT_ENERGY_JOULE	Energy, Joule.
BLE_GATT_UNIT_POWER_WATT	Power, Watt.
BLE_GATT_UNIT_ELECTRIC_CHARGE_COULOMB	Electrical Charge, Coulomb.
BLE_GATT_UNIT_ELECTRIC_POTENTIAL_DIFFERENCE_VOLT	Electrical Potential Difference, Voltage.
BLE_GATT_UNIT_TIME_MINUTE	Time, Minute.
BLE_GATT_UNIT_TIME_HOUR	Time, Hour.
BLE_GATT_UNIT_TIME_DAY	Time, Day.
BLE_GATT_UNIT_PRESSURE_BAR	Pressure, Bar.
BLE_GATT_UNIT_PRESSURE_MILLIMETRE_OF_MERCURY	Pressure, Millimetre of Mercury.
BLE_GATT_UNIT_LENGTH_YARD	Length, Yard.
BLE_GATT_UNIT_LENGTH_PARSEC	Length, Parsec.
BLE_GATT_UNIT_LENGTH_INCH	Length, Inch.
BLE_GATT_UNIT_LENGTH_FOOT	Length, Foot.
BLE_GATT_UNIT_LENGTH_MILE	Length, Mile.
BLE_GATT_UNIT_VELOCITY_KILOMETRE_PER_HOUR	Velocity, Kilometre per Hour.
BLE_GATT_UNIT_VELOCITY_MILE_PER_HOUR	Velocity, Mile per Hour.
BLE_GATT_UNIT_ANGULAR_VELOCITY_REVOLUTION_PER_MINUTE	Angular Velocity, Revolution per Minute.
BLE_GATT_UNIT_ENERGY_GRAM_CALORIE	Energy, Gram Calorie.
BLE_GATT_UNIT_ENERGY_KILOGRAM_CALORIE	Energy, Kilogram Calorie.
BLE_GATT_UNIT_ENERGY_KILOWATT_HOUR	Energy, Killowatt Hour.
BLE_GATT_UNIT_PERCENTAGE	Percentage.
BLE_GATT_UNIT_TIME_YEAR	Time, Year.
BLE_GATT_UNIT_TIME_MONTH	Time, Month.

Definition at line 113 of file GattCharacteristic.h.

Creates a new GattCharacteristic using the specified 16-bit UUID, value length, and properties.

Note:

The UUID value must be unique in the service and is normally >1

Parameters:

[in]	uuid	The UUID to use for this characteristic
[in]	valuePtr	The memory holding the initial value. The value is copied into the stack when the enclosing service is added; and thereafter maintained internally by the stack.
[in]	initialLen	The min length in bytes of this characteristic's value
[in]	maxLen	The max length in bytes of this characteristic's value
[in]	props	The 8-bit bit field containing the characteristic's properties
[in]	descriptors	A pointer to an array of descriptors to be included within this characteristic
[in]	numDescriptors	The number of descriptors

: If valuePtr == NULL, initialLength == 0, and properties == READ for the value attribute of a characteristic, then that particular characteristic may be considered optional and dropped while instantiating the service with the underlying BLE stack.

Definition at line 329 of file GattCharacteristic.h.