Installation - AEtHeLsYn/hyperion GitHub Wiki

For installation on OpenELEC see here.

For installation on OSMC see here.

Prerequisites

Hyperion make use of some external libraries. * The [QT libraries](http://qt-project.org) are used as a basis for the application. * The libusb libraries are needed for certain devices. * Default set of CA-certificates to allow download from github.

All of these would be installed through the installation script.

In almost all cases is it important, before running the install, to make sure 'boblight' is disabled. Hyperion and boblight most likely use the same device which leads to a conflict if both are on. Boblight can be disabled in the Raspbmc settings menu. To temporarily disable boblight run (boblight will restart on reboot):

sudo /sbin/initctl stop boblight

Deployment

The installation of hyperion consists of several steps:
  1. installation of the hyperiond and hyperion-remote (default installed to '/usr/bin')
  2. configuration file for the hyperion daemon (default file '/etc/hyperion.config.json')
  3. add hyperiond as a os-service
  • on initctl: "hyperion.conf" in '/etc/init'
  • on init.d: "hyperion" in '/etc/init.d'
  • on systemd: "hyperion.service" in '/etc/systemd/system'
  1. start the hyperion service
  • on initctl: 'initctl start hyperion'
  • on init.d: 'service hyperion start'
  • on systemd: 'service hyperion start'
  1. Raspbery Pi only: add "dtparam=spi=on" to your config.txt (reboot required)

All these steps are wrapped into a single installation script available from the github repository (bin/install_hyperion.sh). This will download and perform the above mentioned steps. Note: You need root privileges to install hyperion.

If you use PWM LEDs (WS281X): Just use the install script with the following command

wget -nv -N https://raw.github.com/tvdzwan/hyperion/master/bin/install_hyperion.sh && chmod +x install_hyperion.sh
sudo sh ./install_hyperion.sh WS281X

If you use SPI LEDs (WS2801, APA102, LPDXXXX, ...: Just use the install script with the following command

wget -nv -N https://raw.github.com/tvdzwan/hyperion/master/bin/install_hyperion.sh && chmod +x install_hyperion.sh
sudo sh ./install_hyperion.sh

Note that the installed configuration file may need some changes dependent on your hardware setup. See the configuration page for more information.

Test installation

Test the installation by checking if data can be send to Hyperion. For example try setting all leds to red for 5 seconds: ``` hyperion-remote --priority 50 --color red --duration 5000 ```

Restart Hyperion

If you want to change the hyperion config for example you can use the following command. `restart` is also a valid option. ``` # Raspbian(wheezy/jessie)/OSMC users sudo service hyperion stop sudo service hyperion start

Raspbmc/Xbian users

sudo /sbin/initctl stop hyperion sudo /sbin/initctl start hyperion

Test hyperion

hyperion-remote --effect "Rainbow swirl fast" --duration 3000


<h4>Disable Hyperion</h4>
The system depending scripts will start Hyperion on each boot. If you want to disable Hyperion or switch back to Boblight simply stop Hyperion and delete the script:

On OpenELEC

killall hyperiond sed -i "/hyperiond/d" /storage/.config/autostart.sh

On Raspbian Wheezy/Debian 7 and other init.d driven systems

sudo /usr/sbin/service hyperion stop sudo update-rc.d -f hyperion remove sudo rm -v /etc/init.d/hyperion

On Xbian/Ubuntu 14.04 and other initctl driven systems

sudo /sbin/initctl stop hyperion rm /etc/init/hyperion.conf initctl reload-configuration

On Raspbian Jessie/OSMC/Debian 8 and other systemd driven systems

sudo service hyperion stop sudo systemctl disable hyperion.service rm -v /etc/systemd/system/hyperion.service

<h4>Remove Hyperion</h4>
It is possible to remove Hyperion completely from your system. Just use the remove_hyperion.sh (Backup you config if necessary!)
Use the following command

wget -nv -N https://raw.github.com/tvdzwan/hyperion/master/bin/remove_hyperion.sh && chmod +x remove_hyperion.sh && sudo sh ./remove_hyperion.sh

For OpenELEC and other systems that can´t use "wget"

curl -# -k -L --output remove_hyperion.sh --get https://raw.github.com/tvdzwan/hyperion/master/bin/remove_hyperion.sh && sudo sh ./remove_hyperion.sh

Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️