TwclGattClient Class

Bluetooth Low Energy GATT client.

Namespace: wclBluetooth
TComponent
  wclBluetooth.TwclBluetoothComponent
    wclBluetooth.TwclGattClient
type
 TwclGattClient = class(TwclBluetoothComponent)
 end;

The TwclGattClient type exposes the following members.

Show:
 NameDescription
Create(TComponent)

Creates new TwclGattClient component. (Overrides TwclBluetoothComponent.Create(TComponent).)

Destroy

Frees the component. (Overrides TwclBluetoothComponent.Destroy.)

Top
Show:
 NameDescription
Address

Gets and sets a target Bluetooth device's MAC address.

ConnectOnRead

Gets and sets connection mode.

ForceNotifications

Gets and sets the notifications mode.

OnConnectionParamsChanged

The event fires when the connection parameters changed.

OnConnectionPhyChanged

The event fires when the connection PHY changed.

OnMaxPduSizeChanged

The event fires when the maximum PDU size changed.

Radio

Gets the Radio used for connection.

State

Gets the client state.

Top
Show:
 NameDescription
Connect(TwclBluetoothRadio)

Connects to a remote Bluetooth LE device.

Disconnect

Disconnects from a remote device.

DoCharacteristicChanged(Word,TwclGattCharacteristicValue)

Fires the OnCharacteristicChanged event.

DoConnect(Integer)

Fires the OnConnected event.

DoConnectionParamsChanged

Fires the OnConnectionParamsChanged event.

DoConnectionPhyChanged

Fires the OnConnectionPhyChanged event.

DoDisconnect(Integer)

Fires then OnDisconnected event.

DoMaxPduSizeChanged

Fires the OnMaxPduSizeChanged event.

Enter

Enters the Bluetooth component protection critical section. (Inherited from TwclBluetoothComponent.)

FindCharacteristic(TwclGattService,TwclGattUuid,TwclGattCharacteristic,TwclGattOperationFlag)

The method searches the characteristic in given service with the specified UUID.

FindService(TwclGattUuid,TwclGattService,TwclGattOperationFlag)

The method searches the service with specified UUID.

GetConnectionParams(TwclBluetoothLeConnectionParameters)

Gets the current connection parameters.

GetConnectionPhyInfo(TwclBluetoothLeConnectionPhy)

Reads the Bluetooth LE physical layer (PHY) information.

GetMaxPduSize(Word)

Reads the maximum PDU size for the current connection.

Leave

Leaves the Bluetooth component protection critical section. (Inherited from TwclBluetoothComponent.)

ReadCharacteristics(TwclGattService,TwclGattOperationFlag,TwclGattCharacteristics)

The method reads all the characteristics available for the specified service.

ReadCharacteristicValue(TwclGattCharacteristic,TwclGattOperationFlag,TwclGattCharacteristicValue,TwclGattProtectionLevel)

The method reads the value of the specified characteristic.

ReadDescriptors(TwclGattCharacteristic,TwclGattOperationFlag,TwclGattDescriptors)

The method reads all the descriptors available for the specified characteristic.

ReadDescriptorValue(TwclGattDescriptor,TwclGattOperationFlag,TwclGattDescriptorValue,TwclGattProtectionLevel)

The method reads the value of the specified descriptor.

ReadIncludedServices(TwclGattService,TwclGattOperationFlag,TwclGattServices)

The method reads all the included services available for a given service.

ReadServices(TwclGattOperationFlag,TwclGattServices)

Reads available services from a remote Bluetooth LE device.

SetConnectionParams(TwclBluetoothLeConnectionParametersType)

Overloaded. Request the connection parameters change to the specified preferred connection parameters.

SetConnectionParams(TwclBluetoothLeConnectionParametersValue)

Overloaded. Request the connection parameters change to the specified preferred connection parameters.

SetCopy(TwclCustomConnection)

The method sets new copy of the current connection. (Inherited from TwclBluetoothComponent.)

Subscribe(TwclGattCharacteristic,TwclGattSubscribeKind)

Subscribes for the characteristic changes notifications.

SubscribeForNotifications(TwclGattCharacteristic,TwclGattOperationFlag,TwclGattProtectionLevel,TwclGattSubscribeKind)

Subscribes for the characteristic changes notifications and writes the client configuration descriptor to the device.

Unsubscribe(TwclGattCharacteristic,TwclGattSubscribeKind)

Unsubscribes from the characteristic changes notifications.

UnsubscribeFromNotifications(TwclGattCharacteristic,TwclGattOperationFlag,TwclGattProtectionLevel,TwclGattSubscribeKind)

Unsubscribes from the characteristic changes notifications and writes the client configuration descriptor to the device.

WriteCharacteristicValue(TwclGattCharacteristic,TwclGattCharacteristicValue,TwclGattProtectionLevel,TwclGattWriteKind)

The method writes the specified characteristic value to the Bluetooth device.

WriteClientConfiguration(TwclGattCharacteristic,Boolean,TwclGattOperationFlag,TwclGattProtectionLevel,TwclGattSubscribeKind)

Writes the client configuration descriptor to the device.

WriteDescriptorValue(TwclGattDescriptor,TwclGattDescriptorValue,TwclGattProtectionLevel)

The method writes the specified descriptor value to the Bluetooth device.

Top
Show:
 NameDescription
OnCharacteristicChanged

The event fires when a subscribed characteristic value has been changed.

OnConnect

The event fires when a connection to a remote device has been established.

OnDisconnect

The even fires when a connection to a remote device has been closed.

Top

The TwclGattClient component enables an application to connect to a Bluetooth Low Energy device and work with GATT profiles.