procon-ip - v2.0.0
    Preparing search index...

    Class UsrcfgCgiService

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _endpoint: string = '/usrcfg.cgi'

    Endpoint path relative to IServiceConfig.controllerUrl.

    _method: HttpMethod = 'POST'

    HTTP method for this endpoint.

    _requestHeaders: Record<string, string>
    log: ILogger

    Accessors

    Methods

    • Perform the HTTP request configured for this service.

      The HTTP method, Authorization header (when basicAuth is enabled), and signal are always controlled by this method and cannot be overridden via init: an explicit init.method is ignored, and a caller-supplied init.signal is composed (via AbortSignal.any) with the internal timeout signal rather than replacing it. An external abort re-throws the original AbortError so callers can distinguish it from a timeout.

      Any other fetch init field (body, headers, cache, etc.) is passed through to fetch; caller headers are merged on top of the service's _requestHeaders.

      Parameters

      • init: RequestInit & { params?: Record<string, string | number> } = {}

        Optional fetch init plus a params shortcut. params, if provided, is serialised as key=value&key=value and appended to the URL without URL-encoding — values must already be URL-safe (numbers and ASCII letters are fine; spaces / special chars are not). This matches the wire format the controller's legacy endpoints expect (e.g. literal commas in ?MAN_DOSAGE=0,60).

      Returns Promise<Response>

      The raw Response for the caller to parse.

      BadCredentialsError on HTTP 401 or 403.

      BadStatusCodeError on any other 4xx/5xx response.

      RequestTimeoutError if the request exceeds the configured timeout.

    • Switch the given relay to manual ON.

      Parameters

      Returns Promise<void>

      import {
      GetStateService, UsrcfgCgiService, RelayDataInterpreter,
      GetStateCategory, Logger,
      } from 'procon-ip';

      const log = new Logger();
      const config = { controllerUrl: 'http://192.168.2.3', basicAuth: false,
      timeout: 5000, updateInterval: 5000, errorTolerance: 2 };
      const get = new GetStateService(config, log);
      await get.update();
      const relays = new UsrcfgCgiService(config, log, get, new RelayDataInterpreter(log));
      const [firstRelay] = get.data.getDataObjectsByCategory(GetStateCategory.RELAYS);
      if (!firstRelay) throw new Error('no relays in fixture');
      await relays.setOn(firstRelay);