Characteristic Type
A GATT characteristic.
Remarks
This type represents a GATT characteristic.
Fields
|
CachedValue String |
The most recently cached value of this characteristic. To read the characteristic's value directly from the remote server, use ReadValue. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CachedValueB TBytes |
The most recently cached value of this characteristic. To read the characteristic's value directly from the remote server, use ReadValue. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CanSubscribe Boolean |
Whether or not you can subscribe to receive value updates for this characteristic. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Description String |
This characteristic's Bluetooth SIG user-friendly name, if one is defined. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Flags Integer |
A bitmask of this characteristic's flags. This property is a bitmask which represents all of the flags (or, in BLE terms, "properties") which this characteristic has set. The following table shows what bitmask is used to represent each flag:
Note that, on some platforms, the component might have to automatically discover specific descriptors for the value this returns to be accurate. The component take care of handling this automatic discovery in the most energy-efficient manner possible. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Id String |
An identification string which uniquely identifies this instance of this characteristic. This identification string is guaranteed to be unchanged while the component remains connected to the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subscribed Boolean |
Whether or not the component has subscribed to updates for this characteristic's value. See Subscribe for more information. Note that, on some platforms, the component might have to automatically discover specific descriptors for the value this returns to be accurate. The component take care of handling this automatic discovery in the most energy-efficient manner possible. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
UserDescription String |
The value of the user description descriptor for this characteristic. If the "Writable Auxiliaries" property is set for this characteristic, you can change this value, which updates it on the server too. Note that, on some platforms, the component might have to automatically discover specific descriptors for the value this returns to be accurate. The component take care of handling this automatic discovery in the most energy-efficient manner possible. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Uuid String |
This characteristic's 128-bit UUID string. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValueExponent Integer |
The exponent of this characteristic's value, for applicable value formats. For an applicable ValueFormat, this signed integer should be used as an exponent in the following formula in order to determine the actual value of the characteristic: [Value] * 10^[Exponent]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValueFormat TiplValueFormats |
The data type of this characteristic's value. The valid options are as follows:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValueFormatCount Integer |
The number of value formats this characteristic has. Characteristics whose values are an aggregate of multiple other values will often have multiple value formats as a result. In such cases, this property's value will be greater than 1, and the ValueFormatIndex property can be used to choose which value format the ValueFormat, ValueExponent, and ValueUnit properties are populated with. Note that, on some platforms, the component might have to automatically discover specific descriptors for the value this returns to be accurate. The component take care of handling this automatic discovery in the most energy-efficient manner possible. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValueFormatIndex Integer |
Selects the currently populated value format details for this characteristic. See ValueFormatCount for more details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValueUnit String |
The 128-bit UUID string that represents the unit of measurement for this characteristic's value. |
Constructors
constructor Create();