wsjtx-lib 1.0.2 → 1.0.4

package/dist/types.d.ts

@@ -0,0 +1,252 @@
+/**
+ * WSJTX Digital Radio Protocol Library for Node.js
+ *
+ * This library provides encoding and decoding capabilities for various
+ * digital amateur radio protocols including FT8, FT4, WSPR, and others.
+ *
+ * The library is a Node.js C++ extension that wraps the wsjtx_lib C library,
+ * providing high-performance digital signal processing capabilities with
+ * multi-platform support (Windows, macOS, Linux).
+ *
+ * @version 1.0.0
+ * @author WSJTX Development Team
+ * @license GPL-3.0
+ */
+/**
+ * Supported WSJTX digital radio modes
+ *
+ * Each mode has different characteristics in terms of symbol rate,
+ * bandwidth, transmission duration, and sensitivity.
+ */
+declare enum WSJTXMode {
+    /**
+     * FT8 - 8-FSK modulation, 15-second transmissions
+     * - Sample rate: 48 kHz
+     * - Duration: 12.64 seconds
+     * - Bandwidth: ~50 Hz
+     * - Sensitivity: -24 dB
+     */
+    FT8 = 0,
+    /**
+     * FT4 - 4-FSK modulation, 6-second transmissions
+     * - Sample rate: 48 kHz
+     * - Duration: 6.0 seconds
+     * - Bandwidth: ~80 Hz
+     * - Sensitivity: -17 dB
+     */
+    FT4 = 1,
+    /**
+     * JT4 - Weak signal mode for microwave EME
+     * - Sample rate: 11.025 kHz
+     * - Duration: 47.1 seconds
+     * - Multiple bandwidth options
+     */
+    JT4 = 2,
+    /**
+     * JT65 - Popular EME and HF weak signal mode
+     * - Sample rate: 11.025 kHz
+     * - Duration: 46.8 seconds
+     * - Bandwidth: ~180 Hz
+     */
+    JT65 = 3,
+    /**
+     * JT9 - Low data rate, narrow bandwidth mode
+     * - Sample rate: 12 kHz
+     * - Duration: 49.0 seconds
+     * - Bandwidth: ~16 Hz
+     */
+    JT9 = 4,
+    /**
+     * FST4 - Flexible format for 15-900 second transmissions
+     * - Sample rate: 12 kHz
+     * - Variable duration (15s, 30s, 60s, 120s, 300s, 900s)
+     * - Ultra-weak signal capability
+     */
+    FST4 = 5,
+    /**
+     * Q65 - Optimized for EME on VHF and higher
+     * - Sample rate: 12 kHz
+     * - Duration: 60 seconds
+     * - Multiple bandwidth options
+     */
+    Q65 = 6,
+    /**
+     * FST4W - Weak signal beacons
+     * - Sample rate: 12 kHz
+     * - Duration: 120 seconds
+     * - Optimized for propagation studies
+     */
+    FST4W = 7,
+    /**
+     * WSPR - Weak Signal Propagation Reporter
+     * - Sample rate: 12 kHz
+     * - Duration: 110.6 seconds
+     * - 4-FSK modulation, very weak signal capability
+     */
+    WSPR = 8
+}
+/**
+ * Audio data formats supported by the library
+ * Can be either 32-bit floating point or 16-bit signed integer samples
+ */
+type AudioData = Float32Array | Int16Array;
+/**
+ * IQ (In-phase/Quadrature) data for WSPR decoding
+ * Interleaved I,Q samples as 32-bit floating point values
+ */
+type IQData = Float32Array;
+/**
+ * Time information for decoded messages
+ */
+interface WSJTXTime {
+    /** Hour (0-23) */
+    hour: number;
+    /** Minute (0-59) */
+    minute: number;
+    /** Second (0-59) */
+    second: number;
+}
+/**
+ * A decoded WSJTX message containing timing and signal information
+ */
+interface WSJTXMessage {
+    /** The decoded message text */
+    text: string;
+    /** Signal-to-noise ratio in dB */
+    snr: number;
+    /** Time offset from start of transmission period in seconds */
+    deltaTime: number;
+    /** Frequency offset from dial frequency in Hz */
+    deltaFrequency: number;
+    /** Unix timestamp when the message was decoded */
+    timestamp: number;
+    /** Sync quality metric (mode-dependent) */
+    sync: number;
+}
+/**
+ * Result from a decode operation
+ */
+interface DecodeResult {
+    /** Whether the decode operation completed successfully */
+    success: boolean;
+    /** Optional error message if decode failed */
+    error?: string;
+}
+/**
+ * Result from an encode operation
+ */
+interface EncodeResult {
+    /** Generated audio waveform data */
+    audioData: Float32Array;
+    /** The actual message that was encoded (may differ from input) */
+    messageSent: string;
+}
+/**
+ * Single WSPR decode result
+ */
+interface WSPRResult {
+    /** Frequency of the decoded signal in Hz */
+    frequency: number;
+    /** Sync quality metric */
+    sync: number;
+    /** Signal-to-noise ratio in dB */
+    snr: number;
+    /** Time offset in seconds */
+    deltaTime: number;
+    /** Frequency drift in Hz/minute */
+    drift: number;
+    /** Jitter metric */
+    jitter: number;
+    /** Decoded message text */
+    message: string;
+    /** Decoded callsign */
+    callsign: string;
+    /** Decoded grid locator */
+    locator: string;
+    /** Decoded power in dBm */
+    power: string;
+    /** Number of decode cycles */
+    cycles: number;
+}
+/**
+ * Options for WSPR decoding
+ */
+interface WSPRDecodeOptions {
+    /** Dial frequency in Hz (default: 14095600 for 20m WSPR) */
+    dialFrequency?: number;
+    /** Receiving station callsign for better decoding */
+    callsign?: string;
+    /** Receiving station grid locator */
+    locator?: string;
+    /** Enable quick decode mode (faster but less sensitive) */
+    quickMode?: boolean;
+    /** Use hash table for callsign/locator lookup */
+    useHashTable?: boolean;
+    /** Number of decoding passes (1-3, default: 2) */
+    passes?: number;
+    /** Enable signal subtraction for better weak signal decoding */
+    subtraction?: boolean;
+}
+/**
+ * Error thrown by WSJTX library operations
+ */
+declare class WSJTXError extends Error {
+    code?: string | undefined;
+    constructor(message: string, code?: string | undefined);
+}
+/**
+ * Configuration options for the WSJTX library
+ */
+interface WSJTXConfig {
+    /** Maximum number of threads to use for processing (1-16) */
+    maxThreads?: number;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Library version information
+ */
+interface VersionInfo {
+    /** WSJTXLib wrapper version */
+    wrapperVersion: string;
+    /** Underlying wsjtx_lib version */
+    libraryVersion: string;
+    /** Node.js version used to build */
+    nodeVersion: string;
+    /** Build timestamp */
+    buildDate: string;
+}
+/**
+ * Mode capabilities information
+ */
+interface ModeCapabilities {
+    /** Mode identifier */
+    mode: WSJTXMode;
+    /** Whether encoding is supported */
+    encodingSupported: boolean;
+    /** Whether decoding is supported */
+    decodingSupported: boolean;
+    /** Required sample rate in Hz */
+    sampleRate: number;
+    /** Transmission duration in seconds */
+    duration: number;
+    /** Typical bandwidth in Hz */
+    bandwidth?: number;
+    /** Typical sensitivity in dB */
+    sensitivity?: number;
+}
+/**
+ * Callback function for decode operations
+ * The native module returns a boolean indicating completion status
+ */
+type DecodeCallback = (error: Error | null, result: boolean) => void;
+/**
+ * Callback function type for asynchronous encode operations
+ */
+type EncodeCallback = (error: Error | null, result: EncodeResult) => void;
+/**
+ * Callback function type for asynchronous WSPR decode operations
+ */
+type WSPRDecodeCallback = (error: Error | null, results: WSPRResult[]) => void;
+
+export { type AudioData, type DecodeCallback, type DecodeResult, type EncodeCallback, type EncodeResult, type IQData, type ModeCapabilities, type VersionInfo, type WSJTXConfig, WSJTXError, type WSJTXMessage, WSJTXMode, type WSJTXTime, type WSPRDecodeCallback, type WSPRDecodeOptions, type WSPRResult };

package/dist/types.js

@@ -0,0 +1,8 @@
+import {
+  WSJTXError,
+  WSJTXMode
+} from "./chunk-IOOVX2IY.js";
+export {
+  WSJTXError,
+  WSJTXMode
+};

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["/**\n * WSJTX Digital Radio Protocol Library for Node.js\n * \n * This library provides encoding and decoding capabilities for various\n * digital amateur radio protocols including FT8, FT4, WSPR, and others.\n * \n * The library is a Node.js C++ extension that wraps the wsjtx_lib C library,\n * providing high-performance digital signal processing capabilities with\n * multi-platform support (Windows, macOS, Linux).\n * \n * @version 1.0.0\n * @author WSJTX Development Team\n * @license GPL-3.0\n */\n\n/**\n * Supported WSJTX digital radio modes\n * \n * Each mode has different characteristics in terms of symbol rate,\n * bandwidth, transmission duration, and sensitivity.\n */\nexport enum WSJTXMode {\n    /** \n     * FT8 - 8-FSK modulation, 15-second transmissions\n     * - Sample rate: 48 kHz\n     * - Duration: 12.64 seconds\n     * - Bandwidth: ~50 Hz\n     * - Sensitivity: -24 dB\n     */\n    FT8 = 0,\n\n    /** \n     * FT4 - 4-FSK modulation, 6-second transmissions\n     * - Sample rate: 48 kHz  \n     * - Duration: 6.0 seconds\n     * - Bandwidth: ~80 Hz\n     * - Sensitivity: -17 dB\n     */\n    FT4 = 1,\n\n    /** \n     * JT4 - Weak signal mode for microwave EME\n     * - Sample rate: 11.025 kHz\n     * - Duration: 47.1 seconds\n     * - Multiple bandwidth options\n     */\n    JT4 = 2,\n\n    /** \n     * JT65 - Popular EME and HF weak signal mode\n     * - Sample rate: 11.025 kHz\n     * - Duration: 46.8 seconds\n     * - Bandwidth: ~180 Hz\n     */\n    JT65 = 3,\n\n    /** \n     * JT9 - Low data rate, narrow bandwidth mode\n     * - Sample rate: 12 kHz\n     * - Duration: 49.0 seconds\n     * - Bandwidth: ~16 Hz\n     */\n    JT9 = 4,\n\n    /** \n     * FST4 - Flexible format for 15-900 second transmissions\n     * - Sample rate: 12 kHz\n     * - Variable duration (15s, 30s, 60s, 120s, 300s, 900s)\n     * - Ultra-weak signal capability\n     */\n    FST4 = 5,\n\n    /** \n     * Q65 - Optimized for EME on VHF and higher\n     * - Sample rate: 12 kHz\n     * - Duration: 60 seconds\n     * - Multiple bandwidth options\n     */\n    Q65 = 6,\n\n    /** \n     * FST4W - Weak signal beacons\n     * - Sample rate: 12 kHz\n     * - Duration: 120 seconds\n     * - Optimized for propagation studies\n     */\n    FST4W = 7,\n\n    /** \n     * WSPR - Weak Signal Propagation Reporter\n     * - Sample rate: 12 kHz\n     * - Duration: 110.6 seconds\n     * - 4-FSK modulation, very weak signal capability\n     */\n    WSPR = 8\n}\n\n/**\n * Audio data formats supported by the library\n * Can be either 32-bit floating point or 16-bit signed integer samples\n */\nexport type AudioData = Float32Array | Int16Array;\n\n/**\n * IQ (In-phase/Quadrature) data for WSPR decoding\n * Interleaved I,Q samples as 32-bit floating point values\n */\nexport type IQData = Float32Array;\n\n/**\n * Time information for decoded messages\n */\nexport interface WSJTXTime {\n    /** Hour (0-23) */\n    hour: number;\n    /** Minute (0-59) */\n    minute: number;\n    /** Second (0-59) */\n    second: number;\n}\n\n/**\n * A decoded WSJTX message containing timing and signal information\n */\nexport interface WSJTXMessage {\n    /** The decoded message text */\n    text: string;\n    /** Signal-to-noise ratio in dB */\n    snr: number;\n    /** Time offset from start of transmission period in seconds */\n    deltaTime: number;\n    /** Frequency offset from dial frequency in Hz */\n    deltaFrequency: number;\n    /** Unix timestamp when the message was decoded */\n    timestamp: number;\n    /** Sync quality metric (mode-dependent) */\n    sync: number;\n}\n\n/**\n * Result from a decode operation\n */\nexport interface DecodeResult {\n    /** Whether the decode operation completed successfully */\n    success: boolean;\n    /** Optional error message if decode failed */\n    error?: string;\n}\n\n/**\n * Result from an encode operation\n */\nexport interface EncodeResult {\n    /** Generated audio waveform data */\n    audioData: Float32Array;\n    /** The actual message that was encoded (may differ from input) */\n    messageSent: string;\n}\n\n/**\n * Single WSPR decode result\n */\nexport interface WSPRResult {\n    /** Frequency of the decoded signal in Hz */\n    frequency: number;\n    /** Sync quality metric */\n    sync: number;\n    /** Signal-to-noise ratio in dB */\n    snr: number;\n    /** Time offset in seconds */\n    deltaTime: number;\n    /** Frequency drift in Hz/minute */\n    drift: number;\n    /** Jitter metric */\n    jitter: number;\n    /** Decoded message text */\n    message: string;\n    /** Decoded callsign */\n    callsign: string;\n    /** Decoded grid locator */\n    locator: string;\n    /** Decoded power in dBm */\n    power: string;\n    /** Number of decode cycles */\n    cycles: number;\n}\n\n/**\n * Options for WSPR decoding\n */\nexport interface WSPRDecodeOptions {\n    /** Dial frequency in Hz (default: 14095600 for 20m WSPR) */\n    dialFrequency?: number;\n    /** Receiving station callsign for better decoding */\n    callsign?: string;\n    /** Receiving station grid locator */\n    locator?: string;\n    /** Enable quick decode mode (faster but less sensitive) */\n    quickMode?: boolean;\n    /** Use hash table for callsign/locator lookup */\n    useHashTable?: boolean;\n    /** Number of decoding passes (1-3, default: 2) */\n    passes?: number;\n    /** Enable signal subtraction for better weak signal decoding */\n    subtraction?: boolean;\n}\n\n/**\n * Error thrown by WSJTX library operations\n */\nexport class WSJTXError extends Error {\n    constructor(message: string, public code?: string) {\n        super(message);\n        this.name = 'WSJTXError';\n    }\n}\n\n/**\n * Configuration options for the WSJTX library\n */\nexport interface WSJTXConfig {\n    /** Maximum number of threads to use for processing (1-16) */\n    maxThreads?: number;\n    /** Enable debug logging */\n    debug?: boolean;\n}\n\n/**\n * Library version information\n */\nexport interface VersionInfo {\n    /** WSJTXLib wrapper version */\n    wrapperVersion: string;\n    /** Underlying wsjtx_lib version */\n    libraryVersion: string;\n    /** Node.js version used to build */\n    nodeVersion: string;\n    /** Build timestamp */\n    buildDate: string;\n}\n\n/**\n * Mode capabilities information\n */\nexport interface ModeCapabilities {\n    /** Mode identifier */\n    mode: WSJTXMode;\n    /** Whether encoding is supported */\n    encodingSupported: boolean;\n    /** Whether decoding is supported */\n    decodingSupported: boolean;\n    /** Required sample rate in Hz */\n    sampleRate: number;\n    /** Transmission duration in seconds */\n    duration: number;\n    /** Typical bandwidth in Hz */\n    bandwidth?: number;\n    /** Typical sensitivity in dB */\n    sensitivity?: number;\n}\n\n/**\n * Callback function for decode operations\n * The native module returns a boolean indicating completion status\n */\nexport type DecodeCallback = (error: Error | null, result: boolean) => void;\n\n/**\n * Callback function type for asynchronous encode operations\n */\nexport type EncodeCallback = (error: Error | null, result: EncodeResult) => void;\n\n/**\n * Callback function type for asynchronous WSPR decode operations\n */\nexport type WSPRDecodeCallback = (error: Error | null, results: WSPRResult[]) => void;\n  "],"mappings":";AAqBO,IAAK,YAAL,kBAAKA,eAAL;AAQH,EAAAA,sBAAA,SAAM,KAAN;AASA,EAAAA,sBAAA,SAAM,KAAN;AAQA,EAAAA,sBAAA,SAAM,KAAN;AAQA,EAAAA,sBAAA,UAAO,KAAP;AAQA,EAAAA,sBAAA,SAAM,KAAN;AAQA,EAAAA,sBAAA,UAAO,KAAP;AAQA,EAAAA,sBAAA,SAAM,KAAN;AAQA,EAAAA,sBAAA,WAAQ,KAAR;AAQA,EAAAA,sBAAA,UAAO,KAAP;AAzEQ,SAAAA;AAAA,GAAA;AA6LL,IAAM,aAAN,cAAyB,MAAM;AAAA,EAClC,YAAY,SAAwB,MAAe;AAC/C,UAAM,OAAO;AADmB;AAEhC,SAAK,OAAO;AAAA,EAChB;AACJ;","names":["WSJTXMode"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wsjtx-lib",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Node.js C++ extension for WSJTX digital radio protocol library",
   "type": "module",
   "main": "dist/src/index.js",

package/prebuilds/darwin-arm64/build-info.json

@@ -3,8 +3,8 @@
   "github_runner": "macos-latest",
   "arch": "arm64",
   "node_version": "18",
-  "build_time": "2025-06-05T11:19:15Z",
+  "build_time": "2025-10-14T08:33:24Z",
   "cmake_arch": "arm64",
-  "file_size": 984136,
+  "file_size": 919048,
   "bundled_libraries":        3
 }

package/prebuilds/linux-arm64/build-info.json

@@ -0,0 +1,10 @@
+{
+  "platform": "ubuntu-24.04-arm",
+  "github_runner": "ubuntu-24.04-arm",
+  "arch": "arm64",
+  "node_version": "18",
+  "build_time": "2025-10-14T08:33:46Z",
+  "cmake_arch": "arm64",
+  "file_size": 1022336,
+  "bundled_libraries": 0
+}

package/prebuilds/linux-x64/build-info.json

@@ -3,8 +3,8 @@
   "github_runner": "ubuntu-latest",
   "arch": "x64",
   "node_version": "18",
-  "build_time": "2025-06-05T11:19:08Z",
+  "build_time": "2025-10-14T08:35:04Z",
   "cmake_arch": "x86_64",
-  "file_size": 1110008,
+  "file_size": 1111096,
   "bundled_libraries": 0
 }

