2021-05-01 17:00:44 +02:00
![Hyperion ](doc/logo.png )
2019-05-04 22:04:03 +02:00
2020-03-26 21:41:15 +01:00
[![Latest-Release ](https://img.shields.io/github/v/release/hyperion-project/hyperion.ng?include_prereleases )](https://github.com/hyperion-project/hyperion.ng/releases)
2020-07-12 11:30:06 +02:00
[![GitHub Actions ](https://github.com/hyperion-project/hyperion.ng/workflows/Hyperion%20CI%20Build/badge.svg?branch=master )](https://github.com/hyperion-project/hyperion.ng/actions)
2019-07-09 23:07:31 +02:00
[![LGTM ](https://img.shields.io/lgtm/alerts/g/hyperion-project/hyperion.ng.svg )](https://lgtm.com/projects/g/hyperion-project/hyperion.ng/alerts/)
2019-07-12 16:54:26 +02:00
[![Documentation ](https://codedocs.xyz/hyperion-project/hyperion.ng.svg )](https://codedocs.xyz/hyperion-project/hyperion.ng/)
2020-12-23 23:42:51 +01:00
[![made-with-love ](https://img.shields.io/badge/Made%20with-♥-ff0000.svg )](#)
2019-02-06 21:12:22 +01:00
2019-07-09 23:07:31 +02:00
## About Hyperion
2016-07-24 20:27:02 +02:00
2020-03-09 21:44:18 +01:00
[Hyperion ](https://github.com/hyperion-project/hyperion.ng ) is an opensource [Bias or Ambient Lighting ](https://en.wikipedia.org/wiki/Bias_lighting ) implementation which you might know from TV manufacturers. It supports many LED devices and video grabbers. The project is still in a alpha development stage (no stable release available).
2016-06-20 09:23:52 +02:00
2019-07-09 23:07:31 +02:00
![Screenshot ](doc/screenshot.png )
2016-06-20 09:23:52 +02:00
2019-07-09 23:07:31 +02:00
### Features:
2016-06-20 09:23:52 +02:00
2016-12-02 22:47:09 +01:00
* Low CPU load makes it perfect for SoCs like Raspberry Pi
* Json interface which allows easy integration into scripts
2019-10-17 19:59:25 +02:00
* A command line utility for testing and integration in automated environment
2019-07-09 23:07:31 +02:00
* Priority channels are not coupled to a specific led data provider which means that a provider can post led data and leave without the need to maintain a connection to Hyperion. This is ideal for a remote application (like our [Android app ](https://play.google.com/store/apps/details?id=nl.hyperion.hyperionpro )).
* Black border detector and processor
2020-12-23 23:42:51 +01:00
* A scriptable (Python) effect engine with 39 build-in effects for your inspiration
2019-07-09 23:07:31 +02:00
* A multi language web interface to configure and remote control hyperion
2016-12-02 22:47:09 +01:00
2020-05-15 22:13:07 +02:00
If you need further support please open a topic at the forum!< br >
2019-07-09 23:07:31 +02:00
[![Hyperion webpage/forum ](https://img.shields.io/website/https/hyperion-project.org.svg?down_color=red&down_message=offline&up_color=green&up_message=online )](https://www.hyperion-project.org)
2016-04-30 01:14:28 +02:00
2020-05-12 19:51:19 +02:00
## Contributing
2019-07-09 23:07:31 +02:00
2020-05-15 22:13:07 +02:00
Contributions are welcome! Feel free to join us! We are looking always for people who wants to participate.< br >
2019-07-09 23:07:31 +02:00
[![Contributors ](https://img.shields.io/github/contributors/hyperion-project/hyperion.ng.svg )](https://github.com/hyperion-project/hyperion.ng/graphs/contributors)
2020-05-15 22:13:07 +02:00
For an example, you can participate in the translation.< br >
2019-07-09 23:07:31 +02:00
[![Join Translation ](https://img.shields.io/badge/POEditor-translate-green.svg )](https://poeditor.com/join/project/Y4F6vHRFjA)
2013-08-14 11:03:41 +02:00
2017-10-13 17:49:29 +02:00
## Requirements
2020-05-12 19:51:19 +02:00
Debian 9, Ubuntu 16.04 or higher.
2019-07-12 20:38:23 +02:00
2019-07-12 22:04:48 +02:00
We provide a macOS Build but we can not support this.
2016-12-02 22:47:09 +01:00
2020-05-12 19:51:19 +02:00
## Documentation
Covers these topics (WorkInProgress)
2020-05-25 21:51:11 +02:00
- Installation
2020-05-12 19:51:19 +02:00
- Configuration
- Effect development
- JSON API
2020-05-15 22:13:07 +02:00
[![Visit Documentation ](https://img.shields.io/website?down_message=offline&label=Documentation%20%20&up_message=online&url=https%3A%2F%2Fdocs.hyperion-project.org )](https://docs.hyperion-project.org)
2020-05-12 19:51:19 +02:00
2020-07-12 09:18:40 +02:00
## Changelog
Released and unreleased changes at [Changelog.md ](CHANGELOG.md )
2017-10-13 17:49:29 +02:00
## Building
2020-02-10 15:21:58 +01:00
See [CompileHowto ](CompileHowto.md ) and [CrossCompileHowto ](CrossCompileHowto.md ).
2016-12-02 22:47:09 +01:00
2017-10-13 17:49:29 +02:00
## Download
2020-02-20 19:12:44 +01:00
Alpha releases available from the [Hyperion release page ](https://github.com/hyperion-project/hyperion.ng/releases )
2017-10-13 17:49:29 +02:00
2016-12-02 22:47:09 +01:00
## License
2020-10-26 01:21:09 +01:00
The source is released under MIT-License (see https://opensource.org/licenses/MIT).< br >
2019-07-09 23:07:31 +02:00
[![GitHub license ](https://img.shields.io/badge/License-MIT-yellow.svg )](https://raw.githubusercontent.com/hyperion-project/hyperion.ng/master/LICENSE)