Skip to content
Home Assistant BridgeHome Assistant Bridge
Esc
↑↓navigate↵open⌘Jpreview
On this page

ha-bridge vacuum

Arguments and flags for every ha-bridge vacuum command.

Every ha-bridge vacuum command and its help, as --help prints it. Each also accepts the global flags.

ha-bridge vacuum

DESCRIPTION
  Vacuum actions

USAGE
  ha-bridge vacuum <subcommand> [flags]

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)

ha-bridge vacuum start

DESCRIPTION
  Start cleaning

USAGE
  ha-bridge vacuum start [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge vacuum pause

DESCRIPTION
  Pause cleaning

USAGE
  ha-bridge vacuum pause [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge vacuum start-pause

DESCRIPTION
  Start or pause cleaning

USAGE
  ha-bridge vacuum start-pause [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge vacuum stop

DESCRIPTION
  Stop cleaning

USAGE
  ha-bridge vacuum stop [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge vacuum return-to-base

DESCRIPTION
  Go back to the dock

USAGE
  ha-bridge vacuum return-to-base [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge vacuum locate

DESCRIPTION
  Make the vacuum sound so you can find it

USAGE
  ha-bridge vacuum locate [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge vacuum clean-spot

DESCRIPTION
  Clean the spot it's on

USAGE
  ha-bridge vacuum clean-spot [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge vacuum clean-area

DESCRIPTION
  Clean areas

USAGE
  ha-bridge vacuum clean-area [flags] [<entity_id...>]

ARGUMENTS
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string        Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --clean-area string    Area ID to clean; repeat for more
  --entity string        Entity ID or name; repeat for more
  --device string        Device ID or name; repeat for more
  --area string          Area ID or name; repeat for more
  --floor string         Floor ID or name; repeat for more
  --label string         Label ID or name; repeat for more

ha-bridge vacuum fan-speed

DESCRIPTION
  Set the fan speed

USAGE
  ha-bridge vacuum fan-speed [flags] <speed> [<entity_id...>]

ARGUMENTS
  speed string           One of the vacuum's fan_speed_list
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

ha-bridge vacuum send-command

DESCRIPTION
  Send a raw command

USAGE
  ha-bridge vacuum send-command [flags] <command> [<entity_id...>]

ARGUMENTS
  command string         Command the integration understands
  entity_id... string    Entity ID, with or without the vacuum. prefix; repeat for more (optional)

FLAGS
  --socket string    Path to the bridge socket (default: $HA_BRIDGE_SOCK, then $XDG_RUNTIME_DIR/ha-bridge/ha-bridge.sock)
  --params string    Parameters as JSON, such as {"speed":2}
  --entity string    Entity ID or name; repeat for more
  --device string    Device ID or name; repeat for more
  --area string      Area ID or name; repeat for more
  --floor string     Floor ID or name; repeat for more
  --label string     Label ID or name; repeat for more

Last updated on