com.embeddedunveiled.serial.usb.SerialComUSBPowerInfo 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.usb;

import com.embeddedunveiled.serial.util.SerialComUtil;

/**
 * Encapsulates various power related information about a USB device.
 * 
 * @author Rishi Gupta
 */
public final class SerialComUSBPowerInfo {

	private String autoSuspendDelay;
	private String currentControlConfig;
	private String currentRuntimeStatus;
	private String isSelectiveSuspendSupported;
	private String isSelectiveSuspendEnabled;
	private String selectiveSuspendTimeoutValue;

	/**
	 * Construct and allocates a new SerialComUSBPowerInfo object with the given details.
	 * 
	 * @param autoSuspendDelay delay in milliseconds before USB device is suspended after inactivity.
	 * @param currentControlConfig value indicating whether device is to be kept on always or is allowed 
	 *         to suspend.
	 * @param currentRuntimeStatus current power status (on or suspended) of this USB device.
	 * @param isSelectiveSuspendSupported string indicating window's selective suspend supported or not.
	 * @param isSelectiveSuspendEnabled string indicating window's selective suspend is enabled or not.
	 * @param selectiveSuspendTimeoutValue string indicating window's selective suspend timeout value.
	 */
	public SerialComUSBPowerInfo(String autoSuspendDelay, String currentControlConfig, String currentRuntimeStatus,
			String isSelectiveSuspendSupported, String isSelectiveSuspendEnabled, String selectiveSuspendTimeoutValue) {
		this.autoSuspendDelay = autoSuspendDelay;
		this.currentControlConfig = currentControlConfig;
		this.currentRuntimeStatus = currentRuntimeStatus;
		this.isSelectiveSuspendSupported = isSelectiveSuspendSupported;
		this.isSelectiveSuspendEnabled = isSelectiveSuspendEnabled;
		this.selectiveSuspendTimeoutValue = selectiveSuspendTimeoutValue;
	}

	/** 
	 * Retrieves time after which this USB device will be allowed to auto suspend if idle.
	 * 
	 * @return time in milliseconds as string.
	 */
	public String getAutoSuspendDelay() {
		return autoSuspendDelay;
	}

	/** 
	 * Retrieves value indicating whether this USB device will be prevented from auto suspending or 
	 * is allowed to auto suspend.
	 * 
	 * @return current control setting string.
	 */
	public String getCurrentControlConfig() {
		return currentControlConfig;
	}

	/** 
	 * Retrieves value indicating whether this USB device is active or auto suspended.
	 * 
	 * @return current power status string.
	 */
	public String getCurrentRuntimeStatus() {
		return currentRuntimeStatus;
	}

	/** 
	 * Tells whether device support selective suspend or not.
	 * 
	 * @return true if selective suspend supported otherwise false.
	 */
	public Boolean isSelectiveSuspendSupported() {
		if(isSelectiveSuspendSupported.equals("true")) {
			return true;
		}
		return false;
	}

	/** 
	 * Tells whether selective suspend is enabled or not.
	 * 
	 * @return true if selective suspend is enabled otherwise false.
	 */
	public Boolean isSelectiveSuspendEnabled() {
		if(isSelectiveSuspendEnabled.equals("true")) {
			return true;
		}
		return false;
	}

	/** 
	 * Gives current selective suspend timeout value for this device.
	 * 
	 * @return timeout value.
	 * @throws NumberFormatException if the timeout value hex string can not be converted into 
	 *         numerical representation.
	 */
	public int getSelectiveSuspendTimeout() {
		if("---".equals(selectiveSuspendTimeoutValue)) {
			return 0;
		}
		return (int) SerialComUtil.hexStrToLongNumber(selectiveSuspendTimeoutValue);
	}

	/** 
	 * Prints information about power management of this USB device on console.
	 */
	public void dumpDevicePowerInfo() {
		System.out.println(
				"Auto suspend delay (ms) : " + autoSuspendDelay + 
				"\nControl configuration : " + currentControlConfig + 
				"\nCurrent power status : " + currentRuntimeStatus + 
				"\nIs selective suspend supported : " + isSelectiveSuspendSupported +
				"\nIs selective suspend enabled : " + isSelectiveSuspendEnabled +
				"\nSelective suspend timeout value : " + selectiveSuspendTimeoutValue);
	}
}