wcl |
Bluetooth Low Energy GATT client.
Inheritance HierarchyNamespace: wclBluetooth
Assembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.17.12.0 (7.17.12.0)
SyntaxThe wclGattClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | wclGattClient | Creates new TwclGattClient component. |
Properties| Name | Description | |
|---|---|---|
 | Address | Gets and sets a target Bluetooth device's MAC address. |
| ConnectOnRead | Gets and sets connection mode. |
| ForceNotifications | Gets and sets the notifications mode. |
| Radio | Gets the Radio used for connection. |
| State | Gets the client state. |
Methods| Name | Description | |
|---|---|---|
| Connect | Connects to a remote Bluetooth LE device. |
| Disconnect | Disconnects from a remote device. |
 | DoCharacteristicChanged | Fires the OnCharacteristicChanged event. |
| DoConnect | Fires the OnConnected event. |
| DoConnectionParamsChanged | Fires the OnConnectionParamsChanged event. |
| DoConnectionPhyChanged | Fires the OnConnectionPhyChanged event. |
| DoDisconnect | Fires then OnDisconnected event. |
| DoMaxPduSizeChanged | Fires the OnMaxPduSizeChanged event. |
| Enter | Enters the Bluetooth component protection critical
section. (Inherited from wclBluetoothComponent) |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindCharacteristic | The method searches the characteristic in given service with the specified UUID. |
| FindService | The method searches the service with specified UUID. |
| GetConnectionParams | Gets the current connection parameters. |
| GetConnectionPhyInfo | Reads the Bluetooth LE physical layer (PHY) information. |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object) |
| GetMaxPduSize | Reads the maximum PDU size for the current connection. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Leave | Leaves the Bluetooth component protection critical
section. (Inherited from wclBluetoothComponent) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ReadCharacteristics | The method reads all the characteristics available for the specified service. |
| ReadCharacteristicValue | The method reads the value of the specified characteristic. |
| ReadDescriptors | The method reads all the descriptors available for the specified characteristic. |
| ReadDescriptorValue | The method reads the value of the specified descriptor. |
| ReadIncludedServices | The method reads all the included services available for a given service. |
| ReadServices | Reads available services from a remote Bluetooth LE device. |
| SetConnectionParams(wclBluetoothLeConnectionParametersType) | Request the connection parameters change to the specified preferred connection parameters. |
| SetConnectionParams(wclBluetoothLeConnectionParametersValue) | Request the connection parameters change to the specified preferred connection parameters. |
| Subscribe | Subscribes for the characteristic changes notifications. |
| SubscribeForNotifications | Subscribes for the characteristic changes notifications and writes the client configuration descriptor to the device. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Unsubscribe | Unsubscribes from the characteristic changes notifications. |
| UnsubscribeFromNotifications | Unsubscribes from the characteristic changes notifications and writes the client configuration descriptor to the device. |
| WriteCharacteristicValue | The method writes the specified characteristic value to the Bluetooth device. |
| WriteClientConfiguration | Writes the client configuration descriptor to the device. |
| WriteDescriptorValue | The method writes the specified descriptor value to the Bluetooth device. |
Events| Name | Description | |
|---|---|---|
 | 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. |
| OnConnectionParamsChanged | The event fires when the connection parameters changed. |
| OnConnectionPhyChanged | The event fires when the connection PHY changed. |
| OnDisconnect | The even fires when a connection to a remote device has been closed. |
| OnMaxPduSizeChanged | The event fires when the maximum PDU size changed. |
Remarks The TwclGattClient component enables an
application to connect to a Bluetooth Low Energy device and work
with GATT profiles.
See Also