No close event emitted when a device is physically removed for an open port. #2043

t0mpa · 2020-03-04T14:29:35Z

Summary of Problem

(Please answer all 3)

What are you trying to do?
Detect when a device is physically disconnected from the usb-port.
What happens?
When a physical device is unplugged there's no close event emitted with [email protected] (tested with all versions between 8.0.1 to 8.0.7)
Doing the same thing with [email protected] it works fine.

Output from the provided code below:

Test with node v13.9.0 and node [email protected]

% node app.js

Port opened
Port writable: true
Port open: true
Port writable: true
Port open: true

--- Unplugged the device here! The closed event is NOT being emitted!!! ---

Port writable: true
Port open: true
Port writable: true

--- Sending a write command to the device after it is unplugged, will emit an error (of course) and then the port close event is emitted! It shall not be necessary to write to the port to detect that a physical device has been removed from the system. --- 

Error:  ENXIO: no such device or address, write
Port closed!
Port writable: true
Port open: false

Same code and a test with node v12.6.0 and node [email protected]

% node app.js

Port opened
Port writable: true
Port open: true
Port writable: true
Port open: true

--- Unplugged the device here! The closed event is emitted instantly as it should. ---

Port closed!
Port writable: true
Port open: false
Port writable: true
Port open: false

What should have happened?
The close event shall be emitted when the physical device is disconnected, without delay and without the need to write to the port. It's no longer visible in the system, verified with ls -l /dev/tty.*

It shall work like it did in node [email protected].

Code to Reproduce the Issue

const SerialPort = require("serialport");

const port = new SerialPort("/dev/tty.usbmodems2731______1", {
  BaudRate: 115200,
  autoOpen: false
});

port.on("readable", function() {
  var data = port.read();
  console.log("Data:", data.toString());
});

port.on("close", function() {
  console.log("Port closed!");
});

port.on("open", function() {
  console.log("Port opened");
  setInterval(() => {
    console.log("Port writable:", port.writable);
    console.log("Port open:", port.isOpen);
  }, 1000);
});

port.on("error", function(error) {
  if (error) {
    return console.log("Error: ", error.message);
  }
});

port.open(function(error) {
  if (error) {
    return console.log("Error opening port: ", error.message);
  }
});

Versions, Operating System and Hardware

[email protected]
Node.js v13.9.0
Mac OS X 10.15.3
MacBook Pro 13

NicholasBertazzon · 2020-03-05T07:57:44Z

Same problem on Windows 10

gcarlsson · 2020-03-06T08:51:53Z

I can confirm the issue on macOS v10.15.1

kevingtzz · 2020-03-22T05:16:14Z

I have the same issue.

Platform: MacOS v10.15.2
Hardware: Arduino Mega, Xbee explorer
Node version: 13.8.0
serialport version: 8.0.7

Close event is not being triggered.

EarthyOrange · 2020-04-13T18:09:09Z

We are periodically checking the status of the device with get as a work around for this issue.

But this API behaves differently on different platforms:

Windows: the CB is called with updated modem status on disconnection or connection.
Mac: the CB is called with an error on disconnect, but on a good connection the modem status never gets updated (All the flags are set to false).

ijager · 2020-04-16T21:47:57Z

For me the close event still fires on 8.0.4 but not on >8.0.5.

However it was very tricky to downgrade because npm kept installing 8.0.7, ignoring the lower version. In the end I pasted the package-lock.json entries for [email protected] from an older project and installed them with npm ci.

See serialport/node-serialport#2043 No close event is emitted when physically removing the serial device.

thetroy · 2020-04-27T20:06:00Z

It seems like responsibilities shifted around between versions and I don't fully follow that, so I can't propose a fix. Perhaps what I did find will help with fixing.

when you unplug the cable, this code (in stream):

      debug('binding.read', `error`, err)
      if (!err.canceled) {
        this._disconnected(err)
      }

https://github.com/serialport/node-serialport/blob/master/packages/stream/lib/index.js#L388-L391
...no longer calls _disconnected like it did in 6.2.2. This suggests that canceled should not have been set.

canceled is set in the catch in unixRead:

    const disconnectError =
      err.code === 'EBADF' || // Bad file number means we got closed
      err.code === 'ENXIO' || // No such device or address probably usb disconnect
      err.code === 'UNKNOWN' ||
      err.errno === -1 // generic error

    if (disconnectError) {
      err.canceled = true
      logger('disconnecting', err)
    }

