Class WindowsPowerSourceJNA

java.lang.Object

oshi.hardware.common.AbstractPowerSource

oshi.hardware.common.platform.windows.WindowsPowerSource

oshi.hardware.platform.windows.WindowsPowerSourceJNA

All Implemented Interfaces:

PowerSource

@ThreadSafe
public final class WindowsPowerSourceJNA
extends WindowsPowerSource

JNA-based Windows power source implementation.

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 inherited from class WindowsPowerSource

BATTERY_CAPACITY_RELATIVE, BATTERY_CHARGING, BATTERY_DEVICE_NAME_LEVEL, BATTERY_DISCHARGING, BATTERY_ESTIMATED_TIME_LEVEL, BATTERY_INFORMATION_LEVEL, BATTERY_IS_SHORT_TERM, BATTERY_MANUFACTURE_DATE_LEVEL, BATTERY_MANUFACTURE_NAME_LEVEL, BATTERY_POWER_ON_LINE, BATTERY_SERIAL_NUMBER_LEVEL, BATTERY_SYSTEM_BATTERY, BATTERY_TEMPERATURE_LEVEL, IOCTL_BATTERY_QUERY_INFORMATION, IOCTL_BATTERY_QUERY_STATUS, IOCTL_BATTERY_QUERY_TAG

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

Constructor

Description

WindowsPowerSourceJNA(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)

Method Summary

Modifier and Type	Method	Description
static List<PowerSource>	getPowerSources()	Gets Battery Information.
protected List<PowerSource>	queryPowerSources()	Returns a fresh list of power sources for this platform, used by AbstractPowerSource.updateAttributes().

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, 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.
String	toString()
boolean	updateAttributes()	Updates statistics on this battery.

Methods inherited from class Object

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

Constructor Details

WindowsPowerSourceJNA

public WindowsPowerSourceJNA(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)

Method Details

queryPowerSources

protected List<PowerSource> queryPowerSources()

Description copied from class: AbstractPowerSource

Returns a fresh list of power sources for this platform, used by AbstractPowerSource.updateAttributes(). Each concrete subclass implements this by delegating to its own static getPowerSources() factory method.

Specified by:

queryPowerSources in class AbstractPowerSource

Returns:

A list of PowerSource objects representing batteries, etc.

getPowerSources

public static List<PowerSource> getPowerSources()

Gets Battery Information.

Returns:

A list of PowerSource objects representing batteries, etc.