bluetooth-serial-port 3.0.4 → 3.0.6

package/README.md

@@ -4,7 +4,7 @@
 
 This piece of open source software is free (as in speech) to [use, modify and distribute](LICENSE.md), no strings attached. If this software saves you some cash and you want to do something for the good please consider making a donation to a [charity](https://www.doctorswithoutborders.org). Any charity will do. 🙏
 
-> MacOS support has (temporarily) been dropped as of version v3.0.0 of the module. If you use the module on a Mac please stay on v2 of this module.
+> experimental macOS support is available again. Feedback (also when it is working as expected) would be highly apreciated.
 
 > _DEPRECATED_ I am no longer actively maintaining this project. If you want to help out by adding support please contact me. It was a great experience maintaining this project for almost 8 years. It was great to see people step in to improve this project. Thank you all!
 
@@ -18,6 +18,7 @@ If you have any problems make sure to [checkout the FAQ](https://github.com/eelc
 ## New in the last releases
 
 * Installs precompiled native artifacts
+* Re-enables MacOS support
 * Bumps dependencies
 * Fixes memory leaks.
 * Adds support for node 20, 22 and 24
@@ -60,11 +61,16 @@ sudo systemctl restart bluetooth
 -   Needs Visual Studio (Visual C++) and its command line tools for source builds.
 -   Needs Python installed and accessible from the command line path.
 
+## Prerequisites on macOS
+
+-   Build prerequisites are only needed when no matching prebuilt binary is available.
+-   Install Xcode and Command Line Tools.
+
 ## Install
 
 `npm install bluetooth-serial-port`
 
-For Linux x64 and Windows x64 on Node 18, 20, 22 and 24, installation first downloads a prebuilt native binary from GitHub Releases.
+For Linux x64/arm64, Windows x64, and macOS x64/arm64 on Node 18, 20, 22 and 24, installation first downloads a prebuilt native binary from GitHub Releases.
 If a matching prebuild is unavailable, install falls back to a local `node-gyp` build.
 
 ## Test build Linux using docker

package/binding.gyp

@@ -11,6 +11,14 @@
           'libraries': ['-lbluetooth'],
           'cflags':['-std=c++11']
         }],
+        [ 'OS=="mac"', {
+          'sources': ['src/macos/DeviceINQ.mm', 'src/macos/BluetoothWorker.mm', 'src/macos/pipe.c', 'src/macos/BluetoothDeviceResources.mm', 'src/macos/BluetoothSerialPort.mm', 'src/macos/BTSerialPortBinding.mm'],
+          'include_dirs' : [ "<!(node -e \"require('nan')\")", 'src', 'src/macos' ],
+          'libraries':['-framework Foundation', '-framework IOBluetooth', '-fobjc-arc'],
+          'cflags!': [ '-fno-exceptions' ],
+          'cflags_cc!': [ '-fno-exceptions' ],
+          'xcode_settings': { 'GCC_ENABLE_CPP_EXCEPTIONS': 'YES', 'OTHER_CFLAGS': [ '-Wno-unused-function' ] }
+        }],
         [ 'OS=="win"', {
           'sources': [ 'src/windows/BluetoothSerialPort.cc', 'src/windows/DeviceINQ.cc', 'src/windows/BTSerialPortBinding.cc', 'src/windows/BluetoothHelpers.cc' ],
           'include_dirs' : [ "<!(node -e \"require('nan')\")", 'src', 'src/windows' ],
@@ -32,4 +40,3 @@
     }
   ] # end targets
 }
-

package/lib/bluetooth-serial-port.js

@@ -51,6 +51,14 @@
     };
 
     BluetoothSerialPort.prototype.inquire = function () {
+        if (process.platform === 'darwin') {
+            var self = this;
+            setImmediate(function () {
+                self.inq.inquireSync(self.found, self.finish);
+            });
+            return;
+        }
+
         this.inq.inquire(this.found, this.finish);
     };
 

package/package.json

