Class: Light

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

Extends

• Device

Constructors

Constructor

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

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

Parameters

omni

OmniLogic

poolId

number

equipmentId

number

name

string

Returns

Light

Inherited from

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

---

brightness

Get Signature

get brightness(): number | undefined

Defined in: packages/omnilogic-local-sdk/src/equipment/light.ts:141

Returns

number | undefined

---

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/light.ts:147

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

---

omniDirect

Get Signature

get omniDirect(): boolean

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

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

---

powerState

Get Signature

get powerState(): string

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

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

---

show

Get Signature

get show(): string

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

Returns

string

---

shows

Get Signature

get shows(): object[]

Defined in: packages/omnilogic-local-sdk/src/equipment/light.ts:105

Returns

object[]

---

speed

Get Signature

get speed(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/light.ts:133

Returns

string

---

state

Get Signature

get state(): ColorLogicLight | undefined

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

Returns

ColorLogicLight | undefined

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

---

off()

off(options?): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/light.ts:211

Parameters

options?

LightWriteOptions = {}

Returns

Promise<void>

---

on()

on(options?): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/light.ts:207

Parameters

options?

LightWriteOptions = {}

Returns

Promise<void>

---

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

---

setShow()

setShow(show, options?): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/light.ts:178

Parameters

show

number

options?

LightWriteOptions = {}

Returns

Promise<void>

---

showParams()

showParams(show, options?): object

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

Parameters

show

number

options?

Pick<LightWriteOptions, "speed" | "brightness"> = {}

Returns

object

data

data: number = show

field19

field19: number = 0

field1a

field1a: number = 0

field1b

field1b: number = 0

---

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