Home Assistant Provider

The Home Assistant provider displays entity states from your Home Assistant smart home hub. Monitor temperatures, door sensors, switches, and more — all directly in your menu bar.

Connection Setup

Home Assistant connections are managed under Settings → Connections → Home Assistant Connections. See Managing Connections for general instructions on adding and configuring connections.

You will need a Long-Lived Access Token from your Home Assistant instance. Generate one under your Home Assistant user profile.

Entity Groups

Each channel can have multiple entity groups. An entity group is associated with a specific Home Assistant connection and contains one or more entity configurations. This allows you to pull data from multiple Home Assistant instances into a single channel, or organize entities logically.

Entity Configuration

Each entity within a group can be configured with the following settings:

Setting Description
Entity ID Home Assistant entity identifier (e.g., sensor.temperature)
Show Unit Display unit of measurement (°C, %, etc.)
Attribute Key Extract a specific attribute instead of the entity state
Source Optional source label
Prefix Text prepended to the value
Suffix Text appended to the value
Processor Link to a Processor Pipeline
Deduplicate Prevent duplicate messages

Finding Entity IDs

To find the Entity ID for a device or sensor:

  1. Open your Home Assistant instance
  2. Go to Settings → Devices & Services → Entities
  3. Find the entity you want to monitor
  4. Copy the Entity ID

Common entity ID examples:

  • sensor.livingroom_temperature
  • binary_sensor.front_door
  • weather.home
  • switch.desk_lamp

Processor Pipeline Integration

Entities can use Processor Pipelines to transform or filter values before they are displayed. See Processor Pipelines for details on creating and configuring pipelines.

Activation

To enable the Home Assistant provider for a channel:

  1. Open Settings → Channels
  2. Select the target channel
  3. Go to Providers
  4. Enable Home Assistant
  5. Select a connection
  6. Configure entities
Next
Command-Line App