@ham2k/lib-operation-data 0.6.1 → 0.7.1

package/package.json

@@ -1,12 +1,19 @@
 {
   "name": "@ham2k/lib-operation-data",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "type": "module",
   "main": "./src/index.js",
   "exports": {
     ".": "./src/index.js"
   },
   "devDependencies": {
+    "jest": "~29",
     "standard": "^17.0.0"
+  },
+  "scripts": {
+    "test": "node --experimental-vm-modules ./node_modules/.bin/jest"
+  },
+  "standard": {
+    "env": [ "jest" ]
   }
 }

package/src/data/bandPlans.json

@@ -0,0 +1,141 @@
+{
+  "sources": [
+    { "url": "https://www.iaru-r2.org/en/reference/band-plans/" },
+    { "url": "https://www.arrl.org/band-plan" },
+    { "url": "https://www.arrl.org/news/view/updated-arrl-us-amateur-radio-bands-charts-now-available" }
+  ],
+  "bands": {
+    "160m": {
+      "mhz": [1800, 2000],
+      "segments": [
+        { "name": "CW", "mhz": [1800, 1843], "mode": "CW" },
+        { "name": "Data", "mhz": [1800, 1810], "mode": "RTTY" },
+        { "name": "FT8", "mhz": [1840, 1843], "mode": "FT8" },
+        { "name": "Phone", "mhz": [1843, 2000], "mode": "SSB", "submode": "LSB" }
+      ]
+    },
+    "80m": {
+      "mhz": [3500, 3800],
+      "segments": [
+        { "name": "CW", "mhz": [3500, 3600], "mode": "CW" },
+        { "name": "Phone", "mhz": [3535, 3800], "mode": "SSB", "submode": "LSB", "regions": [ 3 ] },
+        { "name": "FT8", "mhz": [3568, 3571], "mode": "FT8", "regions": [ 3 ] },
+        { "name": "Data", "mhz": [3570, 3600], "mode": "RTTY" },
+        { "name": "FT8", "mhz": [3573, 3576], "mode": "FT8" },
+        { "name": "Phone", "mhz": [3600, 4000], "mode": "SSB", "submode": "LSB" }
+      ]
+    },
+    "60m": {
+      "mhz": [5330.5, 3406.5],
+      "segments": [
+        { "name": "60m Channel 1", "mhz": [5330.5, 5333.5] },
+        { "name": "60m Channel 2", "mhz": [5346.5, 5349.5] },
+        { "name": "60m Channel 3", "mhz": [5357, 5360], "mode": "FT8" },
+        { "name": "60m Channel 4", "mhz": [5371.5, 5373.5] },
+        { "name": "60m Channel 5", "mhz": [5403.5, 5406.5] }
+      ]
+    },
+    "40m": {
+      "mhz": [7000, 7300],
+      "segments": [
+        { "name": "CW", "mhz": [7000, 7060], "mode": "CW" },
+        { "name": "CW", "mhz": [7000, 7125], "mode": "CW", "countries": [ "US" ] },
+        { "name": "FT4", "mhz": [7047.5, 7050.5], "mode": "FT4" },
+        { "name": "Phone", "mhz": [7060, 7300], "mode": "SSB", "submode": "LSB" },
+        { "name": "FT8", "mhz": [7074, 7077], "mode": "FT8" },
+        { "name": "Data", "mhz": [7080, 7125], "mode": "RTTY" },
+        { "name": "Phone", "mhz": [7125, 7300], "mode": "SSB", "submode": "LSB", "countries": [ "US" ] }
+      ]
+    },
+    "30m": {
+      "mhz": [10100, 10150],
+      "segments": [
+        { "name": "CW", "mhz": [10100, 10150], "mode": "CW" },
+        { "name": "Data", "mhz": [10130, 10140], "mode": "RTTY" },
+        { "name": "FT8", "mhz": [10136, 10139], "mode": "FT8" },
+        { "name": "FT4", "mhz": [10140, 10143], "mode": "FT4" }
+      ]
+    },
+    "20m": {
+      "mhz": [14000, 14350],
+      "segments": [
+        { "name": "CW", "mhz": [14000, 14101], "mode": "CW", "regions": [ 2 ] },
+        { "name": "CW", "mhz": [14000, 14150], "mode": "CW" },
+        { "name": "Data", "mhz": [14070, 14095], "mode": "RTTY" },
+        { "name": "FT8", "mhz": [14074, 14077], "mode": "FT8" },
+        { "name": "FT4", "mhz": [14080, 14083], "mode": "FT4" },
+        { "name": "Phone", "mhz": [14112, 14350], "mode": "SSB", "submode": "USB", "regions": [ 2 ] },
+        { "name": "Phone", "mhz": [14150, 14350], "mode": "SSB", "submode": "USB", "countries": [ "US" ] }
+      ]
+    },
+    "17m": {
+      "mhz": [18068, 18168],
+      "segments": [
+        { "name": "CW", "mhz": [18068, 18110], "mode": "CW" },
+        { "name": "Data", "mhz": [18100, 18105], "mode": "RTTY" },
+        { "name": "FT8", "mhz": [18100, 18103], "mode": "FT8" },
+        { "name": "FT4", "mhz": [18104, 18107], "mode": "FT4" },
+        { "name": "Phone", "mhz": [18110, 18168], "mode": "SSB", "submode": "USB" }
+      ]
+    },
+    "15m": {
+      "mhz": [21000, 21450],
+      "segments": [
+        { "name": "CW", "mhz": [21000, 21150], "mode": "CW" },
+        { "name": "Data", "mhz": [21070, 21095], "mode": "RTTY" },
+        { "name": "FT8", "mhz": [21074, 21077], "mode": "FT8" },
+        { "name": "FT4", "mhz": [21140, 21143], "mode": "FT4" },
+        { "name": "Phone", "mhz": [21150, 21450], "mode": "SSB", "submode": "USB" }
+      ]
+    },
+    "12m": {
+      "mhz": [24890, 24990],
+      "segments": [
+        { "name": "CW", "mhz": [24890, 24930], "mode": "CW" },
+        { "name": "FT8", "mhz": [24915, 24918], "mode": "FT8" },
+        { "name": "FT4", "mhz": [24919, 23922], "mode": "FT4" },
+        { "name": "Data", "mhz": [24920, 24925], "mode": "RTTY" },
+        { "name": "Phone", "mhz": [24930, 24990], "mode": "SSB", "submode": "USB" }
+      ]
+    },
+    "10m": {
+      "mhz": [28000, 29700],
+      "segments": [
+        { "name": "CW", "mhz": [28000, 28190], "mode": "CW" },
+        { "name": "Data", "mhz": [28070, 28150], "mode": "RTTY" },
+        { "name": "FT8", "mhz": [28074, 28077], "mode": "FT8" },
+        { "name": "FT4", "mhz": [28180, 28183], "mode": "FT4" },
+        { "name": "Beacons", "mhz": [28190, 28300] },
+        { "name": "Phone SSB", "mhz": [28300, 29000], "mode": "SSB", "submode": "USB" },
+        { "name": "AM", "mhz": [29000, 29200], "mode": "AM" },
+        { "name": "Satellite", "mhz": [29300, 29520] },
+        { "name": "Repeater Uplinks", "mhz": [29520, 29590] },
+        { "name": "FM", "mhz": [29520, 29700], "mode": "FM" },
+        { "name": "Repeater Downlinks", "mhz": [29620, 29700] }
+      ]
+    },
+    "6m": {
+      "mhz": [50000, 54000],
+      "segments": [
+        { "name": "CW", "mhz": [50000, 50150], "mode": "CW" },
+        { "name": "Data", "mhz": [50090, 50130], "mode": "RTTY" },
+        { "name": "Phone", "mhz": [50150, 50600], "mode": "SSB", "submode": "USB" },
+        { "name": "AM", "mhz": [50150, 54000], "mode": "AM" },
+        { "name": "FT8", "mhz": [50313, 50316], "mode": "FT8" },
+        { "name": "FT4", "mhz": [50318, 50321], "mode": "FT4" },
+        { "name": "FT8", "mhz": [50323, 50326], "mode": "FT8" }
+      ]
+    },
+    "2m": {
+      "mhz": [144000, 148000],
+      "segments": [
+        { "name": "CW", "mhz": [144000, 144100], "mode": "CW" },
+        { "name": "Data", "mhz": [144100, 144200], "mode": "RTTY" },
+        { "name": "FT8", "mhz": [144174, 144177], "mode": "FT8" },
+        { "name": "FT8", "mhz": [144170, 144173], "mode": "FT4" },
+        { "name": "Phone", "mhz": [144200, 144275], "mode": "SSB", "submode": "LSB" },
+        { "name": "FM", "mhz": [144300, 148000], "mode": "FM" }
+      ]
+    }
+  }
+}

