@synapticon/motion-master-client 6.0.0-alpha.74 → 6.0.0-alpha.76
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.
- package/dist/generated/Api.d.ts +35 -0
- package/package.json +1 -1
package/dist/generated/Api.d.ts
CHANGED
|
@@ -24,6 +24,11 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
24
24
|
* @example "eth0"
|
|
25
25
|
*/
|
|
26
26
|
name: string;
|
|
27
|
+
/**
|
|
28
|
+
* 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.
|
|
29
|
+
* @example "Realtek USB GbE Family Controller"
|
|
30
|
+
*/
|
|
31
|
+
description: string;
|
|
27
32
|
}[], any>>;
|
|
28
33
|
/**
|
|
29
34
|
* No description
|
|
@@ -292,6 +297,11 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
292
297
|
* @example true
|
|
293
298
|
*/
|
|
294
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;
|
|
295
305
|
}, void>>;
|
|
296
306
|
/**
|
|
297
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.
|
|
@@ -1226,6 +1236,11 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
1226
1236
|
* @example true
|
|
1227
1237
|
*/
|
|
1228
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;
|
|
1229
1244
|
}[], any>>;
|
|
1230
1245
|
/**
|
|
1231
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.
|
|
@@ -1265,6 +1280,26 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
1265
1280
|
* @example true
|
|
1266
1281
|
*/
|
|
1267
1282
|
healthy: boolean;
|
|
1283
|
+
/**
|
|
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.
|
|
1287
|
+
* @format int64
|
|
1288
|
+
* @example 0
|
|
1289
|
+
*/
|
|
1290
|
+
shortWkcCycles: number;
|
|
1291
|
+
/**
|
|
1292
|
+
* Epoch microseconds of the first such cycle, 0 if there has been none
|
|
1293
|
+
* @format int64
|
|
1294
|
+
* @example 0
|
|
1295
|
+
*/
|
|
1296
|
+
firstShortWkcUs: number;
|
|
1297
|
+
/**
|
|
1298
|
+
* Epoch microseconds of the most recent such cycle, 0 if there has been none
|
|
1299
|
+
* @format int64
|
|
1300
|
+
* @example 0
|
|
1301
|
+
*/
|
|
1302
|
+
lastShortWkcUs: number;
|
|
1268
1303
|
/**
|
|
1269
1304
|
* Number of process images retained since the last reset
|
|
1270
1305
|
* @example 1
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@synapticon/motion-master-client",
|
|
3
|
-
"version": "6.0.0-alpha.
|
|
3
|
+
"version": "6.0.0-alpha.76",
|
|
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": {
|