ebm-papst Kickstart - Manual (Page 28)

28
6 Kickstart Modules
shape
Defines the type of control will be created when the
Data Object is dropped on the UI Panel canvas. Available standard shapes:
shape: Description
label simple control used to display a read-only value
text text box control to display or edit a value
slider vertical slider control used to display or modify a value within a given range
dial dial control used to display or modify a value within a given range
radio a list of options displayed as radio buttons, each one representing a certain data object value (e.g. “3”) and a
matching description (e.g. “Velocity Mode”). See the
options description for more details.
bitfield a list of bit signals. Each signal corresponds to one bit of the control’s integer value. See the options and
fieldsize descriptions for more details.
NOTICe
Every shape corresponds to one .qml file from the / QML folder of your Kickstart Project, e.g. KickLabel.qml,
KickTextInput.qml, ...
You can design and use your own QML / Qt Quick elements by defining e.g. shape:MyOwnQmlControl.qml, with
MyOwnQmlControl.qml being a modified version of one of the Kick... .qml files.
NOTICe
Once a shape has been created on the canvas, e.g. by using Drag&Drop, its type cannot be modified by changing the
shape: definition. The shape: definition only applies to creating new elements.
To change the type of an existing control on the canvas, you need to modify the text in the Instances column at the right
end of the Data Objects table.
updates
Defines how the UI control communicates with the actual data object. Its value defines if the data object’s value can be modified by the user,
and also how the value is read from the device.
examples:
updates: Description
r the value is read from the device only once, upon initialization.
r100 the value is read from the device periodically, in this case every 1000 milliseconds.
r,w the initial value is read from the device upon initialization and can then be modified by the user. User-modified
values will be sent to the device.
NOTICe
You cannot combine periodical-reading with the control being user-modifiable. E.g. updates:r100,w is not a valid
definition.