motion-master-client 0.0.339 → 0.0.341

package/src/lib/device.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.factoryResetDefaultFilesToKeep = exports.isFilenamePart = exports.emptyAppBase64 = exports.stackUnlockFilename = exports.computeZeroHomeOffsetFromPosition = exports.parseDeviceLogContent = exports.parseDeviceLog = exports.isValidDeviceRefObj = exports.isDeviceRef = exports.makeDeviceRefObj = exports.ensureDeviceRef = exports.getDeviceRefFromDeviceRefObj = exports.filenamePartRegExp = void 0;
 exports.filenamePartRegExp = /^(.*?)(?:\.zip(?:\.part\d+)?)$/;
+/**
+ * Returns the first defined value from a {@link DeviceRefObj}.
+ */
 function getDeviceRefFromDeviceRefObj(deviceRefObj) {
     for (const [_, value] of Object.entries(deviceRefObj)) {
         if (value !== undefined) {
@@ -11,11 +14,23 @@ function getDeviceRefFromDeviceRefObj(deviceRefObj) {
     return null;
 }
 exports.getDeviceRefFromDeviceRefObj = getDeviceRefFromDeviceRefObj;
+/**
+ * Ensures that a {@link DeviceRef} is numeric if possible.
+ *
+ * If the value is numeric-like, it is converted to a number; otherwise the original string is returned.
+ */
 function ensureDeviceRef(deviceRef) {
     const n = Number(deviceRef);
     return isNaN(n) ? deviceRef : n;
 }
 exports.ensureDeviceRef = ensureDeviceRef;
+/**
+ * Converts a {@link DeviceRef} into a structured {@link DeviceRefObj}.
+ *
+ * - Numbers ≤ `0xffff` are treated as device positions.
+ * - Larger numbers are treated as device addresses.
+ * - Strings are treated as serial numbers.
+ */
 function makeDeviceRefObj(deviceRef) {
     deviceRef = ensureDeviceRef(deviceRef);
     if (typeof deviceRef === 'number') {
@@ -31,18 +46,30 @@ function makeDeviceRefObj(deviceRef) {
     }
 }
 exports.makeDeviceRefObj = makeDeviceRefObj;
+/**
+ * Type guard verifying that a value is a valid {@link DeviceRef}.
+ */
 function isDeviceRef(deviceRef) {
     return (deviceRef !== undefined &&
         deviceRef !== null &&
         (typeof deviceRef === 'string' || (typeof deviceRef === 'number' && deviceRef >= 0)));
 }
 exports.isDeviceRef = isDeviceRef;
+/**
+ * Validates the structure of a {@link DeviceRefObj}.
+ */
 function isValidDeviceRefObj(obj) {
     return (Number.isFinite(Number(obj.deviceAddress)) ||
         (typeof obj.devicePosition === 'number' && obj.devicePosition >= 0) ||
         typeof obj.deviceSerialNumber === 'string');
 }
 exports.isValidDeviceRefObj = isValidDeviceRefObj;
+/**
+ * Parses a single device log line.
+ *
+ * Expected format:
+ * `HH:MM:SS.mmm LEVEL|MESSAGE`
+ */
 function parseDeviceLog(line) {
     const re = /^(\d{2}:\d{2}:\d{2}\.\d+)\s(.*)\|(.*)$/gm;
     const result = re.exec(line);
@@ -56,6 +83,9 @@ function parseDeviceLog(line) {
     return;
 }
 exports.parseDeviceLog = parseDeviceLog;
+/**
+ * Parses multi-line log content into an array of {@link DeviceLogLine}.
+ */
 function parseDeviceLogContent(content) {
     return content
         .split('\n')
@@ -63,22 +93,35 @@ function parseDeviceLogContent(content) {
         .filter((l) => l !== undefined);
 }
 exports.parseDeviceLogContent = parseDeviceLogContent;
+/**
+ * Computes the "zero home offset" given a home offset and the current device position.
+ */
 function computeZeroHomeOffsetFromPosition(homeOffset, position) {
     return homeOffset - position;
 }
 exports.computeZeroHomeOffsetFromPosition = computeZeroHomeOffsetFromPosition;
 /**
- * The FoE read command with the filename "fs-stackunlock=DD1317" enables writing or deleting protected files (i.e., files that begin with a dot ".").
+ * Name of the FoE file used to unlock protected filesystem operations.
+ *
+ * Sending a FoE read command with this filename allows writing or deleting
+ * protected files (i.e., files whose names start with a dot).
  */
 exports.stackUnlockFilename = 'fs-stackunlock=DD1317';
 /**
- * Base64-encoded empty firmware binary used during a Factory Reset to remove the currently installed firmware.
+ * Base64-encoded empty firmware image used during Factory Reset
+ * to remove the currently installed firmware.
  */
 exports.emptyAppBase64 = 'UEsDBBQACAAIABBye08AAAAAAAAAAAAAAAANACAAYXBwX2VtcHR5LmJpblVUDQAHMHfeXTB33l0wd95ddXgLAAEE6AMAAAToAwAAAwBQSwcIAAAAAAIAAAAAAAAAUEsBAhQDFAAIAAgAEHJ7TwAAAAACAAAAAAAAAA0AIAAAAAAAAAAAAKSBAAAAAGFwcF9lbXB0eS5iaW5VVA0ABzB33l0wd95dMHfeXXV4CwABBOgDAAAE6AMAAFBLBQYAAAAAAQABAFsAAABdAAAAAAA=';
+/**
+ * Returns `true` if the filename represents a multi-part ZIP file.
+ */
 function isFilenamePart(filename) {
     return exports.filenamePartRegExp.test(filename);
 }
 exports.isFilenamePart = isFilenamePart;
+/**
+ * Default set of files preserved during Factory Reset.
+ */
 exports.factoryResetDefaultFilesToKeep = [
     '.assembly_config',
     '.factory_config',

package/src/lib/device.js.map

@@ -1 +1 @@
-{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/device.ts"],"names":[],"mappings":";;;AAMa,QAAA,kBAAkB,GAAG,gCAAgC,CAAC;AAqGnE,SAAgB,4BAA4B,CAAC,YAA0B;IACrE,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QACrD,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,KAAK,CAAC;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAPD,oEAOC;AAED,SAAgB,eAAe,CAAC,SAAoB;IAClD,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC5B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAHD,0CAGC;AAED,SAAgB,gBAAgB,CAAC,SAAoB;IACnD,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IACvC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,IAAI,SAAS,IAAI,MAAM,EAAE;YACvB,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;SACtC;aAAM;YACL,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;SACrC;KACF;SAAM;QACL,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,CAAC;KAC1C;AACH,CAAC;AAXD,4CAWC;AAED,SAAgB,WAAW,CAAC,SAAc;IACxC,OAAO,CACL,SAAS,KAAK,SAAS;QACvB,SAAS,KAAK,IAAI;QAClB,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,IAAI,CAAC,CAAC,CAAC,CACrF,CAAC;AACJ,CAAC;AAND,kCAMC;AAED,SAAgB,mBAAmB,CAAC,GAAiB;IACnD,OAAO,CACL,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,OAAO,GAAG,CAAC,cAAc,KAAK,QAAQ,IAAI,GAAG,CAAC,cAAc,IAAI,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC,kBAAkB,KAAK,QAAQ,CAC3C,CAAC;AACJ,CAAC;AAND,kDAMC;AAED,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,EAAE,GAAG,0CAA0C,CAAC;IACtD,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,IAAI,MAAM,EAAE;QACV,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YACtB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YACvB,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;SAC1B,CAAC;KACH;IACD,OAAO;AACT,CAAC;AAXD,wCAWC;AAED,SAAgB,qBAAqB,CAAC,OAAe;IACnD,OAAO,OAAO;SACX,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;SAC7B,MAAM,CAAC,CAAC,CAAC,EAAsB,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;AACxD,CAAC;AALD,sDAKC;AAED,SAAgB,iCAAiC,CAAC,UAAkB,EAAE,QAAgB;IACpF,OAAO,UAAU,GAAG,QAAQ,CAAC;AAC/B,CAAC;AAFD,8EAEC;AAED;;GAEG;AACU,QAAA,mBAAmB,GAAG,uBAAuB,CAAC;AAE3D;;GAEG;AACU,QAAA,cAAc,GACzB,sRAAsR,CAAC;AAEzR,SAAgB,cAAc,CAAC,QAAgB;IAC7C,OAAO,0BAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3C,CAAC;AAFD,wCAEC;AAEY,QAAA,8BAA8B,GAAG;IAC5C,kBAAkB;IAClB,iBAAiB;IACjB,uBAAuB;IACvB,UAAU;IACV,iBAAiB;CAClB,CAAC"}
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/device.ts"],"names":[],"mappings":";;;AAMa,QAAA,kBAAkB,GAAG,gCAAgC,CAAC;AAwGnE;;GAEG;AACH,SAAgB,4BAA4B,CAAC,YAA0B;IACrE,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;QACrD,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,KAAK,CAAC;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAPD,oEAOC;AAED;;;;GAIG;AACH,SAAgB,eAAe,CAAC,SAAoB;IAClD,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC5B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAHD,0CAGC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,SAAoB;IACnD,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IACvC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,IAAI,SAAS,IAAI,MAAM,EAAE;YACvB,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC;SACtC;aAAM;YACL,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;SACrC;KACF;SAAM;QACL,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,CAAC;KAC1C;AACH,CAAC;AAXD,4CAWC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,SAAc;IACxC,OAAO,CACL,SAAS,KAAK,SAAS;QACvB,SAAS,KAAK,IAAI;QAClB,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,IAAI,CAAC,CAAC,CAAC,CACrF,CAAC;AACJ,CAAC;AAND,kCAMC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CAAC,GAAiB;IACnD,OAAO,CACL,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,OAAO,GAAG,CAAC,cAAc,KAAK,QAAQ,IAAI,GAAG,CAAC,cAAc,IAAI,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC,kBAAkB,KAAK,QAAQ,CAC3C,CAAC;AACJ,CAAC;AAND,kDAMC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,EAAE,GAAG,0CAA0C,CAAC;IACtD,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,IAAI,MAAM,EAAE;QACV,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YACtB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YACvB,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;SAC1B,CAAC;KACH;IACD,OAAO;AACT,CAAC;AAXD,wCAWC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,OAAe;IACnD,OAAO,OAAO;SACX,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;SAC7B,MAAM,CAAC,CAAC,CAAC,EAAsB,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;AACxD,CAAC;AALD,sDAKC;AAED;;GAEG;AACH,SAAgB,iCAAiC,CAAC,UAAkB,EAAE,QAAgB;IACpF,OAAO,UAAU,GAAG,QAAQ,CAAC;AAC/B,CAAC;AAFD,8EAEC;AAED;;;;;GAKG;AACU,QAAA,mBAAmB,GAAG,uBAAuB,CAAC;AAE3D;;;GAGG;AACU,QAAA,cAAc,GACzB,sRAAsR,CAAC;AAEzR;;GAEG;AACH,SAAgB,cAAc,CAAC,QAAgB;IAC7C,OAAO,0BAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC3C,CAAC;AAFD,wCAEC;AAED;;GAEG;AACU,QAAA,8BAA8B,GAAG;IAC5C,kBAAkB;IAClB,iBAAiB;IACjB,uBAAuB;IACvB,UAAU;IACV,iBAAiB;CAClB,CAAC"}

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

@@ -1938,8 +1938,6 @@ export declare class MotionMasterReqResClient {
      *          and lists the supported pin modes. If all pin modes for a pin are disabled, the array defaults to `[0]`.
      */
     getSupportedDios(deviceRef: DeviceRef): Observable<number[][]>;
-    getMaxValuePercentageColor(percentage: number): "" | "#6ba853" | "#aeb303" | "#e69138" | "#fb262e";
-    getMaxValuePercentageLabel(percentage: number): "" | "Calibration was successful. Encoder system is robust to mechanical displacements and temperature expansions." | "Calibration was successful. Encoder system is robust to small mechanical displacements and temperature expansions." | "Calibration was successful. Mechanical displacement and temperature expansions should be avoided." | "Phase error is too high. The absolute position can't be computed reliably. Adjust mechanical position and repeat calibration.";
     /**
      * Checks the Circulo encoder error status registers for a specified encoder ordinal.
      *
@@ -2137,4 +2135,16 @@ export declare class MotionMasterReqResClient {
      * - This function assumes positive values; a negative value may indicate an error or reversed rotation.
      */
     getGearRatio(deviceRef: DeviceRef): Promise<number>;
+    /**
+     * Retrieves the PDO mapping for the given device.
+     *
+     * This method attempts to get the device-specific UI configuration and returns
+     * its PDO mapping. If the device does not have a specific UI configuration or
+     * its PDO mapping is missing, the default PDO mapping (`uiConfigWithDefaultPdoMapping`)
+     * is returned instead.
+     *
+     * @param deviceRef - Reference to the device for which the UI configuration is requested.
+     * @returns An `Observable` that emits the RX and TX PDO mapping for the device.
+     */
+    getUiConfigOrDefaultPdoMapping(deviceRef: DeviceRef): Observable<UiPdoMapping>;
 }

package/src/lib/motion-master-req-res-client.js

@@ -3762,38 +3762,6 @@ class MotionMasterReqResClient {
             }));
         }));
     }
-    // TODO: Move to another file
-    getMaxValuePercentageColor(percentage) {
-        if (percentage >= 50 && percentage <= 100) {
-            return '#6ba853';
-        }
-        else if (percentage > 20 && percentage < 50) {
-            return '#aeb303';
-        }
-        else if (percentage > 0 && percentage <= 20) {
-            return '#e69138';
-        }
-        else if (percentage <= 0) {
-            return '#fb262e';
-        }
-        return '';
-    }
-    // TODO: Move to another file
-    getMaxValuePercentageLabel(percentage) {
-        if (percentage >= 50 && percentage <= 100) {
-            return 'Calibration was successful. Encoder system is robust to mechanical displacements and temperature expansions.';
-        }
-        else if (percentage > 20 && percentage < 50) {
-            return 'Calibration was successful. Encoder system is robust to small mechanical displacements and temperature expansions.';
-        }
-        else if (percentage > 0 && percentage <= 20) {
-            return 'Calibration was successful. Mechanical displacement and temperature expansions should be avoided.';
-        }
-        else if (percentage <= 0) {
-            return "Phase error is too high. The absolute position can't be computed reliably. Adjust mechanical position and repeat calibration.";
-        }
-        return '';
-    }
     /**
      * Checks the Circulo encoder error status registers for a specified encoder ordinal.
      *
@@ -4197,6 +4165,20 @@ class MotionMasterReqResClient {
             }
         });
     }
+    /**
+     * Retrieves the PDO mapping for the given device.
+     *
+     * This method attempts to get the device-specific UI configuration and returns
+     * its PDO mapping. If the device does not have a specific UI configuration or
+     * its PDO mapping is missing, the default PDO mapping (`uiConfigWithDefaultPdoMapping`)
+     * is returned instead.
+     *
+     * @param deviceRef - Reference to the device for which the UI configuration is requested.
+     * @returns An `Observable` that emits the RX and TX PDO mapping for the device.
+     */
+    getUiConfigOrDefaultPdoMapping(deviceRef) {
+        return this.getUiConfig(deviceRef).pipe((0, operators_1.map)((uiConfig) => { var _a; return (_a = uiConfig.pdoMapping) !== null && _a !== void 0 ? _a : device_parameter_1.uiConfigWithDefaultPdoMapping.pdoMapping; }));
+    }
 }
 exports.MotionMasterReqResClient = MotionMasterReqResClient;
 /**