com.embeddedunveiled.serial.vendor.FTdevicelistInfoNode 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.vendor;

import com.embeddedunveiled.serial.util.SerialComUtil;

/**
 * Represents a FT_DEVICE_LIST_INFO_NODE structure.
 * 
 * @author Rishi Gupta
 */
public final class FTdevicelistInfoNode {

	private String flags = null;
	private String type = null;
	private String id = null;
	private String locId = null;
	private String serialNumber = null;
	private String description = null;
	private String ftHandle = null;

	/**
	 * Construct and allocates a new FTdevicelistInfoNode object with given details.
	 * 
	 * @param flags flags for this device.
	 * @param type device type.
	 * @param id device ID.
	 * @param locId location id of this device.
	 * @param serialNumber serial number of this device.
	 * @param description description of this device.
	 * @param ftHandle handle for this device.
	 */
	public FTdevicelistInfoNode(String flags, String type, String id, String locId, String serialNumber, 
			String description, String ftHandle) {
		this.flags = flags;
		this.type = type;
		this.id = id;
		this.locId = locId;
		this.serialNumber = serialNumber;
		this.description = description;
		this.ftHandle = ftHandle;
	}

	/** 
	 * Retrieves the flags for this FT device info node.
	 * 
	 * @return flags for this FT device info node.
	 * @throws NumberFormatException if the flags hex string can not be converted into numerical representation.
	 */
	public long getFlags() {
		return SerialComUtil.hexStrToLongNumber(flags);
	}

	/** 
	 * Interpret the flags of this device giving information about whether port is open or closed and 
	 * is it enumerated as high speed or full speed usb device.
	 * 
	 * @return Array of string with interpretation of this device flags field.
	 * @throws NumberFormatException if the flags hex string can not be converted into numerical representation.
	 */
	public String[] interpretFlags() {
		String[] info = new String[2];

		// The flag value is a 4-byte bit map containing miscellaneous data
		short flagBitMap = (short) SerialComUtil.hexStrToLongNumber(flags);

		// Bit 0 (least significant bit) of this number indicates if the port is open (1) or closed (0).
		if((0x01 & flagBitMap) == 0x01) {
			info[0] = new String("Port status : open");
		}else {
			info[0] = new String("Port status : closed");
		}

		// Bit 1 indicates if the device is enumerated as a high-speed USB device (2) or a full-speed USB device (0).
		if((0x02 & flagBitMap) == 0x02) {
			info[1] = new String("Enumerated as : high-speed USB device");
		}else {
			info[1] = new String("Enumerated as : full-speed USB device");
		}

		return info;
	}

	/** 
	 * Retrieves the type for this FT device info node.
	 * 
	 * @return type for this FT device info node.
	 * @throws NumberFormatException if the type hex string can not be converted into numerical representation.
	 */
	public long getType() {
		return SerialComUtil.hexStrToLongNumber(type);
	}

	/** 
	 * Retrieves the id for this FT device info node.
	 * 
	 * @return id for this FT device info node.
	 * @throws NumberFormatException if the id hex string can not be converted into numerical representation.
	 */
	public long getId() {
		return SerialComUtil.hexStrToLongNumber(id);
	}

	/** 
	 * Retrieves the locId for this FT device info node.
	 * 
	 * @return locId for this FT device info node.
	 * @throws NumberFormatException if the locId hex string can not be converted into numerical representation.
	 */
	public long getLocId() {
		return SerialComUtil.hexStrToLongNumber(locId);
	}

	/** 
	 * Retrieves the serial number string for this FT device info node.
	 * 
	 * @return serial number string for this FT device info node.
	 */
	public String getSerialNumber() {
		return serialNumber;
	}

	/** 
	 * Retrieves the description for this FT device info node.
	 * 
	 * @return description string for this FT device info node.
	 */
	public String getDescription() {
		return description;
	}

	/** 
	 * Retrieves the ftHandle for this FT device info node.
	 * 
	 * @return ftHandle for this FT device info node.
	 * @throws NumberFormatException if the ftHandle hex string can not be converted into numerical representation.
	 */
	public long getFThandle() {
		return SerialComUtil.hexStrToLongNumber(ftHandle);
	}

	/** 
	 * Prints information about this FT device info node on console.
	 */
	public void dumpDeviceInfo() {
		System.out.println("Flags : 0x" + flags + 
				"\nType : 0x" + type + 
				"\nID : 0x" + id + 
				"\nLocId : 0x" + locId + 
				"\nSerialNumber : " + serialNumber + 
				"\nDescription : " + description + 
				"\nftHandle : 0x" + ftHandle );
	}
}