API.RWS. SIGNAL

This class class provides a set of signal-related interfaces that are not supported by the OmniCore SDK.

Methods

getSignalInstance(signalName, network, device) → {Promise.<any>}

Get the signal instance defined by RWS.IO

Parameters:
NameTypeDescription
signalNamestring
networkstring
devicestring
Returns:
Type: 
Promise.<any>

getSignalValue(signalName, deviceType, networkType) → {Promise.<string>}

Gets the signal value.

Parameters:
NameTypeDescription
signalNamestring

The signal name.

deviceTypestring

The device type.

networkTypestring

The network type.

Returns:
Type: 
Promise.<string>
Example
await API.RWS.SIGNAL.getSignalValue("TestDO1");

setSignalValue(signalName, value, mode, pulses, activePulse, passivePulse, delay, deviceType, networkType, attr)

Modifies the signal value.

Parameters:
NameTypeDescription
signalNamestring
valuenumber
modestring

value | pulse | invert | toggle | delay

pulsesnumber

Number of pulses. This parameter is required to be set if the mode is set to "toggle" or "pulse".

activePulsenumber

Active pulse length for pulse/toggle mode, in ms

passivePulsenumber

Passive pulse length for pulse/toggle mode, in ms

delaynumber

Delay time for delay mode, in ms

deviceTypestring
networkTypestring
attr*
Example
await API.RWS.SIGNAL.setSignalValue("TestDO1","1");