Class WindowsPowerSource

java.lang.Object

oshi.hardware.common.AbstractPowerSource

oshi.hardware.common.platform.windows.WindowsPowerSource

All Implemented Interfaces:

PowerSource

Direct Known Subclasses:

WindowsPowerSourceJNA

@ThreadSafe
public abstract class WindowsPowerSource
extends AbstractPowerSource

A Power Source

Nested Class Summary

Nested classes/interfaces inherited from interface PowerSource

PowerSource.CapacityUnits

Modifier and Type	Interface	Description
static enum	PowerSource.CapacityUnits	Units of Battery Capacity

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	BATTERY_CAPACITY_RELATIVE	Battery capability flag: capacity is relative (percent).
protected static final int	BATTERY_CHARGING	Battery power state flag: charging.
protected static final int	BATTERY_DEVICE_NAME_LEVEL	Query information level: device name.
protected static final int	BATTERY_DISCHARGING	Battery power state flag: discharging.
protected static final int	BATTERY_ESTIMATED_TIME_LEVEL	Query information level: estimated time remaining.
protected static final int	BATTERY_INFORMATION_LEVEL	Query information level: battery information.
protected static final int	BATTERY_IS_SHORT_TERM	Battery capability flag: short-term (UPS).
protected static final int	BATTERY_MANUFACTURE_DATE_LEVEL	Query information level: manufacture date.
protected static final int	BATTERY_MANUFACTURE_NAME_LEVEL	Query information level: manufacturer name.
protected static final int	BATTERY_POWER_ON_LINE	Battery power state flag: AC power online.
protected static final int	BATTERY_SERIAL_NUMBER_LEVEL	Query information level: serial number.
protected static final int	BATTERY_SYSTEM_BATTERY	Battery capability flag: system battery.
protected static final int	BATTERY_TEMPERATURE_LEVEL	Query information level: temperature.
protected static final int	IOCTL_BATTERY_QUERY_INFORMATION	IOCTL code to query battery information.
protected static final int	IOCTL_BATTERY_QUERY_STATUS	IOCTL code to query battery status.
protected static final int	IOCTL_BATTERY_QUERY_TAG	IOCTL code to query battery tag.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WindowsPowerSource(String psName, String psDeviceName, double psRemainingCapacityPercent, double psTimeRemainingEstimated, double psTimeRemainingInstant, double psPowerUsageRate, double psVoltage, double psAmperage, boolean psPowerOnLine, boolean psCharging, boolean psDischarging, PowerSource.CapacityUnits psCapacityUnits, int psCurrentCapacity, int psMaxCapacity, int psDesignCapacity, int psCycleCount, String psChemistry, LocalDate psManufactureDate, String psManufacturer, String psSerialNumber, double psTemperature)	Constructor.

Method Summary

Methods inherited from class AbstractPowerSource

getAmperage, getCapacityUnits, getChemistry, getCurrentCapacity, getCycleCount, getDesignCapacity, getDeviceName, getManufactureDate, getManufacturer, getMaxCapacity, getName, getPowerUsageRate, getRemainingCapacityPercent, getSerialNumber, getTemperature, getTimeRemainingEstimated, getTimeRemainingInstant, getVoltage, isCharging, isDischarging, isPowerOnLine, queryPowerSources, toString, updateAttributes

Modifier and Type	Method	Description
double	getAmperage()	Amperage of the battery, in milliAmperes (mA).
PowerSource.CapacityUnits	getCapacityUnits()	Reports =the units of PowerSource.getCurrentCapacity(), PowerSource.getMaxCapacity(), and PowerSource.getDesignCapacity()
String	getChemistry()	The battery chemistry (e.g., Lithium Ion).
int	getCurrentCapacity()	The current (remaining) capacity of the battery.
int	getCycleCount()	The cycle count of the battery, if known.
int	getDesignCapacity()	The design (original) capacity of the battery.
String	getDeviceName()	Name of the power source at the device level.
LocalDate	getManufactureDate()	The battery's date of manufacture.
String	getManufacturer()	The name of the battery's manufacturer.
int	getMaxCapacity()	The maximum capacity of the battery.
String	getName()	Name of the power source at the Operating System level.
double	getPowerUsageRate()	Power Usage Rate of the battery, in milliWatts (mW).
double	getRemainingCapacityPercent()	Estimated remaining capacity as a fraction of max capacity.
String	getSerialNumber()	The battery's serial number.
double	getTemperature()	The battery's temperature, in degrees Celsius.
double	getTimeRemainingEstimated()	Estimated time remaining on the power source, in seconds, as reported by the operating system.
double	getTimeRemainingInstant()	Estimated time remaining on the power source, in seconds, as reported by the battery.
double	getVoltage()	Voltage of the battery, in Volts.
boolean	isCharging()	Reports whether the battery is charging.
boolean	isDischarging()	Reports whether the battery is discharging.
boolean	isPowerOnLine()	Reports whether the device is plugged in to an external power source.
protected abstract List<PowerSource>	queryPowerSources()	Returns a fresh list of power sources for this platform, used by AbstractPowerSource.updateAttributes().
String	toString()
boolean	updateAttributes()	Updates statistics on this battery.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

