@synapticon/motion-master-client 6.0.0-alpha.75 → 6.0.0-alpha.77

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -50,7 +50,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
50
50
  */
51
51
  getSwaggerYml: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<string, any>>;
52
52
  /**
53
- * @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, logLevel, tls, gameLoop, recorder, parameterCache, parameters).
53
+ * @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).
54
54
  *
55
55
  * @name GetStartedConfig
56
56
  * @summary Get the configuration Motion Master was started with
@@ -297,6 +297,11 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
297
297
  * @example true
298
298
  */
299
299
  isCia402: boolean;
300
+ /**
301
+ * 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.
302
+ * @example false
303
+ */
304
+ parametersUnavailable: boolean;
300
305
  }, void>>;
301
306
  /**
302
307
  * @description Constructs the requested fieldbus driver, opens the network interface, and makes the driver available for subsequent calls to /api/scan. The driver defaults to SOEM when omitted. SOEM has no adapter auto-detect: a network adapter must be supplied, otherwise init fails.
@@ -1231,6 +1236,11 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
1231
1236
  * @example true
1232
1237
  */
1233
1238
  isCia402: boolean;
1239
+ /**
1240
+ * 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.
1241
+ * @example false
1242
+ */
1243
+ parametersUnavailable: boolean;
1234
1244
  }[], any>>;
1235
1245
  /**
1236
1246
  * @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.
@@ -1271,7 +1281,9 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
1271
1281
  */
1272
1282
  healthy: boolean;
1273
1283
  /**
1274
- * Cycles that answered with a working counter below `expectedWkc` since this image was published. `healthy` is a sample of the most recent cycle and so cannot see a fault that has already cleared; this count can.
1284
+ * 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.
1285
+ *
1286
+ * 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.
1275
1287
  * @format int64
1276
1288
  * @example 0
1277
1289
  */
@@ -1492,7 +1504,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
1492
1504
  size: number;
1493
1505
  }, void>>;
1494
1506
  /**
1495
- * @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.
1507
+ * @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`.
1496
1508
  *
1497
1509
  * @name DeleteUserCacheFile
1498
1510
  * @summary Delete a user-cache file or directory
@@ -50,7 +50,7 @@ export class Api extends HttpClient {
50
50
  ...params,
51
51
  });
52
52
  /**
53
- * @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, logLevel, tls, gameLoop, recorder, parameterCache, parameters).
53
+ * @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).
54
54
  *
55
55
  * @name GetStartedConfig
56
56
  * @summary Get the configuration Motion Master was started with
@@ -1119,7 +1119,7 @@ export class Api extends HttpClient {
1119
1119
  ...params,
1120
1120
  });
1121
1121
  /**
1122
- * @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.
1122
+ * @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`.
1123
1123
  *
1124
1124
  * @name DeleteUserCacheFile
1125
1125
  * @summary Delete a user-cache file or directory
@@ -191,6 +191,11 @@ export interface UserCacheFile {
191
191
  * @example 1783968687738
192
192
  */
193
193
  modifiedMs: number;
194
+ /**
195
+ * Whether `DELETE` will accept this path. False for a file the running server holds open — today only its own log file, `logs/motion-master.log`. Deleting such a file cannot do what it appears to (Windows refuses; Linux and macOS unlink it while the server keeps writing to it, reclaiming nothing), so the request is refused with `409 Conflict` and a client should not offer the action. Rotated copies are closed and remain deletable, which is how the space is reclaimed.
196
+ * @example true
197
+ */
198
+ deletable: boolean;
194
199
  }
195
200
  /** Summary of one on-disk parameter-cache file (its identity, size, and count). */
196
201
  export interface ParameterCacheEntry {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@synapticon/motion-master-client",
3
- "version": "6.0.0-alpha.75",
3
+ "version": "6.0.0-alpha.77",
4
4
  "description": "Isomorphic TypeScript client for Motion Master: the generated HTTP API client, the WebSocket connection, and helpers.",
5
5
  "license": "MIT",
6
6
  "repository": {