1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

Hyperion Plugins Introduction

Discussion in 'Archive' started by Brindosch, 17 November 2017.

Thread Status:
Not open for further replies.
  1. Brindosch

    Brindosch Active Member

    Messages:
    658
    Hardware:
    RPi1/Zero, RPi2, RPi3, +nodeMCU/ESP8266
    What are Plugins?
    Hyperion does not provide solutions for every use case. Integration of "all use cases" would blow up the code (size) very fast and has a bunch of down sides like rapid update publishing for every tiny change and higher instabillity risk of the core. Also the Hyperion programming language (C++) is too complex for beginners and trivial tasks.
    So Hyperion starts little external programs written in Python, we call them "Plugin"

    A Plugin adds a new feature to Hyperion
    • This can be a simple timer event like. "Enable Hyperion at nine o'clock", "Dimm brightness to 50% at ten o'clock"
    • Interaction between Hyperion and a media player. "Enable capture when video plays and disable on stop"
    • Home automation, your telephone rings so "Run the notification effect in red for 5 seconds"
    Comfortable for Users
    • We provide Plugins from our repository
    • The installation is simple, open the web configuration and install one or more plugins
    • Configuration is also done through the web configuration, hassle free.
    • Start / stop / update / remove whenever you want.
    • Automatic updates on new versions
    • Security: A buzzword these days. We will do our best that plugins won't harm or do suspicious actions on your system, as each plugin will be reviewed before we add it to the repository.
    Comfortable for Developers
    • Programming for beginners, Python is easy to learn.
    • Tutorial with sample plugin which gets you started in no time: Plugin Development Starter
    • Fully documented API: Plugin Development API
    • Be sure your work will be honored by submitting Plugins to our repository where the Hyperion community around the globe can download them.

    FAQ:

    Can i use a plugin which is not part of the Hyperion repository?
    Yes, we don't regulate the usage of plugins, you can share them as a .zip file with other people. But use them on your own risk.

    Can i use another repository?
    No final decision, currently it's limited to our repository. The idea behind one repository for all is also to prevent heavy "plugin splitting", we are a small but active community and Hyperion is a niches software. So let's gather all the great plugins at one place with proper information and support flow.

    I have an idea for a new Plugin
    Create a new thread which describes your idea, another user can take your proposal or a team member will have a look. If you want to learn a little bit Python programming you probably want to have a look at this: https://docs.hyperion-project.org/en/developer/plugins_dev#our_first_plugin
    With the sample plugin as template you can create a new plugin very fast
     
    • Like Like x 1
Thread Status:
Not open for further replies.