Class: HeaterAppliance

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:12

Extends

• Device

Constructors

Constructor

new HeaterAppliance(omni, poolId, config): HeaterAppliance

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

Parameters

omni

OmniLogic

poolId

number

config

HeaterEquipment

Returns

HeaterAppliance

Overrides

Device.constructor

Accessors

allowLowSpeed

Get Signature

get allowLowSpeed(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:84

Returns

boolean

---

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

---

enabled

Get Signature

get enabled(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:96

Returns

boolean

---

equipmentId

Get Signature

get equipmentId(): number

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

Returns

number

Inherited from

Device.equipmentId

---

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/heaterAppliance.ts:54

Returns

boolean

---

lowSpeed

Get Signature

get lowSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:71

Returns

number

---

maintainFor

Get Signature

get maintainFor(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:132

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

---

poolId

Get Signature

get poolId(): number

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

Returns

number

Inherited from

Device.poolId

---

priority

Get Signature

get priority(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:109

Returns

string

---

running

Get Signature

get running(): boolean

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

Returns

boolean

Inherited from

Device.running

---

sharedWith

Get Signature

get sharedWith(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:31

Returns

number

---

state

Get Signature

get state(): Heater

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:35

Returns

Heater

---

status

Get Signature

get status(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:48

Returns

string

---

supportsCooling

Get Signature

get supportsCooling(): boolean | undefined

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:66

Returns

boolean | undefined

---

temp

Get Signature

get temp(): number | undefined

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:58

Returns

number | undefined

---

type

Get Signature

get type(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:26

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

---

setAllowLowSpeed()

setAllowLowSpeed(on): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:88

Parameters

on

boolean

Returns

Promise<void>

---

setEnabled()

setEnabled(on): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:100

Parameters

on

boolean

Returns

Promise<void>

---

setLowSpeed()

setLowSpeed(value): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:75

Parameters

value

number

Returns

Promise<void>

---

setPriority()

setPriority(rank): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heaterAppliance.ts:113

Parameters

rank

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