motion-master-client 0.0.3 → 0.0.6

package/README.md

@@ -1,49 +1,123 @@
-# Motion Master Client
-
-Motion Master Client is a library and CLI program written in [TypeScript](https://www.typescriptlang.org). It is used for communicating with Motion Master process over [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) connections by exchanging [Protocol Buffers](https://developers.google.com/protocol-buffers) serialized messages.
-
-## Installation
-
-```sh
-npm install motion-master-client
-```
-
-## Usage
-
-```ts
-const reqResSocket = new MotionMasterReqResWebSocket();
-const pubSubSocket = new MotionMasterPubSubWebSocket();
-
-const client = new MotionMasterClient(reqResSocket, pubSubSocket);
-
-const clientId = v4();
-reqResSocket.open(`ws://oblac-drives-7dc95497.local:63524?clientId=${clientId}`);
-pubSubSocket.open(`ws://oblac-drives-7dc95497.local:63525?clientId=${clientId}`);
-
-client.request.getDeviceInfo().subscribe(console.log);
-```
-
-## Communication
-
-### Protocols
-
-### Message Exchange
-
-## Running unit tests
-
-## Features
-
-## Goals
-
-Run `nx test motion-master-client` to execute the unit tests via [Jest](https://jestjs.io).
-
-https://github.com/protocolbuffers/protobuf/issues/2497#issuecomment-267422550
-
-class diagram
-
-explain status progress completed error
-request timeout
-ping mechanism
-reactive and async api
-two sockets
-matching request id (message id with response)
+# Motion Master Client
+
+Motion Master Client is a library and CLI program written in [TypeScript](https://www.typescriptlang.org). It is used for communicating with Motion Master process over [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) connections by exchanging [Protocol Buffers](https://developers.google.com/protocol-buffers) serialized messages.
+
+## Installation
+
+```sh
+npm install motion-master-client
+```
+
+## Usage
+
+```ts
+const reqResSocket = new MotionMasterReqResWebSocket();
+const pubSubSocket = new MotionMasterPubSubWebSocket();
+
+const client = new MotionMasterClient(reqResSocket, pubSubSocket);
+
+const clientId = v4();
+reqResSocket.open(`ws://oblac-drives-7dc95497.local:63524?clientId=${clientId}`);
+pubSubSocket.open(`ws://oblac-drives-7dc95497.local:63525?clientId=${clientId}`);
+
+client.request.getDeviceInfo().subscribe(console.log);
+```
+
+### Class Diagrams
+
+```mermaid
+---
+title: Client & socket classes
+---
+classDiagram
+  class MotionMasterClient {
+    +MotionMasterReqResClient request
+    +MotionMasterPubSubClient monitor
+    +startMonitoring()
+    +stopMonitoring()
+  }
+  
+  class MotionMasterReqResClient {
+    +MotionMasterReqResSocket socket
+    note "Has all the request methods\ncorresponding to the proto file."
+  }
+
+  class MotionMasterReqResSocket
+  <<interface>> MotionMasterReqResSocket
+  MotionMasterReqResSocket: +BehaviorSubject~boolean~ opened\$
+  MotionMasterReqResSocket: +BehaviorSubject~boolean~ alive\$
+  MotionMasterReqResSocket: +Observable~MotionMasterMessage~ message\$
+  MotionMasterReqResSocket: +open(string url, number pingSystemInterval?, number systemAliveTimeout?)
+  MotionMasterReqResSocket: +close()
+  MotionMasterReqResSocket: +send(MotionMasterMessage message)
+  
+  class MotionMasterReqResWebSocket {
+    note "Keeps the connection alive by\nsending the ping system messages\nin regular intervals."
+  }
+  
+  class MotionMasterReqResWorkerSocket {
+    +Worker worker
+    note "Passes messages between\nthe UI and worker thread."
+  }
+
+  class MotionMasterPubSubClient {
+    +MotionMasterPubSubSocket socket
+    +Subject<[string, MotionMasterMessage[]]> data\$
+    +Observable~MotionMasterMessage~ notification\$
+    +Observable~MotionMasterMessage~ systemEvent\$
+    +Observable~MotionMasterMessage~ deviceEvent\$
+    +subscribe(MonitoringConfig config)
+    +unsubscribe(string messageId)
+    +unsubscribeAll()
+  }
+
+  class MotionMasterPubSubSocket
+  <<interface>> MotionMasterPubSubSocket
+  MotionMasterPubSubSocket: +BehaviorSubject~boolean~ opened\$
+  MotionMasterPubSubSocket: +Observable<[string, MotionMasterMessage]> data\$
+  MotionMasterPubSubSocket: +open(string url)
+  MotionMasterPubSubSocket: +close()
+
+  class MotionMasterPubSubWebSocket {
+    note "Deserializes incoming data into\na tuple of topic and message."
+  }
+  
+  class MotionMasterPubSubWorkerSocket {
+    +Worker worker
+    note "Passes messages between\nthe UI and worker thread."
+  }
+
+  MotionMasterClient *-- MotionMasterReqResClient
+  MotionMasterClient *-- MotionMasterPubSubClient
+
+  MotionMasterReqResClient *-- MotionMasterReqResSocket
+  MotionMasterReqResWebSocket <|-- MotionMasterReqResSocket
+  MotionMasterReqResWorkerSocket <|-- MotionMasterReqResSocket
+  
+  MotionMasterPubSubClient *-- MotionMasterPubSubSocket
+  MotionMasterPubSubWebSocket <|-- MotionMasterPubSubSocket
+  MotionMasterPubSubWorkerSocket <|-- MotionMasterPubSubSocket
+```
+
+## Communication
+
+### Protocols
+
+### Message Exchange
+
+## Running unit tests
+
+## Features
+
+## Goals
+
+Run `nx test motion-master-client` to execute the unit tests via [Jest](https://jestjs.io).
+
+https://github.com/protocolbuffers/protobuf/issues/2497#issuecomment-267422550
+
+explain status progress completed error
+request timeout
+ping mechanism
+reactive and async api
+two sockets
+matching request id (message id with response)

package/package.json

@@ -1,6 +1,21 @@
-{
-  "name": "motion-master-client",
-  "version": "0.0.3",
-  "type": "module",
-  "description": "A library and CLI program used for communicating with Motion Master."
-}
+{
+  "name": "motion-master-client",
+  "version": "0.0.6",
+  "type": "commonjs",
+  "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.1.2",
+    "roarr": "^7.14.1",
+    "rxjs": "~7.5.0",
+    "uuid": "^9.0.0",
+    "ws": "^8.12.1"
+  },
+  "peerDependencies": {
+    "tslib": "^2.4.0"
+  },
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
+}

package/src/{index.ts → index.d.ts}

@@ -1,22 +1,23 @@
-export * from './lib/device-log-line';
-export * from './lib/device-parameter';
-export * from './lib/hardware-description';
-export * from './lib/monitoring-config';
-export * from './lib/monitoring-entry';
-export * from './lib/motion-master-client';
-export * from './lib/motion-master-pub-sub-client';
-export * from './lib/motion-master-pub-sub-socket';
-export * from './lib/motion-master-pub-sub-web-socket';
-export * from './lib/motion-master-pub-sub-worker-socket';
-export * from './lib/motion-master-req-res-client';
-export * from './lib/motion-master-req-res-socket';
-export * from './lib/motion-master-req-res-web-socket';
-export * from './lib/motion-master-req-res-worker-socket';
-export * from './lib/operators';
-export * from './lib/options';
-export * from './lib/parameter';
-export * from './lib/request-status-resolver';
-export * from './lib/system-log-line';
-export * from './lib/types';
-export * from './lib/urls';
-export * from './lib/util';
+export * from './lib/cia402';
+export * from './lib/device-log-line';
+export * from './lib/device-parameter';
+export * from './lib/hardware-description';
+export * from './lib/monitoring-config';
+export * from './lib/monitoring-entry';
+export * from './lib/motion-master-client';
+export * from './lib/motion-master-pub-sub-client';
+export * from './lib/motion-master-pub-sub-socket';
+export * from './lib/motion-master-pub-sub-web-socket';
+export * from './lib/motion-master-pub-sub-worker-socket';
+export * from './lib/motion-master-req-res-client';
+export * from './lib/motion-master-req-res-socket';
+export * from './lib/motion-master-req-res-web-socket';
+export * from './lib/motion-master-req-res-worker-socket';
+export * from './lib/operators';
+export * from './lib/options';
+export * from './lib/parameter';
+export * from './lib/request-status-resolver';
+export * from './lib/system-log-line';
+export * from './lib/types';
+export * from './lib/urls';
+export * from './lib/util';

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.ts → device-parameter.d.ts}

@@ -1,69 +1,56 @@
-import { makeParameterId, Parameter } from "./parameter";
-
-export interface DeviceParameter extends Parameter {
-  id: string;
-}
-
-/**
- * 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 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 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 function makeDeviceParameterId(serialNumber: string, index?: (number | null), subindex?: (number | null)): string;
-
-export function makeDeviceParameterId(serialNumber: string, a?: (number | null) | { index?: (number | null), subindex?: (number | null) } | [(number | null | undefined), (number | null | undefined)], b?: (number | null)): string {
-  const parameterId = makeParameterId(a, b);
-  return `${parameterId}.${serialNumber}`;
-}
-
-/**
- * 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 const 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
- */
-export function splitDeviceParameterId(id: string): [string, number, number] {
-  const match = id.match(deviceParameterIdRegExp);
-
-  if (!match) {
-    throw new Error(`Device parameter id "${id}" doesn't match the regular expression: ${deviceParameterIdRegExp}`);
-  }
-
-  return [
-    match[3], // device serial number
-    parseInt(match[1], 16), // index
-    parseInt(match[2], 16), // subindex
-  ];
-}
+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,8 @@
+import { HardwareDescription } from "./hardware-description";
+export interface Device {
+    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/examples/get-firmware-version-for-all-devices.d.ts

@@ -0,0 +1 @@
+export {};