https://github.com/serialport/node-serialport/blob/master/packages/bindings/lib/unix-read.js#L42-L51

Note: it is also set in 2 other places above that, likely each needs to be double-checked.

I also found this comment that relates (in binding-abstract)

The in progress reads must error when the port is closed with an error object that has the property canceled equal to true. Any other error will cause a disconnection.

...there is a similar comment for write. Perhaps that comment could be clarified once someone wraps their head around this.

SeBassTian23 · 2020-05-11T15:45:26Z

The issue persists in the latest version for me:

Platform: MacOS v10.15.4
Hardware: Teensy 3.2
Node version: 12.13.0
Serialport version: 9.0.0

Close event is not being triggered after physical disconnect

SeBassTian23 · 2020-05-14T12:59:16Z

For me the close event still fires on 8.0.4 but not on >8.0.5.

However it was very tricky to downgrade because npm kept installing 8.0.7, ignoring the lower version. In the end I pasted the package-lock.json entries for [email protected] from an older project and installed them with npm ci.

I tried the version 8.0.4 but unfortunately it is not working for me:
Platform: MacOS v10.15.4
Hardware: Teensy 3.2
Node version: 12.13.0

SeBassTian23 · 2020-06-10T12:54:31Z

I'm trying to downgrade to version 7.1.5 which worked for me in the past, but unfortunately I run into this error now:

> prebuild-install --tag-prefix @serialport/bindings@ || node-gyp rebuild
    
      CXX(target) Release/obj.target/bindings/src/serialport.o
    
                    errorOut=prebuild-install WARN install No prebuilt binaries found (target=8.2.4 runtime=electron arch=x64 libc= platform=darwin)
    ../src/serialport.cpp:329:14: error: no matching member function for call to 'Set'
        results->Set(Nan::New<v8::String>("cts").ToLocalChecked(), Nan::New<v8::Boolean>(data->cts));
        ~~~~~~~~~^~~
    /Users/kuhlgert/.electron-gyp/8.2.4/include/node/v8.h:3611:37: note: candidate function not viable: requires 3 arguments, but 2 were provided
      V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context,
                                        ^
    /Users/kuhlgert/.electron-gyp/8.2.4/include/node/v8.h:3614:37: note: candidate function not viable: requires 3 arguments, but 2 were provided
      V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index,
                                        ^
    ../src/serialport.cpp:330:14: error: no matching member function for call to 'Set'
        results->Set(Nan::New<v8::String>("dsr").ToLocalChecked(), Nan::New<v8::Boolean>(data->dsr));
        ~~~~~~~~~^~~
    /Users/kuhlgert/.electron-gyp/8.2.4/include/node/v8.h:3611:37: note: candidate function not viable: requires 3 arguments, but 2 were provided
      V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context,
                                        ^
    /Users/kuhlgert/.electron-gyp/8.2.4/include/node/v8.h:3614:37: note: candidate function not viable: requires 3 arguments, but 2 were provided
      V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index,
                                        ^
    ../src/serialport.cpp:331:14: error: no matching member function for call to 'Set'
        results->Set(Nan::New<v8::String>("dcd").ToLocalChecked(), Nan::New<v8::Boolean>(data->dcd));
        ~~~~~~~~~^~~
    /Users/[username]/.electron-gyp/8.2.4/include/node/v8.h:3611:37: note: candidate function not viable: requires 3 arguments, but 2 were provided
      V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context,
                                        ^
    /Users/[username]/.electron-gyp/8.2.4/include/node/v8.h:3614:37: note: candidate function not viable: requires 3 arguments, but 2 were provided
      V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index,
                                        ^
    ../src/serialport.cpp:378:14: error: no matching member function for call to 'Set'
        results->Set(Nan::New<v8::String>("baudRate").ToLocalChecked(), Nan::New<v8::Integer>(data->baudRate));
        ~~~~~~~~~^~~
    /Users/[username]/.electron-gyp/8.2.4/include/node/v8.h:3611:37: note: candidate function not viable: requires 3 arguments, but 2 were provided
      V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context,
                                        ^
    /Users/[username]/.electron-gyp/8.2.4/include/node/v8.h:3614:37: note: candidate function not viable: requires 3 arguments, but 2 were provided
      V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index,
                                        ^
    4 errors generated.

Any ideas on how to fix this?

Platform: MacOS v10.15.4
Electron: 8.2.4
Node version: 12.13.0

