Skip to content

superbox-dev/unipi-control-os

Repository files navigation

license-url

Unipi Control OS

Unipi Control OS is a lightweight and memory-efficient Linux based operating system optimized to host Unipi Control.


For more information please read the documentation at: docs.superbox.one


Getting started

  1. Download the latest release *.img.xz from GitHub.
  2. Write the image *.img.xz to your SD card with Balena Etcher.
  3. Insert SD card to your Unipi Neuron and power the system on.
  4. Connect to your Unipi Neuron with ssh on Linux/macOS or with Putty on Windows (The username and password are unipi).
    ssh unipi@unipi.local
  5. Install Unipi Control with the OPKG package manager.
    sudo opkg install unipi-control
  6. Read the Unipi Control documentation to configure your Unipi Neuron and copy the configuration files to /usr/local/etc/unipi.
  7. Start the service with:
    sudo systemctl start unipi-control.service

The Unipi Neuron I/O are now available in your network via MQTT.

Optionally: You can use the Unipi Neuron I/O in Home Assistant. Read the MQTT documentation from Home Assistant.

Supported hardware

  • Unipi Neuron (Raspberry Pi 3B+)

If you have an Unipi device, that is not supported, then contact use.

Changelog

The changelog lives in the CHANGELOG.md document. The format is based on Keep a Changelog.

Contributing

We're happy about your contributions to the project!

You can get started by reading the CONTRIBUTING.md.

Donation

We put a lot of time into this project. If you like it, you can support us with a donation.

ko-fi

Additional information

This is a third-party software for Unipi Neuron. This software is NOT from Unipi Technology s.r.o..