Skip to content

Espressif-IDE is not clearing serial port before trying to upload (IEP-1398) #1168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Espressif-IDE is not clearing serial port before trying to upload (IEP-1398) #1168

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c489bab
fix: clean up code and use try-with-resources for better resource man…
sigmaaa Mar 3, 2025
4aaa693
feat: destroy process in finally
sigmaaa Mar 25, 2025
73d6915
feat: try to destroy process forcibly
sigmaaa Mar 25, 2025
aa96b37
fix: destroying forcibly when reflashing
sigmaaa Mar 27, 2025
a8a53a8
fix: closing streams before destroying process
sigmaaa Mar 28, 2025
ad9f295
fix: stop web socket server before destroying the process
sigmaaa Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 2 additions & 20 deletions ...df.launch.serial.core/src/com/espressif/idf/launch/serial/internal/SerialFlashLaunch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@
*******************************************************************************/
package com.espressif.idf.launch.serial.internal;

import java.io.IOException;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.debug.core.DebugEvent;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.ILaunchConfiguration;
Expand Down Expand Up @@ -55,14 +51,7 @@ public void start()
wasOpen = serialPort.isOpen();
if (wasOpen)
{
try
{
serialPort.pause();
}
catch (IOException e)
{
Activator.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, Messages.SerialFlashLaunch_Pause, e));
}
serialPort.pause();
}
}
else
Expand All @@ -77,14 +66,7 @@ public void handleDebugEvents(DebugEvent[] events)
super.handleDebugEvents(events);
if (isTerminated() && wasOpen)
{
try
{
serialPort.resume();
}
catch (IOException e)
{
Activator.log(new Status(IStatus.ERROR, Activator.PLUGIN_ID, Messages.SerialFlashLaunch_Resume, e));
}
serialPort.resume();
wasOpen = false;
}
}
Expand Down
42 changes: 24 additions & 18 deletions ...tor.serial/src/com/espressif/idf/terminal/connector/serial/connector/SerialConnector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
*******************************************************************************/
package com.espressif.idf.terminal.connector.serial.connector;

import java.io.IOException;
import java.io.OutputStream;
import java.util.HashSet;
import java.util.Set;
Expand All @@ -28,7 +27,8 @@
import com.espressif.idf.core.util.StringUtil;
import com.espressif.idf.terminal.connector.serial.activator.Activator;

