motion-master-client 0.0.356 → 0.0.358

package/src/lib/pdo.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Checks if a string is a valid representation of a CANopen PDO mapping entry.
+ *
+ * A valid entry is a 32-bit hexadecimal value representing:
+ * - **Index** (16 bits)
+ * - **Subindex** (8 bits)
+ * - **Bit Length** (8 bits)
+ *
+ * It accepts formats with or without the '0x' prefix (e.g., "0x60400010" or "60400010").
+ *
+ * @param value The string to validate.
+ * @returns `true` if the string follows the PDO mapping entry hex format, `false` otherwise.
+ *
+ * @example
+ * isPdoMappingEntry('0x60400010'); // true
+ * isPdoMappingEntry('60400010');   // true
+ * isPdoMappingEntry('invalid');    // false
+ */
+export declare function isPdoMappingEntry(value: string): boolean;
+/**
+ * Represents the components of a single CANopen PDO Mapping Entry.
+ *
+ * A PDO Mapping Entry is a 32-bit value describing which object dictionary parameter
+ * maps to a specific location in a PDO message.
+ *
+ * The 32-bit structure is defined as:
+ * - **Index (16-bit):** The object dictionary index (e.g., `0x6040`).
+ * - **Subindex (8-bit):** The specific sub-element of the object (e.g., `0x00`).
+ * - **Bit Length (8-bit):** The size of the data in bits (e.g., `16`).
+ */
+export interface PdoMappingEntry {
+    /**
+     * The Object Dictionary Index (16-bit unsigned integer).
+     *
+     * @example 0x6040 (Controlword)
+     */
+    index: number;
+    /**
+     * The Object Dictionary Subindex (8-bit unsigned integer).
+     *
+     * @example 0x00 (Main value)
+     */
+    subindex: number;
+    /**
+     * The length of the mapped parameter in bits (8-bit unsigned integer).
+     *
+     * @example 16 (for a 16-bit integer)
+     * @example 0x10 (hex representation of 16)
+     */
+    bitLength: number;
+}
+/**
+ * Parses a CANopen PDO Mapping Entry (32-bit value) into its components.
+ *
+ * Structure: Index (16-bit) | Subindex (8-bit) | Bit Length (8-bit)
+ *
+ * @param entry The mapping entry as a raw number or hex string (e.g., 0x60400010).
+ * @returns An object containing the parsed index, subindex, and bit length.
+ * @throws Error if the input string is not a valid hex number.
+ */
+export declare function parsePdoMappingEntry(entry: number | string): PdoMappingEntry;

package/src/lib/pdo.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePdoMappingEntry = exports.isPdoMappingEntry = void 0;
+// Matches a hex string like "0x60400010" or "60400010"
+// Captures: Group 1 (Index), Group 2 (Subindex), Group 3 (Bit Length)
+const pdoMappingEntryRegExp = /^(?:0x)?([0-9a-fA-F]{4})([0-9a-fA-F]{2})([0-9a-fA-F]{2})$/;
+/**
+ * Checks if a string is a valid representation of a CANopen PDO mapping entry.
+ *
+ * A valid entry is a 32-bit hexadecimal value representing:
+ * - **Index** (16 bits)
+ * - **Subindex** (8 bits)
+ * - **Bit Length** (8 bits)
+ *
+ * It accepts formats with or without the '0x' prefix (e.g., "0x60400010" or "60400010").
+ *
+ * @param value The string to validate.
+ * @returns `true` if the string follows the PDO mapping entry hex format, `false` otherwise.
+ *
+ * @example
+ * isPdoMappingEntry('0x60400010'); // true
+ * isPdoMappingEntry('60400010');   // true
+ * isPdoMappingEntry('invalid');    // false
+ */
+function isPdoMappingEntry(value) {
+    return pdoMappingEntryRegExp.test(value);
+}
+exports.isPdoMappingEntry = isPdoMappingEntry;
+/**
+ * Parses a CANopen PDO Mapping Entry (32-bit value) into its components.
+ *
+ * Structure: Index (16-bit) | Subindex (8-bit) | Bit Length (8-bit)
+ *
+ * @param entry The mapping entry as a raw number or hex string (e.g., 0x60400010).
+ * @returns An object containing the parsed index, subindex, and bit length.
+ * @throws Error if the input string is not a valid hex number.
+ */
+function parsePdoMappingEntry(entry) {
+    let value;
+    if (typeof entry === 'string') {
+        // Determine base: if it starts with 0x, parse as 16, otherwise assume it might be 16 or 10.
+        // For PDO mapping strings, we safely assume Hex if it looks like standard "60400010".
+        // Using parseInt with radix 16 handles "0x" prefix automatically.
+        value = parseInt(entry, 16);
+        if (isNaN(value)) {
+            throw new Error(`Invalid PDO mapping entry string: "${entry}"`);
+        }
+    }
+    else {
+        value = entry;
+    }
+    return {
+        // Use zero-fill right shift (>>>) to ensure we handle unsigned 32-bit correctly
+        index: (value >>> 16) & 0xffff,
+        subindex: (value >>> 8) & 0xff,
+        bitLength: value & 0xff,
+    };
+}
+exports.parsePdoMappingEntry = parsePdoMappingEntry;
+//# sourceMappingURL=pdo.js.map

package/src/lib/pdo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdo.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/pdo.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,sEAAsE;AACtE,MAAM,qBAAqB,GAAG,2DAA2D,CAAC;AAE1F;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,OAAO,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC;AAFD,8CAEC;AAqCD;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAAC,KAAsB;IACzD,IAAI,KAAa,CAAC;IAElB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,4FAA4F;QAC5F,sFAAsF;QACtF,kEAAkE;QAClE,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAE5B,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,sCAAsC,KAAK,GAAG,CAAC,CAAC;SACjE;KACF;SAAM;QACL,KAAK,GAAG,KAAK,CAAC;KACf;IAED,OAAO;QACL,gFAAgF;QAChF,KAAK,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,GAAG,MAAM;QAC9B,QAAQ,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,IAAI;QAC9B,SAAS,EAAE,KAAK,GAAG,IAAI;KACxB,CAAC;AACJ,CAAC;AAtBD,oDAsBC"}