@synapticon/motion-master-client 6.0.0-alpha.45 → 6.0.0-alpha.47

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.
@@ -13,7 +13,12 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
13
13
  * MAC address in colon-separated uppercase format
14
14
  * @example "AA:BB:CC:DD:EE:FF"
15
15
  */
16
- mac: string;
16
+ macLinux: string;
17
+ /**
18
+ * MAC address in dash-separated uppercase format
19
+ * @example "AA-BB-CC-DD-EE-FF"
20
+ */
21
+ macWindows: string;
17
22
  /**
18
23
  * OS interface name (e.g. eth0 on Linux, \\Device\\NPF_{GUID} on Windows)
19
24
  * @example "eth0"
@@ -31,6 +36,14 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
31
36
  /** @example "6.0.0" */
32
37
  version: string;
33
38
  }, any>>;
39
+ /**
40
+ * @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.
41
+ *
42
+ * @name GetSwaggerYml
43
+ * @summary Get this OpenAPI specification
44
+ * @request GET:/api/swagger.yml
45
+ */
46
+ getSwaggerYml: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<string, any>>;
34
47
  /**
35
48
  * @description The effective configuration after merging the JSONC config file (if any) over the built-in defaults — the same `Config` the server booted with. 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).
36
49
  *
@@ -318,7 +331,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
318
331
  error: string;
319
332
  }>>;
320
333
  /**
321
- * @description Transitions all slaves to INIT state, closes the network interface, and removes all Device objects. After this returns, POST /api/init and POST /api/scan may be called again.
334
+ * @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.
322
335
  *
323
336
  * @name Reset
324
337
  * @summary Reset the fieldbus driver and clear the device list
@@ -37,6 +37,18 @@ export class Api extends HttpClient {
37
37
  format: "json",
38
38
  ...params,
39
39
  });
40
+ /**
41
+ * @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.
42
+ *
43
+ * @name GetSwaggerYml
44
+ * @summary Get this OpenAPI specification
45
+ * @request GET:/api/swagger.yml
46
+ */
47
+ getSwaggerYml = (params = {}) => this.request({
48
+ path: `/api/swagger.yml`,
49
+ method: "GET",
50
+ ...params,
51
+ });
40
52
  /**
41
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. 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).
42
54
  *
@@ -131,7 +143,7 @@ export class Api extends HttpClient {
131
143
  ...params,
132
144
  });
133
145
  /**
134
- * @description Transitions all slaves to INIT state, closes the network interface, and removes all Device objects. After this returns, POST /api/init and POST /api/scan may be called again.
146
+ * @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.
135
147
  *
136
148
  * @name Reset
137
149
  * @summary Reset the fieldbus driver and clear the device list
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@synapticon/motion-master-client",
3
- "version": "6.0.0-alpha.45",
3
+ "version": "6.0.0-alpha.47",
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": {