Web Thing Property Element

The Web Thing Property element is used to define a single Thing Property Description for a device. There may be multiple Web Thing Property elements per project.

Web Thing Property elements work in a similar way to the BLE Characteristic Custom Element. You can write data to them, and receive a trigger when they’ve been written to.

This element is only available for ESP32 based platforms.

Properties

The following properties can be changed for the Web Thing Property element:

Name

The name of the element.

Capability

The capability implemented by this Web Thing Property. The full specification and description of the various capabilities can be found here.

If a capability is chosen that requires a specific unit, such as the TemperatureProperty, the user’s input will be ignored and the unit from the specification will instead be used.

Title [Optional]

A user friendly title for the element. This is the name that will be displayed in the Mozilla Web Things Gateway for your property.

If not specified, the name of the element will be used.

Description [Optional]

A description of the property.

Data Type

The data type of the property.

Initial Value

The initial value of the property.

Minimum Value [Optional]

Minimum value of the property. This is only used for integer and unsigned integer data types.

Maximum Value [Optional]

Maximum value of the property. This is only used for integer and unsigned integer data types.

SI Unit [Optional]

SI or SI-derived unit. For a list of common units, see this page.

Triggers

The following triggers are available to execute events from within the Web Thing Property element:

Triggered

Execute an event when the source element connected to the Web Thing triggers.

Written

Execute an event when the property is written to. The newly written data is passed with the event.

Abilities

The following abilities are available for the Web Thing Property element when its source element triggers:

Trigger

Trigger the element(s) that follow the Web Thing Property element.

Write

Write new data to the property. Data will be converted to your selected data type.