Class: Filter

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:24

Extends

• Pump

Constructors

Constructor

new Filter(omni, poolId, config): Filter

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:25

Parameters

omni

OmniLogic

poolId

number

config

Filter

Returns

Filter

Overrides

Pump.constructor

Accessors

bodyConfig

Get Signature

get bodyConfig(): BodyOfWater | undefined

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:46

Returns

BodyOfWater | undefined

Inherited from

Pump.bodyConfig

---

cooldownDuration

Get Signature

get cooldownDuration(): number

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

Returns

number

---

countdownReason

Get Signature

get countdownReason(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:45

Returns

number

Overrides

Pump.countdownReason

---

equipmentId

Get Signature

get equipmentId(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:33

Returns

number

Inherited from

Pump.equipmentId

---

flowMonitor

Get Signature

get flowMonitor(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:243

Returns

boolean

---

freezeProtect

Get Signature

get freezeProtect(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:199

Returns

boolean

---

freezeProtectOverrideInterval

Get Signature

get freezeProtectOverrideInterval(): number

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

Returns

number

---

freezeProtectSpeed

Get Signature

get freezeProtectSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:221

Returns

number

---

freezeProtectTemp

Get Signature

get freezeProtectTemp(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:210

Returns

number

---

function

Get Signature

get function(): string | undefined

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:29

Returns

string | undefined

Inherited from

Pump.function

---

highSpeed

Get Signature

get highSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:147

Returns

number

---

inventoryBody

Get Signature

get inventoryBody(): BodyInventory

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:53

Returns

BodyInventory

Inherited from

Pump.inventoryBody

---

isOn

Get Signature

get isOn(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:73

Returns

boolean

Inherited from

Pump.isOn

---

isPriming

Get Signature

get isPriming(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:64

Returns

boolean

---

isRunning

Get Signature

get isRunning(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:77

Returns

boolean

Inherited from

Pump.isRunning

---

lastSpeed

Get Signature

get lastSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:81

Returns

number

Inherited from

Pump.lastSpeed

---

lowSpeed

Get Signature

get lowSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:137

Returns

number

---

maxSpeed

Get Signature

get maxSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:124

Returns

number

---

mediumSpeed

Get Signature

get mediumSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:142

Returns

number

---

minSpeed

Get Signature

get minSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:112

Returns

number

---

name

Get Signature

get name(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:37

Returns

string

Inherited from

Pump.name

---

offDuringValveChange

Get Signature

get offDuringValveChange(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:232

Returns

boolean

---

omni

Get Signature

get omni(): OmniLogic

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:24

Returns

OmniLogic

Inherited from

Pump.omni

---

onCountdown

Get Signature

get onCountdown(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:97

Returns

boolean

Inherited from

Pump.onCountdown

---

poolId

Get Signature

get poolId(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:29

Returns

number

Inherited from

Pump.poolId

---

power

Get Signature

get power(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:70

Returns

number

---

primingDuration

Get Signature

get primingDuration(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:151

Returns

number

---

reasons

Get Signature

get reasons(): Record<number, string>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:41

Returns

Record<number, string>

Overrides

Pump.reasons

---

reported

Get Signature

get reported(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:42

Returns

boolean

Inherited from

Pump.reported

---

reportedSpeed

Get Signature

get reportedSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:60

Returns

number

---

running

Get Signature

get running(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:41

Returns

boolean

Inherited from

Pump.running

---

sharedFilterTimeout

Get Signature

get sharedFilterTimeout(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:175

Returns

number

---

speed

Get Signature

get speed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:69

Returns

number

Inherited from

Pump.speed

---

state

Get Signature

get state(): Filter

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:49

Returns

Filter

Overrides

Pump.state

---

states

Get Signature

get states(): Record<number, string>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:37

Returns

Record<number, string>

Overrides

Pump.states

---

status

Get Signature

get status(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:87

Returns

string

Inherited from

Pump.status

---

type

Get Signature

get type(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:24

Returns

string

Inherited from

Pump.type

---

valvePosition

Get Signature

get valvePosition(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:54

Returns

string

---

whyOn

Get Signature

get whyOn(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:92

Returns

string

Inherited from

Pump.whyOn

Methods

configured()

configured<T>(node): T

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:83

Type Parameters

T

T

Parameters

node

T | undefined

Returns

T

Inherited from

Pump.configured

---

diagnostics()

diagnostics(options?): Promise<FilterDiagnostics>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:74

Parameters

options?

ReadOptions = {}

Returns

Promise<FilterDiagnostics>

---

idAt()

idAt(path): number

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:64

Parameters

path

"filter" | "filter.vsp" | "heater" | "heater.gas" | "heater.unit" | "chlorinator" | "chlorinator.cell" | "chlorinator.feeder" | "csad" | "light" | "light.networked" | "blower" | "spillover"

Returns

number

Inherited from

Pump.idAt

---

reportedIn()

reportedIn(list): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:78

Parameters

list

object[]

Returns

boolean

Inherited from

Pump.reportedIn

---

requireRunning()

requireRunning(): void

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:68

Returns

void

Inherited from

Pump.requireRunning

---

setCooldownDuration()

setCooldownDuration(seconds): Promise<void>

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

Parameters

seconds

number

Returns

Promise<void>

---

setFlowMonitor()

setFlowMonitor(on): Promise<void>

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

Parameters

on

boolean

Returns

Promise<void>

---

setFreezeProtect()

setFreezeProtect(on): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:203

Parameters

on

boolean

Returns

Promise<void>

---

setFreezeProtectOverrideInterval()

setFreezeProtectOverrideInterval(seconds): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:191

Parameters

seconds

number

Returns

Promise<void>

---

setFreezeProtectSpeed()

setFreezeProtectSpeed(value): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:225

Parameters

value

number

Returns

Promise<void>

---

setFreezeProtectTemp()

setFreezeProtectTemp(degrees): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:214

Parameters

degrees

number

Returns

Promise<void>

---

setMaxSpeed()

setMaxSpeed(value): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:128

Parameters

value

number

Returns

Promise<void>

---

setMinSpeed()

setMinSpeed(value): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:116

Parameters

value

number

Returns

Promise<void>

---

setOffDuringValveChange()

setOffDuringValveChange(on): Promise<void>

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

Parameters

on

boolean

Returns

Promise<void>

---

setPrimingDuration()

setPrimingDuration(seconds): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:155

Parameters

seconds

number

Returns

Promise<void>

---

setSharedFilterTimeout()

setSharedFilterTimeout(seconds): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/filter.ts:179

Parameters

seconds

number

Returns

Promise<void>

---

setSpeed()

setSpeed(value): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/pump.ts:102

Parameters

value

number

Returns

Promise<void>

Inherited from

Pump.setSpeed

---

telemetry()

telemetry<T>(list): T

Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:90

Type Parameters

T

T extends object

Parameters

list

T[]

Returns

T

Inherited from

Pump.telemetry