@synapticon/motion-master-client 2.3.0-beta.0 → 6.0.0-alpha.110

package/dist/generated/Api.d.ts

@@ -0,0 +1,1886 @@
+import { AlStatusCode, AutoTuningError, AutoTuningRunRequest, AutoTuningRunResponse, AutoTuningStatus, BrakeState, CaptureSummary, Cia402Status, DcSyncStatus, DeviceDiagnostics, DeviceFile, DeviceParameter, Encoders, EscRegister, EsiParseResult, FirmwareCompatibility, FirmwarePackageName, FoeErrorCode, GameLoopHealth, HardwareDescription, HrdRecording, IntegroVariant, IntegroVariantOption, MailboxErrorCode, Monitoring, ObjectDataTypeInfo, OperationModes, OutputStageResult, ParameterCacheEntry, ParameterValue, PdoMapping, PdoMappingRequest, ProcedureListing, ProcedureRequest, ProcedureSnapshot, ProcessDataWatchdog, ProcessImageObject, SdoAbortCode, SlaveConfig, SlaveInformationInterface, UserCacheListing } from "./data-contracts.js";
+import { HttpClient, RequestParams } from "./http-client.js";
+export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * No description
+     *
+     * @name GetAdapters
+     * @summary List network adapters on the host
+     * @request GET:/api/adapters
+     */
+    getAdapters: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * MAC address in colon-separated uppercase format
+         * @example "AA:BB:CC:DD:EE:FF"
+         */
+        macLinux: string;
+        /**
+         * MAC address in dash-separated uppercase format
+         * @example "AA-BB-CC-DD-EE-FF"
+         */
+        macWindows: string;
+        /**
+         * OS interface name (e.g. eth0 on Linux, \\Device\\NPF_{GUID} on Windows)
+         * @example "eth0"
+         */
+        name: string;
+        /**
+         * Human-readable hardware description. Populated on Windows, where the interface name is a GUID device path that identifies nothing; empty on Linux and macOS, where the interface name is the identification. Clients must fall back to `name` when it is empty.
+         * @example "Realtek USB GbE Family Controller"
+         */
+        description: string;
+    }[], any>>;
+    /**
+     * No description
+     *
+     * @name GetVersion
+     * @summary Get Motion Master version
+     * @request GET:/api/version
+     */
+    getVersion: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** @example "6.0.0" */
+        version: string;
+    }, any>>;
+    /**
+     * @description Returns this document — the OpenAPI specification embedded in the running binary — as YAML. Lets a client discover the exact API contract of the server it is talking to without a packaged file or a matching source checkout; the served spec always matches the running version.
+     *
+     * @name GetSwaggerYml
+     * @summary Get this OpenAPI specification
+     * @request GET:/api/swagger.yml
+     */
+    getSwaggerYml: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<string, any>>;
+    /**
+     * @description The effective configuration after merging the JSONC config file (if any) over the built-in defaults — the same `Config` the server booted with. The config file is either the one passed via `--config` or a `motion-master.jsonc` auto-discovered next to the executable (`--config` wins). Read-only; changing it requires editing the config file and restarting. The shape mirrors the config file (server, fieldbus, logging, tls, gameLoop, recorder, parameterCache, parameters).
+     *
+     * @name GetStartedConfig
+     * @summary Get the configuration Motion Master was started with
+     * @request GET:/api/config
+     */
+    getStartedConfig: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Record<string, any>, any>>;
+    /**
+     * @description A best-effort snapshot of the operating system and hardware Motion Master is running on, for the Connection page's System panel. Every field is best-effort: one that cannot be determined on the current platform is returned empty (strings) or zero (numbers) rather than failing the request. Collected on demand — not cached.
+     *
+     * @name GetSystemInfo
+     * @summary Get host OS and hardware information
+     * @request GET:/api/system-info
+     */
+    getSystemInfo: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * Friendly OS name.
+         * @example "Ubuntu 24.04 LTS"
+         */
+        osName: string;
+        /**
+         * Kernel or OS build identifier.
+         * @example "6.8.0-31-generic"
+         */
+        kernel: string;
+        /**
+         * Machine architecture.
+         * @example "x86_64"
+         */
+        architecture: string;
+        /**
+         * Network host name.
+         * @example "motion-master-pi"
+         */
+        hostname: string;
+        /**
+         * CPU brand string.
+         * @example "Intel(R) Core(TM) i7-1185G7 @ 3.00GHz"
+         */
+        cpuModel: string;
+        /**
+         * Logical processor count.
+         * @example 8
+         */
+        cpuCores: number;
+        /**
+         * Total physical RAM in bytes (0 if unknown).
+         * @format int64
+         * @example 16777216000
+         */
+        totalMemoryBytes: number;
+        /**
+         * Capacity of the filesystem holding the working directory, in bytes.
+         * @format int64
+         * @example 250790436864
+         */
+        diskTotalBytes: number;
+        /**
+         * Space available to an unprivileged process on that filesystem, in bytes.
+         * @format int64
+         * @example 98765432100
+         */
+        diskFreeBytes: number;
+        /**
+         * Container runtime when running inside one ("docker", "podman", "containerd", "kubernetes", "lxc"); empty on bare metal.
+         * @example "docker"
+         */
+        container: string;
+        /**
+         * Docker version reported by `docker --version` on the host; empty if the docker CLI is not installed/on PATH (including inside Motion Master's own image).
+         * @example "27.1.1"
+         */
+        dockerVersion: string;
+    }, any>>;
+    /**
+     * @description Reports the validity window and identity of the certificate the server is currently serving. `expiresSoon` trips within 7 days of `notAfter`, so the PWA can prompt the user to refresh. Note that an already-expired certificate blocks the browser from reaching this endpoint at all; the binary self-heals an expired/missing certificate at startup (fetching from the rolling release) and exposes `--update-cert` for manual refresh. Returns 500 if the certificate file cannot be read or parsed.
+     *
+     * @name GetCert
+     * @summary Get the TLS certificate validity window
+     * @request GET:/api/cert
+     */
+    getCert: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * Filesystem path of the certificate being served.
+         * @example "/opt/motion-master/cert.pem"
+         */
+        path: string;
+        /**
+         * Subject common name (CN).
+         * @example "local.motion-master.synapticon.com"
+         */
+        subject: string;
+        /**
+         * The certificate's subjectAltName DNS entries — the hostnames it is valid for, and what a browser actually checks (the CN is legacy and ignored). The bundled certificate covers both the loopback name and the `*.ip.…` wildcard used by off-loopback deployments, so one file serves either. Empty for a certificate with no SAN extension.
+         * @example ["local.motion-master.synapticon.com","*.ip.motion-master.synapticon.com"]
+         */
+        dnsNames?: string[];
+        /**
+         * Issuer common name (CN).
+         * @example "R10"
+         */
+        issuer: string;
+        /**
+         * Start of the validity window (ISO 8601 UTC).
+         * @format date-time
+         * @example "2026-05-01T00:00:00Z"
+         */
+        notBefore: string;
+        /**
+         * End of the validity window / expiry (ISO 8601 UTC).
+         * @format date-time
+         * @example "2026-08-01T00:00:00Z"
+         */
+        notAfter: string;
+        /**
+         * Whole days until expiry; negative once expired.
+         * @example 56
+         */
+        daysRemaining: number;
+        /**
+         * Whether the certificate is already past notAfter.
+         * @example false
+         */
+        expired: boolean;
+        /**
+         * True when expired or within 7 days of notAfter.
+         * @example false
+         */
+        expiresSoon: boolean;
+        /** Every certificate present in the served PEM file, leaf first, in chain order (leaf → intermediate(s)). A fullchain PEM usually stops at the intermediate — the root lives in the OS trust store and is not transmitted — but the last entry's `issuer` still names that root. */
+        chain?: {
+            /**
+             * Subject common name (CN) of this certificate.
+             * @example "local.motion-master.synapticon.com"
+             */
+            subject: string;
+            /**
+             * Issuer common name (CN) — the subject of the next link up.
+             * @example "R10"
+             */
+            issuer: string;
+            /**
+             * Subject organization (O) — the friendly CA name (e.g. "Let's Encrypt") that the short CN does not carry; empty if absent (leaf certs often have no O).
+             * @example "Let's Encrypt"
+             */
+            organization: string;
+            /**
+             * Issuer organization (O) — names the next link's (or, for the last link, the root's) organization; empty if absent.
+             * @example "Internet Security Research Group"
+             */
+            issuerOrganization: string;
+        }[];
+    }, {
+        /**
+         * Human-readable reason the certificate could not be read.
+         * @example "cannot parse PEM certificate: /opt/motion-master/cert.pem"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Downloads a fresh certificate and key from the rolling release, validates the pair (parses, CN matches, not expired, key matches cert), and atomically installs them next to the binary. The new certificate only takes effect after a restart (the TLS listener loads the certificate once at startup), indicated by `restartRequired` in the response. Use the still-valid proactive case; an already-expired certificate is healed by the binary at startup instead.
+     *
+     * @name RefreshCert
+     * @summary Fetch and install a fresh TLS certificate
+     * @request POST:/api/cert/refresh
+     */
+    refreshCert: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** @example "/opt/motion-master/cert.pem" */
+        path?: string;
+        /** @example "local.motion-master.synapticon.com" */
+        subject?: string;
+        /** @example "R10" */
+        issuer?: string;
+        /** @format date-time */
+        notBefore?: string;
+        /** @format date-time */
+        notAfter: string;
+        /** @example 89 */
+        daysRemaining: number;
+        /** @example false */
+        expired?: boolean;
+        /** @example false */
+        expiresSoon?: boolean;
+        /**
+         * Always true — restart Motion Master to serve the new certificate.
+         * @example true
+         */
+        restartRequired: boolean;
+    }, {
+        /** @example "downloaded key does not match certificate" */
+        error: string;
+    } | {
+        /** @example "certificate refresh is not configured" */
+        error: string;
+    }>>;
+    /**
+     * No description
+     *
+     * @name GetDevice
+     * @summary Get a single fieldbus device by bus position
+     * @request GET:/api/devices/{slavePosition}
+     */
+    getDevice: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * 1-based position on the fieldbus
+         * @example 1
+         */
+        slavePosition: number;
+        /**
+         * Human-readable device name from SII EEPROM. For SOMANET drives this is the generic group name "SOMANET"; use productName to distinguish products.
+         * @example "SOMANET"
+         */
+        name: string;
+        /**
+         * Canonical product name, independent of the SII EEPROM. For a recognised SOMANET product this distinguishes the product (e.g. "SOMANET Circulo"); otherwise it falls back to name.
+         * @example "SOMANET Node"
+         */
+        productName: string;
+        /**
+         * Vendor ID from EEPROM
+         * @format int64
+         * @example 131073
+         */
+        vendorId: number;
+        /**
+         * Product code from EEPROM
+         * @format int64
+         * @example 5570560
+         */
+        productCode: number;
+        /**
+         * Revision number from EEPROM
+         * @format int64
+         * @example 1
+         */
+        revisionNumber: number;
+        /**
+         * Serial number from EEPROM
+         * @format int64
+         * @example 12345
+         */
+        serialNumber: number;
+        /**
+         * Whether the device implements the CiA402 drive profile (both controlword 0x6040 and statusword 0x6041 present in its object dictionary). Gates the CiA402 motion-control endpoints under /api/devices/{slavePosition}/cia402.
+         * @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;
+        /**
+         * The low byte of ESC register 0x0000, which names the slave controller family: 0x85 is a netX (Integro), 0xC0 the controller of a Circulo, 0x90 a TI PRU-ICSS (Jasper). Null when the register could not be read at the scan, and over SPoE.
+         * @format int32
+         * @example 192
+         */
+        escType?: number | null;
+        /**
+         * Whether Motion Master writes each mailbox request to this device once and never sends it again. True for a Synapticon or Sensodrive device whose ESC type is not 0x85, because its EtherCAT stack locks its receive mailbox when it gets one request twice. False for a netX, which discards a repeat, and for every other vendor, where a write with no frame back is sent again.
+         * @example true
+         */
+        mailboxWriteOnce?: 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 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
+     * @request POST:/api/init
+     */
+    init: (data?: {
+        /**
+         * Fieldbus driver to use
+         * @default "soem"
+         * @example "soem"
+         */
+        driver?: "soem" | "spoe";
+        /**
+         * 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;
+    }, void | {
+        /** @example "already initialised — call reset() first" */
+        error: string;
+    } | {
+        /**
+         * Human-readable error message from the driver
+         * @example "FPRD slave 1: wkc=0"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Compares the bus with the last scan. Two changes make that scan wrong. A device that resets, for example after a power cycle, loses the station address the scan gave it, and no longer answers at it. A device added to or removed from the chain changes the number of devices on the wire, even when every known device still answers. The server reads the AL state of every scanned device, as `GET /api/devices/state` does, and with SOEM it counts the devices on the wire with one broadcast read. A device that lost its station address still answers a broadcast, so it is counted. Before the first scan, `devicesScanned` is 0, so any device on the wire makes `required` true. A device swapped for another at the same position without a reset is not detected, because it keeps the old address and answers normally.
+     *
+     * @name GetScanStatus
+     * @summary Read whether the bus needs a new scan
+     * @request GET:/api/scan
+     */
+    getScanStatus: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * True when `unreachable` is not empty, or when `devicesOnWire` is not null and differs from `devicesScanned`.
+         * @example true
+         */
+        required: boolean;
+        /**
+         * The number of devices on the wire now. Null over SPoE, which cannot count them.
+         * @example 3
+         */
+        devicesOnWire: number | null;
+        /**
+         * The number of devices the last scan found
+         * @example 2
+         */
+        devicesScanned: number;
+        /**
+         * Positions whose `reachability` is not `answering`, in position order. `GET /api/devices/state` tells why for each one.
+         * @example [2]
+         */
+        unreachable: number[];
+    }, {
+        /**
+         * Human-readable error message from the driver
+         * @example "FPRD slave 1: wkc=0"
+         */
+        error: string;
+    }>>;
+    /**
+     * @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
+     * @request POST:/api/scan
+     */
+    scan: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * Number of slaves discovered on the bus (0 if empty/unpowered)
+         * @example 3
+         */
+        slaves: number;
+    }, {
+        /**
+         * Human-readable error message from the driver
+         * @example "FPRD slave 1: wkc=0"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Tears down all master-side state — unpublishes the process image, frees the recorder, removes all Device objects, and closes the network interface (releasing the NIC). It does not command the slaves to any AL state; the master simply stops talking to the bus. After this returns, POST /api/init and POST /api/scan may be called again.
+     *
+     * @name Reset
+     * @summary Reset the fieldbus driver and clear the device list
+     * @request POST:/api/reset
+     */
+    reset: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** @example true */
+        ok: boolean;
+    }, any>>;
+    /**
+     * @description Returns the most recent in-memory log lines as plain text, one entry per line. The ring buffer holds up to 100 000 entries (~10 MB).
+     *
+     * @name GetLog
+     * @summary Get recent log output
+     * @request GET:/api/log
+     */
+    getLog: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<string, any>>;
+    /**
+     * @description Reports what Motion Master knows about the auto-tuning process. The tuning calculations run in a separate executable, which Motion Master starts at startup and reaches over loopback. That executable is downloaded by the install scripts rather than shipped in a release, so a machine may not have it — this endpoint is how a client tells the four cases apart: switched off in the configuration, not installed, installed but would not start, or running. The values are a startup snapshot. `started` says the process answered when Motion Master waited for it, not that it is alive now. Nothing polls it: a call is the honest test, and `POST /api/auto-tuning/run` makes one.
+     *
+     * @name GetAutoTuning
+     * @summary Auto-tuning process status
+     * @request GET:/api/auto-tuning
+     */
+    getAutoTuning: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<AutoTuningStatus, any>>;
+    /**
+     * @description Forwards the request to the auto-tuning process and returns its reply unchanged. The body is a JSON object with `run`, naming the function, and `data`, holding that function's inputs — the same shape the auto-tuning program takes on its own API. **A rejected input is reported with 200 and an `error` property**, not with a 4xx. The auto-tuning program keeps 4xx and 5xx for a malformed request, an unknown function name, and a routine that threw, so a client tests for `error` in the body rather than relying on the status alone. Motion Master passes both through untouched; only 400, 502 and 503 below are its own. Measurement data travels in the body. `identify_plant_model` takes the chirp measurements as `data.csv` text, and the bode data comes back inline as `bode`, so no file is written and nothing needs a shared filesystem view. The schemas here are a copy of the auto-tuning program's own, taken from version 3.1.1, and they exist so that the generated clients are typed. That program's current description is served verbatim at `GET /api/auto-tuning/swagger.yml`, which is the authority if the two ever disagree.
+     *
+     * @name RunAutoTuning
+     * @summary Run an auto-tuning function
+     * @request POST:/api/auto-tuning/run
+     */
+    runAutoTuning: (data: AutoTuningRunRequest, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<AutoTuningRunResponse, AutoTuningError | {
+        error: string;
+    }>>;
+    /**
+     * @description Serves the OpenAPI document the auto-tuning process carries, fetched from it on each request. The schemas under `/api/auto-tuning/run` above are a copy of these, so this is where to look when a version of the program disagrees with them.
+     *
+     * @name GetAutoTuningSpec
+     * @summary The auto-tuning program's own API description
+     * @request GET:/api/auto-tuning/swagger.yml
+     */
+    getAutoTuningSpec: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<string, {
+        error: string;
+    }>>;
+    /**
+     * @description Returns the static catalogue of EtherCAT AL Status Codes defined in ETG.1000.6 §6.4.1. These codes appear in the alStatusCode field of the device state response when an error is present and identify the cause of the state transition failure.
+     *
+     * @name GetAlStatusCodes
+     * @summary List all known AL Status Codes
+     * @request GET:/api/meta/al-status-codes
+     */
+    getAlStatusCodes: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<AlStatusCode[], any>>;
+    /**
+     * @description Returns the static catalogue of well-known EtherCAT Slave Controller registers from the Beckhoff ESC datasheet (Section II) and ETG.1000.4. Use the address and length fields as inputs to the device register read/write endpoints.
+     *
+     * @name GetRegisters
+     * @summary List all known ESC registers
+     * @request GET:/api/meta/esc-registers
+     */
+    getRegisters: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<EscRegister[], any>>;
+    /**
+     * @description Returns the static catalogue of standard File over EtherCAT (FoE) error codes defined in ETG.1000.6 §5.5.  These codes appear in the FoE ERROR packet sent by the slave when a file transfer fails, and are surfaced in the error message returned by the file read endpoint.  Vendor-specific codes outside the 0x8000 range are not listed here.
+     *
+     * @name GetFoeErrorCodes
+     * @summary List all known FoE error codes
+     * @request GET:/api/meta/foe-error-codes
+     */
+    getFoeErrorCodes: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<FoeErrorCode[], any>>;
+    /**
+     * @description Returns the static catalogue of CoE SDO abort codes defined in ETG.1000.6 §5.6.2.7.2, Table 41 (which reproduces the CANopen CiA 301 abort transfer codes).  A slave returns one of these when a mailbox SDO read/write fails; the code is embedded in the error text returned by the SDO endpoints.
+     *
+     * @name GetSdoAbortCodes
+     * @summary List all known CoE SDO abort codes
+     * @request GET:/api/meta/sdo-abort-codes
+     */
+    getSdoAbortCodes: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<SdoAbortCode[], any>>;
+    /**
+     * @description The register maps of the two iC-Haus chips inside a Circulo's internal encoder — the reference tables for POST /api/devices/{slavePosition}/procedures/encoder-register-communication, and documentation in their own right. Static: they describe the chips, not any connected device, so no bus and no scan are needed. Two chips, and the iC-MU is the one in charge. The iC-MU is the position encoder proper, a magnetic off-axis absolute chip speaking BiSS-C to the drive. The iC-PVL is a battery-buffered Hall multiturn counter behind it, reached over I2C through the iC-MU rather than directly. The response is a list of register *spaces*, not of registers, because an address alone names nothing: the same iC-PVL address 0x00 is a configuration register in one space and the status register in another, depending on which I2C device id addressed it. Each space says which chip it belongs to and how it is reached. A row is one address, or the range the datasheet prints as one row — `address` and `lastAddress` are equal in the ordinary case. `fields` lists the named pieces of the register, most significant bit first, each with the datasheet's own one-line description; it is empty exactly when `reserved` is true. `layout` is those same fields rendered as the datasheet prints the row, e.g. `GC_M(1:0) | GF_M(5:0)`, derived rather than stored so it cannot disagree with them. `spiOnly` marks the iC-MU's 0x80-0xAF, which is reachable over SPI only and so beyond the drive's register communication service. A field's `bits` is its own bit slice as the register map prints it, not its position within the byte: `GC_M(1:0)` occupies bits 7:6 of address 0x00 and reads "1:0" because those are the field's two bits. A value wider than one register is spread across several, which is why `RESABZ` reads "7:0" at 0x13 and "15:8" at 0x14. Granularity follows each datasheet's own register map. The iC-PVL prints its status registers bit by bit, so those arrive as eight fields; the iC-MU prints its own as `STATUS0(7:0)`, so that is one field. Transcribed from the vendors' datasheets: iC-MU Series Rev B1 (Tables 90 and 91) and iC-PVL Rev F2 (Tables 5, 6 and 7), with descriptions from their CONFIGURATION PARAMETERS indexes and, for the iC-PVL status bytes, its status tables. The prose behind those one-liners is not reproduced.
+     *
+     * @name GetIcHausRegisters
+     * @summary The Circulo internal encoder's register maps
+     * @request GET:/api/meta/ic-haus-registers
+     */
+    getIcHausRegisters: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** @example "iC-MU" */
+        chip: "iC-MU" | "iC-PVL";
+        /**
+         * The datasheet's own name for the space.
+         * @example "CONF, bank 0, addresses 0x00-0x3F"
+         */
+        name: string;
+        /** How the space is reached, which is what decides whether the register communication service can read it at all. */
+        addressing: string;
+        registers: {
+            /**
+             * The address, or the first of a printed range.
+             * @example 15
+             */
+            address: number;
+            /**
+             * The last address of the range; equal to address for a single-address row.
+             * @example 15
+             */
+            lastAddress: number;
+            /**
+             * The fields rendered as the datasheet prints the row. "RESERVED" for a reserved row.
+             * @example "SPO_MT(3:0) | MPC(3:0)"
+             */
+            layout: string;
+            /** The named pieces of this register, most significant bit first. Empty when reserved. */
+            fields: {
+                /**
+                 * The datasheet's own name for the field.
+                 * @example "SPO_MT"
+                 */
+                name: string;
+                /**
+                 * The field's own bit slice as the register map prints it, empty where it prints a bare name. Not the position within the byte.
+                 * @example "3:0"
+                 */
+                bits: string;
+                /**
+                 * The datasheet's one-line description of the field.
+                 * @example "Offset external multiturn"
+                 */
+                description: string;
+            }[];
+            /** @example false */
+            reserved: boolean;
+            /**
+             * Reachable over SPI only, so the register communication service cannot touch it.
+             * @example false
+             */
+            spiOnly: boolean;
+        }[];
+    }[], 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, 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
+     * @request GET:/api/meta/kuebler-registers
+     */
+    getKueblerRegisters: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * Register address, as OS command 19 carries it.
+         * @example 48
+         */
+        address: number;
+        /**
+         * Width in bits — 8, 16, 32, or 64.
+         * @example 32
+         */
+        bits: number;
+        /**
+         * The vendor's own name for the register.
+         * @example "Absolute position ST"
+         */
+        name: string;
+        /** @example "ro" */
+        access: "ro" | "wo" | "rw";
+        /**
+         * Whether the encoder implements it, per the vendor's draft.
+         * @example true
+         */
+        implemented: boolean;
+        /**
+         * How to read the assembled value.
+         * @example "unsigned"
+         */
+        format: "unsigned" | "signed" | "bitField" | "signedHalves";
+        /**
+         * The vendor's bit definitions, clauses joined with "; ".
+         * @example "Left aligned 32 bit singleturn position"
+         */
+        definition: string;
+        /**
+         * False only for the 64-bit register, which exceeds the command's 4-byte length field.
+         * @example true
+         */
+        readableInOneCommand: boolean;
+    }[], any>>;
+    /**
+     * @description Returns the static catalogue of CoE mailbox error codes defined in ETG.1000.4, Table 30 ("Error Reply Service Data").  A slave returns one of these when the mailbox layer (below a specific protocol such as CoE/FoE) rejects a transfer; the code is embedded in the error text the mailbox endpoints return.
+     *
+     * @name GetMailboxErrorCodes
+     * @summary List all known CoE mailbox error codes
+     * @request GET:/api/meta/mailbox-error-codes
+     */
+    getMailboxErrorCodes: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<MailboxErrorCode[], any>>;
+    /**
+     * @description Returns the static catalogue of ETG.1020 data type codes used in CoE object dictionary entries.  Each entry of a `DeviceParameter` carries a `dataType` field whose value is one of the codes listed here.
+     *
+     * @name GetObjectDataTypes
+     * @summary List all known CoE object dictionary data types
+     * @request GET:/api/meta/object-data-types
+     */
+    getObjectDataTypes: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<ObjectDataTypeInfo[], any>>;
+    /**
+     * @description Enumerates the entire CoE object dictionary of the device at `slavePosition` via the SDO Info service ("Get Object List" → "Get Object Description" → "Get Entry Description") and rebuilds its parameter map. The device must be in PRE-OP, SAFE-OP, or OP (mailbox communication active).  On a fully populated drive the call can take several seconds. When `readValues=true` each entry is additionally read via SDO upload and the decoded value is stored on the parameter. An entry that fails to read keeps the value of an earlier read with `syncState` `stale`, or the type-appropriate default with `syncState` `unknown`, and the call still succeeds. Check `syncState` to find the entries that were not read.
+     *
+     * @name InitializeDeviceParameters
+     * @summary Initialise the parameter list for a device by enumerating its object dictionary
+     * @request POST:/api/devices/{slavePosition}/parameters/init
+     */
+    initializeDeviceParameters: (slavePosition: number, query?: {
+        /**
+         * When `true`, perform an SDO upload for every entry and decode the value.  Defaults to `false` — only schema (name, type, access) is populated.
+         * @default false
+         */
+        readValues?: boolean;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<DeviceParameter[], void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Re-reads the value of every readable parameter already loaded for the device at `slavePosition`, leaving the parameter list itself intact (it does not re-enumerate the object dictionary — use `POST …/parameters/init` for that).  Each value is read PDO-aware: from the live process image when the device is exchanging and the object is PDO-mapped, otherwise via an SDO upload over the mailbox.  Write-only objects are skipped.  Best-effort: an entry that fails to read keeps its cached value, a `synced` entry becomes `stale`, and the call still succeeds.  Returns the refreshed list, ordered by `(index, subindex)`.
+     *
+     * @name ReadAllDeviceParameters
+     * @summary Refresh the cached value of every parameter without re-enumerating the dictionary
+     * @request POST:/api/devices/{slavePosition}/parameters/read
+     */
+    readAllDeviceParameters: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<DeviceParameter[], void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Returns the parameter list populated by the most recent call to `POST /api/devices/{slavePosition}/parameters/init`.  Empty before the first call.  Entries are ordered ascending by `(index, subindex)`.
+     *
+     * @name GetDeviceParameters
+     * @summary Read the previously initialised parameter list for a device
+     * @request GET:/api/devices/{slavePosition}/parameters
+     */
+    getDeviceParameters: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<DeviceParameter[], void>>;
+    /**
+     * @description Reads one parameter of the device at `slavePosition` and returns the full `DeviceParameter` (value plus metadata: data type, access, sync state). Unlike the raw `GET …/sdo/{index}/{subindex}` endpoint, this is PDO-aware. With `source=auto` (the default) the value is taken from the live process image when the device is exchanging and the object is PDO-mapped, otherwise via an SDO upload, otherwise from the cache. With `source=cache` the cached value is served with no bus access at all. Both `index` and `subindex` accept decimal or hexadecimal notation; prefix with `0x` for hex (e.g. `0x6064` or `24676` for object 0x6064).
+     *
+     * @name ReadParameter
+     * @summary Read a single parameter value (PDO-aware, with optional cache-only mode)
+     * @request GET:/api/devices/{slavePosition}/parameters/{index}/{subindex}
+     */
+    readParameter: (slavePosition: number, index: number, subindex: number, query?: {
+        /**
+         * `auto` (default) reads PDO-when-exchanging else SDO else cache; `cache` returns the cached value with no bus access.
+         * @default "auto"
+         */
+        source?: "auto" | "cache";
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<DeviceParameter, void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Writes one parameter of the device at `slavePosition`. The value is converted to the parameter's declared data type, then routed: staged into the process image when the device is exchanging and the object is output (RxPDO) mapped — sent on the next cycle — otherwise written via an SDO download, otherwise held in the cache as pending until the device is back online. This is the endpoint to set a target (e.g. target torque 0x6071) or the modes of operation: it knows which objects are PDO-mapped and stages them into the process data, falling back to SDO transparently. Returns the updated `DeviceParameter` (with the converted value and resulting sync state). A value the data type cannot hold is refused with 400, and nothing is written. That is a number outside the limits of an integer type (300 or -1 for an UNSIGNED8), a number with a fraction for an integer type, or a number outside the range of a REAL32. Every value that fits the data type is sent unchanged, even one outside the object's documented range, because the drive decides whether a value is valid. To send arbitrary bytes, use `sdoDownload`. Both `index` and `subindex` accept decimal or hexadecimal notation; prefix with `0x` for hex.
+     *
+     * @name WriteParameter
+     * @summary Write a single parameter value (PDO-aware)
+     * @request PUT:/api/devices/{slavePosition}/parameters/{index}/{subindex}
+     */
+    writeParameter: (slavePosition: number, index: number, subindex: number, data: {
+        /**
+         * The value to set. The server converts it to the declared type of the parameter. `ParameterValue` says which JSON type each `dataType` uses.
+         * @example 100
+         */
+        value: ParameterValue;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<DeviceParameter, void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Reads `length` bytes from the ESC register at `address` on the slave at `slavePosition` using a Configured-Address Read (FPRD) datagram. Pass `address` in decimal (e.g. 272 for DL Status at 0x0110).
+     *
+     * @name ReadRegister
+     * @summary Read bytes from an ESC register
+     * @request GET:/api/devices/{slavePosition}/registers/{address}
+     */
+    readRegister: (slavePosition: number, address: number, query: {
+        /**
+         * Number of bytes to read
+         * @min 1
+         * @example 2
+         */
+        length: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * Register bytes in ascending address order
+         * @example [65,0]
+         */
+        data: number[];
+    }, void | {
+        error: string;
+    } | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Writes bytes to the ESC register at `address` on the slave at `slavePosition` using a Configured-Address Write (FPWR) datagram. Pass `address` in decimal (e.g. 272 for DL Status at 0x0110).
+     *
+     * @name WriteRegister
+     * @summary Write bytes to an ESC register
+     * @request POST:/api/devices/{slavePosition}/registers/{address}
+     */
+    writeRegister: (slavePosition: number, address: number, data: {
+        /**
+         * Bytes to write in ascending address order
+         * @example [1,0]
+         */
+        data: number[];
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** @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)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Reads the process-data watchdog timeout the slave at `slavePosition` is configured with, decoded from the watchdog divider (0x0400) and process-data watchdog time (0x0420) ESC registers. This is the configured timeout itself, not the expiration counter exposed by `GET /api/devices/diagnostics`. A device in OP that misses process data past this timeout faults itself to SAFE-OP+error; raising it lets a device tolerate the brief PDO pause of a whole-bus re-map.
+     *
+     * @name GetProcessDataWatchdog
+     * @summary Read the process-data (sync-manager) watchdog configuration
+     * @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)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Sets the process-data watchdog timeout of the slave at `slavePosition`, writing the process-data watchdog time register (0x0420). The device's watchdog divider (0x0400) is left untouched (it is shared with the PDI watchdog), so the achieved timeout is rounded to that divider's tick base — the response reports the value actually programmed. A `timeoutMs` of 0 disables the watchdog. The write persists across re-maps and re-scans until the ESC reloads EEPROM (power cycle).
+     *
+     * @name SetProcessDataWatchdog
+     * @summary Set the process-data (sync-manager) watchdog timeout
+     * @request PUT:/api/devices/{slavePosition}/watchdog
+     */
+    setProcessDataWatchdog: (slavePosition: number, data: {
+        /**
+         * Desired watchdog timeout in milliseconds; 0 disables the watchdog
+         * @format double
+         * @min 0
+         * @example 200
+         */
+        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)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Reads the PDO mapping of the slave at `slavePosition` over CoE, grouped by mapping object: the sync-manager assignment (0x1C12 outputs / 0x1C13 inputs) and, for each assigned mapping object (0x16xx / 0x1Axx), its `pdoIndex` and ordered entries. `outputs` are RxPDO objects (master→slave), `inputs` are TxPDO objects (slave→master). Each entry carries its derived `bitOffset` within the direction's window. This is the grouped, round-trippable counterpart of the flat, whole-bus `GET /api/process-image`. Reads fresh over SDO, so the device's mailbox must be active (PRE-OP, SAFE-OP, or OP); a device in INIT or BOOT yields 409.
+     *
+     * @name GetDevicePdoMapping
+     * @summary Read a device's PDO mapping grouped by object (CoE)
+     * @request GET:/api/devices/{slavePosition}/pdo-mapping
+     */
+    getDevicePdoMapping: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<PdoMapping, void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "FPRD slave 1: wkc=0"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Reconfigures the PDO mapping of the slave at `slavePosition` over CoE: both directions' sync-manager assignment (0x1C12 outputs / 0x1C13 inputs) and the referenced mapping objects (0x16xx / 0x1Axx). `outputs` are RxPDO objects (master→slave), `inputs` are TxPDO objects (slave→master); the array order is the sync-manager assignment order, which fixes each object's position in the process image. Both directions must be present — an empty array clears that sync manager's assignment. **The device must be in PRE-OP.** The mapping and assignment objects are writable only in PRE-OP; in SAFE-OP/OP the sync managers are active and the slave rejects the write, and INIT/BOOT have no CoE mailbox. This is the "drop to PRE-OP, remap, climb back" flow: take the device to PRE-OP (`POST /api/devices/state`), call this, then transition it back to SAFE-OP/OP — at which point the whole-bus process image is re-mapped from the new mapping. The write follows the CoE ordering rule (clear assignment, rewrite each mapping object, then re-assign), is read back and verified, and is retried a few times so a dropped mailbox frame cannot leave the object dictionary half-configured. The response is the device's grouped read-back mapping (same shape as GET), whose `bitOffset` values are derived by the device (the request omits them). This endpoint does not itself change the AL state or re-map the process image.
+     *
+     * @name WriteDevicePdoMapping
+     * @summary Rewrite a device's PDO mapping (CoE)
+     * @request PUT:/api/devices/{slavePosition}/pdo-mapping
+     */
+    writeDevicePdoMapping: (slavePosition: number, data: PdoMappingRequest, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<PdoMapping, void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Returns the drive's current control state — the decoded state-machine state, the raw status (0x6041) and control (0x6040) words, and the active operation mode (display object 0x6061). The values are read live (from the process image when the device is exchanging, else over SDO), so poll this to drive a motion UI. Only valid for a CiA402 device (see the isCia402 flag on GET /api/devices).
+     *
+     * @name GetCia402Status
+     * @summary Read a device's CiA402 control snapshot
+     * @request GET:/api/devices/{slavePosition}/cia402
+     */
+    getCia402Status: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Cia402Status, void>>;
+    /**
+     * @description Every operation mode the device has, standard and manufacturer-specific, with what the drive says about each. The standard modes are CiA402's (ETG.6010 §6.8.1) and carry the bit of "Supported drive modes" (0x6502) that advertises them, decoded into `supported`. The manufacturer modes are the vendor's own — the negative half of 0x6060 — and are listed only for a device whose vendor this server knows; their `supported` is null, because 0x6502 reserves bits 16-31 for the vendor without defining them, so a drive has no way to advertise one that a master could read. That null means "the drive does not say", not "no". Read this once per device and cache it: it is a static property of the firmware, and the one thing that makes a negative value of 0x6061 nameable rather than "Unknown".
+     *
+     * @name GetOperationModes
+     * @summary List a device's operation modes
+     * @request GET:/api/devices/{slavePosition}/operation-modes
+     */
+    getOperationModes: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<OperationModes, void>>;
+    /**
+     * @description Writes the requested operation mode to 0x6060 and returns the resulting control snapshot. The drive reflects the accepted mode in 0x6061 (the modeOfOperation of the response) once it takes effect. Any value object 0x6060 can hold is accepted, standard or manufacturer-specific — the negative half of that range belongs to the vendor, so a SOMANET's diagnostics (-2) or system identification (-4) go through here like any other. Whether a given drive has the mode is the drive's answer, seen in the modeOfOperation of the response; GET /api/devices/{slavePosition}/operation-modes is what lists them beforehand.
+     *
+     * @name SetCia402OperationMode
+     * @summary Set a device's CiA402 operation mode
+     * @request POST:/api/devices/{slavePosition}/cia402/mode
+     */
+    setCia402OperationMode: (slavePosition: number, data: {
+        /**
+         * Operation mode to request (the 0x6060 value). Standard modes are 0 NoMode, 1 Profile Position, 2 Velocity, 3 Profile Velocity, 4 Profile Torque, 6 Homing, 7 Interpolated Position, 8 Cyclic Sync Position, 9 Cyclic Sync Velocity, 10 Cyclic Sync Torque, 11 Cyclic Sync Torque with Commutation Angle; negative values are the vendor's.
+         * @min -128
+         * @max 127
+         * @example 9
+         */
+        mode: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Cia402Status, void>>;
+    /**
+     * @description Walks the CiA402 device-control state machine to the state you name, issuing whatever transitions that takes and re-reading the drive between each — so multi-hop paths are ordinary: Switch On Disabled up to Operation Enabled, Quick Stop Active back down to Ready To Switch On. Starting from Fault begins with a fault reset, and a fault whose cause is still present is reported as such (with the drive's 0x603F error code) rather than as a timeout. Only the five states a master can command are accepted. Not Ready To Switch On, Fault Reaction Active and Fault are entered by the drive itself and are rejected as a bad request. **Asking for Operation Enabled while the drive is in Quick Stop Active leaves that quick stop** (CiA402 transition 16), because naming the destination is an explicit instruction to go there. The "enable" command on the sibling endpoint deliberately does not, so a procedure preparing a drive cannot undo somebody's stop by accident. The device must be exchanging process data for any of this to progress — the statusword has to update between polls, and the firmware refuses Operation Enabled unless master communication is live. Returns the resulting control snapshot.
+     *
+     * @name TransitionToCia402State
+     * @summary Bring a drive to a CiA402 state
+     * @request POST:/api/devices/{slavePosition}/cia402/state
+     */
+    transitionToCia402State: (slavePosition: number, data: {
+        /**
+         * The state to bring the drive to.
+         * @example "OperationEnabled"
+         */
+        state: "SwitchOnDisabled" | "ReadyToSwitchOn" | "SwitchedOn" | "OperationEnabled" | "QuickStopActive";
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Cia402Status, void>>;
+    /**
+     * @description Drives the CiA402 device-control state machine. "enable" walks every intermediate transition to Operation Enabled (clearing a fault first if needed); "disable" goes to Switch On Disabled; "quickStop" triggers a quick stop; "faultReset" clears a latched fault. The device must be exchanging process data for "enable" to make progress. Returns the resulting control snapshot. Use POST /api/devices/{slavePosition}/cia402/state to name a destination instead of an action — it reaches states these four cannot, and it is the one that will leave a quick stop. "enable" here deliberately will not.
+     *
+     * @name RunCia402Command
+     * @summary Run a CiA402 state-machine command
+     * @request POST:/api/devices/{slavePosition}/cia402/command
+     */
+    runCia402Command: (slavePosition: number, data: {
+        /**
+         * The state-machine action to perform.
+         * @example "enable"
+         */
+        command: "enable" | "disable" | "quickStop" | "faultReset";
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Cia402Status, void>>;
+    /**
+     * @description Writes the one setpoint that matches the active operation mode — target position (0x607A, INTEGER32) in PP/CSP, target velocity (0x60FF, INTEGER32) in PV/CSV, or target torque (0x6071, INTEGER16, per-mille of rated) in PT/CST. All are signed: negative values command reverse motion or regenerative torque. Routes through the live process image when the object is PDO-mapped and the device is exchanging, else an SDO download.
+     *
+     * @name SetCia402Target
+     * @summary Set a CiA402 cyclic setpoint (target)
+     * @request POST:/api/devices/{slavePosition}/cia402/target
+     */
+    setCia402Target: (slavePosition: number, data: {
+        /**
+         * Which setpoint to write (pick the one matching the active mode).
+         * @example "velocity"
+         */
+        target: "position" | "velocity" | "torque";
+        /**
+         * The setpoint value in the object's own units (signed). For torque it is per-mille of rated and is narrowed to INTEGER16.
+         * @example 1000
+         */
+        value: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<void, void>>;
+    /**
+     * @description Copies the actual value into the target of one kind: position actual value (0x6064) into target position (0x607A), velocity actual value (0x606C) into target velocity (0x60FF), or torque actual value (0x6077) into target torque (0x6071). Without `kind` the pair is the one the active operation mode (0x6061) acts on. A drive holds its actual position only until the first setpoint reaches it. In CSP the master sends 0x607A every cycle, so a drive enabled with a stale target position steps to it at once, and that step can pull the supply down. Call this before you enable a drive in CSP. Motion Master never does it on its own: an enable writes the controlword and nothing else.
+     *
+     * @name SetCia402TargetToActual
+     * @summary Set a CiA402 target to its actual value
+     * @request POST:/api/devices/{slavePosition}/cia402/target/actual
+     */
+    setCia402TargetToActual: (slavePosition: number, query?: {
+        /**
+         * Which pair to copy. Omit it to copy the pair of the active operation mode.
+         * @example "position"
+         */
+        kind?: "position" | "velocity" | "torque";
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * The pair that was copied.
+         * @example "position"
+         */
+        kind: "position" | "velocity" | "torque";
+        /**
+         * The value written, in the object's own units. Torque is per mille of rated, widened from INTEGER16.
+         * @example 123456
+         */
+        value: number;
+    }, void>>;
+    /**
+     * @description Returns every procedure available on the device, each with its descriptor and the state of its current or last run. One request is enough to render a whole per-device procedures view: the descriptor carries the title, description and caveats to display, and the snapshot says whether anything is running or how the last run went. The list is per device, not global — a procedure is offered only where it applies, so a third-party slave reports an empty list rather than controls that could only ever fail. A procedure that has never run reports an idle snapshot (`status` `idle`, `runCount` 0, every step `idle`), so every entry has the same shape.
+     *
+     * @name ListProcedures
+     * @summary List the procedures a device supports
+     * @request GET:/api/devices/{slavePosition}/procedures
+     */
+    listProcedures: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<ProcedureListing[], void>>;
+    /**
+     * @description Starts the named procedure and returns as soon as the run is under way — this does **not** wait for it to finish. Poll `GET` on the same path for its outcome, or `DELETE` to cancel it. The request body carries the procedure's parameters, and each descriptor from `GET /api/devices/{slavePosition}/procedures` reports its own in `parameters` — name, type, bounds, default, and whether it is required — which is enough to build a form for any procedure without hard-coding one per name. A procedure that takes no parameters may be started with no body. Only one procedure may run on a device at a time; a second start is refused with 409 while the first is in flight. Most procedures require an active mailbox, so the device must be in PRE-OP, SAFE-OP or OP. A run the drive answers with an error is not a failure of *this* request — it is reported in the snapshot as a failed run.
+     *
+     * @name StartProcedure
+     * @summary Start a procedure on a device
+     * @request POST:/api/devices/{slavePosition}/procedures/{procedureName}
+     */
+    startProcedure: (slavePosition: number, procedureName: string, data?: ProcedureRequest, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<ProcedureSnapshot, void>>;
+    /**
+     * @description Returns the current run, or the last one to have finished. This is the whole progress surface — there is no push channel — and polling it is lossless: every finished step keeps its terminal status and value, so a step that both starts and completes between two polls is still reported as succeeded. A polling loop is `while status == "running"`. A procedure that has never run is not an absence: it reports an idle snapshot built from the procedure's step template, so a client renders one shape and needs no empty-state branch. The snapshot is retained after a run ends, so a client that reconnects (or a user returning to a page) sees how the last run went. It is dropped when the device set is rebuilt by a scan or reset, because bus positions may then name different hardware.
+     *
+     * @name GetProcedure
+     * @summary Read the state of a procedure on a device
+     * @request GET:/api/devices/{slavePosition}/procedures/{procedureName}
+     */
+    getProcedure: (slavePosition: number, procedureName: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<ProcedureSnapshot, void>>;
+    /**
+     * @description Asks the running procedure to stop and returns immediately. Where the procedure is waiting on the drive it also tells the drive to abort (for an OS command, 0x1024 = 3), so a run that is waiting stops when asked rather than carrying on to completion. The run then finishes with status `cancelled`. This cancels the *run*, not the record: the snapshot remains and reports how far it got.
+     *
+     * @name CancelProcedure
+     * @summary Cancel a running procedure on a device
+     * @request DELETE:/api/devices/{slavePosition}/procedures/{procedureName}
+     */
+    cancelProcedure: (slavePosition: number, procedureName: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<void, void>>;
+    /**
+     * @description Reports both encoder configuration records, 0x2110 (encoder 1) and 0x2112 (encoder 2), and the encoder each controller uses: position control from 0x2012:09, velocity control from 0x2011:05, commutation from 0x2010:0C. A record whose type is `none` is still listed, because the controller fields refer to the ordinal. Read this to learn what one revolution is in position counts. A position in 0x6064 or 0x607A is in counts of the position encoder, unscaled by the gear ratio (0x6091), so one revolution of that encoder is its `resolution`. The feed constant (0x6092) is not applied here.
+     *
+     * @name GetEncoders
+     * @summary Read a SOMANET drive's encoders and which controller uses which
+     * @request GET:/api/devices/{slavePosition}/encoders
+     */
+    getEncoders: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Encoders, void>>;
+    /**
+     * @description Reports the brake objects (0x2004) that decide what a release or engage will do: its current state, the release strategy, the pull time and the pull/hold voltages. Read this before commanding the brake. `softwareControllable` is false when the release strategy is `manualOutputVoltage`, meaning the firmware does not drive the brake at all and both commands below are no-ops. `releaseMovesShaft` is true for a pin brake, whose release procedure turns the motor to lift the load off the pin.
+     *
+     * @name GetBrake
+     * @summary Read a drive's brake configuration and state
+     * @request GET:/api/devices/{slavePosition}/brake
+     */
+    getBrake: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<BrakeState, void>>;
+    /**
+     * @description Reads the files the `hrd-streaming` procedure recorded, concatenates them in order and decodes them into samples. Run that procedure first; this endpoint only reads what is already on the drive. **`data` is required and must match what was recorded.** Nothing on the drive says which signal its files hold, so the wrong selection reinterprets the same bytes as a different layout and returns plausible nonsense. The procedure's `configure-stream` step reports the selection it used for exactly this reason. Samples travel positionally — `columns` names the fields of each row, once, the way a monitoring topic ships its parameter order once — because a full recording is up to ten thousand rows. `trailingBytes` is what was left over past the last whole sample: the drive allocates its files in fixed-size blocks, so a recording that does not fill the last block ends in padding rather than data. Answers **JSON or CSV**, chosen by the `Accept` header. CSV is the same numbers in the same column order, one header row then one row per sample — a file to open in a spreadsheet rather than JSON to read, which for ten thousand rows is usually what is wanted. Values are decoded, not raw: `velocityRpm` is converted out of the file's Q15 fixed point (exactly — multiply by 32768 to recover the stored integer), while `torquePermil` and the encoder's `raw` word are the file's own values. Blocks for the transfer, which is up to five 8 KB FoE reads plus the listing.
+     *
+     * @name ReadHrdRecording
+     * @summary Read back a drive's high resolution data recording
+     * @request GET:/api/devices/{slavePosition}/hrd
+     */
+    readHrdRecording: (slavePosition: number, query: {
+        /**
+         * Which layout the files hold — the same selection the recording was made with.
+         * @example "encoder-raw"
+         */
+        data: "encoder-raw" | "system-identification";
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<HrdRecording, void>>;
+    /**
+     * @description Writes "disengaged" to the brake state object (0x2004:07) and waits the drive's pull time (0x2004:03) plus `settle` before answering, because the firmware blocks motion — and motion-related OS commands — until the pull time expires. Answers with the brake state read back. **The release only actually happens while the drive is in OP ENABLED.** In any other state the write merely energises the brake output (phase D). Note also that entering OP ENABLED releases the brake automatically in normal operation but **not** in diagnostics mode, where the master owns the brake — which is why a diagnostics procedure has to call this. **On a pin brake this moves the shaft**: the controller raises current progressively until the load has lifted off the pin by the minimum displacement (0x2004:08), reversing direction if it reaches the current ceiling (0x2004:09, a percentage of rated current) first. Check `releaseMovesShaft` on `GET .../brake`. Brake release is open-loop — nothing confirms the brake let go — so the wait is the only margin there is. A brake whose release strategy is `manualOutputVoltage` is left alone and the returned state says so; that is not an error. **A released brake stays released**: nothing re-engages it for you, so on a vertical or loaded axis engage it again when you are done.
+     *
+     * @name ReleaseBrake
+     * @summary Release (disengage) a drive's brake
+     * @request POST:/api/devices/{slavePosition}/brake/release
+     */
+    releaseBrake: (slavePosition: number, query?: {
+        /**
+         * Extra wait in milliseconds on top of the drive's pull time. Size it for the machine — release is open-loop, so this is the only margin between "commanded" and "assumed released".
+         * @min 0
+         * @default 50
+         * @example 50
+         */
+        settle?: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<BrakeState, void>>;
+    /**
+     * @description Writes "engaged" to the brake state object (0x2004:07) and waits `settle` before answering with the brake state read back. There is no pull time on the way in — a brake is spring-engaged, so engaging it is the removal of voltage — so the wait is only `settle`. As with release, a brake whose release strategy is `manualOutputVoltage` is left alone and the returned state says so.
+     *
+     * @name EngageBrake
+     * @summary Engage a drive's brake
+     * @request POST:/api/devices/{slavePosition}/brake/engage
+     */
+    engageBrake: (slavePosition: number, query?: {
+        /**
+         * How long to wait in milliseconds after commanding the brake before answering.
+         * @min 0
+         * @default 50
+         * @example 50
+         */
+        settle?: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<BrakeState, 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).
+     *
+     * @name SdoUpload
+     * @summary Upload an object dictionary entry from a device (CoE SDO upload)
+     * @request GET:/api/devices/{slavePosition}/sdo/{index}/{subindex}
+     */
+    sdoUpload: (slavePosition: number, index: number, subindex: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * Object bytes as transferred by the SDO upload
+         * @example [0,0,0,0]
+         */
+        data: number[];
+    }, void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Performs a CoE SDO download — writes the raw bytes in the request body to object `index:subindex` on the device at `slavePosition`. The byte count must match the object's length. Requires the device to be in PRE-OP, SAFE-OP, or OP (mailbox communication active). Both `index` and `subindex` accept decimal or hexadecimal notation; prefix with `0x` for hex (e.g. `0x6064` or `24676`).
+     *
+     * @name SdoDownload
+     * @summary Download an object dictionary entry to a device (CoE SDO download)
+     * @request PUT:/api/devices/{slavePosition}/sdo/{index}/{subindex}
+     */
+    sdoDownload: (slavePosition: number, index: number, subindex: number, data: {
+        /**
+         * Object bytes to write (little-endian, must match the object length)
+         * @example [100,0,0,0]
+         */
+        data: number[];
+    }, 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 Lists what the device holds — firmware images, the ESI, logs, configuration and any high resolution data recording — with the size it reports for each. **Vendor-specific despite reading like a filesystem listing.** EtherCAT defines no directory service, so SOMANET firmware serves its own as a pseudo-file (`fs-getlist`) read over FoE. A device that is not a SOMANET drive is refused rather than probed. `byteCount` is absent when the device reported a name without a size, which is a formatting quirk of one entry rather than a reason to hide the file.
+     *
+     * @name ListDeviceFiles
+     * @summary List the files stored on a device
+     * @request GET:/api/devices/{slavePosition}/files
+     */
+    listDeviceFiles: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<DeviceFile[], void>>;
+    /**
+     * @description Reads and decodes the device's `.hardware_description` file over FoE — its product id and revision, serial number, the components it is built from, and the assembly it was packaged into. It is also the only source of the descriptor that decides which firmware belongs on the device, which is what most callers want it for (see `/api/devices/{slavePosition}/firmware-compatibility`). **Readable in BOOT as well as PRE-OP and above.** The bootloader deliberately allows this one file, which is what lets a compatibility check work on a drive a failed install left stranded there — precisely when knowing whether the package was the right one matters most.
+     *
+     * @name GetDeviceHardwareDescription
+     * @summary Read what a device says it is
+     * @request GET:/api/devices/{slavePosition}/hardware-description
+     */
+    getDeviceHardwareDescription: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<HardwareDescription, void>>;
+    /**
+     * @description Reads and decodes the device's `.variant` file over FoE — which features the Integro was licensed with. **A 404 is the ordinary answer for most devices.** Only Integro drives carry this file, so the resource being absent is normal rather than a problem. Its one property that matters beyond inspection is `fieldbusProtocol`, which the hardware description deliberately does not carry and a full firmware descriptor ends with.
+     *
+     * @name GetDeviceIntegroVariant
+     * @summary Read a device's Integro variant file
+     * @request GET:/api/devices/{slavePosition}/variant
+     */
+    getDeviceIntegroVariant: (slavePosition: number, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<IntegroVariant, void>>;
+    /**
+     * @description Reads the device's `.hardware_description` and `.variant`, assembles the full firmware descriptors it accepts, and compares them against the descriptor in `filename`. **A mismatch is a `200` carrying `compatible: false`**, not an error status: the client asked a question and got an answer, and the body names both descriptors so it can say which hardware the package was for. A `4xx` means the question could not be asked — the filename is not a package name, or the hardware description could not be read. **Nothing acts on the answer.** The firmware installation procedure writes whatever it is given, on purpose, so this exists to tell a user before they start.
+     *
+     * @name CheckDeviceFirmwareCompatibility
+     * @summary Check whether a firmware package belongs on a device
+     * @request GET:/api/devices/{slavePosition}/firmware-compatibility
+     */
+    checkDeviceFirmwareCompatibility: (slavePosition: number, query: {
+        /**
+         * The package filename, with no directory part.
+         * @example "package_SOMANET-Circulo-7_8500-04-2332_motion-drive_v5.6.10.zip"
+         */
+        filename: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<FirmwareCompatibility, void>>;
+    /**
+     * @description Sends an FoE read request for `filename` to the device at `slavePosition` and returns the raw file bytes.  FoE is available in Boot, Pre-Op, Safe-Op, and Op states (device-dependent); the caller is responsible for ensuring the device is in a suitable state before calling.  The call blocks until the full file has been received. Over EtherCAT it waits up to 6 s for the device's answer and tries a read that gets no answer up to 3 times, so a device that never answers takes about 18 s to fail. A refusal from the device is not tried again. After a failure without an answer, Motion Master aborts the transfer on the device, so that the next request works. Over SPoE it waits the configured file timeout for each packet. When the device refuses the read, the error names the FoE error code it sent and its meaning, and the device's error text when that adds anything, e.g. `FOEread slave 1 'x.bin' failed (FoE error 0x8001: Not found)`. A device that never answered gives `(no response)`.
+     *
+     * @name FoeReadFile
+     * @summary Read a file from a device via FoE (File over EtherCAT)
+     * @request GET:/api/devices/{slavePosition}/files/{filename}
+     */
+    foeReadFile: (slavePosition: number, filename: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Blob, void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "SDOread slave 1 0x2345:01 failed (no response — mailbox timeout)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Sends an FoE write request for `filename` to the device at `slavePosition`, streaming the raw request body as the file contents.  FoE is available in Boot, Pre-Op, Safe-Op, and Op states (device-dependent); the caller is responsible for ensuring the device is in a suitable state before calling. Over EtherCAT it waits up to 10 s for the device to acknowledge each packet. A write that fails without an answer is aborted on the device and is not tried again.
+     *
+     * @name FoeWriteFile
+     * @summary Write a file to a device via FoE (File over EtherCAT)
+     * @request PUT:/api/devices/{slavePosition}/files/{filename}
+     */
+    foeWriteFile: (slavePosition: number, filename: string, data: File, 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 Deletes `filename` from the flash of the device at `slavePosition`. Motion Master waits up to 10 s for the device to answer, and 30 s for the ESI (`SOMANET_CiA_402.xml.zip`), because the device answers only after it has erased the file. **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`.
+     *
+     * @name ReadSii
+     * @summary Read a device's SII (Slave Information Interface / EEPROM)
+     * @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)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Writes the raw SII image in the request body to the device's EEPROM, one 16-bit word at a time. The image is parse-validated first and rejected if it is not a well-formed SII (a guard against bricking the device). **Destructive:** a wrong image can leave the device unidentifiable until re-flashed. The device adopts the new contents only after a **power cycle**, and the write is most reliable while the device is in INIT or PRE-OP. Intended for restoring a previously downloaded image.
+     *
+     * @name WriteSii
+     * @summary Write a raw SII (EEPROM) image to a device
+     * @request PUT:/api/devices/{slavePosition}/sii
+     */
+    writeSii: (slavePosition: number, data: File, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** @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)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Decodes a raw SII EEPROM image supplied in the request body and returns the parsed structure — the same decoder the device read path uses, exposed as a bus-independent utility. No device is involved; the Tools SII page uses this to view previously downloaded `.bin` files offline.
+     *
+     * @name ParseSii
+     * @summary Parse a raw SII (EEPROM) image
+     * @request POST:/api/sii/parse
+     */
+    parseSii: (data: File, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<SlaveInformationInterface, void>>;
+    /**
+     * @description Breaks a firmware package filename into the five fields the SOMANET naming convention defines (Hardware description specification §3.4.2) — `package_<hardware>_<fullFirmwareDescriptor>_<software>_v<version>.zip` — and, where the descriptor is the numeric `<id>-<version>[-<key>[-<fieldbus>]]` kind, decodes it further. The specification allows a descriptor that is not (its own example `Branded-Drive-Elite` carries `MyProduct-v25-key3-ecat`), so those four fields are omitted rather than guessed. Bus-independent, like `/api/sii/parse` and `/api/esi/parse`, but a `GET` with a query because there is no file to upload — only a short string. This is the same decoder firmware installation uses to decide whether a package can be cached, so what it reports is what that will do.
+     *
+     * @name GetFirmwarePackageName
+     * @summary Decode a SOMANET firmware package filename
+     * @request GET:/api/firmware-package-name
+     */
+    getFirmwarePackageName: (query: {
+        /**
+         * The package filename, with no directory part.
+         * @example "package_SOMANET-Circulo-7_8500-04-2332_motion-drive_v5.6.10.zip"
+         */
+        filename: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<FirmwarePackageName, void>>;
+    /**
+     * @description Decodes a `.hardware_description` supplied in the request body. No device is involved — the same parse a device read uses, so a file saved from one device can be inspected with no hardware present. Three things fail a parse: content that is not JSON, content with no `device` object, and a device carrying no `id` or no `version`. Everything else is accepted as written. Those three required fields are exactly what a descriptor is built from, which is also what makes this a usable type check — arbitrary JSON is rejected rather than yielding an empty descriptor. The `fileVersion` major is reported but not enforced: a bump means "a new parser is needed", but refusing an unknown one would make a drive flashed with a future file unreadable today.
+     *
+     * @name ParseHardwareDescription
+     * @summary Parse a .hardware_description file
+     * @request POST:/api/hardware-description/parse
+     */
+    parseHardwareDescription: (data: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<HardwareDescription, void>>;
+    /**
+     * @description Decodes a `.variant` file supplied in the request body. Binary rather than text, hence a `POST` with bytes like `/api/sii/parse` rather than a query like `/api/firmware-package-name`. Trailing bytes past the last option are accepted: the firmware reads only as many options as the count claims and ignores the rest, so refusing padding would reject a file the drive is happy with.
+     *
+     * @name ParseIntegroVariant
+     * @summary Parse a .variant file
+     * @request POST:/api/integro-variant/parse
+     */
+    parseIntegroVariant: (data: File, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<IntegroVariant, void>>;
+    /**
+     * @description Every option an Integro can be licensed with, in code order. Static data: no device, no bus, no request body. Served so a client can explain a decoded file — or simply show what is available — without carrying a second copy of a table that belongs to the firmware. The codes ascend with real gaps, and the catalogue keeps codes current firmware no longer implements, because files written years ago still carry them.
+     *
+     * @name ListIntegroVariantOptions
+     * @summary The whole Integro variant option catalogue
+     * @request GET:/api/integro-variant/options
+     */
+    listIntegroVariantOptions: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<IntegroVariantOption[], any>>;
+    /**
+     * @description Decodes an ENI document supplied in the request body. No device is involved, and that is the point: the useful case is reading a configuration somebody else's tool wrote — acontis EC-Engineer, TwinCAT — rather than the one this master exports from `GET /api/eni`. **An ENI is a script, not a description.** Every configuration step in it is an EtherCAT datagram or a CoE download tagged with the AL-state transition it belongs to, so a listing of the raw elements would show `FPWR to 2064, data 0018060064000100` and leave the reading undone. Each datagram therefore carries a `register` object naming what its `ado` selects, with the instance for a repeating block, and `decoded` fields where the payload is a sync-manager or FMMU register block. A write to AL Control reports `requestsState`, and the read that follows it reports `waitsForState`. Every enumeration is spelled out beside its value — `cmd` 5 with `cmdName` `FPWR`, transitions as `IP`/`PS`/`SO` — and every payload carries its hex beside its byte count, because the reader of this JSON is a person rather than a master. Tolerant by design. Only three things fail: XML that will not parse, a root that is not `EtherCATConfig`, and a missing `Config`. Anything else costs that value and a line in `warnings`, including an element this model has no room for. The sample documents ETG itself ships need that tolerance: two of them omit elements their own schema marks mandatory, and a previous port of `A` is spec-legal while ENI Schema 1.7 enumerates only `B`, `C` and `D`.
+     *
+     * @name ParseEni
+     * @summary Parse an EtherCAT Network Information (ENI) file
+     * @request POST:/api/eni/parse
+     */
+    parseEni: (data: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The master, every device, the cyclic frame and the process image, keyed by the model's own field names. */
+        network: object;
+        /** One line per element seen and not modelled, or per value that would not decode. Each names a place in the document. */
+        warnings: string[];
+        summary: {
+            /** Devices in the document */
+            devices: number;
+            /** EtherCAT init commands, master and devices together */
+            datagrams: number;
+            /** CoE init commands, which live under a device's mailbox */
+            coeTransfers: number;
+        };
+    }, void>>;
+    /**
+     * @description Decodes a vendor's ESI XML supplied in the request body. No device is involved — the Tools page uses this to inspect an ESI with no hardware present, which is the only way to see object descriptions, enum option labels, engineering units and min/max bounds: the CoE SDO-Information service reports none of them. The response carries the vendor, every module, and **every device with its own assembled `entries` table** — one row per addressable `(index, subindex)`, merged from the device's own dictionary plus the dictionaries of the modules its slots reference, with each row recording in `source` where it came from. Object-level annotation (an object's description and raw properties) is attached to **subindex 0 only** — that row *is* the object — rather than repeated onto every subindex. A RECORD member still carries its own description on its own row; an ARRAY element carries none, because the ESI describes an array once rather than per element. To read an object's text for any subindex, look at subindex 0 of the same index. Where a slot offers mutually exclusive module variants the merge necessarily collides; it is resolved last-wins and reported in that device's `warnings`. Pass `modules` to model one concrete configuration instead.
+     *
+     * @name ParseEsi
+     * @summary Parse an EtherCAT Slave Information (ESI) file
+     * @request POST:/api/esi/parse
+     */
+    parseEsi: (data: string, query?: {
+        /** Comma-separated `ModuleIdent` values (hexadecimal or decimal) restricting the merge, applied to every device by intersection with the idents that device's slots actually reference. Omit to merge every module each device references. */
+        modules?: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<EsiParseResult, void>>;
+    /**
+     * @description Reads live link-quality and watchdog diagnostics from each slave's EtherCAT Slave Controller (DL Status 0x0110, error-counter block 0x0300–0x0313, watchdog block 0x0440–0x0443) via FPRD. Counters are 8-bit, saturate at 255, and are cleared only by a power cycle or explicit write — poll this endpoint and watch for a rising delta rather than an absolute value. The per-port counters localise a degrading link to a specific cable/connector; the watchdog counters distinguish a slave that stopped receiving process data from a master-side problem. Omit `positions` to query all discovered devices. Returns 500 for transports without an ESC (e.g. SPoE).
+     *
+     * @name GetDeviceDiagnostics
+     * @summary Read live ESC health diagnostics for devices
+     * @request GET:/api/devices/diagnostics
+     */
+    getDeviceDiagnostics: (query?: {
+        /**
+         * Comma-separated list of 1-based slave positions to query (e.g. `1,2,3`). Omit to query all discovered devices.
+         * @example "1,2"
+         */
+        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)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Reads each slave's distributed-clock unit live from its EtherCAT Slave Controller (system-time delay 0x0928 and system-time difference 0x092C) via FPRD. The reference clock is the first DC-capable slave; every other DC slave continuously corrects its local clock toward it, and `systemTimeDifference` is the live deviation in nanoseconds. The figure is meaningful only while the bus is exchanging process data in SAFE-OP/OP (the reference time is distributed in the cyclic frame) and converges toward zero as the slaves' drift loops settle — poll this endpoint and watch for a slave whose deviation stays large or grows rather than an absolute value. Non-DC slaves report `dcCapable` false with zeroed values. Omit `positions` to query all discovered devices. Returns 500 for transports without an ESC (e.g. SPoE).
+     *
+     * @name GetDcSync
+     * @summary Read live distributed-clock synchronisation status for devices
+     * @request GET:/api/dc-sync
+     */
+    getDcSync: (query?: {
+        /**
+         * Comma-separated list of 1-based slave positions to query (e.g. `1,2,3`). Omit to query all discovered devices.
+         * @example "1,2"
+         */
+        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)"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Runs the capture program `motion-master-capture`, which ships beside the server binary, on the adapter the bus is on, waits for it to exit, and answers the summary. The program records every EtherCAT frame that leaves or enters the adapter with a kernel timestamp and writes them as a pcap file under `captures/` in the user cache, so the file is listed, downloaded and deleted through the `/api/user-cache` routes and opens in Wireshark. The summary matches each frame the master sent to the frame that came back for it, by the index and the header of its first datagram, and reports per kind of frame how late the returns were. The cyclic process-data frame is one kind; mailbox and register datagrams, the control plane, are the other. The bands are the three waits the driver uses, 2 ms, 20 ms and 100 ms, and they are cumulative: a frame later than 100 ms counts in all three. A frame sent again with the same index and header while its first copy had no answer counts once, as `resent`, and its return is timed from the first copy. The time is the kernel's, taken at the boundary to the NIC driver on both sides: when the frame is handed to the driver, and when the driver hands its return back. So the number covers the NIC, the wire and the device, and not the host's own queues and scheduling between that boundary and Motion Master. A capture that shows late frames puts the delay on the wire or in the device. A clean capture beside the server's own warnings, "mailbox write(s) got no frame back", puts it inside the host. Read the two together. One capture at a time. The capture adds no frame to the bus and runs on a thread of its own, so the bus is not touched. The program needs `CAP_NET_RAW`, which the packages grant it at install.
+     *
+     * @name RunCapture
+     * @summary Record the EtherCAT frames of the bus adapter for a number of seconds
+     * @request POST:/api/captures
+     */
+    runCapture: (data?: {
+        /**
+         * How long to record. A capture is a measurement a person starts.
+         * @min 1
+         * @max 120
+         * @default 30
+         */
+        seconds?: number;
+        /**
+         * The adapter to record, when no bus is up. Defaults to the adapter of the bus.
+         * @example "enp0s13f0u1u2"
+         */
+        adapter?: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * The pcap file, relative to the user-cache root
+         * @example "captures/capture-20261022-143005-enp0s13f0u1u2.pcap"
+         */
+        path: string;
+        /** @example "enp0s13f0u1u2" */
+        adapter: string;
+        /** @example 30 */
+        seconds: number;
+        /** How late the frames of a capture came back. See `POST /api/captures`. */
+        summary: CaptureSummary;
+    }, void | {
+        error: string;
+    }>>;
+    /**
+     * @description Reads `captures/{name}` from the user cache and answers the summary that `POST /api/captures` answers, over any Ethernet pcap: a file the server recorded, or one from `tcpdump` on another host that a user put into `captures/` with `PUT /api/user-cache/captures/{name}`. Microsecond and nanosecond timestamps and both byte orders are read.
+     *
+     * @name GetCaptureSummary
+     * @summary Summarise a pcap file in the user cache
+     * @request GET:/api/captures/{name}
+     */
+    getCaptureSummary: (name: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** @example "captures/capture-20261022-143005-enp0s13f0u1u2.pcap" */
+        path: string;
+        /** How late the frames of a capture came back. See `POST /api/captures`. */
+        summary: CaptureSummary;
+    }, void>>;
+    /**
+     * @description Reads the current EtherCAT Application Layer state for one or more devices. Omit the `positions` query parameter to query all discovered devices.
+     *
+     * @name GetDeviceStates
+     * @summary Read current AL state for devices
+     * @request GET:/api/devices/state
+     */
+    getDeviceStates: (query?: {
+        /**
+         * Comma-separated list of 1-based slave positions to query (e.g. `1,2,3`). Omit to query all discovered devices.
+         * @example "1,2"
+         */
+        positions?: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * 1-based position on the fieldbus
+         * @example 1
+         */
+        slavePosition: number;
+        /**
+         * Raw AL Status register value (ETG.1000.6 §6.4.1). Bits 3:0 encode the state; bit 4 is the error indicator.
+         * @example 17
+         */
+        alStatus: number;
+        /**
+         * Current AL state decoded from alStatus (ETG.1000.6 encoding): 1 = Init, 2 = PreOp, 3 = Boot, 4 = SafeOp, 8 = Op. 0 when the device does not answer (see `reachability`).
+         * @example 1
+         */
+        alState: 0 | 1 | 2 | 3 | 4 | 8;
+        /**
+         * True when the AL Status error indicator bit (bit 4) is set
+         * @example true
+         */
+        error: boolean;
+        /**
+         * AL Status Code register (ETG.1000.6 §6.4.1). Non-zero when error is true; identifies the error cause (e.g. 0x0014 = No valid firmware).
+         * @example 20
+         */
+        alStatusCode: number;
+        /**
+         * Whether the device answers at the station address the master gave it. `addressLost`: nothing answers at that address, but a device answers at its wire position. A reset, such as a power cycle, clears the address. Run `POST /api/scan` to command it again. `notAnswering`: nothing answers at that address or at its wire position. Check the cabling and the power. If devices were removed from the chain, run a scan. The wire position is checked by position only, so after a change to the chain the device that answers there can be a different one. When the value is not `answering`, the state of the device is unknown, and `alStatus`, `alState` and `alStatusCode` are 0.
+         * @example "answering"
+         */
+        reachability: "answering" | "addressLost" | "notAnswering";
+    }[], void | {
+        /**
+         * Human-readable error message from the driver
+         * @example "FPRD slave 1: wkc=0"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Commands one or more devices to the requested EtherCAT Application Layer state and blocks until all targeted devices arrive or the timeout elapses. The settled state of every targeted device is then read back and returned in `devices`, each with a `reached` flag; `ok` is true only when every device reached the target. A device that did not reach it carries an `alStatusCode` explaining why. A device that does not answer at its address is not commanded, so the request does not wait out the timeout for it. Its `reachability` says why, and the other devices are still commanded. Omit `positions` or pass an empty array to target all discovered devices. State values are the standard AL state register encodings from ETG.1000.6: 1 (Init), 2 (PreOp), 3 (Boot), 4 (SafeOp), 8 (Op).
+     *
+     * @name TransitionToState
+     * @summary Transition devices to an EtherCAT AL state
+     * @request POST:/api/devices/state
+     */
+    transitionToState: (data: {
+        /**
+         * 1-based slave positions to target. Omit or pass an empty array to target all discovered devices.
+         * @example [1,2]
+         */
+        positions?: number[];
+        /**
+         * Target EtherCAT AL state (ETG.1000.6 AL control register encoding): 1 = Init, 2 = PreOp, 3 = Boot, 4 = SafeOp, 8 = Op.
+         * @example 8
+         */
+        state: 1 | 2 | 3 | 4 | 8;
+        /**
+         * Maximum time to wait for all devices, in milliseconds
+         * @default 5000
+         * @example 5000
+         */
+        timeout?: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * True only when every targeted device reached the target state.
+         * @example true
+         */
+        ok: boolean;
+        /** Settled state of each targeted device, in the order targeted. */
+        devices: {
+            /**
+             * 1-based position on the fieldbus
+             * @example 1
+             */
+            slavePosition: number;
+            /**
+             * Raw AL Status register value (ETG.1000.6 §6.4.1). Bits 3:0 encode the state; bit 4 is the error indicator.
+             * @example 2
+             */
+            alStatus: number;
+            /**
+             * Current AL state decoded from alStatus (ETG.1000.6 encoding): 1 = Init, 2 = PreOp, 3 = Boot, 4 = SafeOp, 8 = Op. 0 when the device does not answer (see `reachability`).
+             * @example 2
+             */
+            alState: 0 | 1 | 2 | 3 | 4 | 8;
+            /**
+             * True when the AL Status error indicator bit (bit 4) is set
+             * @example false
+             */
+            error: boolean;
+            /**
+             * AL Status Code register (ETG.1000.6 §6.4.1). Non-zero when error is true; identifies the error cause (e.g. 0x0014 = No valid firmware).
+             * @example 0
+             */
+            alStatusCode: number;
+            /**
+             * Whether the device answers at the station address the master gave it. `addressLost`: nothing answers at that address, but a device answers at its wire position. A reset, such as a power cycle, clears the address. Run `POST /api/scan` to command it again. `notAnswering`: nothing answers at that address or at its wire position. Check the cabling and the power. If devices were removed from the chain, run a scan. The wire position is checked by position only, so after a change to the chain the device that answers there can be a different one. When the value is not `answering`, the state of the device is unknown, and `alStatus`, `alState` and `alStatusCode` are 0.
+             * @example "answering"
+             */
+            reachability: "answering" | "addressLost" | "notAnswering";
+            /**
+             * True when this device reached the requested target state (error clear and alState equal to the requested state).
+             * @example true
+             */
+            reached: boolean;
+        }[];
+    }, void | {
+        /** Why the driver refuses state changes */
+        error: string;
+    } | {
+        /**
+         * Human-readable error message from the driver
+         * @example "FPRD slave 1: wkc=0"
+         */
+        error: string;
+    }>>;
+    /**
+     * No description
+     *
+     * @name GetDevices
+     * @summary List all fieldbus devices
+     * @request GET:/api/devices
+     */
+    getDevices: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * 1-based position on the fieldbus
+         * @example 1
+         */
+        slavePosition: number;
+        /**
+         * Human-readable device name from SII EEPROM. For SOMANET drives this is the generic group name "SOMANET"; use productName to distinguish products.
+         * @example "SOMANET"
+         */
+        name: string;
+        /**
+         * Canonical product name, independent of the SII EEPROM. For a recognised SOMANET product this distinguishes the product (e.g. "SOMANET Circulo"); otherwise it falls back to name.
+         * @example "SOMANET Node"
+         */
+        productName: string;
+        /**
+         * Vendor ID from EEPROM
+         * @format int64
+         * @example 131073
+         */
+        vendorId: number;
+        /**
+         * Product code from EEPROM
+         * @format int64
+         * @example 5570560
+         */
+        productCode: number;
+        /**
+         * Revision number from EEPROM
+         * @format int64
+         * @example 1
+         */
+        revisionNumber: number;
+        /**
+         * Serial number from EEPROM
+         * @format int64
+         * @example 12345
+         */
+        serialNumber: number;
+        /**
+         * Whether the device implements the CiA402 drive profile (both controlword 0x6040 and statusword 0x6041 present in its object dictionary). Gates the CiA402 motion-control endpoints under /api/devices/{slavePosition}/cia402.
+         * @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;
+        /**
+         * The low byte of ESC register 0x0000, which names the slave controller family: 0x85 is a netX (Integro), 0xC0 the controller of a Circulo, 0x90 a TI PRU-ICSS (Jasper). Null when the register could not be read at the scan, and over SPoE.
+         * @format int32
+         * @example 192
+         */
+        escType?: number | null;
+        /**
+         * Whether Motion Master writes each mailbox request to this device once and never sends it again. True for a Synapticon or Sensodrive device whose ESC type is not 0x85, because its EtherCAT stack locks its receive mailbox when it gets one request twice. False for a netX, which discards a repeat, and for every other vendor, where a write with no frame back is sent again.
+         * @example true
+         */
+        mailboxWriteOnce?: 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.
+     *
+     * @name GetProcessImage
+     * @summary Inspect the published EtherCAT process image
+     * @request GET:/api/process-image
+     */
+    getProcessImage: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * Whether an image is currently published for exchange
+         * @example true
+         */
+        configured: boolean;
+        /**
+         * Size of the output image (master→slave) in bytes
+         * @example 12
+         */
+        outputBytes: number;
+        /**
+         * Size of the input image (slave→master) in bytes
+         * @example 16
+         */
+        inputBytes: number;
+        /**
+         * Working counter expected from the devices currently exchanging. A device in SAFE-OP or OP counts 2 for mapped outputs and 1 for mapped inputs. A device below SAFE-OP, or with the AL error flag set, counts 0.
+         * @example 3
+         */
+        expectedWkc: number;
+        /**
+         * Working counter from the most recent exchange (0 before any)
+         * @example 3
+         */
+        lastWkc: number;
+        /**
+         * Whether the last working counter meets the expected value
+         * @example true
+         */
+        healthy: boolean;
+        /**
+         * Cycles that answered with a working counter below the value expected at the time, counted since `POST /api/init` and cleared only by `POST /api/reset`. `healthy` is a sample of the most recent cycle and so cannot see a fault that has already cleared; this count can.
+         *
+         * It spans every re-map rather than resetting per image, because a re-map happens whenever a device is brought into or out of SAFE-OP/OP — which is exactly when someone is chasing a fault. `generations` says how many images the count spans. Cycles missed while a device was being deliberately commanded out of an exchange state are not counted: the expectation is lowered before the transition is commanded.
+         * @format int64
+         * @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
+         * @example 0
+         */
+        firstShortWkcUs: number;
+        /**
+         * Epoch microseconds of the most recent such cycle, 0 if there has been none
+         * @format int64
+         * @example 0
+         */
+        lastShortWkcUs: number;
+        /**
+         * Number of process images retained since the last reset
+         * @example 1
+         */
+        generations: number;
+        /** Output-mapped objects (RxPDO), in image order */
+        outputs: ProcessImageObject[];
+        /** Input-mapped objects (TxPDO), in image order */
+        inputs: ProcessImageObject[];
+    }, any>>;
+    /**
+     * @description Returns a point-in-time snapshot of the RT cyclic loop: the configured period and target rate, the cumulative achieved rate since start, the executed- and skipped-cycle counters, per-cycle task-execution timing (last / worst / mean), and whether real-time scheduling was acquired. Skipped cycles accumulate whenever the loop cannot meet its period (common on non-RT hosts such as Windows userspace) — a steadily rising `skippedCycles`, or an `achievedHz` well below `targetHz`, means the configured period is too aggressive for the hardware. Poll this endpoint and diff `executedCycles`/`skippedCycles` against `timestampUs` to chart the instantaneous rate over time.
+     *
+     * @name GetGameLoop
+     * @summary Inspect real-time game-loop health
+     * @request GET:/api/game-loop
+     */
+    getGameLoop: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<GameLoopHealth, any>>;
+    /**
+     * @description Retimes the running RT loop to a new cycle period, in microseconds. The change takes effect within one cycle and is transient — it is not written back to the config file, so a restart reverts to the configured `gameLoop.periodUs`. Intended for tuning on hosts that cannot sustain the configured rate: if `skippedCycles` climbs steadily (common on Windows userspace), raise the period (e.g. from 1000 to 2000 µs) until the loop meets its grid. Only the master cadence is retimed — the process-data recorder ring is not resized, and no drive-side watchdog is touched, so raising the period toward a drive's PDO/SM watchdog window can fault that drive. Applying a period starts a fresh health epoch: the cumulative counters (`executedCycles`, `skippedCycles`, the `achievedHz` average, and `maxExecNs`/`avgExecNs`) reset so the snapshot reflects only the new period — letting you see straight away whether the change improved the loop's health. Returns the updated health snapshot.
+     *
+     * @name SetGameLoopPeriod
+     * @summary Change the real-time cycle period
+     * @request PUT:/api/game-loop
+     */
+    setGameLoopPeriod: (data: {
+        /**
+         * New cycle period in microseconds. Must be greater than 0.
+         * @format int64
+         * @min 1
+         * @example 2000
+         */
+        periodUs: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<GameLoopHealth, void>>;
+    /**
+     * @description Streams the same `.mmpd` serialisation as the POST variant (the recorder's current span, with the process image embedded as a header) directly in the response body instead of writing a file — for the client SDK / browser, which parses the bytes offline. Request with `Accept: application/octet-stream`. Same span semantics as the POST; works in any state.
+     *
+     * @name StreamProcessDataDump
+     * @summary Stream the recorder ring as a binary .mmpd
+     * @request GET:/api/process-data/dump
+     */
+    streamProcessDataDump: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Blob, {
+        /** Human-readable reason the dump could not be produced */
+        error: string;
+    }>>;
+    /**
+     * @description Serialises the process-data recorder's current span — every cycle from the oldest still in the ring up to the newest at the instant of the call — to a `.mmpd` file and returns its path. Each cycle's full raw input and output images, sequence, and epoch-nanosecond timestamp are written, with the process image (per-device identity and PDO object layout, including object names and data types where the object dictionary has been enumerated) embedded as a header, so the file decodes fully offline with no running Motion Master and no live bus. Works in any state: while devices are exchanging (SAFE-OP/OP) it captures tail→head at that moment and ignores cycles recorded afterwards; after the bus has left the exchange states it uses the most recent retained image layout. The file is written under the configured `recorder.dumpDir`, created if absent; by default that is a `dumps` subdirectory of the user-cache root, so the written file is also reachable through the `/api/user-cache` endpoints — list it, download it, or delete it there. Only the path is returned here. (Setting an explicit `recorder.dumpDir` outside the cache root opts out of that; the file is then only reachable from a shell on the server.)
+     *
+     * @name DumpProcessData
+     * @summary Dump the recorder ring to a binary .mmpd file
+     * @request POST:/api/process-data/dump
+     */
+    dumpProcessData: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * Absolute path of the written .mmpd file
+         * @example "/tmp/motion-master/dump-20260610T141530Z-300123.mmpd"
+         */
+        path: string;
+    }, {
+        /**
+         * Human-readable reason the dump could not be produced
+         * @example "the recorder is empty — no cycles have been recorded yet"
+         */
+        error: string;
+    }>>;
+    /**
+     * @description Stages many output (RxPDO) objects at once — the "send all" action of the Process Data page. Each value is converted to the object's declared data type and, when the object is output-mapped and its device is exchanging (SAFE-OP/OP), written into the output image so it is sent on the next real-time cycle and re-sent every cycle thereafter (set-once, sent-continuously). The batch is best-effort atomic: values are staged sequentially, so a batch can straddle two consecutive ~1 ms cycles. The request never fails as a whole — each object gets its own result, so the client can flag any object that was not cyclically staged (unknown device, a value the data type cannot hold, object not output-mapped, or bus not exchanging; in the last two cases the value is still written via SDO/cache, just not cyclically driven). A value the data type cannot hold is refused in its own result and nothing is written for it, by the same rule as `writeParameter`.
+     *
+     * @name StageProcessDataOutputs
+     * @summary Stage a batch of output values into the process image
+     * @request POST:/api/process-data/outputs
+     */
+    stageProcessDataOutputs: (data: any[][], params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        results: OutputStageResult[];
+    }, {
+        error: string;
+    }>>;
+    /**
+     * @description Returns the static ESC configuration the master programmed into every slave during the last scan: station/alias addresses, mapped process-data sizes, the mailbox transport windows, the distributed-clock setup, and the configured Sync Managers and FMMUs. Read from cached state with no bus I/O and valid once the bus has been scanned. The list is empty before any scan, or when the active transport has no ESC (e.g. SPoE). Numeric fields (SM/FMMU type, mailbox protocol bits, SM flags) are raw register values; the client decodes them. `deviceName` is empty when no known device occupies the slave.
+     *
+     * @name GetBusConfig
+     * @summary Inspect each slave's static EtherCAT Slave Controller configuration
+     * @request GET:/api/bus-config
+     */
+    getBusConfig: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<SlaveConfig[], any>>;
+    /**
+     * @description Returns the bus as an ENI document, the vendor-neutral configuration a third-party master (acontis EC-Master, TwinCAT, CODESYS) replays to bring the same bus up. Where an ESI file describes one device family, an ENI describes one assembled network, and it is imperative rather than declarative: every configuration step is an EtherCAT datagram or a CoE download tagged with the AL-state transition it belongs to. The document carries each device's identity and addresses, its Sync Manager and FMMU register writes, its mailbox windows, its PDO assignment as CoE downloads, the AL-state walk with a read that holds the master until the device arrives, the cyclic frame, and the named process image. Conforms to ENI Schema 1.7 (ETG.2100). The bus must be configured. FMMUs and logical addresses come into being at the SAFE-OP transition, so a bus in PRE-OP has no mapping to describe and the call returns 409. **This drives the bus.** Each device's SII is read for its port layout and bootstrap mailbox, and its PDO assignment is read over CoE, so the call costs one EEPROM read and a short burst of SDO uploads per device. It is an export action, not an accessor. Distributed clocks are left out, so the generated configuration runs in free-run — which is how Motion Master runs the bus itself. The `DC` element needs an `AssignActivate` word, and a SOMANET drive does not carry the SII category that holds one. `X-Eni-Warnings` counts the parts that were asked for and not answered; each is also logged. A warning costs one optional element, never the document: a device whose SII will not read keeps every init command.
+     *
+     * @name ExportEni
+     * @summary Export the bus as an EtherCAT Network Information (ENI) file
+     * @request GET:/api/eni
+     */
+    exportEni: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<File, {
+        /** Human-readable reason the export could not be produced */
+        error: string;
+    } | {
+        /** The field that could not be written */
+        error: string;
+    } | {
+        error: string;
+    }>>;
+    /**
+     * @description Returns every registered monitoring as a resource — its configuration plus, per parameter, how its value is sourced, and the current buffer fill.
+     *
+     * @name ListMonitorings
+     * @summary List all monitorings
+     * @request GET:/api/monitorings
+     */
+    listMonitorings: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Monitoring[], any>>;
+    /**
+     * @description Registers a monitoring and starts sampling it off the real-time thread. Each parameter is classified once against the published process image: PDO-mapped objects are decoded from the live image; the rest are polled over SDO in the background. Create monitorings after the bus is operational so PDO objects are recognised as PDO. Monitoring is live-only — a parameter samples `null` while its owning device is not exchanging (SAFE-OP/OP).
+     *
+     * @name CreateMonitoring
+     * @summary Create a monitoring
+     * @request POST:/api/monitorings
+     */
+    createMonitoring: (data: {
+        /**
+         * URL-safe unique id; also the WebSocket topic.
+         * @pattern ^[A-Za-z0-9._-]{1,64}$
+         * @example "left-leg"
+         */
+        topic: string;
+        /**
+         * Optional human-readable label.
+         * @example "Left Leg"
+         */
+        name?: string;
+        /**
+         * Flush cadence in milliseconds (5–2000). Not a sample rate: every recorded cycle since the last flush is delivered, so a longer interval yields a larger batch rather than fewer samples. 16 ms (~one batch per 60 Hz display frame) is a good default for live plotting.
+         * @min 5
+         * @max 2000
+         * @example 16
+         */
+        interval: number;
+        /**
+         * Objects to sample, each as `[devicePosition, index, subindex]`.
+         * @minItems 1
+         * @example [[1,8240,1],[1,24676,0]]
+         */
+        parameters: number[][];
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Monitoring, {
+        error: string;
+    }>>;
+    /**
+     * No description
+     *
+     * @name GetMonitoring
+     * @summary Get a monitoring
+     * @request GET:/api/monitorings/{topic}
+     */
+    getMonitoring: (topic: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Monitoring, void>>;
+    /**
+     * @description Stops sampling and releases the monitoring's SDO parameters from the shared refresher — an object no remaining monitoring needs stops being polled.
+     *
+     * @name DeleteMonitoring
+     * @summary Delete a monitoring
+     * @request DELETE:/api/monitorings/{topic}
+     */
+    deleteMonitoring: (topic: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<void, void>>;
+    /**
+     * @description Returns one entry per cached parameter-definition file on disk, keyed by device identity (vendor, product, revision). The cache stores only the object-dictionary *definitions* (not live values), so a scan of previously-seen hardware can skip the slow SDO enumeration. Independent of the bus — works whether or not a driver is initialised.
+     *
+     * @name ListParameterCacheEntries
+     * @summary List on-disk parameter caches
+     * @request GET:/api/parameter-cache
+     */
+    listParameterCacheEntries: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<ParameterCacheEntry[], any>>;
+    /**
+     * @description Returns the raw JSON cache file for the given id, verbatim, so it can be saved or inspected offline.
+     *
+     * @name GetParameterCache
+     * @summary Download a parameter-cache file
+     * @request GET:/api/parameter-cache/{id}
+     */
+    getParameterCache: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<object, void>>;
+    /**
+     * @description Removes one cached file from disk. The next scan of that hardware re-enumerates it. Useful when a vendor reused a revision across an object-dictionary change.
+     *
+     * @name DeleteParameterCache
+     * @summary Delete a parameter-cache file
+     * @request DELETE:/api/parameter-cache/{id}
+     */
+    deleteParameterCache: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<void, void>>;
+    /**
+     * @description Returns every file in Motion Master's per-user cache directory, flattened: one entry per file with its full path relative to the cache root, whatever the nesting. Directories have no entries of their own. Independent of the bus — works whether or not a driver is initialised. The cache is a plain file store for data that should outlive a restart. The store itself neither validates nor interprets an upload — `PUT` accepts any bytes at any valid path, and putting a file here does not, on its own, make Motion Master do anything with it; the client chooses the paths. That is separate from whether a *feature* reads a given file, and several do: `parameters/` (the on-disk object-dictionary cache) and `dumps/` (`.mmpd` recorder dumps) are written and consumed by those features, with more to follow. Their files appear in this listing alongside everything else, so a client must not assume every entry was uploaded through this API, nor that deleting one is inconsequential.
+     *
+     * @name ListUserCacheFiles
+     * @summary List the files in the user cache
+     * @request GET:/api/user-cache
+     */
+    listUserCacheFiles: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<UserCacheListing, void>>;
+    /**
+     * @description Returns the file verbatim, always as `application/octet-stream` and always with `Content-Disposition: attachment`, `X-Content-Type-Options: nosniff` and a `default-src 'none'; sandbox` CSP. The bytes are whatever a user uploaded, served from the API's own origin, so a browser must never *render* them — a rendered upload would be stored XSS against the origin that controls the drives, which CORS cannot help with. No extension is trusted to name a content type, and the attachment carries no `filename` (the path is user-controlled and must not reach a response header). Clients read the bytes and name the saved file themselves.
+     *
+     * @name GetUserCacheFile
+     * @summary Download a user-cache file
+     * @request GET:/api/user-cache/{path}
+     */
+    getUserCacheFile: (path: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<Blob, void>>;
+    /**
+     * @description Writes the request body to the given path, creating parent directories as needed and replacing any existing file. The write is atomic — a concurrent reader sees either the old contents or the new one, never a partial file. The body is taken as raw bytes whatever its content type.
+     *
+     * @name PutUserCacheFile
+     * @summary Upload a user-cache file
+     * @request PUT:/api/user-cache/{path}
+     */
+    putUserCacheFile: (path: string, data: File, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * The path written, relative to the cache root.
+         * @example "configs/machine-a.json"
+         */
+        path: string;
+        /**
+         * Bytes written.
+         * @example 20480
+         */
+        size: number;
+    }, void>>;
+    /**
+     * @description Removes a file, or a directory and everything under it. Directories left empty between the removed path and the cache root are pruned, so no husks remain. A file the running server holds open is refused — see `deletable` on `UserCacheFile`.
+     *
+     * @name DeleteUserCacheFile
+     * @summary Delete a user-cache file or directory
+     * @request DELETE:/api/user-cache/{path}
+     */
+    deleteUserCacheFile: (path: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<void, void>>;
+}