Difference between revisions of "Apple Watch Interface"
| Line 56: | Line 56: | ||
If the "action" is "device", Its icon changes to reflect the status of the associated device address. | If the "action" is "device", Its icon changes to reflect the status of the associated device address. | ||
| − | === UISet === | + | ==== UISet Attributes ==== |
*'''label''': to dynamically modify the button's label | *'''label''': to dynamically modify the button's label | ||
*'''state''': used to change the icon state if the "action" is not "device". Can be "off", "on" or "unknown". | *'''state''': used to change the icon state if the "action" is not "device". Can be "off", "on" or "unknown". | ||
| Line 85: | Line 85: | ||
E.g. If the url is "http://www.myurl.com/slider?%value" and the slider's value is changed to "77", the following URL is requested: "http://www.myurl.com/slider?77" | E.g. If the url is "http://www.myurl.com/slider?%value" and the slider's value is changed to "77", the following URL is requested: "http://www.myurl.com/slider?77" | ||
| − | === UISet === | + | ==== UISet Attributes ==== |
*'''label''': to dynamically modify the slider's label | *'''label''': to dynamically modify the slider's label | ||
*'''value''': 0-100, modifies the displayed value | *'''value''': 0-100, modifies the displayed value | ||
| Line 97: | Line 97: | ||
*'''url''': the image's URL | *'''url''': the image's URL | ||
| − | === UISet === | + | ==== UISet Attributes ==== |
*'''url''': to dynamically change the image | *'''url''': to dynamically change the image | ||
*'''visible''': true|false, specifies the object visibility | *'''visible''': true|false, specifies the object visibility | ||
| Line 109: | Line 109: | ||
*'''visible''': true|false, specifies the object visibility | *'''visible''': true|false, specifies the object visibility | ||
| − | === UISet === | + | ==== UISet Attributes ==== |
*'''visible''': true|false, specifies the object visibility | *'''visible''': true|false, specifies the object visibility | ||
Revision as of 16:04, 17 November 2017
An Apple Watch interface can be created visually through the Project Editor or using a Project's UISet (for example, for dynamically build Watch interfaces).
Contents
Objects
Label
A label object to display text. Text can be on multiple rows. The object's height will adjust to contain the text.
Parameters
- id: the object's ID, used by UISets, optional
- text: the label's text
UISet Attributes
- text: to dynamically modify the text
- visible: true|false, specifies the object visibility
Button
A button object that executes an action.
Parameters
- id: the object's ID, used by UISets, optional
- label: the button's label
- action: the button's action
- The action parameter specifies the type of action and can have the following values:
- user: similar to a User Button object, sends a User call to the server
- device: similar to a Button object, controls a light or automation device
- url: requests the specified URL
- Each type of action uses different parameters as following.
User Parameters
- name: name passed to the Java callback method and event in EVENTS
- parameter: parameter passed to the Java callback method and event in EVENTS
Device Parameters
- address: device data point name
Device Parameters
- url: the URL to be requested. Its return value will give a different feedback: "ack" (success feedback) or "error" (failure feedback)
UISet Attributes
- label: to dynamically modify the button's label
- visible: true|false, specifies the object visibility
Light
The light object displays a "light" icon on the left of the button. It has the same parameters as the "Button" object. If the "action" is "device", Its icon changes to reflect the status of the associated device address.
UISet Attributes
- label: to dynamically modify the button's label
- state: used to change the icon state if the "action" is not "device". Can be "off", "on" or "unknown".
- visible: true|false, specifies the object visibility
OnOff
Same as the Light object, but displays an on/off icon.
Shutter
Same as the Light and OnOff objects, but with an additional parameter "mode" for the direction of the shutter. The UISet "state" can have the following values: "up", "down", "offup", "offdown", "unknown".
Slider
Same as the Button object, but sends a value as well.
If action is "device", the slider's value is updated with the corresponding device's state.
If the action is "user", the slider's value is sent as parameter.
If the action is "url", the slider's value will be replaced in the URL where "%value" is found.
E.g. If the url is "http://www.myurl.com/slider?%value" and the slider's value is changed to "77", the following URL is requested: "http://www.myurl.com/slider?77"
UISet Attributes
- label: to dynamically modify the slider's label
- value: 0-100, modifies the displayed value
- visible: true|false, specifies the object visibility
Image
Displays an image.
Parameters
- id: the object's ID, used by UISets, optional
- url: the image's URL
UISet Attributes
- url: to dynamically change the image
- visible: true|false, specifies the object visibility
Camera
Displays a camera.
Parameters
- id: the object's ID, used by UISets, optional
- address: the camera's address
- visible: true|false, specifies the object visibility
UISet Attributes
- visible: true|false, specifies the object visibility
