Skip to content

GetUIRelayCmd ​

Status VerifiedOpcode22TypeRead

Reads whether a relay is on.

Parameters ​

nametypenotes
poolIdint
equipmentIdint

Reply ​

Opcode1022

UIRelayRsp

nametypeunit
poolIdint
relayIdint
isOnint

Example ​

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

Request XML ​

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

Response XML ​

xml
<?xml version="1.0" encoding="UTF-8" ?>
<Response xmlns="http://nextgen.hayward.com/api">
  <Name>UIRelayRsp</Name>
  <Parameters>
    <Parameter name="PoolID" dataType="int">1</Parameter>
    <Parameter name="RelayID" dataType="int">8</Parameter>
    <Parameter name="IsOn" dataType="int">0</Parameter>
  </Parameters>
</Response>

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