List of functions

The range capability has functions. Functions have parameters and voice scenarios that let you describe the skills for the device.


Function	Description
brightness	Changing brightness of lighting.
channel	Changing the channel (for example, on a TV).
humidity	Changing the humidity.
open	Opening something (shades or windows).
temperature	Changing the temperature. It may indicate the heating temperature of an electric kettle, heater, or an air conditioner in any of its modes.
volume	Changing the device volume.


Function	Description
brightness	Changing brightness of lighting.
channel	Changing the channel (for example, on a TV).
humidity	Changing the humidity.
open	Opening something (shades or windows).
temperature	Changing the temperature. It may indicate the heating temperature of an electric kettle, heater, or an air conditioner in any of its modes.
volume	Changing the device volume.

brightness

Changing brightness of lighting elements.

Below is the description of the parameters object from the Description of capability section.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Acceptable values: `brightness`.
unit	String	Function value units. Acceptable values: `unit.percent` (percentage).
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	Minimum acceptable value: 0.
max	Float	Maximum acceptable value: 100.
precision	Float	The minimum step between values in the range. The default value is 1.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Acceptable values: `brightness`.
unit	String	Function value units. Acceptable values: `unit.percent` (percentage).
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	Minimum acceptable value: 0.
max	Float	Maximum acceptable value: 100.
precision	Float	The minimum step between values in the range. The default value is 1.

Yasmina, set the night light to minimum brightness.
Yasmina, make the chandelier brighter.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "brightness",
    "unit": "unit.percent",
    "range": {
      "min": 0,
      "max": 100,
      "precision": 10
    }
  }
  ...
}

Examples of devices with the brightness function

devices.types.light

channel

Changing the channel (for example, on a TV).

Below is the description of the parameters object from the Description of capability section.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Accepted values: `channel`.
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	No restrictions.
max	Float	No restrictions.
precision	Float	The minimum step between values in the range. The default value is 1.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Accepted values: `channel`.
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	No restrictions.
max	Float	No restrictions.
precision	Float	The minimum step between values in the range. The default value is 1.

Yasmina, switch to the next TV channel.
Yasmina, switch to the previous TV channel.
Yasmina, set the TV to channel five.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "channel",
    "random_access": true,
    "range": {
      "min": 0,
      "max": 999,
      "precision": 1
    }
  }
  ...
}
Copied to clipboard

Examples of devices with the channel function

humidity

Changing the humidity.

Below is the description of the parameters object from the Description of capability section.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Accepted values: `humidity`.
unit	String	Function value units. Acceptable values: `unit.percent` (percentage).
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	Minimum acceptable value: 0.
max	Float	Maximum acceptable value: 100.
precision	Float	The minimum step between values in the range. The default value is 1.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Accepted values: `humidity`.
unit	String	Function value units. Acceptable values: `unit.percent` (percentage).
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	Minimum acceptable value: 0.
max	Float	Maximum acceptable value: 100.
precision	Float	The minimum step between values in the range. The default value is 1.

Yasmina, set humidity to maximum.
Yasmina, set humidity to 45%.
Yasmina, add humidity in the nursery.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "humidity",
    "random_access": true,
    "range": {
      "max": 100,
      "min": 10,
      "precision": 10
    },
    "unit": "unit.percent"
  }
  ...
}
Copied to clipboard

Examples of devices with the humidity function

devices.types.humidifier

open

Opening something (shades or windows).

Below is the description of the parameters object from the Description of capability section.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Valid value: `open`.
unit	String	Function value units. Acceptable values: `unit.percent` (percentage).
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	Minimum acceptable value: 0.
max	Float	Maximum acceptable value: 100.
precision	Float	The minimum step between values in the range. The default value is 1.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Valid value: `open`.
unit	String	Function value units. Acceptable values: `unit.percent` (percentage).
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	Minimum acceptable value: 0.
max	Float	Maximum acceptable value: 100.
precision	Float	The minimum step between values in the range. The default value is 1.

Yasmina, open the shades 10%.
Yasmina, open the window one-third of the way.
Yasmina, open the gate slightly.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "open",
    "random_access": true,
    "range": {
      "max": 100,
      "min": 0,
      "precision": 10
    },
    "unit": "unit.percent"
  }
  ...
}
Copied to clipboard

Examples of devices with the open function

temperature

Changing the temperature. It may indicate the heating temperature of an electric kettle, heater, or an air conditioner in any of its modes.

Below is the description of the parameters object from the Description of capability section.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Accepted values: `temperature`.
unit	String	Function value units. Acceptable values: `unit.temperature.celsius` — Measured in degrees Celsius. `unit.temperature.kelvin` — measured in kelvins.
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	No restrictions.
max	Float	No restrictions.
precision	Float	The minimum step between values in the range. The default value is 1.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Accepted values: `temperature`.
unit	String	Function value units. Acceptable values: `unit.temperature.celsius` — Measured in degrees Celsius. `unit.temperature.kelvin` — measured in kelvins.
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
`range` object
min	Float	No restrictions.
max	Float	No restrictions.
precision	Float	The minimum step between values in the range. The default value is 1.

Yasmina, set air conditioning to 20 degrees.
Yasmina, turn down the temperature on the air conditioner.
Yasmina, make it warmer in the nursery.
Yasmina, make it cooler in the living room.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "temperature",
    "random_access": true,
    "range": {
      "max": 40,
      "min": 18,
      "precision": 1
    },
    "unit": "unit.temperature.celsius"
  }
  ...
}
Copied to clipboard

Examples of devices with the temperature function

volume

Changing the device volume.

Below is the description of the parameters object from the Description of capability section.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Accepted values: `volume`.
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
unit	String	Function value units. Acceptable values: `unit.percent` — Measured as a percentage. If the parameter is omitted, the function is measured in abstract units. Example of a voice command: Yasmina, turn the TV volume up by 3.
`range` object
min	Float	No restrictions.
max	Float	No restrictions.
precision	Float	The minimum step between values in the range. The default value is 1.


`parameters` object
Parameter	Type	Description
instance	String	Function name for this capability. Accepted values: `volume`.
random_access	Boolean	Setting arbitrary function values. If this feature is disabled, the user can only change the values gradually, either up or down. For example, turning the TV volume up or down via an IR remote. Acceptable values: `true`: Setting arbitrary values is enabled. `false`: The feature is disabled. Default value: `true`.
range	Object	Object that describes the range of function values.
unit	String	Function value units. Acceptable values: `unit.percent` — Measured as a percentage. If the parameter is omitted, the function is measured in abstract units. Example of a voice command: Yasmina, turn the TV volume up by 3.
`range` object
min	Float	No restrictions.
max	Float	No restrictions.
precision	Float	The minimum step between values in the range. The default value is 1.

Yasmina, turn down the volume on the TV.
Yasmina, turn up the volume on the TV.
Yasmina, set the volume to 3 on the TV.

Use this function to describe the features of various devices:

Example of the parameters object

See the full example in Example of use.

{
  ...
  "parameters": {
    "instance": "volume",
    "random_access": true,
    "unit": "unit.percent",
    "range": {
      "min": 0,
      "max": 100,
      "precision": 10
    }
  }
  ...
}
Copied to clipboard

Examples of devices with the volume function