@synapticon/motion-master-client 6.0.0-alpha.57 → 6.0.0-alpha.59

package/dist/generated/Api.d.ts

@@ -657,6 +657,58 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          */
         value: number;
     }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<void, void>>;
+    /**
+     * @description Commands the device to persist its current parameters (the generic CANopen "store parameters" object 0x1010:01) and waits for confirmation. The server writes the ASCII "save" signature, waits a fixed settle (~1 s) for the drive to begin the flash write, then polls 0x1010:01 until it reads back 1 ("save completed"). Because a store in progress can leave the mailbox briefly unresponsive, a poll that does not yet confirm — a value mismatch or a transient read error alike — is retried up to `retries` more times, `interval` apart. The call blocks until the store is confirmed or the retry budget is exhausted (up to a few seconds); the device's mailbox must be active (PRE-OP/SAFE-OP/OP).
+     *
+     * @name StoreParameters
+     * @summary Store a device's parameters to non-volatile memory
+     * @request POST:/api/devices/{slavePosition}/store-parameters
+     */
+    storeParameters: (slavePosition: number, query?: {
+        /**
+         * Maximum number of extra confirmation polls after the first.
+         * @min 0
+         * @default 10
+         * @example 5
+         */
+        retries?: number;
+        /**
+         * Delay between confirmation polls, in milliseconds.
+         * @min 0
+         * @default 500
+         * @example 500
+         */
+        interval?: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<void, void>>;
+    /**
+     * @description Commands the device to restore its default parameters (the generic CANopen "restore default parameters" object 0x1011) for the selected `group`, and waits for confirmation. The server writes the ASCII "load" signature to the matching 0x1011 sub-entry, waits a fixed settle (~1 s) for the device to begin, then polls that sub-entry until it reads back 1 ("restore completed"), retrying a poll that does not yet confirm — a value mismatch or a transient read error alike — up to `retries` more times, `interval` apart. The call blocks until the restore is confirmed or the retry budget is exhausted (up to a few seconds); the device's mailbox must be active (PRE-OP/SAFE-OP/OP). **Destructive:** this overwrites the selected group's parameter values in the device's volatile memory with the device's defaults, replacing the current live values (not the persisted store). Which values it touches, and whether it takes effect immediately or after the next reset, is device-specific.
+     *
+     * @name RestoreDefaultParameters
+     * @summary Restore a device's default parameters
+     * @request POST:/api/devices/{slavePosition}/restore-default-parameters
+     */
+    restoreDefaultParameters: (slavePosition: number, query?: {
+        /**
+         * Which group of defaults to restore — all (0x1011:01), communication (0x1011:02), application (0x1011:03), or manufacturer (0x1011:04).
+         * @default "all"
+         * @example "all"
+         */
+        group?: "all" | "communication" | "application" | "manufacturer";
+        /**
+         * Maximum number of extra confirmation polls after the first.
+         * @min 0
+         * @default 10
+         * @example 5
+         */
+        retries?: number;
+        /**
+         * Delay between confirmation polls, in milliseconds.
+         * @min 0
+         * @default 500
+         * @example 500
+         */
+        interval?: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<void, void>>;
     /**
      * @description Performs a CoE SDO upload — reads the value of object `index:subindex` from the device at `slavePosition` and returns the raw bytes as a JSON array. Both `index` and `subindex` accept decimal or hexadecimal notation; prefix with `0x` for hex (e.g. `0x6064` or `24676` for object 0x6064).
      *

package/dist/generated/Api.js

@@ -456,6 +456,32 @@ export class Api extends HttpClient {
         type: ContentType.Json,
         ...params,
     });
+    /**
+     * @description Commands the device to persist its current parameters (the generic CANopen "store parameters" object 0x1010:01) and waits for confirmation. The server writes the ASCII "save" signature, waits a fixed settle (~1 s) for the drive to begin the flash write, then polls 0x1010:01 until it reads back 1 ("save completed"). Because a store in progress can leave the mailbox briefly unresponsive, a poll that does not yet confirm — a value mismatch or a transient read error alike — is retried up to `retries` more times, `interval` apart. The call blocks until the store is confirmed or the retry budget is exhausted (up to a few seconds); the device's mailbox must be active (PRE-OP/SAFE-OP/OP).
+     *
+     * @name StoreParameters
+     * @summary Store a device's parameters to non-volatile memory
+     * @request POST:/api/devices/{slavePosition}/store-parameters
+     */
+    storeParameters = (slavePosition, query, params = {}) => this.request({
+        path: `/api/devices/${slavePosition}/store-parameters`,
+        method: "POST",
+        query: query,
+        ...params,
+    });
+    /**
+     * @description Commands the device to restore its default parameters (the generic CANopen "restore default parameters" object 0x1011) for the selected `group`, and waits for confirmation. The server writes the ASCII "load" signature to the matching 0x1011 sub-entry, waits a fixed settle (~1 s) for the device to begin, then polls that sub-entry until it reads back 1 ("restore completed"), retrying a poll that does not yet confirm — a value mismatch or a transient read error alike — up to `retries` more times, `interval` apart. The call blocks until the restore is confirmed or the retry budget is exhausted (up to a few seconds); the device's mailbox must be active (PRE-OP/SAFE-OP/OP). **Destructive:** this overwrites the selected group's parameter values in the device's volatile memory with the device's defaults, replacing the current live values (not the persisted store). Which values it touches, and whether it takes effect immediately or after the next reset, is device-specific.
+     *
+     * @name RestoreDefaultParameters
+     * @summary Restore a device's default parameters
+     * @request POST:/api/devices/{slavePosition}/restore-default-parameters
+     */
+    restoreDefaultParameters = (slavePosition, query, params = {}) => this.request({
+        path: `/api/devices/${slavePosition}/restore-default-parameters`,
+        method: "POST",
+        query: query,
+        ...params,
+    });
     /**
      * @description Performs a CoE SDO upload — reads the value of object `index:subindex` from the device at `slavePosition` and returns the raw bytes as a JSON array. Both `index` and `subindex` accept decimal or hexadecimal notation; prefix with `0x` for hex (e.g. `0x6064` or `24676` for object 0x6064).
      *

package/dist/generated/data-contracts.d.ts

@@ -798,6 +798,11 @@ export interface DeviceParameter {
      * @example 7
      */
     access: number;
+    /**
+     * Where this parameter's definition came from. `objectDictionary` — enumerated over the CoE object dictionary (SDO-Info). `sii` — derived from the SII EEPROM PDO categories, for a mailbox-less slave (an EtherCAT coupler / simple I/O terminal) that has no CoE object dictionary; such a parameter has no live SDO access, so its value comes only from the process image.
+     * @example "objectDictionary"
+     */
+    origin: "objectDictionary" | "sii";
     /**
      * Last-known value, decoded according to `dataType`.  Initialised to a type-appropriate zero (0 for numbers, "" for strings, [] for raw bytes) before the first read.  After a successful SDO upload, holds the decoded value; the JSON encoding follows the variant alternative — number, string, or array of byte values.
      * @example 12345

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synapticon/motion-master-client",
-  "version": "6.0.0-alpha.57",
+  "version": "6.0.0-alpha.59",
   "description": "Isomorphic TypeScript client for Motion Master: the generated HTTP API client, the WebSocket connection, and helpers.",
   "license": "MIT",
   "repository": {