motion-master-client 0.0.13 → 0.0.15

package/package.json

@@ -1,6 +1,21 @@
 {
   "name": "motion-master-client",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "type": "commonjs",
-  "description": "A library and CLI program used for communicating with Motion Master."
+  "description": "A library and CLI program used for communicating with Motion Master.",
+  "dependencies": {
+    "fast-deep-equal": "^3.1.3",
+    "lodash": "^4.17.21",
+    "long": "5.2.1",
+    "protobufjs": "^7.2.3",
+    "roarr": "^7.14.1",
+    "rxjs": "~7.5.0",
+    "semver": "7.3.8",
+    "uuid": "^9.0.0"
+  },
+  "peerDependencies": {
+    "tslib": "^2.4.0"
+  },
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
 }

package/src/index.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/cia402"), exports);
+tslib_1.__exportStar(require("./lib/device-log-line"), exports);
+tslib_1.__exportStar(require("./lib/device-parameter"), exports);
+tslib_1.__exportStar(require("./lib/hardware-description"), exports);
+tslib_1.__exportStar(require("./lib/monitoring-config"), exports);
+tslib_1.__exportStar(require("./lib/monitoring-entry"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-client"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-pub-sub-client"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-pub-sub-socket"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-pub-sub-web-socket"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-pub-sub-worker-socket"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-req-res-client"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-req-res-socket"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-req-res-web-socket"), exports);
+tslib_1.__exportStar(require("./lib/motion-master-req-res-worker-socket"), exports);
+tslib_1.__exportStar(require("./lib/operators"), exports);
+tslib_1.__exportStar(require("./lib/options"), exports);
+tslib_1.__exportStar(require("./lib/parameter"), exports);
+tslib_1.__exportStar(require("./lib/request-status-resolver"), exports);
+tslib_1.__exportStar(require("./lib/system-log-line"), exports);
+tslib_1.__exportStar(require("./lib/types"), exports);
+tslib_1.__exportStar(require("./lib/urls"), exports);
+tslib_1.__exportStar(require("./lib/util"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/motion-master-client/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,gEAAsC;AACtC,iEAAuC;AACvC,qEAA2C;AAC3C,kEAAwC;AACxC,iEAAuC;AACvC,qEAA2C;AAC3C,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,0DAAgC;AAChC,wDAA8B;AAC9B,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,sDAA4B;AAC5B,qDAA2B;AAC3B,qDAA2B"}

package/src/lib/cia402.d.ts

@@ -0,0 +1,30 @@
+export declare enum CiA402State {
+    NOT_READY_TO_SWITCH_ON = 0,
+    SWITCH_ON_DISABLED = 1,
+    READY_TO_SWITCH_ON = 2,
+    SWITCHED_ON = 3,
+    OPERATION_ENABLED = 4,
+    QUICK_STOP_ACTIVE = 5,
+    FAULT_REACTION_ACTIVE = 6,
+    FAULT = 7
+}
+export declare const cia402StateLabels: string[];
+export declare const statuswordToCia402StateMap: Map<number, CiA402State>;
+export declare function getCia402StateFromStatusword(statusword: number): CiA402State | undefined;
+export declare function isInternalLimitActive(statusword: number): boolean;
+export declare enum ModesOfOperation {
+    OPEN_LOOP_FIELD_MODE = -3,
+    DIAGNOSTICS_MODE = -2,
+    COGGING_COMPENSATION_RECORDING_MODE = -1,
+    NO_MODE_ASSIGNED = 0,
+    PROFILE_POSITION_MODE = 1,
+    PROFILE_VELOCITY_MODE = 3,
+    TORQUE_PROFILE_MODE = 4,
+    HOMING_MODE = 6,
+    CYCLIC_SYNC_POSITION_MODE = 8,
+    CYCLIC_SYNC_VELOCITY_MODE = 9,
+    CYCLIC_SYNC_TORQUE_MODE = 10
+}
+export declare const controlwordBits: string[];
+export declare const statuswordBits: string[];
+export declare const supportedDriveModesBits: string[];

package/src/lib/cia402.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.supportedDriveModesBits = exports.statuswordBits = exports.controlwordBits = exports.ModesOfOperation = exports.isInternalLimitActive = exports.getCia402StateFromStatusword = exports.statuswordToCia402StateMap = exports.cia402StateLabels = exports.CiA402State = void 0;
+var CiA402State;
+(function (CiA402State) {
+    CiA402State[CiA402State["NOT_READY_TO_SWITCH_ON"] = 0] = "NOT_READY_TO_SWITCH_ON";
+    CiA402State[CiA402State["SWITCH_ON_DISABLED"] = 1] = "SWITCH_ON_DISABLED";
+    CiA402State[CiA402State["READY_TO_SWITCH_ON"] = 2] = "READY_TO_SWITCH_ON";
+    CiA402State[CiA402State["SWITCHED_ON"] = 3] = "SWITCHED_ON";
+    CiA402State[CiA402State["OPERATION_ENABLED"] = 4] = "OPERATION_ENABLED";
+    CiA402State[CiA402State["QUICK_STOP_ACTIVE"] = 5] = "QUICK_STOP_ACTIVE";
+    CiA402State[CiA402State["FAULT_REACTION_ACTIVE"] = 6] = "FAULT_REACTION_ACTIVE";
+    CiA402State[CiA402State["FAULT"] = 7] = "FAULT";
+})(CiA402State = exports.CiA402State || (exports.CiA402State = {}));
+exports.cia402StateLabels = [
+    'NOT READY TO SWITCH ON',
+    'SWITCH ON DISABLED',
+    'READY TO SWITCH ON',
+    'SWITCHED ON',
+    'OPERATION ENABLED',
+    'QUICK STOP ACTIVE',
+    'FAULT REACTION ACTIVE',
+    'FAULT',
+];
+exports.statuswordToCia402StateMap = new Map([
+    [0b00000000, CiA402State.NOT_READY_TO_SWITCH_ON],
+    [0b01000000, CiA402State.SWITCH_ON_DISABLED],
+    [0b00100001, CiA402State.READY_TO_SWITCH_ON],
+    [0b00100011, CiA402State.SWITCHED_ON],
+    [0b00100111, CiA402State.OPERATION_ENABLED],
+    [0b00000111, CiA402State.QUICK_STOP_ACTIVE],
+    [0b00001111, CiA402State.FAULT_REACTION_ACTIVE],
+    [0b00001000, CiA402State.FAULT],
+]);
+function getCia402StateFromStatusword(statusword) {
+    return exports.statuswordToCia402StateMap.get(statusword & 0b01101111)
+        || exports.statuswordToCia402StateMap.get(statusword & 0b01001111);
+}
+exports.getCia402StateFromStatusword = getCia402StateFromStatusword;
+function isInternalLimitActive(statusword) {
+    return (0x800 & statusword) === 0x800;
+}
+exports.isInternalLimitActive = isInternalLimitActive;
+var ModesOfOperation;
+(function (ModesOfOperation) {
+    ModesOfOperation[ModesOfOperation["OPEN_LOOP_FIELD_MODE"] = -3] = "OPEN_LOOP_FIELD_MODE";
+    ModesOfOperation[ModesOfOperation["DIAGNOSTICS_MODE"] = -2] = "DIAGNOSTICS_MODE";
+    ModesOfOperation[ModesOfOperation["COGGING_COMPENSATION_RECORDING_MODE"] = -1] = "COGGING_COMPENSATION_RECORDING_MODE";
+    ModesOfOperation[ModesOfOperation["NO_MODE_ASSIGNED"] = 0] = "NO_MODE_ASSIGNED";
+    ModesOfOperation[ModesOfOperation["PROFILE_POSITION_MODE"] = 1] = "PROFILE_POSITION_MODE";
+    ModesOfOperation[ModesOfOperation["PROFILE_VELOCITY_MODE"] = 3] = "PROFILE_VELOCITY_MODE";
+    ModesOfOperation[ModesOfOperation["TORQUE_PROFILE_MODE"] = 4] = "TORQUE_PROFILE_MODE";
+    ModesOfOperation[ModesOfOperation["HOMING_MODE"] = 6] = "HOMING_MODE";
+    ModesOfOperation[ModesOfOperation["CYCLIC_SYNC_POSITION_MODE"] = 8] = "CYCLIC_SYNC_POSITION_MODE";
+    ModesOfOperation[ModesOfOperation["CYCLIC_SYNC_VELOCITY_MODE"] = 9] = "CYCLIC_SYNC_VELOCITY_MODE";
+    ModesOfOperation[ModesOfOperation["CYCLIC_SYNC_TORQUE_MODE"] = 10] = "CYCLIC_SYNC_TORQUE_MODE";
+})(ModesOfOperation = exports.ModesOfOperation || (exports.ModesOfOperation = {}));
+exports.controlwordBits = [
+    'so = switch on',
+    'ev = enable voltage',
+    'qs = quick stop',
+    'eo = enable operation',
+    'oms = operation mode specific',
+    'oms = operation mode specific',
+    'oms = operation mode specific',
+    'fr = fault reset',
+    'h = halt',
+    'oms = operation mode specific',
+    'r = reserved',
+    'ms = manufacturer-specific',
+    'ms = manufacturer-specific',
+    'ms = manufacturer-specific',
+    'ms = manufacturer-specific',
+    'ms = manufacturer-specific',
+];
+exports.statuswordBits = [
+    'rtso = ready to switch on',
+    'so = switched on',
+    'oe = operation enabled',
+    'f = fault',
+    've = voltage enabled',
+    'qs = quick stop',
+    'sod = switch on disabled',
+    'w = warning',
+    'ms = manufacturer-specific',
+    'rm = remote',
+    'tr = target reached',
+    'ila = internal limit active',
+    'oms = operation-mode-specific',
+    'oms = operation-mode-specific',
+    'ms = manufacturer-specific',
+    'ms = manufacturer-specific',
+];
+exports.supportedDriveModesBits = [
+    'pp = profile position mode',
+    'vl = velocity mode',
+    'pv = profile velocity mode',
+    'tq = torque mode',
+    'r = reserved',
+    'hm = homing mode',
+    'ip = interpolated position mode',
+    'csp = cyclic synchronous position mode',
+    'csv = cyclic synchronous velocity mode',
+    'cst = cyclic synchronous torque mode',
+    'r = reserved',
+    'r = reserved',
+    'r = reserved',
+    'r = reserved',
+    'r = reserved',
+    'r = reserved',
+];
+//# sourceMappingURL=cia402.js.map

package/src/lib/cia402.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cia402.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/cia402.ts"],"names":[],"mappings":";;;AAAA,IAAY,WASX;AATD,WAAY,WAAW;IACrB,iFAAsB,CAAA;IACtB,yEAAkB,CAAA;IAClB,yEAAkB,CAAA;IAClB,2DAAW,CAAA;IACX,uEAAiB,CAAA;IACjB,uEAAiB,CAAA;IACjB,+EAAqB,CAAA;IACrB,+CAAK,CAAA;AACP,CAAC,EATW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAStB;AAEY,QAAA,iBAAiB,GAAG;IAC/B,wBAAwB;IACxB,oBAAoB;IACpB,oBAAoB;IACpB,aAAa;IACb,mBAAmB;IACnB,mBAAmB;IACnB,uBAAuB;IACvB,OAAO;CACR,CAAC;AAEW,QAAA,0BAA0B,GAAG,IAAI,GAAG,CAAC;IAChD,CAAC,UAAU,EAAE,WAAW,CAAC,sBAAsB,CAAC;IAChD,CAAC,UAAU,EAAE,WAAW,CAAC,kBAAkB,CAAC;IAC5C,CAAC,UAAU,EAAE,WAAW,CAAC,kBAAkB,CAAC;IAC5C,CAAC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC;IACrC,CAAC,UAAU,EAAE,WAAW,CAAC,iBAAiB,CAAC;IAC3C,CAAC,UAAU,EAAE,WAAW,CAAC,iBAAiB,CAAC;IAC3C,CAAC,UAAU,EAAE,WAAW,CAAC,qBAAqB,CAAC;IAC/C,CAAC,UAAU,EAAE,WAAW,CAAC,KAAK,CAAC;CAChC,CAAC,CAAC;AAEH,SAAgB,4BAA4B,CAAC,UAAkB;IAC7D,OAAO,kCAA0B,CAAC,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;WACzD,kCAA0B,CAAC,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC;AAC/D,CAAC;AAHD,oEAGC;AAED,SAAgB,qBAAqB,CAAC,UAAkB;IACtD,OAAO,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,KAAK,CAAC;AACxC,CAAC;AAFD,sDAEC;AAED,IAAY,gBAYX;AAZD,WAAY,gBAAgB;IAC1B,wFAAyB,CAAA;IACzB,gFAAqB,CAAA;IACrB,sHAAwC,CAAA;IACxC,+EAAoB,CAAA;IACpB,yFAAyB,CAAA;IACzB,yFAAyB,CAAA;IACzB,qFAAuB,CAAA;IACvB,qEAAe,CAAA;IACf,iGAA6B,CAAA;IAC7B,iGAA6B,CAAA;IAC7B,8FAA4B,CAAA;AAC9B,CAAC,EAZW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAY3B;AAEY,QAAA,eAAe,GAAG;IAC7B,gBAAgB;IAChB,qBAAqB;IACrB,iBAAiB;IACjB,uBAAuB;IACvB,+BAA+B;IAC/B,+BAA+B;IAC/B,+BAA+B;IAC/B,kBAAkB;IAClB,UAAU;IACV,+BAA+B;IAC/B,cAAc;IACd,4BAA4B;IAC5B,4BAA4B;IAC5B,4BAA4B;IAC5B,4BAA4B;IAC5B,4BAA4B;CAC7B,CAAC;AAEW,QAAA,cAAc,GAAG;IAC5B,2BAA2B;IAC3B,kBAAkB;IAClB,wBAAwB;IACxB,WAAW;IACX,sBAAsB;IACtB,iBAAiB;IACjB,0BAA0B;IAC1B,aAAa;IACb,4BAA4B;IAC5B,aAAa;IACb,qBAAqB;IACrB,6BAA6B;IAC7B,+BAA+B;IAC/B,+BAA+B;IAC/B,4BAA4B;IAC5B,4BAA4B;CAC7B,CAAC;AAEW,QAAA,uBAAuB,GAAG;IACrC,4BAA4B;IAC5B,oBAAoB;IACpB,4BAA4B;IAC5B,kBAAkB;IAClB,cAAc;IACd,kBAAkB;IAClB,iCAAiC;IACjC,wCAAwC;IACxC,wCAAwC;IACxC,sCAAsC;IACtC,cAAc;IACd,cAAc;IACd,cAAc;IACd,cAAc;IACd,cAAc;IACd,cAAc;CACf,CAAC"}

package/src/lib/device-log-line.d.ts

@@ -0,0 +1,5 @@
+export interface DeviceLogLine {
+    time: string;
+    level: string;
+    message: string;
+}

package/src/lib/device-log-line.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=device-log-line.js.map

package/src/lib/device-log-line.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-log-line.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/device-log-line.ts"],"names":[],"mappings":""}

package/src/lib/device-parameter.d.ts

@@ -0,0 +1,56 @@
+import { Parameter } from "./parameter";
+export interface DeviceParameter extends Parameter {
+    id: string;
+    flags?: {
+        access?: 'ro' | 'rw' | 'wo';
+        category?: 'm' | 'o' | 'c';
+        pdoMapping?: 't' | 'r' | 'tr';
+        safetyMapping?: 'si' | 'so' | 'sio' | 'sp';
+    };
+}
+/**
+ * Make device parameter id by providing a device serial number and tuple of index and subindex.
+ *
+ * @param serialNumber - device serial number from the hardware description file
+ * @param tuple - an array of index and subindex
+ * @throws {Error} if index or subindex are less than 0
+ * @returns combined index and subindex in uppercase hexadecimal format, e.g. "0x60FE:02"
+ */
+export declare function makeDeviceParameterId(serialNumber: string, tuple: [(number | null | undefined), (number | null | undefined)]): string;
+/**
+ * Make device parameter id by providing a device serial number and object which has index and subindex properties.
+ *
+ * @param serialNumber - device serial number from the hardware description file
+ * @param parameter - an object with optional index and subindex properties
+ * @throws {Error} if index or subindex are less than 0
+ * @returns combined index and subindex in uppercase hexadecimal format, e.g. "0x60FE:02"
+ */
+export declare function makeDeviceParameterId(serialNumber: string, parameter: {
+    index?: (number | null);
+    subindex?: (number | null);
+}): string;
+/**
+ * Make parameter id by providing a device serial number and index and subindex.
+ *
+ * @param serialNumber - device serial number from the hardware description file
+ * @param index - from 0x0000 to 0xFFFF for objects defined in ESI and >0xFFFF for custom object
+ * @param subindex - defaults to 0 if not provided
+ * @throws {Error} if index or subindex are less than 0
+ * @returns combined index and subindex in uppercase hexadecimal format, e.g. "0x60FE:02"
+ */
+export declare function makeDeviceParameterId(serialNumber: string, index?: (number | null), subindex?: (number | null)): string;
+/**
+ * Example of device parameter id is "0x2110:1A.8502-03-0001353-2115" where:
+ * - 0x2110 is object index in hexadecimal format
+ * - 1A is subindex in hexadecimal format
+ * - 8502-03-0001353-2115 is device serial number from hardware description file
+ */
+export declare const deviceParameterIdRegExp: RegExp;
+/**
+ * Split device parameter id into parts.
+ *
+ * @param id - device parameter id like "0x2110:1A.8502-03-0001353-2115"
+ * @returns tuple of device serial number, index, and subindex
+ */
+export declare function splitDeviceParameterId(id: string): [string, number, number];
+export declare function isDeviceParameterId(id: string): boolean;

package/src/lib/device-parameter.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDeviceParameterId = exports.splitDeviceParameterId = exports.deviceParameterIdRegExp = exports.makeDeviceParameterId = void 0;
+const parameter_1 = require("./parameter");
+function makeDeviceParameterId(serialNumber, a, b) {
+    const parameterId = (0, parameter_1.makeParameterId)(a, b);
+    return `${parameterId}.${serialNumber}`;
+}
+exports.makeDeviceParameterId = makeDeviceParameterId;
+/**
+ * Example of device parameter id is "0x2110:1A.8502-03-0001353-2115" where:
+ * - 0x2110 is object index in hexadecimal format
+ * - 1A is subindex in hexadecimal format
+ * - 8502-03-0001353-2115 is device serial number from hardware description file
+ */
+exports.deviceParameterIdRegExp = /^0x([0-9a-fA-F]{4,}):([0-9a-fA-F]{2})\.([\d-]+)$/;
+/**
+ * Split device parameter id into parts.
+ *
+ * @param id - device parameter id like "0x2110:1A.8502-03-0001353-2115"
+ * @returns tuple of device serial number, index, and subindex
+ */
+function splitDeviceParameterId(id) {
+    const match = id.match(exports.deviceParameterIdRegExp);
+    if (!match) {
+        throw new Error(`Device parameter id "${id}" doesn't match the regular expression: ${exports.deviceParameterIdRegExp}`);
+    }
+    return [
+        match[3],
+        parseInt(match[1], 16),
+        parseInt(match[2], 16), // subindex
+    ];
+}
+exports.splitDeviceParameterId = splitDeviceParameterId;
+function isDeviceParameterId(id) {
+    return exports.deviceParameterIdRegExp.test(id);
+}
+exports.isDeviceParameterId = isDeviceParameterId;
+//# sourceMappingURL=device-parameter.js.map

package/src/lib/device-parameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-parameter.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/device-parameter.ts"],"names":[],"mappings":";;;AAAA,2CAAyD;AA2CzD,SAAgB,qBAAqB,CAAC,YAAoB,EAAE,CAA0I,EAAE,CAAmB;IACzN,MAAM,WAAW,GAAG,IAAA,2BAAe,EAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1C,OAAO,GAAG,WAAW,IAAI,YAAY,EAAE,CAAC;AAC1C,CAAC;AAHD,sDAGC;AAED;;;;;GAKG;AACU,QAAA,uBAAuB,GAAG,kDAAkD,CAAC;AAE1F;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,EAAU;IAC/C,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,+BAAuB,CAAC,CAAC;IAEhD,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,wBAAwB,EAAE,2CAA2C,+BAAuB,EAAE,CAAC,CAAC;KACjH;IAED,OAAO;QACL,KAAK,CAAC,CAAC,CAAC;QACR,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACtB,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,WAAW;KACpC,CAAC;AACJ,CAAC;AAZD,wDAYC;AAED,SAAgB,mBAAmB,CAAC,EAAU;IAC5C,OAAO,+BAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC1C,CAAC;AAFD,kDAEC"}

package/src/lib/device.d.ts

@@ -0,0 +1,9 @@
+import { HardwareDescription } from "./hardware-description";
+export interface Device {
+    id: string;
+    deviceAddress: number;
+    type?: number;
+    position?: number;
+    alias?: number;
+    hardwareDescription?: HardwareDescription;
+}

package/src/lib/device.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=device.js.map

package/src/lib/device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/device.ts"],"names":[],"mappings":""}

package/src/lib/hardware-description.d.ts

@@ -0,0 +1,41 @@
+export interface HardwareComponent {
+    name: string;
+    version: string;
+    serialNumber: string;
+}
+export declare type AssemblyComponent = HardwareComponent;
+export declare type DeviceComponent = HardwareComponent;
+export interface Assembly {
+    name: string;
+    id: string;
+    version: string;
+    serialNumber: string;
+    components: AssemblyComponent[];
+}
+export interface HardwareDevice {
+    name: string;
+    id: string;
+    version: string;
+    keyId: string;
+    serialNumber: string;
+    macAddress: string;
+    components: DeviceComponent[];
+}
+/**
+ * @link https://docs.google.com/document/d/1N00-ZjxHkjoWNIsnoTtza9CUHrxm8-e54298DXLuD94
+ */
+export interface HardwareDescription {
+    fileVersion: string;
+    assembly?: Assembly;
+    device: HardwareDevice;
+}
+export declare function getIdFromHardwareDescription(hd: HardwareDescription): string;
+export declare function getApiIdentifierFromHardwareDescription(hd: HardwareDescription, skipKeyId?: boolean): string;
+export declare function getNameFromHardwareDescription(hd: HardwareDescription): string;
+export declare function getSerialNumberFromHardwareDescription(hd: HardwareDescription): string;
+export declare function getAllComponentsFromHardwareDescription(hd: HardwareDescription): HardwareComponent[];
+export declare function hardwareComponentsMatch(a: HardwareComponent[], b: HardwareComponent[]): boolean;
+export declare function isHardwareDescriptionCompatibleWithPackageFilename(hardwareDescription: HardwareDescription, packageFilename: string): boolean;
+export declare function getHardwareComponentsFromPackageFilename(packageFilename: string): HardwareComponent[];
+export declare function getVersionFromPackageFilename(packageFilename: string): string | undefined;
+export declare function getApiIdentifierFromPackageFilename(packageFilename: string): string | undefined;

package/src/lib/hardware-description.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApiIdentifierFromPackageFilename = exports.getVersionFromPackageFilename = exports.getHardwareComponentsFromPackageFilename = exports.isHardwareDescriptionCompatibleWithPackageFilename = exports.hardwareComponentsMatch = exports.getAllComponentsFromHardwareDescription = exports.getSerialNumberFromHardwareDescription = exports.getNameFromHardwareDescription = exports.getApiIdentifierFromHardwareDescription = exports.getIdFromHardwareDescription = void 0;
+const lodash_1 = require("lodash");
+const semver_1 = require("semver");
+function getIdFromHardwareDescription(hd) {
+    return hd.assembly
+        ? hd.assembly.id
+        : hd.device.id;
+}
+exports.getIdFromHardwareDescription = getIdFromHardwareDescription;
+function getApiIdentifierFromHardwareDescription(hd, skipKeyId = false) {
+    let apiId = hd.assembly
+        ? `${hd.assembly.id}-${hd.assembly.version}`
+        : `${hd.device.id}-${hd.device.version}`;
+    if (!skipKeyId && hd.device.keyId) {
+        apiId += `-${hd.device.keyId}`;
+    }
+    return apiId;
+}
+exports.getApiIdentifierFromHardwareDescription = getApiIdentifierFromHardwareDescription;
+function getNameFromHardwareDescription(hd) {
+    return hd.assembly
+        ? hd.assembly.name
+        : hd.device.name;
+}
+exports.getNameFromHardwareDescription = getNameFromHardwareDescription;
+function getSerialNumberFromHardwareDescription(hd) {
+    return hd.assembly
+        ? hd.assembly.serialNumber
+        : hd.device.serialNumber;
+}
+exports.getSerialNumberFromHardwareDescription = getSerialNumberFromHardwareDescription;
+function getAllComponentsFromHardwareDescription(hd) {
+    return hd.assembly
+        ? [...hd.assembly.components, ...hd.device.components]
+        : hd.device.components;
+}
+exports.getAllComponentsFromHardwareDescription = getAllComponentsFromHardwareDescription;
+function hardwareComponentsMatch(a, b) {
+    if (a.length === 0 && b.length === 0) {
+        return false; // edge case: when both components are empty they don't match since there are no components to compare
+    }
+    const ac = a.map((c) => `${c.name}-${c.version[0]}`.replace(/\s/g, '').toLocaleLowerCase()).sort();
+    const bc = b.map((c) => `${c.name}-${c.version[0]}`.replace(/\s/g, '').toLocaleLowerCase()).sort();
+    return (0, lodash_1.isEqual)(ac, bc);
+}
+exports.hardwareComponentsMatch = hardwareComponentsMatch;
+function isHardwareDescriptionCompatibleWithPackageFilename(hardwareDescription, packageFilename) {
+    const hdApiId = getApiIdentifierFromHardwareDescription(hardwareDescription);
+    const pfApiId = getApiIdentifierFromPackageFilename(packageFilename);
+    if (hdApiId && pfApiId) {
+        return hdApiId === pfApiId;
+    }
+    else {
+        const pfComponents = getHardwareComponentsFromPackageFilename(packageFilename);
+        const hdComponents = getAllComponentsFromHardwareDescription(hardwareDescription);
+        return hardwareComponentsMatch(pfComponents, hdComponents);
+    }
+}
+exports.isHardwareDescriptionCompatibleWithPackageFilename = isHardwareDescriptionCompatibleWithPackageFilename;
+function getHardwareComponentsFromPackageFilename(packageFilename) {
+    if (packageFilename.match(/_Com[^_]+_Core[^_]+_Drive/g)) {
+        return packageFilename.split('_').slice(1, 4).map((b) => {
+            const p = b.split('-'); // ['ComEtherCAT', 'b']
+            return {
+                name: p[0],
+                serialNumber: '',
+                version: p[1],
+            };
+        });
+    }
+    else {
+        // not all package filenames have components,
+        // e.g. 'package_SOMANET-Servo-Node-Circulo-1800_circulo1800_motion-drive_v4.2.0-beta.5.zip'
+        return [];
+    }
+}
+exports.getHardwareComponentsFromPackageFilename = getHardwareComponentsFromPackageFilename;
+function getVersionFromPackageFilename(packageFilename) {
+    const parts = packageFilename.split('_');
+    const version = parts[parts.length - 1].replace(/\.zip$/, '').split(/\s+/)[0];
+    return semver_1.default.valid(version) ? version : undefined;
+}
+exports.getVersionFromPackageFilename = getVersionFromPackageFilename;
+function getApiIdentifierFromPackageFilename(packageFilename) {
+    if (packageFilename.match(/_Com[^_]+_Core[^_]+_Drive/g)) {
+        return undefined;
+    }
+    const [, , apiIdentifier] = packageFilename.split('_');
+    return apiIdentifier;
+}
+exports.getApiIdentifierFromPackageFilename = getApiIdentifierFromPackageFilename;
+//# sourceMappingURL=hardware-description.js.map

package/src/lib/hardware-description.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hardware-description.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/hardware-description.ts"],"names":[],"mappings":";;;AAAA,mCAAiC;AACjC,mCAA4B;AAsC5B,SAAgB,4BAA4B,CAAC,EAAuB;IAClE,OAAO,EAAE,CAAC,QAAQ;QAChB,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE;QAChB,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;AACnB,CAAC;AAJD,oEAIC;AAED,SAAgB,uCAAuC,CAAC,EAAuB,EAAE,SAAS,GAAG,KAAK;IAChG,IAAI,KAAK,GAAG,EAAE,CAAC,QAAQ;QACrB,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE;QAC5C,CAAC,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAE3C,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE;QACjC,KAAK,IAAI,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;KAChC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAVD,0FAUC;AAED,SAAgB,8BAA8B,CAAC,EAAuB;IACpE,OAAO,EAAE,CAAC,QAAQ;QAChB,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI;QAClB,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC;AAJD,wEAIC;AAED,SAAgB,sCAAsC,CAAC,EAAuB;IAC5E,OAAO,EAAE,CAAC,QAAQ;QAChB,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,YAAY;QAC1B,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC;AAC7B,CAAC;AAJD,wFAIC;AAED,SAAgB,uCAAuC,CAAC,EAAuB;IAC7E,OAAO,EAAE,CAAC,QAAQ;QAChB,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC;QACtD,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC;AAC3B,CAAC;AAJD,0FAIC;AAED,SAAgB,uBAAuB,CAAC,CAAsB,EAAE,CAAsB;IACpF,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACpC,OAAO,KAAK,CAAC,CAAC,sGAAsG;KACrH;IAED,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,iBAAiB,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACnG,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,iBAAiB,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAEnG,OAAO,IAAA,gBAAO,EAAC,EAAE,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AATD,0DASC;AAED,SAAgB,kDAAkD,CAAC,mBAAwC,EAAE,eAAuB;IAClI,MAAM,OAAO,GAAG,uCAAuC,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,OAAO,GAAG,mCAAmC,CAAC,eAAe,CAAC,CAAC;IAErE,IAAI,OAAO,IAAI,OAAO,EAAE;QACtB,OAAO,OAAO,KAAK,OAAO,CAAC;KAC5B;SAAM;QACL,MAAM,YAAY,GAAG,wCAAwC,CAAC,eAAe,CAAC,CAAC;QAC/E,MAAM,YAAY,GAAG,uCAAuC,CAAC,mBAAmB,CAAC,CAAC;QAClF,OAAO,uBAAuB,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;KAC5D;AACH,CAAC;AAXD,gHAWC;AAED,SAAgB,wCAAwC,CAAC,eAAuB;IAC9E,IAAI,eAAe,CAAC,KAAK,CAAC,4BAA4B,CAAC,EAAE;QACvD,OAAO,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACtD,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,uBAAuB;YAC/C,OAAO;gBACL,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBACV,YAAY,EAAE,EAAE;gBAChB,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;aACO,CAAC;QACzB,CAAC,CAAC,CAAC;KACJ;SAAM;QACL,6CAA6C;QAC7C,4FAA4F;QAC5F,OAAO,EAAE,CAAC;KACX;AACH,CAAC;AAfD,4FAeC;AAED,SAAgB,6BAA6B,CAAC,eAAuB;IACnE,MAAM,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,OAAO,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC;AAJD,sEAIC;AAED,SAAgB,mCAAmC,CAAC,eAAuB;IACzE,IAAI,eAAe,CAAC,KAAK,CAAC,4BAA4B,CAAC,EAAE;QACvD,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,CAAC,EAAE,AAAD,EAAG,aAAa,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvD,OAAO,aAAa,CAAC;AACvB,CAAC;AAND,kFAMC"}

package/src/lib/logger.d.ts

@@ -0,0 +1 @@
+export declare const logger: import("roarr").Logger<import("roarr/dist/src/types").JsonObject>;

package/src/lib/logger.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const roarr_1 = require("roarr");
+exports.logger = roarr_1.Roarr.child({
+    package: '@synapticon/motion-master-client'
+});
+//# sourceMappingURL=logger.js.map

package/src/lib/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/logger.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAEjB,QAAA,MAAM,GAAG,aAAK,CAAC,KAAK,CAAC;IAChC,OAAO,EAAE,kCAAkC;CAC5C,CAAC,CAAC"}

package/src/lib/monitoring-config.d.ts

@@ -0,0 +1,6 @@
+export interface MonitoringConfig {
+    readonly bufferSize?: number;
+    readonly distinct?: boolean;
+    readonly messageId: string;
+    readonly topic: string;
+}

package/src/lib/monitoring-config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=monitoring-config.js.map

package/src/lib/monitoring-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monitoring-config.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/monitoring-config.ts"],"names":[],"mappings":""}

package/src/lib/{monitoring-entry.ts → monitoring-entry.d.ts}

@@ -1,10 +1,9 @@
 import { Observable } from "rxjs";
 import { MonitoringConfig } from "./monitoring-config";
 import { MotionMasterMessage, ParameterValueType } from "./types";
-
 export interface MonitoringEntry {
-  config: MonitoringConfig;
-  interval: number;
-  values$: Observable<ParameterValueType[]>;
-  parameters: MotionMasterMessage.Request.GetDeviceParameterValues.IParameter[];
+    config: MonitoringConfig;
+    interval: number;
+    values$: Observable<ParameterValueType[]>;
+    parameters: MotionMasterMessage.Request.GetDeviceParameterValues.IParameter[];
 }

package/src/lib/monitoring-entry.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=monitoring-entry.js.map

package/src/lib/monitoring-entry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monitoring-entry.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/monitoring-entry.ts"],"names":[],"mappings":""}

package/src/lib/motion-master-client.d.ts

@@ -0,0 +1,30 @@
+import { Observable } from "rxjs";
+import { MonitoringConfig } from "./monitoring-config";
+import { MotionMasterPubSubClient } from "./motion-master-pub-sub-client";
+import { MotionMasterPubSubSocket } from "./motion-master-pub-sub-socket";
+import { MotionMasterReqResClient } from "./motion-master-req-res-client";
+import { MotionMasterReqResSocket } from "./motion-master-req-res-socket";
+import { DeviceRef, ParameterValueType } from "./types";
+export declare function createMotionMasterClient(hostname: string): MotionMasterClient;
+export declare class MotionMasterClient {
+    readonly reqResSocket: MotionMasterReqResSocket;
+    readonly pubSubSocket: MotionMasterPubSubSocket;
+    readonly request: MotionMasterReqResClient;
+    readonly monitor: MotionMasterPubSubClient;
+    constructor(reqResSocket: MotionMasterReqResSocket, pubSubSocket: MotionMasterPubSubSocket);
+    /**
+     * This observable will emit true when both req/res and pub/sub sockets are opened.
+     * If any socket gets closed, this observable will emit false.
+     * This is a hot observable that will on subscription emit the last value of sockets opened.
+     */
+    socketsOpened$: Observable<boolean>;
+    /**
+     * Client is ready when both req/res and pub/sub sockets are opened.
+     * If both sockets are already opened, this function will immediately resolve to true.
+     * Otherwise, it will wait up to requestTimeout for both sockets to open, or throw an error.
+     */
+    whenReady(requestTimeout?: number): Promise<true>;
+    startMonitoring(ids: string[] | [DeviceRef, number, number][], interval: number, config?: MonitoringConfig, requestTimeout?: number): Observable<ParameterValueType[]>;
+    stopMonitoring(messageId: string): void;
+    closeSockets(): void;
+}