hamlib 0.1.6 → 0.1.7

package/Readme.md

@@ -1,593 +0,0 @@
-# node-hamlib
-
-A comprehensive Node.js wrapper for [Hamlib](https://hamlib.github.io/) - control amateur radio transceivers from JavaScript/TypeScript.
-
-## 🚀 Features
-
-- **Async/Await Support**: All operations are asynchronous and non-blocking for optimal performance
-- **Built-in Methods**: Complete radio control API including memory channels, RIT/XIT, scanning, levels, functions, and more
-- **303+ Supported Radios**: Works with Yaesu, Icom, Kenwood, Elecraft, FlexRadio, and many more
-- **Multi-platform**: Pre-built binaries for Windows x64, Linux x64/ARM64, macOS ARM64
-- **Connection Types**: Serial ports, network (rigctld), and direct control
-- **TypeScript Support**: Full type definitions and IntelliSense
-- **Modern JavaScript**: CommonJS and ES Modules support
-
-## ⚡ Async Operations
-
-**All radio control operations are asynchronous** to prevent blocking the Node.js event loop during I/O operations:
-
-```javascript
-// ✅ Correct - Using async/await
-await rig.setFrequency(144390000);
-const frequency = await rig.getFrequency();
-
-// ✅ Correct - Using Promises
-rig.setFrequency(144390000)
-  .then(() => rig.getFrequency())
-  .then(freq => console.log('Frequency:', freq))
-  .catch(err => console.error('Error:', err));
-
-// ❌ Incorrect - Operations are no longer synchronous
-// rig.setFrequency(144390000); // This won't work as expected
-```
-
-## 📦 Quick Start
-
-```bash
-npm install node-hamlib
-```
-
-```javascript
-const { HamLib } = require('node-hamlib');
-
-async function controlRadio() {
-  // Find your radio model
-  const rigs = HamLib.getSupportedRigs();
-  console.log('Supported radios:', rigs.length);
-
-  // Connect to radio
-  const rig = new HamLib(1035, '/dev/ttyUSB0'); // FT-991A
-  await rig.open();
-
-  // Basic control
-  await rig.setFrequency(144390000); // 144.39 MHz
-  await rig.setMode('FM');
-  await rig.setPtt(true);
-
-  // Get status
-  console.log('Frequency:', await rig.getFrequency());
-  console.log('Mode:', await rig.getMode());
-  console.log('Signal:', await rig.getStrength());
-
-  await rig.close();
-}
-
-controlRadio().catch(console.error);
-```
-
-## 📡 Complete API Reference
-
-### 🔍 Radio Discovery
-
-#### `HamLib.getSupportedRigs()`
-Get all supported radio models
-```javascript
-const rigs = HamLib.getSupportedRigs();
-console.log(`Found ${rigs.length} supported radios`);
-
-// Find your radio
-const yaesu = rigs.filter(r => r.mfgName === 'Yaesu');
-const ft991a = rigs.find(r => r.modelName === 'FT-991A');
-console.log('FT-991A Model ID:', ft991a.rigModel);
-```
-
-### 🔌 Connection Management
-
-#### `new HamLib(model, port)`
-Create radio instance
-```javascript
-// Serial connection
-const rig = new HamLib(1035, '/dev/ttyUSB0');        // Linux
-const rig = new HamLib(1035, '/dev/cu.usbserial-1420'); // macOS  
-const rig = new HamLib(1035, 'COM3');                // Windows
-
-// Network connection
-const rig = new HamLib(1035, 'localhost:4532');      // rigctld
-```
-
-#### `open()` / `close()` / `destroy()`
-Connection control
-```javascript
-await rig.open();        // Open connection
-await rig.close();       // Close (can reopen)
-await rig.destroy();     // Destroy permanently
-```
-
-#### `getConnectionInfo()`
-Get connection details
-```javascript
-const info = rig.getConnectionInfo();
-console.log('Connection type:', info.connectionType);
-console.log('Port:', info.port);
-console.log('Status:', info.status);
-```
-
-### 📻 Basic Radio Control
-
-#### Frequency Control
-```javascript
-// Set frequency (Hz)
-await rig.setFrequency(144390000);
-await rig.setFrequency(144390000, 'VFO-A');
-
-// Get frequency
-const freq = await rig.getFrequency();
-const freqA = await rig.getFrequency('VFO-A');
-```
-
-#### Mode Control
-```javascript
-// Set mode
-await rig.setMode('FM');
-await rig.setMode('USB', 'wide');
-
-// Get mode
-const mode = await rig.getMode();
-console.log('Mode:', mode.mode);
-console.log('Bandwidth:', mode.bandwidth);
-```
-
-#### VFO Control
-```javascript
-// Set VFO
-await rig.setVfo('VFO-A');
-await rig.setVfo('VFO-B');
-
-// Get current VFO
-const vfo = await rig.getVfo();
-```
-
-#### PTT Control
-```javascript
-await rig.setPtt(true);   // Transmit
-await rig.setPtt(false);  // Receive
-```
-
-#### Signal Monitoring
-```javascript
-const strength = await rig.getStrength();
-console.log('Signal strength:', strength);
-```
-
-### 💾 Memory Channel Management
-
-#### `setMemoryChannel(channel, data)`
-Store memory channel
-```javascript
-rig.setMemoryChannel(1, {
-  frequency: 144390000,
-  mode: 'FM',
-  description: 'Local Repeater'
-});
-```
-
-#### `getMemoryChannel(channel, readOnly)`
-Retrieve memory channel
-```javascript
-const channel = rig.getMemoryChannel(1);
-console.log('Channel 1:', channel);
-```
-
-#### `selectMemoryChannel(channel)`
-Select memory channel
-```javascript
-rig.selectMemoryChannel(1);
-```
-
-### 🎛️ RIT/XIT Control
-
-#### RIT (Receiver Incremental Tuning)
-```javascript
-rig.setRit(100);        // +100 Hz offset
-const rit = rig.getRit();
-```
-
-#### XIT (Transmitter Incremental Tuning)
-```javascript
-rig.setXit(-50);        // -50 Hz offset
-const xit = rig.getXit();
-```
-
-#### Clear RIT/XIT
-```javascript
-rig.clearRitXit();      // Clear both offsets
-```
-
-### 🔍 Scanning Operations
-
-#### `startScan(type, channel)`
-Start scanning
-```javascript
-rig.startScan('VFO');     // VFO scan
-rig.startScan('MEM');     // Memory scan
-rig.startScan('PROG');    // Program scan
-```
-
-#### `stopScan()`
-Stop scanning
-```javascript
-rig.stopScan();
-```
-
-### 🎚️ Level Controls
-
-#### `getSupportedLevels()`
-Get available level controls
-```javascript
-const levels = rig.getSupportedLevels();
-console.log('Available levels:', levels);
-// ['AF', 'RF', 'SQL', 'RFPOWER', 'MICGAIN', ...]
-```
-
-#### `setLevel(type, value)` / `getLevel(type)`
-Control audio and RF levels
-```javascript
-rig.setLevel('AF', 0.7);          // Audio gain 70%
-rig.setLevel('RF', 0.5);          // RF gain 50%
-rig.setLevel('SQL', 0.3);         // Squelch 30%
-rig.setLevel('RFPOWER', 0.5);     // TX power 50%
-rig.setLevel('MICGAIN', 0.8);     // Mic gain 80%
-
-// Get levels
-const audioGain = rig.getLevel('AF');
-const rfGain = rig.getLevel('RF');
-```
-
-### 🔧 Function Controls
-
-#### `getSupportedFunctions()`
-Get available function controls
-```javascript
-const functions = rig.getSupportedFunctions();
-console.log('Available functions:', functions);
-// ['NB', 'COMP', 'VOX', 'TONE', 'TSQL', 'TUNER', ...]
-```
-
-#### `setFunction(type, enable)` / `getFunction(type)`
-Control radio functions
-```javascript
-rig.setFunction('NB', true);      // Enable noise blanker
-rig.setFunction('COMP', true);    // Enable compressor
-rig.setFunction('VOX', true);     // Enable VOX
-rig.setFunction('TUNER', true);   // Enable auto tuner
-
-// Get function status
-const nbEnabled = rig.getFunction('NB');
-const compEnabled = rig.getFunction('COMP');
-```
-
-### 📡 Split Operations
-
-#### Split Frequency
-```javascript
-rig.setSplitFreq(144340000);      // TX frequency
-const txFreq = rig.getSplitFreq();
-```
-
-#### Split Mode
-```javascript
-rig.setSplitMode('FM', 'wide');   // TX mode
-const txMode = rig.getSplitMode();
-```
-
-#### Split Control
-```javascript
-rig.setSplit(true, 'VFO-B');      // Enable split
-const splitStatus = rig.getSplit();
-```
-
-### 📻 VFO Operations
-
-#### `vfoOperation(operation)`
-VFO operations
-```javascript
-rig.vfoOperation('CPY');      // Copy VFO A to B
-rig.vfoOperation('XCHG');     // Exchange VFO A and B
-rig.vfoOperation('UP');       // Frequency up
-rig.vfoOperation('DOWN');     // Frequency down
-rig.vfoOperation('TOGGLE');   // Toggle VFO A/B
-```
-
-### 📶 Antenna Selection
-
-#### `setAntenna(antenna)` / `getAntenna()`
-Antenna control
-```javascript
-rig.setAntenna(1);            // Select antenna 1
-rig.setAntenna(2);            // Select antenna 2
-const antenna = rig.getAntenna();
-```
-
-### ⚙️ Serial Port Configuration
-
-#### `getSupportedSerialConfigs()`
-Get available serial configuration options
-```javascript
-const configs = rig.getSupportedSerialConfigs();
-console.log('Data bits:', configs.serial.data_bits);     // ['5', '6', '7', '8']
-console.log('Stop bits:', configs.serial.stop_bits);     // ['1', '2']
-console.log('Parity:', configs.serial.serial_parity);    // ['None', 'Even', 'Odd']
-console.log('Handshake:', configs.serial.serial_handshake); // ['None', 'Hardware', 'Software']
-console.log('PTT types:', configs.ptt_type);             // ['RIG', 'DTR', 'RTS', 'PARALLEL', ...]
-console.log('DCD types:', configs.dcd_type);             // ['RIG', 'DSR', 'CTS', 'CD', ...]
-```
-
-#### `setSerialConfig(param, value)` / `getSerialConfig(param)`
-Configure serial port parameters
-```javascript
-// Basic serial configuration (most common)
-rig.setSerialConfig('data_bits', '8');        // 8 data bits
-rig.setSerialConfig('stop_bits', '1');        // 1 stop bit
-rig.setSerialConfig('serial_parity', 'None'); // No parity
-rig.setSerialConfig('serial_handshake', 'None'); // No flow control
-
-// Hardware flow control (if supported)
-rig.setSerialConfig('serial_handshake', 'Hardware');
-
-// Control line states
-rig.setSerialConfig('rts_state', 'ON');       // Set RTS high
-rig.setSerialConfig('dtr_state', 'OFF');      // Set DTR low
-
-// Get current configuration
-const dataBits = rig.getSerialConfig('data_bits');
-const parity = rig.getSerialConfig('serial_parity');
-```
-
-#### `setPttType(type)` / `getPttType()`
-Configure PTT (Push-to-Talk) method
-```javascript
-// Use CAT command for PTT (recommended)
-rig.setPttType('RIG');
-
-// Use DTR line for PTT (legacy interfaces)
-rig.setPttType('DTR');
-
-// Use RTS line for PTT (alternative)
-rig.setPttType('RTS');
-
-// Disable PTT control
-rig.setPttType('NONE');
-
-// Get current PTT type
-const pttType = rig.getPttType();
-console.log('PTT method:', pttType);
-```
-
-#### `setDcdType(type)` / `getDcdType()`
-Configure DCD (Data Carrier Detect) method
-```javascript
-// Use CAT command for DCD (software squelch)
-rig.setDcdType('RIG');
-
-// Use DSR line for DCD (hardware squelch)
-rig.setDcdType('DSR');
-
-// Use CTS line for DCD (alternative)
-rig.setDcdType('CTS');
-
-// Get current DCD type
-const dcdType = rig.getDcdType();
-console.log('DCD method:', dcdType);
-```
-
-#### Common Serial Configurations
-
-**Yaesu Radios:**
-```javascript
-rig.setSerialConfig('data_bits', '8');
-rig.setSerialConfig('stop_bits', '1');
-rig.setSerialConfig('serial_parity', 'None');
-rig.setSerialConfig('serial_handshake', 'None');
-rig.setPttType('RIG');  // Use CAT command
-// Baud rate: 4800/9600 (set in constructor)
-```
-
-**Kenwood Radios:**
-```javascript
-rig.setSerialConfig('data_bits', '8');
-rig.setSerialConfig('stop_bits', '2');        // Note: 2 stop bits
-rig.setSerialConfig('serial_parity', 'None');
-rig.setSerialConfig('serial_handshake', 'None');
-rig.setPttType('RIG');
-// Baud rate: 9600
-```
-
-**Legacy Interface (DTR/RTS PTT):**
-```javascript
-rig.setSerialConfig('data_bits', '8');
-rig.setSerialConfig('stop_bits', '1');
-rig.setSerialConfig('serial_parity', 'None');
-rig.setPttType('DTR');                        // Use DTR for PTT
-rig.setDcdType('DSR');                        // Use DSR for squelch
-```
-
-## 🎯 Complete Example
-
-```javascript
-const { HamLib } = require('node-hamlib');
-
-async function radioControl() {
-  // Find radios
-  const rigs = HamLib.getSupportedRigs();
-  const ft991a = rigs.find(r => r.modelName === 'FT-991A');
-  
-  if (!ft991a) {
-    console.log('FT-991A not found');
-    return;
-  }
-  
-  // Connect
-  const rig = new HamLib(ft991a.rigModel, '/dev/ttyUSB0');
-  
-  try {
-    await rig.open();
-    console.log('Connected to', rig.getConnectionInfo().port);
-    
-    // Set up radio
-    await rig.setFrequency(144390000);
-    await rig.setMode('FM');
-    await rig.setLevel('RFPOWER', 0.5);
-    await rig.setFunction('NB', true);
-    
-    // Store memory channel
-    await rig.setMemoryChannel(1, {
-      frequency: 144390000,
-      mode: 'FM',
-      description: 'Local Repeater'
-    });
-    
-    // Monitor signal
-    const monitorInterval = setInterval(async () => {
-      try {
-        const freq = await rig.getFrequency();
-        const mode = await rig.getMode();
-        const strength = await rig.getStrength();
-        
-        console.log(`${freq/1000000} MHz ${mode.mode} S:${strength}`);
-      } catch (err) {
-        console.error('Monitor error:', err.message);
-      }
-    }, 1000);
-    
-    // Stop monitoring after 30 seconds
-    setTimeout(() => {
-      clearInterval(monitorInterval);
-    }, 30000);
-    
-  } catch (error) {
-    console.error('Error:', error.message);
-  } finally {
-    await rig.close();
-  }
-}
-
-radioControl().catch(console.error);
-```
-
-## 📋 Supported Radios
-
-This library supports **303+ radio models** from major manufacturers:
-
-| Manufacturer | Models | Popular Radios |
-|--------------|--------|----------------|
-| **Yaesu** | 46 | FT-991A, FT-891, FT-857D, FT-817ND |
-| **Icom** | 83 | IC-7300, IC-9700, IC-705, IC-7610 |
-| **Kenwood** | 35 | TS-2000, TS-590SG, TS-890S, TH-D74 |
-| **Elecraft** | 7 | K3, K4, KX3, KX2 |
-| **FlexRadio** | 10 | 6300, 6400, 6500, 6600, 6700 |
-| **Others** | 122 | AOR, JRC, Ten-Tec, Winradio, etc. |
-
-### Finding Your Radio
-```javascript
-const rigs = HamLib.getSupportedRigs();
-
-// Search by manufacturer
-const yaesu = rigs.filter(r => r.mfgName === 'Yaesu');
-
-// Search by model name
-const ft991a = rigs.find(r => r.modelName.includes('FT-991A'));
-
-// List all radios
-rigs.forEach(rig => {
-  console.log(`${rig.rigModel}: ${rig.mfgName} ${rig.modelName}`);
-});
-```
-
-## 🛠️ Installation & Setup
-
-### System Requirements
-- Node.js 12.0.0 or higher
-- Supported platforms: Windows x64, Linux x64/ARM64, macOS ARM64
-
-### Install Dependencies (if building from source)
-```bash
-# Ubuntu/Debian
-sudo apt-get install libhamlib-dev
-
-# macOS
-brew install hamlib
-
-# Windows
-vcpkg install hamlib:x64-windows
-```
-
-### Building from Source
-```bash
-npm install
-npm run build
-```
-
-### Testing
-```bash
-npm test
-```
-
-## 🔧 Connection Types
-
-### Serial Connection
-```javascript
-// Linux
-const rig = new HamLib(1035, '/dev/ttyUSB0');
-
-// macOS
-const rig = new HamLib(1035, '/dev/cu.usbserial-1420');
-
-// Windows
-const rig = new HamLib(1035, 'COM3');
-```
-
-### Network Connection (rigctld)
-```javascript
-const rig = new HamLib(1035, 'localhost:4532');
-```
-
-Start rigctld:
-```bash
-rigctld -m 1035 -r /dev/ttyUSB0 -t 4532
-```
-
-## 🐛 Troubleshooting
-
-### Permission Issues (Linux)
-```bash
-sudo usermod -a -G dialout $USER
-# Log out and back in
-```
-
-### Finding Serial Ports
-```bash
-# Linux
-ls /dev/tty*
-
-# macOS
-ls /dev/cu.*
-
-# Windows
-# Use Device Manager
-```
-
-### Testing Connection
-```bash
-# Test with rigctl
-rigctl -m 1035 -r /dev/ttyUSB0 f
-```
-
-## 📄 License
-
-LGPL - see [COPYING](COPYING) file for details.
-
-## 🔗 Links
-
-- [Hamlib Project](https://hamlib.github.io/)
-- [Supported Radios](https://github.com/Hamlib/Hamlib/wiki/Supported-Radios)
-- [rigctl Documentation](https://hamlib.github.io/manpages/rigctl.html)