motion-master-client 0.0.358 → 0.0.359

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "motion-master-client",
-  "version": "0.0.358",
+  "version": "0.0.359",
   "type": "commonjs",
   "description": "A library and CLI program used for communicating with Motion Master.",
   "dependencies": {

package/src/index.d.ts

@@ -6,6 +6,7 @@ export * from './lib/device';
 export * from './lib/device-parameter';
 export * from './lib/device-log-line';
 export * from './lib/encoder';
+export * from './lib/error-reports';
 export * from './lib/ethercat';
 export * from './lib/ethernet';
 export * from './lib/fetch';

package/src/index.js

@@ -9,6 +9,7 @@ tslib_1.__exportStar(require("./lib/device"), exports);
 tslib_1.__exportStar(require("./lib/device-parameter"), exports);
 tslib_1.__exportStar(require("./lib/device-log-line"), exports);
 tslib_1.__exportStar(require("./lib/encoder"), exports);
+tslib_1.__exportStar(require("./lib/error-reports"), exports);
 tslib_1.__exportStar(require("./lib/ethercat"), exports);
 tslib_1.__exportStar(require("./lib/ethernet"), exports);
 tslib_1.__exportStar(require("./lib/fetch"), exports);

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/motion-master-client/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,wDAA8B;AAC9B,4DAAkC;AAClC,gEAAsC;AACtC,uDAA6B;AAC7B,iEAAuC;AACvC,gEAAsC;AACtC,wDAA8B;AAC9B,yDAA+B;AAC/B,yDAA+B;AAC/B,sDAA4B;AAC5B,yDAA+B;AAC/B,qEAA2C;AAC3C,uDAA6B;AAC7B,4EAAkD;AAClD,gEAAsC;AACtC,0DAAgC;AAChC,oFAA0D;AAC1D,uDAA6B;AAC7B,kEAAwC;AACxC,iEAAuC;AACvC,gEAAsC;AACtC,qEAA2C;AAC3C,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,qEAA2C;AAC3C,uDAA6B;AAC7B,0DAAgC;AAChC,wDAA8B;AAC9B,2DAAiC;AACjC,0DAAgC;AAChC,oDAA0B;AAC1B,wDAA8B;AAC9B,wEAA8C;AAC9C,oDAA0B;AAC1B,uDAA6B;AAC7B,oDAA0B;AAC1B,gEAAsC;AACtC,sDAA4B;AAC5B,sDAA4B;AAC5B,8DAAoC;AACpC,qDAA2B;AAC3B,kFAAwD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/motion-master-client/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,wDAA8B;AAC9B,4DAAkC;AAClC,gEAAsC;AACtC,uDAA6B;AAC7B,iEAAuC;AACvC,gEAAsC;AACtC,wDAA8B;AAC9B,8DAAoC;AACpC,yDAA+B;AAC/B,yDAA+B;AAC/B,sDAA4B;AAC5B,yDAA+B;AAC/B,qEAA2C;AAC3C,uDAA6B;AAC7B,4EAAkD;AAClD,gEAAsC;AACtC,0DAAgC;AAChC,oFAA0D;AAC1D,uDAA6B;AAC7B,kEAAwC;AACxC,iEAAuC;AACvC,gEAAsC;AACtC,qEAA2C;AAC3C,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,6EAAmD;AACnD,6EAAmD;AACnD,iFAAuD;AACvD,oFAA0D;AAC1D,qEAA2C;AAC3C,uDAA6B;AAC7B,0DAAgC;AAChC,wDAA8B;AAC9B,2DAAiC;AACjC,0DAAgC;AAChC,oDAA0B;AAC1B,wDAA8B;AAC9B,wEAA8C;AAC9C,oDAA0B;AAC1B,uDAA6B;AAC7B,oDAA0B;AAC1B,gEAAsC;AACtC,sDAA4B;AAC5B,sDAA4B;AAC5B,8DAAoC;AACpC,qDAA2B;AAC3B,kFAAwD"}

package/src/lib/error-reports.d.ts

@@ -0,0 +1,69 @@
+import { Observable } from 'rxjs';
+/**
+ * Represents a single error report entry loaded from `error-reports-v2.json`.
+ *
+ * Error reports describe known error conditions, affected firmware versions,
+ * error codes, and suggested remedies.
+ */
+export interface ErrorReport {
+    /**
+     * Logical grouping or category of the error (e.g. "Communication", "Safety").
+     */
+    group: string;
+    /**
+     * Short, human-readable error title or summary.
+     */
+    errorReport: string;
+    /**
+     * Detailed technical description of the error.
+     */
+    longForm: string;
+    /**
+     * High-level explanation intended for users or integrators.
+     */
+    explanation: string;
+    /**
+     * Raw list or formatted representation of associated error codes.
+     */
+    errorCodeList: string;
+    /**
+     * Recommended actions or steps to resolve the error.
+     */
+    remedy: string;
+    /**
+     * Indicates whether the error applies to firmware version 4.2.
+     */
+    'v4.2': boolean;
+    /**
+     * Indicates whether the error applies to firmware version 4.4.
+     */
+    'v4.4': boolean;
+    /**
+     * Indicates whether the error applies to firmware version 5.0.
+     */
+    'v5.0': boolean;
+    /**
+     * Indicates whether the error applies to firmware version 5.1.
+     */
+    'v5.1': boolean;
+    /**
+     * List of firmware identifiers where this error is known to occur.
+     */
+    firmwares: string[];
+    /**
+     * Numeric error code reported by the device or firmware.
+     */
+    errorCode: number;
+    /**
+     * Unique identifier for this error report entry.
+     */
+    id: string;
+}
+/**
+ * Fetches the error reports JSON as an Observable.
+ * Can optionally cache the result.
+ *
+ * @param useCache Whether to cache the result for future subscribers. Default: true.
+ * @returns Observable of ErrorReport array
+ */
+export declare function getErrorReports(useCache?: boolean): Observable<ErrorReport[]>;

package/src/lib/error-reports.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorReports = void 0;
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const fetch_1 = require("./fetch");
+/**
+ * Fetches the error reports JSON as an Observable.
+ * Can optionally cache the result.
+ *
+ * @param useCache Whether to cache the result for future subscribers. Default: true.
+ * @returns Observable of ErrorReport array
+ */
+function getErrorReports(useCache = true) {
+    // Internal cache holder
+    let cached$;
+    // The actual getter
+    const fetch$ = () => (0, rxjs_1.defer)(() => (0, fetch_1.fetchAndResolve)('/error-reports-v2.json', 'json', false));
+    if (!useCache) {
+        return fetch$();
+    }
+    // Create cached observable if needed
+    if (!cached$) {
+        cached$ = fetch$().pipe((0, operators_1.shareReplay)({ bufferSize: 1, refCount: false }));
+    }
+    return cached$;
+}
+exports.getErrorReports = getErrorReports;
+//# sourceMappingURL=error-reports.js.map

package/src/lib/error-reports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-reports.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/error-reports.ts"],"names":[],"mappings":";;;AAAA,+BAAyC;AACzC,8CAA6C;AAC7C,mCAA0C;AA2E1C;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,QAAQ,GAAG,IAAI;IAC7C,wBAAwB;IACxB,IAAI,OAA8C,CAAC;IAEnD,oBAAoB;IACpB,MAAM,MAAM,GAAG,GAAG,EAAE,CAAC,IAAA,YAAK,EAAC,GAAG,EAAE,CAAC,IAAA,uBAAe,EAAC,wBAAwB,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAE3F,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,MAAM,EAAE,CAAC;KACjB;IAED,qCAAqC;IACrC,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,IAAA,uBAAW,EAAC,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;KAC1E;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAjBD,0CAiBC"}

package/src/lib/smm-od-v2.json

@@ -1557,7 +1557,7 @@
             {
                 "parameterName": "SLT input",
                 "variableName": "STR_ConfiguredInput",
-                "group": "SLT",
+                "group": "Safety functions (SLT)",
                 "index": 9906,
                 "subindex": 1,
                 "description": "Specifies the associated safe digital input used for activation of the safety function",
@@ -1574,7 +1574,7 @@
             {
                 "parameterName": "SLT source",
                 "variableName": "torqueSource",
-                "group": "SLT",
+                "group": "Safety functions (SLT)",
                 "index": 9906,
                 "subindex": 2,
                 "description": "The specified torque source to be used for supervision.",
@@ -1591,7 +1591,7 @@
             {
                 "parameterName": "f_PosLim_SLT",
                 "variableName": "f_UL_STR",
-                "group": "SLT",
+                "group": "Safety functions (SLT)",
                 "index": 26289,
                 "subindex": 1,
                 "description": "Torque upper limit",
@@ -1607,7 +1607,7 @@
             {
                 "parameterName": "f_NegLimit_SLT",
                 "variableName": "f_LL_STR",
-                "group": "SLT",
+                "group": "Safety functions (SLT)",
                 "index": 26290,
                 "subindex": 1,
                 "description": "Torque lower limit",
@@ -1623,7 +1623,7 @@
             {
                 "parameterName": "SLT Limit violation reaction",
                 "variableName": "STRLimitViolationReaction",
-                "group": "SLT",
+                "group": "Safety functions (SLT)",
                 "index": 26291,
                 "subindex": 1,
                 "description": "The limit violation reaction for SLT",

package/src/lib/error-report.d.ts

@@ -1,15 +0,0 @@
-export interface ErrorReport {
-    group: string;
-    errorReport: string;
-    longForm: string;
-    explanation: string;
-    errorCodeList: string;
-    remedy: string;
-    'v4.2': boolean;
-    'v4.4': boolean;
-    'v5.0': boolean;
-    'v5.1': boolean;
-    firmwares: string[];
-    errorCode: number;
-    id: string;
-}

package/src/lib/error-report.js

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

package/src/lib/error-report.js.map

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