Skip to main content

Home Assistant

Bundles contain custom components that support specific third-party integrations with Orbis Studio.

This page describes the components that are available in the Home Assistant bundle.

Home Assistant is an open-source home automation platform. These components let agents control smart home devices and query device state directly from your flows.

Home Assistant Control​

The Home Assistant Control component is a tool-mode component that lets an agent send control commands (turn on, turn off, toggle) to Home Assistant entities such as lights, switches, and thermostats.

Home Assistant Control parameters​

Some parameters are hidden by default in the visual editor. You can modify all component parameters through the component inspection panel that appears when you select a component.

NameTypeDescription
ha_tokenSecretStringInput parameter. A Home Assistant Long-Lived Access Token. Generate one in your Home Assistant profile settings.
base_urlStringInput parameter. The base URL of your Home Assistant instance. Example: http://192.168.0.10:8123.
default_actionStringInput parameter. Default action to perform. Options: turn_​on, turn_​off, toggle. Optional.
default_entity_idStringInput parameter. Default entity ID to control. Example: switch.living_​room_​lights. Optional.

Home Assistant Control outputs​

NameTypeDescription
home_assistant_controlToolOutput parameter. A tool that can be connected to an Agent component to control Home Assistant entities.

List Home Assistant States​

The List Home Assistant States component retrieves the current state of all entities registered in your Home Assistant instance and returns them as a Data list.

List Home Assistant States parameters​

Some parameters are hidden by default in the visual editor. You can modify all component parameters through the component inspection panel that appears when you select a component.

NameTypeDescription
ha_tokenSecretStringInput parameter. A Home Assistant Long-Lived Access Token.
base_urlStringInput parameter. The base URL of your Home Assistant instance.

List Home Assistant States outputs​

NameTypeDescription
dataJSONOutput parameter. List of all Home Assistant entity states.

See also​