Button SysVar Events Driver

© 2022, Hilium Pty Ltd

Go to www.HomeAutomationCo.com.au/rti-drivers for the License Key (see below). Or contact support@hilium.com.au.

This driver enhances the capability of other drivers by providing a range of events based on button press actions and changes to external (other drivers’) system variables. Up to 50 external variables can be monitored each with a corresponding button.

This amongst other uses allows a button press to fully control a dimmable lighting load. For example, short press can toggle on/off; long press can dim up or dim down based on what the load/dimmer did last (by keeping track of the previous change to the external variable); and a double press can turn a dimmer to say 100%. Even where the most recent change was initiated from outside the RTI system as long as feedback has been received by the RTI processor.

Release History

1.0 Apr 2022 Initial release of the driver

Functionality

The following button press functions are implemented:

Press

Release

Toggle

On

Off

However, the power in this driver is not from the basic functions but rather from the Driver Events.

Events

The following driver events are implemented for each button:

Button Events:

Press

Double Press

Long Press

Release

Short Release

Long Release

Toggle

On

Off

Ramp Events: – to control drivers that support ramped level changes

Ramp Up

Ramp Down

Ramp Steps: – to control drivers that allow level setting

Ramp 0%

Ramp 10%

Ramp 20%

Ramp 30%

Ramp 40%

Ramp 50%

Ramp 60%

Ramp 70%

Ramp 80%

Ramp 90%

Ramp 100%

The above Ramp Events and Ramp Steps use the integer value of the nominated external system variable (Ext SysVar) as the basis for the ramp. The Ext SysVar is monitored to keep track of its changes which may have occurred from a change initiated within RTI or it may have been external with feedback to RTI. For example, a light may have been turned on, off or dimmed via a wall switch with feedback to RTI. This driver records the change in the Ext SysVar level so that a subsequent change desired by the RTI end user will be appropriate.

Driver Properties

Settings

Short Press

Maximum duration in milliseconds between ‘press’ and ‘release’ to trigger a “Short Press” event. This is also the Interval between dimmer step change events. Default is 400ms.

Double Press

Maximum duration in milliseconds between first release and second release to trigger a “Double Press” event. Default is 300ms.

License Credentials

License Key

Use ‘Trial’ for testing purposes – the driver will be fully functional for 60 minutes.

Enter a Valid License key issued by Hilium Pty Ltd for production use. Contact details above.

System Variable “License Variable” “Status” will show whether not a valid license key has been entered.

System Integer variables

Number or Variables

The number of external system variables to monitor (50 maximum) and the corresponding number of buttons.

.

Integer Variable 1

Select the relevant external system variable from other RTI drivers from the drop-down list for the 1st button.

.

.

.

Integer Variable 50

Select the relevant external system variable from other RTI drivers from the drop-down list for the 50th button.

Functions – commands available in Apex

For each button the commands are:

Press Commands:

Press

Triggers Press Event

Triggers Long Press if held for > ‘short press’ duration

Triggers Ramp Up or Ramp Down Event depending on last change to Ext SysVar if held for > ‘short press’ duration

Triggers Ramp x% events every ‘short press’ interval to produce a step based ramp to control other drivers, if held for > ‘short press’ duration and repeats until Ramp 0% or Ramp 100% Event is trigger once

Release

Triggers Release Event

Triggers Short Release, Long Release, or Double Press as appropriate

Toggle

Triggers Toggle Event

On

Triggers On Event

Off

Triggers Off Event

System Events – available in Apex

As described in ‘Events’ above and further detailed in Functions immediately above for each button.

System Variables – available in Apex

For each button the system variables are:

Last Event – String, the name of the last event triggered

Last Change – Boolean, the direction of the last change of the monitored external SysVar. Value are up (true) or down (false)

Not Last Change – Boolean, the logical opposite of ‘Last Change’

Ramp Up – Boolean, true is ramp up is occurring (ie button press held > ‘short press’ duration and still held)

Ramp Down – Boolean, true is ramp down is occurring

Var IntegerOut – Integer, showing the level in steps (0, 10, 20...100) corresponding to the Ramp x% Events.

Level Index – Integer, showing the level in steps (0, 1, 2..10) corresponding to the Ramp x/10% Events. Intended to be used as an image list index.

Last Updated 5 April 2022