BLE Characteristic Element

The BLE characteristic element is used to create a GATT characteristic. This element is a coupled element that bridges the project between the Embedded tab and Application tab, meaning it’s included on both tabs.

The BLE characteristic element is located in the Element Toolbox within Studio’s the Embedded tab. When a BLE characteristic element is added to the canvas, it creates a coupled version in the project’s Cloud tab that bridges the element’s functionality between the two tabs.

Properties

The following properties can be changed for the BLE characteristic element:

Name

The name of the element.

Instance

The BLE driver instance number to use. If unsure leave it set to the default value.

Service UUID (128-bit)

The 128-bit UUID given to the GATT services in the project.

Characteristic UUID (128-bit)

The 128-bit UUID given to the GATT characteristics in the project.

Read

The state of the element’s ability to read data: enabled or disabled.

Read Data Type

The data type the element reads. The element includes the following data types:

  • Void
  • Character
  • Integer
  • Unsigned Integer
  • Floating Point (32-bit)
  • Double Floating Point (64-bit)
  • String
  • Boolean
  • Raw Binary Data
  • 3D Float (32-bit) Vector
  • 3D Double (64-bit) Vector

This is the data type the mobile device will receive when data is written from the embedded device. On the embedded device, the data will be converted to this type before being written to the BLE Characteristic.

Write

The state of the element’s ability to write: enabled or disabled.

Write Data Type

The data type the element writes with. This is the data type the embedded device will receive when data is written from the mobile device. On the mobile device, the data will be converted to this type before being written to the BLE Characteristic.

Notify

The state of the element’s ability to be notified: enabled or disabled.

Notify Data Type

The data type the element is notified with.

Embedded Triggers

The following triggers are available to execute events from within the BLE characteristic element:

Triggered

Execute an event when the source element connected to the BLE characteristic triggers.

Written

Execute an event when data is written to the BLE characteristic.

Subscribed

Execute an event when client has subscribed to the characteristic.

Unsubscribed

Execute an event when client has unsubscribe to the characteristic.

Embedded Abilities

The following abilities are available for the BLE characteristic element when its source element triggers:

Trigger

Trigger the element(s) that follow the BLE characteristic element.

Set Value

Set the value of the BLE characteristic element.

Written

Trigger the written events.

Subscribe

Subscibes to notifications from the characteristic.

Unsubscribe

Unsubscribes to notifications from the characteristic.

App Triggers

The following triggers are available to execute events from within the BLE characteristic element on the Application side:

Triggered

Execute an event when the source element connected to the BLE characteristic triggers.

Read

Execute an event when the data has been read from a characteristic.

Written

Execute an event when data is written to the BLE characteristic.

Notification

Execute an event when the client has received notification data.

Indication

Execute an event when the client has recieved indication data.

Subscribed

Execute an event when client has subscribed to the characteristic.

Unsubscribed

Execute an event when client has unsubscribe to the characteristic.

App Abilities

The following abilities are available for the BLE characteristic element when its source element triggers:

Trigger

Trigger the element(s) that follow the BLE characteristic element.

Read

Request a read from the BLE characteristic.

Write

Write data to the BLE characteristic.

Write without Response

Write data to the BLE characteristic without requiring a response from the server.

Subscribe

Subscibes to notifications from the characteristic.

Unsubscribe

Unsubscribes to notifications from the characteristic.