System Bridge

A bridge for your systems.

Features

• System Information - Access your system's information via the data modules using the API/WebSocket.
• Open files and URLs - Automate your system by opening a URL/path via the API/WebSocket.
• Send Notifications - Send system notifications via the API/WebSocket.
• Compatible with Windows and Linux.
• Integrated with Home Assistant.
• Android Companion App - You can find the Android companion app on the Play Store. The source for this app can be found here.

Documentation

Installation

You can find installation instructions here.

Running

You can find instructions to run the application here.

Data Modules

You can find documentation data modules that can be accessed via the API/WebSocket here.

CLI

You can find documentation for the CLI here.

API

You can find documentation for the API here.

WebSocket

You can find documentation for the WebSocket here.

Packages

systembridgebackend

The main application which contains the API/WebSocket and data modules. This package requires the systembridgeshared package.

systembridgecli

The command line interface for the application. Here you can get the api-key and update settings and get data.

systembridgeconnector

Allows other applications to connect to the backend. For example, in the Home Assistant integration.

systembridgefrontend

The frontend for the application. This is used by the systembridgegui module to show settings etc.

systembridgegui

The GUI for the application. This shows a system tray icon and allows you to interact with the application.

systembridgeshared

Shared package required by the systembridgebackend, systembridgecli and systembridgegui packages.

systembridgewindowssensors

Specifically for windows, adds sensors to get windows system information.

Developing

You can install each python module using pip:

python -m pip install .

inside each directory with a setup.py file.

You can also install all current dev releases using the following command:

python -m pip install --upgrade --pre systembridgeshared systembridgebackend systembridgecli systembridgeconnector systembridgefrontend systembridgegui systembridgewindowssensors

Frontend

To develop the frontend, enter into the frontend directory and use yarn to install the dependencies:

cd frontend
yarn install

Then start the development server:

yarn start:dev

Once you have finished, you can build and export the frontend then install the python package by running:

yarn build
yarn export
python -m pip install .

Windows Sensors

Open the .NET solution in the windowssensors directory, make your changes and build the solution.

Then install the package by running:

python -m pip install .