OmniLogicLocal

Class: OmniLogic ​

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:119

Constructors ​

Constructor ​

new OmniLogic(options): OmniLogic

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:138

Parameters ​

options ​

OmniLogicOptions

Returns ​

OmniLogic

Accessors ​

backyard ​

Get Signature ​

get backyard(): Backyard

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:163

Returns ​

Backyard

config ​

Get Signature ​

get config(): MSPConfig

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:180

Returns ​

MSPConfig

configChecksum ​

Get Signature ​

get configChecksum(): number

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:167

Returns ​

number

inventory ​

Get Signature ​

get inventory(): Inventory

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:194

Returns ​

Inventory

mspVersion ​

Get Signature ​

get mspVersion(): string | undefined

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:171

Returns ​

string | undefined

telemetry ​

Get Signature ​

get telemetry(): Telemetry

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:187

Returns ​

Telemetry

telemetryDirty ​

Get Signature ​

get telemetryDirty(): boolean

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:176

Returns ​

boolean

timings ​

Get Signature ​

get timings(): Timings

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:159

Returns ​

Timings

Methods ​

command() ​

Call Signature ​

command<N>(name, params, options): Promise<string | undefined>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:231

Send a command to the controller

Type Parameters ​
N ​

N extends "SetUIPoolSpaSpilloverCmd" | "GetUIPoolSpaSpilloverCmd" | "SetUIPoolFilterCmd" | "SetUIFilterSpeedCmd" | "GetUIFilterSpeedCmd" | "SetUIHeaterCmd" | "GetUIHeaterCmd" | "SetUIHeaterPriorityCmd" | "GetUIHeaterPriorityCmd" | "SetUISuperCHLORCmd" | "GetUISuperCHLORCmd" | "SetUISuperCHLORTimeoutCmd" | "SetUIORPCHLORTimeoutCmd" | "SetUISuperCHLOROutputCmd" | "GetUISuperCHLOROutputCmd" | "SetUIRelayCmd" | "SetUIEquipmentCmd" | "GetUIRelayCmd" | "SetUIValveCmd" | "GetUIValveCmd" | "GetUIPoolTempCmd" | "GetUIAirTempCmd" | "GetUIFlowSensor" | "GetUISensor" | "GetUISolarTempCmd" | "UiSetManualLastSpeed" | "GetAutoTime" | "SetUISolarSetPointCmd" | "GetSetUISolarSetPointCmd" | "SetUIHeaterModeCmd" | "GetUIHeaterModeCmd" | "SetHeaterAutoDifferential" | "GetHeaterAutoDifferential" | "GetHeaterDiagnostic" | "GetHeaterPowerUsage" | "GetHeaterSensor" | "SetHeaterSilentMode" | "GetHeaterSilentMode" | "SetUISmartValveCmd" | "GetUISmartValveCmd" | "SetUISmartValveTargetCmd" | "SetUISmartValveForTheme" | "GetFlowControlPortStatus" | "GetFlowControlPortConfig" | "GetFlowControlDiagnostic" | "GetFlowControlPortErrors" | "FlowControlHomePortsCmd" | "SetUIFlowControlForTheme" | "SetTime2" | "SetDateTime" | "GetDateTime" | "SetDate" | "GetDate" | "SetTime" | "GetTime" | "SetBackLight" | "GetBackLight" | "SetBackLightBrightness" | "GetBackLightBrightness" | "SetBackLightTimeout" | "GetBackLightTimeout" | "SetBeeper" | "GetBeeper" | "SetTimeFormat" | "GetTimeFormat" | "SetUnits" | "GetUnits" | "SetVSPSpeedFormat" | "GetVSPSpeedFormat" | "SetCHLOREnable" | "GetCHLOREnable" | "SetCHLORDisplay" | "GetCHLORDisplay" | "SetSpaSpilloverEnable" | "GetSpaSpilloverEnable" | "SetFilterOperation" | "GetFilterOperation" | "SetFilterOffValveChg" | "GetFilterOffValveChg" | "SetFilterLowSpeed" | "GetFilterLowSpeed" | "SetFilterHighSpeed" | "GetFilterHighSpeed" | "SetFreezeProtect" | "GetFreezeProtect" | "SetFreezeProtectSpeed" | "GetFreezeProtectSpeed" | "SetFreezeProtectTemp" | "GetFreezeProtectTemp" | "SetFlowMonitor" | "GetFlowMonitor" | "SetExternalInterLock" | "GetExternalInterLock" | "SetHeaterEnable" | "GetHeaterEnable" | "SetHeaterCoolDown" | "GetHeaterCoolDown" | "SetHeaterExtend" | "GetHeaterExtend" | "SetHeaterAllowedLowSpeed" | "GetHeaterAllowedLowSpeed" | "SetCHLORParams" | "GetCHLORParams" | "GetCHLORStatus" | "GetCHLORAlert" | "GetCHLORError" | "CHLORSaltCalcRestart" | "CHLORRelayPolarityReverse" | "CHLORCellRuntimeRestart" | "GetCHLORMeasurement" | "GetScVersionCmd" | "SetScLedCmd" | "SetCHLORTimePercent" | "GetCHLORRelayPolarity" | "GetUICLLightStatus" | "GetUICLIMStatus" | "SetCLSerialIdentifyStart" | "SetUICLSerialIdentifyStop" | "GetUICLIMAuthenticate" | "SetUICLIMUnlock" | "GetNetworkedLightStatus" | "SetUICLLightNumAssignSeqStandard" | "SetUICLLightNumAssignSeqCustom" | "SetUICLLightNumAssignSeqStationary" | "SetUICLLightNumUnassignAux" | "SetUICLLightNumIdentifyStart" | "SetUICLLightNumIdentifyStop" | "SetUICLAuxLightOnOff" | "SetUICLAuxUpdateSettingStationary" | "SetUICLAuxUpdateSettingStandard" | "SetUICLAuxUpdateSettingCustom" | "SetUICLAuxUpdateBrightness" | "SetUICLAuxRelease" | "SetUICLAllFindLightsStart" | "SetUICLAllFindLightsStop" | "GetUICLAllFindLightsReport" | "SetUICLAllResetToDefaults" | "SetUICLAllOnWhite" | "SetLightMode" | "IDV2Light" | "SetV2Mode" | "SetLightModeByRelay" | "SetV2ModeByRelay" | "CreateUIScheduleAltCmd" | "CreateUIScheduleCmd" | "DeleteUIScheduleCmd" | "SetUIScheduleEnableCmd" | "EditUIScheduleCmd" | "EditUIScheduleAltCmd" | "UIGetCSADForcedOnTimeout" | "UISetCSADForcedOnTimeout" | "UIGetCSADAutoTimeout" | "UISetCSADAutoTimeout" | "UIGetCSADStatus" | "UIGetCSADRevision" | "UIGetCSADTargetValue" | "UISetCSADTargetValue" | "UIGetCSADPHAlarmLevel" | "UISetCSADPHAlarmLevel" | "UIGetCSADEnabled" | "UISetCSADEnabled" | "UIGetCSADExtendEnabled" | "UISetCSADExtendEnabled" | "UIGetCSADType" | "UISetCSADType" | "UIGetCSADMode" | "UISetCSADMode" | "SetUISystemStateCmd" | "GetUISuperCHLORTimeRemaining" | "UIGetCSADCalibrationValue" | "UISetCSADCalibrationValue" | "GetUISystemStateCmd" | "SetUICHLOROperatingMode" | "GetUICHLOROperatingMode" | "SetUICSADORPTargetLevel" | "GetUICSADORPTargetLevel" | "SetUICSADORPAlarmLevel" | "GetUICSADORPAlarmLevel" | "SetUIMultiHeaterPriorityCmd" | "SetChlorinatorScheduleCmd" | "RestoreChlorinatorPercentCmd" | "ClearUIAlarmCmd" | "GetUIFilterStatus" | "GetUIHeaterStatus" | "SetStandAloneLightShow" | "ResetStandAloneLight" | "GetStandAloneLightShow" | "SetUISpilloverCmd" | "GetUIPumpStatus" | "SetHeaterScheduleAltCmd" | "SetHeaterScheduleCmd" | "RestoreHeaterSetPointCmd" | "RunGroupCmd" | "SaveNewGroupCmd" | "SaveExistingGroupCmd" | "DeleteGroupCmd" | "SetGroupCmd" | "TurnOnOffForGroup" | "CreateUIFavoriteAltCmd" | "CreateUIFavoriteCmd" | "DeleteUIFavoriteCmd" | "ModifyUIFavoriteCmd" | "UpdateButtonOnTerm" | "GetRemainingCountdownTime" | "GetRemainingSCTime" | "UiEditConfigObjectName" | "UiGetConfigObjectName" | "SetSolarScheduleCmd" | "RestoreSolarSetPointCmd" | "RestoreIdleState" | "SetDemandResponseCmd" | "SetPrimingDuration" | "GetPrimingDuration" | "SetCooldownDuration" | "GetCooldownDuration" | "SetSharedFilterTimeout" | "GetSharedFilterTimeout" | "SetHeaterAllowLowSpeed" | "GetHeaterAllowLowSpeed" | "SetHeaterLowSpeed" | "GetHeaterLowSpeed" | "SetUITestModeEnter" | "SetUIDisplayModeState" | "GetUIDisplayModeState" | "SetUIPumpSpeed" | "GetUIPumpSpeed" | "SetUIFreezeProtectOverride" | "GetUIFreezeProtectOverride" | "SetUIFreezeProtectOverrideInterval" | "GetUIFreezeProtectOverrideInterval" | "GetUIFilterDiagnosticInfo" | "SetUITemporaryHeaterEnable" | "SetUITemporaryHeaterPriorityCmd" | "SetUITemporaryHeaterMaintainPriorityCmd" | "SetCoordinates" | "GetCoordinates" | "Unknown1414"

