@synapticon/motion-master-client 6.0.0-alpha.112 → 6.0.0-alpha.114

package/dist/generated/Api.d.ts

@@ -1933,7 +1933,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      */
     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.
+     * @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. `esis/` holds ESI files, which a client adds and the firmware installation stores from each package it caches, named `esi-<vendor>-<version>.xml`; a device whose vendor and firmware version (0x100A) match a file takes the units, ranges, descriptions and options of its parameters from it at the next scan or parameter init. 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

package/dist/generated/Api.js

@@ -1268,7 +1268,7 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @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.
+     * @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. `esis/` holds ESI files, which a client adds and the firmware installation stores from each package it caches, named `esi-<vendor>-<version>.xml`; a device whose vendor and firmware version (0x100A) match a file takes the units, ranges, descriptions and options of its parameters from it at the next scan or parameter init. 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

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

@@ -1692,16 +1692,38 @@ export interface DeviceParameter {
      */
     value: ParameterValue;
     /**
-     * ETG.1004 unit code reported by the slave for this entry.  Absent when the slave does not populate the Unit field of the SDO Info response.  The 32-bit code decomposes into prefix, base SI unit, and exponent per ETG.1004.
-     * @example 0
+     * ETG.1004 unit code of this entry. The code comes from the SDO Info response of the slave. When the slave reports none, it comes from the device's ESI in the `esis` directory of the user cache. That file is named `esi-<vendor>-<version>.xml`, where `<version>` is the device's firmware version in 0x100A, matched exactly. Absent when neither source gives a unit. The 32-bit code decomposes into prefix, base SI unit, and exponent per ETG.1004.
+     * @example 11814656
      */
     unit?: number;
-    /** Slave-reported default value, decoded with the same logic as `value`.  Absent when the slave does not report a default. */
+    /**
+     * The symbol of `unit`, for example `rpm` or `mV`. It comes from the ESI with the unit, or is rendered from the ETG.1004 code when the slave reported the unit. Absent when there is no unit or it has no symbol.
+     * @example "rpm"
+     */
+    unitSymbol?: string;
+    /** The default value, decoded with the same logic as `value`. It comes from the SDO Info response of the slave. When the slave reports none, it comes from the device's ESI (see `esiFile`). Absent when neither source gives one. */
     defaultValue?: ParameterValue;
-    /** Slave-reported minimum value, decoded with the same logic as `value`.  Absent when the slave does not report a minimum. */
+    /** The minimum value, decoded with the same logic as `value`. It comes from the SDO Info response of the slave. When the slave reports none, it comes from the device's ESI (see `esiFile`). Absent when neither source gives one. */
     minValue?: ParameterValue;
-    /** Slave-reported maximum value, decoded with the same logic as `value`.  Absent when the slave does not report a maximum. */
+    /** The maximum value, decoded with the same logic as `value`. It comes from the SDO Info response of the slave. When the slave reports none, it comes from the device's ESI (see `esiFile`). Absent when neither source gives one. */
     maxValue?: ParameterValue;
+    /** What the entry does, from the device's ESI, as HTML. A record or array is described once, on subindex 0. Absent when the ESI gives no description. SOMANET ESIs carry one for most objects. */
+    description?: string;
+    /** The named values of an enumerated entry, from the device's ESI. Absent when the entry is not an enumeration. */
+    options?: {
+        /**
+         * @format int64
+         * @example 1
+         */
+        value: number;
+        /** @example "Enabled" */
+        label: string;
+    }[];
+    /**
+     * The file in the `esis` directory of the user cache that described this entry. Absent when the device has no ESI, or its ESI does not describe this entry. On a device whose other entries have one, an absent `esiFile` means the ESI and the firmware disagree.
+     * @example "esi-000022d2-v5.6.11.xml"
+     */
+    esiFile?: string;
     /**
      * Freshness of `value` relative to the device. `synced` — matches the device (last successful read or write); `pending` — set locally while offline or after a failed write, not yet confirmed on the device; `stale` — came from an earlier read or write, and the latest read of the object failed; `unknown` — never read, `value` is the type-appropriate default. A failed read turns `synced` into `stale` and keeps the value. It leaves `unknown` and `pending` unchanged. The next successful read sets `synced` again.
      * @example "synced"

package/package.json

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