AxisPTZ.js

Filename	Percent	Threshold	Total	Covered	Uncovered
src/ptz/AxisPTZ.js	66.27%	80%	249	165	84

// @ts-check
// SPDX-License-Identifier: Zlib
// SPDX-FileCopyrightText: 2024 CERN (home.cern)
// SPDX-FileContributor: Author: Sylvain Fargier <sylvain.fargier@cern.ch>

import { isNil } from "@cern/nodash";
import d from "debug";
import axios from "axios";
import PTZDevice from "./PTZDevice.js";

const debug = d("cam:ptz:axis");

/**
 * @typedef {import('express').Request} Request
 * @typedef {import('express').IRouter} expressIRouter
 * @typedef {import('express-ws').WithWebsocketMethod & expressIRouter} IRouter
 */

const ControlParams = [ "pan", "tilt", "zoom", "iris", "focus", "brightness" ];
const ExtraControlParams = [
  "backlight", "ircutfilter", "imagerotation", "speed", "gotodevicepreset",
  "gotopresetname", "auxiliary", "continuousbrightnessmove",
  "continuousirismove", "continuousfocusmove", "continuouszoommove",
  "continuouspantiltmove", "autoiris", "autofocus", "imageheight", "imagewidth",
  "areazoom", "center", "whoami", "camera"
];

class AxisPTZ extends PTZDevice {
  /**
   *
   * @param {any} data
   */
  _parseResponse(data) {
    return ((typeof data === "string") ? data : "").split("\n").reduce((ret, line) => {
      const pos = line.indexOf("=");
      if (pos >= 0) {
        ret[line.slice(0, pos).trim()] = line.slice(pos + 1).trim();
      }
      return ret;
    }, {});
  }

  async getLimits() {
    const opts = { timeout: 5000 };
    if (this.user) {
      opts.auth = { username: this.user, password: this.pass };
    }

    const ret = await axios.get(
      `${this.src}/axis-cgi/com/ptz.cgi?query=limits`, opts)
    .catch((ret) => {
      debug("get limits error: %s", ret?.response?.data ?? "?");
      throw new Error("request failed with status: " + ret?.response?.status);
    });
    return Object.entries(this._parseResponse(ret.data)).reduce(
      (ret, [ key, value ]) => {
        ret[key] = Number(value);
        return ret;
      }, {});
  }

  async getPosition() {
    const opts = { timeout: 5000 };
    if (this.user) {
      opts.auth = { username: this.user, password: this.pass };
    }

    const ret = await axios.get(
      `${this.src}/axis-cgi/com/ptz.cgi?query=position`, opts)
    .catch((ret) => {
      debug("get position error: %s", ret?.response?.data ?? "?");
      throw new Error("request failed with status: " + ret?.response?.status);
    });
    return Object.entries(this._parseResponse(ret.data)).reduce(
      (ret, [ key, v ]) => {
        if (key === "autofocus" || key === "autoiris") {
          ret[key] = (v === "on");
        }
        else {
          ret[key] = Number(v);
        }
        return ret;
      }, {});
  }

  /**
   * @param {any} params
   * @param {any} query
   */
  _prepareQuery(params, query) {
    (ExtraControlParams ?? []).forEach((p) => {
      const value = params[p];
      if (isNil(value)) { return; }
      else if (value === true || value === false) {
        query[p] = value ? "on" : "off";
      }
      else {
        query[p] = value;
      }
    });
  }

  async putPosition(params) {
    if (!(params instanceof Object)) { throw new Error("invalid arguments: " + params); }

    const opts = { timeout: 5000 };
    if (this.user) {
      opts.auth = { username: this.user, password: this.pass };
    }

    opts.params = ControlParams.reduce((ret, name) => {
      if (!isNil(params[name])) {
        ret[name] = params[name];
      }
      return ret;
    }, {});

    this._prepareQuery(params, opts.params);

    await axios.get(`${this.src}/axis-cgi/com/ptz.cgi`, opts)
    .catch((ret) => {
      debug("put position error: %s", ret?.response?.data ?? "?");
      throw new Error("request failed with status: " + ret?.response?.status);
    });
    return true;
  }

