From b1001bd0e09474db07bf4a1f3ec60903bc4e3fae Mon Sep 17 00:00:00 2001 From: Yannic Labonte Date: Thu, 31 Aug 2023 03:16:20 +0200 Subject: [PATCH] Rebuilt docs --- docs/classes/AbstractService.html | 20 ++++----- docs/classes/CommandService.html | 32 +++++++------- docs/classes/GetStateData.html | 42 +++++++++--------- docs/classes/GetStateDataObject.html | 30 ++++++------- docs/classes/GetStateDataSysInfo.html | 48 ++++++++++----------- docs/classes/GetStateService.html | 44 +++++++++---------- docs/classes/Logger.html | 16 +++---- docs/classes/RelayDataInterpreter.html | 24 +++++------ docs/classes/RelayDataObject.html | 32 +++++++------- docs/classes/SetStateService.html | 24 +++++------ docs/classes/UsrcfgCgiService.html | 38 ++++++++-------- docs/enums/DosageTarget.html | 8 ++-- docs/enums/GetStateCategory.html | 20 ++++----- docs/enums/LogLevel.html | 10 ++--- docs/enums/RelayStateBitMask.html | 6 +-- docs/enums/SetStateValue.html | 8 ++-- docs/interfaces/IGetStateCategories.html | 20 ++++----- docs/interfaces/IGetStateServiceConfig.html | 18 ++++---- docs/interfaces/ILogger.html | 10 ++--- docs/interfaces/IServiceConfig.html | 14 +++--- docs/variables/GETSTATE.html | 2 +- 21 files changed, 233 insertions(+), 233 deletions(-) diff --git a/docs/classes/AbstractService.html b/docs/classes/AbstractService.html index 7f06b3f..86669d4 100644 --- a/docs/classes/AbstractService.html +++ b/docs/classes/AbstractService.html @@ -30,7 +30,7 @@

