com.embeddedunveiled.serial.hid.SerialComHIDdevice Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scm Show documentation
serial communication in java
The newest version!
/*
 * Author : Rishi Gupta
 * 
 * This file is part of 'serial communication manager' library.
 * Copyright (C) <2014-2016>  
 *
 * This 'serial communication manager' is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by the Free Software 
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * The 'serial communication manager' 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with 'serial communication manager'.  If not, see .
 */

package com.embeddedunveiled.serial.hid;

import com.embeddedunveiled.serial.SerialComException;
import com.embeddedunveiled.serial.util.SerialComUtil;


/**
 * Represents a HID device with information about it.
 * 
 * @author Rishi Gupta
 */
public final class SerialComHIDdevice {

	private final String transport;
	private final String deviceNode;
	private final String idVendor;
	private final String idProduct;
	private final String serial;
	private final String product;
	private final String manufacturer;
	private final String location;

	/**
	 * Construct and allocates a new SerialComHIDdevice object with given details.
	 * 
	 * @param transport communication medium USB or Bluetooth this devices uses.
	 * @param deviceNode identifier that can be used to open this device.
	 * @param idVendor USB-IF unique vendor id of this device.
	 * @param idProduct USB product id of this device.
	 * @param serial serial number of this device.
	 * @param product product identifier/description of this device.
	 * @param manufacturer company manufacturing of this device.
	 * @param location location in device tree created dynamically.
	 * @throws SerialComException if the object can not be constructed.
	 */
	public SerialComHIDdevice(String transport, String deviceNode, String idVendor, String idProduct, 
			String serial, String product, String manufacturer, String location) {
		this.transport = transport;
		this.deviceNode = deviceNode;
		this.idVendor = idVendor;
		this.idProduct = idProduct;
		this.serial = serial;
		this.product = product;
		this.manufacturer = manufacturer;
		this.location = location;
	}

	/** 
	 * Returns USB or Bluetooth i.e. transport this device uses.
	 * 
	 * @return USB or Bluetooth string whichever is applicable for this device.
	 */
	public String getTransportType() {
		return transport;
	}

	/** 
	 * Returns device node representing this device in system.
	 * 
	 * In MAC os x, there is no device file for HID devices like '/dev/xxx'. Devices are identified 
	 * by their usage or other properties. Therefore to maintain consistency, we create device node 
	 * string with various properties separated by underscore : 
	 * Transport_USB-VID_USB-PID_USB-serialnumber_LocationID
	 * 
	 * @return string device node.
	 */
	public String getDeviceNode() {
		return deviceNode;
	}

	/** 
	 * Retrieves the vendor id of the USB device.
	 * 
	 * @return vendor id of the USB device or -1 if location ID is not applicable for this platform.
	 * @throws NumberFormatException if the USB vendor id hex string can not be converted into numerical 
	 *          representation.
	 */
	public int getVendorID() {
		if("---".equals(idVendor)) {
			return -1;
		}
		return (int) SerialComUtil.hexStrToLongNumber(idVendor);
	}

	/** 
	 * Retrieves the product id of the USB device.
	 * 
	 * @return product id of the USB device or -1 if location ID is not applicable for this platform.
	 * @throws NumberFormatException if the USB product id hex string can not be converted into numerical 
	 *          representation.
	 */
	public int getProductID() {
		if("---".equals(idProduct)) {
			return -1;
		}
		return (int) SerialComUtil.hexStrToLongNumber(idProduct);
	}

	/** 
	 * Retrieves the serial number string of the USB device.
	 * 
	 * @return serial number string of the USB device.
	 */
	public String getSerialNumber() {
		return serial;
	}

	/** 
	 * Retrieves the product string of the USB device.
	 * 
	 * @return serial number string of the USB device.
	 */
	public String getProductString() {
		return product;
	}

	/** 
	 * Retrieves the manufacturer string of the USB device.
	 * 
	 * @return serial number string of the USB device.
	 */
	public String getManufacturerString() {
		return manufacturer;
	}

	/** 
	 * Retrieves the location of the USB device in system.
	 * 
	 * @return location information about this device.
	 */
	public String getLocation() {
		return location;
	}

	/** 
	 * Prints information about this device on console.
	 */
	public void dumpDeviceInfo() {
		System.out.println(
				"Transport : " + transport +
				"\nDevice node : " + deviceNode +
				"\nVendor id : 0x" + idVendor + 
				"\nProduct id : 0x" + idProduct + 
				"\nSerial number : " + serial + 
				"\nProduct : " + product + 
				"\nManufacturer : " + manufacturer +
				"\nLocation : " + location);
	}
}