/system-bridge

A bridge for your systems

Primary LanguageTypeScriptMIT LicenseMIT

System Bridge

CI CodeQL

A bridge for your systems.

Logo

Features

  • System Information - Access your system's Audio, Battery, Bluetooth, CPU, Display, Filesystems, Graphics, Keyboard, Memory, Networking, OS, Process and System information via the API.
  • Send Commands and Open files and URLs - Automate your system by sending a command or opening a URL/path via the API.
  • Send Notifications - Send system notifications via the API.
  • Cross-Platform - Compatible with Windows, Mac and Linux.
  • Integrated with Home Assistant - Interact with your Bridges using Home Assistant.

API Endpoints

You can find documentation for the API here.

Download

You can download the latest version of the application here.

Support my work

If you like my work, and would like to send me a tip/donation, please use the links below:

Sponsor Timmo

Buy me a coffee

Links

Developing

Dependencies

To make changes to the application, you will need:

  • Node.js
  • Yarn

Optional Dependencies

MDNS

You will only need this if you want to be able to discover the app over mdns. The app will warn you if there are missing dependencies.

MDNS - Windows

You will need the "Bonjour SDK for Windows" or a related SDK in your system.

MDNS - Linux
Ubuntu/Debian/APT
sudo apt install \
    libavahi-compat-libdnssd-dev \
    libpng++-dev \
    libxext-dev \
    libxss-dev \
    libxtst-dev
Fedora/DNF/RPM
sudo dnf install \
    avahi-compat-libdns_sd-devel
    libpng-devel \
    libxext-devel \
    libxss-devel \
    libxtst-devel

Setup

yarn install:all

Running

yarn start:dev

or:

yarn start

Package

yarn package

Publishing

Make sure the version in package.json matches the release before publishing.

  1. Find the draft release created by the release drafter workflow.
  2. Publish the release.

The deploy workflow will then publish the release for each platform.