motion-master-client 0.0.282 → 0.0.284

package/src/lib/types.d.ts

@@ -346,3 +346,50 @@ export interface MotionMasterConnectionConfig {
      */
     secure?: boolean;
 }
+/**
+ * Defines the structure for storing and representing supported parameter options,
+ * organized by firmware version, versioned device product ID, and positional index.
+ *
+ * The positional index typically refers to hardware elements such as:
+ * - Encoder ports
+ * - Digital I/Os (DIOs)
+ * - Analog inputs (AIs)
+ *
+ * Each inner array represents the allowed option values (e.g., encoder types) for the corresponding position (port).
+ *
+ * @example Encoder type parameter options:
+ * {
+ *   "5.4": {
+ *     "8500-01": [
+ *       [0],                   // First port: no encoder types are allowed
+ *       [0, 1, 2, 3, 4, 7, 9], // Second port: supports these encoder types
+ *       [0, 4, 7, 9],          // Third port: supports a subset of encoder types
+ *       [0],                   // Fourth port: no encoder types can be selected
+ *     ],
+ *   },
+ * }
+ */
+export interface FirmwareProductSupportedOptions {
+    [firmwareVersion: string]: {
+        [versionedDeviceProductId: string]: number[][];
+    };
+}
+/**
+ * Represents a tabular configuration for a part, such as a motor or encoder.
+ *
+ * The `header` array defines the columns, each specifying a name and an optional address,
+ * where the address typically includes an index and subindex identifying the parameter.
+ *
+ * The `values` array contains rows of configuration data, with each row aligned to the header columns.
+ */
+export interface PartConfigurationTable {
+    /** The columns describing each part or field. */
+    header: {
+        /** The display name of the part or configuration field. */
+        name: string;
+        /** (Optional) The address (index and subindex) matching the parameter. */
+        address?: string;
+    }[];
+    /** Rows of configuration data matching the header columns. */
+    values: (string | number | boolean | null)[][];
+}