DispenseCommand

Description

Dispense items.

Fields

Key Type Description
devices [Device]

Devices that support dispensing a specified amount of one or more physical items.

Required
item String

Name of the item to dispense.

Optional

To use this field, all the following fields CANNOT be used: presetName

To use this field, all the following fields SHOULD be used: amount, unit

The available values depends on each device.
amount Number

Amount to dispense

Optional

To use this field, all the following fields CANNOT be used: presetName

To use this field, all the following fields SHOULD be used: unit, item
unit String

Unit for the amount.

Optional

To use this field, all the following fields CANNOT be used: presetName

To use this field, all the following fields SHOULD be used: amount, item

The available values depends on each device.
presetName String

Name of the preset to dispense.

Optional

To use this field, all the following fields CANNOT be used: amount, unit, item

The available values depends on each device.

Examples

actions:
- type: device.command.Dispense
  devices: My Device - Room Name
  item: Some String
  amount: 10
  unit: Some String