List of functions

Function

Description

cleanup_mode

Setting the cleaning mode.

coffee_mode

Setting the coffee machine mode.

dishwashing

Setting the dishwashing mode.

fan_speed

Setting the fan speed (such as in an air conditioner, fan, or heater).

heat

Setting the heating mode.

input_source

Setting the signal source.

program

Setting a program on a device.

swing

Setting the air direction on climate control devices.

tea_mode

Setting the tea making mode.

thermostat

Setting the temperature mode of climate control devices (such as an air conditioner).

ventilation_mode

Setting the ventilation mode.

work_speed

Setting the speed.

cleanup_mode

Setting the cleaning mode.

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: cleanup_mode.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, включи уборку в режим экспресс.

    Translation: Alice, turn on express cleaning.

  2. Алиса, включи ночную уборку.

    Translation: Alice, turn on night cleaning.

  3. Алиса, включи автоматическую чистку.

    Translation: Alice, turn on automatic cleaning.

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": "cleanup_mode",
    "modes": [
      {
        "value": "auto"
      },
      {
        "value": "quiet"
      }
    ]
  }
  ...
}

Examples of devices with the cleanup_mode function

  1. devices.types.vacuum_cleaner
  1. auto
  2. eco
  3. express
  4. normal
  5. quiet
  6. wet_cleaning
  7. dry_cleaning
  8. mixed_cleaning

coffee_mode

Setting the coffee machine mode.

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: coffee_mode.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, поставь кофе в режим капучино.

    Translation: Alice, set coffee to cappuccino mode.

  2. Алиса, сделай латте.

    Translation: Alice, make a latte.

  3. Алиса, свари американо.

    Translation: Alice, prepare an Americano.

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": "coffee_mode",
    "modes": [
      {
        "value": "latte"
      },
      {
        "value": "cappuccino"
      }
    ]
  }
  ...
}

Examples of devices with the coffee_mode function

  1. devices.types.cooking.coffee_maker
  1. americano
  2. cappuccino
  3. double_espresso
  4. espresso
  5. latte

dishwashing

Setting the dishwashing mode.

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: dishwashing.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, включи мойку посуды в интенсивный режим.

    Translation: Alice, set the dishwashing machine to intensive mode.

  2. Алиса, вымой посуду в режиме авто.

    Translation: Alice, wash the dishes in auto mode.

  3. Алиса, помой посуду в экспресс режиме.

    Translation: Alice, wash the dishes in express mode.

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": "dishwashing",
    "modes": [
      {
        "value": "auto"
      },
      {
        "value": "intensive"
      },
      {
        "value": "glass"
      },
      {
        "value": "express"
      }
    ]
  }
  ...
}

Examples of devices with the dishwashing function

  1. devices.types.dishwasher
  1. auto
  2. eco
  3. express
  4. glass
  5. intensive
  6. pre_rinse
  7. quiet

fan_speed

Setting the fan speed (such as in an air conditioner, fan, or heater).

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: fan_speed.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, включи кондиционеру высокую скорость вентиляции.

    Translation: Alice, turn the air conditioning to high.

  2. Алиса, включи минимальную скорость вентиляции на кондиционере.

    Translation: Alice, turn the air conditioner fan to low.

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": "fan_speed",
    "modes": [
      {
        "value": "high"
      },
      {
        "value": "medium"
      }
    ]
  }
  ...
}

Examples of devices with the fan_speed function

  1. devices.types.thermostat
  2. devices.types.thermostat.ac
  3. devices.types.humidifier
  4. devices.types.purifier
  5. devices.types.ventilation
  1. auto
  2. high
  3. low
  4. medium
  5. turbo

heat

Setting the heating mode.

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: heat.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, включи минимальный нагрев теплого пола.

    Translation: Alice, set the minimum floor heat.

  2. Алиса, переключи нагрев теплого пола в режим авто.

    Translation: Alice, turn the floor heating to auto.

  3. Алиса, включи на котле нагрев в максимальный режим.

    Translation: Alice, set the boiler heating to maximum.

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": "heat",
    "modes": [
      {
        "value": "auto"
      },
      {
        "value": "min"
      },
      {
        "value": "max"
      }
    ]
  }
  ...
}

Examples of devices with the heat function

  1. devices.types.thermostat
  1. auto
  2. max
  3. min
  4. normal
  5. turbo

input_source

Setting the signal source.

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: input_source.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, смени вход телека на второй.

    Translation: Alice, change TV input to number two.

  2. Алиса, включи первый источник сигнала телевизора.

    Translation: Alice, turn on TV input number two.

  3. Алиса, включи третий вход на телевизоре.

    Translation: Alice, set TV input to three.

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": "input_source",
    "modes": [
      {
        "value": "one"
      },
      {
        "value": "two"
      }
    ]
  }
  ...
}

Examples of devices with the input_source function

  1. devices.types.media_device
  2. devices.types.media_device.tv
  3. devices.types.media_device.receiver
  1. one
  2. two
  3. three
  4. four
  5. five
  6. six
  7. seven
  8. eight
  9. nine
  10. ten

program

Setting a program on a device.

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: program.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, включи программу в первый режим.

    Translation: Alice, switch the program to mode one.

  2. Алиса, включи десятую рабочую программу.

    Translation: Alice, turn on program ten.

  3. Алиса, включи авто программу работы на пылесосе.

    Translation: Alice, set the automatic vacuum cleaner to the automatic program.

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": "program",
    "modes": [
      {
        "value": "auto"
      },
      {
        "value": "ten"
      }
    ]
  }
  ...
}

