Class SetStateService

The CommandService uses the /SetState.pl endpoint of the ProCon.IP pool controller to turn on relays for a specified time span.

Hierarchy (view full)

Constructors

constructor

Properties

_config _endpoint _method _requestHeaders log

Accessors

axiosRequestConfig baseUrl url

Methods

setTimer

Constructors

constructor

Properties

Protected_config

_config: IServiceConfig

_endpoint

_endpoint: string = '/SetState.pl'

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

setTimer

  • setTimer(relayNo, duration): Promise<number>

  • Set relay on-timer.

    Parameters

    • relayNo: number

      Target relay number (count starting from 1).

    • duration: number

      Desired timer duration in seconds.

    Returns Promise<number>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods