Class: Heater

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:10

Extends

• Device

Constructors

Constructor

new Heater(omni, poolId, equipmentId, name): Heater

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

Parameters

omni

OmniLogic

poolId

number

equipmentId

number

name

string

Returns

Heater

Inherited from

Device.constructor

Accessors

allowLowSpeed

Get Signature

get allowLowSpeed(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:158

Returns

boolean

---

appliances

Get Signature

get appliances(): HeaterAppliance[]

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

Returns

HeaterAppliance[]

---

applianceState

Get Signature

get applianceState(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:32

Returns

string

---

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

---

cooldown

Get Signature

get cooldown(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:110

Returns

boolean

---

enabled

Get Signature

get enabled(): boolean

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

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

---

extend

Get Signature

get extend(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:122

Returns

boolean

---

inventoryBody

Get Signature

get inventoryBody(): BodyInventory

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

Returns

BodyInventory

Inherited from

Device.inventoryBody

---

lowSpeed

Get Signature

get lowSpeed(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:166

Returns

number

---

maxSetPoint

Get Signature

get maxSetPoint(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:51

Returns

number

---

minSetPoint

Get Signature

get minSetPoint(): number

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

Returns

number

---

mode

Get Signature

get mode(): string

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

Returns

string

---

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

---

running

Get Signature

get running(): boolean

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

Returns

boolean

Inherited from

Device.running

---

setPoint

Get Signature

get setPoint(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:36

Returns

number

---

silentMode

Get Signature

get silentMode(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:98

Returns

boolean

---

solarSetPoint

Get Signature

get solarSetPoint(): number

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

Returns

number

---

state

Get Signature

get state(): VirtualHeater

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:11

Returns

VirtualHeater

Methods

autoDifferential()

autoDifferential(): Promise<number>

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:134

Returns

Promise<number>

---

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/heater.ts:162

Parameters

on

boolean

Returns

Promise<void>

---

setAutoDifferential()

setAutoDifferential(degrees): Promise<void>

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

Parameters

degrees

number

Returns

Promise<void>

---

setCooldown()

setCooldown(on): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:114

Parameters

on

boolean

Returns

Promise<void>

---

setEnabled()

setEnabled(on): Promise<void>

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

Parameters

on

boolean

Returns

Promise<void>

---

setExtend()

setExtend(on): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:126

Parameters

on

boolean

Returns

Promise<void>

---

setLowSpeed()

setLowSpeed(value): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:170

Parameters

value

number

Returns

Promise<void>

---

setMode()

setMode(mode): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:85

Parameters

mode

number

Returns

Promise<void>

---

setSetPoint()

setSetPoint(degrees): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/heater.ts:55

Parameters

degrees

number

Returns

Promise<void>

---

setSilentMode()

setSilentMode(on): Promise<void>

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

Parameters

on

boolean

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