@synapticon/motion-master-client 6.0.0-alpha.111 → 6.0.0-alpha.113

package/dist/generated/Api.d.ts

@@ -1909,7 +1909,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      */
     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.
+     * @description Returns one entry per cached parameter-definition file on disk, keyed by vendor ID, product code and firmware version (object 0x100A). A device without 0x100A is not cached. 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
@@ -1925,7 +1925,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      */
     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.
+     * @description Removes one cached file from disk. The next scan of that hardware re-enumerates it. Useful when a firmware changed its object dictionary and kept its version string.
      *
      * @name DeleteParameterCache
      * @summary Delete a parameter-cache file
@@ -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 that a client adds, named `esi-<vendor>-<version>.xml`; a device whose vendor and firmware version (0x100A) match a file takes the units 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

@@ -1230,7 +1230,7 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @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.
+     * @description Returns one entry per cached parameter-definition file on disk, keyed by vendor ID, product code and firmware version (object 0x100A). A device without 0x100A is not cached. 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
@@ -1256,7 +1256,7 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @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.
+     * @description Removes one cached file from disk. The next scan of that hardware re-enumerates it. Useful when a firmware changed its object dictionary and kept its version string.
      *
      * @name DeleteParameterCache
      * @summary Delete a parameter-cache file
@@ -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 that a client adds, named `esi-<vendor>-<version>.xml`; a device whose vendor and firmware version (0x100A) match a file takes the units 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

@@ -232,8 +232,8 @@ export interface UserCacheFile {
 /** Summary of one on-disk parameter-cache file (its identity, size, and count). */
 export interface ParameterCacheEntry {
     /**
-     * Opaque key addressing this cache file in the download/delete endpoints ("<vendor>-<product>-<revision>"). Use it verbatim — do not construct it client-side.
-     * @example "000022d2-00000201-0000000a"
+     * Opaque key addressing this cache file in the download/delete endpoints ("<vendor>-<product>-<version>", the version reduced to URL-safe characters). Use it verbatim — do not construct it client-side.
+     * @example "000022d2-00000201-v5.6.6"
      */
     id: string;
     /**
@@ -247,10 +247,10 @@ export interface ParameterCacheEntry {
      */
     productCode: number;
     /**
-     * Revision number.
-     * @example 10
+     * The device's firmware version (0x100A) the file was written for, in full.
+     * @example "v5.6.6"
      */
-    revisionNumber: number;
+    firmwareVersion: string;
     /**
      * Number of cached parameter definitions in the file.
      * @example 312
@@ -1018,7 +1018,7 @@ export interface ProcedureRequest {
      */
     pollIntervalMs?: number;
     /**
-     * `os-command` only: whether the command moves bulk data through the drive's fs-buffer, and which way. Most commands move none. The transfer runs while the command runs, because the drive holds the command in progress until all the data has moved, and it needs firmware 5.2 or newer. Setting a direction for a command that moves no bulk data leaves the server waiting for a transfer the drive will never start.
+     * `os-command` only: whether the command moves bulk data through the drive's fs-buffer, and which way. Most commands move none. A write runs while the command runs, because the command reads its input as it arrives, and it needs firmware 5.2 or newer. A read runs after the command succeeds, because the command completes when its whole output is in the fs-buffer. No read runs after a failure. An output larger than the 2024-byte fs-buffer cannot be read: the command waits for the master to empty it and runs into its timeout. Setting a direction for a command that moves no bulk data makes the transfer wait for an answer the drive never sends.
      * @default "none"
      * @example "read"
      */
@@ -1692,10 +1692,15 @@ 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;
+    /**
+     * 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;
     /** Slave-reported default value, decoded with the same logic as `value`.  Absent when the slave does not report a default. */
     defaultValue?: ParameterValue;
     /** Slave-reported minimum value, decoded with the same logic as `value`.  Absent when the slave does not report a minimum. */

package/package.json

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