hyperion.ng/README.md
LordGrey f98938020a
Add Supported Platforms documention (#1257)
* Add Supported Platforms docu

* Update SupportedPlatforms.md

* Update SupportedPlatforms.md

* Rearrange development related documentation
2021-07-13 21:07:48 +02:00

3.5 KiB

Hyperion

Latest-Release GitHub Actions LGTM Documentation made-with-love

About Hyperion

Hyperion is an opensource Bias or Ambient 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).

Screenshot

Features:

  • Low CPU load makes it perfect for SoCs like Raspberry Pi
  • Json interface which allows easy integration into scripts
  • A command line utility for testing and integration in automated environment
  • 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).
  • Black border detector and processor
  • A scriptable (Python) effect engine with 39 build-in effects for your inspiration
  • A multi language web interface to configure and remote control hyperion

If you need further support please open a topic at the forum!
Hyperion webpage/forum

Contributing

Contributions are welcome! Feel free to join us! We are looking always for people who wants to participate.
Contributors

For an example, you can participate in the translation.
Join Translation

Supported Platforms

Find here more details on supported platforms and configuration sets

Documentation

Covers these topics (WorkInProgress)

  • Installation
  • Configuration
  • Effect development
  • JSON API

Visit Documentation

Changelog

Released and unreleased changes at Changelog.md

Building

See CompileHowto.

Download

Alpha releases available from the Hyperion release page

License

The source is released under MIT-License (see https://opensource.org/licenses/MIT).
GitHub license