Parameters ​
name ​

N

params ​

CommandParams<N> | undefined

options ​

CommandOptions & object

Returns ​

Promise<string | undefined>

Call Signature ​

command<N>(name, ...rest): Promise<CommandResult<N>>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:236

Send a command to the controller

Type Parameters ​
N ​

N extends "SetUIPoolSpaSpilloverCmd" | "GetUIPoolSpaSpilloverCmd" | "SetUIPoolFilterCmd" | "SetUIFilterSpeedCmd" | "GetUIFilterSpeedCmd" | "SetUIHeaterCmd" | "GetUIHeaterCmd" | "SetUIHeaterPriorityCmd" | "GetUIHeaterPriorityCmd" | "SetUISuperCHLORCmd" | "GetUISuperCHLORCmd" | "SetUISuperCHLORTimeoutCmd" | "SetUIORPCHLORTimeoutCmd" | "SetUISuperCHLOROutputCmd" | "GetUISuperCHLOROutputCmd" | "SetUIRelayCmd" | "SetUIEquipmentCmd" | "GetUIRelayCmd" | "SetUIValveCmd" | "GetUIValveCmd" | "GetUIPoolTempCmd" | "GetUIAirTempCmd" | "GetUIFlowSensor" | "GetUISensor" | "GetUISolarTempCmd" | "UiSetManualLastSpeed" | "GetAutoTime" | "SetUISolarSetPointCmd" | "GetSetUISolarSetPointCmd" | "SetUIHeaterModeCmd" | "GetUIHeaterModeCmd" | "SetHeaterAutoDifferential" | "GetHeaterAutoDifferential" | "GetHeaterDiagnostic" | "GetHeaterPowerUsage" | "GetHeaterSensor" | "SetHeaterSilentMode" | "GetHeaterSilentMode" | "SetUISmartValveCmd" | "GetUISmartValveCmd" | "SetUISmartValveTargetCmd" | "SetUISmartValveForTheme" | "GetFlowControlPortStatus" | "GetFlowControlPortConfig" | "GetFlowControlDiagnostic" | "GetFlowControlPortErrors" | "FlowControlHomePortsCmd" | "SetUIFlowControlForTheme" | "SetTime2" | "SetDateTime" | "GetDateTime" | "SetDate" | "GetDate" | "SetTime" | "GetTime" | "SetBackLight" | "GetBackLight" | "SetBackLightBrightness" | "GetBackLightBrightness" | "SetBackLightTimeout" | "GetBackLightTimeout" | "SetBeeper" | "GetBeeper" | "SetTimeFormat" | "GetTimeFormat" | "SetUnits" | "GetUnits" | "SetVSPSpeedFormat" | "GetVSPSpeedFormat" | "SetCHLOREnable" | "GetCHLOREnable" | "SetCHLORDisplay" | "GetCHLORDisplay" | "SetSpaSpilloverEnable" | "GetSpaSpilloverEnable" | "SetFilterOperation" | "GetFilterOperation" | "SetFilterOffValveChg" | "GetFilterOffValveChg" | "SetFilterLowSpeed" | "GetFilterLowSpeed" | "SetFilterHighSpeed" | "GetFilterHighSpeed" | "SetFreezeProtect" | "GetFreezeProtect" | "SetFreezeProtectSpeed" | "GetFreezeProtectSpeed" | "SetFreezeProtectTemp" | "GetFreezeProtectTemp" | "SetFlowMonitor" | "GetFlowMonitor" | "SetExternalInterLock" | "GetExternalInterLock" | "SetHeaterEnable" | "GetHeaterEnable" | "SetHeaterCoolDown" | "GetHeaterCoolDown" | "SetHeaterExtend" | "GetHeaterExtend" | "SetHeaterAllowedLowSpeed" | "GetHeaterAllowedLowSpeed" | "SetCHLORParams" | "GetCHLORParams" | "GetCHLORStatus" | "GetCHLORAlert" | "GetCHLORError" | "CHLORSaltCalcRestart" | "CHLORRelayPolarityReverse" | "CHLORCellRuntimeRestart" | "GetCHLORMeasurement" | "GetScVersionCmd" | "SetScLedCmd" | "SetCHLORTimePercent" | "GetCHLORRelayPolarity" | "GetUICLLightStatus" | "GetUICLIMStatus" | "SetCLSerialIdentifyStart" | "SetUICLSerialIdentifyStop" | "GetUICLIMAuthenticate" | "SetUICLIMUnlock" | "GetNetworkedLightStatus" | "SetUICLLightNumAssignSeqStandard" | "SetUICLLightNumAssignSeqCustom" | "SetUICLLightNumAssignSeqStationary" | "SetUICLLightNumUnassignAux" | "SetUICLLightNumIdentifyStart" | "SetUICLLightNumIdentifyStop" | "SetUICLAuxLightOnOff" | "SetUICLAuxUpdateSettingStationary" | "SetUICLAuxUpdateSettingStandard" | "SetUICLAuxUpdateSettingCustom" | "SetUICLAuxUpdateBrightness" | "SetUICLAuxRelease" | "SetUICLAllFindLightsStart" | "SetUICLAllFindLightsStop" | "GetUICLAllFindLightsReport" | "SetUICLAllResetToDefaults" | "SetUICLAllOnWhite" | "SetLightMode" | "IDV2Light" | "SetV2Mode" | "SetLightModeByRelay" | "SetV2ModeByRelay" | "CreateUIScheduleAltCmd" | "CreateUIScheduleCmd" | "DeleteUIScheduleCmd" | "SetUIScheduleEnableCmd" | "EditUIScheduleCmd" | "EditUIScheduleAltCmd" | "UIGetCSADForcedOnTimeout" | "UISetCSADForcedOnTimeout" | "UIGetCSADAutoTimeout" | "UISetCSADAutoTimeout" | "UIGetCSADStatus" | "UIGetCSADRevision" | "UIGetCSADTargetValue" | "UISetCSADTargetValue" | "UIGetCSADPHAlarmLevel" | "UISetCSADPHAlarmLevel" | "UIGetCSADEnabled" | "UISetCSADEnabled" | "UIGetCSADExtendEnabled" | "UISetCSADExtendEnabled" | "UIGetCSADType" | "UISetCSADType" | "UIGetCSADMode" | "UISetCSADMode" | "SetUISystemStateCmd" | "GetUISuperCHLORTimeRemaining" | "UIGetCSADCalibrationValue" | "UISetCSADCalibrationValue" | "GetUISystemStateCmd" | "SetUICHLOROperatingMode" | "GetUICHLOROperatingMode" | "SetUICSADORPTargetLevel" | "GetUICSADORPTargetLevel" | "SetUICSADORPAlarmLevel" | "GetUICSADORPAlarmLevel" | "SetUIMultiHeaterPriorityCmd" | "SetChlorinatorScheduleCmd" | "RestoreChlorinatorPercentCmd" | "ClearUIAlarmCmd" | "GetUIFilterStatus" | "GetUIHeaterStatus" | "SetStandAloneLightShow" | "ResetStandAloneLight" | "GetStandAloneLightShow" | "SetUISpilloverCmd" | "GetUIPumpStatus" | "SetHeaterScheduleAltCmd" | "SetHeaterScheduleCmd" | "RestoreHeaterSetPointCmd" | "RunGroupCmd" | "SaveNewGroupCmd" | "SaveExistingGroupCmd" | "DeleteGroupCmd" | "SetGroupCmd" | "TurnOnOffForGroup" | "CreateUIFavoriteAltCmd" | "CreateUIFavoriteCmd" | "DeleteUIFavoriteCmd" | "ModifyUIFavoriteCmd" | "UpdateButtonOnTerm" | "GetRemainingCountdownTime" | "GetRemainingSCTime" | "UiEditConfigObjectName" | "UiGetConfigObjectName" | "SetSolarScheduleCmd" | "RestoreSolarSetPointCmd" | "RestoreIdleState" | "SetDemandResponseCmd" | "SetPrimingDuration" | "GetPrimingDuration" | "SetCooldownDuration" | "GetCooldownDuration" | "SetSharedFilterTimeout" | "GetSharedFilterTimeout" | "SetHeaterAllowLowSpeed" | "GetHeaterAllowLowSpeed" | "SetHeaterLowSpeed" | "GetHeaterLowSpeed" | "SetUITestModeEnter" | "SetUIDisplayModeState" | "GetUIDisplayModeState" | "SetUIPumpSpeed" | "GetUIPumpSpeed" | "SetUIFreezeProtectOverride" | "GetUIFreezeProtectOverride" | "SetUIFreezeProtectOverrideInterval" | "GetUIFreezeProtectOverrideInterval" | "GetUIFilterDiagnosticInfo" | "SetUITemporaryHeaterEnable" | "SetUITemporaryHeaterPriorityCmd" | "SetUITemporaryHeaterMaintainPriorityCmd" | "SetCoordinates" | "GetCoordinates" | "Unknown1414"

