2022-09-05 23:53:41 +02:00
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "doc/logo_dark.png" >
< source media = "(prefers-color-scheme: light)" srcset = "doc/logo_light.png" >
< img alt = "Hyperion" src = "doc/logo_light.png" >
< / picture >
2019-05-04 22:04:03 +02:00
2022-01-09 17:23:50 +01:00
[](https://github.com/hyperion-project/hyperion.ng/releases)
2020-07-12 11:30:06 +02:00
[](https://github.com/hyperion-project/hyperion.ng/actions)
2022-12-27 08:36:10 +01:00
[](https://github.com/hyperion-project/hyperion.ng/actions/workflows/codeql.yml)
2022-01-09 17:23:50 +01:00
[](https://www.hyperion-project.org)
[](https://docs.hyperion-project.org)
2023-05-29 21:43:28 +02:00
[](https://discord.gg/XtVTb3HEKS)
2022-01-09 17:23:50 +01:00
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
2021-11-17 20:35:28 +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.
2016-06-20 09:23:52 +02:00
2019-07-09 23:07:31 +02:00
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
2022-04-27 17:46:36 +02:00
### Supported Hardware
2022-04-30 20:30:04 +02:00
You can find a list of supported hardware [here ](https://docs.hyperion-project.org/en/user/leddevices/ ).
2022-04-27 17:46:36 +02:00
2020-05-15 22:13:07 +02:00
If you need further support please open a topic at the forum!< br >
2022-01-09 17:23:50 +01:00
[](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 >
2022-01-09 17:23:50 +01:00
[](https://github.com/hyperion-project/hyperion.ng/graphs/contributors)
2019-07-09 23:07:31 +02:00
2020-05-15 22:13:07 +02:00
For an example, you can participate in the translation.< br >
2022-01-09 17:23:50 +01:00
[](https://poeditor.com/join/project/Y4F6vHRFjA)
2013-08-14 11:03:41 +02:00
2021-07-13 21:07:48 +02:00
## Supported Platforms
2019-07-12 20:38:23 +02:00
2021-07-13 21:07:48 +02:00
Find here more details on [supported platforms and configuration sets ](doc/development/SupportedPlatforms.md )
2016-12-02 22:47:09 +01:00
2020-05-12 19:51:19 +02:00
## Documentation
2021-12-03 13:17:43 +01:00
Covers these topics:
- [Installation ](https://docs.hyperion-project.org/en/user/Installation.html )
- [Configuration ](https://docs.hyperion-project.org/en/user/Configuration.html )
- [Effect development ](https://docs.hyperion-project.org/en/effects/#effect-files )
- [JSON API ](https://docs.hyperion-project.org/en/json/ )
2020-05-12 19:51:19 +02:00
2022-01-09 17:23:50 +01:00
[](https://docs.hyperion-project.org)
2020-05-12 19:51:19 +02:00
2020-07-12 09:18:40 +02:00
## Changelog
2021-12-03 13:17:43 +01:00
Released and unreleased changes at [CHANGELOG.md ](CHANGELOG.md )
2020-07-12 09:18:40 +02:00
2017-10-13 17:49:29 +02:00
## Building
2022-02-08 17:21:55 +01:00
See [CompileHowto.md ](doc/development/CompileHowto.md ).
2016-12-02 22:47:09 +01:00
2021-12-03 13:17:43 +01:00
## Installation
2022-05-22 08:01:49 +02:00
See [Documentation ](https://docs.hyperion-project.org/en/user/Installation.html ) or at [Installation.md ](Installation.md ).
2021-12-03 13:17:43 +01:00
2017-10-13 17:49:29 +02:00
## Download
2021-11-17 20:35:28 +01:00
Releases available from the [Hyperion release page ](https://github.com/hyperion-project/hyperion.ng/releases )
2017-10-13 17:49:29 +02:00
2022-02-08 17:21:55 +01:00
## Privacy Policy
See [PRIVACY.md ](PRIVACY.md ).
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
[](https://raw.githubusercontent.com/hyperion-project/hyperion.ng/master/LICENSE)
