jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-13 12:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for System Bridge 3.x.x (#22749)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Aidan Timson 2022-06-07 18:20:55 +01:00 committed by GitHub
parent 7439a86ca1
commit c942ab104c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
source/_integrations/system_bridge.markdown
View File

@ -18,11 +18,17 @@ ha_zeroconf: true
ha_integration_type: integration
---
[System Bridge](https://system-bridge.timmo.dev) 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.
[System Bridge](https://system-bridge.timmo.dev) is an application that runs on your local machine to share system information via its API/WebSocket. You can also send commands to be to the device such as opening a URL or sending keyboard keypresses.
## Prerequisites
You will need your API key. This can be found and configured in the application's settings.
### Version
This integration requires System Bridge 3.1.1 and above. Any older version will not work.
### API Key
You will need your API key. This can be found following the documentation [here](https://system-bridge.timmo.dev/docs/running).
{% include integrations/config_flow.md %}
@ -42,27 +48,27 @@ This integration provides the following sensors:
| Name | Description |
| ---------------------- | --------------------------------------------------- |
| Battery | Battery level of the device |
| CPU Speed | The current CPU speed |
| 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 |
| Latest Version | System Bridge Latest Version |
| Load | System load percentage |
| 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 |
@ -72,76 +78,45 @@ These sensors are also available, but are not enabled by default:
| 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.
{% my developer_call_service service="system_bridge.send_command" title="Open your Home Assistant instance and show your service developer tools with a specific service selected." %}
#### Examples
```yaml
service: system_bridge.send_command
data:
bridge: device
command: code
arguments: /home/user/file.txt
```
```yaml
service: system_bridge.send_command
data:
bridge: device
command: python
arguments: '-V'
```
### Service `system_bridge.open`
### Service `system_bridge.open_path`
Open a URL or file on the server using the default application.
{% my developer_call_service service="system_bridge.open" title="Open your Home Assistant instance and show your service developer tools with a specific service selected." %}
#### Examples
{% my developer_call_service service="system_bridge.open_path" title="Show service in your Home Assistant instance." %}
```yaml
service: system_bridge.open
service: system_bridge.open_path
data:
bridge: "device"
bridge: "deviceid"
path: "C:\\image.jpg"
```
```yaml
service: system_bridge.open
data:
bridge: "device"
path: "https://home-assistant.io"
```
### Service `system_bridge.open_url`
Open a URL or file on the server using the default application.
{% my developer_call_service service="system_bridge.open_url" title="Show service in your Home Assistant instance." %}
```yaml
service: system_bridge.open
service: system_bridge.open_url
data:
bridge: "device"
path: "steam://rungameid/814380"
bridge: "deviceid"
url: "https://home-assistant.io"
```
### Service `system_bridge.send_keypress`
Send a keypress to the server.
{% my developer_call_service service="system_bridge.send_keypress" title="Show service in your Home Assistant instance." %}
```yaml
service: system_bridge.send_keypress
data:
bridge: "device"
bridge: "deviceid"
key: "a"
```
@ -149,9 +124,11 @@ data:
Sends text for the server to type.
{% my developer_call_service service="system_bridge.send_text" title="Show service in your Home Assistant instance." %}
```yaml
service: system_bridge.send_text
data:
bridge: "device"
bridge: "deviceid"
text: "Hello"
```