motion-master-client 0.0.363 → 0.0.366

package/src/lib/offset-detection.d.ts

@@ -0,0 +1,75 @@
+import { ProgressStep } from './types';
+interface OpenPhaseDetectionStep extends ProgressStep<boolean> {
+    id: 'openPhaseDetection';
+}
+interface PhaseResistanceMeasurementStep extends ProgressStep<number> {
+    id: 'phaseResistanceMeasurement';
+}
+interface PhaseInductanceMeasurementStep extends ProgressStep<number> {
+    id: 'phaseInductanceMeasurement';
+}
+interface PolePairDetectionStep extends ProgressStep<number> {
+    id: 'polePairDetection';
+}
+interface MotorPhaseOrderDetectionStep extends ProgressStep<number> {
+    id: 'motorPhaseOrderDetection';
+}
+interface CommutationOffsetMeasurementStep extends ProgressStep<number> {
+    id: 'commutationOffsetMeasurement';
+}
+/**
+ * Tuple representing the ordered sequence of all offset detection steps.
+ *
+ * Each position in the tuple corresponds to a specific diagnostic step
+ * in the offset detection workflow.
+ */
+export type OffsetDetectionSteps = [
+    OpenPhaseDetectionStep,
+    PhaseResistanceMeasurementStep,
+    PhaseInductanceMeasurementStep,
+    PolePairDetectionStep,
+    MotorPhaseOrderDetectionStep,
+    CommutationOffsetMeasurementStep
+];
+/**
+ * Union type of all possible offset detection step identifiers.
+ */
+export type OffsetDetectionStepId = OffsetDetectionSteps[number]['id'];
+/**
+ * Template describing the ordered offset detection steps and their initial state.
+ *
+ * This array serves as the baseline structure for reporting progress during the
+ * offset detection procedure. It is typically cloned and mutated as the procedure
+ * executes, with each step transitioning through statuses such as:
+ * - 'idle'
+ * - 'running'
+ * - 'succeeded'
+ * - 'failed'
+ *
+ * The structure and order of this array define:
+ * - The sequence in which diagnostic steps are executed
+ * - The shape of progress updates emitted during the procedure
+ *
+ * Consumers should treat this array as immutable and use a cloned copy when
+ * tracking or displaying runtime progress.
+ */
+export declare const offsetDetectionSteps: OffsetDetectionSteps;
+/**
+ * Formats the value associated with a specific offset detection step.
+ *
+ * Depending on the provided `stepId`, this function will convert the raw `value` into a human-readable string
+ * or return the value as-is. The formatting is tailored to the type of step:
+ * - For 'openPhaseDetection', returns 'Yes' or 'No' based on the truthiness of `value`.
+ * - For 'phaseResistanceMeasurement', appends 'mΩ' to the value if defined.
+ * - For 'phaseInductanceMeasurement', appends 'μH' to the value if defined.
+ * - For 'polePairDetection', returns the value directly.
+ * - For 'motorPhaseOrderDetection', returns 'Normal' or 'Inverted' based on the value.
+ * - For 'commutationOffsetMeasurement', returns the value if defined.
+ * - For any other step, returns the value as-is.
+ *
+ * @param stepId - The identifier of the offset detection step.
+ * @param value - The value to be parsed and formatted.
+ * @returns The formatted value as a string or the original value, depending on the step.
+ */
+export declare function formatOffsetDetectionStepValue(stepId: OffsetDetectionStepId, value: number): string | number;
+export {};

