@synapticon/motion-master-client 6.0.0-alpha.82 → 6.0.0-alpha.84

package/dist/generated/Api.d.ts

@@ -495,7 +495,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
         }[];
     }[], any>>;
     /**
-     * @description The register map of the Integro's internal (Kübler) encoder — the reference table for POST /api/devices/{slavePosition}/procedures/kuebler-register-communication, and documentation in its own right. Static: it describes the encoder type, not any connected device, so it needs no bus and no scan. Transcribed from the vendor's own draft table. Each entry carries the width, the access type, whether the encoder actually implements it — seven are documented but not implemented — and the vendor's bit definitions verbatim, which for a bit-field register is the only place its meaning is recorded. `format` says how to read the assembled value, because signedness is not uniform and one register is not a single number at all: `unsigned`, `signed`, `bitField` (the number means nothing on its own), or `signedHalves` — two signed 16-bit values packed into 32 bits, which register 0x3C is the only case of. `readableInOneCommand` is false for the one 64-bit register, since the command's length byte caps at 4 bytes.
+     * @description The register map of the Integro's internal (Kübler) encoder — the reference table for POST /api/devices/{slavePosition}/procedures/kuebler-register-communication, and documentation in its own right. Static: it describes the encoder type, not any connected device, so it needs no bus and no scan. Transcribed from the vendor's own draft table, then corrected against what the encoder really does: the draft calls four registers not implemented that the encoder calibration sequence reads or writes, and leaves out four more. Each entry carries the width, the access type, whether the encoder implements it, and the vendor's bit definitions verbatim, which for a bit-field register is the only place its meaning is recorded. A register the draft does not document says so in `definition`, because a reader has nowhere else to look. `format` says how to read the assembled value, because signedness is not uniform and one register is not a single number at all: `unsigned`, `signed`, `bitField` (the number means nothing on its own), or `signedHalves` — two signed 16-bit values packed into 32 bits, which register 0x3C is the only case of. `readableInOneCommand` says whether one command can carry the register, since the command's length byte caps at 4 bytes. Every register fits today, so it is true for all of them.
      *
      * @name GetKueblerRegisters
      * @summary The Integro internal encoder's register map
@@ -1028,6 +1028,23 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          */
         error: string;
     }>>;
