@springfield/ham-radio-api 0.12.0 → 0.14.0

package/dist/brand.d.ts

@@ -0,0 +1,6 @@
+declare const brand: unique symbol;
+export type Brand<T, TBrand extends string> = T & {
+    [brand]: TBrand;
+};
+export {};
+//# sourceMappingURL=brand.d.ts.map

package/dist/brand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../src/brand.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,EAAE,OAAO,MAAM,CAAC;AAEnC,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,IAAI,CAAC,GAAG;IAAE,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/brand.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=brand.js.map

package/dist/brand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brand.js","sourceRoot":"","sources":["../src/brand.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -4,11 +4,13 @@ export * from './radio/channel.js';
 export * from './radio/connection.js';
 export * from './radio/driver.js';
 export * from './radio/manufacturer.js';
+export * from './radio/memory.js';
 export * from './radio/model.js';
 export * from './radio/module.js';
 export * from './radio/program.js';
 export * from './radio/programmed-channel.js';
 export * from './radio/progress-indicator.js';
+export * from './radio/tone.js';
 export * from './spectrum/band.js';
 export * from './spectrum/channel.js';
 export * from './spectrum/mode.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AAEnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAE9C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AAEnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAEhC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAA"}

package/dist/index.js

@@ -20,11 +20,13 @@ __exportStar(require("./radio/channel.js"), exports);
 __exportStar(require("./radio/connection.js"), exports);
 __exportStar(require("./radio/driver.js"), exports);
 __exportStar(require("./radio/manufacturer.js"), exports);
+__exportStar(require("./radio/memory.js"), exports);
 __exportStar(require("./radio/model.js"), exports);
 __exportStar(require("./radio/module.js"), exports);
 __exportStar(require("./radio/program.js"), exports);
 __exportStar(require("./radio/programmed-channel.js"), exports);
 __exportStar(require("./radio/progress-indicator.js"), exports);