Hierarchy

  • SetStateService
  • UsrcfgCgiService
  • +
  • Defined in abstract-service.ts:59
  • @@ -77,14 +77,14 @@
    logger: Returns AbstractService
    +
  • Defined in abstract-service.ts:112
  • Properties

    +
  • Defined in abstract-service.ts:60
  • _endpoint: string
    @@ -94,7 +94,7 @@
    +
  • Defined in abstract-service.ts:68
  • _method: Method
    @@ -106,7 +106,7 @@
    +
  • Defined in abstract-service.ts:89
  • _requestHeaders: {
        [key: string]: string;
    }
    @@ -122,7 +122,7 @@

    Type declaration

    [key: string]: string
    +
  • Defined in abstract-service.ts:99
  • log: ILogger
    @@ -130,7 +130,7 @@
    +
  • Defined in abstract-service.ts:104
  • Accessors

    @@ -143,7 +143,7 @@
    +
  • Defined in abstract-service.ts:164
  • +
  • Defined in abstract-service.ts:123
    • @@ -169,7 +169,7 @@

      Returns stringThrows

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141
  • +
  • Defined in abstract-service.ts:60
  • _endpoint: string = '/Command.htm'
    @@ -102,7 +102,7 @@
    +
  • Defined in command.service.ts:31
  • _method: Method = 'get'
    @@ -112,7 +112,7 @@
    +
  • Defined in command.service.ts:37
  • _requestHeaders: {
        [key: string]: string;
    }
    @@ -129,7 +129,7 @@
    [
    +
  • Defined in abstract-service.ts:99
  • log: ILogger
    @@ -138,7 +138,7 @@
    +
  • Defined in abstract-service.ts:104
  • Accessors

    @@ -152,7 +152,7 @@

    Returns AxiosReq

    +
  • Defined in abstract-service.ts:164
  • +
  • Defined in abstract-service.ts:123
    • @@ -180,7 +180,7 @@

      Throws

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141
  • Methods

    @@ -197,7 +197,7 @@
    dosageTarget: dosageDuration: number

    Returns Promise<number>

    +
  • Defined in command.service.ts:84
  • Returns AxiosPromise

    +
  • Defined in command.service.ts:106
  • +
  • Defined in command.service.ts:44
  • +
  • Defined in command.service.ts:72
  • +
  • Defined in command.service.ts:53
  • +
  • Defined in command.service.ts:62
  • +
  • Defined in get-state-data.ts:129
  • parsed: string[][]
    @@ -120,7 +120,7 @@
    +
  • Defined in get-state-data.ts:114
  • raw: string
    @@ -128,7 +128,7 @@
    +
  • Defined in get-state-data.ts:95
  • @@ -138,7 +138,7 @@
    +
  • Defined in get-state-data.ts:122
  • categories: IGetStateCategories = ...
    @@ -152,7 +152,7 @@
    +
  • Defined in get-state-data.ts:149
  • Methods

    @@ -173,7 +173,7 @@

    Returns string

    +
  • Defined in get-state-data.ts:247
  • +
  • Defined in get-state-data.ts:312
  • +
  • Defined in get-state-data.ts:291
  • +
  • Defined in get-state-data.ts:274
  • +
  • Defined in get-state-data.ts:263
  • +
  • Defined in get-state-data.ts:284
  • +
  • Defined in get-state-data.ts:319
  • +
  • Defined in get-state-data.ts:298
  • +
  • Defined in get-state-data.ts:326
  • +
  • Defined in get-state-data.ts:305
  • +
  • Defined in get-state-data.ts:333
  • +
  • Defined in get-state-data.ts:347
  • +
  • Defined in get-state-data-object.ts:52
  • gain: number
    @@ -143,7 +143,7 @@
    +
  • Defined in get-state-data-object.ts:42
  • id: number
    @@ -151,7 +151,7 @@
    +
  • Defined in get-state-data-object.ts:22
  • label: string
    @@ -159,7 +159,7 @@
    +
  • Defined in get-state-data-object.ts:27
  • offset: number
    @@ -167,7 +167,7 @@
    +
  • Defined in get-state-data-object.ts:37
  • raw: number
    @@ -175,7 +175,7 @@
    +
  • Defined in get-state-data-object.ts:32
  • unit: string
    @@ -183,7 +183,7 @@
    +
  • Defined in get-state-data-object.ts:57
  • value: string | number
    @@ -191,7 +191,7 @@
    +
  • Defined in get-state-data-object.ts:47
  • Methods

    @@ -222,7 +222,7 @@

    Returns anyReturns void

    +
  • Defined in get-state-data-object.ts:154
  • +
  • Defined in get-state-data-object.ts:106
  • +
  • Defined in get-state-data-sys-info.ts:97
  • ntpFaultState: number
    @@ -154,7 +154,7 @@
    +
  • Defined in get-state-data-sys-info.ts:63
  • phMinusDosageRelay: number
    @@ -162,7 +162,7 @@
    +
  • Defined in get-state-data-sys-info.ts:107
  • phPlusDosageRelay: number
    @@ -170,7 +170,7 @@
    +
  • Defined in get-state-data-sys-info.ts:102
  • resetRootCause: number
    @@ -187,13 +187,13 @@
    +
  • Defined in get-state-data-sys-info.ts:49
  • time: string
    +
  • Defined in get-state-data-sys-info.ts:25
  • uptime: number
    @@ -201,7 +201,7 @@
    +
  • Defined in get-state-data-sys-info.ts:30
  • version: string
    @@ -209,7 +209,7 @@
    +
  • Defined in get-state-data-sys-info.ts:35
  • Methods

    @@ -232,7 +232,7 @@
    object: Returns number
    +
  • Defined in get-state-data-sys-info.ts:215
  • +
  • Defined in get-state-data-sys-info.ts:234
  • +
  • Defined in get-state-data-sys-info.ts:160
  • +
  • Defined in get-state-data-sys-info.ts:256
  • +
  • Defined in get-state-data-sys-info.ts:191
  • +
  • Defined in get-state-data-sys-info.ts:167
  • +
  • Defined in get-state-data-sys-info.ts:241
  • +
  • Defined in get-state-data-sys-info.ts:249
  • +
  • Defined in get-state-data-sys-info.ts:174
  • +
  • Defined in get-state-data-sys-info.ts:181
  • +
  • Defined in get-state-data-sys-info.ts:132
  • +
  • Defined in get-state-data-sys-info.ts:148
  • +
  • Defined in abstract-service.ts:60
  • _endpoint: string = '/GetState.csv'
    @@ -108,7 +108,7 @@
    +
  • Defined in get-state.service.ts:38
  • _method: Method = 'get'
    @@ -118,7 +118,7 @@
    +
  • Defined in get-state.service.ts:44
  • _requestHeaders: {
        [key: string]: string;
    }
    @@ -135,7 +135,7 @@
    [
    +
  • Defined in abstract-service.ts:99
  • _updateCallback?: ((data) => any)
    @@ -157,7 +157,7 @@
    data: Returns any
    +
  • Defined in get-state.service.ts:72
  • _updateInterval: number
    @@ -166,7 +166,7 @@
    +
  • Defined in get-state.service.ts:66
  • @@ -174,7 +174,7 @@
    +
  • Defined in get-state.service.ts:49
  • log: ILogger
    @@ -183,7 +183,7 @@
    +
  • Defined in abstract-service.ts:104
  • Accessors

    @@ -197,7 +197,7 @@

    Returns AxiosReq

    +
  • Defined in abstract-service.ts:164
  • +
  • Defined in abstract-service.ts:123
    • @@ -225,7 +225,7 @@

      Throws

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141
  • Methods

    @@ -241,7 +241,7 @@
    +
  • Defined in get-state.service.ts:186
  • +
  • Defined in get-state.service.ts:255
  • +
  • Defined in get-state.service.ts:119
  • +
  • Defined in get-state.service.ts:267
  • +
  • Defined in get-state.service.ts:135
  • +
  • Defined in get-state.service.ts:128
  • +
  • Defined in get-state.service.ts:154
  • +
  • Defined in get-state.service.ts:174
  • +
  • Defined in get-state.service.ts:209
  • +
  • Defined in logger.ts:93
    • @@ -127,7 +127,7 @@

      Returns void

    +
  • Defined in logger.ts:126
  • +
  • Defined in logger.ts:104
  • +
  • Defined in logger.ts:84
  • +
  • Defined in logger.ts:115
  • +
  • Defined in get-state-data-object.ts:77
  • category: string
    @@ -102,7 +102,7 @@
    +
  • Defined in get-state-data-object.ts:62
  • categoryId: number
    @@ -113,7 +113,7 @@
    +
  • Defined in get-state-data-object.ts:70
  • displayValue: string
    @@ -122,7 +122,7 @@
    +
  • Defined in get-state-data-object.ts:52
  • gain: number
    @@ -131,7 +131,7 @@
    +
  • Defined in get-state-data-object.ts:42
  • id: number
    @@ -140,7 +140,7 @@
    +
  • Defined in get-state-data-object.ts:22
  • label: string
    @@ -149,7 +149,7 @@
    +
  • Defined in get-state-data-object.ts:27
  • offset: number
    @@ -158,7 +158,7 @@
    +
  • Defined in get-state-data-object.ts:37
  • raw: number
    @@ -167,7 +167,7 @@
    +
  • Defined in get-state-data-object.ts:32
  • unit: string
    @@ -176,7 +176,7 @@
    +
  • Defined in get-state-data-object.ts:57
  • value: string | number
    @@ -185,7 +185,7 @@
    +
  • Defined in get-state-data-object.ts:47
  • Accessors

    @@ -207,7 +207,7 @@
    +
  • Defined in relay-data-object.ts:41
  • Methods

    @@ -239,7 +239,7 @@

    Returns void

    +
  • Defined in get-state-data-object.ts:154
  • +
  • Defined in get-state-data-object.ts:106
  • +
  • Defined in abstract-service.ts:60
  • _endpoint: string = '/SetState.pl'
    @@ -98,7 +98,7 @@
    +
  • Defined in set-state.service.ts:20
  • _method: Method = 'get'
    @@ -108,7 +108,7 @@
    +
  • Defined in set-state.service.ts:26
  • _requestHeaders: {
        [key: string]: string;
    }
    @@ -125,7 +125,7 @@
    [
    +
  • Defined in abstract-service.ts:99
  • log: ILogger
    @@ -134,7 +134,7 @@
    +
  • Defined in abstract-service.ts:104
  • Accessors

    @@ -148,7 +148,7 @@

    Returns AxiosReq

    +
  • Defined in abstract-service.ts:164
  • +
  • Defined in abstract-service.ts:123
    • @@ -176,7 +176,7 @@

      Throws

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141
  • Methods

    @@ -193,7 +193,7 @@
    relayNo: duration: number

    Returns Promise<number>

    +
  • Defined in set-state.service.ts:46
  • +
  • Defined in set-state.service.ts:34
  • +
  • Defined in abstract-service.ts:60
  • _endpoint: string = '/usrcfg.cgi'
    @@ -118,7 +118,7 @@
    +
  • Defined in usrcfg-cgi.service.ts:42
  • _method: Method = 'post'
    @@ -128,7 +128,7 @@
    +
  • Defined in usrcfg-cgi.service.ts:48
  • _requestHeaders: {
        [key: string]: string;
    }
    @@ -145,12 +145,12 @@
    [
    +
  • Defined in abstract-service.ts:99
  • getStateService: GetStateService
    +
  • Defined in usrcfg-cgi.service.ts:52
  • log: ILogger
    @@ -159,17 +159,17 @@
    +
  • Defined in abstract-service.ts:104
  • relayDataInterpreter: RelayDataInterpreter
    +
  • Defined in usrcfg-cgi.service.ts:54
  • stateData: GetStateData
    +
  • Defined in usrcfg-cgi.service.ts:50
  • Accessors

    @@ -183,7 +183,7 @@

    Returns AxiosReq

    +
  • Defined in abstract-service.ts:164
  • +
  • Defined in abstract-service.ts:123
    • @@ -211,7 +211,7 @@

      Throws

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141
  • Methods

    @@ -228,7 +228,7 @@
    relay: state: number

    Returns Promise<number>

    +
  • Defined in usrcfg-cgi.service.ts:126
    • @@ -241,7 +241,7 @@

      Parameters

      bitTupel: [number, number]

    Returns AxiosPromise

    +
  • Defined in usrcfg-cgi.service.ts:175
  • +
  • Defined in usrcfg-cgi.service.ts:101
  • +
  • Defined in usrcfg-cgi.service.ts:92
  • +
  • Defined in usrcfg-cgi.service.ts:83
  • +
  • Defined in usrcfg-cgi.service.ts:111
  • +
  • Defined in command.service.ts:15
  • @@ -40,17 +40,17 @@

    Enumeration Members

    CHLORINE: 0
    +
  • Defined in command.service.ts:16
  • PH_MINUS: 1
    +
  • Defined in command.service.ts:17
  • PH_PLUS: 2
    +
  • Defined in command.service.ts:18
  • +
  • Defined in get-state-data.ts:21
  • @@ -50,7 +50,7 @@
    +
  • Defined in get-state-data.ts:31
  • CANISTER: "canister"
    @@ -58,7 +58,7 @@
    +
  • Defined in get-state-data.ts:61
  • CANISTER_CONSUMPTION: "canisterConsumptions"
    @@ -66,7 +66,7 @@
    +
  • Defined in get-state-data.ts:66
  • DIGITAL_INPUT: "digitalInput"
    @@ -74,7 +74,7 @@
    +
  • Defined in get-state-data.ts:51
  • ELECTRODES: "electrodes"
    @@ -82,7 +82,7 @@
    +
  • Defined in get-state-data.ts:36
  • EXTERNAL_RELAYS: "externalRelays"
    @@ -90,7 +90,7 @@
    +
  • Defined in get-state-data.ts:56
  • RELAYS: "relays"
    @@ -98,7 +98,7 @@
    +
  • Defined in get-state-data.ts:46
  • TEMPERATURES: "temperatures"
    @@ -106,7 +106,7 @@
    +
  • Defined in get-state-data.ts:41
  • TIME: "time"
    @@ -115,7 +115,7 @@
    +
  • Defined in get-state-data.ts:26
  • +
  • Defined in logger.ts:14
  • +
  • Defined in relay-data-interpreter.ts:19
  • @@ -42,12 +42,12 @@

    Enumeration Members

    manual: 2
    +
  • Defined in relay-data-interpreter.ts:21
  • on: 1
    +
  • Defined in relay-data-interpreter.ts:20
  • +
  • Defined in usrcfg-cgi.service.ts:21
  • @@ -40,17 +40,17 @@

    Enumeration Members

    AUTO: 2
    +
  • Defined in usrcfg-cgi.service.ts:24
  • OFF: 0
    +
  • Defined in usrcfg-cgi.service.ts:22
  • ON: 1
    +
  • Defined in usrcfg-cgi.service.ts:23
  • +
  • Defined in abstract-service.ts:24
  • errorTolerance: number
    @@ -74,7 +74,7 @@
    +
  • Defined in get-state.service.ts:25
  • password?: string
    @@ -83,7 +83,7 @@
    +
  • Defined in abstract-service.ts:34
  • requestHeaders?: {
        [key: string]: string;
    }
    @@ -94,7 +94,7 @@

    Type declaration

    [key: string]: string
    +
  • Defined in abstract-service.ts:17
  • timeout: number
    @@ -103,7 +103,7 @@
    +
  • Defined in abstract-service.ts:44
  • updateInterval: number
    @@ -111,7 +111,7 @@
    +
  • Defined in get-state.service.ts:20
  • username?: string
    @@ -120,7 +120,7 @@
    +
  • Defined in abstract-service.ts:29
  • +
  • Defined in abstract-service.ts:17
  • timeout: number
    @@ -86,7 +86,7 @@
    +
  • Defined in abstract-service.ts:44
  • username?: string
    @@ -94,7 +94,7 @@
    +
  • Defined in abstract-service.ts:29
  • +
  • Defined in mock-state.ts:13