+    /**
+     * @description Deletes `filename` from the flash of the device at `slavePosition`. **Vendor-specific despite reading like a filesystem operation.** FoE has no delete, so SOMANET firmware acts on a pseudo-file instead: reading the name `fs-remove=<filename>` removes that file. This endpoint exists so no client has to know that, and a device that is not a SOMANET drive is refused rather than probed. **A file that was not there answers 200.** The caller asked for the file to be gone, and it is. Every other FoE failure is a 500 naming the reason. The file is gone from flash immediately. Deleting `config.csv` discards the stored parameter values, so the drive falls back to its defaults on the next power cycle.
+     *
+     * @name DeleteDeviceFile
+     * @summary Delete a file from a device
+     * @request DELETE:/api/devices/{slavePosition}/files/{filename}
+     */
+    deleteDeviceFile: (slavePosition: number, filename: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** @example true */
+        ok?: boolean;
+    }, void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
     /**
      * @description Reads the raw SII EEPROM image of the device at `slavePosition` through the ESC's EEPROM-control registers and returns either the parsed structure or the raw bytes, selected by the `Accept` request header. With `Accept: application/json` (or `*\/*`, or no `Accept` header) the parsed `SlaveInformationInterface` is returned — the 128-byte fixed header plus the decoded category section (strings, general info, FMMU/Sync-Manager and PDO defaults, distributed-clock settings).  With `Accept: application/octet-stream` the raw EEPROM image is returned unparsed, suitable for a hex dump or archival. EEPROM access is a control-plane operation and is most reliable while the device is in INIT or PRE-OP.  String-index fields in the parsed structure (e.g. `general.nameIdx`) are 1-based references into `category.strings`.
      *

package/dist/generated/Api.js

@@ -273,7 +273,7 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description The register map of the Integro's internal (Kübler) encoder — the reference table for POST /api/devices/{slavePosition}/procedures/kuebler-register-communication, and documentation in its own right. Static: it describes the encoder type, not any connected device, so it needs no bus and no scan. Transcribed from the vendor's own draft table. Each entry carries the width, the access type, whether the encoder actually implements it — seven are documented but not implemented — and the vendor's bit definitions verbatim, which for a bit-field register is the only place its meaning is recorded. `format` says how to read the assembled value, because signedness is not uniform and one register is not a single number at all: `unsigned`, `signed`, `bitField` (the number means nothing on its own), or `signedHalves` — two signed 16-bit values packed into 32 bits, which register 0x3C is the only case of. `readableInOneCommand` is false for the one 64-bit register, since the command's length byte caps at 4 bytes.
+     * @description The register map of the Integro's internal (Kübler) encoder — the reference table for POST /api/devices/{slavePosition}/procedures/kuebler-register-communication, and documentation in its own right. Static: it describes the encoder type, not any connected device, so it needs no bus and no scan. Transcribed from the vendor's own draft table, then corrected against what the encoder really does: the draft calls four registers not implemented that the encoder calibration sequence reads or writes, and leaves out four more. Each entry carries the width, the access type, whether the encoder implements it, and the vendor's bit definitions verbatim, which for a bit-field register is the only place its meaning is recorded. A register the draft does not document says so in `definition`, because a reader has nowhere else to look. `format` says how to read the assembled value, because signedness is not uniform and one register is not a single number at all: `unsigned`, `signed`, `bitField` (the number means nothing on its own), or `signedHalves` — two signed 16-bit values packed into 32 bits, which register 0x3C is the only case of. `readableInOneCommand` says whether one command can carry the register, since the command's length byte caps at 4 bytes. Every register fits today, so it is true for all of them.
      *
      * @name GetKueblerRegisters
      * @summary The Integro internal encoder's register map
@@ -765,6 +765,19 @@ export class Api extends HttpClient {
         format: "json",
         ...params,
     });
+    /**
+     * @description Deletes `filename` from the flash of the device at `slavePosition`. **Vendor-specific despite reading like a filesystem operation.** FoE has no delete, so SOMANET firmware acts on a pseudo-file instead: reading the name `fs-remove=<filename>` removes that file. This endpoint exists so no client has to know that, and a device that is not a SOMANET drive is refused rather than probed. **A file that was not there answers 200.** The caller asked for the file to be gone, and it is. Every other FoE failure is a 500 naming the reason. The file is gone from flash immediately. Deleting `config.csv` discards the stored parameter values, so the drive falls back to its defaults on the next power cycle.
+     *
+     * @name DeleteDeviceFile
+     * @summary Delete a file from a device
+     * @request DELETE:/api/devices/{slavePosition}/files/{filename}
+     */
+    deleteDeviceFile = (slavePosition, filename, params = {}) => this.request({
+        path: `/api/devices/${slavePosition}/files/${filename}`,
+        method: "DELETE",
+        format: "json",
+        ...params,
+    });
     /**
      * @description Reads the raw SII EEPROM image of the device at `slavePosition` through the ESC's EEPROM-control registers and returns either the parsed structure or the raw bytes, selected by the `Accept` request header. With `Accept: application/json` (or `*\/*`, or no `Accept` header) the parsed `SlaveInformationInterface` is returned — the 128-byte fixed header plus the decoded category section (strings, general info, FMMU/Sync-Manager and PDO defaults, distributed-clock settings).  With `Accept: application/octet-stream` the raw EEPROM image is returned unparsed, suitable for a hex dump or archival. EEPROM access is a control-plane operation and is most reliable while the device is in INIT or PRE-OP.  String-index fields in the parsed structure (e.g. `general.nameIdx`) are 1-based references into `category.strings`.
      *

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

@@ -418,7 +418,7 @@ export interface ProgressStep {
     /** @example "succeeded" */
     status: "idle" | "running" | "succeeded" | "failed";
     /**
-     * What the step produced, if anything — shape is per procedure. Absent when the step produced nothing. For `os-command` it is an object with `status`, `data`, and `errorCode` when the drive sent one.
+     * What the step produced, if anything — shape is per procedure. Absent when the step produced nothing. For `os-command` it is an object with `status`, `data`, `errorCode` when the drive sent one, and `fsBuffer` when the request asked to read bulk data. For `read-object-dictionary` it is an object with `byteCount` and `values`, one entry per object with its `index`, `subindex` and `value`.
      * @example {"status":1,"data":[1,2,3,4,5,6]}
      */
     value?: any;