  async postPosition(params) {
    if (!(params instanceof Object)) { throw new Error("invalid arguments: " + params); }

    const opts = { timeout: 5000 };
    if (this.user) {
      opts.auth = { username: this.user, password: this.pass };
    }

    opts.params = ControlParams.reduce((ret, name) => {
      if (!isNil(params[name])) {
        ret["r" + name] = params[name];
      }
      return ret;
    }, {});
    this._prepareQuery(params, opts.params);
    await axios.get(`${this.src}/axis-cgi/com/ptz.cgi`, opts)
    .catch((ret) => {
      debug("post position error: %s", ret?.response?.data ?? "?");
      throw new Error("request failed with status: " + ret?.response?.status);
    });
    return true;
  }
}

export default AxisPTZ;

[{"file":"src/ptz/AxisPTZ.js","line":32,"character":17,"text":"data","kind":1},{"file":"src/ptz/AxisPTZ.js","line":33,"character":20,"text":"data","kind":1},{"file":"src/ptz/AxisPTZ.js","line":44,"character":13,"text":"user","kind":1},{"file":"src/ptz/AxisPTZ.js","line":45,"character":20,"text":"username","kind":1},{"file":"src/ptz/AxisPTZ.js","line":45,"character":35,"text":"user","kind":1},{"file":"src/ptz/AxisPTZ.js","line":45,"character":41,"text":"password","kind":1},{"file":"src/ptz/AxisPTZ.js","line":45,"character":56,"text":"pass","kind":1},{"file":"src/ptz/AxisPTZ.js","line":49,"character":14,"text":"src","kind":1},{"file":"src/ptz/AxisPTZ.js","line":50,"character":12,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":51,"character":36,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":51,"character":41,"text":"response","kind":1},{"file":"src/ptz/AxisPTZ.js","line":51,"character":51,"text":"data","kind":1},{"file":"src/ptz/AxisPTZ.js","line":52,"character":55,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":52,"character":60,"text":"response","kind":1},{"file":"src/ptz/AxisPTZ.js","line":52,"character":70,"text":"status","kind":1},{"file":"src/ptz/AxisPTZ.js","line":54,"character":50,"text":"data","kind":1},{"file":"src/ptz/AxisPTZ.js","line":55,"character":19,"text":"value","kind":1},{"file":"src/ptz/AxisPTZ.js","line":56,"character":26,"text":"value","kind":1},{"file":"src/ptz/AxisPTZ.js","line":63,"character":13,"text":"user","kind":1},{"file":"src/ptz/AxisPTZ.js","line":64,"character":20,"text":"username","kind":1},{"file":"src/ptz/AxisPTZ.js","line":64,"character":35,"text":"user","kind":1},{"file":"src/ptz/AxisPTZ.js","line":64,"character":41,"text":"password","kind":1},{"file":"src/ptz/AxisPTZ.js","line":64,"character":56,"text":"pass","kind":1},{"file":"src/ptz/AxisPTZ.js","line":68,"character":14,"text":"src","kind":1},{"file":"src/ptz/AxisPTZ.js","line":69,"character":12,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":70,"character":38,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":70,"character":43,"text":"response","kind":1},{"file":"src/ptz/AxisPTZ.js","line":70,"character":53,"text":"data","kind":1},{"file":"src/ptz/AxisPTZ.js","line":71,"character":55,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":71,"character":60,"text":"response","kind":1},{"file":"src/ptz/AxisPTZ.js","line":71,"character":70,"text":"status","kind":1},{"file":"src/ptz/AxisPTZ.js","line":73,"character":50,"text":"data","kind":1},{"file":"src/ptz/AxisPTZ.js","line":74,"character":19,"text":"v","kind":1},{"file":"src/ptz/AxisPTZ.js","line":76,"character":22,"text":"v","kind":1},{"file":"src/ptz/AxisPTZ.js","line":79,"character":28,"text":"v","kind":1},{"file":"src/ptz/AxisPTZ.js","line":89,"character":16,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":89,"character":24,"text":"query","kind":1},{"file":"src/ptz/AxisPTZ.js","line":91,"character":12,"text":"value","kind":1},{"file":"src/ptz/AxisPTZ.js","line":91,"character":20,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":92,"character":16,"text":"value","kind":1},{"file":"src/ptz/AxisPTZ.js","line":93,"character":15,"text":"value","kind":1},{"file":"src/ptz/AxisPTZ.js","line":93,"character":33,"text":"value","kind":1},{"file":"src/ptz/AxisPTZ.js","line":94,"character":8,"text":"query","kind":1},{"file":"src/ptz/AxisPTZ.js","line":94,"character":19,"text":"value","kind":1},{"file":"src/ptz/AxisPTZ.js","line":97,"character":8,"text":"query","kind":1},{"file":"src/ptz/AxisPTZ.js","line":97,"character":19,"text":"value","kind":1},{"file":"src/ptz/AxisPTZ.js","line":102,"character":20,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":103,"character":10,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":103,"character":79,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":106,"character":13,"text":"user","kind":1},{"file":"src/ptz/AxisPTZ.js","line":107,"character":20,"text":"username","kind":1},{"file":"src/ptz/AxisPTZ.js","line":107,"character":35,"text":"user","kind":1},{"file":"src/ptz/AxisPTZ.js","line":107,"character":41,"text":"password","kind":1},{"file":"src/ptz/AxisPTZ.js","line":107,"character":56,"text":"pass","kind":1},{"file":"src/ptz/AxisPTZ.js","line":111,"character":17,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":112,"character":20,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":117,"character":23,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":119,"character":28,"text":"src","kind":1},{"file":"src/ptz/AxisPTZ.js","line":120,"character":12,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":121,"character":38,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":121,"character":43,"text":"response","kind":1},{"file":"src/ptz/AxisPTZ.js","line":121,"character":53,"text":"data","kind":1},{"file":"src/ptz/AxisPTZ.js","line":122,"character":55,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":122,"character":60,"text":"response","kind":1},{"file":"src/ptz/AxisPTZ.js","line":122,"character":70,"text":"status","kind":1},{"file":"src/ptz/AxisPTZ.js","line":127,"character":21,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":128,"character":10,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":128,"character":79,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":131,"character":13,"text":"user","kind":1},{"file":"src/ptz/AxisPTZ.js","line":132,"character":20,"text":"username","kind":1},{"file":"src/ptz/AxisPTZ.js","line":132,"character":35,"text":"user","kind":1},{"file":"src/ptz/AxisPTZ.js","line":132,"character":41,"text":"password","kind":1},{"file":"src/ptz/AxisPTZ.js","line":132,"character":56,"text":"pass","kind":1},{"file":"src/ptz/AxisPTZ.js","line":136,"character":17,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":137,"character":26,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":141,"character":23,"text":"params","kind":1},{"file":"src/ptz/AxisPTZ.js","line":142,"character":28,"text":"src","kind":1},{"file":"src/ptz/AxisPTZ.js","line":143,"character":12,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":144,"character":39,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":144,"character":44,"text":"response","kind":1},{"file":"src/ptz/AxisPTZ.js","line":144,"character":54,"text":"data","kind":1},{"file":"src/ptz/AxisPTZ.js","line":145,"character":55,"text":"ret","kind":1},{"file":"src/ptz/AxisPTZ.js","line":145,"character":60,"text":"response","kind":1},{"file":"src/ptz/AxisPTZ.js","line":145,"character":70,"text":"status","kind":1}]

TypeScript coverage report