Examples of devices with the program function

  1. devices.types.cooking
  2. devices.types.cooking.coffee_maker
  3. devices.types.cooking.kettle
  4. devices.types.cooking.multicooker
  5. devices.types.washing_machine
  6. devices.types.dishwasher
  7. devices.types.iron
  1. auto
  2. express
  3. one
  4. two
  5. three
  6. four
  7. five
  8. six
  9. seven
  10. eight
  11. nine
  12. ten

swing

Setting the air direction on climate control devices.

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: swing.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, поставь направление воздуха в горизонтальный режим.

    Translation: Alice, set air flow to horizontal.

  2. Алиса, включи обдув в вертикальный режим.

    Translation: Alice, set airflow to vertical.

  3. Алиса, смени направление воздуха на вертикальное.

    Translation: Alice, change the airflow direction to vertical.

  4. Алиса, направь струю/поток воздуха из кондиционера горизонтально/вертикально.

    Translation: Alice, set the AC airflow/airstream to horizontal/vertical.

  5. Алиса, включи вертикальный/горизонтальный поток/обдув на кондиционере.

    Translation: Alice, set the AC airflow to vertical/horizontal.

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": "swing",
    "modes": [
      {
        "value": "vertical"
      },
      {
        "value": "horizontal"
      }
    ]
  }
  ...
}

Examples of devices with the swing function

  1. devices.types.thermostat.ac
  1. auto
  2. horizontal
  3. stationary
  4. vertical

tea_mode

Setting the tea making mode.

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: tea_mode.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, включи приготовление чая в режим улун.

    Translation: Alice, set tea making to the oolong mode.

  2. Алиса, поставь на чайнике экспресс режим приготовления чая.

    Translation: Alice, set the kettle to the express tea making mode.

  3. Алиса, сделай черный чай.

    Translation: Alice, make black tea.

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": "tea_mode",
    "modes": [
      {
        "value": "express"
      },
      {
        "value": "black_tea"
      },
      {
        "value": "green_tea"
      },
      {
        "value": "oolong_tea"
      }
    ]
  }
  ...
}

Examples of devices with the tea_mode function

  1. devices.types.cooking.kettle
  1. black_tea
  2. flower_tea
  3. green_tea
  4. herbal_tea
  5. oolong_tea
  6. puerh_tea
  7. red_tea
  8. white_tea

thermostat

Setting the temperature mode of climate control devices (such as an air conditioner).

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: thermostat.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, переведи кондиционер в режим охлаждения.

    Translation: Alice, switch the air conditioner to cooling mode.

  2. Алиса, включи на кондиционере экорежим.

    Translation: Alice, turn the air conditioner to energy saving mode.

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": "thermostat",
    "modes": [
      {
        "value": "fan_only"
      },
      {
        "value": "heat"
      }
    ]
  }
  ...
}

Examples of devices with the thermostat function

  1. devices.types.thermostat
  2. devices.types.thermostat.ac
  3. devices.types.ventilation
  1. auto
  2. cool
  3. dry
  4. fan_only
  5. heat
  6. preheat

ventilation_mode

Setting the ventilation mode.

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: ventilation_mode.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, установи максимальный режим вентиляции.

    Translation: Alice, set ventilation to maximum.

  2. Алиса, включи вентиляцию в приточный режим.

    Translation: Alice, set ventilation to supply mode.

  3. Алиса, включи вентиляцию на обогрев.

    Translation: Alice, set ventilation to heating mode.

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": "ventilation_mode",
    "modes": [
      {
        "value": "supply_air"
      },
      {
        "value": "extraction_air"
      }
    ]
  }
  ...
}

Examples of devices with the ventilation_mode function

  1. devices.types.ventilation
  1. auto
  2. supply_air
  3. extraction_air

work_speed

Setting the speed.

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: work_speed.

modes

Array of mode objects

The array of mode objects describing the function's modes. Minimum number of modes in the array: 1.

Limitation

When resending the mode object array for the same device, keep in mind the order of modes. The order must be the same as in the latest array sent.

The mode object that is a part of the modes array

Parameter

Type

Description

value

String

The value of the function operating mode processed on the provider side. You can find the acceptable values on the List of operating modes.

  1. Алиса, включи скорость работы в режим турбо.

    Translation: Alice, set the speed to turbo.

  2. Алиса, включи медленную скорость работы.

    Translation: Alice, set the speed to slow.

  3. Алиса, включи максимальную скорость.

    Translation: Alice, set the speed to maximum.

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": "work_speed",
    "modes": [
      {
        "value": "fast"
      },
      {
        "value": "slow"
      }
    ]
  }
  ...
}

Examples of devices with the fan_speed function

  1. devices.types.openable
  2. devices.types.openable.curtain
  3. devices.types.vacuum_cleaner
  1. auto
  2. fast
  3. max
  4. medium
  5. min
  6. slow
  7. turbo

String enclosed in quotation marks, for example: "Hello, world".

An array of elements separated by a comma. As array items, you can use standard JSON elements: a string, number, true, false, object, or array. Arrays are enclosed in square brackets []:

"cities": ["Moscow", "Tokyo", "New York"]