@synapticon/motion-master-client 6.0.0-alpha.88 → 6.0.0-alpha.89

package/dist/generated/Api.d.ts

@@ -297,14 +297,29 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @example true
          */
         isCia402: boolean;
+        /**
+         * Whether the device is a SOMANET device, which runs SOMANET firmware. The server decides this from the vendor ID: Synapticon (0x22D2) or Sensodrive (0x063A). Gates the SOMANET features, such as the SOMANET files and the SOMANET procedures.
+         * @example true
+         */
+        isSomanet: boolean;
         /**
          * Whether an object-dictionary read for this device has failed since it was scanned. The automatic read on reaching a mailbox-active state is attempted once, so a device flagged here keeps an empty parameter list until `POST /api/devices/{slavePosition}/parameters/init` is called; that clears the flag on success.
          * @example false
          */
         parametersUnavailable: boolean;
+        /**
+         * Whether the device has an EtherCAT Slave Controller: SII, ESC registers, distributed clocks and the ESC diagnostics. False over SPoE, where those endpoints answer 409.
+         * @example true
+         */
+        supportsEsc?: boolean;
+        /**
+         * Whether the transport can blink the device's LEDs, which is what the `device-locate` procedure does. True over SPoE.
+         * @example false
+         */
+        supportsLocate?: boolean;
     }, void>>;
     /**
-     * @description Constructs the requested fieldbus driver, opens the network interface, and makes the driver available for subsequent calls to /api/scan. The driver defaults to SOEM when omitted. SOEM has no adapter auto-detect: a network adapter must be supplied, otherwise init fails.
+     * @description Constructs the requested fieldbus driver and makes it available for subsequent calls to /api/scan. The body is the `fieldbus` block of the config file, and the same rules check it. The driver defaults to SOEM when omitted. SOEM opens the network interface. It has no adapter auto-detect: a network adapter must be supplied, otherwise init fails. SPoE connects to each drive at scan time. It needs `ipAddresses`, one address per drive, and the list order is the position order.
      *
      * @name Init
      * @summary Initialise the fieldbus driver
@@ -312,16 +327,42 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      */
     init: (data?: {
         /**
-         * Fieldbus driver to use (only soem is implemented today; spoe is planned)
+         * Fieldbus driver to use
          * @default "soem"
          * @example "soem"
          */
         driver?: "soem" | "spoe";
         /**
-         * Network interface name or MAC address. Required for SOEM — there is no auto-detect, so an empty value makes init fail.
+         * SOEM only. Network interface name or MAC address. Required for SOEM — there is no auto-detect, so an empty value makes init fail.
          * @example "eth0"
          */
         adapter?: string;
+        /**
+         * SPoE only. One IP address per drive, at least one. The list order is the position order, and a drive that does not answer keeps its position.
+         * @example ["192.168.0.10"]
+         */
+        ipAddresses?: string[];
+        /** SPoE only. */
+        spoe?: {
+            /**
+             * Who owns the drive's state. In `monitor` mode a PLC owns it, Motion Master only parametrises and observes, and a state change answers 409. In `control` mode Motion Master owns it.
+             * @default "monitor"
+             */
+            mode?: "monitor" | "control";
+            /**
+             * Control mode only. The drive faults when no SPoE message arrives for this long. At least 50. Firmware with SPoE protocol 1.0 cannot set it and uses a fixed watchdog.
+             * @min 50
+             * @default 75
+             */
+            watchdogMs?: number;
+            /**
+             * The TCP port of the SPoE server on every drive.
+             * @min 1
+             * @max 65535
+             * @default 8080
+             */
+            port?: number;
+        };
     }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
         /** @example true */
         ok: boolean;
@@ -336,7 +377,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
         error: string;
     }>>;
     /**
-     * @description Scans the fieldbus for slaves and configures their sync managers and FMMUs. Must be called after a successful POST /api/init. Slaves remain in INIT state after this call; state transitions are driven by subsequent API calls. An empty bus is a successful scan returning 0 slaves, not an error: the master cannot distinguish a bus with no devices powered from a disconnected one, and the user recovers by powering devices on and scanning again. A 500 is returned only on a genuine driver failure (e.g. no driver initialised). A scan does not wait for work already in flight. A procedure that is running keeps running against the devices it started on, and fails at its next bus transfer. Retained procedure snapshots are discarded, because a position may name different hardware after a scan. A scan frees the recording, the retained process images and the previous device set, so it first waits up to 200 ms for the real-time loop to leave the cycle it is in. If the loop is stalled — a cyclic task that overruns, or severe CPU contention — the scan fails with 500 and changes nothing, rather than freeing memory the loop is still reading. `GET /api/game-loop` shows the stall. The same applies to `POST /api/process-data`, which re-allocates the recorder. `POST /api/reset` never fails this way: it holds the memory back instead and reclaims it later.
+     * @description Scans the fieldbus for slaves and configures their sync managers and FMMUs. Must be called after a successful POST /api/init. With SOEM, slaves remain in INIT state after this call, and state transitions are driven by subsequent API calls. An SPoE drive starts in OP. When a scan finds a device already in SAFE-OP or OP, it reads that device's object dictionary and publishes the process image, so the exchange starts with no state change. The dictionary comes from the parameter cache when the cache has it. Otherwise the first read of a drive model takes several seconds. If this step fails, the scan still returns 200 and the server logs a warning. A later state change to SAFE-OP or OP maps the image again. An empty bus is a successful scan returning 0 slaves, not an error: the master cannot distinguish a bus with no devices powered from a disconnected one, and the user recovers by powering devices on and scanning again. A 500 is returned only on a genuine driver failure (e.g. no driver initialised). A scan does not wait for work already in flight. A procedure that is running keeps running against the devices it started on, and fails at its next bus transfer. Retained procedure snapshots are discarded, because a position may name different hardware after a scan. A scan frees the recording, the retained process images and the previous device set, so it first waits up to 200 ms for the real-time loop to leave the cycle it is in. If the loop is stalled — a cyclic task that overruns, or severe CPU contention — the scan fails with 500 and changes nothing, rather than freeing memory the loop is still reading. `GET /api/game-loop` shows the stall. The same applies to `POST /api/process-data`, which re-allocates the recorder. `POST /api/reset` never fails this way: it holds the memory back instead and reclaims it later.
      *
      * @name Scan
      * @summary Scan the bus for slaves
@@ -659,6 +700,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          */
         data: number[];
     }, void | {
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
@@ -682,6 +725,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
         /** @example true */
         ok: boolean;
     }, void | {
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
@@ -696,6 +741,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @request GET:/api/devices/{slavePosition}/watchdog
      */
     getProcessDataWatchdog: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<ProcessDataWatchdog, void | {
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
@@ -717,6 +764,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          */
         timeoutMs: number;
     }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<ProcessDataWatchdog, void | {
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
@@ -1053,6 +1102,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @request GET:/api/devices/{slavePosition}/sii
      */
     readSii: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<SlaveInformationInterface, void | {
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
@@ -1070,6 +1121,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
         /** @example true */
         ok?: boolean;
     }, void | {
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
@@ -1168,6 +1221,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          */
         positions?: string;
     }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<DeviceDiagnostics[], void | {
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
@@ -1188,6 +1243,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          */
         positions?: string;
     }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<DcSyncStatus[], void | {
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
@@ -1304,6 +1361,9 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
             reached: boolean;
         }[];
     }, void | {
+        /** Why the driver refuses state changes */
+        error: string;
+    } | {
         /**
          * Human-readable error message from the driver
          * @example "FPRD slave 1: wkc=0"
@@ -1362,11 +1422,26 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @example true
          */
         isCia402: boolean;
+        /**
+         * Whether the device is a SOMANET device, which runs SOMANET firmware. The server decides this from the vendor ID: Synapticon (0x22D2) or Sensodrive (0x063A). Gates the SOMANET features, such as the SOMANET files and the SOMANET procedures.
+         * @example true
+         */
+        isSomanet: boolean;
         /**
          * Whether an object-dictionary read for this device has failed since it was scanned. The automatic read on reaching a mailbox-active state is attempted once, so a device flagged here keeps an empty parameter list until `POST /api/devices/{slavePosition}/parameters/init` is called; that clears the flag on success.
          * @example false
          */
         parametersUnavailable: boolean;
+        /**
+         * Whether the device has an EtherCAT Slave Controller: SII, ESC registers, distributed clocks and the ESC diagnostics. False over SPoE, where those endpoints answer 409.
+         * @example true
+         */
+        supportsEsc?: boolean;
+        /**
+         * Whether the transport can blink the device's LEDs, which is what the `device-locate` procedure does. True over SPoE.
+         * @example false
+         */
+        supportsLocate?: boolean;
     }[], any>>;
     /**
      * @description Returns the whole-bus process image: the byte sizes of each direction, the expected and last working counters and overall health, the number of retained image generations (one per re-map since the last reset), and every mapped object resolved to its absolute bit offset. While an image is live `configured` is true and the layout describes it. When no image is published (no device is in SAFE-OP/OP) but at least one generation has been mapped, `configured` is false and the layout describes the most recent retained generation — the last-known mapping — so a bus that has dropped out of SAFE-OP/OP stays inspectable; `lastWkc` then holds the final exchange value and working-counter health does not apply. The object lists are empty only before any image has ever been mapped. Object `name` is populated only for devices whose object dictionary has been enumerated.
@@ -1414,6 +1489,12 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @example 0
          */
         shortWkcCycles: number;
+        /**
+         * Input frames the driver dropped since the process data was configured, summed over all devices. Only a transport that buffers input frames can drop one: a SPoE drive returns its frames in batches, and the oldest are dropped when the real-time loop falls more than 30 cycles behind. Every other transport reports 0.
+         * @format int64
+         * @example 0
+         */
+        droppedInputFrames: number;
         /**
          * Epoch microseconds of the first such cycle, 0 if there has been none
          * @format int64

package/dist/generated/Api.js

@@ -115,7 +115,7 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Constructs the requested fieldbus driver, opens the network interface, and makes the driver available for subsequent calls to /api/scan. The driver defaults to SOEM when omitted. SOEM has no adapter auto-detect: a network adapter must be supplied, otherwise init fails.
+     * @description Constructs the requested fieldbus driver and makes it available for subsequent calls to /api/scan. The body is the `fieldbus` block of the config file, and the same rules check it. The driver defaults to SOEM when omitted. SOEM opens the network interface. It has no adapter auto-detect: a network adapter must be supplied, otherwise init fails. SPoE connects to each drive at scan time. It needs `ipAddresses`, one address per drive, and the list order is the position order.
      *
      * @name Init
      * @summary Initialise the fieldbus driver
@@ -130,7 +130,7 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Scans the fieldbus for slaves and configures their sync managers and FMMUs. Must be called after a successful POST /api/init. Slaves remain in INIT state after this call; state transitions are driven by subsequent API calls. An empty bus is a successful scan returning 0 slaves, not an error: the master cannot distinguish a bus with no devices powered from a disconnected one, and the user recovers by powering devices on and scanning again. A 500 is returned only on a genuine driver failure (e.g. no driver initialised). A scan does not wait for work already in flight. A procedure that is running keeps running against the devices it started on, and fails at its next bus transfer. Retained procedure snapshots are discarded, because a position may name different hardware after a scan. A scan frees the recording, the retained process images and the previous device set, so it first waits up to 200 ms for the real-time loop to leave the cycle it is in. If the loop is stalled — a cyclic task that overruns, or severe CPU contention — the scan fails with 500 and changes nothing, rather than freeing memory the loop is still reading. `GET /api/game-loop` shows the stall. The same applies to `POST /api/process-data`, which re-allocates the recorder. `POST /api/reset` never fails this way: it holds the memory back instead and reclaims it later.
+     * @description Scans the fieldbus for slaves and configures their sync managers and FMMUs. Must be called after a successful POST /api/init. With SOEM, slaves remain in INIT state after this call, and state transitions are driven by subsequent API calls. An SPoE drive starts in OP. When a scan finds a device already in SAFE-OP or OP, it reads that device's object dictionary and publishes the process image, so the exchange starts with no state change. The dictionary comes from the parameter cache when the cache has it. Otherwise the first read of a drive model takes several seconds. If this step fails, the scan still returns 200 and the server logs a warning. A later state change to SAFE-OP or OP maps the image again. An empty bus is a successful scan returning 0 slaves, not an error: the master cannot distinguish a bus with no devices powered from a disconnected one, and the user recovers by powering devices on and scanning again. A 500 is returned only on a genuine driver failure (e.g. no driver initialised). A scan does not wait for work already in flight. A procedure that is running keeps running against the devices it started on, and fails at its next bus transfer. Retained procedure snapshots are discarded, because a position may name different hardware after a scan. A scan frees the recording, the retained process images and the previous device set, so it first waits up to 200 ms for the real-time loop to leave the cycle it is in. If the loop is stalled — a cyclic task that overruns, or severe CPU contention — the scan fails with 500 and changes nothing, rather than freeing memory the loop is still reading. `GET /api/game-loop` shows the stall. The same applies to `POST /api/process-data`, which re-allocates the recorder. `POST /api/reset` never fails this way: it holds the memory back instead and reclaims it later.
      *
      * @name Scan
      * @summary Scan the bus for slaves

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

@@ -954,6 +954,14 @@ export interface ProcedureRequest {
      * @example "all"
      */
     group?: "all" | "communication" | "application" | "manufacturer";
+    /**
+     * `device-locate` only: how long the LEDs blink, in seconds. They stop at the end, and when the run is cancelled. Only a device whose transport can blink the LEDs offers `device-locate`, which today is a SPoE drive.
+     * @min 1
+     * @max 3600
+     * @default 10
+     * @example 10
+     */
+    duration?: number;
     /** `firmware-installation`: the .zip firmware package, base64-encoded into this JSON string. One of this or a `packageFilename` naming an already-cached package must be present; this wins when both are given. To avoid base64 entirely, `PUT` the raw bytes to `/api/user-cache/firmwares/<name>.zip` first and then send only `packageFilename` — the firmware cache is that directory. (Deliberately not `format: byte`: that is the correct OpenAPI spelling for base64, but generators map it to a binary type — `Blob` in TypeScript — which is not what goes on the wire here and would serialise to `{}`.) */
     packageContent?: string;
     /**
@@ -972,7 +980,7 @@ export interface ProcedureRequest {
      */
     cachePackage?: boolean;
     /**
-     * `firmware-installation`: where the device is left, as an AL state number — the same ETG.1000.6 encoding `POST /api/devices/state` takes and `alState` reports, so a client holds one way to name a state rather than two. `2` (PRE-OP) is the default and the confirmation that the install worked: the bootloader hands over to the newly written firmware on that transition, so reaching PRE-OP means the new firmware booted. No power cycle is needed for the firmware (an SII written from the package does need one — the ESC reads its EEPROM at reset). Choose `3` (BOOT) when no application will be present, after erasing one or between two installs, since a PRE-OP transition then has nothing to hand over to and the drive answers AL status `0x0014`, "No valid firmware". `4` and `8` climb through PRE-OP and re-map the whole bus on the way, briefly pausing every other device. The state the device was in beforehand is not restored.
+     * `firmware-installation`: where the device is left, as an AL state number — the same ETG.1000.6 encoding `POST /api/devices/state` takes and `alState` reports, so a client holds one way to name a state rather than two. `2` (PRE-OP) is the default and the confirmation that the install worked: the bootloader hands over to the newly written firmware on that transition, so reaching PRE-OP means the new firmware booted. No power cycle is needed for the firmware (an SII written from the package does need one — the ESC reads its EEPROM at reset). Choose `3` (BOOT) when no application will be present, after erasing one or between two installs, since a PRE-OP transition then has nothing to hand over to and the drive answers AL status `0x0014`, "No valid firmware". `4` and `8` climb through PRE-OP and re-map the whole bus on the way, briefly pausing every other device. The state the device was in beforehand is not restored. Over SPoE the drive restarts into the new firmware and comes up in PRE-OP, so `3` cannot keep it in BOOT.
      * @default 2
      * @example 2
      */

package/package.json

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