Skip to content

Add clean button to SerialPlot #7422

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

Closed
wants to merge 4 commits into from
Closed

Add clean button to SerialPlot #7422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f8db03e
- Saving same bytes in HardwareSerial::write
chromhelm May 29, 2015
d89ffe2
Merge branch 'master' of https://github.com/Arduino/Arduino
chromhelm Apr 5, 2018
219cc6c
Add clear button to SerialPlotter
chromhelm Apr 5, 2018
c76a8f9
Added label support to SerialPlotter
chromhelm Apr 5, 2018
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 116 additions & 18 deletions app/src/processing/app/SerialPlotter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
import java.util.ArrayList;
import javax.swing.*;
import javax.swing.border.EmptyBorder;

import com.jcraft.jsch.Buffer;

import java.awt.*;
import java.awt.event.ActionListener;
import java.awt.geom.AffineTransform;
Expand All @@ -37,18 +40,23 @@ public class SerialPlotter extends AbstractMonitor {

private final StringBuffer messageBuffer;
private JComboBox<String> serialRates;
private JButton clearButton;
private Serial serial;
private int serialRate, xCount;

private ArrayList<Graph> graphs;
private final static int BUFFER_CAPACITY = 500;
private int buffer_capacity = 500;
private final static int BUFFER_CAPACITY_DEFAULT = 500;
private final static int BUFFER_CAPACITY_MAX = 5000;
private final static int BUFFER_CAPACITY_MIN = 10;

private static class Graph {
public CircularBuffer buffer;
public String label;
private Color color;

public Graph(int id) {
buffer = new CircularBuffer(BUFFER_CAPACITY);
public Graph(int id, int capacity) {
buffer = new CircularBuffer(capacity);
color = Theme.getColorCycleColor("plotting.graphcolor", id);
}

Expand Down Expand Up @@ -146,12 +154,12 @@ public void paintComponent(Graphics g1) {
}

// handle data count
int cnt = xCount - BUFFER_CAPACITY;
if (xCount < BUFFER_CAPACITY) cnt = 0;
int cnt = xCount - buffer_capacity;
if (xCount < buffer_capacity) cnt = 0;

double zeroTick = ticks.getTick(0);
double lastTick = ticks.getTick(ticks.getTickCount() - 1);
double xTickRange = BUFFER_CAPACITY / ticks.getTickCount();
double xTickRange = buffer_capacity / ticks.getTickCount();

for (int i = 0; i < ticks.getTickCount() + 1; i++) {
String s;
Expand All @@ -167,7 +175,7 @@ public void paintComponent(Graphics g1) {
s = String.valueOf((int)(xTickRange * i)+cnt);
fBounds = fm.getStringBounds(s, g);
sWidth = (int)fBounds.getWidth()/2;
xValue = (int)((bounds.width - xOffset - xPadding) * ((xTickRange * i) / BUFFER_CAPACITY) + xOffset);
xValue = (int)((bounds.width - xOffset - xPadding) * ((xTickRange * i) / buffer_capacity) + xOffset);
}
// draw graph x axis, ticks and labels
g.setColor(boundsColor);
Expand All @@ -184,13 +192,24 @@ public void paintComponent(Graphics g1) {
g.drawLine(xOffset, (int) transformY(zeroTick), bounds.width - xPadding, (int)transformY(zeroTick));

g.setTransform(AffineTransform.getTranslateInstance(xOffset, 0));
float xstep = (float) (bounds.width - xOffset - xPadding) / (float) BUFFER_CAPACITY;
int legendLength = graphs.size() * 10 + (graphs.size() - 1) * 3;

float xstep = (float) (bounds.width - xOffset - xPadding) / (float) buffer_capacity;
// draw legend
int legendXOffset = 0;
for(int i = 0; i < graphs.size(); ++i) {
graphs.get(i).paint(g, xstep, minY, maxY, rangeY, bounds.height);
if(graphs.size() > 1) {
g.fillRect(bounds.width - (xOffset + legendLength + 10) + i * 13, 10, 10, 10);
if(graphs.size() > 1) {
//draw legend rectangle
g.fillRect(10 + legendXOffset, 10, 10, 10);
legendXOffset += 13;
//draw label
g.setColor(boundsColor);
String s = graphs.get(i).label;
if(s != null && s.length() > 0) {
Rectangle2D fBounds = fm.getStringBounds(s, g);
int sWidth = (int)fBounds.getWidth();
g.drawString(s, 10 + legendXOffset, 10 + (int)fBounds.getHeight() /2);
legendXOffset += sWidth + 3;
}
}
}
}
Expand Down Expand Up @@ -231,6 +250,8 @@ public SerialPlotter(BoardPort port) {

messageBuffer = new StringBuffer();
graphs = new ArrayList<>();

clearButton.addActionListener(ae -> {graphs.clear();});
}

protected void onCreateWindow(Container mainPane) {
Expand All @@ -248,21 +269,36 @@ protected void onCreateWindow(Container mainPane) {
for (String serialRateString : serialRateStrings) serialRates.addItem(serialRateString + " " + tr("baud"));

serialRates.setMaximumSize(serialRates.getMinimumSize());

clearButton = new JButton(tr("Clear output"));

pane.add(Box.createHorizontalGlue());
pane.add(Box.createRigidArea(new Dimension(8, 0)));
pane.add(serialRates);
pane.add(clearButton);

mainPane.add(pane, BorderLayout.SOUTH);
}

protected void onEnableWindow(boolean enable) {
serialRates.setEnabled(enable);
clearButton.setEnabled(enable);
}

private void onSerialRateChange(ActionListener listener) {
serialRates.addActionListener(listener);
}

private void setNewBufferCapacity(int capacity){
if(buffer_capacity != capacity) {
if(capacity > BUFFER_CAPACITY_MAX) capacity = BUFFER_CAPACITY_MAX;
else if(capacity < BUFFER_CAPACITY_MIN) capacity = BUFFER_CAPACITY_MIN;
buffer_capacity = capacity;
for(int i = 0; i < graphs.size(); i++) {
graphs.get(i).buffer.newCapacity(capacity);
}
}
}

public void message(final String s) {
messageBuffer.append(s);
Expand All @@ -280,19 +316,81 @@ public void message(final String s) {
if(parts.length == 0) {
continue;
}

int validParts = 0;
int validLabels = 0;
for(int i = 0; i < parts.length; ++i) {
try {
double value = Double.valueOf(parts[i]);
Double value = null;
String label = null;

// all commands start with #
if(parts[i].startsWith("#") && parts[i].length() > 1) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a big fan of hardcoded commands but I appreciate the idea.
Probably a standalone commit (like "add CLEAR and SET_SIZE runtime commands to Serial Plotter") could do the trick and make discussion easier
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in pull request #7461
String command = parts[i].substring(1, parts[i].length()).trim();
if(command.equals("CLEAR")) {
graphs.clear();
}
else if(command.startsWith("SIZE:")) {
String[] subString = parts[i].split("[:]+");
int newSize = BUFFER_CAPACITY_DEFAULT;
if(subString.length > 1) {
try {
newSize = Integer.parseInt(subString[1]);
} catch (NumberFormatException e) {
// Ignore
}
}
setNewBufferCapacity(newSize);
}
} else {
if(parts[i].contains(":")) {
// get label
String[] subString = parts[i].split("[:]+");

if(subString.length > 0) {
int labelLength = subString[0].length();

if(labelLength > 32) {
labelLength = 32;
}
label = subString[0].substring(0, labelLength);
} else {
label = "";
}

if(subString.length > 1) {
parts[i] = subString[1];
} else {
parts[i] = "";
}
}
try {
value = Double.valueOf(parts[i]);
} catch (NumberFormatException e) {
// ignored
}
//CSV header
if(label == null && value == null) {
label = parts[i];
}
}

if(value != null) {
if(validParts >= graphs.size()) {
graphs.add(new Graph(validParts));
graphs.add(new Graph(validParts, buffer_capacity));
}
graphs.get(validParts).buffer.add(value);
validParts++;
} catch (NumberFormatException e) {
// ignore

}
if(label != null) {
if(validLabels >= graphs.size()) {
graphs.add(new Graph(validLabels, buffer_capacity));
}
graphs.get(validLabels).label = label;
validLabels++;
}
if(validParts > validLabels) validLabels = validParts;
else if(validLabels > validParts) validParts = validLabels;
}
}

Expand Down
10 changes: 8 additions & 2 deletions app/src/processing/app/helpers/CircularBuffer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

public class CircularBuffer {

private final double[] elements;
private double[] elements;
private int start = -1;
private int end = -1;
private final int capacity;
private int capacity;

public void add(double num) {
end = (end + 1) % capacity;
Expand Down Expand Up @@ -36,6 +36,12 @@ public CircularBuffer(int capacity) {
this.capacity = capacity;
elements = new double[capacity];
}

public void newCapacity(int capacity) {
elements = new double[capacity];
this.capacity = capacity;
start = end = 0;
}

public double min() {
if (size() == 0) {
Expand Down