Class LinuxPowerSource

java.lang.Object

oshi.hardware.common.AbstractPowerSource

oshi.hardware.common.platform.linux.LinuxPowerSource

All Implemented Interfaces:

PowerSource

Direct Known Subclasses:

LinuxPowerSourceJNA

@ThreadSafe
public class LinuxPowerSource
extends AbstractPowerSource

A Power Source

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	LinuxPowerSource.Prop	Power supply uevent properties from sysfs.

Nested classes/interfaces inherited from interface PowerSource

PowerSource.CapacityUnits

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	LinuxPowerSource(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)	Creates a LinuxPowerSource with the given parameters.
protected	LinuxPowerSource(LinuxPowerSource src)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
protected static LinuxPowerSource	buildPowerSource(String name, Map<LinuxPowerSource.Prop, String> props)	Builds a LinuxPowerSource from parsed uevent properties.
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

LinuxPowerSource

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

Creates a LinuxPowerSource with the given parameters.

Parameters:

psName - power source name

psDeviceName - device name

psRemainingCapacityPercent - remaining capacity percentage

psTimeRemainingEstimated - estimated time remaining

psTimeRemainingInstant - instant time remaining

psPowerUsageRate - power usage rate

psVoltage - voltage

psAmperage - amperage

psPowerOnLine - whether on AC power

psCharging - whether charging

psDischarging - whether discharging

psCapacityUnits - capacity units

psCurrentCapacity - current capacity

psMaxCapacity - max capacity

psDesignCapacity - design capacity

psCycleCount - cycle count

psChemistry - chemistry

psManufactureDate - manufacture date

psManufacturer - manufacturer

psSerialNumber - serial number

psTemperature - temperature

LinuxPowerSource

protected LinuxPowerSource(LinuxPowerSource src)

Copy constructor.

Parameters:

src - the source to copy from

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:

An array of PowerSource objects representing batteries, etc.

buildPowerSource

protected static LinuxPowerSource buildPowerSource(String name,
 Map<LinuxPowerSource.Prop, String> props)

Builds a LinuxPowerSource from parsed uevent properties.

Parameters:

name - the power supply name

props - the parsed properties map

Returns:

a new LinuxPowerSource instance