Class CommandService

The CommandService uses the /Command.htm endpoint of the ProCon.IP pool controller to turn on manual dosage for a given amount of time/seconds.

Hierarchy (view full)

Constructors

constructor

Properties

_config _endpoint _method _requestHeaders log

Accessors

axiosRequestConfig baseUrl url

Methods

setChlorineDosage setDosage setPhMinusDosage setPhPlusDosage

Constructors

constructor

Properties

Protected_config

_config: IServiceConfig

_endpoint

_endpoint: string = '/Command.htm'

Specific service endpoint.

A path relative to the IServiceConfig.controllerUrl.

_method

_method: Method = 'get'

HTTP request method for this specific service endpoint. See: axios/Method

Protected_requestHeaders

_requestHeaders: {
    [key: string]: string;
}

Custom HTTP headers.

Custom headers can be defined in form of a key value pair.

this._requestHeaders["Cache-Control"] = "no-cache";

Protectedlog

log: ILogger

Logger which will be used for all logging events.

Accessors

ProtectedaxiosRequestConfig

  • get axiosRequestConfig(): AxiosRequestConfig<any>

  • Get an axios/AxiosRequestConfig object.

    Returns AxiosRequestConfig<any>

baseUrl

url

  • get url(): string

  • Get the webservice url (joined base url and endpoint).

    Returns string

    URL string (joined base url and endpoint).

Methods

setChlorineDosage

  • setChlorineDosage(dosageTime): Promise<number>

  • Set manuel chlorine dosage for given amount of time in seconds.

    Parameters

    • dosageTime: number

      Dosage duration in seconds.

    Returns Promise<number>

setDosage

  • setDosage(dosageTarget, dosageDuration): Promise<number>

  • Set the desired relay state.

    Parameters

    • dosageTarget: DosageTarget

      Dosage target (0 = chlorine, 1 = pH minus, 2 = pH plus).

    • dosageDuration: number

      Desired duration in seconds.

    Returns Promise<number>

setPhMinusDosage

  • setPhMinusDosage(dosageTime): Promise<number>

  • Set manuel pH minus dosage for given amount of time in seconds.

    Parameters

    • dosageTime: number

      Dosage duration in seconds.

    Returns Promise<number>

setPhPlusDosage

  • setPhPlusDosage(dosageTime): Promise<number>

  • Set manuel pH plus dosage for given amount of time in seconds.

    Parameters

    • dosageTime: number

      Dosage duration in seconds.

    Returns Promise<number>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods