Platforms to show: All Mac Windows Linux Cross-Platform
WindowsGattCharacteristicMBS class
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Bluetooth | MBS WinFrameworks Plugin | 22.3 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
The GattCharacteristic object represents a GATT Characteristic of a particular service, and is obtained from the Characteristics property of the GattDeviceService object.
- 8 events
- event DescriptorsCompleted(asyncStatus as Integer, Result as WindowsGattDescriptorsResultMBS)
- event ReadClientCharacteristicConfigurationDescriptorAsyncCompleted(asyncStatus as Integer, Result as WindowsGattReadClientCharacteristicConfigurationDescriptorResultMBS)
- event ReadValueAsyncCompleted(asyncStatus as Integer, Result as WindowsGattReadResultMBS)
- event ValueChanged(args as WindowsGattValueChangedEventArgsMBS)
- event WriteClientCharacteristicConfigurationDescriptorAsyncCompleted(asyncStatus as Integer, Status as Integer)
- event WriteClientCharacteristicConfigurationDescriptorWithResultAsyncCompleted(asyncStatus as Integer, Result as WindowsGattWriteResultMBS)
- event WriteValueAsyncCompleted(asyncStatus as Integer, Result as Integer)
- event WriteValueWithResultAsyncCompleted(asyncStatus as Integer, Result as WindowsGattWriteResultMBS)
- 7 properties
- property AttributeHandle as Integer
- property CharacteristicProperties as Integer
- property Handle as Integer
- property ProtectionLevel as Integer
- property Service as WindowsGattDeviceServiceMBS
- property UserDescription as String
- property UUID as String
- 18 methods
- method AllDescriptors as WindowsGattDescriptorMBS()
- method Constructor Private
- method Constructor(other as WindowsGattCharacteristicMBS)
- method Descriptors(characteristicUUID as String) as WindowsGattDescriptorMBS()
- method Destructor
- method GetDescriptorsAsync
- method GetDescriptorsAsync(BluetoothCacheMode as Integer)
- method GetDescriptorsForUuidAsync(characteristicUuid as String)
- method GetDescriptorsForUuidAsync(characteristicUuid as String, BluetoothCacheMode as Integer)
- method ReadClientCharacteristicConfigurationDescriptorAsync
- method ReadValueAsync
- method ReadValueAsync(CacheMode as Integer)
- method WriteClientCharacteristicConfigurationDescriptorAsync(ClientCharacteristicConfigurationDescriptorValue as Integer)
- method WriteClientCharacteristicConfigurationDescriptorWithResultAsync(ClientCharacteristicConfigurationDescriptorValue as Integer)
- method WriteValueAsync(buffer as MemoryBlock)
- method WriteValueAsync(buffer as MemoryBlock, WriteOption as Integer)
- method WriteValueWithResultAsync(buffer as MemoryBlock)
- method WriteValueWithResultAsync(buffer as MemoryBlock, WriteOption as Integer)
- 82 shared methods
- shared method AlertCategoryId as String
- shared method AlertCategoryIdBitMask as String
- shared method AlertLevel as String
- shared method AlertNotificationControlPoint as String
- shared method AlertStatus as String
- shared method BatteryLevel as String
- shared method BloodPressureFeature as String
- shared method BloodPressureMeasurement as String
- shared method BodySensorLocation as String
- shared method BootKeyboardInputReport as String
- shared method BootKeyboardOutputReport as String
- shared method BootMouseInputReport as String
- shared method ConvertShortIdToUuid(ID as UInt16) as String
- shared method CscFeature as String
- shared method CscMeasurement as String
- shared method CurrentTime as String
- shared method CyclingPowerControlPoint as String
- shared method CyclingPowerFeature as String
- shared method CyclingPowerMeasurement as String
- shared method CyclingPowerVector as String
- shared method DateTime as String
- shared method DayDateTime as String
- shared method DayOfWeek as String
- shared method DstOffset as String
- shared method ExactTime256 as String
- shared method FirmwareRevisionString as String
- shared method GapAppearance as String
- shared method GapDeviceName as String
- shared method GapPeripheralPreferredConnectionParameters as String
- shared method GapPeripheralPrivacyFlag as String
- shared method GapReconnectionAddress as String
- shared method GattServiceChanged as String
- shared method GlucoseFeature as String
- shared method GlucoseMeasurement as String
- shared method GlucoseMeasurementContext as String
- shared method HardwareRevisionString as String
- shared method HeartRateControlPoint as String
- shared method HeartRateMeasurement as String
- shared method HidControlPoint as String
- shared method HidInformation as String
- shared method Ieee1107320601RegulatoryCertificationDataList as String
- shared method IntermediateCuffPressure as String
- shared method IntermediateTemperature as String
- shared method LnControlPoint as String
- shared method LnFeature as String
- shared method LocalTimeInformation as String
- shared method LocationAndSpeed as String
- shared method ManufacturerNameString as String
- shared method MeasurementInterval as String
- shared method ModelNumberString as String
- shared method Navigation as String
- shared method NewAlert as String
- shared method PnpId as String
- shared method PositionQuality as String
- shared method ProtocolMode as String
- shared method RecordAccessControlPoint as String
- shared method ReferenceTimeInformation as String
- shared method Report as String
- shared method ReportMap as String
- shared method RingerControlPoint as String
- shared method RingerSetting as String
- shared method RscFeature as String
- shared method RscMeasurement as String
- shared method ScanIntervalWindow as String
- shared method ScanRefresh as String
- shared method SCControlPoint as String
- shared method SensorLocation as String
- shared method SerialNumberString as String
- shared method SoftwareRevisionString as String
- shared method SupportedNewAlertCategory as String
- shared method SupportUnreadAlertCategory as String
- shared method SystemId as String
- shared method TemperatureMeasurement as String
- shared method TemperatureType as String
- shared method TimeAccuracy as String
- shared method TimeSource as String
- shared method TimeUpdateControlPoint as String
- shared method TimeUpdateState as String
- shared method TimeWithDst as String
- shared method TimeZone as String
- shared method TxPowerLevel as String
- shared method UnreadAlertStatus as String
- 23 constants
Cache Modes
Constant | Value | Description |
---|---|---|
CacheModeCached | 0 |
Cached data. |
CacheModeUncached | 1 |
Uncached data. |
GATT characteristic properties
Constant | Value | Description |
---|---|---|
PropertiesAuthenticatedSignedWrites | &h40 |
The characteristic supports signed writes. |
PropertiesBroadcast | 1 |
The characteristic supports broadcasting. |
PropertiesExtendedProperties | &h80 |
The ExtendedProperties Descriptor is present. |
PropertiesIndicate | &h20 |
The characteristic is indicatable. |
PropertiesNone | 0 |
The characteristic doesn’t have any properties that apply. |
PropertiesNotify | &h10 |
The characteristic is notifiable. |
PropertiesRead | 2 |
The characteristic is readable. |
PropertiesReliableWrites | &h100 |
The characteristic supports reliable writes. |
PropertiesWritableAuxiliaries | &h200 |
The characteristic has writable auxiliaries. |
PropertiesWrite | 8 |
The characteristic is writable. |
PropertiesWriteWithoutResponse | 4 |
The characteristic supports Write Without Response. |
Protection Levels
Constant | Value | Description |
---|---|---|
ProtectionLevelAuthenticationRequired | 1 |
Require the link to be authenticated. |
ProtectionLevelEncryptionAndAuthenticationRequired | 3 |
Require the link to be encrypted and authenticated. |
ProtectionLevelEncryptionRequired | 2 |
Require the link to be encrypted. |
ProtectionLevelPlain | 0 |
Uses the default protection level. |
Status Values
Constant | Value | Description |
---|---|---|
StatusAccessDenied | 3 |
Access is denied. |
StatusProtocolError | 2 |
There was a GATT communication protocol error. |
StatusSuccess | 0 |
The operation completed successfully. |
StatusUnreachable | 1 |
No communication can be performed with the device, at this time. |
Write Options
Constant | Value | Description |
---|---|---|
WriteWithoutResponse | 1 |
The Write Without Response procedure shall be used. |
WriteWithResponse | 0 |
The default GATT write procedure shall be used. |
This class has no sub classes.
Some methods using this class:
- WindowsGattCharacteristicsResultMBS.Characteristics as WindowsGattCharacteristicMBS()
- WindowsGattDeviceServiceMBS.GetAllCharacteristics as WindowsGattCharacteristicMBS()
Some examples using this class:
Blog Entries
- News from the MBS Xojo Plugins in Version 23.0
- MonkeyBread Software Releases the MBS Xojo Plugins in version 23.0
- The Top 10 from the MBS Xojo Plugins in 2022
- Bluetooth LE on Windows
- MBS Xojo Plugins, version 22.6pr1
- News from the MBS Xojo Plugins Version 22.3
- MBS Xojo Plugins in version 22.3
- MBS Xojo Plugins, version 22.3pr6
- MBS Xojo Plugins, version 22.3pr5
- MBS Xojo Plugins, version 22.3pr1
Xojo Developer Magazine
Release notes
- Version 23.0
- Added shared methods to WindowsGattCharacteristicMBS to return GUIDs for various characteristics.
- Fixed a bug in WindowsGattCharacteristicMBS class for getting UUID.
- Version 22.3
- Added more methods to WindowsGattCharacteristicMBS class.
- Added WindowsGattWriteResultMBS, WindowsGattWriteRequestMBS, WindowsGattReadResultMBS, WindowsGattReadRequestMBS, WindowsGattDeviceServiceMBS and WindowsGattCharacteristicMBS classes.
The items on this page are in the following plugins: MBS WinFrameworks Plugin.
WindowsFontFamilyMBS - WindowsGattCharacteristicsResultMBS