package/src/lib/offset-detection.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatOffsetDetectionStepValue = exports.offsetDetectionSteps = void 0;
+/**
+ * Template describing the ordered offset detection steps and their initial state.
+ *
+ * This array serves as the baseline structure for reporting progress during the
+ * offset detection procedure. It is typically cloned and mutated as the procedure
+ * executes, with each step transitioning through statuses such as:
+ * - 'idle'
+ * - 'running'
+ * - 'succeeded'
+ * - 'failed'
+ *
+ * The structure and order of this array define:
+ * - The sequence in which diagnostic steps are executed
+ * - The shape of progress updates emitted during the procedure
+ *
+ * Consumers should treat this array as immutable and use a cloned copy when
+ * tracking or displaying runtime progress.
+ */
+exports.offsetDetectionSteps = [
+    {
+        id: 'openPhaseDetection',
+        label: 'Open Phase Detection',
+        status: 'idle',
+    },
+    {
+        id: 'phaseResistanceMeasurement',
+        label: 'Phase Resistance Measurement',
+        status: 'idle',
+    },
+    {
+        id: 'phaseInductanceMeasurement',
+        label: 'Phase Inductance Measurement',
+        status: 'idle',
+    },
+    {
+        id: 'polePairDetection',
+        label: 'Pole Pair Detection',
+        status: 'idle',
+    },
+    {
+        id: 'motorPhaseOrderDetection',
+        label: 'Motor Phase Order Detection',
+        status: 'idle',
+    },
+    {
+        id: 'commutationOffsetMeasurement',
+        label: 'Commutation Offset Measurement',
+        status: 'idle',
+    },
+];
+/**
+ * Formats the value associated with a specific offset detection step.
+ *
+ * Depending on the provided `stepId`, this function will convert the raw `value` into a human-readable string
+ * or return the value as-is. The formatting is tailored to the type of step:
+ * - For 'openPhaseDetection', returns 'Yes' or 'No' based on the truthiness of `value`.
+ * - For 'phaseResistanceMeasurement', appends 'mΩ' to the value if defined.
+ * - For 'phaseInductanceMeasurement', appends 'μH' to the value if defined.
+ * - For 'polePairDetection', returns the value directly.
+ * - For 'motorPhaseOrderDetection', returns 'Normal' or 'Inverted' based on the value.
+ * - For 'commutationOffsetMeasurement', returns the value if defined.
+ * - For any other step, returns the value as-is.
+ *
+ * @param stepId - The identifier of the offset detection step.
+ * @param value - The value to be parsed and formatted.
+ * @returns The formatted value as a string or the original value, depending on the step.
+ */
+function formatOffsetDetectionStepValue(stepId, value) {
+    var _a;
+    switch (stepId) {
+        case 'openPhaseDetection': {
+            return value ? 'Yes' : 'No';
+        }
+        case 'phaseResistanceMeasurement': {
+            return typeof value !== 'undefined' ? `${value} mΩ` : '';
+        }
+        case 'phaseInductanceMeasurement': {
+            return typeof value !== 'undefined' ? `${value} μH` : '';
+        }
+        case 'polePairDetection': {
+            return value;
+        }
+        case 'motorPhaseOrderDetection': {
+            const phases = ['Normal', 'Inverted'];
+            return (_a = phases[value]) !== null && _a !== void 0 ? _a : '';
+        }
+        case 'commutationOffsetMeasurement': {
+            return typeof value !== 'undefined' ? value : '';
+        }
+        default: {
+            return value;
+        }
+    }
+}
+exports.formatOffsetDetectionStepValue = formatOffsetDetectionStepValue;
+//# sourceMappingURL=offset-detection.js.map

package/src/lib/offset-detection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"offset-detection.js","sourceRoot":"","sources":["../../../../../libs/motion-master-client/src/lib/offset-detection.ts"],"names":[],"mappings":";;;AA8CA;;;;;;;;;;;;;;;;;GAiBG;AACU,QAAA,oBAAoB,GAAyB;IACxD;QACE,EAAE,EAAE,oBAAoB;QACxB,KAAK,EAAE,sBAAsB;QAC7B,MAAM,EAAE,MAAM;KACf;IACD;QACE,EAAE,EAAE,4BAA4B;QAChC,KAAK,EAAE,8BAA8B;QACrC,MAAM,EAAE,MAAM;KACf;IACD;QACE,EAAE,EAAE,4BAA4B;QAChC,KAAK,EAAE,8BAA8B;QACrC,MAAM,EAAE,MAAM;KACf;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,KAAK,EAAE,qBAAqB;QAC5B,MAAM,EAAE,MAAM;KACf;IACD;QACE,EAAE,EAAE,0BAA0B;QAC9B,KAAK,EAAE,6BAA6B;QACpC,MAAM,EAAE,MAAM;KACf;IACD;QACE,EAAE,EAAE,8BAA8B;QAClC,KAAK,EAAE,gCAAgC;QACvC,MAAM,EAAE,MAAM;KACf;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,8BAA8B,CAAC,MAA6B,EAAE,KAAa;;IACzF,QAAQ,MAAM,EAAE;QACd,KAAK,oBAAoB,CAAC,CAAC;YACzB,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;SAC7B;QACD,KAAK,4BAA4B,CAAC,CAAC;YACjC,OAAO,OAAO,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1D;QACD,KAAK,4BAA4B,CAAC,CAAC;YACjC,OAAO,OAAO,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1D;QACD,KAAK,mBAAmB,CAAC,CAAC;YACxB,OAAO,KAAK,CAAC;SACd;QACD,KAAK,0BAA0B,CAAC,CAAC;YAC/B,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACtC,OAAO,MAAA,MAAM,CAAC,KAAK,CAAC,mCAAI,EAAE,CAAC;SAC5B;QACD,KAAK,8BAA8B,CAAC,CAAC;YACnC,OAAO,OAAO,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;SAClD;QACD,OAAO,CAAC,CAAC;YACP,OAAO,KAAK,CAAC;SACd;KACF;AACH,CAAC;AAzBD,wEAyBC"}

