There is no communication of problem when monitor process creation fails #1508

per1234 · 2022-09-30T15:15:20Z

Describe the problem

When the Arduino IDE Serial Monitor is opened, a pluggable monitor tool process is started. This process may error if the port can't be opened. Inability to open a port is a common problem for Arduino users, usually caused by already having it open in another application, not having set up system permissions for access, or the port being stuck in a glitched state.

The Arduino IDE Serial Monitor does not communicate in any way to the user that there is a problem, nor what the nature of that problem might be when starting monitor process fails after Serial Monitor is opened.

🐛 The user will not understand why the expected output is not being sent or received from Serial Monitor. They, and those supporting them, may waste quite some time studying their code and hardware for problems.

To reproduce

Equipment

Any Arduino board that produces a serial port.

Steps

Upload a sketch to your Arduino board that uses serial input and output:

unsigned long previousMillis;

void setup() {
  Serial.begin(9600);
}

void loop() {
  if (Serial.available() > 0) {
    while (Serial.available() > 0) {
      Serial.write(Serial.read());
      delay(10);
    }
  } else if (millis() - previousMillis >= 1000) {
    previousMillis = millis();
    Serial.println("hello");
  }
}

Close the Arduino IDE 2.x Serial Monitor view if it is open.
Open the serial port of the Arduino board in any other application.
e.g., Arduino IDE 1.x Serial Monitor, arduino-cli monitor
Select the port of the Arduino board in the Arduino IDE 2.x Tools > Port menu.
Select Tools > Serial Monitor from the Arduino IDE 2.x menus to open the Serial Monitor view.

🐛 There is no indication of any problem other than the lack of a baud rate menu:

🐛 The expected "hello" output is not printed.
🐛 Any data sent via the "Message" field is not received by the board.

Expected behavior

Clear communication of the problem when starting a monitor process fails.

Arduino IDE version

2.0.1-snapshot-6f07717

Operating system

Windows

Operating system version

10

Additional context

The logs show the Arduino CLI daemon is communicating the problem to the IDE:

