HAI Omni Pro II Driver

RSS

The HAI Omni Pro II Driver connects to an HAI Omni Pro II security and automation panel.

The following HAI features are supported:

Lights
Thermostats
Outputs
Flags
Areas
Zones
Arming/Disarming

Units such as lights, outputs and flags can be addressed individually starting with 1 for each type, for example light 1 or output 1. Since HAI users may be more accustomed to addressing each unit by it's HAI id, this is supported as well.

This driver can communicate with the HAI Omni Pro II via the computer's network port.

Manufacturer: Home Automation, Inc (HAI)

Primary Communications Port: Network

Table of Contents [Hide/Show]

Configuration Settings

Host Name : The host name or ip address of HAI Omni. The IP address can be found using the Omni keypad in the Setup/Misc menu.
Port : (optional) The port to connect to. Defaults to 4369. This can be found using the Omni keypad in the Setup/Misc menu.
Encryption Key Part 1 : This is the first part of the encryption key. This can be found using the Omni keypad in the Setup/Misc menu.
Encryption Key Part 2 : This is the second part of the encryption key. This can be found using the Omni keypad in the Setup/Misc menu.
Temperature Scale : The temperature scale to use when reporting temperatures.

Events

Light On/Off State Changed

Occurs when the light changes from on to off or off to on. Any level greater than zero is considered on.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Output State Changed

Occurs when an output's state changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Thermostate Current Temperature Changed

Occurs when a thermostat current temperature changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Termostat Current Humidity Changed

Occurs when a thermostat current humidity changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Thermostat Fan Mode Changed

Occurs when a thermostat fan mode changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Thermostat Cool Set Point Changed

Occurs when a thermostat cool set point changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Thermostat Heat Set Point Changed

Occurs when a thermostat heat set point changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Thermostat Hold State Changed

Occurs when a thermostat hold state changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Thermostat Mode Changed

Occurs when a thermostat mode changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Physical Status Changed

Occurs when a zone's physical status changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Area Arm Status Changed

Occurs when an area's arm status changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Area Arm Up State Changed

Occurs when an area's arm up state changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Temperature Changed

Occurs when a zone's temperature changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Zone Humidity Changed

Occurs when a zone's humidity changes.

Whenever Filter:

PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

Number Index : The index within the property array.
Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Instance Properties

ModelVersion

Gets the model and version.

Accessibility : Read Only

Type: String

Connected

Gets a value indicating if the driver is connected to the hai unit.

Accessibility : Read Only

Type: Boolean

LightLevels

Gets the percent on level of the lights. 0-100

Accessibility : Read Only

Type: Array

LightOnOffs

Gets or sets the light to a fully on state or fully off.

Accessibility : Read Only

Type: Array

LightNames

Gets the names of all lights.

Accessibility : Read Only

Type: Array

UnitLevels

Gets the level of all units (lights, outputs, and flags).

Accessibility : Read Only

Type: Array

UnitNames

Gets the names of all units (lights, outputs, and flags).

Accessibility : Read Only

Type: Array

OutputStates

Gets the state of all outputs. true=closed, false=open

Accessibility : Read Only

Type: Array

OutputNames

Gets the names of all outputs.

Accessibility : Read Only

Type: Array

FlagLevels

Gets the level of all flags. (0-255)

Accessibility : Read Only

Type: Array

FlagNames

Gets the names of all flags.

Accessibility : Read Only

Type: Array

ThermostatNames

Gets the names of all thermostats.

Accessibility : Read Only

Type: Array

ThermostatCurrentTemperatures

Gets the current thermostat temperatures.

Accessibility : Read Only

Type: Array

ThermostatCurrentHumidities

Gets the current thermostat humidities.

Accessibility : Read Only

Type: Array

ThermostatFanModes

Gets the current thermostat fan modes.

Accessibility : Read Only

Type: Array

ThermostatFanModeTexts

Gets the current thermostat fan modes as displayable text.

Accessibility : Read Only

Type: Array

ThermostatCoolSetPoints

Gets the current thermostat cool set point temperatures.

Accessibility : Read Only

Type: Array

ThermostatHeatSetPoints

Gets the current thermostat heat set point temperatures.

Accessibility : Read Only

Type: Array

ThermostatHolds

Gets the current thermostat hold states.

Accessibility : Read Only

Type: Array

ThermostatModes

Gets the current thermostat modes.

Accessibility : Read Only

