Class: Relay

Defined in: packages/omnilogic-local-sdk/src/equipment/relay.ts:7

Extends

• Device

Constructors

Constructor

new Relay(omni, poolId, config): Relay

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

Parameters

omni

OmniLogic

poolId

number

config

Relay

Returns

Relay

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

---

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

Defined in: packages/omnilogic-local-sdk/src/equipment/relay.ts:21

Returns

string

---

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/relay.ts:53

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

---

onCountdown

Get Signature

get onCountdown(): boolean

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

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

---

running

Get Signature

get running(): boolean

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

Returns

boolean

Inherited from

Device.running

---

smartValveTarget

Get Signature

get smartValveTarget(): number | undefined

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

Returns

number | undefined

---

state

Get Signature

get state(): Relay | ValveActuator

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

Returns

Relay | ValveActuator

---

status

Get Signature

get status(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/relay.ts:49

Returns

string

---

type

Get Signature

get type(): string

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

Returns

string

---

valveDefaultSpeed

Get Signature

get valveDefaultSpeed(): number | undefined

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

Returns

number | undefined

---

whyOn

Get Signature

get whyOn(): string

Defined in: packages/omnilogic-local-sdk/src/equipment/relay.ts:64

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

---

off()

off(): Promise<void>

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

Returns

Promise<void>

---

on()

on(): Promise<void>

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

Returns

Promise<void>

---

remainingCountdownTime()

remainingCountdownTime(): Promise<number>

Defined in: packages/omnilogic-local-sdk/src/equipment/relay.ts:91

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

---

setCountdownTime()

setCountdownTime(minutes): Promise<void>

Defined in: packages/omnilogic-local-sdk/src/equipment/relay.ts:99

Parameters

minutes

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