isabella232 / serial-communication-manager

Forked from RishiGupta12/serial-communication-manager

Serial communication manager (SCM)

The 'serial communication manager (abbreviated as scm)' is an easy to use java library for communication over serial port. It supports RS-232 control signals handshaking, monitoring and has been ported to Linux, MAC, and Windows operating system for both 32 bit and 64 bit. It is consistent, portable, efficient, reliable, testable, extensible, modifiable, scalable and feature rich library. It has been also ported to ARM platform (Embedded SE Java).

It is powerfully configurable for both poll and event driven application designs be it low volume low frequency data or high volume high frequency data.

It eliminates the complexities of serial port programming for different operating systems, allowing engineers to concentrate on their application logic.

##Features MODERN

• Notification on USB Hotplug, calls listener whenever a USB-UART IC is added/removed.
• Find COM port assigned to a USB device dynamically from USB-IF VID, PID and serial number.
• Find information about all USB devices connected to system.
• Custom baud rate setting and high baud rates (3 Mbps) settings supported.
• Both polling based and event listener based data/event read supported.
• IOCTL calls for GPIO control and power management.
• USB HID class API for communicating with composite USB devices like MCP2200, CP2110 etc.
• Find which driver is driving a particular serial port.
• Completely port re-entrant, allowing it to be time-sliced.
• USB power related information reporting like selective suspend or auto suspend.
• Direct byte buffer API for transferring large data fastly.

LEGACY

• Access to EIA232 standard DTR, CD, CTS, RTS and DSR signals.
• Hardware and software flow-control options.

OTHERS

• Vendor libraries like D2XX from ftdi, SimpleIO from microchip, USBXpress from silicon labs etc supported.
• X/Y/Z FTP API with finite state machine, progress listener for GUI applications, text/binary mode, abort command and send/receive in parallel.
• Extraction of shared libraries at user defined locations for isolated environment and security.
• Input and Output byte stream (blocking and non-blocking) for serial port communication.
• CRC and other utility class for common functions for quick application development.
• Optimized read and write methods for single byte, multiple byte or string sending/receiving.

PROJECT

• Functional, stress, stability, unit tested (Junit for continuous integration).
• Application specific parameters tuning for performance with and without modification of drivers.
• Maven repository release for maven integration.
• Extensive error detection and handling for reliable operations.
• Fully Optimized for power, performance and memory.
• Support for fault tolerant and recoverable application design.
• Extensively documented both Java (online javadocs) and C code.
• Scripts for quickly building and testing project.

##Getting started

The folder prebuilt-release contains ready-to-use jar file (scm-1.0.3.jar) that can be imported in any project and referenced right away.

package example;
import com.embeddedunveiled.serial.SerialComManager;
import com.embeddedunveiled.serial.SerialComManager.BAUDRATE;
import com.embeddedunveiled.serial.SerialComManager.DATABITS;
import com.embeddedunveiled.serial.SerialComManager.FLOWCONTROL;
import com.embeddedunveiled.serial.SerialComManager.PARITY;
import com.embeddedunveiled.serial.SerialComManager.STOPBITS;

public class Example {
	public static void main(String[] args) {
		try {
			SerialComManager scm = new SerialComManager();
			long handle = scm.openComPort("/dev/ttyUSB1", true, true, false);
			scm.configureComPortData(handle, DATABITS.DB_8, STOPBITS.SB_1, PARITY.P_NONE, BAUDRATE.B115200, 0);
			scm.configureComPortControl(handle, FLOWCONTROL.NONE, 'x', 'x', false, false);
			scm.writeString(handle, "testing hello", 0) == true);
			String data = scm.readString(handle);
			System.out.println("data read is :" + data);
			scm.closeComPort(handle);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

##Wiki, Java docs, Example usage, Build guide, Discussion, Trouble shooting

http://www.embeddedunveiled.com/

##Help the project grow !

• Suggest features and enhancements
• Report bugs and fixes
• Help with missing documentation
• Suggest more test cases
• Publish an article on your blog to educate others about this project

##Author, License, and Copyright The 'serial communication manager (scm)' is designed, developed and maintained by Rishi gupta. The Linkdin profile of the author can be found here : http://in.linkedin.com/pub/rishi-gupta/20/9b8/a10

This library is licensed under the LGPL, See LICENSE AND COPYING for full license text.