@@ -1,12 +1,13 @@
 {
     "name": "bluetooth-serial-port",
-    "version": "3.0.4",
+    "version": "3.0.6",
     "description": "Bluetooth serial port communication for Node.js",
     "author": "Eelco Cramer <eelco@hailendal.org>",
     "keywords": [
         "bluetooth",
         "serial port",
         "rfcomm",
+        "darwin",
         "linux",
         "windows"
     ],
@@ -29,6 +30,7 @@
         "prebuilds/"
     ],
     "os": [
+        "darwin",
         "linux",
         "win32"
     ],

package/src/macos/BTSerialPortBinding.mm

@@ -216,7 +216,7 @@ void BTSerialPortBinding::Init(Local<Object> target) {
     t->InstanceTemplate()->SetInternalFieldCount(1);
     t->SetClassName(Nan::New("BTSerialPortBinding").ToLocalChecked());
 
-    Isolate *isolate = target->GetIsolate();
+    Isolate *isolate = Isolate::GetCurrent();
     Local<Context> ctx = isolate->GetCurrentContext();
 
     Nan::SetPrototypeMethod(t, "write", Write);

package/src/macos/BluetoothWorker.mm

@@ -19,6 +19,7 @@
 
 #include <v8.h>
 #include <node.h>
+#include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
 #include <unistd.h>
@@ -33,6 +34,8 @@
 using namespace node;
 using namespace v8;
 
+static const CFTimeInterval INQUIRY_TIMEOUT_SECONDS = 20.0;
+
 /** Private class for wrapping a pipe */
 @interface Pipe : NSObject {
     pipe_t *pipe;
@@ -60,6 +63,49 @@ using namespace v8;
 @synthesize address;
 @end
 
+/** Stops the current run loop when inquiry completes. */
+@interface DeviceInquiryRunLoopStopper : NSObject <IOBluetoothDeviceInquiryDelegate> {
+    @private
+    BOOL completed;
+}
+
+- (BOOL)isCompleted;
+
+@end
+
+@implementation DeviceInquiryRunLoopStopper
+
+- (id)init
+{
+    self = [super init];
+    if (self != nil) {
+        completed = NO;
+    }
+
+    return self;
+}
+
+- (BOOL)isCompleted
+{
+    return completed;
+}
+
+- (void)deviceInquiryDeviceFound:(IOBluetoothDeviceInquiry *)sender device:(IOBluetoothDevice *)device
+{
+    (void)sender;
+    (void)device;
+}
+
+- (void)deviceInquiryComplete:(IOBluetoothDeviceInquiry *)sender error:(IOReturn)error aborted:(BOOL)aborted
+{
+    (void)sender;
+    (void)error;
+    (void)aborted;
+    completed = YES;
+}
+
+@end
+
 static NSMutableDictionary *instanceWorkers = nil;
 static NSLock *globalConnectLock = nil;
 
@@ -260,21 +306,57 @@ static NSLock *globalConnectLock = nil;
 - (void) inquireWithPipe: (pipe_t *)pipe
 {
     @synchronized(self) {
-      inquiryProducer = pipe_producer_new(pipe);
-      dispatch_async(worker_queue, ^{
-          [self inquiryTask];
-      });
+        if (inquiryProducer != NULL) {
+            pipe_producer_free(inquiryProducer);
+            inquiryProducer = NULL;
+        }
+        inquiryProducer = pipe_producer_new(pipe);
+    }
+
+    if ([NSThread isMainThread]) {
+        [self inquiryTask];
+    } else {
+        dispatch_sync(worker_queue, ^{
+            [self inquiryTask];
+        });
     }
 }
 
 /** Worker task to the the inquiry */
 - (void) inquiryTask
 {
-  IOBluetoothDeviceInquiry *bdi = [IOBluetoothDeviceInquiry inquiryWithDelegate:self];
-//  bdi.inquiryLength = 30;
-  [bdi start];
-//  [NSThread sleepUntilDate: [NSDate dateWithTimeIntervalSinceNow: 31]];
-//  [bdi stop];
+    @autoreleasepool {
+        DeviceInquiryRunLoopStopper *stopper = [[DeviceInquiryRunLoopStopper alloc] init];
+        IOBluetoothDeviceInquiry *inquiry = [[IOBluetoothDeviceInquiry alloc] initWithDelegate:stopper];
+
+        if (inquiry == nil) {
+            [self completeInquiry];
+            [stopper release];
+            return;
+        }
+
+        [inquiry setInquiryLength:10];
+        IOReturn startStatus = [inquiry start];
+
+        if (startStatus == kIOReturnSuccess) {
+            NSDate *deadline = [NSDate dateWithTimeIntervalSinceNow:INQUIRY_TIMEOUT_SECONDS];
+            while (![stopper isCompleted] && [deadline timeIntervalSinceNow] > 0) {
+                [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:deadline];
+            }
+        }
+
+        [inquiry stop];
+        [inquiry setDelegate:nil];
+
+        NSArray *foundDevices = [inquiry foundDevices];
+        for (IOBluetoothDevice *device in foundDevices) {
+            [self emitInquiryDevice:device];
+        }
+
+        [self completeInquiry];
+        [inquiry release];
+        [stopper release];
+    }
 }
 
 /** Get the RFCOMM channel for a given device */
@@ -360,30 +442,48 @@ static NSLock *globalConnectLock = nil;
 
 /** Called when the device inquiry completes */
 - (void) deviceInquiryComplete: (IOBluetoothDeviceInquiry *) sender error: (IOReturn) error aborted: (BOOL) aborted
+{
+    (void)sender;
+    (void)error;
+    (void)aborted;
+    [self completeInquiry];
+}
+
+/** Called when a device has been found */
+- (void) deviceInquiryDeviceFound: (IOBluetoothDeviceInquiry*) sender device: (IOBluetoothDevice*) device
+{
+    (void)sender;
+    [self emitInquiryDevice:device];
+}
+
+- (void)completeInquiry
 {
     @synchronized(self) {
         if (inquiryProducer != NULL) {
-            // free the producer so the main thread is signaled that the inquiry has been completed.
             pipe_producer_free(inquiryProducer);
             inquiryProducer = NULL;
         }
     }
 }
 
-/** Called when a device has been found */
-- (void) deviceInquiryDeviceFound: (IOBluetoothDeviceInquiry*) sender device: (IOBluetoothDevice*) device
+- (void)emitInquiryDevice:(IOBluetoothDevice *)device
 {
     @synchronized(self) {
-        if (inquiryProducer != NULL) {
-            device_info_t *info = new device_info_t;
-            strcpy(info->address, [[device addressString] UTF8String]);
-            strcpy(info->name, [[device addressString] UTF8String]);
+        if (inquiryProducer == NULL || device == nil) {
+            return;
+        }
 
-            // push the device data into the pipe to notify the main thread
-            pipe_push(inquiryProducer, info, 1);
+        device_info_t info;
+        memset(&info, 0, sizeof(device_info_t));
 
-            delete info;
-        }
+        const char *address = [[device addressString] UTF8String];
+        const char *name = [[device nameOrAddress] UTF8String];
+
+        snprintf(info.address, sizeof(info.address), "%s", address != NULL ? address : "");
+        snprintf(info.name, sizeof(info.name), "%s", name != NULL ? name : info.address);
+
+        // push the device data into the pipe to notify the main thread
+        pipe_push(inquiryProducer, &info, 1);
     }
 }
 

package/src/macos/DeviceINQ.mm

@@ -126,7 +126,7 @@ void DeviceINQ::Init(Local<Object> target) {
     t->InstanceTemplate()->SetInternalFieldCount(1);
     t->SetClassName(Nan::New("DeviceINQ").ToLocalChecked());
 
-    Isolate *isolate = target->GetIsolate();
+    Isolate *isolate = Isolate::GetCurrent();
     Local<Context> ctx = isolate->GetCurrentContext();
 
     Nan::SetPrototypeMethod(t, "inquireSync", InquireSync);