org.sensingkit.sensingkitlib.data

Class SKBatteryData

java.lang.Object

org.sensingkit.sensingkitlib.data.SKAbstractData

org.sensingkit.sensingkitlib.data.SKBatteryData

All Implemented Interfaces:

SKSensorData

public class SKBatteryData
extends SKAbstractData

An instance of SKBatteryData encapsulates Battery properties

Field Summary

Fields

Modifier and Type	Field and Description
protected int	health
protected int	level
protected int	plugged
protected int	scale
protected int	status
protected int	temperature
protected int	voltage

Fields inherited from class org.sensingkit.sensingkitlib.data.SKAbstractData

sensorType, timestamp

Constructor Summary

Constructors

Constructor and Description
SKBatteryData(long timestamp, int level, int scale, int temperature, int voltage, int plugged, int status, int health) Initialize the instance

Method Summary

Methods

Modifier and Type	Method and Description
int	getBatteryHealth() Get the battery health
java.lang.String	getBatteryHealthString() Get the battery health in string format
int	getBatteryStatus() Get the battery status
java.lang.String	getBatteryStatusString() Get the battery status in string format
java.lang.String	getDataInCSV() Get the battery properties in csv format
int	getLevel() Get the battery level
float	getLevelRatio() Get the battery charge
int	getPlugged() Get the battery plugged state
java.lang.String	getPluggedString() Get the battery plugged state in string format
int	getScale() Get the battery scale
int	getTemperature() Get the battery temperature
int	getVoltage() Get the battery voltage

Methods inherited from class org.sensingkit.sensingkitlib.data.SKAbstractData

getSensorType, getTimestamp, toString

Methods inherited from class java.lang.Object

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

Field Detail

level

protected final int level

scale

protected final int scale

temperature

protected final int temperature

voltage

protected final int voltage

plugged

protected final int plugged

status

protected final int status

health

protected final int health

Constructor Detail

SKBatteryData

public SKBatteryData(long timestamp,
             int level,
             int scale,
             int temperature,
             int voltage,
             int plugged,
             int status,
             int health)

Initialize the instance

Parameters:

timestamp - Time in milliseconds (the difference between the current time and midnight, January 1, 1970 UTC)

level - Indicates the current battery charge level. Value ranges from 0 to maximum battery level

scale - Maximum battery level

temperature - Current battery temperature

voltage - Current battery voltage

plugged - Values are: 0 - on battery, BATTERY_PLUGGED_AC, BATTERY_PLUGGED_USB, BATTERY_PLUGGED_WIRELESS

status - Values are: BATTERY_STATUS_CHARGING, BATTERY_STATUS_DISCHARGING, BATTERY_STATUS_FULL, BATTERY_STATUS_NOT_CHARGING, BATTERY_STATUS_UNKNOWN

health - Values are: BATTERY_HEALTH_COLD, BATTERY_HEALTH_DEAD, BATTERY_HEALTH_GOOD, BATTERY_HEALTH_OVERHEAT, BATTERY_HEALTH_OVER_VOLTAGE, BATTERY_HEALTH_UNKNOWN

Method Detail

getDataInCSV

public java.lang.String getDataInCSV()

Get the battery properties in csv format

Returns:

String containing the battery properties in csv format: timestamp,charge,temperature, voltage, plugged string ("usb", "ac", "wireless" or "unknown"), status string ("charging", "discharging", "full", "not charging", "unknown" or "unsupported"), health string ("cold", "dead", "good", "over heat", "over voltage", "unknown", "failure" or "unsupported")

getLevelRatio

public float getLevelRatio()

Get the battery charge

Returns:

charge (level/scale)

getLevel

public int getLevel()

Get the battery level

Returns:

level

getScale

public int getScale()

Get the battery scale

Returns:

scale

getTemperature

public int getTemperature()

Get the battery temperature

Returns:

temperature

getVoltage

public int getVoltage()

Get the battery voltage

Returns:

voltage

getPlugged

public int getPlugged()

Get the battery plugged state

Returns:

plugged

getBatteryStatus

public int getBatteryStatus()

Get the battery status

Returns:

status

getBatteryHealth

public int getBatteryHealth()

Get the battery health

Returns:

health

getPluggedString

public java.lang.String getPluggedString()

Get the battery plugged state in string format

Returns:

plugged in string format

getBatteryStatusString

public java.lang.String getBatteryStatusString()

Get the battery status in string format

Returns:

status in string format

getBatteryHealthString

public java.lang.String getBatteryHealthString()

Get the battery health in string format

Returns:

health in string format