Skip to main content

Watch Shutter

Attributes

Common

ID

Sets the object's ID.

The ID identifies the object and is used to reference it in UISet actions, allowing to change its attributes dynamically.

The ID is not unique, it can be shared among multiple objects to quickly change a common attribute.

IDs can't be changed with a UISet action, but they can have a Value Binding assigned to them. Value Bindings on IDs allow an object to be dinamically attached to a set of attribute values.

E.g. the following Value Binding switches the ID of the object between mybutton1 and mybutton2 based on the value of the UISet button.address:

Value binding: ="mybutton" + ui('button', 'address')

UISet: UISet('button', 'address', '1') switches the ID to mybutton1 UISet('button', 'address', '2') switches the ID to mybutton2

Mode

Specifies the mode of the shutter.

The default value is: vertical.

Attribute Values
ValueDescription
verticalDefault value. Vertical.
horizontalHorizontal.

Label

Specifies the label.

Attribute Values
ValueDescription
<string>Label text.

Action

Specifies the action performed when tapped.

The default value is: user.

Attribute Values
ValueDescription
userDefault value. Sends a command to the server, with the specified name and parameter.
deviceToggles a datapoint.

Name

Specifies the name of the command.

Attribute Values
ValueDescription
<string>Command name.

Param

Specifies the parameter of the command.

Attribute Values
ValueDescription
<string>Command parameter.

Address

Specifies the datapoint.

Attribute Values
ValueDescription
<string>Datapoint address.

Confirm

Specifies whether the button needs to be tapped twice to perform the action.

The default value is: false.

Attribute Values
ValueDescription
falseDefault value. Button needs to be tapped once.
trueButton needs to be tapped twice.

Meta

Comment

Specifies a comment, visible only in the Project Editor. It can be used to add a note or a tag to the object. The filter in the object's SELECT panel applies to the comment as well.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Exclude

Excludes the object from the UI. Useful to temporarily hide an object without deleting it. Different from the "Visible" attribute, which hides the object in the UI but keeps it in the project, allowing it to be shown again with a UISet.

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Attribute Values
ValueDescription
falseDefault value. Object is included in the UI.
trueObject is excluded from the UI.