package/src/lib/modes.js

@@ -1,3 +1,5 @@
+import BandPlans from '../data/bandPlans.json'
+
 export const SUPER_MODES = [
   'CW',
   'PHONE',
@@ -144,3 +146,35 @@ export function superModeForMode(mode) {
     return 'DATA'
   }
 }
+
+const AllSegments = Object.keys(BandPlans.bands).reduce((segments, band) => {
+  return segments.concat(
+    BandPlans.bands[band].segments.map(segment => (
+      {
+        ...segment,
+        band,
+        width: segment.mhz[1] - segment.mhz[0],
+        regions: (segment.regions || []).reduce((regions, region) => { regions[region] = true; return regions }, {}),
+        entities: (segment.entities || []).reduce((entities, entity) => { entities[entity] = true; return entities }, {}),
+        countries: (segment.countries || []).reduce((countries, country) => { countries[country] = true; return countries }, {}),
+      }
+    ))
+  )
+}, [])
+
+export function modeForFrequency(frequency, { region, country, entity } = {}) {
+  const segments = AllSegments.filter(segment => segment.mhz[0] <= frequency && segment.mhz[1] >= frequency)
+  const sortedSegments = segments.sort((a, b) => {
+    if (entity && !a.entities[entity] && b.entities[entity]) return 1
+    if (entity && a.entities[entity] && !b.entities[entity]) return -1
+
+    if (country && !a.countries[country] && b.countries[country]) return 1
+    if (country && a.countries[country] && !b.countries[country]) return -1
+
+    if (region && !a.regions[region] && b.regions[region]) return 1
+    if (region && a.regions[region] && !b.regions[region]) return -1
+
+    return a.width - b.width
+  })
+  return sortedSegments[0]?.mode
+}

package/src/lib/modes.spec.js

@@ -0,0 +1,14 @@
+import { modeForFrequency } from './modes'
+
+describe('modeForFrequency', () => {
+  it('should find the most common mode for a frequency', () => {
+    expect(modeForFrequency(14255)).toEqual('USB')
+    expect(modeForFrequency(14107)).toEqual('CW')
+    expect(modeForFrequency(14074)).toEqual('FT8')
+
+    expect(modeForFrequency(14140)).toEqual('CW')
+    expect(modeForFrequency(14140, { region: 2 })).toEqual('USB')
+    expect(modeForFrequency(14140, { entity: 'K' })).toEqual('CW')
+
+  })
+})