Complete event based example request

grunzasr commented 4 years ago

A complete example of an event based reading and writing application would be really helpful. The code snippets in the Usage area are useful but without a complete example, I have missed something. I am not getting events (the code did not hit a break point in the event handler code) but there is data to be read ( the bytesAvailable() method returns greater than zero).

I am a beginning Java programmer (30+ years of C and assembly) so it is probably a simple mistake but I cannot find it. A complete example would allow me to verify my code has all the pieces it is supposed to have.

youcanwin2088 commented 3 years ago

/*

SerialPortTest.java
Created on: Feb 27, 2015
Last Updated on: Feb 20, 2020
Author: Will Hedgecock
Copyright (C) 2012-2020 Fazecast, Inc.
This file is part of jSerialComm.
jSerialComm is free software: you can redistribute it and/or modify
it under the terms of either the Apache Software License, version 2, or
the GNU Lesser General Public License as published by the Free Software
Foundation, version 3 or above.
jSerialComm 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.
You should have received a copy of both the GNU Lesser General Public
License and the Apache Software License along with jSerialComm. If not,
see http://www.gnu.org/licenses/ and http://www.apache.org/licenses/. */

package com.fazecast.jSerialComm;

import java.io.InputStream; import java.util.Scanner;

/**

This class provides a test case for the jSerialComm library.
@author Will Hedgecock <will.hedgecock@gmail.com>
@version 2.6.2
@see java.io.InputStream
@see java.io.OutputStream */ public class SerialPortTest { private static final class PacketListener implements SerialPortPacketListener { @Override public int getListeningEvents() { return SerialPort.LISTENING_EVENT_DATA_RECEIVED; } @Override public void serialEvent(SerialPortEvent event) { byte[] newData = event.getReceivedData(); System.out.println("Received data of size: " + newData.length); for (int i = 0; i < newData.length; ++i) System.out.print((char)newData[i]); System.out.println("\n"); } @Override public int getPacketSize() { return 100; } }

private static final class MessageListener implements SerialPortMessageListener { public String byteToHex(byte num) { char[] hexDigits = new char[2]; hexDigits[0] = Character.forDigit((num >> 4) & 0xF, 16); hexDigits[1] = Character.forDigit((num & 0xF), 16); return new String(hexDigits); } @Override public int getListeningEvents() { return SerialPort.LISTENING_EVENT_DATA_RECEIVED; } @Override public void serialEvent(SerialPortEvent event) { byte[] byteArray = event.getReceivedData(); StringBuffer hexStringBuffer = new StringBuffer(); for (int i = 0; i < byteArray.length; i++) hexStringBuffer.append(byteToHex(byteArray[i])); System.out.println("Received the following message: " + hexStringBuffer.toString()); } @Override public byte[] getMessageDelimiter() { return new byte[]{ (byte)0xB5, (byte)0x62 }; } @Override public boolean delimiterIndicatesEndOfMessage() { return false; } }

static public void main(String[] args) { System.out.println("\nUsing Library Version v" + SerialPort.getVersion()); SerialPort[] ports = SerialPort.getCommPorts(); System.out.println("\nAvailable Ports:\n"); for (int i = 0; i < ports.length; ++i) System.out.println(" [" + i + "] " + ports[i].getSystemPortName() + ": " + ports[i].getDescriptivePortName() + " - " + ports[i].getPortDescription()); SerialPort ubxPort; System.out.print("\nChoose your desired serial port or enter -1 to specify a port directly: "); int serialPortChoice = 0; try { Scanner inputScanner = new Scanner(System.in); serialPortChoice = inputScanner.nextInt(); inputScanner.close(); } catch (Exception e) {} if (serialPortChoice == -1) { String serialPortDescriptor = ""; System.out.print("\nSpecify your desired serial port descriptor: "); try { Scanner inputScanner = new Scanner(System.in); serialPortDescriptor = inputScanner.nextLine(); inputScanner.close(); } catch (Exception e) {} ubxPort = SerialPort.getCommPort(serialPortDescriptor); } else ubxPort = ports[serialPortChoice]; byte[] readBuffer = new byte[2048]; System.out.println("\nPre-setting RTS: " + (ubxPort.setRTS() ? "Success" : "Failure")); boolean openedSuccessfully = ubxPort.openPort(0); System.out.println("\nOpening " + ubxPort.getSystemPortName() + ": " + ubxPort.getDescriptivePortName() + " - " + ubxPort.getPortDescription() + ": " + openedSuccessfully); if (!openedSuccessfully) return; System.out.println("Setting read timeout mode to non-blocking"); ubxPort.setBaudRate(115200); ubxPort.setComPortTimeouts(SerialPort.TIMEOUT_NONBLOCKING, 1000, 0); try { for (int i = 0; i < 3; ++i) { System.out.println("\nReading #" + i); System.out.println("Available: " + ubxPort.bytesAvailable()); int numRead = ubxPort.readBytes(readBuffer, readBuffer.length); System.out.println("Read " + numRead + " bytes."); } } catch (Exception e) { e.printStackTrace(); } System.out.println("\nSetting read timeout mode to semi-blocking with a timeout of 200ms"); ubxPort.setComPortTimeouts(SerialPort.TIMEOUT_READ_SEMI_BLOCKING, 200, 0); try { for (int i = 0; i < 3; ++i) { System.out.println("\nReading #" + i); System.out.println("Available: " + ubxPort.bytesAvailable()); int numRead = ubxPort.readBytes(readBuffer, readBuffer.length); System.out.println("Read " + numRead + " bytes."); } } catch (Exception e) { e.printStackTrace(); } System.out.println("\nSetting read timeout mode to semi-blocking with no timeout"); ubxPort.setComPortTimeouts(SerialPort.TIMEOUT_READ_SEMI_BLOCKING, 0, 0); try { for (int i = 0; i < 3; ++i) { System.out.println("\nReading #" + i); System.out.println("Available: " + ubxPort.bytesAvailable()); int numRead = ubxPort.readBytes(readBuffer, readBuffer.length); System.out.println("Read " + numRead + " bytes."); } } catch (Exception e) { e.printStackTrace(); } System.out.println("\nSetting read timeout mode to blocking with a timeout of 100ms"); ubxPort.setComPortTimeouts(SerialPort.TIMEOUT_READ_BLOCKING, 100, 0); try { for (int i = 0; i < 3; ++i) { System.out.println("\nReading #" + i); System.out.println("Available: " + ubxPort.bytesAvailable()); int numRead = ubxPort.readBytes(readBuffer, readBuffer.length); System.out.println("Read " + numRead + " bytes."); } } catch (Exception e) { e.printStackTrace(); } System.out.println("\nSetting read timeout mode to blocking with no timeout"); ubxPort.setComPortTimeouts(SerialPort.TIMEOUT_READ_BLOCKING, 0, 0); try { for (int i = 0; i < 3; ++i) { System.out.println("\nReading #" + i); System.out.println("Available: " + ubxPort.bytesAvailable()); int numRead = ubxPort.readBytes(readBuffer, readBuffer.length); System.out.println("Read " + numRead + " bytes."); } } catch (Exception e) { e.printStackTrace(); } System.out.println("\nSwitching over to event-based reading"); System.out.println("\nListening for any amount of data available\n"); ubxPort.addDataListener(new SerialPortDataListener() { @Override public int getListeningEvents() { return SerialPort.LISTENING_EVENT_DATA_AVAILABLE; } @Override public void serialEvent(SerialPortEvent event) { SerialPort comPort = event.getSerialPort(); System.out.println("Available: " + comPort.bytesAvailable() + " bytes."); byte[] newData = new byte[comPort.bytesAvailable()]; int numRead = comPort.readBytes(newData, newData.length); System.out.println("Read " + numRead + " bytes."); } }); try { Thread.sleep(5000); } catch (Exception e) {} ubxPort.removeDataListener(); System.out.println("\nNow listening for full 100-byte data packets\n"); PacketListener listener = new PacketListener(); ubxPort.addDataListener(listener); try { Thread.sleep(5000); } catch (Exception e) {} ubxPort.removeDataListener(); System.out.println("\nNow listening for byte-delimited binary messages\n"); MessageListener messageListener = new MessageListener(); ubxPort.addDataListener(messageListener); try { Thread.sleep(5000); } catch (Exception e) {} ubxPort.removeDataListener(); System.out.println("\n\nClosing " + ubxPort.getDescriptivePortName() + ": " + ubxPort.closePort()); try { Thread.sleep(1000); } catch (InterruptedException e1) { e1.printStackTrace(); } System.out.println("Reopening " + ubxPort.getDescriptivePortName() + ": " + ubxPort.openPort() + "\n"); ubxPort.setComPortTimeouts(SerialPort.TIMEOUT_READ_BLOCKING, 1000, 0); InputStream in = ubxPort.getInputStream(); try { for (int j = 0; j < 1000; ++j) System.out.print((char)in.read()); in.close(); } catch (Exception e) { e.printStackTrace(); } System.out.println("\n\nClosing " + ubxPort.getDescriptivePortName() + ": " + ubxPort.closePort()); openedSuccessfully = ubxPort.openPort(0); System.out.println("Reopening " + ubxPort.getSystemPortName() + ": " + ubxPort.getDescriptivePortName() + ": " + openedSuccessfully); if (!openedSuccessfully) return; System.out.println("Unplug the device sometime in the next 10 seconds to ensure that it closes properly...\n"); ubxPort.setComPortTimeouts(SerialPort.TIMEOUT_READ_BLOCKING, 0, 0); ubxPort.addDataListener(new SerialPortDataListener() { @Override public int getListeningEvents() { return SerialPort.LISTENING_EVENT_DATA_AVAILABLE; } @Override public void serialEvent(SerialPortEvent event) { SerialPort comPort = event.getSerialPort(); System.out.println("Available: " + comPort.bytesAvailable() + " bytes."); byte[] newData = new byte[comPort.bytesAvailable()]; int numRead = comPort.readBytes(newData, newData.length); System.out.println("Read " + numRead + " bytes."); } }); try { Thread.sleep(10000); } catch (Exception e) {} ubxPort.removeDataListener(); System.out.println("\n\nClosing " + ubxPort.getDescriptivePortName() + ": " + ubxPort.closePort());
```
/*System.out.println("\n\nAttempting to read from two serial ports simultaneously\n");
System.out.println("\nAvailable Ports:\n");
for (int i = 0; i < ports.length; ++i)
    System.out.println("   [" + i + "] " + ports[i].getSystemPortName() + ": " + ports[i].getDescriptivePortName() + " - " + ports[i].getPortDescription());
SerialPort ubxPort2;
System.out.print("\nChoose your second desired serial port, or enter -1 to skip this test: ");
serialPortChoice = 0;
try {
    Scanner inputScanner = new Scanner(System.in);
    serialPortChoice = inputScanner.nextInt();
    inputScanner.close();
} catch (Exception e) {}
if (serialPortChoice != -1)
{
    ubxPort2 = ports[serialPortChoice];
    ubxPort2.openPort();
    try
    {
        System.out.print("\nReading from first serial port...\n\n");
        in = ubxPort.getInputStream();
        InputStream in2 = ubxPort2.getInputStream();
        for (int j = 0; j < 1000; ++j)
            System.out.print((char)in.read());
        System.out.print("\nReading from second serial port...\n\n");
        for (int j = 0; j < 100; ++j)
            System.out.print((char)in2.read());
        System.out.print("\nReading from first serial port again...\n\n");
        for (int j = 0; j < 1000; ++j)
            System.out.print((char)in.read());
        in.close();
        in2.close();
    }
    catch (SerialPortIOException e) { e.printStackTrace(); }
    catch (Exception e) { e.printStackTrace(); }
}
System.out.println("\n\nEntering Java-based InputStream in Scanner mode and reading 200 lines\n");
ubxPort.setComPortTimeouts(SerialPort.TIMEOUT_SCANNER, 0, 0);
Scanner scanner = new Scanner(ubxPort.getInputStream());
for (int i = 1; i < 201; ++i)
    if (scanner.hasNextLine())
        System.out.println("Full Line #" + i + ": " + scanner.nextLine());
scanner.close();
System.out.println("\n\nClosing " + ubxPort.getDescriptivePortName() + ": " + ubxPort.closePort());*/
```
} }

hedgecrw commented 3 years ago

Please see the comment in this thread for a complete example. This code is located in the source directory under src/test/java/com/fazecast/jSerialComm.

Fazecast / jSerialComm

Complete event based example request #304