Skip to content

Hayward OmniLogic Binding ​

The Hayward OmniLogic binding integrates the OmniLogic pool controller using the Hayward API.

The Hayward OmniLogic API interacts with Hayward's cloud servers and requires an Internet connection for sending and receiving information.

Supported Things ​

The table below lists the Hayward OmniLogic binding Thing types:

ThingsDescriptionThing Type
Hayward OmniLogic ConnectionConnection to Hayward's serverbridge
BackyardBackyardbackyard
Body of WaterBody of Waterbow
ChlorinatorChlorinatorchlorinator
Colorlogic LightColorlogic Lightcolorlogic
FilterFilter controlfilter
Heater EquipmentActual heater (i.e. gas, solar, electric)heater
PumpAuxiliary pump control (i.e., spillover)pump
RelayAccessory relay control (deck jet sprinklers, lights, etc.)relay
Virtual HeaterA virtual heater that can control all heater equipment based on priorityvirtualHeater

Discovery ​

The binding will automatically discover the Omnilogic pool things from the cloud server using your Hayward Omnilogic credentials.

Thing Configuration ​

Hayward OmniLogic Connection Parameters:

PropertyDefaultRequiredDescription
Host Namehttps://app1.haywardomnilogic.com/HAAPI/HomeAutomation/API.ashYesHost name of the Hayward API server
User NameNoneYesYour Hayward User Name (not email address)
PasswordNoneYesYour Hayward User Password
Telemetry Poll Delay3YesTelemetry Poll Delay (2-60 seconds)
Alarm Poll Delay10YesAlarm Poll Delay (0-120 seconds, 0 disabled)

Channels ​

Backyard Channels ​

Channel Type IDItem TypeDescriptionRead Write
backyardAirTempNumber:TemperatureBackyard air temp sensor readingR
backyardStatusStringBackyard statusR
backyardStateStringBackyard stateR
backyardAlarm1StringBackyard alarm #1R
backyardAlarm2StringBackyard alarm #2R
backyardAlarm3StringBackyard alarm #3R
backyardAlarm4StringBackyard alarm #4R
backyardAlarm5StringBackyard alarm #5R

Body of Water Channels ​

Channel Type IDItem TypeDescriptionRead Write
bowFlowSwitchBody of Water flow sensor feedbackR
bowWaterTempNumber:TemperatureBody of Water temperatureR

Chlorinator Channels ​

Channel Type IDItem TypeDescriptionRead Write
chlorEnableSwitchChlorinator enableR/W
chlorOperatingModeStringChlorinator operating modeR
chlorTimedPercentNumber:DimensionlessChlorinator salt output (%)R/W
chlorOperatingStateNumberChlorinator operating stateR
chlorScModeStringChlorinator super chlorinate modeR
chlorErrorStringChlorinator error bit arrayR
chlorAlertStringChlorinator alert bit arrayR
chlorAvgSaltLevelNumber:DimensionlessChlorinator average salt level in Part per Million (ppm)R
chlorInstantSaltLevelNumber:DimensionlessChlorinator instant salt level in Part per Million (ppm)R
chlorStatusStringChlorinator status bit arrayR

Chlorinator Error Bit Array ​

BitsValueDescription
1:000 = OK, 01 = Short, 10 = OpenCurrent Sensor
3:200 = OK, 01 = Short, 10 = OpenVoltage Sensor
5:400 = OK, 01 = Short, 10 = OpenCell Temp Sensor
7:600 = OK, 01 = Short, 10 = OpenBoard Temp Sensor
9:800 = OK, 01 = Short, 10 = OpenK1 Relay
11:1000 = OK, 01 = Short, 10 = OpenK2 Relay
13:1200 = OK, 01 = Type, 10 = Authentication, 11 = Comm LossCell Errors
140Aquarite PCB Error

Chlorinator Alert Bit Array ​

BitsValueDescription
1:000 = OK, 01 = Salt Low, 10 = Salt too LowLow salt
20 = OK, 1 = HighHigh Current
30 = OK, 1 = LowLow Voltage
5:400 = OK, 01 = Low, 10 = Scaleback, 11 = HighCell Water Temp
7:600 = OK, 01 = High, 10 = ClearingBoard Temp
80Not Used
10:90Not Used
12:1100 = OK, 01 = CleanCell Cleaning/Runtime

Chlorinator Status Bit Array ​

BitsValueDescription
00 = OK, 1 = Error PresentError Present
10 = OK, 1 = Alert PresentAlert Present
20 = Standy, 1 = GeneratingGenerating
30 = Not Paused, 1 = PausedPaused
40 = Local Not Paused, 1 = Local PausedLocal Pause
50 = Not Authenticated, 1 = AuthenticatedT-Cell Authenticated
60 = K1 Relay Off, 1 = K1 Relay OnK1 Relay Active
70 = K2 Relay Off, 1 = K2 Relay OnK2 Relay Active

Colorlogic Light Channels ​

Channel Type IDItem TypeDescriptionRead Write
colorLogicLightEnableSwitchColorlogic Light enableR/W
colorLogicLightStateStringColorlogic Light stateR
colorLogicLightCurrentShowStringColorlogic Light current showR/W
colorLogicLightBrightnessStringColorlogic Light brightnessR/W
colorLogicLightSpeedStringColorlogic Light speedR/W

Note: Brightness and speed channels only available on Hayward V2 lights

Filter Channels ​

Channel Type IDItem TypeDescriptionRead Write
filterEnableSwitchFilter enableR/W
filterValvePositionStringFilter valve positionR
filterSpeedPercentNumber:DimensionlessFilter speed (%)R/W
filterSpeedRpmNumber:FrequencyFilter speed (rpm)R/W
filterSpeedSelectStringFilter speed presetsR/W
filterStateStringFilter stateR
filterLastSpeedNumber:DimensionlessFilter last speed (%)R

Heater Channels ​

Channel Type IDItem TypeDescriptionRead Write
heaterStateStringHeater stateR
heaterEnableSwitchHeater enableR

Pump Channels ​

Channel Type IDItem TypeDescriptionRead Write
pumpEnableSwitchPump enableR/W
pumpSpeedPercentNumber:DimensionlessPump speed (%)R/W
pumpSpeedRpmNumber:FrequencyPump speed in RPMR/W
pumpSpeedSelectStringPump speed presetsR/W
pumpStateStringPump stateR
pumpLastSpeedNumber:DimensionlessPump last speed (%)R

Relay Channels ​

Channel Type IDItem TypeDescriptionRead Write
relayStateSwitchRelay stateR/W

Virtual Heater Channels ​

Channel Type IDItem TypeDescriptionRead Write
heaterEnableSwitchHeater enableR
heaterCurrentSetpointNumber:TemperatureHeater Current SetpointR/W

Note: Item types such as Number:Dimensionless should have their units (e.g., %, ppm) defined in the unit metadata.

Full Example ​

After installing the binding, manually add the Hayward Connection Thing and enter your credentials. All pool items can be automatically discovered by scanning the bridge. Go to the Inbox and add the things.