Class GetStateDataSysInfo

A class for an object representation of the first line of the /GetState.csv API endpoint response. This line has a special role and no relation to the subsequent lines of the CSV file.

Indexable

[key: string]: unknown
Making GetStateDataSysInfo objects extensible, also allows accessing object keys using string variables.

Constructors

constructor

new GetStateDataSysInfo(data?): GetStateDataSysInfo
Initialize a new GetStateDataSysInfo object.
Parameters
- Optionaldata: string[][]
  Parsed response CSV of the /GetState.csv endpoint as 2-dimensional array (see: GetStateData.parsed)
Returns GetStateDataSysInfo
- Defined in get-state-data-sys-info.ts:120

Properties

chlorineDosageRelay

chlorineDosageRelay: number

Chlorine dosage relay id.

configOtherEnable

configOtherEnable: number

Other config flags.

Values are documented bitwise as follows:

Bit 8: Extension an SPI (0) oder DMX (1)
Bit 7: Repeated Mails
Bit 6: FlowSensor
Bit 5: High Bus Load
Bit 4: Relay Extension
Bit 3: Avatar
Bit 2: DMX
Bit 1: SD-Card
Bit 0: TCP-IP Boost

See manual for more information or updates: http://www.pooldigital.de/trm/TRM_ProConIP.pdf

dosageControl

dosageControl: number

Dosage control information flags.

Values are documented bitwise as follows:

Bit 12: pH+ enabled
Bit 11..9: reserved
Bit 8: pH- enabled
Bit 7..5: reserved
Bit 4: Cl liquid || Elektrolysis
Bit 3..1: reserved
Bit 0: CL enabled

See manual for more information or updates: http://www.pooldigital.de/trm/TRM_ProConIP.pdf

ntpFaultState

ntpFaultState: number

NTP fault state.

Values are documented bitwise as follows:

Bit 16: NTP available
Bit 15..3: reserved
Bit 2: Error
Bit 1: Warning
Bit 0: Logfile

See manual for more information or updates: http://www.pooldigital.de/trm/TRM_ProConIP.pdf

phMinusDosageRelay

phMinusDosageRelay: number

pH- dosage relay id.

phPlusDosageRelay

phPlusDosageRelay: number

pH+ dosage relay id.

resetRootCause

resetRootCause: number

Reset root cause.

Values are documented bitwise as follows:

Bit 4: External reset
Bit 3: PowerUp reset
Bit 2: Brown out reset
Bit 1: Watchdog reset
Bit 0: SW reset

See manual for more information or updates: http://www.pooldigital.de/trm/TRM_ProConIP.pdf

time

time: string

uptime

uptime: number

Uptime of the ProCon.IP controller at the time this data was requested.

version

version: string

Current firmware version string.

Methods

getDosageRelay

getDosageRelay(object): number
Returns the configured dosage relay for a given GetStateDataObject object.
Parameters
- object: GetStateDataObject
  The GetStateDataObject to check, should be a GetStateData.categories.canister or a GetStateData.categories.canisterConsumptions object.
Returns number
- Defined in get-state-data-sys-info.ts:215

isAvatarEnabled

isAvatarEnabled(): boolean
Check whether generation of an avatar image is enabled or not.

Returns boolean
- Defined in get-state-data-sys-info.ts:234

isChlorineDosageEnabled

isChlorineDosageEnabled(): boolean
Check whether the automated chlorine dosage is enabled.

Returns boolean
- Defined in get-state-data-sys-info.ts:160

isDmxEnabled

isDmxEnabled(): boolean
Check whether DMX is enabled or not.

Returns boolean
- Defined in get-state-data-sys-info.ts:256

isDosageEnabled

isDosageEnabled(object): boolean
Check whether the given GetStateDataObject object is a dosage control relay.
Parameters
- object: GetStateDataObject
  The GetStateDataObject to check.
Returns boolean
- Defined in get-state-data-sys-info.ts:191

isElectrolysis

isElectrolysis(): boolean
Checks if the chlorine dosage device is configured as an electrolysis cell or a pump.

Returns boolean
- Defined in get-state-data-sys-info.ts:167

isExtRelaysEnabled

isExtRelaysEnabled(): boolean
Check whether external relays are enabled or not.

Returns boolean
- Defined in get-state-data-sys-info.ts:241

isFlowSensorEnabled

isFlowSensorEnabled(): boolean
Check whether the digitial input 0 is configured as a flow sensor or not.

Returns boolean
- Defined in get-state-data-sys-info.ts:249

isPhMinusDosageEnabled

isPhMinusDosageEnabled(): boolean
Check whether the automated pH- dosage is enabled.

Returns boolean
- Defined in get-state-data-sys-info.ts:174

isPhPlusDosageEnabled

isPhPlusDosageEnabled(): boolean
Check whether the automated pH+ dosage is enabled.

Returns boolean
- Defined in get-state-data-sys-info.ts:181

setValuesFromArray

setValuesFromArray(data): void
Set values from based on a 2-dimensional array structure.
Parameters
- data: string[][]
  Parsed response CSV of the /GetState.csv endpoint as 2-dimensional array (see: GetStateData.parsed)
Returns void
- Defined in get-state-data-sys-info.ts:132

toArrayOfObjects

toArrayOfObjects(): {
key: string;
value: string;
}[]
Converts the object instance to a simple array of objects for better handling/iteration.

Returns {
key: string;
value: string;
}[]
- Defined in get-state-data-sys-info.ts:148

Class GetStateDataSysInfo

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GetStateDataSysInfo

Properties

chlorineDosageRelay

configOtherEnable

dosageControl

ntpFaultState

phMinusDosageRelay

phPlusDosageRelay

resetRootCause

time

uptime

version

Methods

getDosageRelay

Parameters

Returns number

isAvatarEnabled

Returns boolean

isChlorineDosageEnabled

Returns boolean

isDmxEnabled

Returns boolean

isDosageEnabled

Parameters

Returns boolean

isElectrolysis

Returns boolean

isExtRelaysEnabled

Returns boolean

isFlowSensorEnabled

Returns boolean

isPhMinusDosageEnabled

Returns boolean

isPhPlusDosageEnabled

Returns boolean

setValuesFromArray

Parameters

Returns void

toArrayOfObjects

Returns { key: string; value: string; }[]

Settings

On This Page

Returns {
key: string;
value: string;
}[]