134 lines
4.1 KiB
YAML
134 lines
4.1 KiB
YAML
select_program:
|
|
name: Select program
|
|
description: Select a program and optionally set the program options
|
|
fields:
|
|
device_id:
|
|
description: The ID of the appliance to start the program on
|
|
name: device_id
|
|
required: true
|
|
selector:
|
|
device:
|
|
integration: home_connect_alt
|
|
program_key:
|
|
name: Program
|
|
description: >
|
|
The full key of a valid program for the selected appliance
|
|
For example: ConsumerProducts.CoffeeMaker.Program.Beverage.Espresso
|
|
Documentation: https://api-docs.home-connect.com/programs-and-options
|
|
example: ConsumerProducts.CoffeeMaker.Program.Beverage.Espresso
|
|
required: true
|
|
selector:
|
|
text:
|
|
validate:
|
|
name: Validate
|
|
description: >
|
|
(Optional) Validate that the specified program_key is currently available to be called.
|
|
When this is set to false "startonly" programs will not be supported
|
|
required: false
|
|
default: true
|
|
advanced: true
|
|
selector:
|
|
boolean:
|
|
options:
|
|
name: Options
|
|
description: >
|
|
(Optional) A list of dictionaries with options for the program:
|
|
[
|
|
{ "key": "... option key ...", "value": "... option value ... "}
|
|
]
|
|
example: >
|
|
[
|
|
{ "key": "ConsumerProducts.CoffeeMaker.Option.BeanAmount", "value": "ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.DoubleShot" },
|
|
{ "key": "ConsumerProducts.CoffeeMaker.Option.FillQuantity", "value": 50 },
|
|
]
|
|
required: false
|
|
selector:
|
|
object:
|
|
|
|
start_program:
|
|
name: Start program
|
|
description: Start the currently selected program
|
|
fields:
|
|
device_id:
|
|
description: The ID of the appliance to start the program on
|
|
name: device_id
|
|
required: true
|
|
selector:
|
|
device:
|
|
integration: home_connect_alt
|
|
program_key:
|
|
name: Program
|
|
description: >
|
|
The full key of a valid program for the selected appliance, if not specified
|
|
will use the currently selected program
|
|
For example: ConsumerProducts.CoffeeMaker.Program.Beverage.Espresso
|
|
Documentation: https://api-docs.home-connect.com/programs-and-options
|
|
example: ConsumerProducts.CoffeeMaker.Program.Beverage.Espresso
|
|
required: true
|
|
selector:
|
|
text:
|
|
validate:
|
|
name: Validate
|
|
description: >
|
|
(Optional) Validate that the specified program_key is currently available to be called.
|
|
required: false
|
|
default: true
|
|
advanced: true
|
|
selector:
|
|
boolean:
|
|
options:
|
|
name: Options
|
|
description: >
|
|
(Optional) A list of dictionaries with options for the program:
|
|
[
|
|
{ "key": "... option key ...", "value": "... option value ... "}
|
|
]
|
|
example: >
|
|
[
|
|
{ "key": "ConsumerProducts.CoffeeMaker.Option.BeanAmount", "value": "ConsumerProducts.CoffeeMaker.EnumType.BeanAmount.DoubleShot" },
|
|
{ "key": "ConsumerProducts.CoffeeMaker.Option.FillQuantity", "value": 50 },
|
|
]
|
|
required: false
|
|
selector:
|
|
object:
|
|
|
|
stop_program:
|
|
name: Stop program
|
|
description: Stop the currently active program
|
|
fields:
|
|
device_id:
|
|
description: The ID of the appliance to stop the program on
|
|
name: device_id
|
|
required: true
|
|
selector:
|
|
device:
|
|
integration: home_connect_alt
|
|
|
|
set_program_option:
|
|
name: Set program option
|
|
description: Sets an option for the currently selected or active program
|
|
fields:
|
|
device_id:
|
|
description: The ID of the appliance to start the program on
|
|
name: device_id
|
|
required: true
|
|
selector:
|
|
device:
|
|
integration: home_connect_alt
|
|
key:
|
|
name: Option key
|
|
description: >
|
|
The ENUM key of an option which is available for the current program
|
|
example: ConsumerProducts.CoffeeMaker.Program.Beverage.Espresso
|
|
required: true
|
|
selector:
|
|
text:
|
|
value:
|
|
name: Option value
|
|
description: >
|
|
An allowed value for the specified option
|
|
example: ConsumerProducts.CoffeeMaker.Program.Beverage.Espresso
|
|
required: true
|
|
selector:
|
|
text:
|