Skip to content

GetCHLORParams ​

Status VerifiedOpcode156TypeRead

Reads the chlorinator's configuration in one reply: state, mode, body and cell type, timed percent, superchlorinate and ORP timeouts.

Parameters ​

nametypenotes
poolIdint
equipmentIdint

Reply ​

Opcode1156

GetCHLORParamsRsp

nametypeunit
poolIdint
chlorIdint
cfgStatebyte
opModebyte
bowTypebyte
cellTypebyte
timedPercentbyte
scTimeoutbytehour
orpTimeoutbytehour

Example ​

typescript
const reply = await omni.command("GetCHLORParams", {
  poolId: 1,
  equipmentId: 6,
});

Request XML ​

xml
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://nextgen.hayward.com/api">
  <Name>GetCHLORParams</Name>
  <Parameters>
    <Parameter name="poolId" dataType="int">1</Parameter>
    <Parameter name="equipmentId" dataType="int">6</Parameter>
  </Parameters>
</Request>

Response XML ​

xml
<?xml version="1.0" encoding="UTF-8" ?>
<Response xmlns="http://nextgen.hayward.com/api">
  <Name>GetCHLORParamsRsp</Name>
  <Parameters>
    <Parameter name="PoolID" dataType="int">1</Parameter>
    <Parameter name="ChlorID" dataType="int">6</Parameter>
    <Parameter name="CfgState" dataType="byte">3</Parameter>
    <Parameter name="OpMode" dataType="byte">1</Parameter>
    <Parameter name="BOWType" dataType="byte">0</Parameter>
    <Parameter name="CellType" dataType="byte">8</Parameter>
    <Parameter name="TimedPercent" dataType="byte">15</Parameter>
    <Parameter name="SCTimeout" dataType="byte" unit="hour">1</Parameter>
    <Parameter name="ORPTimeout" dataType="byte" unit="hour">24</Parameter>
  </Parameters>
</Response>

This software is not produced, endorsed, or supported by Hayward Industries, Inc. “Hayward” and “OmniLogic” are trademarks of their respective owners.