TeleStern/altosuilib/AltosScanUI.java

/*
 * Copyright © 2011 Keith Packard <keithp@keithp.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 */

package org.altusmetrum.altosuilib_14;

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import javax.swing.event.*;
import java.io.*;
import java.util.*;
import java.text.*;
import java.util.concurrent.*;
import org.altusmetrum.altoslib_14.*;

class AltosScanResult {
	String		callsign;
	int		serial;
	int		flight;
	AltosFrequency	frequency;
	int		telemetry;
	int		rate;

	boolean	interrupted = false;

	public String toString() {
		return String.format("%-9.9s serial %-4d flight %-4d (%s %s %d)",
				     callsign, serial, flight,
				     frequency.toShortString(),
				     AltosLib.telemetry_name(telemetry),
				     AltosLib.ao_telemetry_rate_values[rate]);
	}

	public String toShortString() {
		return String.format("%s %d %d %7.3f %d %d",
				     callsign, serial, flight, frequency, telemetry, rate);
	}

	public AltosScanResult(String in_callsign, int in_serial,
			       int in_flight, AltosFrequency in_frequency,
			       int in_telemetry,
			       int in_rate) {
		callsign = in_callsign;
		serial = in_serial;
		flight = in_flight;
		frequency = in_frequency;
		telemetry = in_telemetry;
		rate = in_rate;
	}

	public int hashCode() {
		return serial ^ frequency.hashCode() ^ telemetry ^ rate;
	}

	public boolean equals(Object o) {
		if (o == null)
			return false;
		if (!(o instanceof AltosScanResult))
			return false;
		AltosScanResult other = (AltosScanResult) o;
		return (serial == other.serial &&
			frequency.equals(other.frequency) &&
			telemetry == other.telemetry &&
			rate == other.rate);
	}

	public boolean up_to_date(AltosScanResult other) {
		if (flight == 0 && other.flight != 0) {
			flight = other.flight;
			return false;
		}
		if (callsign.equals("N0CALL") && !other.callsign.equals("N0CALL")) {
			callsign = other.callsign;
			return false;
		}
		return true;
	}
}

class AltosScanResults extends LinkedList<AltosScanResult> implements ListModel<AltosScanResult> {

	LinkedList<ListDataListener>	listeners = new LinkedList<ListDataListener>();

	void changed(ListDataEvent de) {
		for (ListDataListener l : listeners)
			l.contentsChanged(de);
	}

	public boolean add(AltosScanResult r) {
		int i = 0;
		for (AltosScanResult old : this) {
			if (old.equals(r)) {
				if (!old.up_to_date(r))
					changed (new ListDataEvent(this,
								   ListDataEvent.CONTENTS_CHANGED,
								   i, i));
				return true;
			}
			i++;
		}

		super.add(r);
		changed(new ListDataEvent(this,
					  ListDataEvent.INTERVAL_ADDED,
					  this.size() - 2, this.size() - 1));
		return true;
	}

	public void addListDataListener(ListDataListener l) {
		listeners.add(l);
	}

	public void removeListDataListener(ListDataListener l) {
		listeners.remove(l);
	}

	public AltosScanResult getElementAt(int i) {
		return this.get(i);
	}

	public int getSize() {
		return this.size();
	}
}

