Driver Details

Integer Helper

By: RTI
Updated: Aug. 7, 2020
Version: 1.3

Description:

Assists with some of the tasks that you commonly deal with when using the integer based variables in a driver: It can scale or translate a number from one range to another. It creates an alert mechanism when a variable gets outside a given range. It also can give you boolean (reverse/visible) variables for each possible value of an integer. It helps create pop ups when the variable changes and can create a text based 'gauge' based on the integer value.

Integer Helper

The Integer Helper Driver assists with some of the tasks that you commonly deal with when using the integer based variables in a driver: It can scale or translate a number from one range to another. It creates an alert mechanism when a variable gets outside a given range. It also can give you boolean (reverse/visible) variables for each possible value

Version History
1.0: The initial release of the driver
1.1: Added the pop-up variable and events

Driver Configuration
The main configuration task is to select the variable the driver will watch. The Integer Variable pulldown menu will allow you to choose any of the integer based variables in the drivers currently in your system file.

The main configuration page also allows you to turn on the different tasks in the driver separately. Each task requires a small amount of processing power each time the variable changes so it's best to disable any function you don't need.

Scaling
Scaling is most commonly used for volume translation, converting a device that uses a -82 to 12 range for example into one that shows 0 to 100. Another common use is US to metric conversion of temperature or distance.

Creating the conversion is simple: first enable the conversion by checking the Scaling Enabled option, then fill two integers in the current range of your variable into the Native variable range and put their equivalent, converted, values in for the Target numbers. These don't have to be the absolute largest and smallest values although the conversion will be more accurate with further apart numbers.

The Scaled Output variable will then be a continuous conversion of the input variable. Every time the source variable changes the output variable will change to match it. Because ID and the RTI variable system always work using integers there is usually a remainder and that is available as a variable as well.

Text Gauge
The Text Gauge variable takes the scaler output and makes a text string that is that many characters long. Originally intended for the KX2 and other 'graphically challenged' panels but usable on any panel that can display 2 way text. It can be made any size by changing the font size and/or the Target Maximum of the scaler. It can also be given a reverse color.

Boolean
Often a driver will return a devices state as an integer with several possible values. If you want to create an individual button for each possible state and have a reverse variable for it you can use the driver’s booleanator feature. To use this feature you first enable it and then tell the driver whether to create the booleans from the original variable or from the output of the scaler. You can also enter the number of booleans needed. Keeping this number at the minimum needed will help reduce the processing power needed by the driver.

Range Checking
You can also create events and variables that warn when the value of a variable is outside a certain range. When Range checking is enables you are given the choice whether to check the min and max against the original variable or the output of the scaler. You can then specify the initial min and max variables for the comparison. Commands exist in the driver to set, increment and decrement these values.

Pop Up Control
The Pop Up Variable is used to control visibility if you want a graphic to show only when the variable changes. When the integer variable changes the Show Pop Up will go true. It will remain true as long as the variable keeps changing. The Pop Up Length setting in the configuration controls how long the flag remains high after the variable stops changing. There are also driver events that match the changes in variables.