Class: Device
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:6
Extended by
Constructors
Constructor
new Device(
omni,poolId,equipmentId,name):Device
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:12
Parameters
omni
poolId
number
equipmentId
number
name
string
Returns
Device
Accessors
bodyConfig
Get Signature
get bodyConfig():
BodyOfWater|undefined
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:46
Returns
BodyOfWater | undefined
equipmentId
Get Signature
get equipmentId():
number
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:33
Returns
number
inventoryBody
Get Signature
get inventoryBody():
BodyInventory
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:53
Returns
BodyInventory
name
Get Signature
get name():
string
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:37
Returns
string
omni
Get Signature
get omni():
OmniLogic
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:24
Returns
poolId
Get Signature
get poolId():
number
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:29
Returns
number
running
Get Signature
get running():
boolean
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:41
Returns
boolean
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
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
reportedIn()
reportedIn(
list):boolean
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:78
Parameters
list
object[]
Returns
boolean
requireRunning()
requireRunning():
void
Defined in: packages/omnilogic-local-sdk/src/equipment/device.ts:68
Returns
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