Class: Chlorinator

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

Extends

• Device

Constructors

Constructor

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

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

Parameters

omni

OmniLogic

poolId

number

equipmentId

number

name

string

Returns

Chlorinator

Inherited from

Device.constructor

Accessors

alert

Get Signature

get alert(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:108

Returns

string

---

averageSalt

Get Signature

get averageSalt(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:118

Returns

number

---

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

---

conditions

Get Signature

get conditions(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:101

Returns

string

---

enabled

Get Signature

get enabled(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:59

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

---

error

Get Signature

get error(): string

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

Returns

string

---

instantSalt

Get Signature

get instantSalt(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:123

Returns

number

---

inventoryBody

Get Signature

get inventoryBody(): BodyInventory

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

Returns

BodyInventory

Inherited from

Device.inventoryBody

---

isSuperchlorinating

Get Signature

get isSuperchlorinating(): boolean

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:127

Returns

boolean

---

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

---

operatingMode

Get Signature

get operatingMode(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:94

Returns

string

---

operatingState

Get Signature

get operatingState(): string

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

Returns

string

---

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

---

state

Get Signature

get state(): Chlorinator

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

Returns

Chlorinator

---

superchlorinateHours

Get Signature

get superchlorinateHours(): number

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:139

Returns

number

---

timedPercent

Get Signature

get timedPercent(): number

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

Returns

number

Methods

cellMeasurement()

cellMeasurement(options?): Promise<CellMeasurement>

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:188

Parameters

options?

ReadOptions = {}

Returns

Promise<CellMeasurement>

---

cellStatus()

cellStatus(options?): Promise<CellStatus>

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

Parameters

options?

ReadOptions = {}

Returns

Promise<CellStatus>

---

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

---

relayPolarity()

relayPolarity(): Promise<number>

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

Returns

Promise<number>

---

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

---

setEnabled()

setEnabled(on): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:63

Parameters

on

boolean

Returns

Promise<void>

---

setSuperchlorinateHours()

setSuperchlorinateHours(hours): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:143

Parameters

hours

number

Returns

Promise<void>

---

setTimedPercent()

setTimedPercent(percent): Promise<void>

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

Parameters

percent

number

Returns

Promise<void>

---

superchlorinate()

superchlorinate(on?): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/chlorinator.ts:131

Parameters

on?

boolean = true

Returns

Promise<void>

---

superchlorinateMinutesRemaining()

superchlorinateMinutesRemaining(): Promise<number>

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

Returns

Promise<number>

---

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