Skip to content

Hyperion Binding ​

This binding integrates openHAB with the Hyperion ambient lighting software. Further details on the Hyperion project can be found on the Hyperion project website

Supported Things ​

  • Hyperion Server (may be referred to as V1)
  • Hyperion.ng Server

Binding Configuration ​

The binding itself does not require any special configuration.

Discovery ​

Automatic background discovery only works for Hyperion.ng servers as they advertise using mDNS. You must manually configure a Hyperion Server V1 either through a UI/REST or .things file.

Thing Configuration ​

Hyperion Server (V1) ​

In order to use a Hyperion Server, it must be properly configured. You can do this either through a UI/REST or through static .things files.

ParameterData typeRequiredExample
hostStringY"192.168.0.10"
portIntegerY19444
priorityIntegerY50
poll_frequencyIntegerY15

To manually configure a Hyperion Server you must specify the following parameters: host, port, priority and polling frequency.

In the Thing file, this looks for e.g. like

dsl
Thing hyperion:serverV1:myServer [ host="192.168.0.10", port=19444, priority=50, poll_frequency=15]

Hyperion.ng Server ​

In order to use a Hyperion.ng Server, it must be properly configured. You can do this either through a UI/REST or through static .things files.

ParameterData typeRequiredExample
hostStringY"192.168.0.10"
portIntegerY19444
priorityIntegerY50
poll_frequencyIntegerY15
originStringY"openHAB"
instancesStringN"0,1"

The optional instances parameter is a comma-separated list of Hyperion instance indices to which commands are applied; leave it empty to apply commands to all instances.

To manually configure a Hyperion.ng Server you must specify the following parameters: host, port, priority, polling frequency and origin.

In the .things file, this looks for e.g. like

dsl
Thing hyperion:serverNG:myServer [ host="192.168.0.10", port=19444, priority=50, poll_frequency=15, origin="openHAB"]

Channels ​

Hyperion Server (V1) ​

ChannelItemDescriptionExample
brightnessDimmerSets/stores the current brightnesshyperion:serverV1:myServer:brightness
effectStringSets/stores the current effecthyperion:serverV1:myServer:effect
colorColorSets/stores the current colorhyperion:serverV1:myServer:color
clearStringClears the priority of the given input (e.g. "50")hyperion:serverV1:myServer:clear

Hyperion.ng Server ​

ChannelItemDescriptionExample
brightnessDimmerSets/stores the current brightnesshyperion:serverNG:myServer:brightness
effectStringSets/stores the current effecthyperion:serverNG:myServer:effect
colorColorSets/stores the current colorhyperion:serverNG:myServer:color
clearStringClears the priority of the given input (e.g. "50")hyperion:serverNG:myServer:clear
hyperionenabledSwitchEnables or disables Hyperionhyperion:serverNG:myServer:hyperionenabled
blackborderSwitchEnables or disables the black border componenthyperion:serverNG:myServer:blackborder
smoothingSwitchEnables or disables the smoothing componenthyperion:serverNG:myServer:smoothing
kodicheckerSwitchEnables or disables the kodi checker componenthyperion:serverNG:myServer:kodichecker
forwarderSwitchEnables or disables the forwarder componenthyperion:serverNG:myServer:forwarder
udplistenerSwitchEnables or disables the udp listener componenthyperion:serverNG:myServer:udplistener
boblightserverSwitchEnables or disables the boblight server componenthyperion:serverNG:myServer:boblightserver
grabberSwitchEnables or disables the grabber componenthyperion:serverNG:myServer:grabber
v4lSwitchEnables or disables the V4L componenthyperion:serverNG:myServer:v4l
leddeviceSwitchEnables or disables the led device componenthyperion:serverNG:myServer:leddevice

Items ​

Hyperion Server (V1) ​

dsl
Dimmer Brightness "Brightness [%s]" {channel="hyperion:serverV1:myServer:brightness"}
Color MyColor "Color" {channel="hyperion:serverV1:myServer:color"}
String Effect "Current effect [%s]" {channel="hyperion:serverV1:myServer:effect"}
String Clear "Clear priority" {channel="hyperion:serverV1:myServer:clear"}

Hyperion.ng Server ​

dsl
Dimmer Brightness "Brightness [%s]" {channel="hyperion:serverNG:myServer:brightness"}
Color MyColor "Color" {channel="hyperion:serverNG:myServer:color"}
String Effect "Current effect [%s]" {channel="hyperion:serverNG:myServer:effect"}
String Clear "Clear priority" {channel="hyperion:serverNG:myServer:clear"}
Switch HyperionEnabled "Hyperion Enabled" {channel="hyperion:serverNG:myServer:hyperionenabled"}
Switch BlackBorderEnabled "Black Border" {channel="hyperion:serverNG:myServer:blackborder"}
Switch SmoothingEnabled "Smooting" {channel="hyperion:serverNG:myServer:smoothing"}
Switch KodiCheckerEnabled "Kodi Checker" {channel="hyperion:serverNG:myServer:kodichecker"}
Switch ForwarderEnabled "Forwarder" {channel="hyperion:serverNG:myServer:forwarder"}
Switch UdpListenerEnabled "UDP Listener" {channel="hyperion:serverNG:myServer:udplistener"}
Switch BoblightEnabled "Boblight" {channel="hyperion:serverNG:myServer:boblightserver"}
Switch GrabberEnabled "Grabber" {channel="hyperion:serverNG:myServer:grabber"}
Switch V4lEnabled "V4L" {channel="hyperion:serverNG:myServer:v4l"}
Switch LedDeviceEnabled "LED Device" {channel="hyperion:serverNG:myServer:leddevice"}

Example Sitemap ​

Using the above things channels and items Sitemap:

dsl
sitemap demo label="Main Menu" {
 Frame  {
  // serverV1 & serverNG
  Slider item=Brightness
  Colorpicker item=MyColor
  Selection item=Effect mappings=[
    'Cinema brighten lights'='Cinema brighten lights',
    'Cinema dim lights'='Cinema dim lights',
    'Knight rider'='Knight rider',
    'Blue mood blobs'='Blue mood blobs',
    'Cold mood blobs'='Cold mood blobs',
    'Full color mood blobs'='Full color mood blobs',
    'Green mood blobs'='Green mood blobs',
    'Red mood blobs'='Red mood blobs',
    'Warm mood blobs'='Warm mood blobs',
    'Police Lights Single'='Police Lights Single',
    'Police Lights Solid'='Police Lights Solid',
    'Rainbow mood'='Rainbow mood',
    'Rainbow swirl fast'='Rainbow swirl fast',
    'Rainbow swirl'='Rainbow swirl',
    'Running dots'='Running dots',
    'System Shutdown'='System Shutdown',
    'Snake'='Snake',
    'Sparks Color'='Sparks Color',
    'Sparks'='Sparks',
    'Strobe blue'='Strobe blue',
    'Strobe Raspbmc'='Strobe Raspbmc',
    'Strobe white'='Strobe white',
    'Color traces'='Color traces',
    'X-Mas'='X-Mas'
  ]
  Switch item=Clear mappings=[50="Clear"]

  // only serverNG
  Switch item=HyperionEnabled
  Switch item=BlackBorderEnabled
  Switch item=SmoothingEnabled
  Switch item=KodiCheckerEnabled
  Switch item=ForwarderEnabled
  Switch item=UdpListenerEnabled
  Switch item=BoblightEnabled
  Switch item=GrabberEnabled
  Switch item=V4lEnabled
  Switch item=LedDeviceEnabled
 }
}