package/prebuilds/package-info.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-06-06T01:33:39.094Z",
+  "timestamp": "2025-10-14T08:48:58.839Z",
   "platforms": [
     {
       "platform": "linux",
@@ -7,6 +7,12 @@
       "available": true,
       "path": "./prebuilds/linux-x64/wsjtx_lib_nodejs.node"
     },
+    {
+      "platform": "linux",
+      "arch": "arm64",
+      "available": true,
+      "path": "./prebuilds/linux-arm64/wsjtx_lib_nodejs.node"
+    },
     {
       "platform": "darwin",
       "arch": "arm64",
@@ -20,6 +26,6 @@
       "path": "./prebuilds/win32-x64/wsjtx_lib_nodejs.node"
     }
   ],
-  "totalPackages": 3,
-  "totalSize": 3813799
+  "totalPackages": 4,
+  "totalSize": 4781357
 }

package/prebuilds/win32-x64/build-info.json

@@ -3,11 +3,11 @@
   "github_runner": "windows-latest",
   "arch": "x64",
   "node_version": "18",
-  "build_time": "2025-06-05T11:22:26Z",
+  "build_time": "2025-10-14T08:37:27Z",
   "cmake_arch": "x64",
-  "file_size": 1719655,
+  "file_size": 1728877,
   "bundled_libraries": 6,
-  "total_package_size": 12672623,
+  "total_package_size": 12767114,
   "required_dlls": ["libfftw3f-3.dll","libfftw3f_threads-3.dll","libgcc_s_seh-1.dll","libgfortran-5.dll","libwinpthread-1.dll","libstdc++-6.dll"],
   "bundled_dlls": ["libfftw3f_threads-3.dll", "libfftw3f-3.dll", "libgcc_s_seh-1.dll", "libgfortran-5.dll", "libstdc++-6.dll", "libwinpthread-1.dll"],
   "missing_dlls": ""