SetUIRelayCmd

Status VerifiedOpcode21TypeWrite

NOTE

This command does nothing with isOn 1 unless a start and end time are given, and then runs the relay as a schedule without enforcing the end time. Use SetUIEquipmentCmd instead.

Turns a relay off, or runs it as a schedule over the given time window.

Parameters

name	type	notes
poolId	int
equipmentId	int
isOn	int
isCountDownTimer	byte
startTimeHours	byte
startTimeMinutes	byte
endTimeHours	byte
endTimeMinutes	byte
daysActive	byte
recurring	byte

Reply

Acknowledged only. The controller sends no reply.

Example

import { timerParams } from "@rygine/omnilogic-local-sdk";

await omni.command("SetUIRelayCmd", {
  poolId: 1,
  equipmentId: 1,
  isOn: 0,
  ...timerParams(),
});

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://nextgen.hayward.com/api">
  <Name>SetUIRelayCmd</Name>
  <Parameters>
    <Parameter name="poolId" dataType="int">1</Parameter>
    <Parameter name="equipmentId" dataType="int">1</Parameter>
    <Parameter name="isOn" dataType="int">0</Parameter>
    <Parameter name="isCountDownTimer" dataType="byte">0</Parameter>
    <Parameter name="startTimeHours" dataType="byte">0</Parameter>
    <Parameter name="startTimeMinutes" dataType="byte">0</Parameter>
    <Parameter name="endTimeHours" dataType="byte">0</Parameter>
    <Parameter name="endTimeMinutes" dataType="byte">0</Parameter>
    <Parameter name="daysActive" dataType="byte">0</Parameter>
    <Parameter name="recurring" dataType="byte">0</Parameter>
  </Parameters>
</Request>

Response XML

None.