@springfield/ham-radio-api 16.3.4 → 17.0.0

package/dist/radio/memory-segment.d.ts

@@ -1,4 +1,5 @@
 export interface RadioMemorySegment {
+    /** Inclusive end of the segment (a range 0–6143 is 6144 bytes). */
     endAddress: number;
     startAddress: number;
 }

package/dist/radio/memory-segment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"memory-segment.d.ts","sourceRoot":"","sources":["../../src/radio/memory-segment.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"memory-segment.d.ts","sourceRoot":"","sources":["../../src/radio/memory-segment.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,mEAAmE;IACnE,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/dist/radio/protocol.d.ts

@@ -1,79 +1,68 @@
-export interface RadioExactReceivePattern {
-    type: "exact";
-    value: number;
-    length: number;
+/**
+ * A byte in a send or expect array.
+ *
+ * - number 0–255: literal byte
+ * - hex string such as `"0x50"`: literal byte
+ * - single-character string such as `"S"`: ASCII opcode
+ * - placeholder: `"$address"`, `"$chunkSize"`, `"$length"`, `"$data"`
+ */
+export type RadioByteToken = number | string;
+/**
+ * Receive any content of a fixed length, such as a radio identifier.
+ */
+export interface RadioExpectBytes {
+    bytes: number;
 }
-export interface RadioVariableReceivePattern {
-    type: "variable";
-    length: number;
-}
-export interface RadioPatternReceivePattern {
-    type: "pattern";
-    pattern: (string | number | {
-        field: string;
-        size: number;
-    })[];
-    dataLength?: number | string;
-}
-export interface RadioAnyReceivePattern {
-    type: "any";
-    length: number;
-}
-export type RadioReceivePattern = RadioExactReceivePattern | RadioVariableReceivePattern | RadioPatternReceivePattern | RadioAnyReceivePattern;
-export interface RadioSendReceiveStep {
-    sendReceive: {
-        send: (string | number)[];
-        receive: RadioReceivePattern;
-        timeout?: number;
-        description?: string;
-    };
-}
-export interface RadioSendStep {
-    send: {
-        data: (string | number)[];
-        description?: string;
-    };
-}
-export interface RadioReceiveStep {
-    receive: {
-        type: "exact" | "variable" | "pattern" | "any";
-        value?: number;
-        length: number;
-        pattern?: (string | number | {
-            field: string;
-            size: number;
-        })[];
-        description?: string;
-    };
-}
-export interface RadioReadSegmentStep {
-    readSegment: {
+/**
+ * Expected serial reply for an exchange.
+ *
+ * - token: exact 1-byte match (ACK)
+ * - token array: exact multi-byte match, or a framed reply with `$` placeholders
+ * - `{ bytes: N }`: any N bytes
+ */
+export type RadioExpect = RadioByteToken | RadioByteToken[] | RadioExpectBytes;
+/**
+ * One serial exchange: send bytes and/or wait for a reply.
+ * At least one of `send` or `expect` must be present.
+ */
+export type RadioExchange = {
+    description?: string;
+    send: RadioByteToken[];
+    expect?: RadioExpect;
+    timeout?: number;
+} | {
+    description?: string;
+    send?: RadioByteToken[];
+    expect: RadioExpect;
+    timeout?: number;
+};
+/**
+ * Chunked memory read: repeat an exchange across named segments.
+ * `$data` in `expect` is captured into the memory buffer.
+ * Optional `ack` is a second exchange after each chunk (for example an ACK).
+ */
+export interface RadioReadStep {
+    description?: string;
+    read: {
         segments: string[];
-        startChunk: {
-            send: (string | number)[];
-            receive: RadioReceivePattern;
-        };
-        endChunk: {
-            send: (string | number)[];
-            receive: RadioReceivePattern;
-        };
-        description?: string;
+        send: RadioByteToken[];
+        expect: RadioExpect;
+        ack?: RadioExchange;
+        timeout?: number;
     };
 }
-export interface RadioWriteSegmentStep {
-    writeSegment: {
+/**
+ * Chunked memory write: repeat an exchange across named segments.
+ * `$data` in `send` emits the current chunk from the memory buffer.
+ */
+export interface RadioWriteStep {
+    description?: string;
+    write: {
         segments: string[];
-        send: (string | number)[];
-        data: string;
-        receive: RadioReceivePattern;
-        description?: string;
-    };
-}
-export interface RadioSetVariableStep {
-    setVariable: {
-        name: string;
-        value: string | number;
+        send: RadioByteToken[];
+        expect: RadioExpect;
+        timeout?: number;
     };
 }
-export type RadioProtocolStep = RadioSendReceiveStep | RadioSendStep | RadioReceiveStep | RadioReadSegmentStep | RadioWriteSegmentStep | RadioSetVariableStep;
+export type RadioProtocolStep = RadioExchange | RadioReadStep | RadioWriteStep;
 //# sourceMappingURL=protocol.d.ts.map

package/dist/radio/protocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/radio/protocol.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC;IAC/D,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,KAAK,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,mBAAmB,GAAG,wBAAwB,GAAG,2BAA2B,GAAG,0BAA0B,GAAG,sBAAsB,CAAC;AAE/I,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE;QACX,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,mBAAmB,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE;QACJ,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;QAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE;QACP,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,KAAK,CAAC;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,EAAE,CAAC;QAChE,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE;QACX,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,UAAU,EAAE;YACV,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,mBAAmB,CAAC;SAC9B,CAAC;QACF,QAAQ,EAAE;YACR,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,EAAE,mBAAmB,CAAC;SAC9B,CAAC;QACF,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE;QACZ,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,mBAAmB,CAAC;QAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB,CAAC;CACH;AAED,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG,aAAa,GAAG,gBAAgB,GAAG,oBAAoB,GAAG,qBAAqB,GAAG,oBAAoB,CAAC"}
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/radio/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,cAAc,EAAE,GAAG,gBAAgB,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB;IACE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,cAAc,EAAE,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,cAAc,EAAE,CAAC;IACxB,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEN;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,IAAI,EAAE,cAAc,EAAE,CAAC;QACvB,MAAM,EAAE,WAAW,CAAC;QACpB,GAAG,CAAC,EAAE,aAAa,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,IAAI,EAAE,cAAc,EAAE,CAAC;QACvB,MAAM,EAAE,WAAW,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,aAAa,GAAG,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@springfield/ham-radio-api",
-  "version": "16.3.4",
+  "version": "17.0.0",
   "author": "Bryan Hunt",
   "files": [
     "dist/",

package/src/radio/memory-segment.ts

@@ -1,4 +1,5 @@
 export interface RadioMemorySegment {
+  /** Inclusive end of the segment (a range 0–6143 is 6144 bytes). */
   endAddress: number;
   startAddress: number;
 }

package/src/radio/protocol.ts

@@ -1,83 +1,75 @@
-export interface RadioExactReceivePattern {
-  type: "exact";
-  value: number;
-  length: number;
-}
-
-export interface RadioVariableReceivePattern {
-  type: "variable";
-  length: number;
-}
-
-export interface RadioPatternReceivePattern {
-  type: "pattern";
-  pattern: (string | number | { field: string; size: number })[];
-  dataLength?: number | string; // Optional - actual length determined by segment configuration
-}
-
-export interface RadioAnyReceivePattern {
-  type: "any";
-  length: number;
-}
-
-export type RadioReceivePattern = RadioExactReceivePattern | RadioVariableReceivePattern | RadioPatternReceivePattern | RadioAnyReceivePattern;
-
-export interface RadioSendReceiveStep {
-  sendReceive: {
-    send: (string | number)[];
-    receive: RadioReceivePattern;
-    timeout?: number;
-    description?: string;
-  };
-}
+/**
+ * A byte in a send or expect array.
+ *
+ * - number 0–255: literal byte
+ * - hex string such as `"0x50"`: literal byte
+ * - single-character string such as `"S"`: ASCII opcode
+ * - placeholder: `"$address"`, `"$chunkSize"`, `"$length"`, `"$data"`
+ */
+export type RadioByteToken = number | string;
 
-export interface RadioSendStep {
-  send: {
-    data: (string | number)[];
-    description?: string;
-  };
+/**
+ * Receive any content of a fixed length, such as a radio identifier.
+ */
+export interface RadioExpectBytes {
+  bytes: number;
 }
 
-export interface RadioReceiveStep {
-  receive: {
-    type: "exact" | "variable" | "pattern" | "any";
-    value?: number;
-    length: number;
-    pattern?: (string | number | { field: string; size: number })[];
-    description?: string;
-  };
-}
+/**
+ * Expected serial reply for an exchange.
+ *
+ * - token: exact 1-byte match (ACK)
+ * - token array: exact multi-byte match, or a framed reply with `$` placeholders
+ * - `{ bytes: N }`: any N bytes
+ */
+export type RadioExpect = RadioByteToken | RadioByteToken[] | RadioExpectBytes;
 
-export interface RadioReadSegmentStep {
-  readSegment: {
-    segments: string[];
-    startChunk: {
-      send: (string | number)[];
-      receive: RadioReceivePattern;
-    };
-    endChunk: {
-      send: (string | number)[];
-      receive: RadioReceivePattern;
+/**
+ * One serial exchange: send bytes and/or wait for a reply.
+ * At least one of `send` or `expect` must be present.
+ */
+export type RadioExchange =
+  | {
+      description?: string;
+      send: RadioByteToken[];
+      expect?: RadioExpect;
+      timeout?: number;
+    }
+  | {
+      description?: string;
+      send?: RadioByteToken[];
+      expect: RadioExpect;
+      timeout?: number;
     };
-    description?: string;
-  };
-}
 
-export interface RadioWriteSegmentStep {
-  writeSegment: {
+/**
+ * Chunked memory read: repeat an exchange across named segments.
+ * `$data` in `expect` is captured into the memory buffer.
+ * Optional `ack` is a second exchange after each chunk (for example an ACK).
+ */
+export interface RadioReadStep {
+  description?: string;
+  read: {
     segments: string[];
-    send: (string | number)[];
-    data: string;
-    receive: RadioReceivePattern;
-    description?: string;
+    send: RadioByteToken[];
+    expect: RadioExpect;
+    ack?: RadioExchange;
+    timeout?: number;
   };
 }
 
-export interface RadioSetVariableStep {
-  setVariable: {
-    name: string;
-    value: string | number;
+/**
+ * Chunked memory write: repeat an exchange across named segments.
+ * `$data` in `send` emits the current chunk from the memory buffer.
+ */
+export interface RadioWriteStep {
+  description?: string;
+  write: {
+    segments: string[];
+    send: RadioByteToken[];
+    expect: RadioExpect;
+    timeout?: number;
   };
 }
 
-export type RadioProtocolStep = RadioSendReceiveStep | RadioSendStep | RadioReceiveStep | RadioReadSegmentStep | RadioWriteSegmentStep | RadioSetVariableStep;
+export type RadioProtocolStep = RadioExchange | RadioReadStep | RadioWriteStep;