+__exportStar(require("./radio/tone.js"), exports);
 __exportStar(require("./spectrum/band.js"), exports);
 __exportStar(require("./spectrum/channel.js"), exports);
 __exportStar(require("./spectrum/mode.js"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,+DAA6C;AAC7C,qDAAmC;AACnC,wDAAsC;AACtC,oDAAkC;AAClC,0DAAwC;AACxC,mDAAiC;AACjC,oDAAkC;AAClC,qDAAmC;AACnC,gEAA8C;AAC9C,gEAA8C;AAE9C,qDAAmC;AACnC,wDAAsC;AACtC,qDAAmC;AACnC,0DAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AAEnC,+DAA6C;AAC7C,qDAAmC;AACnC,wDAAsC;AACtC,oDAAkC;AAClC,0DAAwC;AACxC,oDAAkC;AAClC,mDAAiC;AACjC,oDAAkC;AAClC,qDAAmC;AACnC,gEAA8C;AAC9C,gEAA8C;AAC9C,kDAAgC;AAEhC,qDAAmC;AACnC,wDAAsC;AACtC,qDAAmC;AACnC,0DAAuC"}

package/dist/radio/channel.d.ts

@@ -1,9 +1,10 @@
+import { RadioTone } from './tone.js';
 export interface RadioChannel {
     id?: string;
     name?: string;
     transmitFrequency: number;
     receiveFrequency: number;
-    transmitTone?: number;
-    receiveTone?: number;
+    transmitTone: RadioTone;
+    receiveTone: RadioTone;
 }
 //# sourceMappingURL=channel.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../src/radio/channel.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../src/radio/channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,MAAM,WAAW,YAAY;IAC3B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,SAAS,CAAC;IACxB,WAAW,EAAE,SAAS,CAAC;CACxB"}

package/dist/radio/driver.d.ts

@@ -1,7 +1,10 @@
+import { RadioMemory } from './memory.js';
 import { RadioProgram } from './program.js';
 import { RadioProgressIndicator } from './progress-indicator.js';
 export interface RadioDriver {
-    importFromRadio(path: string, progressIndicator: RadioProgressIndicator): Promise<RadioProgram | undefined>;
-    programRadio(path: string, program: RadioProgram, progressIndicator: RadioProgressIndicator): Promise<void>;
+    readRadio(serialPortPath: string, progressIndicator: RadioProgressIndicator): Promise<RadioMemory>;
+    writeRadio(serialPortPath: string, memory: RadioMemory, progressIndicator: RadioProgressIndicator): Promise<void>;
+    decodeMemory(memory: RadioMemory): RadioProgram;
+    encodeProgram(program: RadioProgram, memory: RadioMemory): RadioMemory;
 }
 //# sourceMappingURL=driver.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../src/radio/driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,MAAM,WAAW,WAAW;IAC1B,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAC5G,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7G"}
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../src/radio/driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,cAAc,EAAE,MAAM,EAAE,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACnG,UAAU,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElH,YAAY,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY,CAAC;IAChD,aAAa,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,GAAG,WAAW,CAAC;CACxE"}

package/dist/radio/memory.d.ts

@@ -0,0 +1,5 @@
+export interface RadioMemory {
+    id: string;
+    contents: any;
+}
+//# sourceMappingURL=memory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/radio/memory.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,GAAG,CAAC;CACf"}

package/dist/radio/memory.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=memory.js.map

package/dist/radio/memory.js.map

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

package/dist/radio/model.d.ts

@@ -1,4 +1,5 @@
 export interface RadioModel {
+    id: string;
     moduleId: string;
     name: string;
     schema: any;

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

@@ -1 +1 @@
-{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/radio/model.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,GAAG,CAAC;CACb"}
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../src/radio/model.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,GAAG,CAAC;CACb"}

package/dist/radio/programmed-channel.d.ts

@@ -1,9 +1,13 @@
 import { RadioChannelReference } from './channel-reference.js';
 import { RadioChannel } from './channel.js';
+export interface RadioSpecificChannelSettings {
+    [setting: string]: number | string | boolean;
+}
 export interface RadioProgrammedChannel {
     id?: string;
+    radioModelId: string;
     channelNumber: number;
-    transmitPower: number;
     radioChannel: RadioChannel | RadioChannelReference;
+    settings?: RadioSpecificChannelSettings;
 }
 //# sourceMappingURL=programmed-channel.d.ts.map

package/dist/radio/programmed-channel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"programmed-channel.d.ts","sourceRoot":"","sources":["../../src/radio/programmed-channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,WAAW,sBAAsB;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,YAAY,GAAG,qBAAqB,CAAC;CACpD"}
+{"version":3,"file":"programmed-channel.d.ts","sourceRoot":"","sources":["../../src/radio/programmed-channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,WAAW,4BAA4B;IAC3C,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC9C;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,YAAY,GAAG,qBAAqB,CAAC;IACnD,QAAQ,CAAC,EAAE,4BAA4B,CAAC;CACzC"}

package/dist/radio/tone.d.ts

@@ -0,0 +1,9 @@
+export declare enum RadioToneType {
+    CTCSS = 0,
+    DCS = 1
+}
+export interface RadioTone {
+    tone: number;
+    type: RadioToneType;
+}
+//# sourceMappingURL=tone.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tone.d.ts","sourceRoot":"","sources":["../../src/radio/tone.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa;IACvB,KAAK,IAAA;IACL,GAAG,IAAA;CACJ;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;CACrB"}

package/dist/radio/tone.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RadioToneType = void 0;
+var RadioToneType;
+(function (RadioToneType) {
+    RadioToneType[RadioToneType["CTCSS"] = 0] = "CTCSS";
+    RadioToneType[RadioToneType["DCS"] = 1] = "DCS";
+})(RadioToneType = exports.RadioToneType || (exports.RadioToneType = {}));
+//# sourceMappingURL=tone.js.map

package/dist/radio/tone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tone.js","sourceRoot":"","sources":["../../src/radio/tone.ts"],"names":[],"mappings":";;;AAAA,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,mDAAK,CAAA;IACL,+CAAG,CAAA;AACL,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@springfield/ham-radio-api",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "author": "Bryan Hunt",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
   "scripts": {
     "build": "tsc"
   },
-  "packageManager": "yarn@3.4.1",
+  "packageManager": "yarn@3.5.0",
   "devDependencies": {
     "typescript": "4.9.5"
   }

package/src/brand.ts

@@ -0,0 +1,3 @@
+declare const brand: unique symbol;
+
+export type Brand<T, TBrand extends string> = T & { [brand]: TBrand };

package/src/index.ts

@@ -5,11 +5,13 @@ export * from './radio/channel.js';
 export * from './radio/connection.js';
 export * from './radio/driver.js';
 export * from './radio/manufacturer.js';
+export * from './radio/memory.js';
 export * from './radio/model.js';
 export * from './radio/module.js';
 export * from './radio/program.js';
 export * from './radio/programmed-channel.js';
 export * from './radio/progress-indicator.js';
+export * from './radio/tone.js';
 
 export * from './spectrum/band.js';
 export * from './spectrum/channel.js';

package/src/radio/channel.ts

@@ -1,8 +1,10 @@
+import { RadioTone } from './tone.js';
+
 export interface RadioChannel {
   id?: string;
   name?: string;
   transmitFrequency: number;
   receiveFrequency: number;
-  transmitTone?: number;
-  receiveTone?: number;
+  transmitTone: RadioTone;
+  receiveTone: RadioTone;
 }

package/src/radio/driver.ts

@@ -1,7 +1,11 @@
+import { RadioMemory } from './memory.js';
 import { RadioProgram } from './program.js';
 import { RadioProgressIndicator } from './progress-indicator.js';
 
 export interface RadioDriver {
-  importFromRadio(path: string, progressIndicator: RadioProgressIndicator): Promise<RadioProgram | undefined>;
-  programRadio(path: string, program: RadioProgram, progressIndicator: RadioProgressIndicator): Promise<void>;
+  readRadio(serialPortPath: string, progressIndicator: RadioProgressIndicator): Promise<RadioMemory>;
+  writeRadio(serialPortPath: string, memory: RadioMemory, progressIndicator: RadioProgressIndicator): Promise<void>;
+
+  decodeMemory(memory: RadioMemory): RadioProgram;
+  encodeProgram(program: RadioProgram, memory: RadioMemory): RadioMemory;
 }

package/src/radio/memory.ts

@@ -0,0 +1,4 @@
+export interface RadioMemory {
+  id: string;
+  contents: any;
+}

package/src/radio/model.ts

@@ -1,4 +1,5 @@
 export interface RadioModel {
+  id: string;
   moduleId: string;
   name: string;
   schema: any;

package/src/radio/programmed-channel.ts

@@ -1,9 +1,14 @@
 import { RadioChannelReference } from './channel-reference.js';
 import { RadioChannel } from './channel.js';
 
+export interface RadioSpecificChannelSettings {
+  [setting: string]: number | string | boolean;
+}
+
 export interface RadioProgrammedChannel {
   id?: string;
+  radioModelId: string;
   channelNumber: number;
-  transmitPower: number;
   radioChannel: RadioChannel | RadioChannelReference;
+  settings?: RadioSpecificChannelSettings;
 }

package/src/radio/tone.ts

@@ -0,0 +1,9 @@
+export enum RadioToneType {
+  CTCSS,
+  DCS,
+}
+
+export interface RadioTone {
+  tone: number;
+  type: RadioToneType;
+}