com.fazecast.jSerialComm.SerialPortEvent Maven / Gradle / Ivy
/*
* SerialPortEvent.java
*
* Created on: Feb 25, 2015
* Last Updated on: Jun 08, 2022
* Author: Will Hedgecock
*
* Copyright (C) 2012-2022 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
* This constructor should only be used when the {@link SerialPortEvent} does not contain any data bytes.
*
* Valid serial event types are:
*
* {@link SerialPort#LISTENING_EVENT_DATA_AVAILABLE}
* {@link SerialPort#LISTENING_EVENT_DATA_RECEIVED}
* {@link SerialPort#LISTENING_EVENT_DATA_WRITTEN}
* {@link SerialPort#LISTENING_EVENT_PORT_DISCONNECTED}
* {@link SerialPort#LISTENING_EVENT_BREAK_INTERRUPT}
* {@link SerialPort#LISTENING_EVENT_CARRIER_DETECT}
* {@link SerialPort#LISTENING_EVENT_CTS}
* {@link SerialPort#LISTENING_EVENT_DSR}
* {@link SerialPort#LISTENING_EVENT_RING_INDICATOR}
* {@link SerialPort#LISTENING_EVENT_FRAMING_ERROR}
* {@link SerialPort#LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR}
* {@link SerialPort#LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR}
* {@link SerialPort#LISTENING_EVENT_PARITY_ERROR}
*
* Note that event-based write callbacks are only supported on Windows operating systems. As such, the {@link SerialPort#LISTENING_EVENT_DATA_WRITTEN}
* event will never be called on a non-Windows system.
*
* Also, most control line status and error events from {@link SerialPort#LISTENING_EVENT_BREAK_INTERRUPT} to {@link SerialPort#LISTENING_EVENT_PARITY_ERROR}
* are unlikely to function the same across different operating systems or serial devices on the same operating system, if they work properly at all.
*
* @param comPort The {@link SerialPort} about which this object is being created.
* @param serialEventType The type of serial port event that this object describes.
* @see SerialPort#LISTENING_EVENT_DATA_AVAILABLE
* @see SerialPort#LISTENING_EVENT_DATA_RECEIVED
* @see SerialPort#LISTENING_EVENT_DATA_WRITTEN
* @see SerialPort#LISTENING_EVENT_PORT_DISCONNECTED
* @see SerialPort#LISTENING_EVENT_BREAK_INTERRUPT
* @see SerialPort#LISTENING_EVENT_CARRIER_DETECT
* @see SerialPort#LISTENING_EVENT_CTS
* @see SerialPort#LISTENING_EVENT_DSR
* @see SerialPort#LISTENING_EVENT_RING_INDICATOR
* @see SerialPort#LISTENING_EVENT_FRAMING_ERROR
* @see SerialPort#LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR
* @see SerialPort#LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR
* @see SerialPort#LISTENING_EVENT_PARITY_ERROR
*/
public SerialPortEvent(SerialPort comPort, int serialEventType)
{
super(comPort);
eventType = serialEventType;
serialData = null;
}
/**
* Constructs a {@link SerialPortEvent} object corresponding to the specified serial event type and containing the passed-in data bytes.
*
* Valid serial event types are:
*
* {@link SerialPort#LISTENING_EVENT_DATA_AVAILABLE}
* {@link SerialPort#LISTENING_EVENT_DATA_RECEIVED}
* {@link SerialPort#LISTENING_EVENT_DATA_WRITTEN}
* {@link SerialPort#LISTENING_EVENT_PORT_DISCONNECTED}
* {@link SerialPort#LISTENING_EVENT_BREAK_INTERRUPT}
* {@link SerialPort#LISTENING_EVENT_CARRIER_DETECT}
* {@link SerialPort#LISTENING_EVENT_CTS}
* {@link SerialPort#LISTENING_EVENT_DSR}
* {@link SerialPort#LISTENING_EVENT_RING_INDICATOR}
* {@link SerialPort#LISTENING_EVENT_FRAMING_ERROR}
* {@link SerialPort#LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR}
* {@link SerialPort#LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR}
* {@link SerialPort#LISTENING_EVENT_PARITY_ERROR}
*
* Note that event-based write callbacks are only supported on Windows operating systems. As such, the {@link SerialPort#LISTENING_EVENT_DATA_WRITTEN}
* event will never be called on a non-Windows system.
*
* Also, most control line status and error events from {@link SerialPort#LISTENING_EVENT_BREAK_INTERRUPT} to {@link SerialPort#LISTENING_EVENT_PARITY_ERROR}
* are unlikely to function the same across different operating systems or serial devices on the same operating system, if they work properly at all.
*
* @param comPort The {@link SerialPort} about which this object is being created.
* @param serialEventType The type of serial port event that this object describes.
* @param data The raw data bytes corresponding to this serial port event.
* @see SerialPort#LISTENING_EVENT_DATA_AVAILABLE
* @see SerialPort#LISTENING_EVENT_DATA_RECEIVED
* @see SerialPort#LISTENING_EVENT_DATA_WRITTEN
* @see SerialPort#LISTENING_EVENT_PORT_DISCONNECTED
* @see SerialPort#LISTENING_EVENT_BREAK_INTERRUPT
* @see SerialPort#LISTENING_EVENT_CARRIER_DETECT
* @see SerialPort#LISTENING_EVENT_CTS
* @see SerialPort#LISTENING_EVENT_DSR
* @see SerialPort#LISTENING_EVENT_RING_INDICATOR
* @see SerialPort#LISTENING_EVENT_FRAMING_ERROR
* @see SerialPort#LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR
* @see SerialPort#LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR
* @see SerialPort#LISTENING_EVENT_PARITY_ERROR
*/
public SerialPortEvent(SerialPort comPort, int serialEventType, byte[] data)
{
super(comPort);
eventType = serialEventType;
serialData = data;
}
/**
* Returns a string representation of the type of event represented by this object.
*
* @return A string representation of the type of event represented by this object.
*/
@Override
public final String toString() {
switch(eventType) {
case SerialPort.LISTENING_EVENT_DATA_AVAILABLE: return "LISTENING_EVENT_DATA_AVAILABLE";
case SerialPort.LISTENING_EVENT_DATA_RECEIVED: return "LISTENING_EVENT_DATA_RECEIVED";
case SerialPort.LISTENING_EVENT_DATA_WRITTEN: return "LISTENING_EVENT_DATA_WRITTEN";
case SerialPort.LISTENING_EVENT_PORT_DISCONNECTED: return "LISTENING_EVENT_PORT_DISCONNECTED";
case SerialPort.LISTENING_EVENT_BREAK_INTERRUPT: return "LISTENING_EVENT_BREAK_INTERRUPT";
case SerialPort.LISTENING_EVENT_CARRIER_DETECT: return "LISTENING_EVENT_CARRIER_DETECT";
case SerialPort.LISTENING_EVENT_CTS: return "LISTENING_EVENT_CTS";
case SerialPort.LISTENING_EVENT_DSR: return "LISTENING_EVENT_DSR";
case SerialPort.LISTENING_EVENT_RING_INDICATOR: return "LISTENING_EVENT_RING_INDICATOR";
case SerialPort.LISTENING_EVENT_FRAMING_ERROR: return "LISTENING_EVENT_FRAMING_ERROR";
case SerialPort.LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR: return "LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR";
case SerialPort.LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR: return "LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR";
case SerialPort.LISTENING_EVENT_PARITY_ERROR: return "LISTENING_EVENT_PARITY_ERROR";
default: return "LISTENING_EVENT_UNKNOWN_TYPE";
}
}
/**
* Returns the {@link SerialPort} that triggered this event.
*
* @return The {@link SerialPort} that triggered this event.
*/
public final SerialPort getSerialPort() { return (SerialPort)source; }
/**
* Returns the type of serial port events that caused this object to be created.
*
* Return value will be a bitmask containing one or more of the following items OR'd together:
*
* {@link SerialPort#LISTENING_EVENT_DATA_AVAILABLE}
* {@link SerialPort#LISTENING_EVENT_DATA_RECEIVED}
* {@link SerialPort#LISTENING_EVENT_DATA_WRITTEN}
* {@link SerialPort#LISTENING_EVENT_PORT_DISCONNECTED}
* {@link SerialPort#LISTENING_EVENT_BREAK_INTERRUPT}
* {@link SerialPort#LISTENING_EVENT_CARRIER_DETECT}
* {@link SerialPort#LISTENING_EVENT_CTS}
* {@link SerialPort#LISTENING_EVENT_DSR}
* {@link SerialPort#LISTENING_EVENT_RING_INDICATOR}
* {@link SerialPort#LISTENING_EVENT_FRAMING_ERROR}
* {@link SerialPort#LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR}
* {@link SerialPort#LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR}
* {@link SerialPort#LISTENING_EVENT_PARITY_ERROR}
*
* Note that event-based write callbacks are only supported on Windows operating systems. As such, the {@link SerialPort#LISTENING_EVENT_DATA_WRITTEN}
* event will never be called on a non-Windows system.
*
* Also, most control line status and error events from {@link SerialPort#LISTENING_EVENT_BREAK_INTERRUPT} to {@link SerialPort#LISTENING_EVENT_PARITY_ERROR}
* are unlikely to function the same across different operating systems or serial devices on the same operating system, if they work properly at all.
*
* @return The serial port event that this object describes.
* @see SerialPort#LISTENING_EVENT_DATA_AVAILABLE
* @see SerialPort#LISTENING_EVENT_DATA_RECEIVED
* @see SerialPort#LISTENING_EVENT_DATA_WRITTEN
* @see SerialPort#LISTENING_EVENT_PORT_DISCONNECTED
* @see SerialPort#LISTENING_EVENT_BREAK_INTERRUPT
* @see SerialPort#LISTENING_EVENT_CARRIER_DETECT
* @see SerialPort#LISTENING_EVENT_CTS
* @see SerialPort#LISTENING_EVENT_DSR
* @see SerialPort#LISTENING_EVENT_RING_INDICATOR
* @see SerialPort#LISTENING_EVENT_FRAMING_ERROR
* @see SerialPort#LISTENING_EVENT_FIRMWARE_OVERRUN_ERROR
* @see SerialPort#LISTENING_EVENT_SOFTWARE_OVERRUN_ERROR
* @see SerialPort#LISTENING_EVENT_PARITY_ERROR
*/
public final int getEventType() { return eventType; }
/**
* Returns any raw data bytes associated with this serial port event.
*
* @return Any data bytes associated with this serial port event or null if none exist.
*/
public final byte[] getReceivedData() { return serialData; }
}