@@ -897,6 +897,14 @@ export interface ProcedureRequest {
      * @default 10
      */
     pollIntervalMs?: number;
+    /**
+     * `os-command` only: whether the command moves bulk data through the drive's fs-buffer, and which way. Most commands move none. The transfer runs while the command runs, because the drive holds the command in progress until all the data has moved, and it needs firmware 5.2 or newer. Setting a direction for a command that moves no bulk data leaves the server waiting for a transfer the drive will never start.
+     * @default "none"
+     * @example "read"
+     */
+    fsBuffer?: "none" | "read" | "write";
+    /** `os-command` only, and required when `fsBuffer` is `write`: the bytes to send, base64-encoded into this JSON string. Rejected for the other two directions rather than ignored, so a request that names one and forgets the other is told rather than running a command that moves nothing. (Deliberately not `format: byte`, for the reason spelled out on `packageContent`.) */
+    fsBufferData?: string;
     /**
      * `encoder-register-communication` and `ic-mu-calibration-mode`: which of the drive's encoders to address. Encoder 1 is the encoder configured in 0x2110 and encoder 2 the one configured in 0x2112, so the ordinal picks a configuration object rather than a kind of encoder.
      * @default 1

package/dist/web-socket-connection.d.ts

@@ -19,6 +19,7 @@ type MonitoringListener = (rows: MonitoringBatch) => void;
 type NotificationListener = (data: unknown) => void;
 type ProgressListener = (data: unknown) => void;
 type StateListener = (state: ReadyState) => void;
+export declare const NOTIFICATION_TOPIC = "notifications";
 export interface WebSocketLike {
     readyState: number;
     send(data: string): void;

package/dist/web-socket-connection.js

@@ -3,12 +3,20 @@
 // progress, and client->server topic subscribe/unsubscribe. It owns reconnection, multiplexes
 // per-topic subscriptions over the one socket (ref-counted: subscribe on the first listener,
 // unsubscribe on the last, re-subscribe everything on reconnect), and routes inbound frames by
-// type. It is isomorphic: the browser global `WebSocket` is used by default, and any compatible
-// implementation (e.g. the Node `ws` package) can be injected — there is no hard dependency on
-// either, so the package stays usable in both environments.
+// type. Nothing arrives until something is subscribed: `subscribe(topic, cb)` for one monitoring's
+// batches, `onNotification(cb)` for every server notification — the latter is one shared topic, so
+// a single subscription covers events added in a later server version. It is isomorphic: the
+// browser global `WebSocket` is used by default, and any compatible implementation (e.g. the Node
+// `ws` package) can be injected — there is no hard dependency on either, so the package stays
+// usable in both environments.
 /// The numeric `readyState` value a WebSocket reports when it is open. Hard-coded (rather than read
 /// off a global) so the client never depends on a particular `WebSocket` implementation's statics.
 const WS_OPEN = 1;
+/// The one topic every server notification is published to. One topic rather than one per event, so
+/// a client subscribes once and keeps receiving events added in a later server version — uWebSockets
+/// matches topic names exactly, with no wildcard, so there is no way to ask for "all of them".
+/// Events are told apart by `data.event`, which is kebab-case.
+export const NOTIFICATION_TOPIC = 'notifications';
 export class WebSocketConnection {
     url;
     WebSocketImpl;
@@ -69,6 +77,9 @@ export class WebSocketConnection {
             for (const topic of this.topicListeners.keys()) {
                 this.send({ subscribe: topic });
             }
+            if (this.notificationListeners.size > 0) {
+                this.send({ subscribe: NOTIFICATION_TOPIC });
+            }
         };
         socket.onmessage = (event) => this.route(event.data);
         socket.onclose = () => this.handleDisconnect();
@@ -117,13 +128,21 @@ export class WebSocketConnection {
             }
         };
     }
-    /// Registers a listener for server notifications (e.g. `{ event: 'slaves_changed' }`). Connects
-    /// lazily. Returns a removal function.
+    /// Registers a listener for server notifications (e.g. `{ event: 'short-working-counter' }`). Every
+    /// notification arrives on one topic, so the first listener subscribes and the last to leave
+    /// unsubscribes — the same ref-counting `subscribe` uses. Connects lazily. Returns a removal
+    /// function.
     onNotification(listener) {
+        if (this.notificationListeners.size === 0) {
+            this.send({ subscribe: NOTIFICATION_TOPIC });
+        }
         this.notificationListeners.add(listener);
         this.connect();
         return () => {
             this.notificationListeners.delete(listener);
+            if (this.notificationListeners.size === 0) {
+                this.send({ unsubscribe: NOTIFICATION_TOPIC });
+            }
         };
     }
     /// Registers a listener for procedure progress messages (reserved; fires once the backend ships

package/package.json

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