Parameters ​
name ​

N

rest ​

...CommandParams<N> extends Record<string, never> ? [CommandParams, CommandOptions] : [CommandParams<N>, CommandOptions]

Returns ​

Promise<CommandResult<N>>

Call Signature ​

command<N>(name, params, options?): Promise<CommandResult<N>>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:242

Send a command to the controller

Type Parameters ​
N ​

N extends "SetUIPoolSpaSpilloverCmd" | "GetUIPoolSpaSpilloverCmd" | "SetUIPoolFilterCmd" | "SetUIFilterSpeedCmd" | "GetUIFilterSpeedCmd" | "SetUIHeaterCmd" | "GetUIHeaterCmd" | "SetUIHeaterPriorityCmd" | "GetUIHeaterPriorityCmd" | "SetUISuperCHLORCmd" | "GetUISuperCHLORCmd" | "SetUISuperCHLORTimeoutCmd" | "SetUIORPCHLORTimeoutCmd" | "SetUISuperCHLOROutputCmd" | "GetUISuperCHLOROutputCmd" | "SetUIRelayCmd" | "SetUIEquipmentCmd" | "GetUIRelayCmd" | "SetUIValveCmd" | "GetUIValveCmd" | "GetUIPoolTempCmd" | "GetUIAirTempCmd" | "GetUIFlowSensor" | "GetUISensor" | "GetUISolarTempCmd" | "UiSetManualLastSpeed" | "GetAutoTime" | "SetUISolarSetPointCmd" | "GetSetUISolarSetPointCmd" | "SetUIHeaterModeCmd" | "GetUIHeaterModeCmd" | "SetHeaterAutoDifferential" | "GetHeaterAutoDifferential" | "GetHeaterDiagnostic" | "GetHeaterPowerUsage" | "GetHeaterSensor" | "SetHeaterSilentMode" | "GetHeaterSilentMode" | "SetUISmartValveCmd" | "GetUISmartValveCmd" | "SetUISmartValveTargetCmd" | "SetUISmartValveForTheme" | "GetFlowControlPortStatus" | "GetFlowControlPortConfig" | "GetFlowControlDiagnostic" | "GetFlowControlPortErrors" | "FlowControlHomePortsCmd" | "SetUIFlowControlForTheme" | "SetTime2" | "SetDateTime" | "GetDateTime" | "SetDate" | "GetDate" | "SetTime" | "GetTime" | "SetBackLight" | "GetBackLight" | "SetBackLightBrightness" | "GetBackLightBrightness" | "SetBackLightTimeout" | "GetBackLightTimeout" | "SetBeeper" | "GetBeeper" | "SetTimeFormat" | "GetTimeFormat" | "SetUnits" | "GetUnits" | "SetVSPSpeedFormat" | "GetVSPSpeedFormat" | "SetCHLOREnable" | "GetCHLOREnable" | "SetCHLORDisplay" | "GetCHLORDisplay" | "SetSpaSpilloverEnable" | "GetSpaSpilloverEnable" | "SetFilterOperation" | "GetFilterOperation" | "SetFilterOffValveChg" | "GetFilterOffValveChg" | "SetFilterLowSpeed" | "GetFilterLowSpeed" | "SetFilterHighSpeed" | "GetFilterHighSpeed" | "SetFreezeProtect" | "GetFreezeProtect" | "SetFreezeProtectSpeed" | "GetFreezeProtectSpeed" | "SetFreezeProtectTemp" | "GetFreezeProtectTemp" | "SetFlowMonitor" | "GetFlowMonitor" | "SetExternalInterLock" | "GetExternalInterLock" | "SetHeaterEnable" | "GetHeaterEnable" | "SetHeaterCoolDown" | "GetHeaterCoolDown" | "SetHeaterExtend" | "GetHeaterExtend" | "SetHeaterAllowedLowSpeed" | "GetHeaterAllowedLowSpeed" | "SetCHLORParams" | "GetCHLORParams" | "GetCHLORStatus" | "GetCHLORAlert" | "GetCHLORError" | "CHLORSaltCalcRestart" | "CHLORRelayPolarityReverse" | "CHLORCellRuntimeRestart" | "GetCHLORMeasurement" | "GetScVersionCmd" | "SetScLedCmd" | "SetCHLORTimePercent" | "GetCHLORRelayPolarity" | "GetUICLLightStatus" | "GetUICLIMStatus" | "SetCLSerialIdentifyStart" | "SetUICLSerialIdentifyStop" | "GetUICLIMAuthenticate" | "SetUICLIMUnlock" | "GetNetworkedLightStatus" | "SetUICLLightNumAssignSeqStandard" | "SetUICLLightNumAssignSeqCustom" | "SetUICLLightNumAssignSeqStationary" | "SetUICLLightNumUnassignAux" | "SetUICLLightNumIdentifyStart" | "SetUICLLightNumIdentifyStop" | "SetUICLAuxLightOnOff" | "SetUICLAuxUpdateSettingStationary" | "SetUICLAuxUpdateSettingStandard" | "SetUICLAuxUpdateSettingCustom" | "SetUICLAuxUpdateBrightness" | "SetUICLAuxRelease" | "SetUICLAllFindLightsStart" | "SetUICLAllFindLightsStop" | "GetUICLAllFindLightsReport" | "SetUICLAllResetToDefaults" | "SetUICLAllOnWhite" | "SetLightMode" | "IDV2Light" | "SetV2Mode" | "SetLightModeByRelay" | "SetV2ModeByRelay" | "CreateUIScheduleAltCmd" | "CreateUIScheduleCmd" | "DeleteUIScheduleCmd" | "SetUIScheduleEnableCmd" | "EditUIScheduleCmd" | "EditUIScheduleAltCmd" | "UIGetCSADForcedOnTimeout" | "UISetCSADForcedOnTimeout" | "UIGetCSADAutoTimeout" | "UISetCSADAutoTimeout" | "UIGetCSADStatus" | "UIGetCSADRevision" | "UIGetCSADTargetValue" | "UISetCSADTargetValue" | "UIGetCSADPHAlarmLevel" | "UISetCSADPHAlarmLevel" | "UIGetCSADEnabled" | "UISetCSADEnabled" | "UIGetCSADExtendEnabled" | "UISetCSADExtendEnabled" | "UIGetCSADType" | "UISetCSADType" | "UIGetCSADMode" | "UISetCSADMode" | "SetUISystemStateCmd" | "GetUISuperCHLORTimeRemaining" | "UIGetCSADCalibrationValue" | "UISetCSADCalibrationValue" | "GetUISystemStateCmd" | "SetUICHLOROperatingMode" | "GetUICHLOROperatingMode" | "SetUICSADORPTargetLevel" | "GetUICSADORPTargetLevel" | "SetUICSADORPAlarmLevel" | "GetUICSADORPAlarmLevel" | "SetUIMultiHeaterPriorityCmd" | "SetChlorinatorScheduleCmd" | "RestoreChlorinatorPercentCmd" | "ClearUIAlarmCmd" | "GetUIFilterStatus" | "GetUIHeaterStatus" | "SetStandAloneLightShow" | "ResetStandAloneLight" | "GetStandAloneLightShow" | "SetUISpilloverCmd" | "GetUIPumpStatus" | "SetHeaterScheduleAltCmd" | "SetHeaterScheduleCmd" | "RestoreHeaterSetPointCmd" | "RunGroupCmd" | "SaveNewGroupCmd" | "SaveExistingGroupCmd" | "DeleteGroupCmd" | "SetGroupCmd" | "TurnOnOffForGroup" | "CreateUIFavoriteAltCmd" | "CreateUIFavoriteCmd" | "DeleteUIFavoriteCmd" | "ModifyUIFavoriteCmd" | "UpdateButtonOnTerm" | "GetRemainingCountdownTime" | "GetRemainingSCTime" | "UiEditConfigObjectName" | "UiGetConfigObjectName" | "SetSolarScheduleCmd" | "RestoreSolarSetPointCmd" | "RestoreIdleState" | "SetDemandResponseCmd" | "SetPrimingDuration" | "GetPrimingDuration" | "SetCooldownDuration" | "GetCooldownDuration" | "SetSharedFilterTimeout" | "GetSharedFilterTimeout" | "SetHeaterAllowLowSpeed" | "GetHeaterAllowLowSpeed" | "SetHeaterLowSpeed" | "GetHeaterLowSpeed" | "SetUITestModeEnter" | "SetUIDisplayModeState" | "GetUIDisplayModeState" | "SetUIPumpSpeed" | "GetUIPumpSpeed" | "SetUIFreezeProtectOverride" | "GetUIFreezeProtectOverride" | "SetUIFreezeProtectOverrideInterval" | "GetUIFreezeProtectOverrideInterval" | "GetUIFilterDiagnosticInfo" | "SetUITemporaryHeaterEnable" | "SetUITemporaryHeaterPriorityCmd" | "SetUITemporaryHeaterMaintainPriorityCmd" | "SetCoordinates" | "GetCoordinates" | "Unknown1414"