Type: Array

ThermostatModeTexts

Gets the current thermostat modes as displayable text.

Accessibility : Read Only

Type: Array

AreaNames

Gets the names of all areas.

Accessibility : Read Only

Type: Array

ZoneNames

Gets the names of all zones.

Accessibility : Read Only

Type: Array

ZonePhysicalStatuses

Gets the physical status for all zones. -1=Unknown, 0=Normal, 1=Trouble, 2=Violated, 3=Bypassed

Accessibility : Read Only

Type: Array

ZonePhysicalStatusTexts

Gets the physical status as displayable text for all zones.

Accessibility : Read Only

Type: Array

AreaArmStatuses

Gets the arm status for all areas. -1=Unknown, 0=Disarmed, 1=Armed Away, 2=Armed Day, 3=Armed day Instant, 4=Armed Night Delay, 5=Armed Night, 6=Armed Vacation

Accessibility : Read Only

Type: Array

AreaArmStatusTexts

Gets the arm status as displayable text for all areas. -1=Unknown, 0=Disarmed, 1=Armed Away, 2=Armed Stay, 3= Armed Stay Instant, 4= Armed Night, 5=Armed Night Instant, 6=Armed Vacation

Accessibility : Read Only

Type: Array

AreaArmUpStates

Gets the arm up state for all areas. -1=Unknown, 0=Not Ready To Arm, 1=Ready To Arm, 2=Ready To Force Arm, 3=Armed With Exit Timer Working, 4=Armed Fully, 5=Force Armed With A Force Arm Zone Violated, 6=Armed With A Bypass

Accessibility : Read Only

Type: Array

AreaArmUpStateTexts

Gets the arm up state as displayable text for all areas.

Accessibility : Read Only

Type: Array

ZoneTemperatures

Gets the temperature for all temperature zones.

Accessibility : Read Only

Type: Array

ZoneHumidities

Gets the humidity for all humidity zones.

Accessibility : Read Only

Type: Array

TaskNames

Gets the names of all macro buttons, also known as tasks.

Accessibility : Read Only

Type: Array

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

Instance Methods

ArmNight ( Number, Number )

Puts the specified area in the armed night state.

Syntax

void ArmNight( Number areaID, Number securityCode )

Settings

areaID : The area (1-8) to arm.

securityCode : The four digit security code.

ArmNightInstant ( Number, Number )

Puts the specified area in the armed night instant state.

Syntax

void ArmNightInstant( Number areaID, Number securityCode )

Settings

areaID : The area (1-8) to arm.

securityCode : The four digit security code.

ArmVacation ( Number, Number )

Puts the specified area in the arm vacation state.

Syntax

void ArmVacation( Number areaID, Number securityCode )

Settings

areaID : The area (1-8) to arm.

securityCode : The four digit security code.

BypassZone ( Number, Number )

Bypass a zone.

Syntax

void BypassZone( Number zoneID, Number securityCode )

Settings

zoneID : The zone (1-96) to bypass.

securityCode : The four digit security code.

RestoreZone ( Number, Number )

Restore a bypassed zone.

Syntax

void RestoreZone( Number zoneID, Number securityCode )

Settings

zoneID : The bypassed zone (1-96) to restore.

securityCode : The four digit security code.

RestoreAreaZones ( Number, Number )

Restores all bypassed zones in the specified area.

Syntax

void RestoreAreaZones( Number areaID, Number securityCode )

Settings

areaID : The area (1-8) to restore all bypassed zones.

securityCode : The four digit security code.

RestoreAreaZones ( Number )

Restores all bypassed zones in all areas.

Syntax

void RestoreAreaZones( Number securityCode )

Settings

securityCode : The four digit security code.

ActivateTask ( Number )

Executes a macro button, also known as Activate Task.

Syntax

void ActivateTask( Number taskID )

Settings

taskID : The number of the button to execute.

TurnOnLight ( Number )

Turns on the specified light.

Syntax

void TurnOnLight( Number deviceID )

Settings

deviceID : The device id (1-256).

TurnOffLight ( Number )

Turns off the specified light.

Syntax

void TurnOffLight( Number deviceID )

Settings

deviceID : The device id (1-256).

SetLightLevel ( Number, Number )

Sets the % level of the specified light.

Syntax

void SetLightLevel( Number deviceID, Number percentOn )

Settings

deviceID : The device id (1-256).

percentOn : The brightness percent level to set the device to. (0-100)

TurnOnAllLights

