bpavlov / hyperion_rgb

Hyperion Installation on MacOS

Updated 2019-07-11

This guide details the installation of Hyperion, an application to mimic the functionality of Ambilight, on MacOS.

Hyperion does not come pre-packaged for MacOS, so you have to compile it yourself.

A similar guide is provided on the Hyperion Project GitHub, but is not specific to Mac systems and could lead to confusion. In addition, I had a number of build issues with those instructions on MacOS High Sierra. So, this guide is written for a forked version tested to work on my system.

Disclaimer:

This guide was tested on a system running MacOS High Sierra. I cannot guarantee this will work smoothly on your system.

1. Install Xcode and Command Line Tools

Open the Mac App Store (App Store.app). Search for and install Xcode. Your system may need to restart to complete the installation.

Once that's complete, install Xcode's command line tools. Open Terminal.app and run the following command:

xcode-select --install

2. Install or Update Homebrew

You will need the Mac package manager Homebrew to download dependencies. You can learn more about Homebrew here.

In Terminal.app, run the following command:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

If you already have Homebrew, update it:

brew update && brew upgrade

3. Install Dependencies

Now run these commands:

brew tap cartr/qt4
brew tap-pin cartr/qt4
brew install git cmake qt@4 libusb python doxygen

If you get a warning about Python not being linked (probably because Python 3+ is linked), run this command:

brew link python

If you get any errors, you'll want to dig into those before proceeding.

4. Download Hyperion

Consider where you would like to locate the "Hyperion" directory. For example, you could build this in a Documents subfolder (~/Documents/Hyperion).

Open Terminal, cd to the Documents directory, and add the Hyperion folder as an environment variable:

cd ~/Documents
export HYPERION_DIR="Hyperion"

Now clone the files from GitHub:

git clone --recursive https://github.com/yeutterg/hyperion-macos.git "$HYPERION_DIR"

5. Build and Install Hyperion

Make a new folder called "build" in the Hyperion directory, then enter it:

mkdir "$HYPERION_DIR/build"
cd "$HYPERION_DIR/build"

Run cmake then make:

cmake -DENABLE_DISPMANX=OFF -DENABLE_SPIDEV=OFF -DENABLE_V4L2=OFF -DENABLE_OSX=ON ..
make -j $(nproc)

If everything works (you get the message '[100%] Built target hyperion-osx'), install Hyperion on your system:

sudo make install/strip

Then clean up:

strip bin/*

6. Configure Hyperion with HyperCon

Download the HyperCon utility and move the HyperCon.jar file to a permanent folder, for example ~/Documents. Then open it.

If you get a security warning when trying to open HyperCon.jar, go to System Preferences > Security & Privacy and click "Open Anyway" near the bottom right of the window.

Refer to the wiki configuration page for HyperCon instructions specific to your setup.

Once you are done with the HyperCon, you'll press "Create Hyperion Configuration" to export a file with a default name of 'hyperion.config.json'.

7. Run Hyperion

Open Terminal and cd to the folder containing 'hyperion.config.json'. Run the following command:

hyperiond config.file hyperion.config.json

You may have to refine your configuration based on the messages in Terminal.