@springfield/ham-radio-api 16.3.4 → 17.1.0

package/dist/index.d.ts

@@ -18,6 +18,7 @@ export * from "./radio/driver.js";
 export * from "./radio/driver-provider.js";
 export * from "./radio/id.js";
 export * from "./radio/memory-config.js";
+export * from "./radio/memory-map.js";
 export * from "./radio/memory-segment.js";
 export * from "./radio/memory.js";
 export * from "./radio/module.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}

package/dist/index.js

@@ -18,6 +18,7 @@ export * from "./radio/driver.js";
 export * from "./radio/driver-provider.js";
 export * from "./radio/id.js";
 export * from "./radio/memory-config.js";
+export * from "./radio/memory-map.js";
 export * from "./radio/memory-segment.js";
 export * from "./radio/memory.js";
 export * from "./radio/module.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AAEnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}

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

@@ -0,0 +1,102 @@
+/**
+ * JSON memory-map DSL: describes how radio EEPROM bytes map to settings
+ * without a radio-specific TypeScript decoder.
+ *
+ * Addresses are radio EEPROM addresses (not Chirp image offsets).
+ */
+/** Scalar JSON values stored in decoded settings. */
+export type RadioSettingScalar = string | number | boolean | null;
+/** Nested settings object produced by decode / consumed by encode. */
+export type RadioSettingValue = RadioSettingScalar | RadioSettingValue[] | {
+    [key: string]: RadioSettingValue;
+};
+/** UI widget hint for schema-driven forms. */
+export type RadioMemoryMapWidget = "integer" | "select" | "switch" | "text" | "number";
+/** How a field's raw bits/bytes become a setting value. */
+export type RadioMemoryMapValueKind = {
+    kind: "integer";
+    min?: number;
+    max?: number;
+} | {
+    kind: "boolean";
+} | {
+    kind: "enum";
+    values: string[];
+} | {
+    kind: "ascii";
+    length: number;
+} | {
+    kind: "digits";
+    /** Number of decimal digit bytes. */
+    length: number;
+    /**
+     * Scale applied after parsing digits as a decimal integer.
+     * VFO frequency uses 10 (Hz/10 stored as 8 digits).
+     * Offset uses 1000 (kHz stored as 6 digits → Hz).
+     */
+    scale?: number;
+} | {
+    kind: "dtmf";
+    length: number;
+    /** Character set indexed by byte value; 0xFF terminates. */
+    charset?: string;
+} | {
+    kind: "bbcd";
+    /** Number of packed BCD bytes (Chirp bbcd). */
+    length: number;
+};
+/** UI metadata for a non-reserved field. */
+export interface RadioMemoryMapFieldUi {
+    group: string;
+    label: string;
+    widget: RadioMemoryMapWidget;
+    description?: string;
+    /** Defaults to true. Set false for firmware / read-only messages. */
+    writable?: boolean;
+}
+/**
+ * One field in a sequential struct.
+ * Bitfields pack into the current byte from LSB; width bits are consumed.
+ */
+export interface RadioMemoryMapField {
+    id: string;
+    /**
+     * Storage type:
+     * - u8 / u16: whole bytes (u16 is little-endian, Chirp ul16)
+     * - bits: bitfield of `width` bits within the current byte (LSB-first)
+     * - char: ASCII byte (length via value.kind ascii or count)
+     */
+    type: "u8" | "u16" | "bits" | "char";
+    /** Bit width when type is bits. */
+    width?: number;
+    /** When true, skip decode/encode for this padding field. */
+    reserved?: boolean;
+    value?: RadioMemoryMapValueKind;
+    ui?: RadioMemoryMapFieldUi;
+}
+/**
+ * A named struct at a radio EEPROM seek address.
+ * Fields are laid out sequentially from `seek`.
+ */
+export interface RadioMemoryMapStruct {
+    id: string;
+    /** Radio EEPROM start address (number or hex string such as "0x0E20"). */
+    seek: number | string;
+    fields: RadioMemoryMapField[];
+    /**
+     * Repeat this struct `count` times with `stride` bytes between entries.
+     * Used for PTT-ID code tables.
+     */
+    count?: number;
+    stride?: number;
+}
+/**
+ * Complete memory-map definition for a radio model's settings.
+ */
+export interface RadioMemoryMap {
+    /** Optional map version for tooling. */
+    version?: string;
+    description?: string;
+    structs: RadioMemoryMapStruct[];
+}
+//# sourceMappingURL=memory-map.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"memory-map.d.ts","sourceRoot":"","sources":["../../src/radio/memory-map.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,qDAAqD;AACrD,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAElE,sEAAsE;AACtE,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG,iBAAiB,EAAE,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC;AAEhH,8CAA8C;AAC9C,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEvF,2DAA2D;AAC3D,MAAM,MAAM,uBAAuB,GAC/B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACjC;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN,4CAA4C;AAC5C,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,oBAAoB,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX;;;;;OAKG;IACH,IAAI,EAAE,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,EAAE,CAAC,EAAE,qBAAqB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,0EAA0E;IAC1E,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,oBAAoB,EAAE,CAAC;CACjC"}