Turn on all lights.

Syntax

void TurnOnAllLights( )

Settings

none

TurnOffAllLights

Turn off all lights.

Syntax

void TurnOffAllLights( )

Settings

none

TurnOnLightByName ( String )

Turns on the specified light (or PLC device).

Syntax

void TurnOnLightByName( String name )

Settings

name : The name of the light.

TurnOffLightByName ( String )

Turns off the specified light (or PLC device).

Syntax

void TurnOffLightByName( String name )

Settings

name : The name of the light.

SetLightLevelByName ( String, Number )

Sets the % level of the specified light (or PLC device) by device name.

Syntax

void SetLightLevelByName( String name, Number percentOn )

Settings

name : The name of the light.

percentOn : The brightness percent level to set the device to. (0-100)

TurnOnUnit ( Number )

Turns on the specified unit (light, output, or flag).

Syntax

void TurnOnUnit( Number unitID )

Settings

unitID : The unit id.

TurnOffUnit ( Number )

Turns off the specified unit (light, output, or flag).

Syntax

void TurnOffUnit( Number unitID )

Settings

unitID : The unit id.

SetUnitLevel ( Number, Number )

Sets the % level of the specified unit (light, output, or flag).

Syntax

void SetUnitLevel( Number unitID, Number level )

Settings

unitID : The unit id.

level : Error: The method 'SetUnitLevel' is missing a ScriptObjectMethodParameterAttribute for 'level'.

TurnOnOutput ( Number )

Turns off an output.

Syntax

void TurnOnOutput( Number outputID )

Settings

outputID : The ID of the output to turn on.

TurnOffOutput ( Number )

Opens an output

Syntax

void TurnOffOutput( Number outputID )

Settings

outputID : The ID of the output to turn off.

SetThermostatCoolSetPoint ( Number, Number )

Sets the cool set point temperature of a thermostat.

Syntax

void SetThermostatCoolSetPoint( Number thermostatID, Number setPoint )

Settings

thermostatID : The ID of the thermostat. (1-64)

setPoint : The cool set point temperature. (-40C-50C) (-40F-122F)

SetThermostatHeatSetPoint ( Number, Number )

Sets the heat set point temperature of a thermostat.

Syntax

void SetThermostatHeatSetPoint( Number thermostatID, Number setPoint )

Settings

thermostatID : The ID of the thermostat. (1-64)

setPoint : The heat set point temperature. (-40C-50C) (-40F-122F)

SetThermostatFanMode ( Number, Number )

Sets a thermostat's fan mode.

Syntax

void SetThermostatFanMode( Number thermostatID, Number fanMode )

Settings

thermostatID : The ID of the thermostat.

fanMode : The fan mode: 0=auto, 1=on, 2=cycle.

0 = Auto

1 = On

2 = Cycle

SetThermostatHold ( Number, Boolean )

Sets the hold state of a thermostat.

Syntax

void SetThermostatHold( Number thermostatID, Boolean hold )

Settings

thermostatID : The ID of the thermostat. (1-64)

hold : The hold state. true=hold is on, false=hold is off.

SetThermostatMode ( Number, Number )

Sets the cooling/heating mode of a thermostat.

Syntax

void SetThermostatMode( Number thermostatID, Number mode )

Settings

thermostatID : The ID of the thermostat. (1-64)

mode : The mode. 0=Off, 1=Heat, 2=Cool, 3=Auto, 4=Emergency Heat

0 = Off

1 = Heat

2 = Cool

3 = Auto

4 = Emergency Heat

Disarm ( Number, Number )

Puts the specified area in the disarmed state.

Syntax

void Disarm( Number areaID, Number securityCode )

Settings

areaID : The area (1-8) to arm.

securityCode : The four digit security code.

ArmAway ( Number, Number )

Puts the specified area in the armed away state.

Syntax

void ArmAway( Number areaID, Number securityCode )

Settings

areaID : The area (1-8) to arm.

securityCode : The four digit security code.

ArmStay ( Number, Number )

Puts the specified area in the armed stay state.

Syntax

void ArmStay( Number areaID, Number securityCode )

Settings

areaID : The area (1-8) to arm.

securityCode : The four digit security code.

ArmStayInstant ( Number, Number )

Puts the specified area in the armed stay instant state.

Syntax

void ArmStayInstant( Number areaID, Number securityCode )

Settings

areaID : The area (1-8) to arm.

securityCode : The four digit security code.