public class AltosScanUI
	extends AltosUIDialog
	implements ActionListener
{
	AltosUIFrame			owner;
	AltosDevice			device;
	AltosConfigData			config_data;
	AltosTelemetryReader		reader;
	private JList<AltosScanResult>	list;
	private JLabel			scanning_label;
	private JLabel			frequency_label;
	private JLabel			telemetry_label;
	private JLabel			rate_label;
	private JButton			cancel_button;
	private JButton			monitor_button;
	private JCheckBox[]		telemetry_boxes;
	private JCheckBox[]		rate_boxes;
	javax.swing.Timer		timer;
	AltosScanResults		results = new AltosScanResults();

	int				telemetry;
	boolean				select_telemetry = false;

	int				rate;
	boolean				select_rate = false;

	final static int		timeout = 1200;
	TelemetryHandler		handler;
	Thread				thread;
	AltosFrequency[]		frequencies;
	int				frequency_index;
	int				packet_count;
	int				tick_count;

	void scan_exception(Exception e) {
		if (e instanceof FileNotFoundException) {
			JOptionPane.showMessageDialog(owner,
						      ((FileNotFoundException) e).getMessage(),
						      "Cannot open target device",
						      JOptionPane.ERROR_MESSAGE);
		} else if (e instanceof AltosSerialInUseException) {
			JOptionPane.showMessageDialog(owner,
						      String.format("Device \"%s\" already in use",
								    device.toShortString()),
						      "Device in use",
						      JOptionPane.ERROR_MESSAGE);
		} else if (e instanceof IOException) {
			IOException ee = (IOException) e;
			JOptionPane.showMessageDialog(owner,
						      device.toShortString(),
						      ee.getLocalizedMessage(),
						      JOptionPane.ERROR_MESSAGE);
		} else {
			JOptionPane.showMessageDialog(owner,
						      String.format("Connection to \"%s\" failed",
								    device.toShortString()),
						      "Connection Failed",
						      JOptionPane.ERROR_MESSAGE);
		}
		close();
	}

	class TelemetryHandler implements Runnable {

		public void run() {

			boolean	interrupted = false;

			try {
				for (;;) {
					try {
						AltosState	state = reader.read();
						if (state == null)
							continue;
						packet_count++;
						AltosCalData	cal_data = state.cal_data();
						if (cal_data.flight != AltosLib.MISSING) {
							final AltosScanResult	result = new AltosScanResult(cal_data.callsign,
													     cal_data.serial,
													     cal_data.flight,
													     frequencies[frequency_index],
													     telemetry,
													     rate);
							Runnable r = new Runnable() {
									public void run() {
										results.add(result);
									}
								};
							SwingUtilities.invokeLater(r);
						}
					} catch (ParseException pp) {
					} catch (AltosCRCException ce) {
					}
				}
			} catch (InterruptedException ee) {
				interrupted = true;
			} catch (IOException ie) {
			} finally {
				reader.close(interrupted);
			}
		}
	}

	void set_label() {
		frequency_label.setText(String.format("Frequency: %s", frequencies[frequency_index].toString()));
		if (select_telemetry)
			telemetry_label.setText(String.format("Telemetry: %s", AltosLib.telemetry_name(telemetry)));
		if (select_rate)
			rate_label.setText(String.format("Rate: %d baud", AltosLib.ao_telemetry_rate_values[rate]));
	}

	void set_telemetry() {
		reader.set_telemetry(telemetry);
	}

	void set_rate() {
		reader.set_telemetry_rate(rate);
	}

	void set_frequency() throws InterruptedException, TimeoutException {
		reader.set_frequency(frequencies[frequency_index].frequency);
		reader.reset();
	}

	void next() throws InterruptedException, TimeoutException {
		reader.set_monitor(false);

		if (select_rate) {
			boolean	wrapped = false;
			do {
				++rate;
				if (rate > AltosLib.ao_telemetry_rate_max) {
					wrapped = true;
					rate = 0;
				}
			} while (!rate_boxes[rate].isSelected());
			set_rate();
			if (!wrapped) {
				set_label();
				return;
			}
		}
		if (select_telemetry) {
			boolean	wrapped = false;
			do {
				++telemetry;
				if (telemetry > AltosLib.ao_telemetry_max) {
					wrapped = true;
					telemetry = AltosLib.ao_telemetry_min;
				}
			} while (!telemetry_boxes[telemetry - AltosLib.ao_telemetry_min].isSelected());
			set_telemetry();
			if (!wrapped) {
				set_label();
				return;
			}
		}
		packet_count = 0;
		tick_count = 0;
		++frequency_index;
		if (frequency_index >= frequencies.length)
			frequency_index = 0;
		set_frequency();
		set_label();
		reader.set_monitor(true);
	}


	void close() {
		if (thread != null && thread.isAlive()) {
			thread.interrupt();
			try {
				thread.join();
			} catch (InterruptedException ie) {}
		}
		thread = null;
		if (timer != null)
			timer.stop();
		setVisible(false);
		dispose();
	}

	void tick_timer() throws InterruptedException, TimeoutException {
		++tick_count;
		if (packet_count == 0 || tick_count > 5)
			next();
	}

	public void actionPerformed(ActionEvent e) {
		String cmd = e.getActionCommand();

		try {
			if (cmd.equals("cancel"))
				close();

			if (cmd.equals("tick"))
				tick_timer();

			if (cmd.equals("telemetry")) {
				int k;
				int scanning_telemetry = 0;
				for (k = AltosLib.ao_telemetry_min; k <= AltosLib.ao_telemetry_max; k++) {
					int j = k - AltosLib.ao_telemetry_min;
					if (telemetry_boxes[j].isSelected())
						scanning_telemetry |= (1 << k);
				}
				if (scanning_telemetry == 0) {
					scanning_telemetry |= (1 << AltosLib.ao_telemetry_standard);
					telemetry_boxes[AltosLib.ao_telemetry_standard - AltosLib.ao_telemetry_min].setSelected(true);
				}
				AltosUIPreferences.set_scanning_telemetry(scanning_telemetry);
			}

			if (cmd.equals("rate")) {
				int k;
				int scanning_rate = 0;
				for (k = 0; k <= AltosLib.ao_telemetry_rate_max; k++) {
					if (rate_boxes[k].isSelected())
						scanning_rate |= (1 << k);
				}
				if (scanning_rate == 0) {
					scanning_rate = (1 << 0);
					rate_boxes[0].setSelected(true);
				}
				AltosUIPreferences.set_scanning_telemetry_rate(scanning_rate);
			}

			if (cmd.equals("monitor")) {
				close();
				AltosScanResult	r = (AltosScanResult) (list.getSelectedValue());
				if (r != null) {
					if (device != null) {
						if (reader != null) {
							reader.set_telemetry(r.telemetry);
							reader.set_telemetry_rate(r.rate);
							reader.set_frequency(r.frequency.frequency);
							reader.save_frequency();
							reader.save_telemetry();
							reader.save_telemetry_rate();
							owner.scan_device_selected(device);
						}
					}
				}
			}
		} catch (TimeoutException te) {
			close();
		} catch (InterruptedException ie) {
			close();
		}
	}

	/* A window listener to catch closing events and tell the config code */
	class ConfigListener extends WindowAdapter {
		AltosScanUI	ui;

		public ConfigListener(AltosScanUI this_ui) {
			ui = this_ui;
		}

		public void windowClosing(WindowEvent e) {
			ui.actionPerformed(new ActionEvent(e.getSource(),
							   ActionEvent.ACTION_PERFORMED,
							   "close"));
		}
	}

	private boolean open() {
		device = AltosDeviceUIDialog.show(owner, AltosLib.product_basestation);
		if (device == null)
			return false;
		try {
			reader = new AltosTelemetryReader(new AltosSerial(device));
			set_frequency();
			set_telemetry();
			set_rate();
			try {
				Thread.sleep(100);
			} catch (InterruptedException ie) {
			}
			reader.flush();
			handler = new TelemetryHandler();
			thread = new Thread(handler);
			thread.start();
			return true;
		} catch (FileNotFoundException ee) {
			JOptionPane.showMessageDialog(owner,
						      ee.getMessage(),
						      "Cannot open target device",
						      JOptionPane.ERROR_MESSAGE);
		} catch (AltosSerialInUseException si) {
			JOptionPane.showMessageDialog(owner,
						      String.format("Device \"%s\" already in use",
								    device.toShortString()),
						      "Device in use",
						      JOptionPane.ERROR_MESSAGE);
		} catch (IOException ee) {
			JOptionPane.showMessageDialog(owner,
						      device.toShortString(),
						      "Unkonwn I/O error",
						      JOptionPane.ERROR_MESSAGE);
		} catch (TimeoutException te) {
			JOptionPane.showMessageDialog(owner,
						      device.toShortString(),
						      "Timeout error",
						      JOptionPane.ERROR_MESSAGE);
		} catch (InterruptedException ie) {
			JOptionPane.showMessageDialog(owner,
						      device.toShortString(),
						      "Interrupted exception",
						      JOptionPane.ERROR_MESSAGE);
		}
		if (reader != null)
			reader.close(false);
		return false;
	}

	public AltosScanUI(AltosUIFrame in_owner, boolean in_select_telemetry) {
		super(in_owner, "Scan Telemetry", false);

		owner = in_owner;
		select_telemetry = in_select_telemetry;
		select_rate = true;

		frequencies = AltosUIPreferences.common_frequencies();
		frequency_index = 0;

		telemetry = AltosLib.ao_telemetry_standard;
		rate = 0;

		if (!open())
			return;

		Container		pane = getScrollablePane();
		GridBagConstraints	c = new GridBagConstraints();
		Insets			i = new Insets(4,4,4,4);

		timer = new javax.swing.Timer(timeout, this);
		timer.setActionCommand("tick");
		timer.restart();

		owner = in_owner;

		pane.setLayout(new GridBagLayout());

		scanning_label = new JLabel("Scanning:");
		frequency_label = new JLabel("");

		if (select_telemetry) {
			telemetry_label = new JLabel("");
			telemetry_label.setPreferredSize(new Dimension(100, 16));
			telemetry = AltosLib.ao_telemetry_min;
		} else {
			telemetry = AltosLib.ao_telemetry_standard;
		}

		if (select_rate) {
			rate_label = new JLabel("");
			rate_label.setPreferredSize(new Dimension(100, 16));
		}

		set_label();

		c.fill = GridBagConstraints.HORIZONTAL;
		c.anchor = GridBagConstraints.LINE_START;
		c.insets = i;
		c.weightx = 0;
		c.weighty = 0;

		c.gridx = 0;
		c.gridy = 0;
		c.gridwidth = 2;

		pane.add(scanning_label, c);
		c.gridy = 1;
		pane.add(frequency_label, c);

		int	y_offset_rate = 3;
		int	y_offset_telem = 3;

		int	check_x = 0;

		if (select_rate && select_telemetry)
			c.gridwidth = 1;

		if (select_rate) {
			c.gridy = 2;
			c.gridx = check_x++;
			pane.add(rate_label, c);

			int	scanning_rate = AltosUIPreferences.scanning_telemetry_rate();
			rate_boxes = new JCheckBox[AltosLib.ao_telemetry_rate_max + 1];
			for (int k = 0; k <= AltosLib.ao_telemetry_rate_max; k++) {
				rate_boxes[k] = new JCheckBox(String.format("%d baud", AltosLib.ao_telemetry_rate_values[k]));
				c.gridy = y_offset_rate + k;
				pane.add(rate_boxes[k], c);
				rate_boxes[k].setActionCommand("rate");
				rate_boxes[k].addActionListener(this);
				rate_boxes[k].setSelected((scanning_rate & (1 << k)) != 0);
			}
			y_offset_rate += AltosLib.ao_telemetry_rate_max + 1;
		}

		if (select_telemetry) {
			c.gridy = 2;
			c.gridx = check_x++;
			pane.add(telemetry_label, c);

			int	scanning_telemetry = AltosUIPreferences.scanning_telemetry();
			telemetry_boxes = new JCheckBox[AltosLib.ao_telemetry_max - AltosLib.ao_telemetry_min + 1];
			for (int k = AltosLib.ao_telemetry_min; k <= AltosLib.ao_telemetry_max; k++) {
				int j = k - AltosLib.ao_telemetry_min;
				telemetry_boxes[j] = new JCheckBox(AltosLib.telemetry_name(k));
				c.gridy = y_offset_telem + j;
				pane.add(telemetry_boxes[j], c);
				telemetry_boxes[j].setActionCommand("telemetry");
				telemetry_boxes[j].addActionListener(this);
				telemetry_boxes[j].setSelected((scanning_telemetry & (1 << k)) != 0);
			}
			y_offset_telem += (AltosLib.ao_telemetry_max - AltosLib.ao_telemetry_min + 1);
		}

		int y_offset = Math.max(y_offset_rate, y_offset_telem);

		list = new JList<AltosScanResult>(results) {
				//Subclass JList to workaround bug 4832765, which can cause the
				//scroll pane to not let the user easily scroll up to the beginning
				//of the list.  An alternative would be to set the unitIncrement
				//of the JScrollBar to a fixed value. You wouldn't get the nice
				//aligned scrolling, but it should work.
				public int getScrollableUnitIncrement(Rectangle visibleRect,
								      int orientation,
								      int direction) {
					int row;
					if (orientation == SwingConstants.VERTICAL &&
					    direction < 0 && (row = getFirstVisibleIndex()) != -1) {
						Rectangle r = getCellBounds(row, row);
						if ((r.y == visibleRect.y) && (row != 0))  {
							Point loc = r.getLocation();
							loc.y--;
							int prevIndex = locationToIndex(loc);
							Rectangle prevR = getCellBounds(prevIndex, prevIndex);

							if (prevR == null || prevR.y >= r.y) {
								return 0;
							}
							return prevR.height;
						}
					}
					return super.getScrollableUnitIncrement(
						visibleRect, orientation, direction);
				}
			};

		list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
		list.setLayoutOrientation(JList.HORIZONTAL_WRAP);
		list.setVisibleRowCount(-1);

		list.addMouseListener(new MouseAdapter() {
				 public void mouseClicked(MouseEvent e) {
					 if (e.getClickCount() == 2) {
						 monitor_button.doClick(); //emulate button click
					 }
				 }
			});
		JScrollPane listScroller = new JScrollPane(list);
		listScroller.setPreferredSize(new Dimension(400, 80));
		listScroller.setAlignmentX(LEFT_ALIGNMENT);

		//Create a container so that we can add a title around
		//the scroll pane.  Can't add a title directly to the
		//scroll pane because its background would be white.
		//Lay out the label and scroll pane from top to bottom.
		JPanel listPane = new JPanel();
		listPane.setLayout(new BoxLayout(listPane, BoxLayout.PAGE_AXIS));

		JLabel label = new JLabel("Select Device");
		label.setLabelFor(list);
		listPane.add(label);
		listPane.add(Box.createRigidArea(new Dimension(0,5)));
		listPane.add(listScroller);
		listPane.setBorder(BorderFactory.createEmptyBorder(10,10,10,10));

		c.fill = GridBagConstraints.BOTH;
		c.anchor = GridBagConstraints.CENTER;
		c.insets = i;
		c.weightx = 1;
		c.weighty = 1;

		c.gridx = 0;
		c.gridy = y_offset;
		c.gridwidth = 2;
		c.anchor = GridBagConstraints.CENTER;

		pane.add(listPane, c);

		cancel_button = new JButton("Cancel");
		cancel_button.addActionListener(this);
		cancel_button.setActionCommand("cancel");

		c.fill = GridBagConstraints.NONE;
		c.anchor = GridBagConstraints.CENTER;
		c.insets = i;
		c.weightx = 1;
		c.weighty = 1;

		c.gridx = 0;
		c.gridy = y_offset + 1;
		c.gridwidth = 1;
		c.anchor = GridBagConstraints.CENTER;

		pane.add(cancel_button, c);

		monitor_button = new JButton("Monitor");
		monitor_button.addActionListener(this);
		monitor_button.setActionCommand("monitor");

		c.fill = GridBagConstraints.NONE;
		c.anchor = GridBagConstraints.CENTER;
		c.insets = i;
		c.weightx = 1;
		c.weighty = 1;

		c.gridx = 1;
		c.gridy = y_offset + 1;
		c.gridwidth = 1;
		c.anchor = GridBagConstraints.CENTER;

		pane.add(monitor_button, c);

		pack();
		setLocationRelativeTo(owner);

		addWindowListener(new ConfigListener(this));

		setVisible(true);
	}
}