public class SerialConnector extends TerminalConnectorImpl {
public class SerialConnector extends TerminalConnectorImpl
{

private SerialSettings settings = new SerialSettings();
protected Process process;
Expand All @@ -40,43 +40,51 @@ public class SerialConnector extends TerminalConnectorImpl {

private static Set<String> openPorts = new HashSet<>();

public static boolean isOpen(String portName) {
public static boolean isOpen(String portName)
{
return openPorts.contains(portName);
}

@Override
public OutputStream getTerminalToRemoteStream() {
public OutputStream getTerminalToRemoteStream()
{
return process.getOutputStream();
}

public SerialSettings getSettings() {
public SerialSettings getSettings()
{
return settings;
}

@Override
public String getSettingsSummary() {
public String getSettingsSummary()
{
return settings.getSummary();
}

@Override
public void load(ISettingsStore store) {
public void load(ISettingsStore store)
{
settings.load(store);
}

@Override
public void save(ISettingsStore store) {
public void save(ISettingsStore store)
{
settings.save(store);
}

@Override
public void connect(ITerminalControl control) {
public void connect(ITerminalControl control)
{
super.connect(control);
this.control = control;

//Get selected project - which is required for IDF Monitor
// Get selected project - which is required for IDF Monitor
project = settings.getProject();

if (project == null) {
if (project == null)
{
String message = "project can't be null. Make sure you select a project before launch a serial monitor"; //$NON-NLS-1$
Activator.log(new Status(IStatus.ERROR, Activator.getUniqueIdentifier(), message, null));
return;
Expand All @@ -94,15 +102,13 @@ public void connect(ITerminalControl control) {
}

@Override
protected void doDisconnect() {
protected void doDisconnect()
{

if (serialPort != null && serialPort.isOpen()) {
if (serialPort != null && serialPort.isOpen())
{
openPorts.remove(serialPort.getPortName());
try {
serialPort.close();
} catch (IOException e) {
Activator.log(e);
}
serialPort.close();
}
}

Expand Down
120 changes: 36 additions & 84 deletions ...r.serial/src/com/espressif/idf/terminal/connector/serial/connector/SerialPortHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
package com.espressif.idf.terminal.connector.serial.connector;

import java.io.IOException;
import java.io.InputStream;
import java.lang.ref.WeakReference;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import org.eclipse.core.resources.IProject;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
Expand All @@ -24,29 +22,13 @@ public class SerialPortHandler
private boolean isOpen;
private boolean isPaused;
private Object pauseMutex = new Object();
private IProject project;

private static final Map<String, LinkedList<WeakReference<SerialPortHandler>>> openPorts = new HashMap<>();
private static final Map<String, LinkedList<SerialPortHandler>> openPorts = new ConcurrentHashMap<>();

private Process process;
private Thread thread;
private SerialConnector serialConnector;
private SocketServerMessageHandler serverMessageHandler;

private SocketServerHandler socketServerHandler;

private static String adjustPortName(String portName)
{
if (System.getProperty("os.name").startsWith("Windows") && !portName.startsWith("\\\\.\\")) //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
{
return portName; // $NON-NLS-1$
}
else
{
return portName;
}
}

/**
* Return an the SerialPortHandler with the given name or null if it hasn't been allocated yet. This would be used
* by components that need to pause and resume a serial port.
Expand All @@ -57,19 +39,18 @@ private static String adjustPortName(String portName)
*/
public static SerialPortHandler get(String portName)
{
synchronized (openPorts)
LinkedList<SerialPortHandler> list = openPorts.get(portName);
if (list == null)
{
LinkedList<WeakReference<SerialPortHandler>> list = openPorts.get(adjustPortName(portName));
if (list == null)
{
return null;
}
return null;
}

Iterator<WeakReference<SerialPortHandler>> i = list.iterator();
synchronized (list)
{
Iterator<SerialPortHandler> i = list.iterator();
while (i.hasNext())
{
WeakReference<SerialPortHandler> ref = i.next();
SerialPortHandler port = ref.get();
SerialPortHandler port = i.next();
if (port == null)
{
i.remove();
Expand All @@ -79,16 +60,14 @@ public static SerialPortHandler get(String portName)
return port;
}
}

return null;
}
return null;
}

public SerialPortHandler(String portName, SerialConnector serialConnector, IProject project)
{
this.portName = adjustPortName(portName);
this.portName = portName;
this.serialConnector = serialConnector;
this.project = project;
this.serverMessageHandler = new SocketServerMessageHandler(serialConnector, project);
}

Expand All @@ -99,6 +78,7 @@ public String getPortName()

private int startSocketServerThread() throws Exception
{
SocketServerHandler socketServerHandler;
socketServerHandler = SocketServerHandler.getInstance();
socketServerHandler.startServer();

Expand Down Expand Up @@ -126,34 +106,29 @@ public synchronized void open()
serialConnector.filterOptions, serverPort);
process = serialMonitorHandler.invokeIDFMonitor();
serialConnector.process = process;
thread = new Thread()
{
@Override
public void run()
thread = new Thread(() -> {
try (InputStream targetIn = process.getInputStream())
{
InputStream targetIn = process.getInputStream();
byte[] buff = new byte[256];
int n;
try
while ((n = targetIn.read(buff)) >= 0)
{
while ((n = targetIn.read(buff, 0, buff.length)) >= 0)
if (n != 0)
{
if (n != 0)
{
serialConnector.control.getRemoteToTerminalOutputStream().write(buff, 0, n);
}
serialConnector.control.getRemoteToTerminalOutputStream().write(buff, 0, n);
}

serialConnector.disconnect();
}
catch (Exception e)
{
Activator.log(e);
serialConnector.disconnect();
serialConnector.control.setState(TerminalState.CLOSED);
}
}
};
catch (Exception e)
{
Activator.log(e);
} finally
{
serialConnector.disconnect();
serialConnector.process.destroyForcibly();
serialConnector.control.setState(TerminalState.CLOSED);
}
});

thread.start();
if (!serverMessageHandler.isAlive())
Expand All @@ -164,20 +139,10 @@ public void run()
isOpen = true;

serialConnector.control.setState(TerminalState.CONNECTED);

synchronized (openPorts)
{
LinkedList<WeakReference<SerialPortHandler>> list = openPorts.get(portName);
if (list == null)
{
list = new LinkedList<>();
openPorts.put(portName, list);
}
list.addFirst(new WeakReference<>(this));
}
openPorts.computeIfAbsent(portName, k -> new LinkedList<>()).addFirst(this);
}

public synchronized void close() throws IOException
public synchronized void close()
{
if (isOpen)
{
Expand All @@ -193,23 +158,10 @@ public synchronized void close() throws IOException
thread.interrupt();
}

synchronized (openPorts)
{
LinkedList<WeakReference<SerialPortHandler>> list = openPorts.get(portName);
if (list != null)
{
Iterator<WeakReference<SerialPortHandler>> i = list.iterator();
while (i.hasNext())
{
WeakReference<SerialPortHandler> ref = i.next();
SerialPortHandler port = ref.get();
if (port == null || port.equals(this))
{
i.remove();
}
}
}
}
openPorts.computeIfPresent(portName, (k, list) -> {
list.remove(this);
return list.isEmpty() ? null : list;
});

try
{
Expand All @@ -228,7 +180,7 @@ public boolean isOpen()
return isOpen;
}

public void pause() throws IOException
public void pause()
{
if (!isOpen)
{
Expand All @@ -250,7 +202,7 @@ public void pause() throws IOException
}
}

public void resume() throws IOException
public void resume()
{
synchronized (pauseMutex)
{
Expand Down
Loading
Loading