Class RelayDataInterpreter

The RelayDataInterpreter is a helper for all the binary operations that are necessary to read and write relay states.

Index

Constructors

Properties

Methods

evaluate isAuto isManual isOff isOn setAuto setOff setOn

Constructors

constructor

new RelayDataInterpreter(logger: ILogger): RelayDataInterpreter
Initialize a new RelayDataInterpreter.
Parameters
- logger: ILogger
Returns RelayDataInterpreter
- Defined in src/relay-data-interpreter.ts:42

Properties

bitStates

bitStates: [number, number]

A pair of bit patterns in decimal representation according to the way the /usrcfg.cgi endpoints wants its values.

Methods

evaluate

evaluate(stateData: GetStateData): RelayDataInterpreter
Evaluate the current relay states and set the bitStates accordingly.

The determined values are used to set the switching parameters. Therefore, the input values should be as up-to-date as possible. Otherwise, a change on one relay will reset all other relays based on the stateData.

Important This method should be called before using any of the set operations (setOn, setOff, setAuto).
Parameters
- stateData: GetStateData
  The most recent GetStateData instance.
Returns RelayDataInterpreter
- Defined in src/relay-data-interpreter.ts:59

isAuto

isAuto(relay: GetStateDataObject): boolean
True if the given relay (GetStateDataObject) is currently in auto mode.
Parameters
- relay: GetStateDataObject
Returns boolean
- Defined in src/relay-data-interpreter.ts:122

isManual

isManual(relay: GetStateDataObject): boolean
True if the given relay (GetStateDataObject) is currently not in auto mode.
Parameters
- relay: GetStateDataObject
Returns boolean
- Defined in src/relay-data-interpreter.ts:110

isOff

isOff(relay: GetStateDataObject): boolean
True if the given relay (GetStateDataObject) is currently switched off.
Parameters
- relay: GetStateDataObject
Returns boolean
- Defined in src/relay-data-interpreter.ts:100

isOn

isOn(relay: GetStateDataObject): boolean
True if the given relay (GetStateDataObject) is currently switched on.
Parameters
- relay: GetStateDataObject
Returns boolean
- Defined in src/relay-data-interpreter.ts:88

setAuto

setAuto(relay: GetStateDataObject): [number, number]
Return the appropriate bit patterns for the /usrcfg.cgi endpoint to switch the given relay (GetStateDataObject) into auto mode.
Parameters
- relay: GetStateDataObject
Returns [number, number]
- Defined in src/relay-data-interpreter.ts:166

setOff

setOff(relay: GetStateDataObject): [number, number]
Return the appropriate bit patterns for the /usrcfg.cgi endpoint to switch the given relay (GetStateDataObject) off.
Parameters
- relay: GetStateDataObject
Returns [number, number]
- Defined in src/relay-data-interpreter.ts:149

setOn

setOn(relay: GetStateDataObject): [number, number]
Return the appropriate bit patterns for the /usrcfg.cgi endpoint to switch the given relay (GetStateDataObject) on.
Parameters
- relay: GetStateDataObject
Returns [number, number]
- Defined in src/relay-data-interpreter.ts:132