Smart Home Dock Trait Schema

action.devices.traits.Dock - This trait is designed for self-mobile devices that can be commanded to return for charging.

By and large, these are currently robotic vacuum cleaners, but this would also apply to some drones, delivery robots, and other future devices.

Device ATTRIBUTES

None.

Device STATES

Devices with this trait may report the following states as part of the QUERY operation. To learn more about handling QUERY intents, see Intent fulfillment.

States Type Description
isDocked Boolean

Required.

Whether the device is connected to the docking station or not.

Examples

Is my device docked?

{
  "isDocked": true
}

Device COMMANDS

Devices with this trait may respond to the following commands as part of the EXECUTE operation. To learn more about handling EXECUTE intents, see Intent fulfillment.

action.devices.commands.Dock

Dock the device.

Parameters

Parameters Type Description

No properties

Examples

Dock my device.

{
  "command": "action.devices.commands.Dock",
  "params": {}
}

Device ERRORS

See the full list of errors and exceptions.