package/dist/radio/memory-map.js

@@ -0,0 +1,8 @@
+/**
+ * JSON memory-map DSL: describes how radio EEPROM bytes map to settings
+ * without a radio-specific TypeScript decoder.
+ *
+ * Addresses are radio EEPROM addresses (not Chirp image offsets).
+ */
+export {};
+//# sourceMappingURL=memory-map.js.map

package/dist/radio/memory-map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-map.js","sourceRoot":"","sources":["../../src/radio/memory-map.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

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/dist/radio/radio.d.ts

@@ -1,5 +1,6 @@
 import type { RadioId } from "./id.js";
 import type { RadioMemoryConfig } from "./memory-config.js";
+import type { RadioMemoryMap } from "./memory-map.js";
 import type { RadioProtocolStep } from "./protocol.js";
 import type { RadioSchema } from "./schema.js";
 import type { RadioSerialConfig } from "./serial-config.js";
@@ -12,5 +13,12 @@ export interface Radio {
     serialConfig: RadioSerialConfig;
     readMemory: RadioProtocolStep[];
     writeMemory: RadioProtocolStep[];
+    /**
+     * Optional JSON memory-map for radio-wide settings decode/encode.
+     * May be an inline map or a path/$ref resolved by the registry/module.
+     */
+    memoryMap?: RadioMemoryMap | {
+        $ref: string;
+    };
 }
 //# sourceMappingURL=radio.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"radio.d.ts","sourceRoot":"","sources":["../../src/radio/radio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,WAAW,CAAC;IAC5B,YAAY,EAAE,iBAAiB,CAAC;IAChC,YAAY,EAAE,iBAAiB,CAAC;IAChC,UAAU,EAAE,iBAAiB,EAAE,CAAC;IAChC,WAAW,EAAE,iBAAiB,EAAE,CAAC;CAClC"}
