mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
Add Supported Platforms documention (#1257)
* Add Supported Platforms docu * Update SupportedPlatforms.md * Update SupportedPlatforms.md * Rearrange development related documentation
This commit is contained in:
LordGrey
GitHub
236
doc/development/CompileHowto.md
Normal file
236
doc/development/CompileHowto.md
Normal file
@@ -0,0 +1,236 @@
|
||||
|
||||
# With Docker
|
||||
If you are using [Docker](https://www.docker.com/), you can compile Hyperion inside a docker container. This keeps your system clean and with a simple script it's easy to use. Supported is also cross compiling for Raspberry Pi (Debian Stretch or higher). To compile Hyperion just execute one of the following commands.
|
||||
|
||||
The compiled binaries and packages will be available at the deploy folder next to the script.<br/>
|
||||
Note: call the script with `./docker-compile.sh -h` for more options.
|
||||
|
||||
## Native compilation on Raspberry Pi for:
|
||||
|
||||
**Raspbian Stretch**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i rpi-raspbian
|
||||
```
|
||||
**Raspbian Buster**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i rpi-raspbian -t buster
|
||||
```
|
||||
|
||||
## Cross compilation on x86_64 for:
|
||||
|
||||
**x86_64 (Debian Stretch):**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i x86_64
|
||||
```
|
||||
**x86_64 (Debian Buster):**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i x86_64 -t buster
|
||||
```
|
||||
**Raspberry Pi v1 & ZERO (Debian Stretch)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv6l
|
||||
```
|
||||
**Raspberry Pi v1 & ZERO (Debian Buster)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv6l -t buster
|
||||
```
|
||||
**Raspberry Pi 2/3/4 (Debian Stretch)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv7l
|
||||
```
|
||||
**Raspberry Pi 2/3/4 (Debian Buster)**
|
||||
```console
|
||||
wget -qN https://raw.github.com/hyperion-project/hyperion.ng/master/bin/scripts/docker-compile.sh && chmod +x *.sh && ./docker-compile.sh -i armv7l -t buster
|
||||
```
|
||||
## Cross compilation on x86_64 for developers
|
||||
Using additional options you can cross compile locally
|
||||
-l: use a local hyperion source code directory rather than cloning from GitHub
|
||||
-c: do incremental compiles, Note: you need to keep the image and tag stable
|
||||
|
||||
**Compile code in $HYPERION_HOME incrementally for Raspberry Pi 2/3/4 (Debian Buster)**
|
||||
```console
|
||||
cd $HYPERION_HOME
|
||||
./bin/scripts/docker-compile.sh -l -c -i armv7l -t buster
|
||||
```
|
||||
# The usual way
|
||||
|
||||
## Debian/Ubuntu/Win10LinuxSubsystem
|
||||
|
||||
```console
|
||||
sudo apt-get update
|
||||
sudo apt-get install git cmake build-essential qtbase5-dev libqt5serialport5-dev libqt5sql5-sqlite libqt5svg5-dev libqt5x11extras5-dev libusb-1.0-0-dev python3-dev libcec-dev libxcb-image0-dev libxcb-util0-dev libxcb-shm0-dev libxcb-render0-dev libxcb-randr0-dev libxrandr-dev libxrender-dev libavahi-core-dev libavahi-compat-libdnssd-dev libjpeg-dev libturbojpeg0-dev libssl-dev zlib1g-dev
|
||||
```
|
||||
|
||||
**on RPI you need the videocore IV headers**
|
||||
|
||||
```console
|
||||
sudo apt-get install libraspberrypi-dev
|
||||
```
|
||||
|
||||
**OSMC on Raspberry Pi**
|
||||
```console
|
||||
sudo apt-get install rbp-userland-dev-osmc
|
||||
```
|
||||
|
||||
**ATTENTION Win10LinuxSubsystem** we do not (/we can't) support using hyperion in linux subsystem of MS Windows 10, albeit some users tested it with success. Keep in mind to disable
|
||||
all linux specific led and grabber hardware via cmake. Because we use QT as framework in hyperion, serialport leds and network driven devices could work.
|
||||
|
||||
|
||||
## Arch
|
||||
See [AUR](https://aur.archlinux.org/packages/?O=0&SeB=nd&K=hyperion&outdated=&SB=n&SO=a&PP=50&do_Search=Go) for PKGBUILDs on arch. If the PKGBUILD does not work ask questions there please.
|
||||
|
||||
## Fedora
|
||||
The following dependencies are needed to build hyperion.ng on fedora.
|
||||
```console
|
||||
sudo dnf -y groupinstall "Development Tools"
|
||||
sudo dnf install python3-devel qt-devel qt5-qtbase-devel qt5-qtserialport-devel libjpeg-devel xrandr xcb-util-image-devel qt5-qtx11extras-devel turbojpeg-devel libusb-devel avahi-libs avahi-compat-libdns_sd-devel xcb-util-devel dbus-devel openssl-devel fedora-packager rpmdevtools gcc libcec-devel
|
||||
```
|
||||
After installing the dependencies, you can continue with the compile instructions later on this page (the more detailed way..).
|
||||
|
||||
## OSX
|
||||
To install on OS X you either need Homebrew or Macport but Homebrew is the recommended way to install the packages. To use Homebrew XCode is required as well, use `brew doctor` to check your install.
|
||||
|
||||
First you need to install the dependencies:
|
||||
```console
|
||||
brew install qt5 python3 cmake libusb doxygen zlib
|
||||
```
|
||||
|
||||
## Windows (WIP)
|
||||
We assume a 64bit Windows 10. Install the following;
|
||||
- [Git](https://git-scm.com/downloads) (Check: Add to PATH)
|
||||
- [CMake (Windows win64-x64 Installer)](https://cmake.org/download/) (Check: Add to PATH)
|
||||
- [Visual Studio 2019 Build Tools](https://go.microsoft.com/fwlink/?linkid=840931) ([direct link](https://aka.ms/vs/16/release/vs_buildtools.exe))
|
||||
- Select C++ Buildtools
|
||||
- On the right, just select `MSVC v142 VS 2019 C++ x64/x86-Buildtools` and latest `Windows 10 SDK`. Everything else is not needed.
|
||||
- [Win64 OpenSSL v1.1.1h](https://slproweb.com/products/Win32OpenSSL.html) ([direct link](https://slproweb.com/download/Win64OpenSSL-1_1_1h.exe))
|
||||
- [Python 3 (Windows x86-64 executable installer)](https://www.python.org/downloads/windows/) (Check: Add to PATH and Debug Symbols)
|
||||
- Open a console window and execute `pip install aqtinstall`.
|
||||
- Now we can download Qt to _C:\Qt_ `mkdir c:\Qt && aqt install -O c:\Qt 5.15.0 windows desktop win64_msvc2019_64`
|
||||
|
||||
### Optional:
|
||||
- For DirectX9 grabber:
|
||||
- DirectX Software Development Kit. The download link is no longer available, so you will have to search for it yourself.
|
||||
- For package creation:
|
||||
- [NSIS 3.x](https://sourceforge.net/projects/nsis/files/NSIS%203/) ([direct link](https://sourceforge.net/projects/nsis/files/latest/download))
|
||||
|
||||
# Compiling and installing Hyperion
|
||||
|
||||
## The general quick way (without big comments)
|
||||
|
||||
**complete automated process for Mac/Linux:**
|
||||
```console
|
||||
wget -qO- https://raw.githubusercontent.com/hyperion-project/hyperion.ng/master/bin/compile.sh | sh
|
||||
```
|
||||
|
||||
**some more detailed way: (or more or less the content of the script above)**
|
||||
|
||||
```console
|
||||
# be sure you fulfill the prerequisites above
|
||||
git clone --recursive https://github.com/hyperion-project/hyperion.ng.git hyperion
|
||||
cd hyperion
|
||||
mkdir build
|
||||
cd build
|
||||
cmake -DCMAKE_BUILD_TYPE=Release ..
|
||||
make -j $(nproc)
|
||||
if this get stucked and dmesg says out of memory try:
|
||||
make -j 2
|
||||
# optional: install into your system
|
||||
sudo make install/strip
|
||||
# to uninstall (not very well tested, please keep that in mind)
|
||||
sudo make uninstall
|
||||
# ... or run it from compile directory
|
||||
bin/hyperiond
|
||||
# webui is located on localhost:8090 or 8091
|
||||
```
|
||||
|
||||
## The detailed way (with many comments)
|
||||
|
||||
**Download:**
|
||||
Creates hyperion directory and checkout the code from github
|
||||
```console
|
||||
export HYPERION_DIR="hyperion"
|
||||
git clone --recursive --depth 1 https://github.com/hyperion-project/hyperion.ng.git "$HYPERION_DIR"
|
||||
```
|
||||
|
||||
**Preparations:**
|
||||
Change into hyperion folder and create a build folder
|
||||
```console
|
||||
cd "$HYPERION_DIR"
|
||||
mkdir build
|
||||
cd build
|
||||
```
|
||||
|
||||
**Generate the make files:**
|
||||
To generate make files with automatic platform detection and default settings:
|
||||
This should fit to *RPI, x86, amlogic/wetek:
|
||||
```console
|
||||
cmake -DCMAKE_BUILD_TYPE=Release ..
|
||||
```
|
||||
|
||||
*Developers on x86* linux should use:
|
||||
```console
|
||||
cmake -DPLATFORM=x11-dev -DCMAKE_BUILD_TYPE=Release ..
|
||||
```
|
||||
|
||||
To use framebuffer instead of dispmanx (for example on the *cubox-i*):
|
||||
```console
|
||||
cmake -DENABLE_FB=ON -DCMAKE_BUILD_TYPE=Release ..
|
||||
```
|
||||
|
||||
To generate make files on OS X:
|
||||
|
||||
Platform should be auto detected and refer to osx, you can also force osx:
|
||||
```console
|
||||
cmake -DPLATFORM=osx -DCMAKE_BUILD_TYPE=Release ..
|
||||
```
|
||||
|
||||
In case you would like to build with a dedicated Qt version, provide the version's location via the CMAKE_PREFIX_PATH:
|
||||
```console
|
||||
cmake -DCMAKE_PREFIX_PATH=/opt/Qt/5.15.2/gcc_64 -DCMAKE_BUILD_TYPE=Release ..
|
||||
```
|
||||
|
||||
To generate files on Windows (Release+Debug capable):
|
||||
|
||||
Platform should be auto detected and refer to windows, you can also force windows:
|
||||
|
||||
```posh
|
||||
# You might need to setup MSVC env first
|
||||
call "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvars64.bat"
|
||||
cmake -DPLATFORM=windows -G "Visual Studio 16 2019" ..
|
||||
```
|
||||
|
||||
**Run make to build Hyperion:**
|
||||
The `-j $(nproc)` specifies the amount of CPU cores to use.
|
||||
```console
|
||||
make -j $(nproc)
|
||||
```
|
||||
|
||||
On a mac you can use ``sysctl -n hw.ncpu`` to get the number of available CPU cores to use.
|
||||
|
||||
```console
|
||||
make -j $(sysctl -n hw.ncpu)
|
||||
```
|
||||
|
||||
On Windows run:
|
||||
```posh
|
||||
cmake --build . --config Release -- -maxcpucount
|
||||
```
|
||||
Maintainer: To build installer, install [NSIS](https://nsis.sourceforge.io/Main_Page) and set env `VCINSTALLDIR="C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC"`
|
||||
|
||||
**Install hyperion into your system:**
|
||||
Copy all necessary files to ``/usr/local/share/hyperion``
|
||||
```console
|
||||
sudo make install/strip
|
||||
```
|
||||
|
||||
If you want to install into another location call this before installing
|
||||
|
||||
```console
|
||||
cmake -DCMAKE_INSTALL_PREFIX=/home/pi/apps ..
|
||||
```
|
||||
This will install to ``/home/pi/apps/share/hyperion``
|
||||
|
||||
|
||||
**Integrating hyperion into your system:**
|
||||
|
||||
... ToDo
|
||||
BIN
doc/development/Hyperion-platforms_supported.xlsx
Normal file
BIN
doc/development/Hyperion-platforms_supported.xlsx
Normal file
Binary file not shown.
1
doc/development/LedDevice_Flows.drawio
Normal file
1
doc/development/LedDevice_Flows.drawio
Normal file
File diff suppressed because one or more lines are too long
BIN
doc/development/LedDevice_Flows.png
Normal file
BIN
doc/development/LedDevice_Flows.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 198 KiB |
40
doc/development/SupportedPlatforms.md
Normal file
40
doc/development/SupportedPlatforms.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Hyperion - Supported platforms
|
||||
Hyperion is currently suported on the following sets of configuration:
|
||||
> **_NOTE:_** Configurations tagged as unofficial are running in general, but are provided/maintained on a best effort basis.\
|
||||
In case of problems, it is recommended checking with the wider Hyperion community (https://hyperion-project.org/forum/).
|
||||
|
||||
## Official
|
||||
| Hardware | OS | Version | Grabber | Package | Comments |
|
||||
|-----------|-----------------|--------------------|-----------------------------------------|-------------------------------------------------------------------------------|------------------------------------|
|
||||
| X64 | Windows | 10 | QT¹ | [Windows-AMD64.exe](https://github.com/hyperion-project/hyperion.ng/releases) | Direct X9 Grabber via self-compile |
|
||||
| X64 | Ubuntu | 18.04, 20.04² | QT¹<br/>XCB/X11¹ | [Linux-x86_64.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| X64 | Debian | 9, 10³ | QT¹<br/>XCB/X11¹ | [Linux-x86_64.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 4 | HyperBian | 9, 10³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [HyperBian.zip](https://github.com/Hyperion-Project/HyperBian/releases) | |
|
||||
| RPi 4 | Raspberry Pi OS | 9, 10³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [Linux-armv7l.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 3 /3+ | HyperBian | 9, 10³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [HyperBian.zip](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 3 /3+ | Raspberry Pi OS | 9, 10³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [Linux-armv7l.deb](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
|
||||
## Unofficial
|
||||
In case you have an additional working setups you would like to share with the community, please get in touch or issue a PR to have the table updated.
|
||||
|
||||
| Hardware | OS | Version | Grabber | Package | Comments |
|
||||
|---------------|-----------------|---------------|-----------------------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| X64 | macOS | 11 | QT<br>OSX | [macOS-x86_64.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | M1 not tested |
|
||||
| X64 | Fedora | | QT¹<br/>XCB/X11¹ | [Linux-x86_64.rpm](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| X64 | Arch | | QT¹<br/>XCB/X11¹ | [Linux-x86_64.rpm](https://github.com/hyperion-project/hyperion.ng/releases) | |
|
||||
| RPi 0/ 1 / 2 | Raspberry Pi OS | 9, 10³ | QT¹<br/>XCB/X11¹<br/>DispmanX | [Linux-armv6l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | No recommended |
|
||||
| RPi 4 | LibreElec | 10.x (Matrix) | QT¹ | [Linux-armv7l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | [Install on LibreELEC](https://hyperion-project.org/forum/index.php?thread/10463-install-hyperion-ng-on-libreelec-x86-64-rpi-inoffiziell-unofficially/) |
|
||||
| RPi 4 | LibreElec | 9.2.x (Leia) | QT¹<br/>DispmanX | [Linux-armv7l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | [Install on LibreELEC](https://hyperion-project.org/forum/index.php?thread/10463-install-hyperion-ng-on-libreelec-x86-64-rpi-inoffiziell-unofficially/) |
|
||||
| RPi 3 /3+ | LibreElec | 10.x (Matrix) | QT¹ | [Linux-armv7l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | [Install on LibreELEC](https://hyperion-project.org/forum/index.php?thread/10463-install-hyperion-ng-on-libreelec-x86-64-rpi-inoffiziell-unofficially/) |
|
||||
| RPi 3 /3+ | LibreElec | 9.2.x (Leia) | QT¹<br/>DispmanX | [Linux-armv7l.tar.gz](https://github.com/hyperion-project/hyperion.ng/releases) | [Install on LibreELEC](https://hyperion-project.org/forum/index.php?thread/10463-install-hyperion-ng-on-libreelec-x86-64-rpi-inoffiziell-unofficially/) |
|
||||
| Amlogic | CoreElec | 19.x (Matrix) | Amlogic | CoreElec Plugin | Supported via CoreElec project |
|
||||
| Amlogic | CoreElec | 9.2.x (Leia) | Amlogic | CoreElec Plugin | Supported via CoreElec project |
|
||||
| Vero4K | OSMC | | | | [hyperion-vero4k](https://github.com/hissingshark/hyperion-vero4k) |
|
||||
| LG TV | webOS | | - | | [hyperion-webos](https://github.com/webosbrew/hyperion-webos) |
|
||||
|
||||
Legend
|
||||
---
|
||||
¹ Requires an environment with `DISPLAY` defined\
|
||||
² 18=Bionic Beaver 20=Focal Fossa\
|
||||
³ 9=Stretch, 10=Buster
|
||||
|
||||
Reference in New Issue
Block a user