@packet-net/pdn-aprs 0.0.1

package/src/symbols-data.ts

@@ -0,0 +1,181 @@
+// Generated by scripts/generate-symbols.mjs; do not edit by hand. Every symbol the APRS symbol
+// tables define (APRS12c ch. 21, APRS-Symbols), named as packet.net's AprsSymbol.Named.cs names
+// them, with the description from the table.
+
+/** A named symbol: its table, code and description. */
+export interface NamedSymbolEntry {
+  readonly table: string;
+  readonly code: string;
+  readonly description: string;
+}
+
+/** Every named symbol. */
+export const NAMED_SYMBOLS = {
+  policeSheriff: { table: "/", code: "!", description: "Police, Sheriff" },
+  digipeater: { table: "/", code: "#", description: "Digi (green star with white center)" },
+  phone: { table: "/", code: "$", description: "Phone" },
+  dxCluster: { table: "/", code: "%", description: "DX Cluster" },
+  hfGateway: { table: "/", code: "&", description: "HF Gateway" },
+  smallAircraft: { table: "/", code: "'", description: "Small Aircraft" },
+  mobileSatelliteGroundStation: { table: "/", code: "(", description: "Mobile Satellite Ground Station" },
+  wheelchair: { table: "/", code: ")", description: "Wheelchair (handicapped)" },
+  snowmobile: { table: "/", code: "*", description: "Snowmobile" },
+  redCross: { table: "/", code: "+", description: "Red Cross" },
+  boyScouts: { table: "/", code: ",", description: "Boy Scouts" },
+  house: { table: "/", code: "-", description: "House QTH (VHF)" },
+  xMark: { table: "/", code: ".", description: "X" },
+  redDot: { table: "/", code: "/", description: "Red Dot" },
+  circle0: { table: "/", code: "0", description: "0 Circle" },
+  circle1: { table: "/", code: "1", description: "1 Circle" },
+  circle2: { table: "/", code: "2", description: "2 Circle" },
+  circle3: { table: "/", code: "3", description: "3 Circle" },
+  circle4: { table: "/", code: "4", description: "4 Circle" },
+  circle5: { table: "/", code: "5", description: "5 Circle" },
+  circle6: { table: "/", code: "6", description: "6 Circle" },
+  circle7: { table: "/", code: "7", description: "7 Circle" },
+  circle8: { table: "/", code: "8", description: "8 Circle" },
+  circle9: { table: "/", code: "9", description: "9 Circle" },
+  fire: { table: "/", code: ":", description: "Fire" },
+  campground: { table: "/", code: ";", description: "Campground (Portable ops)" },
+  motorcycle: { table: "/", code: "<", description: "Motorcycle" },
+  railroadEngine: { table: "/", code: "=", description: "Railroad Engine" },
+  car: { table: "/", code: ">", description: "Car" },
+  fileServer: { table: "/", code: "?", description: "File Server" },
+  hurricaneFuturePrediction: { table: "/", code: "@", description: "Hurricane Future Prediction" },
+  aidStation: { table: "/", code: "A", description: "Aid Station" },
+  bbs: { table: "/", code: "B", description: "BBS or PBBS" },
+  canoe: { table: "/", code: "C", description: "Canoe" },
+  eyeball: { table: "/", code: "E", description: "Eyeball (events, etc.)" },
+  farmVehicle: { table: "/", code: "F", description: "Farm Vehicle (Tractor)" },
+  gridSquare: { table: "/", code: "G", description: "Grid Square (6-character)" },
+  hotel: { table: "/", code: "H", description: "Hotel (blue bed icon)" },
+  tcpIpNetworkStation: { table: "/", code: "I", description: "TCP/IP on air network station" },
+  school: { table: "/", code: "K", description: "School" },
+  pcUser: { table: "/", code: "L", description: "PC user" },
+  macAprs: { table: "/", code: "M", description: "MacAPRS" },
+  ntsStation: { table: "/", code: "N", description: "NTS Station" },
+  balloon: { table: "/", code: "O", description: "Balloon" },
+  police: { table: "/", code: "P", description: "Police" },
+  recreationalVehicle: { table: "/", code: "R", description: "Recreational Vehicle" },
+  spaceShuttle: { table: "/", code: "S", description: "Space Shuttle" },
+  sstv: { table: "/", code: "T", description: "SSTV" },
+  bus: { table: "/", code: "U", description: "Bus" },
+  amateurTv: { table: "/", code: "V", description: "Amateur TV" },
+  nationalWeatherServiceSite: { table: "/", code: "W", description: "National Weather Service Site" },
+  helicopter: { table: "/", code: "X", description: "Helicopter" },
+  yacht: { table: "/", code: "Y", description: "Yacht (sail boat)" },
+  winAprs: { table: "/", code: "Z", description: "WinAPRS" },
+  jogger: { table: "/", code: "[", description: "Jogger, Human/person" },
+  directionFinding: { table: "/", code: "\\", description: "Triangle (DF)" },
+  postOffice: { table: "/", code: "]", description: "Mail/Post Office" },
+  largeAircraft: { table: "/", code: "^", description: "Large Aircraft" },
+  weatherStation: { table: "/", code: "_", description: "Weather Station (blue)" },
+  dishAntenna: { table: "/", code: "`", description: "Dish Antenna" },
+  ambulance: { table: "/", code: "a", description: "Ambulance" },
+  bicycle: { table: "/", code: "b", description: "Bicycle" },
+  incidentCommandPost: { table: "/", code: "c", description: "Incident Command Post" },
+  fireDepartment: { table: "/", code: "d", description: "Fire Department" },
+  horse: { table: "/", code: "e", description: "Horse (equestrian)" },
+  fireTruck: { table: "/", code: "f", description: "Fire Truck" },
+  glider: { table: "/", code: "g", description: "Glider" },
+  hospital: { table: "/", code: "h", description: "Hospital" },
+  iota: { table: "/", code: "i", description: "IOTA (Islands on the Air)" },
+  jeep: { table: "/", code: "j", description: "Jeep" },
+  truck: { table: "/", code: "k", description: "Truck" },
+  laptop: { table: "/", code: "l", description: "Laptop" },
+  micERepeater: { table: "/", code: "m", description: "Mic-E Repeater" },
+  node: { table: "/", code: "n", description: "Node (black bulls-eye)" },
+  emergencyOperationsCenter: { table: "/", code: "o", description: "Emergency Operations Center" },
+  rover: { table: "/", code: "p", description: "Rover (puppy dog)" },
+  gridSquareAbove128m: { table: "/", code: "q", description: "Grid Square shown above 128m" },
+  repeater: { table: "/", code: "r", description: "Repeater" },
+  ship: { table: "/", code: "s", description: "Ship (power boat)" },
+  truckStop: { table: "/", code: "t", description: "Truck Stop" },
+  eighteenWheeler: { table: "/", code: "u", description: "Truck (18-wheeler)" },
+  van: { table: "/", code: "v", description: "Van" },
+  waterStation: { table: "/", code: "w", description: "Water Station" },
+  xAprs: { table: "/", code: "x", description: "X-APRS (Unix)" },
+  yagiAtQth: { table: "/", code: "y", description: "Yagi at QTH" },
+  emergency: { table: "\\", code: "!", description: "Emergency" },
+  overlayDigipeater: { table: "\\", code: "#", description: "Digi (green star)" },
+  bank: { table: "\\", code: "$", description: "Bank or ATM (green box)" },
+  powerPlant: { table: "\\", code: "%", description: "Power Plant" },
+  gateway: { table: "\\", code: "&", description: "I=IGate R=RX T=1hopTX 2=2hopTX" },
+  crash: { table: "\\", code: "'", description: "Crash (& incident sites)" },
+  cloudy: { table: "\\", code: "(", description: "Cloudy" },
+  firenet: { table: "\\", code: ")", description: "Firenet MEO, MODIS Earth Obs." },
+  snow: { table: "\\", code: "*", description: "Snow" },
+  church: { table: "\\", code: "+", description: "Church" },
+  girlScouts: { table: "\\", code: ",", description: "Girl Scouts" },
+  overlayHouse: { table: "\\", code: "-", description: "House (H=HF) (O = Op Present)" },
+  ambiguous: { table: "\\", code: ".", description: "Ambiguous (Big Question Mark)" },
+  waypoint: { table: "\\", code: "/", description: "Waypoint Destination (Note 1)" },
+  overlayCircle: { table: "\\", code: "0", description: "Circle (E/I/W= IRLP/EchoLink/WIRES)" },
+  networkNode: { table: "\\", code: "8", description: "802.11 or other network node" },
+  gasStation: { table: "\\", code: "9", description: "Gas Station (blue pump)" },
+  hail: { table: "\\", code: ":", description: "Hail" },
+  park: { table: "\\", code: ";", description: "Park/Picnic Area" },
+  advisory: { table: "\\", code: "<", description: "Advisory (one WX flag)" },
+  aprstt: { table: "\\", code: "=", description: "APRStt Touchtone (DTMF Users)" },
+  overlayVehicle: { table: "\\", code: ">", description: "Cars & Vehicles" },
+  informationKiosk: { table: "\\", code: "?", description: "Information Kiosk (blue box with ?)" },
+  hurricaneTropicalStorm: { table: "\\", code: "@", description: "Hurricane/Tropical Storm" },
+  overlayBox: { table: "\\", code: "A", description: "Box: DTMF, RFID, XO" },
+  blowingSnow: { table: "\\", code: "B", description: "Blowing Snow" },
+  coastGuard: { table: "\\", code: "C", description: "Coast Guard" },
+  drizzle: { table: "\\", code: "D", description: "Drizzle" },
+  smoke: { table: "\\", code: "E", description: "Smoke (& other vis codes)" },
+  freezingRain: { table: "\\", code: "F", description: "Freezing Rain" },
+  snowShower: { table: "\\", code: "G", description: "Snow Shower" },
+  haze: { table: "\\", code: "H", description: "Haze" },
+  rainShower: { table: "\\", code: "I", description: "Rain Shower" },
+  lightning: { table: "\\", code: "J", description: "Lightning" },
+  kenwoodHt: { table: "\\", code: "K", description: "Kenwood HT (w)" },
+  lighthouse: { table: "\\", code: "L", description: "Lighthouse" },
+  mars: { table: "\\", code: "M", description: "MARS (A=Army, N=Navy, F=AF)" },
+  navigationBuoy: { table: "\\", code: "N", description: "Navigation Buoy" },
+  rocket: { table: "\\", code: "O", description: "Rocket" },
+  parking: { table: "\\", code: "P", description: "Parking" },
+  earthquake: { table: "\\", code: "Q", description: "Earthquake" },
+  restaurant: { table: "\\", code: "R", description: "Restaurant" },
+  satellite: { table: "\\", code: "S", description: "Satellite" },
+  thunderstorm: { table: "\\", code: "T", description: "Thunderstorm" },
+  sunny: { table: "\\", code: "U", description: "Sunny" },
+  vortac: { table: "\\", code: "V", description: "VORTAC Nav Aid" },
+  overlayNwsSite: { table: "\\", code: "W", description: "NWS Site" },
+  pharmacy: { table: "\\", code: "X", description: "Pharmacy Rx" },
+  overlayRadio: { table: "\\", code: "Y", description: "Radios and devices" },
+  wallCloud: { table: "\\", code: "[", description: "Wall Cloud" },
+  aircraftWithHeading: { table: "\\", code: "^", description: "Aircraft (Shows Heading)" },
+  weatherStationWithDigipeater: { table: "\\", code: "_", description: "WX Station with Digi (green)" },
+  rain: { table: "\\", code: "`", description: "Rain" },
+  overlayDiamond: { table: "\\", code: "a", description: "ARRL, ARES, WinLINK, Dstar, LoRa, etc" },
+  blowingDust: { table: "\\", code: "b", description: "Blowing Dust/Sand" },
+  overlayCivilDefense: { table: "\\", code: "c", description: "CD triangle RACES/SATERN/etc" },
+  dxSpot: { table: "\\", code: "d", description: "DX Spot (from callsign prefix)" },
+  sleet: { table: "\\", code: "e", description: "Sleet" },
+  funnelCloud: { table: "\\", code: "f", description: "Funnel Cloud" },
+  galeFlags: { table: "\\", code: "g", description: "Gale Flags" },
+  store: { table: "\\", code: "h", description: "Store or Hamfest" },
+  pointOfInterest: { table: "\\", code: "i", description: "BOX or points of Interest" },
+  workZone: { table: "\\", code: "j", description: "Work Zone (steam shovel)" },
+  specialVehicle: { table: "\\", code: "k", description: "Special Vehicle SUV, ATV, 4x4" },
+  area: { table: "\\", code: "l", description: "Area Symbols (box, circle, etc)" },
+  valueSign: { table: "\\", code: "m", description: "Value Sign (3 digit display)" },
+  triangle: { table: "\\", code: "n", description: "Triangle" },
+  smallCircle: { table: "\\", code: "o", description: "Small Circle" },
+  partlyCloudy: { table: "\\", code: "p", description: "Partly Cloudy" },
+  restrooms: { table: "\\", code: "r", description: "Restrooms" },
+  overlayShip: { table: "\\", code: "s", description: "Ship/Boat (top view)" },
+  tornado: { table: "\\", code: "t", description: "Tornado" },
+  overlayTruck: { table: "\\", code: "u", description: "Truck" },
+  overlayVan: { table: "\\", code: "v", description: "Van" },
+  flooding: { table: "\\", code: "w", description: "Flooding (Avalanches/Slides)" },
+  wreck: { table: "\\", code: "x", description: "Wreck or Obstruction" },
+  skywarn: { table: "\\", code: "y", description: "Skywarn" },
+  shelter: { table: "\\", code: "z", description: "Overlayed Shelter" },
+  fog: { table: "\\", code: "{", description: "Fog" },
+} as const satisfies Record<string, NamedSymbolEntry>;
+
+/** Alternate-table symbol codes that take an overlay character (marked # in APRS-Symbols). */
+export const OVERLAY_CODES = "!#$%&'(-08;<=>ADHMRWY[\\^_achiknsuvwz";