+{"version":3,"file":"radio.d.ts","sourceRoot":"","sources":["../../src/radio/radio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,WAAW,CAAC;IAC5B,YAAY,EAAE,iBAAiB,CAAC;IAChC,YAAY,EAAE,iBAAiB,CAAC;IAChC,UAAU,EAAE,iBAAiB,EAAE,CAAC;IAChC,WAAW,EAAE,iBAAiB,EAAE,CAAC;IACjC;;;OAGG;IACH,SAAS,CAAC,EAAE,cAAc,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C"}

package/dist/radio/settings.d.ts

@@ -1,4 +1,11 @@
-export interface RadioSettings {
-    [setting: string]: string | number | boolean;
-}
+import type { RadioSettingValue } from "./memory-map.js";
+/**
+ * Decoded radio-wide settings.
+ *
+ * Values may be nested objects (struct id → fields) or arrays (repeated structs).
+ * Channel-specific settings may still use a flat map of primitives.
+ */
+export type RadioSettings = {
+    [setting: string]: RadioSettingValue;
+};
 //# sourceMappingURL=settings.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/radio/settings.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC9C"}
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/radio/settings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACtC,CAAC"}

package/package.json

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

package/src/index.ts

@@ -20,6 +20,7 @@ export * from "./radio/driver.js";
 export * from "./radio/driver-provider.js";
 export * from "./radio/id.js";
 export * from "./radio/memory-config.js";
+export * from "./radio/memory-map.js";
 export * from "./radio/memory-segment.js";
 export * from "./radio/memory.js";
 export * from "./radio/module.js";

package/src/radio/memory-map.ts

@@ -0,0 +1,102 @@
+/**
+ * JSON memory-map DSL: describes how radio EEPROM bytes map to settings
+ * without a radio-specific TypeScript decoder.
+ *
+ * Addresses are radio EEPROM addresses (not Chirp image offsets).
+ */
+
+/** Scalar JSON values stored in decoded settings. */
+export type RadioSettingScalar = string | number | boolean | null;
+
+/** Nested settings object produced by decode / consumed by encode. */
+export type RadioSettingValue = RadioSettingScalar | RadioSettingValue[] | { [key: string]: RadioSettingValue };
+
+/** UI widget hint for schema-driven forms. */
+export type RadioMemoryMapWidget = "integer" | "select" | "switch" | "text" | "number";
+
+/** How a field's raw bits/bytes become a setting value. */
+export type RadioMemoryMapValueKind =
+  | { kind: "integer"; min?: number; max?: number }
+  | { kind: "boolean" }
+  | { kind: "enum"; values: string[] }
+  | { kind: "ascii"; length: number }
+  | {
+      kind: "digits";
+      /** Number of decimal digit bytes. */
+      length: number;
+      /**
+       * Scale applied after parsing digits as a decimal integer.
+       * VFO frequency uses 10 (Hz/10 stored as 8 digits).
+       * Offset uses 1000 (kHz stored as 6 digits → Hz).
+       */
+      scale?: number;
+    }
+  | {
+      kind: "dtmf";
+      length: number;
+      /** Character set indexed by byte value; 0xFF terminates. */
+      charset?: string;
+    }
+  | {
+      kind: "bbcd";
+      /** Number of packed BCD bytes (Chirp bbcd). */
+      length: number;
+    };
+
+/** UI metadata for a non-reserved field. */
+export interface RadioMemoryMapFieldUi {
+  group: string;
+  label: string;
+  widget: RadioMemoryMapWidget;
+  description?: string;
+  /** Defaults to true. Set false for firmware / read-only messages. */
+  writable?: boolean;
+}
+
+/**
+ * One field in a sequential struct.
+ * Bitfields pack into the current byte from LSB; width bits are consumed.
+ */
+export interface RadioMemoryMapField {
+  id: string;
+  /**
+   * Storage type:
+   * - u8 / u16: whole bytes (u16 is little-endian, Chirp ul16)
+   * - bits: bitfield of `width` bits within the current byte (LSB-first)
+   * - char: ASCII byte (length via value.kind ascii or count)
+   */
+  type: "u8" | "u16" | "bits" | "char";
+  /** Bit width when type is bits. */
+  width?: number;
+  /** When true, skip decode/encode for this padding field. */
+  reserved?: boolean;
+  value?: RadioMemoryMapValueKind;
+  ui?: RadioMemoryMapFieldUi;
+}
+
+/**
+ * A named struct at a radio EEPROM seek address.
+ * Fields are laid out sequentially from `seek`.
+ */
+export interface RadioMemoryMapStruct {
+  id: string;
+  /** Radio EEPROM start address (number or hex string such as "0x0E20"). */
+  seek: number | string;
+  fields: RadioMemoryMapField[];
+  /**
+   * Repeat this struct `count` times with `stride` bytes between entries.
+   * Used for PTT-ID code tables.
+   */
+  count?: number;
+  stride?: number;
+}
+
+/**
+ * Complete memory-map definition for a radio model's settings.
+ */
+export interface RadioMemoryMap {
+  /** Optional map version for tooling. */
+  version?: string;
+  description?: string;
+  structs: RadioMemoryMapStruct[];
+}

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;

package/src/radio/radio.ts

@@ -1,5 +1,6 @@
 import type { RadioId } from "./id.js";
 import type { RadioMemoryConfig } from "./memory-config.js";
+import type { RadioMemoryMap } from "./memory-map.js";
 import type { RadioProtocolStep } from "./protocol.js";
 import type { RadioSchema } from "./schema.js";
 import type { RadioSerialConfig } from "./serial-config.js";
@@ -13,4 +14,9 @@ export interface Radio {
   serialConfig: RadioSerialConfig;
   readMemory: RadioProtocolStep[];
   writeMemory: RadioProtocolStep[];
+  /**
+   * Optional JSON memory-map for radio-wide settings decode/encode.
+   * May be an inline map or a path/$ref resolved by the registry/module.
+   */
+  memoryMap?: RadioMemoryMap | { $ref: string };
 }

package/src/radio/settings.ts

@@ -1,3 +1,11 @@
-export interface RadioSettings {
-  [setting: string]: string | number | boolean;
-}
+import type { RadioSettingValue } from "./memory-map.js";
+
+/**
+ * Decoded radio-wide settings.
+ *
+ * Values may be nested objects (struct id → fields) or arrays (repeated structs).
+ * Channel-specific settings may still use a flat map of primitives.
+ */
+export type RadioSettings = {
+  [setting: string]: RadioSettingValue;
+};