Parameters ​
name ​

N

params ​

CommandParams<N>

options? ​

CommandOptions

Returns ​

Promise<CommandResult<N>>

Call Signature ​

command<N>(name, params, options): Promise<string | undefined>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:247

Send a command to the controller

Type Parameters ​
N ​

N extends "SetUIPoolSpaSpilloverCmd" | "GetUIPoolSpaSpilloverCmd" | "SetUIPoolFilterCmd" | "SetUIFilterSpeedCmd" | "GetUIFilterSpeedCmd" | "SetUIHeaterCmd" | "GetUIHeaterCmd" | "SetUIHeaterPriorityCmd" | "GetUIHeaterPriorityCmd" | "SetUISuperCHLORCmd" | "GetUISuperCHLORCmd" | "SetUISuperCHLORTimeoutCmd" | "SetUIORPCHLORTimeoutCmd" | "SetUISuperCHLOROutputCmd" | "GetUISuperCHLOROutputCmd" | "SetUIRelayCmd" | "SetUIEquipmentCmd" | "GetUIRelayCmd" | "SetUIValveCmd" | "GetUIValveCmd" | "GetUIPoolTempCmd" | "GetUIAirTempCmd" | "GetUIFlowSensor" | "GetUISensor" | "GetUISolarTempCmd" | "UiSetManualLastSpeed" | "GetAutoTime" | "SetUISolarSetPointCmd" | "GetSetUISolarSetPointCmd" | "SetUIHeaterModeCmd" | "GetUIHeaterModeCmd" | "SetHeaterAutoDifferential" | "GetHeaterAutoDifferential" | "GetHeaterDiagnostic" | "GetHeaterPowerUsage" | "GetHeaterSensor" | "SetHeaterSilentMode" | "GetHeaterSilentMode" | "SetUISmartValveCmd" | "GetUISmartValveCmd" | "SetUISmartValveTargetCmd" | "SetUISmartValveForTheme" | "GetFlowControlPortStatus" | "GetFlowControlPortConfig" | "GetFlowControlDiagnostic" | "GetFlowControlPortErrors" | "FlowControlHomePortsCmd" | "SetUIFlowControlForTheme" | "SetTime2" | "SetDateTime" | "GetDateTime" | "SetDate" | "GetDate" | "SetTime" | "GetTime" | "SetBackLight" | "GetBackLight" | "SetBackLightBrightness" | "GetBackLightBrightness" | "SetBackLightTimeout" | "GetBackLightTimeout" | "SetBeeper" | "GetBeeper" | "SetTimeFormat" | "GetTimeFormat" | "SetUnits" | "GetUnits" | "SetVSPSpeedFormat" | "GetVSPSpeedFormat" | "SetCHLOREnable" | "GetCHLOREnable" | "SetCHLORDisplay" | "GetCHLORDisplay" | "SetSpaSpilloverEnable" | "GetSpaSpilloverEnable" | "SetFilterOperation" | "GetFilterOperation" | "SetFilterOffValveChg" | "GetFilterOffValveChg" | "SetFilterLowSpeed" | "GetFilterLowSpeed" | "SetFilterHighSpeed" | "GetFilterHighSpeed" | "SetFreezeProtect" | "GetFreezeProtect" | "SetFreezeProtectSpeed" | "GetFreezeProtectSpeed" | "SetFreezeProtectTemp" | "GetFreezeProtectTemp" | "SetFlowMonitor" | "GetFlowMonitor" | "SetExternalInterLock" | "GetExternalInterLock" | "SetHeaterEnable" | "GetHeaterEnable" | "SetHeaterCoolDown" | "GetHeaterCoolDown" | "SetHeaterExtend" | "GetHeaterExtend" | "SetHeaterAllowedLowSpeed" | "GetHeaterAllowedLowSpeed" | "SetCHLORParams" | "GetCHLORParams" | "GetCHLORStatus" | "GetCHLORAlert" | "GetCHLORError" | "CHLORSaltCalcRestart" | "CHLORRelayPolarityReverse" | "CHLORCellRuntimeRestart" | "GetCHLORMeasurement" | "GetScVersionCmd" | "SetScLedCmd" | "SetCHLORTimePercent" | "GetCHLORRelayPolarity" | "GetUICLLightStatus" | "GetUICLIMStatus" | "SetCLSerialIdentifyStart" | "SetUICLSerialIdentifyStop" | "GetUICLIMAuthenticate" | "SetUICLIMUnlock" | "GetNetworkedLightStatus" | "SetUICLLightNumAssignSeqStandard" | "SetUICLLightNumAssignSeqCustom" | "SetUICLLightNumAssignSeqStationary" | "SetUICLLightNumUnassignAux" | "SetUICLLightNumIdentifyStart" | "SetUICLLightNumIdentifyStop" | "SetUICLAuxLightOnOff" | "SetUICLAuxUpdateSettingStationary" | "SetUICLAuxUpdateSettingStandard" | "SetUICLAuxUpdateSettingCustom" | "SetUICLAuxUpdateBrightness" | "SetUICLAuxRelease" | "SetUICLAllFindLightsStart" | "SetUICLAllFindLightsStop" | "GetUICLAllFindLightsReport" | "SetUICLAllResetToDefaults" | "SetUICLAllOnWhite" | "SetLightMode" | "IDV2Light" | "SetV2Mode" | "SetLightModeByRelay" | "SetV2ModeByRelay" | "CreateUIScheduleAltCmd" | "CreateUIScheduleCmd" | "DeleteUIScheduleCmd" | "SetUIScheduleEnableCmd" | "EditUIScheduleCmd" | "EditUIScheduleAltCmd" | "UIGetCSADForcedOnTimeout" | "UISetCSADForcedOnTimeout" | "UIGetCSADAutoTimeout" | "UISetCSADAutoTimeout" | "UIGetCSADStatus" | "UIGetCSADRevision" | "UIGetCSADTargetValue" | "UISetCSADTargetValue" | "UIGetCSADPHAlarmLevel" | "UISetCSADPHAlarmLevel" | "UIGetCSADEnabled" | "UISetCSADEnabled" | "UIGetCSADExtendEnabled" | "UISetCSADExtendEnabled" | "UIGetCSADType" | "UISetCSADType" | "UIGetCSADMode" | "UISetCSADMode" | "SetUISystemStateCmd" | "GetUISuperCHLORTimeRemaining" | "UIGetCSADCalibrationValue" | "UISetCSADCalibrationValue" | "GetUISystemStateCmd" | "SetUICHLOROperatingMode" | "GetUICHLOROperatingMode" | "SetUICSADORPTargetLevel" | "GetUICSADORPTargetLevel" | "SetUICSADORPAlarmLevel" | "GetUICSADORPAlarmLevel" | "SetUIMultiHeaterPriorityCmd" | "SetChlorinatorScheduleCmd" | "RestoreChlorinatorPercentCmd" | "ClearUIAlarmCmd" | "GetUIFilterStatus" | "GetUIHeaterStatus" | "SetStandAloneLightShow" | "ResetStandAloneLight" | "GetStandAloneLightShow" | "SetUISpilloverCmd" | "GetUIPumpStatus" | "SetHeaterScheduleAltCmd" | "SetHeaterScheduleCmd" | "RestoreHeaterSetPointCmd" | "RunGroupCmd" | "SaveNewGroupCmd" | "SaveExistingGroupCmd" | "DeleteGroupCmd" | "SetGroupCmd" | "TurnOnOffForGroup" | "CreateUIFavoriteAltCmd" | "CreateUIFavoriteCmd" | "DeleteUIFavoriteCmd" | "ModifyUIFavoriteCmd" | "UpdateButtonOnTerm" | "GetRemainingCountdownTime" | "GetRemainingSCTime" | "UiEditConfigObjectName" | "UiGetConfigObjectName" | "SetSolarScheduleCmd" | "RestoreSolarSetPointCmd" | "RestoreIdleState" | "SetDemandResponseCmd" | "SetPrimingDuration" | "GetPrimingDuration" | "SetCooldownDuration" | "GetCooldownDuration" | "SetSharedFilterTimeout" | "GetSharedFilterTimeout" | "SetHeaterAllowLowSpeed" | "GetHeaterAllowLowSpeed" | "SetHeaterLowSpeed" | "GetHeaterLowSpeed" | "SetUITestModeEnter" | "SetUIDisplayModeState" | "GetUIDisplayModeState" | "SetUIPumpSpeed" | "GetUIPumpSpeed" | "SetUIFreezeProtectOverride" | "GetUIFreezeProtectOverride" | "SetUIFreezeProtectOverrideInterval" | "GetUIFreezeProtectOverrideInterval" | "GetUIFilterDiagnosticInfo" | "SetUITemporaryHeaterEnable" | "SetUITemporaryHeaterPriorityCmd" | "SetUITemporaryHeaterMaintainPriorityCmd" | "SetCoordinates" | "GetCoordinates" | "Unknown1414"