package/src/symbols.ts

@@ -0,0 +1,85 @@
+// Symbols by name, and overlays. `Symbols.car` is `/>`; `withOverlay(Symbols.gateway, 'I')` is an
+// IGate (`I&`).
+
+import { NAMED_SYMBOLS, OVERLAY_CODES } from './symbols-data.js';
+import type { AprsSymbol } from './types.js';
+
+/** The name of every symbol the APRS symbol tables define. */
+export type SymbolName = keyof typeof NAMED_SYMBOLS;
+
+function freeze(table: string, code: string): AprsSymbol {
+  return Object.freeze({ table, code });
+}
+
+/**
+ * Every symbol the APRS symbol tables define (APRS12c ch. 21), by name: `Symbols.car`,
+ * `Symbols.house`, `Symbols.weatherStation`, `Symbols.digipeater`, ...
+ */
+export const Symbols: { readonly [K in SymbolName]: AprsSymbol } = Object.freeze(
+  Object.fromEntries(Object.entries(NAMED_SYMBOLS).map(([name, s]) => [name, freeze(s.table, s.code)])),
+) as { readonly [K in SymbolName]: AprsSymbol };
+
+const byText = new Map<string, SymbolName>();
+for (const [name, s] of Object.entries(NAMED_SYMBOLS)) byText.set(s.table + s.code, name as SymbolName);
+
+function isOverlayChar(c: string): boolean {
+  return c.length === 1 && ((c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z'));
+}
+
+/** A symbol from its two characters, table then code: `symbolOf('/>')`. */
+export function symbolOf(text: string): AprsSymbol {
+  if (text.length !== 2) throw new RangeError('a symbol is two characters: the table (or overlay), then the code');
+  return freeze(text[0]!, text[1]!);
+}
+
+/** A symbol's two characters, table then code. */
+export function symbolText(symbol: AprsSymbol): string {
+  return symbol.table + symbol.code;
+}
+
+/** The overlay character on a symbol, if it has one (a table of `0`-`9` or `A`-`Z`). */
+export function overlayOf(symbol: AprsSymbol): string | undefined {
+  return isOverlayChar(symbol.table) ? symbol.table : undefined;
+}
+
+/** A symbol without its overlay: an overlaid symbol is an alternate-table (`\`) symbol. */
+export function withoutOverlay(symbol: AprsSymbol): AprsSymbol {
+  return isOverlayChar(symbol.table) ? freeze('\\', symbol.code) : symbol;
+}
+
+/** Whether the symbol tables mark this alternate-table symbol as taking an overlay. */
+export function acceptsOverlay(symbol: AprsSymbol): boolean {
+  const base = withoutOverlay(symbol);
+  return base.table === '\\' && OVERLAY_CODES.includes(base.code);
+}
+
+/**
+ * An alternate-table symbol with an overlay character (`0`-`9` or `A`-`Z`):
+ * `withOverlay(Symbols.gateway, 'I')` is `I&`. Throws for a primary-table symbol, an overlay
+ * character that is not a digit or capital letter, or a symbol the tables do not mark as taking
+ * an overlay.
+ */
+export function withOverlay(symbol: AprsSymbol, overlay: string): AprsSymbol {
+  if (!isOverlayChar(overlay)) throw new RangeError('an overlay is one digit or capital letter');
+  const base = withoutOverlay(symbol);
+  if (base.table !== '\\') throw new RangeError('only alternate-table (\\) symbols take an overlay');
+  if (!OVERLAY_CODES.includes(base.code)) throw new RangeError(`the symbol tables do not mark \\${base.code} as taking an overlay`);
+  return freeze(overlay, base.code);
+}
+
+/** A symbol's name, e.g. `car`; an overlaid symbol has its alternate-table symbol's name. */
+export function symbolName(symbol: AprsSymbol): SymbolName | undefined {
+  const base = withoutOverlay(symbol);
+  return byText.get(base.table + base.code);
+}
+
+/** What a symbol shows, from the symbol table, e.g. `Car`. */
+export function describeSymbol(symbol: AprsSymbol): string | undefined {
+  const name = symbolName(symbol);
+  return name === undefined ? undefined : NAMED_SYMBOLS[name].description;
+}
+
+/** Whether two symbols are the same. */
+export function sameSymbol(a: AprsSymbol, b: AprsSymbol): boolean {
+  return a.table === b.table && a.code === b.code;
+}