Function Object
The function object is defined by its functionType and one or more additional properties. The property list is variable depending on the type of function. Functions are used to perform more complex operations on a thermostat or user which are too complex with simple property modifications. Functions are used to modify read-only objects where appropriate.
Each function takes different parameters, the object format is below:
Properties
| Name | Type | Read Only | Required | Description |
|---|---|---|---|---|
| type | String | no | no | The function type name. See the type name in the function documentation. |
| params | Map | no | no | A map of key=value pairs as the parameters to the function. See individual function documentation for the properties. |
See Using Functions.