Set away mode

Use this action to set home or away mode for a StreamLabs Water Monitor location.

This is useful when you want an automation to switch the monitor to away mode while you are out, for example to change how it watches for water usage.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label. If you have more than one location, use the Location ID option to choose which one to change. If you leave it empty, the first available location is used.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To set the away mode from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select StreamLabs: Set away mode.
6. Choose the Away mode. If you have more than one location, also enter the Location ID.
7. Select Save.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as streamlabswater.set_away_mode. A basic example looks like this:

action: streamlabswater.set_away_mode
data:
  away_mode: away

This sets the monitor at the first available location to away mode.

Options in YAML

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: Switch to away mode when everyone leaves

This automation sets your StreamLabs Water Monitor to away mode whenever everyone leaves home, so it watches water usage differently while the house is empty.

• Trigger: the home zone changes to having nobody present
• Action: StreamLabs: Set away mode
  • Away mode: away

alias: "Water monitor away mode when nobody is home"
triggers:
  - trigger: numeric_state
    entity_id: zone.home
    below: 1
actions:
  - action: streamlabswater.set_away_mode
    data:
      away_mode: away

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.