Class: Pump

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

Extends

• Device

Extended by

• Filter

Constructors

Constructor

new Pump(omni, poolId, config): Pump

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

Parameters

omni

OmniLogic

poolId

number

config

PumpConfig

Returns

Pump

Overrides

Device.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

Device.bodyConfig

---

countdownReason

Get Signature

get countdownReason(): number

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

Returns

number

---

equipmentId

Get Signature

get equipmentId(): number

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

Returns

number

Inherited from

Device.equipmentId

---

function

Get Signature

get function(): string | undefined

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

Returns

string | undefined

---

inventoryBody

Get Signature

get inventoryBody(): BodyInventory

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

Returns

BodyInventory

Inherited from

Device.inventoryBody

---

isOn

Get Signature

get isOn(): boolean

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

Returns

boolean

---

isRunning

Get Signature

get isRunning(): boolean

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

Returns

boolean

---

lastSpeed

Get Signature

get lastSpeed(): number

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

Returns

number

---

name

Get Signature

get name(): string

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

Returns

string

Inherited from

Device.name

---

omni

Get Signature

get omni(): OmniLogic

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

Returns

OmniLogic

Inherited from

Device.omni

---

onCountdown

Get Signature

get onCountdown(): boolean

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

Returns

boolean

---

poolId

Get Signature

get poolId(): number

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

Returns

number

Inherited from

Device.poolId

---

reasons

Get Signature

get reasons(): Record<number, string>

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

Returns

Record<number, string>

---

reported

Get Signature

get reported(): boolean

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

Returns

boolean

---

running

Get Signature

get running(): boolean

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

Returns

boolean

Inherited from

Device.running

---

speed

Get Signature

get speed(): number

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

Returns

number

---

state

Get Signature

get state(): Filter | Pump

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

Returns

Filter | Pump

---

states

Get Signature

get states(): Record<number, string>

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

Returns

Record<number, string>

---

status

Get Signature

get status(): string

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

Returns

string

---

type

Get Signature

get type(): string

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

Returns

string

---

whyOn

Get Signature

get whyOn(): string

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

Returns

string

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

Device.configured

---

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

Device.idAt

---

reportedIn()

reportedIn(list): boolean

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

Parameters

list

object[]

Returns

boolean

Inherited from

Device.reportedIn

---

requireRunning()

requireRunning(): void

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

Returns

void

Inherited from

Device.requireRunning

---

setSpeed()

setSpeed(value): Promise<void>

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

Parameters

value

number

Returns

Promise<void>

---

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

Device.telemetry