System Bridge
System Bridge is an application that runs on your local machine to share system information via its API as well as allowing commands to be sent to the device.
Prerequisites
You will need your API key. This can be found and configured in the application’s settings.
Configuration
Adding System Bridge to your Home Assistant instance can be done via the user interface, by using this My button:
System Bridge can be auto-discovered by Home Assistant. If an instance was found, it will be shown as “Discovered”, which you can select to set it up right away.
If there wasn’t any discovered automatically, don’t worry! You can set up a manual integration entry:
- Browse to your Home Assistant instance.
- In the sidebar click on Settings.
- From the configuration menu select: Integrations.
- In the bottom right, click on the Add Integration button.
- From the list, search and select “System Bridge”.
- Follow the instruction on screen to complete the set up.
Binary Sensors
This integration provides the following binary sensors:
| Name | Description |
|---|---|
| Battery Is Charging | Whether the battery is charging |
| New Version Available | Whether a new version is available |
Sensors
This integration provides the following sensors:
| Name | Description |
|---|---|
| Battery | Battery level of the device |
| Displays Connected | Number of displays connected |
| Display Resolution X | Display resolution (across) |
| Display Resolution Y | Display resolution (down) |
| Display Refresh Rate | Display refresh rate |
| CPU Speed | The current CPU speed |
| Filesystem(s) | Space used for each drive letter / filesystem mount |
| GPU Memory Free | GPU memory free in GB |
| GPU Usage % | GPU usage percentage |
| Kernel | Version information of the Kernel |
| Memory Free | Memory (RAM) free in GB |
| Memory Used | Memory (RAM) used in GB |
| Memory Used % | Memory (RAM) % used |
| Operating System | Version information of the Operating System |
| Version | System Bridge Version |
| Latest Version | System Bridge Latest Version |
These sensors are also available, but are not enabled by default:
| Name | Description |
|---|---|
| BIOS Version | Version of your system’s BIOS |
| CPU Temperature | The current temperature of the CPU |
| CPU Voltage | The current voltage of the CPU |
| GPU Core Clock Speed | GPU core clock speed in MHz |
| GPU Memory Clock Speed | GPU memory clock speed in MHz |
| GPU Fan Speed | GPU fan speed percentage |
| GPU Memory Used | GPU memory used in GB |
| GPU Memory Used % | GPU memory used percentage |
| GPU Power Usage | GPU power usage |
| GPU Temperature | The current temperature of the GPU |
| Idle Load | System idle load percentage |
| System Load | System load percentage |
| User Load | System user load percentage |
| Idle Load (Per CPU) | System idle load percentage for each CPU |
| System Load (Per CPU) | System load percentage for each CPU |
| User Load (Per CPU) | System user load percentage for each CPU |
Services
Service system_bridge.send_command
Sends a command to the server to run.
Examples
service: system_bridge.send_command
data:
bridge: device
command: code
arguments: /home/user/file.txt
service: system_bridge.send_command
data:
bridge: device
command: python
arguments: '-V'
Service system_bridge.open
Open a URL or file on the server using the default application.
Examples
service: system_bridge.open
data:
bridge: "device"
path: "C:\\image.jpg"
service: system_bridge.open
data:
bridge: "device"
path: "https://home-assistant.io"
service: system_bridge.open
data:
bridge: "device"
path: "steam://rungameid/814380"
Service system_bridge.send_keypress
Send a keypress to the server.
service: system_bridge.send_keypress
data:
bridge: "device"
key: "a"
Service system_bridge.send_text
Sends text for the server to type.
service: system_bridge.send_text
data:
bridge: "device"
text: "Hello"