Parameters ​
name ​

"SetUIPoolSpaSpilloverCmd" | "GetUIPoolSpaSpilloverCmd" | "SetUIPoolFilterCmd" | "SetUIFilterSpeedCmd" | "GetUIFilterSpeedCmd" | "SetUIHeaterCmd" | "GetUIHeaterCmd" | "SetUIHeaterPriorityCmd" | "GetUIHeaterPriorityCmd" | "SetUISuperCHLORCmd" | "GetUISuperCHLORCmd" | "SetUISuperCHLORTimeoutCmd" | "SetUIORPCHLORTimeoutCmd" | "SetUISuperCHLOROutputCmd" | "GetUISuperCHLOROutputCmd" | "SetUIRelayCmd" | "SetUIEquipmentCmd" | "GetUIRelayCmd" | "SetUIValveCmd" | "GetUIValveCmd" | "GetUIPoolTempCmd" | "GetUIAirTempCmd" | "GetUIFlowSensor" | "GetUISensor" | "GetUISolarTempCmd" | "UiSetManualLastSpeed" | "GetAutoTime" | "SetUISolarSetPointCmd" | "GetSetUISolarSetPointCmd" | "SetUIHeaterModeCmd" | "GetUIHeaterModeCmd" | "SetHeaterAutoDifferential" | "GetHeaterAutoDifferential" | "GetHeaterDiagnostic" | "GetHeaterPowerUsage" | "GetHeaterSensor" | "SetHeaterSilentMode" | "GetHeaterSilentMode" | "SetUISmartValveCmd" | "GetUISmartValveCmd" | "SetUISmartValveTargetCmd" | "SetUISmartValveForTheme" | "GetFlowControlPortStatus" | "GetFlowControlPortConfig" | "GetFlowControlDiagnostic" | "GetFlowControlPortErrors" | "FlowControlHomePortsCmd" | "SetUIFlowControlForTheme" | "SetTime2" | "SetDateTime" | "GetDateTime" | "SetDate" | "GetDate" | "SetTime" | "GetTime" | "SetBackLight" | "GetBackLight" | "SetBackLightBrightness" | "GetBackLightBrightness" | "SetBackLightTimeout" | "GetBackLightTimeout" | "SetBeeper" | "GetBeeper" | "SetTimeFormat" | "GetTimeFormat" | "SetUnits" | "GetUnits" | "SetVSPSpeedFormat" | "GetVSPSpeedFormat" | "SetCHLOREnable" | "GetCHLOREnable" | "SetCHLORDisplay" | "GetCHLORDisplay" | "SetSpaSpilloverEnable" | "GetSpaSpilloverEnable" | "SetFilterOperation" | "GetFilterOperation" | "SetFilterOffValveChg" | "GetFilterOffValveChg" | "SetFilterLowSpeed" | "GetFilterLowSpeed" | "SetFilterHighSpeed" | "GetFilterHighSpeed" | "SetFreezeProtect" | "GetFreezeProtect" | "SetFreezeProtectSpeed" | "GetFreezeProtectSpeed" | "SetFreezeProtectTemp" | "GetFreezeProtectTemp" | "SetFlowMonitor" | "GetFlowMonitor" | "SetExternalInterLock" | "GetExternalInterLock" | "SetHeaterEnable" | "GetHeaterEnable" | "SetHeaterCoolDown" | "GetHeaterCoolDown" | "SetHeaterExtend" | "GetHeaterExtend" | "SetHeaterAllowedLowSpeed" | "GetHeaterAllowedLowSpeed" | "SetCHLORParams" | "GetCHLORParams" | "GetCHLORStatus" | "GetCHLORAlert" | "GetCHLORError" | "CHLORSaltCalcRestart" | "CHLORRelayPolarityReverse" | "CHLORCellRuntimeRestart" | "GetCHLORMeasurement" | "GetScVersionCmd" | "SetScLedCmd" | "SetCHLORTimePercent" | "GetCHLORRelayPolarity" | "GetUICLLightStatus" | "GetUICLIMStatus" | "SetCLSerialIdentifyStart" | "SetUICLSerialIdentifyStop" | "GetUICLIMAuthenticate" | "SetUICLIMUnlock" | "GetNetworkedLightStatus" | "SetUICLLightNumAssignSeqStandard" | "SetUICLLightNumAssignSeqCustom" | "SetUICLLightNumAssignSeqStationary" | "SetUICLLightNumUnassignAux" | "SetUICLLightNumIdentifyStart" | "SetUICLLightNumIdentifyStop" | "SetUICLAuxLightOnOff" | "SetUICLAuxUpdateSettingStationary" | "SetUICLAuxUpdateSettingStandard" | "SetUICLAuxUpdateSettingCustom" | "SetUICLAuxUpdateBrightness" | "SetUICLAuxRelease" | "SetUICLAllFindLightsStart" | "SetUICLAllFindLightsStop" | "GetUICLAllFindLightsReport" | "SetUICLAllResetToDefaults" | "SetUICLAllOnWhite" | "SetLightMode" | "IDV2Light" | "SetV2Mode" | "SetLightModeByRelay" | "SetV2ModeByRelay" | "CreateUIScheduleAltCmd" | "CreateUIScheduleCmd" | "DeleteUIScheduleCmd" | "SetUIScheduleEnableCmd" | "EditUIScheduleCmd" | "EditUIScheduleAltCmd" | "UIGetCSADForcedOnTimeout" | "UISetCSADForcedOnTimeout" | "UIGetCSADAutoTimeout" | "UISetCSADAutoTimeout" | "UIGetCSADStatus" | "UIGetCSADRevision" | "UIGetCSADTargetValue" | "UISetCSADTargetValue" | "UIGetCSADPHAlarmLevel" | "UISetCSADPHAlarmLevel" | "UIGetCSADEnabled" | "UISetCSADEnabled" | "UIGetCSADExtendEnabled" | "UISetCSADExtendEnabled" | "UIGetCSADType" | "UISetCSADType" | "UIGetCSADMode" | "UISetCSADMode" | "SetUISystemStateCmd" | "GetUISuperCHLORTimeRemaining" | "UIGetCSADCalibrationValue" | "UISetCSADCalibrationValue" | "GetUISystemStateCmd" | "SetUICHLOROperatingMode" | "GetUICHLOROperatingMode" | "SetUICSADORPTargetLevel" | "GetUICSADORPTargetLevel" | "SetUICSADORPAlarmLevel" | "GetUICSADORPAlarmLevel" | "SetUIMultiHeaterPriorityCmd" | "SetChlorinatorScheduleCmd" | "RestoreChlorinatorPercentCmd" | "ClearUIAlarmCmd" | "GetUIFilterStatus" | "GetUIHeaterStatus" | "SetStandAloneLightShow" | "ResetStandAloneLight" | "GetStandAloneLightShow" | "SetUISpilloverCmd" | "GetUIPumpStatus" | "SetHeaterScheduleAltCmd" | "SetHeaterScheduleCmd" | "RestoreHeaterSetPointCmd" | "RunGroupCmd" | "SaveNewGroupCmd" | "SaveExistingGroupCmd" | "DeleteGroupCmd" | "SetGroupCmd" | "TurnOnOffForGroup" | "CreateUIFavoriteAltCmd" | "CreateUIFavoriteCmd" | "DeleteUIFavoriteCmd" | "ModifyUIFavoriteCmd" | "UpdateButtonOnTerm" | "GetRemainingCountdownTime" | "GetRemainingSCTime" | "UiEditConfigObjectName" | "UiGetConfigObjectName" | "SetSolarScheduleCmd" | "RestoreSolarSetPointCmd" | "RestoreIdleState" | "SetDemandResponseCmd" | "SetPrimingDuration" | "GetPrimingDuration" | "SetCooldownDuration" | "GetCooldownDuration" | "SetSharedFilterTimeout" | "GetSharedFilterTimeout" | "SetHeaterAllowLowSpeed" | "GetHeaterAllowLowSpeed" | "SetHeaterLowSpeed" | "GetHeaterLowSpeed" | "SetUITestModeEnter" | "SetUIDisplayModeState" | "GetUIDisplayModeState" | "SetUIPumpSpeed" | "GetUIPumpSpeed" | "SetUIFreezeProtectOverride" | "GetUIFreezeProtectOverride" | "SetUIFreezeProtectOverrideInterval" | "GetUIFreezeProtectOverrideInterval" | "GetUIFilterDiagnosticInfo" | "SetUITemporaryHeaterEnable" | "SetUITemporaryHeaterPriorityCmd" | "SetUITemporaryHeaterMaintainPriorityCmd" | "SetCoordinates" | "GetCoordinates" | "Unknown1414" extends N ? N : never

