---
title: Home Assistant
description: Monitor and control System Bridge from Home Assistant.
---

System Bridge integrates with [Home Assistant](https://www.home-assistant.io/integrations/system_bridge), so you can monitor and control your machine from your Home Assistant instance. The integration uses a local push connection and is maintained by the System Bridge author.

:::tip
The official [System Bridge integration documentation](https://www.home-assistant.io/integrations/system_bridge) is the most up-to-date reference for entities, actions, and setup. Use this page as a starting point and follow the official docs for the current details.
:::

## Prerequisites

- A running System Bridge backend. See [Running](/running/).
- Your API token. See [how to find your token](/running/#token).

## Adding the integration

System Bridge can be auto-discovered by Home Assistant. When an instance is found, it appears under **Settings > Devices & services** as a discovered device, ready to set up.

To add it manually:

[![Open your Home Assistant instance and start setting up System Bridge.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=system_bridge)

1. In Home Assistant, go to **Settings > Devices & services**, or use the button above.
2. Select **Add Integration** and choose **System Bridge**.
3. Enter the host and your token when prompted, then follow the on-screen steps.

## Features

The integration exposes your system as sensors, a media player, and a set of actions, plus notifications and update tracking.

### Sensors

Sensors report system information such as battery, CPU speed, memory, load, displays, filesystems, GPU usage, processes, and version details. Many are enabled by default, with additional CPU and GPU sensors (temperatures, clock speeds, fan speed, and more) available to enable manually.

### Binary sensors

Binary sensors report on/off states such as whether the battery is charging, AC power is connected, the camera is in use, a reboot is pending, or a new version is available.

### Media player

Control currently playing media on your device from Home Assistant. Media player support is currently limited to devices running System Bridge on Windows.

### Media source

Browse and play media from your system through the Home Assistant media browser and supported media players.

### Update

An update entity notifies you when a new version of System Bridge is available.

### Notifications

Send rich notifications to your device, including a title, message, image, action buttons, and audio.

### Actions

Trigger actions on the machine running System Bridge:

- Get a process by its ID, or get processes by name.
- Open a path or a URL with the default application.
- Send a keypress or type text.
- Send a power command such as `sleep`, `lock`, `restart`, or `shutdown`.

## Dashboard

A System Bridge dashboard lays out a machine's sensors in Home Assistant the way the web client does, with a view for each page, such as CPU, Disks and GPUs. It's built from the integration's entities, so new disks, GPUs and sensors appear on their own. Each view also has a badge that opens the same page in the web client.

The dashboard needs Home Assistant 2026.10 or later. Sensors added to the integration in later versions show up once you update Home Assistant.

### Install from the Marketplace

[![Open your Home Assistant instance and open a repository in the Marketplace.](https://my.home-assistant.io/badges/marketplace_repository.svg)](https://my.home-assistant.io/redirect/marketplace_repository/?owner=timmo001&repository=system-bridge-dashboard&category=plugin)

1. Use the button above, or search for **System Bridge Dashboard** in **Settings > Marketplace**.
2. Select **Install**. The Marketplace adds the dashboard resource for you.
3. Reload your browser.

If you manage dashboard resources in YAML, add `/local/community/system-bridge-dashboard/system-bridge-dashboard.js` as a `module` resource yourself.

If you installed the dashboard from `timmo001/system-bridge` before, remove it and install it again from `timmo001/system-bridge-dashboard`. The dashboard now has a repository of its own, and new versions are only published there.

### Install manually

[![Open your Home Assistant instance and show your dashboard resources.](https://my.home-assistant.io/badges/lovelace_resources.svg)](https://my.home-assistant.io/redirect/lovelace_resources/)

1. Download `system-bridge-dashboard.js` from the [latest release](https://github.com/timmo001/system-bridge-dashboard/releases/latest) and put it in your Home Assistant `config/www/` folder.
2. Use the button above, or go to **Settings > Dashboards**, open the menu and select **Resources**.
3. Add `/local/system-bridge-dashboard.js` as a **JavaScript module**.

### Add the dashboard

[![Open your Home Assistant instance and show your dashboards.](https://my.home-assistant.io/badges/lovelace_dashboards.svg)](https://my.home-assistant.io/redirect/lovelace_dashboards/)

1. Use the button above, or go to **Settings > Dashboards**.
2. Select **Add dashboard** and choose **System Bridge**.
3. With more than one System Bridge device, open the dashboard, select **Edit dashboard** and choose the device.

### Options

Select **Edit dashboard** to change these. Options left at their default aren't saved, so they follow any later change to the default.

| Option | Default | What it does |
| --- | --- | --- |
| Device | The only System Bridge device | The machine the dashboard shows. |
| History | 1 hour | How far back graphs go, up to 48 hours. |
| Percentage tiles | Bar | What tiles for percentages such as CPU and memory usage show under the value: nothing, a bar, or a graph of recent values. |
| Maximum columns | 4 | The most columns of sections a page shows side by side on a wide screen, from 1 to 6. |
| Pages | Every page | The pages shown as views, in tab order. Drag to reorder, remove to hide. |
| Icon and title | Every page | Pages whose tab shows the icon next to the title. The others show only the icon. |
| Web client link | Every page | Pages with a badge at the top that opens the page in the web client. |

Pages with no entities, such as Battery on a desktop, are left out.

:::note
Taking control of the dashboard turns it into ordinary cards. It then stops following new entities, and these options no longer apply.
:::

### Add a section to another dashboard

Any page's sections can go on another sections dashboard, such as one GPU or the storage of one machine. Add a section in YAML:

```yaml
strategy:
  type: custom:system-bridge
  device_id: <device ID>
  section: gpu
  item: card0
```

After that, edit the section to change it in the section editor. It shows a picture of each section to choose from, and only the options that section uses:

- **Item** for sections about one thing: choose the mount, GPU, display or network interface from the device's own.
- **History** for sections with a graph.
- **Percentage tiles** for sections with percentage tiles.

| Section | Shows |
| --- | --- |
| `storage` | Space used on every mount. |
| `audio` | The default audio output, with its output picker and volume. |
| `now-playing` | The media playing, with source and playback controls. |
| `overview-load` | CPU and memory load in one graph. |
| `overview-power` | Power draw, with a graph. |
| `overview-temperatures` | CPU and GPU temperatures, with a graph. |
| `battery` | Battery level, state, time remaining, AC power, power draw and voltage. |
| `device-batteries` | Battery level and state of connected devices, such as a wireless mouse. |
| `cpu` | CPU usage, speed, power, load average, temperature and voltage. |
| `cpu-history` | Graphs of CPU usage, speed, power, load average and temperature. |
| `cpu-cores` | Load and power of each CPU core. |
| `memory` | Memory in use, free and used. |
| `memory-history` | Graph of memory usage. |
| `mount` | One mount point: space used. |
| `disk-activity` | Disk read and write rates, in total and per disk. |
| `display` | One display: resolution and refresh rate. |
| `gpu` | One GPU: load, memory, power, temperature, clocks and fan. |
| `network` | Download and upload rates, with a graph. |
| `network-activity` | Download and upload rates, with a graph of each. |
| `interface` | One network interface: rates, Wi-Fi details and graphs. |
| `processes` | The number of processes, with a graph. |
| `system` | Device power usage and whether the camera is in use. |

`hours_to_show` and `tile_feature` (`none`, `bar` or `trend`) set History and Percentage tiles in YAML.

## Next steps

- See what each feature does in more detail: [monitoring](/features/monitoring/), [notifications](/features/notifications/), [media](/features/media/) and [remote control](/features/remote-control/).
- Read the official [integration documentation](https://www.home-assistant.io/integrations/system_bridge) for entity names, action parameters, and examples.
- Connect to System Bridge directly with the [API and WebSocket](/api/).
