Class MacPowerSource

java.lang.Object

oshi.hardware.common.AbstractPowerSource

oshi.hardware.common.platform.mac.MacPowerSource

All Implemented Interfaces:

PowerSource

@ThreadSafe
public abstract class MacPowerSource
extends AbstractPowerSource

Abstract base for the macOS PowerSource. The AppleSmartBattery registry read and the per-power-source field computation are shared; the JNA and FFM subclasses supply an IOKitProvider and read the IOKit Power Sources (IOPS) list into MacPowerSource.PowerSourceData carriers via buildPowerSources(IOKitProvider, double, List, MacPowerSource.PowerSourceFactory).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MacPowerSource.PowerSourceData	Raw values read from a single IOKit Power Source (IOPS) dictionary by the JNA/FFM subclasses.
protected static interface	MacPowerSource.PowerSourceFactory	Creates a concrete (JNA or FFM) Mac power source from the computed battery fields.

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
protected	MacPowerSource(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 MacPowerSource.

Method Summary

Modifier and Type	Method	Description
protected static List<PowerSource>	buildPowerSources(IOKitProvider ioKit, double timeRemainingEstimated, List<MacPowerSource.PowerSourceData> sources, MacPowerSource.PowerSourceFactory factory)	Reads the AppleSmartBattery registry entry (via ioKit) and merges it with the per-source IOPS readings into a list of power sources.

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

Constructor Details

MacPowerSource

protected MacPowerSource(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 MacPowerSource.

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

Method Details

buildPowerSources

protected static List<PowerSource> buildPowerSources(IOKitProvider ioKit,
 double timeRemainingEstimated,
 List<MacPowerSource.PowerSourceData> sources,
 MacPowerSource.PowerSourceFactory factory)

Reads the AppleSmartBattery registry entry (via ioKit) and merges it with the per-source IOPS readings into a list of power sources.

Mac PowerSource information comes from two sources: the IORegistry's AppleSmartBattery entry (battery-wide fields, read here through the shared IOKitProvider) and the IOKit's IOPS functions (one entry per power source, read natively by the caller into sources).

Parameters:

ioKit - the IOKit provider backing the registry read

timeRemainingEstimated - the estimated time remaining (-1 unknown, -2 unlimited) from IOPS

sources - the present power sources read from the IOPS list

factory - creates the platform-specific instance

Returns:

a list of power sources, one per element of sources