reconbot · 2020-06-11T03:05:45Z

Maybe downgrade your node version? Why are you downloading?

On Wed, Jun 10, 2020 at 8:54 AM Sebastian ***@***.***> wrote: I'm trying to downgrade to version 7.1.5 which worked for me in the past, but unfortunately I run into this error now: > prebuild-install --tag-prefix @serialport/bindings@ || node-gyp rebuild CXX(target) Release/obj.target/bindings/src/serialport.o errorOut=prebuild-install WARN install No prebuilt binaries found (target=8.2.4 runtime=electron arch=x64 libc= platform=darwin) ../src/serialport.cpp:329:14: error: no matching member function for call to 'Set' results->Set(Nan::New<v8::String>("cts").ToLocalChecked(), Nan::New<v8::Boolean>(data->cts)); ~~~~~~~~~^~~ /Users/kuhlgert/.electron-gyp/8.2.4/include/node/v8.h:3611:37: note: candidate function not viable: requires 3 arguments, but 2 were provided V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, ^ /Users/kuhlgert/.electron-gyp/8.2.4/include/node/v8.h:3614:37: note: candidate function not viable: requires 3 arguments, but 2 were provided V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index, ^ ../src/serialport.cpp:330:14: error: no matching member function for call to 'Set' results->Set(Nan::New<v8::String>("dsr").ToLocalChecked(), Nan::New<v8::Boolean>(data->dsr)); ~~~~~~~~~^~~ /Users/kuhlgert/.electron-gyp/8.2.4/include/node/v8.h:3611:37: note: candidate function not viable: requires 3 arguments, but 2 were provided V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, ^ /Users/kuhlgert/.electron-gyp/8.2.4/include/node/v8.h:3614:37: note: candidate function not viable: requires 3 arguments, but 2 were provided V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index, ^ ../src/serialport.cpp:331:14: error: no matching member function for call to 'Set' results->Set(Nan::New<v8::String>("dcd").ToLocalChecked(), Nan::New<v8::Boolean>(data->dcd)); ~~~~~~~~~^~~ /Users/[username]/.electron-gyp/8.2.4/include/node/v8.h:3611:37: note: candidate function not viable: requires 3 arguments, but 2 were provided V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, ^ /Users/[username]/.electron-gyp/8.2.4/include/node/v8.h:3614:37: note: candidate function not viable: requires 3 arguments, but 2 were provided V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index, ^ ../src/serialport.cpp:378:14: error: no matching member function for call to 'Set' results->Set(Nan::New<v8::String>("baudRate").ToLocalChecked(), Nan::New<v8::Integer>(data->baudRate)); ~~~~~~~~~^~~ /Users/[username]/.electron-gyp/8.2.4/include/node/v8.h:3611:37: note: candidate function not viable: requires 3 arguments, but 2 were provided V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, ^ /Users/[username]/.electron-gyp/8.2.4/include/node/v8.h:3614:37: note: candidate function not viable: requires 3 arguments, but 2 were provided V8_WARN_UNUSED_RESULT Maybe<bool> Set(Local<Context> context, uint32_t index, ^ 4 errors generated. Any ideas on how to fix this? Platform: MacOS v10.15.4 Electron: 8.2.4 Node version: 12.13.0 — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#2043 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAGK3SSOUCY55KS6J6H5HDRV57BRANCNFSM4LBI4EOA> .

-- --- Francis Gulotta [email protected]

dunkmann00 · 2020-06-11T03:50:26Z

I can also confirm that this occurs on the new version 9.0.0 (running on MacOS 10.15.2).

SeBassTian23 · 2020-06-12T13:58:59Z

Maybe downgrade your node version? Why are you downloading?
-- --- Francis Gulotta [email protected]

I will try to downgrade node and see if that works. I can't download the prebuild libraries, so I would have to rebuild them and it seems that process is failing. Proper install only works for releases of serialport version 8.x and up

SeBassTian23 · 2020-06-17T12:36:20Z

I finally find some time to get working on the issue. Any particular node version you would recommend using @reconbot ?

dunkmann00 · 2020-06-20T14:50:52Z

I’ve looked into this a bit more. On Windows the problem does not occur. I was trying to look into the code a bit and do some testing, I’m not totally sure but it seems like the Poller binding is not receiving any disconnect event.

dunkmann00 · 2020-06-22T02:44:30Z

