EngineInstance

Table of contents

Constructors

• constructor

Properties

• log
• node
• uid

Accessors

• allConnectors
• allInputs
• allProcesses
• context
• variables

Methods

• closeAll
• closeChannel
• closeConnector
• closeControl
• closeEvent
• closeInput
• closeInterface
• closeModule
• closeMonitor
• closeProcess
• closeProtocol
• get
• getGlobalVariable
• output
• registerAction
• registerChannel
• registerConnector
• registerControl
• registerEvent
• registerInput
• registerInterface
• registerModule
• registerMonitor
• registerProcess
• registerProtocol
• set
• setGlobalVariable
• triggerWorkspaceStart

Constructors

constructor

new EngineInstance(uid, node)

Parameters

Name	Type
uid	string
node	KeyValue

Properties

log

log: EngineLog

---

node

Readonly node: KeyValue

---

uid

Readonly uid: string

Accessors

allConnectors

get allConnectors(): EngineConnector[]

Get registered advanced

Returns

EngineConnector[]

---

allInputs

get allInputs(): EngineInput[]

Get registered inputs

Returns

EngineInput[]

---

allProcesses

get allProcesses(): EngineProcess[]

Get registered processes

Returns

EngineProcess[]

---

context

get context(): EngineContext

Get internal context

Returns

EngineContext

---

variables

get variables(): EngineContext

Get global variables

Returns

EngineContext

Methods

closeAll

closeAll(): void

Close all inputs/events

Returns

void

---

closeChannel

closeChannel(channel): void

Close single channel

Parameters

Name	Type
channel	EngineChannel

Returns

void

---

closeConnector

closeConnector(connector): void

Close a single process

Parameters

Name	Type
connector	EngineConnector

Returns

void

---

closeControl

closeControl(control): void

Close a single control

Parameters

Name	Type
control	EngineControl

Returns

void

---

closeEvent

closeEvent(event): void

Close a single event

Parameters

Name	Type
event	EngineEvent

Returns

void

---

closeInput

closeInput(input): void

Close a single input

Parameters

Name	Type
input	EngineInput

Returns

void

---

closeInterface

closeInterface(iface): void

Close a single interface

Parameters

Name	Type
iface	EngineInterface

Returns

void

---

closeModule

closeModule(module): void

Close a single module

Parameters

Name	Type
module	EngineModule

Returns

void

---

closeMonitor

closeMonitor(monitor): void

Close a single monitor

Parameters

Name	Type
monitor	EngineMonitor

Returns

void

---

closeProcess

closeProcess(proc): void

Close a single process

Parameters

Name	Type
proc	EngineProcess

Returns

void

---

closeProtocol

closeProtocol(protocol): void

Close single procotol

Parameters

Name	Type
protocol	EngineProtocol

Returns

void

---

get

get(key): any

Get variable

Parameters

Name	Type
key	string

Returns

any

---

getGlobalVariable

getGlobalVariable(key): any

Get global variable

Parameters

Name	Type
key	string

Returns

any

---

output

output(channel, data): void

Emit data from instance to processes

Parameters

Name	Type
channel	string
data	any

Returns

void

---

registerAction

registerAction(uid): EngineAction

Get engine action

Parameters

Name	Type
uid	string

Returns

EngineAction

---

registerChannel

registerChannel(name, opts?): EngineChannel

Register a channel

Parameters

Name	Type
name	string
opts?	KeyValue

Returns

EngineChannel

---

registerConnector

registerConnector(uid, opts): EngineConnector

Register a process

Parameters

Name	Type
uid	string
opts	KeyValue

Returns

EngineConnector

---

registerControl

registerControl(uid, instance): EngineControl

Register a control

Parameters

Name	Type
uid	string
instance	ControlBlock

Returns

EngineControl

---

registerEvent

registerEvent(event, opts?, uid?): EngineEvent

Register an event

Parameters

Name	Type
event	EventType
opts?	CronOpts | SolarEventOpts | TimeOpts
uid?	string

Returns

EngineEvent

---

registerInput

registerInput(nodeUID): EngineInput

Register an Input to receive incoming events

Parameters

Name	Type	Description
nodeUID	string	The UID of the Input node

Returns

EngineInput

Returns the new Input instance

---

registerInterface

registerInterface(nodeUID, opts?): EngineInterface

Register an interface

Parameters

Name	Type
nodeUID	string
opts?	KeyValue

Returns

EngineInterface

---

registerModule

registerModule(nodeUID, opts?, uid?): EngineModule

Register a Module

Parameters

Name	Type	Description
nodeUID	string	The UID of the Module node
opts?	EngineModuleOpts	-
uid?	string	-

Returns

EngineModule

Returns the new Module instance

---

registerMonitor

registerMonitor(nodeUID): EngineMonitor

Register an input

Parameters

Name	Type
nodeUID	string

Returns

EngineMonitor

---

registerProcess

registerProcess(nodeUID): EngineProcess

Register a process

Parameters

Name	Type
nodeUID	string

Returns

EngineProcess

---

registerProtocol

registerProtocol(protocol, uid): EngineProtocol

Register a protocol

Parameters

Name	Type
protocol	ConnectivityProtocol
uid	string

Returns

EngineProtocol

---

set

set(key, value, override?): void

Set variable

Parameters

Name	Type
key	string
value	any
override?	boolean

Returns

void

---

setGlobalVariable

setGlobalVariable(key, value, override?): void

Set global variable

Parameters

Name	Type
key	string
value	any
override?	boolean

Returns

void

---

triggerWorkspaceStart

triggerWorkspaceStart(id?): void

Call workspace start nodes

Parameters

Name	Type
id?	string | string[]

Returns

void