package/src/lib/parameter.d.ts

@@ -316,7 +316,7 @@ export interface UIFeaturesConfig {
     disabledEncoderConfigurationIndexes?: number[];
     /**
      * Specifies the type of Setup Wizard to be used.
-     * - `'actilink'`: Uses the Actilink Setup Wizard, which supports unit configuration, limits setup, and auto-tuning.
+     * - `'actilink'`: Uses the ACTILINK-S Setup Wizard, which supports unit configuration, limits setup, and auto-tuning.
      * - `'default'`: Uses the default Setup Wizard, which supports motor, brake, and encoder configuration.
      */
     setupWizard: 'actilink' | 'default';

package/src/lib/product.d.ts

@@ -1,11 +1,11 @@
 import { HardwareDescription } from './hardware-description';
 export declare const productCategories: readonly ["SOMANET", "ACTILINK", "OBLAC", "MOTORCORTEX"];
 export type ProductCategory = (typeof productCategories)[number];
-export declare const productFamilies: readonly ["Node", "Circulo", "Integro", "Core", "ACTILINK-S Integro"];
+export declare const productFamilies: readonly ["Node", "Circulo", "Integro", "Core", "ACTILINK-S Integro", "ACTILINK-JD", "ACTILINK-JD Duo"];
 export type ProductFamily = (typeof productFamilies)[number];
-export declare const productGroups: readonly ["Node 400", "Node 1000", "Node 2000", "Circulo 7", "Circulo 9", "Integro 60", "Integro 80", "Actilink 60", "Actilink 80"];
+export declare const productGroups: readonly ["Node 400", "Node 1000", "Node 2000", "Circulo 7", "Circulo 9", "Integro 60", "Integro 80", "ACTILINK-S Integro 60", "ACTILINK-S Integro 80", "ACTILINK-JD", "ACTILINK-JD Duo"];
 export type ProductGroup = (typeof productGroups)[number];
-export declare const somanetProductRangeNames: readonly ["Circulo", "Circulo Safe Motion", "Integro", "Node", "Node Safety", "Internal", "Actilink S"];
+export declare const somanetProductRangeNames: readonly ["Circulo", "Circulo Safe Motion", "Integro", "Node", "Node Safety", "ACTILINK-S", "ACTILINK-JD", "ACTILINK-JD Duo"];
 export type SomanetProductRangeName = (typeof somanetProductRangeNames)[number];
 export type SomanetProductRangeNameAll = SomanetProductRangeName | 'Circulo All' | 'Node All';
 export interface SomanetProduct {
@@ -17,17 +17,91 @@ export interface SomanetProduct {
     name: string;
 }
 export declare const somanetProducts: SomanetProduct[];
+/**
+ * Defines a Somanet product range, including its name and firmware ID bounds.
+ *
+ * @property name - The logical name of the product range, e.g., "Circulo", "Node Safety".
+ *   Only values from `SomanetProductRangeName` are allowed.
+ *
+ * @property bounds - A tuple representing the inclusive firmware ID range for this product range.
+ *   The first element is the minimum ID, and the second element is the maximum ID.
+ *   Used for validating or filtering products by their firmware IDs.
+ * ```
+ */
 export interface SomanetProductRange {
     name: SomanetProductRangeName;
     bounds: [number, number];
 }
+/**
+ * List of all defined SOMANET product ranges with their corresponding firmware ID bounds.
+ *
+ * Each entry maps a `SomanetProductRangeName` to a numeric range that represents
+ * the inclusive firmware IDs associated with that product range.
+ *
+ * These ranges are used for:
+ * - Validating firmware IDs for a given product.
+ * - Filtering or grouping products by range.
+ * - Mapping devices to their logical product ranges in the UI or API.
+ */
 export declare const somanetProductRanges: SomanetProductRange[];
+/**
+ * Finds the Somanet product range corresponding to a given product ID.
+ *
+ * The function resolves the product ID (number, string, or `HardwareDescription`)
+ * to a numeric ID, and then searches through `somanetProductRanges` to find
+ * the range whose bounds include the ID.
+ *
+ * @param productId - The product identifier to look up. Can be:
+ *   - A numeric product ID
+ *   - A string representation of the ID
+ *   - A `HardwareDescription` object
+ *   - `null` or `undefined`, in which case the function returns `undefined`
+ *
+ * @returns The `SomanetProductRange` whose bounds contain the resolved ID,
+ *   or `undefined` if no matching range is found or the input is invalid.
+ */
 export declare function findSomanetProductRangeByProductId(productId?: number | string | HardwareDescription | null): SomanetProductRange | undefined;
+/**
+ * Finds a SOMANET product by its product ID.
+ *
+ * This function resolves the input `productId` (number, string, or `HardwareDescription`)
+ * to a numeric ID and searches the `somanetProducts` array for a product with a matching ID.
+ *
+ * @param productId - The product identifier to look up. Can be:
+ *   - A numeric product ID
+ *   - A string representing the product ID
+ *   - A `HardwareDescription` object
+ *   - `null` or `undefined`, in which case the function returns `undefined`
+ *
+ * @returns The matching `SomanetProduct` object if found, or `undefined` if no match exists
+ *   or if the input is invalid.
+ */
 export declare function findSomanetProductById(productId?: number | string | HardwareDescription | null): SomanetProduct | undefined;
 /**
  * @deprecated use isSomanetProductIdInRange instead
  */
 export declare function isProductIdOfType(productId?: number | string | HardwareDescription | null, type?: SomanetProductRangeNameAll): boolean;
+/**
+ * Checks whether a given product ID belongs to a specified SOMANET product range.
+ *
+ * This function resolves the `productId` to a numeric ID, determines the corresponding
+ * `SomanetProductRange`, and checks if it matches the provided `rangeName`.
+ *
+ * Special aggregate ranges (`Circulo All` and `Node All`) are supported:
+ * - `"Circulo All"` includes: `"Circulo"`, `"Circulo Safe Motion"`, `"ACTILINK-JD"`, `"ACTILINK-JD Duo"`
+ * - `"Node All"` includes: `"Node"`, `"Node Safety"`
+ *
+ * @param productId - The product identifier to check. Can be:
+ *   - A numeric product ID
+ *   - A string representing the product ID
+ *   - A `HardwareDescription` object
+ *   - `null` or `undefined`, in which case the function returns `false`
+ *
+ * @param rangeName - The product range to check against. Can be any `SomanetProductRangeName`
+ *   or the aggregate values `"Circulo All"` / `"Node All"`.
+ *
+ * @returns `true` if the product belongs to the specified range; otherwise, `false`.
+ */
 export declare function isSomanetProductIdInRange(productId?: number | string | HardwareDescription | null, rangeName?: SomanetProductRangeNameAll): boolean;
 export type SomanetCirculoVariantId = 'ECDN_E1' | 'ECAN' | 'ECBN' | 'ECNN' | 'ECDL' | 'ECDB_E1';
 export interface SomanetCirculoVariant {
@@ -43,27 +117,86 @@ export declare const ECDB_E1_IDS: number[];
 export declare const usableCirculoEncoderPortProductIds: number[][];
 export declare const somanetCirculoVariants: SomanetCirculoVariant[];
 /**
- * Whether the encoder port is internal or not depends on the port position and product ID.
+ * Determines whether a given encoder port on a device is an internal port
+ * based on the product type and port number.
  *
- * Circulo has internal encoders, specifically at port positions 1 and 2.
- * Note that for Circulo variants that lack internal encoders on port positions 1 and 2, this function will return false.
+ * The function checks:
+ * - If the product belongs to specific Somanet ranges (`Integro` or `ACTILINK-S`) and the port is 1.
+ * - If the product ID matches known Circulo variants for specific ports (ECAN, ECBN, ECDN_E1, ECDL, ECDB_E1).
+ * - Special case product IDs (8510, 8511, 8610, 8611) on ports 1 or 2.
  *
- * Integro will have an internal encoder only at port position 1.
+ * @param port - The encoder port number (1-based index).
+ * @param productId - Optional product identifier. Can be a number, string, `HardwareDescription`, or `null`.
+ *                    If omitted, the function returns `false`.
+ * @returns `true` if the specified port is considered internal for the given product, otherwise `false`.
  */
 export declare function isEncoderPortInternal(port: number, productId?: number | string | HardwareDescription | null): boolean;
 /**
- * Whether the encoder port is usable or not depends on the port position and product ID.
+ * Determines whether a specific encoder port on a device is usable for a given product.
+ *
+ * The function checks:
+ * - If no product ID is provided or resolved, the port is considered usable (`true`).
+ * - For products in the SOMANET Circulo family (`Circulo All`):
+ *   - Port 5 is always usable as a Digital I/O port.
+ *   - Ports 1–4 are checked against the known usable product IDs for each internal/external port.
+ *   - If a Circulo product ID is unrecognized, the port is considered usable by default.
  *
- * Circulo has many variants, such as having an internal encoder on both ports 1 and 2, or only on port 1, or only on port 2,
- * or having no internal encoders at all. If internal encoder port 1 is used, then external encoder port 1 cannot be used, and so on.
+ * @param port - The encoder port number (1-based index).
+ * @param productId - Optional product identifier. Can be a number, string, `HardwareDescription`, or `null`.
+ *                    If omitted, the function assumes the port is usable.
+ * @returns `true` if the port is usable for the specified product, otherwise `false`.
  */
 export declare function isEncoderPortUsable(port: number, productId?: number | string | HardwareDescription | null): boolean;
 /**
- * This function only considers the internal encoder ports of Circulo and Integro, specifically ports at positions 1 and 2.
- * It will return false for other port positions because they cannot serve as internal encoders.
- * The usability of encoder ports depends on the Circulo variant.
+ * Determines whether a given internal encoder port is usable for a specific product.
+ *
+ * Checks:
+ * - Circulo products: ports 1 and 2 are considered internal and checked via `isEncoderPortUsable`.
+ * - Integro products: port 1 is always usable.
+ *
+ * @param port - The encoder port number (1-based index).
+ * @param productId - Optional product identifier (number, string, or `HardwareDescription`).
+ * @returns `true` if the port is an internal port and usable, otherwise `false`.
  */
 export declare function isInternalEncoderPortUsable(port: number, productId?: number | string | HardwareDescription | null): boolean;
+/**
+ * Returns a human-readable name for an encoder port for a given product.
+ *
+ * Circulo products:
+ * - Ports 1–2 → "Integrated encoder 1/2"
+ * - Ports 3–4 → "External encoder 1/2"
+ * - Port 5 → "Digital I/O"
+ *
+ * Other products: returns `"Port X"`.
+ *
+ * @param port - The encoder port number (1-based index).
+ * @param productId - Optional product identifier (number, string, or `HardwareDescription`).
+ * @returns The display name for the encoder port.
+ */
 export declare function getEncoderPortName(port: number, productId?: number | string | HardwareDescription | null): string;
+/**
+ * Resolves a product ID from different possible representations.
+ *
+ * Supports:
+ * - Numbers → returned as-is
+ * - Strings → serial number format or 4-digit product ID
+ * - `HardwareDescription` objects → uses `getIdFromHardwareDescription`
+ *
+ * @param value - The value to resolve into a numeric product ID.
+ * @returns The numeric product ID, or `undefined` if it cannot be resolved.
+ */
 export declare function resolveProductId(value?: number | string | HardwareDescription | null): number | undefined;
+/**
+ * Returns the number of encoder ports available for a given product.
+ *
+ * Mapping of product families to encoder ports:
+ * - **Circulo All** → 5 ports
+ * - **Integro** → 2 ports
+ * - **Node All** → 3 ports
+ * - **ACTILINK-S** → 2 ports
+ * - **Others** → 5 ports (fallback for unrecognized products)
+ *
+ * @param productId - Optional product identifier. Can be a number, string, or `HardwareDescription`.
+ * @returns The number of encoder ports for the specified product.
+ */
 export declare function getNumberOfEncoderPortsByProductId(productId?: number | string | HardwareDescription | null): number;