I think I have tracked down the problem. First, it seems that physically disconnecting something triggers a read. It doesn't trigger a disconnect at the low level code in binding/src and it never did. Secondly, it seems that in commit 50f967e unix-read.js was changed:

unix-read.js L#48-51

     if (disconnectError) {
-      err.disconnect = true
+      err.canceled = true
       logger('disconnecting', err)
     }

With this, the disconnect function won't get called in stream/lib/index.js:

node-serialport/packages/stream/lib/index.js

Lines 387 to 393 in 45f83ab

    
           err => { 
        
             debug('binding.read', `error`, err) 
        
             if (!err.canceled) { 
        
               this._disconnected(err) 
        
             } 
        
             this._read(bytesToRead) // prime to read more once we're reconnected 
        
           }

And from what I can tell, it just gets stuck in an (asynchronous) loop and does nothing until you try to write, at which point the disconnect function is called and the closed event is emitted.

I tried just changing unix-read.js back to what it was, but then it fails one of the unit tests.

In binding-abstract/lib/index.js the description for the read function states:

The in progress reads must error when the port is closed with an error object that has the property `canceled` equal to `true`. Any other error will cause a disconnection.

So this clearly was added on purpose, but since physical disconnects trigger in progress reads, I'm not sure what should be changed to maintain the current desired behavior (actual in progress reads erring with canceled equal to true), while adding the disconnect event for disconnects.

@reconbot, thoughts on this?

antmarot · 2020-06-25T14:25:30Z

Same issue with 9.0.0 — node v10.17.0 and macOS 10.15.5

isopterix · 2020-07-04T09:00:01Z

Same here with version 9.0.0 and node v13.12.0 and macOS 10.13.6.

dunkmann00 · 2020-08-05T16:51:43Z

@reconbot Have you had a chance to look into this. If you have any suggestions I'd be happy to make a pull request.

reconbot · 2020-08-07T02:57:03Z

This was an oversight on the refactor. I've changed the code back per @dunkmann00. The test was also wrong.

dunkmann00 · 2020-08-07T23:19:06Z

Thanks @reconbot!

reconbot · 2020-08-08T01:19:44Z

I published [email protected] which has this fix. Let me know how it works.

dunkmann00 · 2020-08-09T17:08:58Z

Working great, thanks again for fixing this!

nvbach91 · 2023-04-30T12:59:19Z

Issue is still present on v10.4.0 and v11.0.0. You have to manually call the port.read() method (in a loop) to actually trigger the close event with the Disconnect Error. Not sure if repeatedly calling read() will cause any problems in production.

here's my log

2023-04-30T12:53:47.202Z connected at COM3, pnpId USB\VID_067B&PID_2303\11111111
2023-04-30T12:53:47.981Z port.isOpen === true Manually calling port.read(): null
2023-04-30T12:53:48.994Z port.isOpen === true Manually calling port.read(): null
2023-04-30T12:53:49.998Z port.isOpen === true Manually calling port.read(): null
2023-04-30T12:53:51.012Z port.isOpen === true Manually calling port.read(): null
2023-04-30T12:53:51.233Z        Port COM3 closed DisconnectedError: Setting COM timeout (SetCommTimeouts): Unknown error code 22
    at SerialPort._disconnected (C:\...\testserialport\node_modules\@serialport\stream\dist\index.js:216:31)
    at C:\...\testserialport\node_modules\@serialport\stream\dist\index.js:205:22 {
  disconnected: true
}
2023-04-30T12:53:52.015Z port.isOpen === false
2023-04-30T12:53:53.018Z port.isOpen === false
2023-04-30T12:53:54.025Z port.isOpen === false
2023-04-30T12:53:55.039Z port.isOpen === false
2023-04-30T12:53:56.041Z port.isOpen === false

and the code (tested on Node.js 16.18.0 and 18.12.0, Windows 10, Windows 11)

const { SerialPort } = require('serialport');
const config = {
    pnpId: 'USB\\VID_067B&PID_2303\\11111111',
    baudRate: 9600,
    dataBits: 8,
    stopBits: 1,
    parity: 'none',
};
const path = 'COM3';

const port = new SerialPort({ ...config, path });
const log = (...msgs) => {
    console.log(new Date().toISOString(), ...msgs);
};
port.on('open', () => {
    log(`connected at ${path}, pnpId ${config.pnpId}`);
});
port.on('close', (disconnectError) => {
    log(`\tPort ${path} closed`, disconnectError);
});

