Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 2.96 KB

install.md

File metadata and controls

90 lines (66 loc) · 2.96 KB

Installing

  1. Install dependencies
  2. Build from source or install using prebuilt binaries.

Install Dependencies

Linux

sudo apt install \
          gcc \
          g++ \
          libappindicator3-dev \
          libdbus-1-dev \
          libfontconfig-dev \
          libgtk-3-dev \
          libpulse-dev \
          libudev-dev \
          libx11-dev \
          libxdo-dev \
          pkg-config \
          protobuf-compiler

Note: Tested on Ubuntu 24.04 LTS

Windows

  • SteelSeries Engine - Optional. All devices can be controlled via raw USB calls, routing via SSE is optional.
  • Protobuf Compiler - Optional. Only required when building from source.

Common

  • Rust - Optional. Only required when building from source.
  • Cargo Make - Optional. This is convenient when building from source, though the commands may also be written by hand.

Build from Source

  1. Open Terminal.

  2. Download repository and go into the directory.

    git clone https://github.com/llMBQll/OmniLED
    cd OmniLED

  3. Build & Install If you have installed cargo make (see dependencies) you may execute a single command to build binaries and run setup utility.

    cargo make run-setup

    Else you need to compile the targets manually. This requires 2 build steps due to package dependencies.

    cargo build --release -p omni-led -p audio -p clock -p images -p media -p weather
    cargo build --release -p omni-led-setup
    cargo run --release --bin omni-led-setup -- install --interactive

Post installation steps

Linux

Allow USB access

To allow this program to access your device, it needs an entry in udev rules.

  1. Create udev rules entry.
    touch /etc/udev/rules.d/69-omni-led.rules

  2. Using your favourite text editor add the following lines and adapt it for your device

    SUBSYSTEM=="usb", ATTRS{idVendor}=="1038", ATTRS{idProduct}=="1618", MODE="0666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="1038", ATTRS{idProduct}=="1618", MODE="0666", GROUP="plugdev"

  3. Reload udev rules (in case this is insufficient, you may need to unplug and plug in the device or restart the system).
    sudo udevadm control --reload-rules && sudo udevadm trigger

Common

You are now ready to proceed to customization.

Prebuilt Binaries

You can find prebuilt binaries for Windows in the releases section on GitHub.

To install or uninstall OmniLED, double-click the executable and follow the on-screen instructions.
Alternatively, you can run the executable from the command line with the install or uninstall. Use the --help flag to see all available options.