params ​

Record<string, string | number> | undefined

options ​

CommandOptions & object

Returns ​

Promise<string | undefined>

Call Signature ​

command<N>(name, params?, options?): Promise<unknown>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:252

Send a command to the controller

Type Parameters ​
N ​

N extends "SetUIPoolSpaSpilloverCmd" | "GetUIPoolSpaSpilloverCmd" | "SetUIPoolFilterCmd" | "SetUIFilterSpeedCmd" | "GetUIFilterSpeedCmd" | "SetUIHeaterCmd" | "GetUIHeaterCmd" | "SetUIHeaterPriorityCmd" | "GetUIHeaterPriorityCmd" | "SetUISuperCHLORCmd" | "GetUISuperCHLORCmd" | "SetUISuperCHLORTimeoutCmd" | "SetUIORPCHLORTimeoutCmd" | "SetUISuperCHLOROutputCmd" | "GetUISuperCHLOROutputCmd" | "SetUIRelayCmd" | "SetUIEquipmentCmd" | "GetUIRelayCmd" | "SetUIValveCmd" | "GetUIValveCmd" | "GetUIPoolTempCmd" | "GetUIAirTempCmd" | "GetUIFlowSensor" | "GetUISensor" | "GetUISolarTempCmd" | "UiSetManualLastSpeed" | "GetAutoTime" | "SetUISolarSetPointCmd" | "GetSetUISolarSetPointCmd" | "SetUIHeaterModeCmd" | "GetUIHeaterModeCmd" | "SetHeaterAutoDifferential" | "GetHeaterAutoDifferential" | "GetHeaterDiagnostic" | "GetHeaterPowerUsage" | "GetHeaterSensor" | "SetHeaterSilentMode" | "GetHeaterSilentMode" | "SetUISmartValveCmd" | "GetUISmartValveCmd" | "SetUISmartValveTargetCmd" | "SetUISmartValveForTheme" | "GetFlowControlPortStatus" | "GetFlowControlPortConfig" | "GetFlowControlDiagnostic" | "GetFlowControlPortErrors" | "FlowControlHomePortsCmd" | "SetUIFlowControlForTheme" | "SetTime2" | "SetDateTime" | "GetDateTime" | "SetDate" | "GetDate" | "SetTime" | "GetTime" | "SetBackLight" | "GetBackLight" | "SetBackLightBrightness" | "GetBackLightBrightness" | "SetBackLightTimeout" | "GetBackLightTimeout" | "SetBeeper" | "GetBeeper" | "SetTimeFormat" | "GetTimeFormat" | "SetUnits" | "GetUnits" | "SetVSPSpeedFormat" | "GetVSPSpeedFormat" | "SetCHLOREnable" | "GetCHLOREnable" | "SetCHLORDisplay" | "GetCHLORDisplay" | "SetSpaSpilloverEnable" | "GetSpaSpilloverEnable" | "SetFilterOperation" | "GetFilterOperation" | "SetFilterOffValveChg" | "GetFilterOffValveChg" | "SetFilterLowSpeed" | "GetFilterLowSpeed" | "SetFilterHighSpeed" | "GetFilterHighSpeed" | "SetFreezeProtect" | "GetFreezeProtect" | "SetFreezeProtectSpeed" | "GetFreezeProtectSpeed" | "SetFreezeProtectTemp" | "GetFreezeProtectTemp" | "SetFlowMonitor" | "GetFlowMonitor" | "SetExternalInterLock" | "GetExternalInterLock" | "SetHeaterEnable" | "GetHeaterEnable" | "SetHeaterCoolDown" | "GetHeaterCoolDown" | "SetHeaterExtend" | "GetHeaterExtend" | "SetHeaterAllowedLowSpeed" | "GetHeaterAllowedLowSpeed" | "SetCHLORParams" | "GetCHLORParams" | "GetCHLORStatus" | "GetCHLORAlert" | "GetCHLORError" | "CHLORSaltCalcRestart" | "CHLORRelayPolarityReverse" | "CHLORCellRuntimeRestart" | "GetCHLORMeasurement" | "GetScVersionCmd" | "SetScLedCmd" | "SetCHLORTimePercent" | "GetCHLORRelayPolarity" | "GetUICLLightStatus" | "GetUICLIMStatus" | "SetCLSerialIdentifyStart" | "SetUICLSerialIdentifyStop" | "GetUICLIMAuthenticate" | "SetUICLIMUnlock" | "GetNetworkedLightStatus" | "SetUICLLightNumAssignSeqStandard" | "SetUICLLightNumAssignSeqCustom" | "SetUICLLightNumAssignSeqStationary" | "SetUICLLightNumUnassignAux" | "SetUICLLightNumIdentifyStart" | "SetUICLLightNumIdentifyStop" | "SetUICLAuxLightOnOff" | "SetUICLAuxUpdateSettingStationary" | "SetUICLAuxUpdateSettingStandard" | "SetUICLAuxUpdateSettingCustom" | "SetUICLAuxUpdateBrightness" | "SetUICLAuxRelease" | "SetUICLAllFindLightsStart" | "SetUICLAllFindLightsStop" | "GetUICLAllFindLightsReport" | "SetUICLAllResetToDefaults" | "SetUICLAllOnWhite" | "SetLightMode" | "IDV2Light" | "SetV2Mode" | "SetLightModeByRelay" | "SetV2ModeByRelay" | "CreateUIScheduleAltCmd" | "CreateUIScheduleCmd" | "DeleteUIScheduleCmd" | "SetUIScheduleEnableCmd" | "EditUIScheduleCmd" | "EditUIScheduleAltCmd" | "UIGetCSADForcedOnTimeout" | "UISetCSADForcedOnTimeout" | "UIGetCSADAutoTimeout" | "UISetCSADAutoTimeout" | "UIGetCSADStatus" | "UIGetCSADRevision" | "UIGetCSADTargetValue" | "UISetCSADTargetValue" | "UIGetCSADPHAlarmLevel" | "UISetCSADPHAlarmLevel" | "UIGetCSADEnabled" | "UISetCSADEnabled" | "UIGetCSADExtendEnabled" | "UISetCSADExtendEnabled" | "UIGetCSADType" | "UISetCSADType" | "UIGetCSADMode" | "UISetCSADMode" | "SetUISystemStateCmd" | "GetUISuperCHLORTimeRemaining" | "UIGetCSADCalibrationValue" | "UISetCSADCalibrationValue" | "GetUISystemStateCmd" | "SetUICHLOROperatingMode" | "GetUICHLOROperatingMode" | "SetUICSADORPTargetLevel" | "GetUICSADORPTargetLevel" | "SetUICSADORPAlarmLevel" | "GetUICSADORPAlarmLevel" | "SetUIMultiHeaterPriorityCmd" | "SetChlorinatorScheduleCmd" | "RestoreChlorinatorPercentCmd" | "ClearUIAlarmCmd" | "GetUIFilterStatus" | "GetUIHeaterStatus" | "SetStandAloneLightShow" | "ResetStandAloneLight" | "GetStandAloneLightShow" | "SetUISpilloverCmd" | "GetUIPumpStatus" | "SetHeaterScheduleAltCmd" | "SetHeaterScheduleCmd" | "RestoreHeaterSetPointCmd" | "RunGroupCmd" | "SaveNewGroupCmd" | "SaveExistingGroupCmd" | "DeleteGroupCmd" | "SetGroupCmd" | "TurnOnOffForGroup" | "CreateUIFavoriteAltCmd" | "CreateUIFavoriteCmd" | "DeleteUIFavoriteCmd" | "ModifyUIFavoriteCmd" | "UpdateButtonOnTerm" | "GetRemainingCountdownTime" | "GetRemainingSCTime" | "UiEditConfigObjectName" | "UiGetConfigObjectName" | "SetSolarScheduleCmd" | "RestoreSolarSetPointCmd" | "RestoreIdleState" | "SetDemandResponseCmd" | "SetPrimingDuration" | "GetPrimingDuration" | "SetCooldownDuration" | "GetCooldownDuration" | "SetSharedFilterTimeout" | "GetSharedFilterTimeout" | "SetHeaterAllowLowSpeed" | "GetHeaterAllowLowSpeed" | "SetHeaterLowSpeed" | "GetHeaterLowSpeed" | "SetUITestModeEnter" | "SetUIDisplayModeState" | "GetUIDisplayModeState" | "SetUIPumpSpeed" | "GetUIPumpSpeed" | "SetUIFreezeProtectOverride" | "GetUIFreezeProtectOverride" | "SetUIFreezeProtectOverrideInterval" | "GetUIFreezeProtectOverrideInterval" | "GetUIFilterDiagnosticInfo" | "SetUITemporaryHeaterEnable" | "SetUITemporaryHeaterPriorityCmd" | "SetUITemporaryHeaterMaintainPriorityCmd" | "SetCoordinates" | "GetCoordinates" | "Unknown1414"