setInterval(() => {
    if (port.isOpen) {
        log('port.isOpen ===', port.isOpen, 'Manually calling port.read():', port.read());
    } else {
        log('port.isOpen ===', port.isOpen);
    }
}, 1000);

my setup

COM               name COM3
Manufacturer      Prolific
PnP ID            USB\VID_067B&PID_2303\11111111
Friendly name     Prolific USB-to-Serial Comm Port (COM3)

Hope this helps somebody.

BCsabaEngine · 2023-11-19T09:25:04Z

Same issue with Linux and node20 and SerialPort v12. Close never occured when disconnected physically. I need to call a write operation to affect closed.
port.write('\n')

ijager added a commit to JitterCompany/SerialWatch that referenced this issue Apr 17, 2020

Pin serialport dep at 8.0.4 since of a bug in later versions.

085c772

See serialport/node-serialport#2043 No close event is emitted when physically removing the serial device.

reconbot mentioned this issue Aug 7, 2020

fix: disconnects should now work again on unix based systems #2120

Merged

reconbot closed this as completed in #2120 Aug 7, 2020

reconbot reopened this Aug 7, 2020

reconbot closed this as completed Aug 8, 2020

hspaay mentioned this issue Nov 26, 2023

serialport + electron, "close" event causes CPU spike #2323

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

No close event emitted when a device is physically removed for an open port. #2043

No close event emitted when a device is physically removed for an open port. #2043

t0mpa commented Mar 4, 2020

NicholasBertazzon commented Mar 5, 2020

gcarlsson commented Mar 6, 2020

kevingtzz commented Mar 22, 2020

EarthyOrange commented Apr 13, 2020

ijager commented Apr 16, 2020 •

edited

Loading

thetroy commented Apr 27, 2020

SeBassTian23 commented May 11, 2020

SeBassTian23 commented May 14, 2020

SeBassTian23 commented Jun 10, 2020

reconbot commented Jun 11, 2020 via email

dunkmann00 commented Jun 11, 2020

SeBassTian23 commented Jun 12, 2020

SeBassTian23 commented Jun 17, 2020

dunkmann00 commented Jun 20, 2020

dunkmann00 commented Jun 22, 2020 •

edited

Loading

antmarot commented Jun 25, 2020

isopterix commented Jul 4, 2020

dunkmann00 commented Aug 5, 2020

reconbot commented Aug 7, 2020

dunkmann00 commented Aug 7, 2020

reconbot commented Aug 8, 2020 •

edited

Loading

dunkmann00 commented Aug 9, 2020

nvbach91 commented Apr 30, 2023 •

edited

Loading

BCsabaEngine commented Nov 19, 2023 •

edited

Loading

No close event emitted when a device is physically removed for an open port. #2043

No close event emitted when a device is physically removed for an open port. #2043

Comments

t0mpa commented Mar 4, 2020

Summary of Problem

Code to Reproduce the Issue

Versions, Operating System and Hardware

NicholasBertazzon commented Mar 5, 2020

gcarlsson commented Mar 6, 2020

kevingtzz commented Mar 22, 2020

EarthyOrange commented Apr 13, 2020

ijager commented Apr 16, 2020 • edited Loading

thetroy commented Apr 27, 2020

SeBassTian23 commented May 11, 2020

SeBassTian23 commented May 14, 2020

SeBassTian23 commented Jun 10, 2020

reconbot commented Jun 11, 2020 via email

dunkmann00 commented Jun 11, 2020

SeBassTian23 commented Jun 12, 2020

SeBassTian23 commented Jun 17, 2020

dunkmann00 commented Jun 20, 2020

dunkmann00 commented Jun 22, 2020 • edited Loading

antmarot commented Jun 25, 2020

isopterix commented Jul 4, 2020

dunkmann00 commented Aug 5, 2020

reconbot commented Aug 7, 2020

dunkmann00 commented Aug 7, 2020

reconbot commented Aug 8, 2020 • edited Loading

dunkmann00 commented Aug 9, 2020

nvbach91 commented Apr 30, 2023 • edited Loading

BCsabaEngine commented Nov 19, 2023 • edited Loading

ijager commented Apr 16, 2020 •

edited

Loading

dunkmann00 commented Jun 22, 2020 •

edited

Loading

reconbot commented Aug 8, 2020 •

edited

Loading

nvbach91 commented Apr 30, 2023 •

edited

Loading

BCsabaEngine commented Nov 19, 2023 •

edited

Loading