@synapticon/motion-master-client 6.0.0-alpha.37 → 6.0.0-alpha.38

package/dist/generated/Api.d.ts

@@ -931,6 +931,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @request GET:/api/game-loop
      */
     getGameLoop: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<GameLoopHealth, any>>;
+    /**
+     * @description Retimes the running RT loop to a new cycle period, in microseconds. The change takes effect within one cycle and is transient — it is not written back to the config file, so a restart reverts to the configured `gameLoop.periodUs`. Intended for tuning on hosts that cannot sustain the configured rate: if `skippedCycles` climbs steadily (common on Windows userspace), raise the period (e.g. from 1000 to 2000 µs) until the loop meets its grid. Only the master cadence is retimed — the process-data recorder ring is not resized, and no drive-side watchdog is touched, so raising the period toward a drive's PDO/SM watchdog window can fault that drive. Applying a period starts a fresh health epoch: the cumulative counters (`executedCycles`, `skippedCycles`, the `achievedHz` average, and `maxExecNs`/`avgExecNs`) reset so the snapshot reflects only the new period — letting you see straight away whether the change improved the loop's health. Returns the updated health snapshot.
+     *
+     * @name SetGameLoopPeriod
+     * @summary Change the real-time cycle period
+     * @request PUT:/api/game-loop
+     */
+    setGameLoopPeriod: (data: {
+        /**
+         * New cycle period in microseconds. Must be greater than 0.
+         * @format int64
+         * @min 1
+         * @example 2000
+         */
+        periodUs: number;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<GameLoopHealth, void>>;
     /**
      * @description Streams the same `.mmpd` serialisation as the POST variant (the recorder's current span, with the process image embedded as a header) directly in the response body instead of writing a file — for the client SDK / browser, which parses the bytes offline. Request with `Accept: application/octet-stream`. Same span semantics as the POST; works in any state.
      *

package/dist/generated/Api.js

@@ -552,6 +552,21 @@ export class Api extends HttpClient {
         format: "json",
         ...params,
     });
+    /**
+     * @description Retimes the running RT loop to a new cycle period, in microseconds. The change takes effect within one cycle and is transient — it is not written back to the config file, so a restart reverts to the configured `gameLoop.periodUs`. Intended for tuning on hosts that cannot sustain the configured rate: if `skippedCycles` climbs steadily (common on Windows userspace), raise the period (e.g. from 1000 to 2000 µs) until the loop meets its grid. Only the master cadence is retimed — the process-data recorder ring is not resized, and no drive-side watchdog is touched, so raising the period toward a drive's PDO/SM watchdog window can fault that drive. Applying a period starts a fresh health epoch: the cumulative counters (`executedCycles`, `skippedCycles`, the `achievedHz` average, and `maxExecNs`/`avgExecNs`) reset so the snapshot reflects only the new period — letting you see straight away whether the change improved the loop's health. Returns the updated health snapshot.
+     *
+     * @name SetGameLoopPeriod
+     * @summary Change the real-time cycle period
+     * @request PUT:/api/game-loop
+     */
+    setGameLoopPeriod = (data, params = {}) => this.request({
+        path: `/api/game-loop`,
+        method: "PUT",
+        body: data,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+    });
     /**
      * @description Streams the same `.mmpd` serialisation as the POST variant (the recorder's current span, with the process image embedded as a header) directly in the response body instead of writing a file — for the client SDK / browser, which parses the bytes offline. Request with `Accept: application/octet-stream`. Same span semantics as the POST; works in any state.
      *

package/dist/mmpd.d.ts

@@ -19,7 +19,6 @@ export interface MmpdDevice {
 export interface MmpdHeader {
     formatVersion: number;
     flags: number;
-    cyclePeriodUs: number;
     startSequence: bigint;
     rowCount: number;
     inputBytes: number;

package/dist/mmpd.js

@@ -3,7 +3,7 @@
 // Master and no live bus. All multi-byte integers are little-endian.
 //
 // Layout:
-//   Prefix (40 bytes): magic 'MMPD', u16 formatVersion, u16 flags, u32 cyclePeriodUs,
+//   Prefix (36 bytes): magic 'MMPD', u16 formatVersion, u16 flags,
 //     u64 startSequence, u64 rowCount, u32 inputBytes, u32 outputBytes, u32 deviceCount.
 //   Device table (deviceCount): u16 slavePosition, u32 vendorId/productCode/revisionNumber/
 //     serialNumber, str name, u32 entryCount, then per entry: u16 index, u8 subindex,
@@ -124,7 +124,7 @@ export class MmpdFile {
 export function parseMmpd(data) {
     const u8 = data instanceof Uint8Array ? data : new Uint8Array(data);
     const dv = new DataView(u8.buffer, u8.byteOffset, u8.byteLength);
-    if (u8.byteLength < 40 || dv.getUint32(0, true) !== MAGIC) {
+    if (u8.byteLength < 36 || dv.getUint32(0, true) !== MAGIC) {
         throw new Error('Not a .mmpd file (bad magic)');
     }
     const formatVersion = dv.getUint16(4, true);
@@ -134,15 +134,14 @@ export function parseMmpd(data) {
     const header = {
         formatVersion,
         flags: dv.getUint16(6, true),
-        cyclePeriodUs: dv.getUint32(8, true),
-        startSequence: dv.getBigUint64(12, true),
-        rowCount: Number(dv.getBigUint64(20, true)),
-        inputBytes: dv.getUint32(28, true),
-        outputBytes: dv.getUint32(32, true),
+        startSequence: dv.getBigUint64(8, true),
+        rowCount: Number(dv.getBigUint64(16, true)),
+        inputBytes: dv.getUint32(24, true),
+        outputBytes: dv.getUint32(28, true),
         devices: [],
     };
-    const deviceCount = dv.getUint32(36, true);
-    const cursor = new Cursor(dv, u8, 40);
+    const deviceCount = dv.getUint32(32, true);
+    const cursor = new Cursor(dv, u8, 36);
     for (let d = 0; d < deviceCount; d++) {
         const device = {
             slavePosition: cursor.u16(),

package/package.json

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