Parameters ​
name ​

"SetUIPoolSpaSpilloverCmd" | "GetUIPoolSpaSpilloverCmd" | "SetUIPoolFilterCmd" | "SetUIFilterSpeedCmd" | "GetUIFilterSpeedCmd" | "SetUIHeaterCmd" | "GetUIHeaterCmd" | "SetUIHeaterPriorityCmd" | "GetUIHeaterPriorityCmd" | "SetUISuperCHLORCmd" | "GetUISuperCHLORCmd" | "SetUISuperCHLORTimeoutCmd" | "SetUIORPCHLORTimeoutCmd" | "SetUISuperCHLOROutputCmd" | "GetUISuperCHLOROutputCmd" | "SetUIRelayCmd" | "SetUIEquipmentCmd" | "GetUIRelayCmd" | "SetUIValveCmd" | "GetUIValveCmd" | "GetUIPoolTempCmd" | "GetUIAirTempCmd" | "GetUIFlowSensor" | "GetUISensor" | "GetUISolarTempCmd" | "UiSetManualLastSpeed" | "GetAutoTime" | "SetUISolarSetPointCmd" | "GetSetUISolarSetPointCmd" | "SetUIHeaterModeCmd" | "GetUIHeaterModeCmd" | "SetHeaterAutoDifferential" | "GetHeaterAutoDifferential" | "GetHeaterDiagnostic" | "GetHeaterPowerUsage" | "GetHeaterSensor" | "SetHeaterSilentMode" | "GetHeaterSilentMode" | "SetUISmartValveCmd" | "GetUISmartValveCmd" | "SetUISmartValveTargetCmd" | "SetUISmartValveForTheme" | "GetFlowControlPortStatus" | "GetFlowControlPortConfig" | "GetFlowControlDiagnostic" | "GetFlowControlPortErrors" | "FlowControlHomePortsCmd" | "SetUIFlowControlForTheme" | "SetTime2" | "SetDateTime" | "GetDateTime" | "SetDate" | "GetDate" | "SetTime" | "GetTime" | "SetBackLight" | "GetBackLight" | "SetBackLightBrightness" | "GetBackLightBrightness" | "SetBackLightTimeout" | "GetBackLightTimeout" | "SetBeeper" | "GetBeeper" | "SetTimeFormat" | "GetTimeFormat" | "SetUnits" | "GetUnits" | "SetVSPSpeedFormat" | "GetVSPSpeedFormat" | "SetCHLOREnable" | "GetCHLOREnable" | "SetCHLORDisplay" | "GetCHLORDisplay" | "SetSpaSpilloverEnable" | "GetSpaSpilloverEnable" | "SetFilterOperation" | "GetFilterOperation" | "SetFilterOffValveChg" | "GetFilterOffValveChg" | "SetFilterLowSpeed" | "GetFilterLowSpeed" | "SetFilterHighSpeed" | "GetFilterHighSpeed" | "SetFreezeProtect" | "GetFreezeProtect" | "SetFreezeProtectSpeed" | "GetFreezeProtectSpeed" | "SetFreezeProtectTemp" | "GetFreezeProtectTemp" | "SetFlowMonitor" | "GetFlowMonitor" | "SetExternalInterLock" | "GetExternalInterLock" | "SetHeaterEnable" | "GetHeaterEnable" | "SetHeaterCoolDown" | "GetHeaterCoolDown" | "SetHeaterExtend" | "GetHeaterExtend" | "SetHeaterAllowedLowSpeed" | "GetHeaterAllowedLowSpeed" | "SetCHLORParams" | "GetCHLORParams" | "GetCHLORStatus" | "GetCHLORAlert" | "GetCHLORError" | "CHLORSaltCalcRestart" | "CHLORRelayPolarityReverse" | "CHLORCellRuntimeRestart" | "GetCHLORMeasurement" | "GetScVersionCmd" | "SetScLedCmd" | "SetCHLORTimePercent" | "GetCHLORRelayPolarity" | "GetUICLLightStatus" | "GetUICLIMStatus" | "SetCLSerialIdentifyStart" | "SetUICLSerialIdentifyStop" | "GetUICLIMAuthenticate" | "SetUICLIMUnlock" | "GetNetworkedLightStatus" | "SetUICLLightNumAssignSeqStandard" | "SetUICLLightNumAssignSeqCustom" | "SetUICLLightNumAssignSeqStationary" | "SetUICLLightNumUnassignAux" | "SetUICLLightNumIdentifyStart" | "SetUICLLightNumIdentifyStop" | "SetUICLAuxLightOnOff" | "SetUICLAuxUpdateSettingStationary" | "SetUICLAuxUpdateSettingStandard" | "SetUICLAuxUpdateSettingCustom" | "SetUICLAuxUpdateBrightness" | "SetUICLAuxRelease" | "SetUICLAllFindLightsStart" | "SetUICLAllFindLightsStop" | "GetUICLAllFindLightsReport" | "SetUICLAllResetToDefaults" | "SetUICLAllOnWhite" | "SetLightMode" | "IDV2Light" | "SetV2Mode" | "SetLightModeByRelay" | "SetV2ModeByRelay" | "CreateUIScheduleAltCmd" | "CreateUIScheduleCmd" | "DeleteUIScheduleCmd" | "SetUIScheduleEnableCmd" | "EditUIScheduleCmd" | "EditUIScheduleAltCmd" | "UIGetCSADForcedOnTimeout" | "UISetCSADForcedOnTimeout" | "UIGetCSADAutoTimeout" | "UISetCSADAutoTimeout" | "UIGetCSADStatus" | "UIGetCSADRevision" | "UIGetCSADTargetValue" | "UISetCSADTargetValue" | "UIGetCSADPHAlarmLevel" | "UISetCSADPHAlarmLevel" | "UIGetCSADEnabled" | "UISetCSADEnabled" | "UIGetCSADExtendEnabled" | "UISetCSADExtendEnabled" | "UIGetCSADType" | "UISetCSADType" | "UIGetCSADMode" | "UISetCSADMode" | "SetUISystemStateCmd" | "GetUISuperCHLORTimeRemaining" | "UIGetCSADCalibrationValue" | "UISetCSADCalibrationValue" | "GetUISystemStateCmd" | "SetUICHLOROperatingMode" | "GetUICHLOROperatingMode" | "SetUICSADORPTargetLevel" | "GetUICSADORPTargetLevel" | "SetUICSADORPAlarmLevel" | "GetUICSADORPAlarmLevel" | "SetUIMultiHeaterPriorityCmd" | "SetChlorinatorScheduleCmd" | "RestoreChlorinatorPercentCmd" | "ClearUIAlarmCmd" | "GetUIFilterStatus" | "GetUIHeaterStatus" | "SetStandAloneLightShow" | "ResetStandAloneLight" | "GetStandAloneLightShow" | "SetUISpilloverCmd" | "GetUIPumpStatus" | "SetHeaterScheduleAltCmd" | "SetHeaterScheduleCmd" | "RestoreHeaterSetPointCmd" | "RunGroupCmd" | "SaveNewGroupCmd" | "SaveExistingGroupCmd" | "DeleteGroupCmd" | "SetGroupCmd" | "TurnOnOffForGroup" | "CreateUIFavoriteAltCmd" | "CreateUIFavoriteCmd" | "DeleteUIFavoriteCmd" | "ModifyUIFavoriteCmd" | "UpdateButtonOnTerm" | "GetRemainingCountdownTime" | "GetRemainingSCTime" | "UiEditConfigObjectName" | "UiGetConfigObjectName" | "SetSolarScheduleCmd" | "RestoreSolarSetPointCmd" | "RestoreIdleState" | "SetDemandResponseCmd" | "SetPrimingDuration" | "GetPrimingDuration" | "SetCooldownDuration" | "GetCooldownDuration" | "SetSharedFilterTimeout" | "GetSharedFilterTimeout" | "SetHeaterAllowLowSpeed" | "GetHeaterAllowLowSpeed" | "SetHeaterLowSpeed" | "GetHeaterLowSpeed" | "SetUITestModeEnter" | "SetUIDisplayModeState" | "GetUIDisplayModeState" | "SetUIPumpSpeed" | "GetUIPumpSpeed" | "SetUIFreezeProtectOverride" | "GetUIFreezeProtectOverride" | "SetUIFreezeProtectOverrideInterval" | "GetUIFreezeProtectOverrideInterval" | "GetUIFilterDiagnosticInfo" | "SetUITemporaryHeaterEnable" | "SetUITemporaryHeaterPriorityCmd" | "SetUITemporaryHeaterMaintainPriorityCmd" | "SetCoordinates" | "GetCoordinates" | "Unknown1414" extends N ? N : never

params? ​

Record<string, string | number>

options? ​

CommandOptions

Returns ​

Promise<unknown>

fetchConfig() ​

fetchConfig<R>(options?): Fetched<R, MSPConfig>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:480

Type Parameters ​

R ​

R extends boolean = false

Parameters ​

options? ​

ReadOptions<R>

Returns ​

Fetched<R, MSPConfig>

fetchSysInfo() ​

fetchSysInfo<R>(options?): Fetched<R, SysInfo>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:516

Type Parameters ​

R ​

R extends boolean = false

Parameters ​

options? ​

ReadOptions<R>

Returns ​

Fetched<R, SysInfo>

fetchTelemetry() ​

fetchTelemetry<R>(options?): Fetched<R, Telemetry>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:499

Type Parameters ​

R ​

R extends boolean = false

Parameters ​

options? ​

ReadOptions<R>

Returns ​

Fetched<R, Telemetry>

refresh() ​

refresh(options?): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/client/omnilogic.ts:628

Fetch and cache the latest telemetry and config

Parameters ​

options? ​
force? ​

boolean

refetch? ​

boolean

Returns ​

Promise<void>

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

MIT Licensed | Copyright © 2026 Ry Racherbaumer