Skip to content

GetUIFilterStatus ​

Status VerifiedOpcode306TypeRead

Reads the filter pump's speed, state, why it is on, and valve position.

Parameters ​

nametypenotes
poolIdint
equipmentIdint

Reply ​

Opcode1306

GetUIFilterStatusRsp

nametypeunit
poolIdint
filterIdint
filterSpeedint
filterStateint
whyFilterIsOnint
valvePositionint

Example ​

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

Request XML ​

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

Response XML ​

xml
<?xml version="1.0" encoding="UTF-8" ?>
<Response xmlns="http://nextgen.hayward.com/api">
  <Name>GetUIFilterStatusRsp</Name>
  <Parameters>
    <Parameter name="PoolID" dataType="int">1</Parameter>
    <Parameter name="FilterID" dataType="int">3</Parameter>
    <Parameter name="FilterSpeed" dataType="int">58</Parameter>
    <Parameter name="FilterState" dataType="int">1</Parameter>
    <Parameter name="WhyFilterIsOn" dataType="int">170</Parameter>
    <Parameter name="ValvePosition" dataType="int">1</Parameter>
  </Parameters>
</Response>

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