daemon INFO {"level":"info","monitor":"serial-monitor","msg":"Starting monitor process","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"level":"info","monitor":"serial-monitor","msg":"Monitor process started successfully!","time":"2022-09-30T04:07:41-07:00"}
{"command":"HELLO 1 \"arduino-cli 0.27.1\"","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"error":false,"event_type":"hello","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"command":"DESCRIBE","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}
{"error":false,"event_type":"describe","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}
{"command":"CONFIGURE dtr on","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"error":false,"event_type":"configure","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}
{"command":"CONFIGURE parity none","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}
{"error":false,"event_type":"configure","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}
{"command":"CONFIGURE rts on","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"error":false,"event_type":"configure","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}
{"command":"CONFIGURE stop_bits 1","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}
{"error":false,"event_type":"configure","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"command":"CONFIGURE baudrate 9600","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}
{"error":false,"event_type":"configure","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}
{"command":"CONFIGURE bits 8","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"error":false,"event_type":"configure","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"command":"OPEN 127.0.0.1:17515 COM7","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"error":true,"event_type":"open","level":"info","message":"Serial port busy","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}
{"command":"QUIT","level":"info","monitor":"serial-monitor","msg":"sending command","time":"2022-09-30T04:07:41-07:00"}
{"error":false,"event_type":"quit","level":"info","message":"OK","monitor":"serial-monitor","msg":"received message","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"level":"info","monitor":"serial-monitor","msg":"Killing monitor process","time":"2022-09-30T04:07:41-07:00"}
{"error":"TerminateProcess: Access is denied.","level":"error","monitor":"serial-monitor","msg":"Sent kill signal","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"level":"error","monitor":"serial-monitor","msg":"stopped decode loop: EOF","time":"2022-09-30T04:07:41-07:00"}

daemon INFO {"level":"info","monitor":"serial-monitor","msg":"Monitor process killed","time":"2022-09-30T04:07:41-07:00"}

monitor-service ERROR Error: 2 UNKNOWN: Port monitor error: command 'open' failed: Serial port busy
    at Object.callErrorFromStatus (C:\ide 2\tip\135-6f07717\resources\app\node_modules\@grpc\grpc-js\build\src\call.js:31:26)
    at Object.onReceiveStatus (C:\ide 2\tip\135-6f07717\resources\app\node_modules\@grpc\grpc-js\build\src\client.js:409:49)
    at Object.onReceiveStatus (C:\ide 2\tip\135-6f07717\resources\app\node_modules\@grpc\grpc-js\build\src\client-interceptors.js:328:181)
    at C:\ide 2\tip\135-6f07717\resources\app\node_modules\@grpc\grpc-js\build\src\call-stream.js:187:78
    at processTicksAndRejections (node:internal/process/task_queues:78:11)
monitor-service INFO monitor to COM7 using serial closed by server

Prior to #982, there was a (misleading) indication of a problem under these conditions:

Arduino IDE 1.x clearly communicates the problem to the user:

Arduino CLI clearly communicates the problem to the command line interface user:

$ arduino-cli monitor --port COM7
Port monitor error: command 'open' failed: Serial port busy

Issue checklist

I searched for previous reports in the issue tracker
I verified the problem still occurs when using the latest nightly build
My report contains all necessary details

The text was updated successfully, but these errors were encountered:

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

- Handle when the board's platform is not installed (Closes #1974) - UX: Smoother monitor widget reset (Closes #1985) - Fixed monitor <input> readOnly state (Closes #1984) - Set monitor widget header color (Ref #682) Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

per1234 added topic: code Related to content of the project itself type: imperfection Perceived defect in any part of project topic: serial monitor Related to the Serial Monitor labels Sep 30, 2022

per1234 mentioned this issue Feb 20, 2023

Serial Monitor loses connection after PC sleeps #1895

Open

3 tasks

kittaakos mentioned this issue Mar 14, 2023

Arduino not throwing an error on an unusable serial port #1957

Closed

3 tasks

kittaakos self-assigned this Mar 17, 2023

kittaakos added a commit that referenced this issue Mar 17, 2023

fix: propagate monitor errors to the frontend

9cced4b

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos mentioned this issue Mar 17, 2023

fix: propagate monitor errors to the frontend #1965

Merged

4 tasks

kittaakos added a commit that referenced this issue Mar 17, 2023

fix: propagate monitor errors to the frontend

4e315ab

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos added a commit that referenced this issue Mar 17, 2023

fix: propagate monitor errors to the frontend

2f44d4f

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos added a commit that referenced this issue Mar 17, 2023

fix: propagate monitor errors to the frontend

6daf0af

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos added a commit that referenced this issue Mar 17, 2023

fix: propagate monitor errors to the frontend

eaf730f

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos added a commit that referenced this issue Mar 17, 2023

fix: propagate monitor errors to the frontend

3328e91

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos added a commit that referenced this issue Mar 17, 2023

fix: propagate monitor errors to the frontend

305b1b8

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos added a commit that referenced this issue Mar 17, 2023

fix: propagate monitor errors to the frontend

eb2fc72

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos added a commit that referenced this issue Mar 29, 2023

fix: propagate monitor errors to the frontend

796aac4

Closes #1508 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

kittaakos closed this as completed in #1965 Apr 13, 2023

kittaakos closed this as completed in 80d5b5a Apr 13, 2023

kittaakos added the conclusion: resolved Issue was resolved label Apr 13, 2023

There is no communication of problem when monitor process creation fails #1508

There is no communication of problem when monitor process creation fails #1508

Comments

per1234 commented Sep 30, 2022

Describe the problem

To reproduce

Equipment

Steps

Expected behavior

Arduino IDE version

Operating system

Operating system version

Additional context

Issue checklist