hamlib 0.1.8 → 0.1.9

package/README.md

@@ -13,10 +13,27 @@ Control amateur radio transceivers from Node.js using the [Hamlib](https://hamli
 
 ## Installation
 
+### Option 1: NPM Installation (Recommended)
 ```bash
-npm install hamlib
+npm install node-hamlib
 ```
 
+The package will automatically use precompiled binaries if available for your platform, otherwise it will build from source.
+
+### Option 2: Manual Prebuilds Installation
+
+For faster installation or offline environments, you can manually install precompiled binaries:
+
+1. **Download Prebuilds**: Go to [Releases](../../releases) and download `node-hamlib-prebuilds.zip`
+2. **Extract**: Unzip to your project's `node_modules/node-hamlib/prebuilds/` directory
+3. **Install**: Run `npm install node-hamlib --ignore-scripts`
+
+**Supported Prebuilt Platforms:**
+- ✅ Linux x64
+- ✅ Linux ARM64
+- ✅ macOS ARM64 (Apple Silicon)
+- ✅ Windows x64
+
 ## Quick Start
 
 ```javascript
@@ -158,21 +175,29 @@ const offset = await rig.getRepeaterOffset();
 
 Node-hamlib provides **comprehensive serial port configuration** with **13 parameters** covering all aspects of serial communication from basic data format to advanced timing control and device-specific features.
 
+**Important**: Serial configuration must be done **before** calling `rig.open()`.
+
 ```javascript
-// Configure serial parameters
+// Create rig instance
+const rig = new HamLib(1035, '/dev/ttyUSB0');
+
+// Configure serial parameters BEFORE opening connection
 await rig.setSerialConfig('rate', '115200');           // Baud rate: 150 to 4000000 bps
 await rig.setSerialConfig('data_bits', '8');           // Data bits: 5, 6, 7, 8
 await rig.setSerialConfig('serial_parity', 'None');    // Parity: None, Even, Odd, Mark, Space
 await rig.setSerialConfig('timeout', '1000');          // Timeout in milliseconds
 await rig.setSerialConfig('write_delay', '10');        // Inter-byte delay (ms)
 
-// Read current settings
-const rate = await rig.getSerialConfig('rate');
-const parity = await rig.getSerialConfig('serial_parity');
-
-// PTT/DCD configuration
+// PTT/DCD configuration (also before opening)
 await rig.setPttType('DTR');                           // PTT: RIG, DTR, RTS, NONE, etc.
 await rig.setDcdType('RIG');                           // DCD: RIG, DSR, CTS, NONE, etc.
+
+// Now open the connection with configured settings
+await rig.open();
+
+// Read current settings (can be done anytime)
+const rate = await rig.getSerialConfig('rate');
+const parity = await rig.getSerialConfig('serial_parity');
 ```
 
 #### Complete Serial Configuration Reference

package/lib/index.js

@@ -418,6 +418,10 @@ class HamLib {
 
   /**
    * Set serial port configuration parameter
+   * 
+   * **IMPORTANT: Must be called BEFORE rig.open()**
+   * Serial configuration cannot be changed after connection is established.
+   * 
    * @param {string} paramName - Parameter name: 
    *   - Serial settings: 'data_bits', 'stop_bits', 'serial_parity', 'serial_handshake'
    *   - Control signals: 'rts_state', 'dtr_state'
@@ -426,27 +430,16 @@ class HamLib {
    *   - Advanced: 'flushx'
    * @param {string} paramValue - Parameter value
    * @example
-   * // Basic serial settings
-   * hamlib.setSerialConfig('data_bits', '8');
-   * hamlib.setSerialConfig('stop_bits', '1');
-   * hamlib.setSerialConfig('serial_parity', 'Even');
-   * hamlib.setSerialConfig('serial_handshake', 'Hardware');
+   * // Configure serial settings BEFORE opening connection
+   * const rig = new HamLib(1035, '/dev/ttyUSB0');
    * 
-   * // Control signals
-   * hamlib.setSerialConfig('rts_state', 'ON');
-   * hamlib.setSerialConfig('dtr_state', 'OFF');
-   * 
-   * // Communication settings
-   * hamlib.setSerialConfig('rate', '115200');
-   * hamlib.setSerialConfig('timeout', '1000');
-   * hamlib.setSerialConfig('retry', '3');
-   * 
-   * // Timing control
-   * hamlib.setSerialConfig('write_delay', '10');
-   * hamlib.setSerialConfig('post_write_delay', '50');
+   * // Basic serial settings
+   * await rig.setSerialConfig('data_bits', '8');
+   * await rig.setSerialConfig('rate', '115200');
+   * await rig.setSerialConfig('serial_parity', 'None');
    * 
-   * // Advanced features
-   * hamlib.setSerialConfig('flushx', 'true');
+   * // Now open with configured settings
+   * await rig.open();
    */
   async setSerialConfig(paramName, paramValue) {
     return this._nativeInstance.setSerialConfig(paramName, paramValue);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hamlib",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "Node.js wrapper for hamlib radio control library",
   "main": "index.js",
   "module": "lib/index.mjs",

package/src/hamlib.cpp

@@ -3479,11 +3479,6 @@ Napi::Value NodeHamLib::GetSupportedRigs(const Napi::CallbackInfo& info) {
 Napi::Value NodeHamLib::SetSerialConfig(const Napi::CallbackInfo& info) {
   Napi::Env env = info.Env();
   
-  if (!rig_is_open) {
-    Napi::TypeError::New(env, "Rig is not open!").ThrowAsJavaScriptException();
-    return env.Null();
-  }
-  
   if (info.Length() < 2 || !info[0].IsString() || !info[1].IsString()) {
     Napi::TypeError::New(env, "Expected parameter name and value as strings").ThrowAsJavaScriptException();
     return env.Null();
@@ -3501,11 +3496,6 @@ Napi::Value NodeHamLib::SetSerialConfig(const Napi::CallbackInfo& info) {
 Napi::Value NodeHamLib::GetSerialConfig(const Napi::CallbackInfo& info) {
   Napi::Env env = info.Env();
   
-  if (!rig_is_open) {
-    Napi::TypeError::New(env, "Rig is not open!").ThrowAsJavaScriptException();
-    return env.Null();
-  }
-  
   if (info.Length() < 1 || !info[0].IsString()) {
     Napi::TypeError::New(env, "Expected parameter name as string").ThrowAsJavaScriptException();
     return env.Null();