IOCTL_BATTERY_QUERY_TAG

protected static final int IOCTL_BATTERY_QUERY_TAG

IOCTL code to query battery tag.

See Also:

• Constant Field Values

IOCTL_BATTERY_QUERY_INFORMATION

protected static final int IOCTL_BATTERY_QUERY_INFORMATION

IOCTL code to query battery information.

See Also:

• Constant Field Values

IOCTL_BATTERY_QUERY_STATUS

protected static final int IOCTL_BATTERY_QUERY_STATUS

IOCTL code to query battery status.

See Also:

• Constant Field Values

BATTERY_SYSTEM_BATTERY

protected static final int BATTERY_SYSTEM_BATTERY

Battery capability flag: system battery.

See Also:

• Constant Field Values

BATTERY_IS_SHORT_TERM

protected static final int BATTERY_IS_SHORT_TERM

Battery capability flag: short-term (UPS).

See Also:

• Constant Field Values

BATTERY_CAPACITY_RELATIVE

protected static final int BATTERY_CAPACITY_RELATIVE

Battery capability flag: capacity is relative (percent).

See Also:

• Constant Field Values

BATTERY_POWER_ON_LINE

protected static final int BATTERY_POWER_ON_LINE

Battery power state flag: AC power online.

See Also:

• Constant Field Values

BATTERY_DISCHARGING

protected static final int BATTERY_DISCHARGING

Battery power state flag: discharging.

See Also:

• Constant Field Values

BATTERY_CHARGING

protected static final int BATTERY_CHARGING

Battery power state flag: charging.

See Also:

• Constant Field Values

BATTERY_INFORMATION_LEVEL

protected static final int BATTERY_INFORMATION_LEVEL

Query information level: battery information.

See Also:

• Constant Field Values

BATTERY_TEMPERATURE_LEVEL

protected static final int BATTERY_TEMPERATURE_LEVEL

Query information level: temperature.

See Also:

• Constant Field Values

BATTERY_ESTIMATED_TIME_LEVEL

protected static final int BATTERY_ESTIMATED_TIME_LEVEL

Query information level: estimated time remaining.

See Also:

• Constant Field Values

BATTERY_DEVICE_NAME_LEVEL

protected static final int BATTERY_DEVICE_NAME_LEVEL

Query information level: device name.

See Also:

• Constant Field Values

BATTERY_MANUFACTURE_DATE_LEVEL

protected static final int BATTERY_MANUFACTURE_DATE_LEVEL

Query information level: manufacture date.

See Also:

• Constant Field Values

BATTERY_MANUFACTURE_NAME_LEVEL

protected static final int BATTERY_MANUFACTURE_NAME_LEVEL

Query information level: manufacturer name.

See Also:

• Constant Field Values

BATTERY_SERIAL_NUMBER_LEVEL

protected static final int BATTERY_SERIAL_NUMBER_LEVEL

Query information level: serial number.

See Also:

• Constant Field Values

Constructor Details

WindowsPowerSource

protected WindowsPowerSource(String psName,
 String psDeviceName,
 double psRemainingCapacityPercent,
 double psTimeRemainingEstimated,
 double psTimeRemainingInstant,
 double psPowerUsageRate,
 double psVoltage,
 double psAmperage,
 boolean psPowerOnLine,
 boolean psCharging,
 boolean psDischarging,
 PowerSource.CapacityUnits psCapacityUnits,
 int psCurrentCapacity,
 int psMaxCapacity,
 int psDesignCapacity,
 int psCycleCount,
 String psChemistry,
 LocalDate psManufactureDate,
 String psManufacturer,
 String psSerialNumber,
 double psTemperature)

Constructor.

Parameters:

psName - the psName

psDeviceName - the psDeviceName

psRemainingCapacityPercent - the psRemainingCapacityPercent

psTimeRemainingEstimated - the psTimeRemainingEstimated

psTimeRemainingInstant - the psTimeRemainingInstant

psPowerUsageRate - the psPowerUsageRate

psVoltage - the psVoltage

psAmperage - the psAmperage

psPowerOnLine - the psPowerOnLine

psCharging - the psCharging

psDischarging - the psDischarging

psCapacityUnits - the psCapacityUnits

psCurrentCapacity - the psCurrentCapacity

psMaxCapacity - the psMaxCapacity

psDesignCapacity - the psDesignCapacity

psCycleCount - the psCycleCount

psChemistry - the psChemistry

psManufactureDate - the psManufactureDate

psManufacturer - the psManufacturer

psSerialNumber - the psSerialNumber

psTemperature - the psTemperature