com.kuka.roboticsAPI.controllerModel.sunrise.state.kmp
Class VoltaboxBatteryState

java.lang.Object
  com.kuka.roboticsAPI.controllerModel.sunrise.state.kmp.VoltaboxBatteryState

All Implemented Interfaces:

IMobilePlatformBatteryState

public class VoltaboxBatteryState
extends Object
implements IMobilePlatformBatteryState

Wrapper class for every info about the battery of KMP1500.

Nested Class Summary

static class

VoltaboxBatteryState.Builder Builds a VoltaboxBatteryState.

Constructor Summary

VoltaboxBatteryState()

Method Summary

boolean	equals(Object obj)
MobilePlatformBatteryWarningState	getBatteryWarningState() Gets the battery warning state [critical, warning, normal].
long	getFirmwareVersionDay() Gets the battery management system's firmware version.
long	getFirmwareVersionMonth() Gets the battery management system's firmware version.
long	getFirmwareVersionYear() Gets the battery management system's firmware version.
long	getIsReferenceChargeNeeded() Gets the state of reference charge, whether the reference charge is needed or not.
long	getLoadCycles() Gets the load cycles of the battery.
long	getOperatingHours() Gets the operating hours of the battery.
long	getStateOfCharge() Gets the battery state of charge [%].
long	getStateOfHealth() Gets the battey state of health.
double	getTotalCurrent() Gets the charging current [A].
int	hashCode()
boolean	isChargerConnected() Gets the state of charging, whether the charging is plugged in or not.
boolean	isChargingActive() Gets the state of charging, whether the charging is on or off.
boolean	isChargingEnabled() Gets the state of charging, whether the charing process is enabled or not.
boolean	isChargingRelayEnabled() Gets the state of charging, whether the charing relay is enabled or not.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VoltaboxBatteryState

public VoltaboxBatteryState()

Method Detail

getLoadCycles

public long getLoadCycles()

Description copied from interface: IMobilePlatformBatteryState

Gets the load cycles of the battery.

Specified by:

getLoadCycles in interface IMobilePlatformBatteryState

Returns:

Load cycles.

getOperatingHours

public long getOperatingHours()

Description copied from interface: IMobilePlatformBatteryState

Gets the operating hours of the battery.

Specified by:

getOperatingHours in interface IMobilePlatformBatteryState

Returns:

Operating hours.

getStateOfCharge

public long getStateOfCharge()

Description copied from interface: IMobilePlatformBatteryState

Gets the battery state of charge [%].

Specified by:

getStateOfCharge in interface IMobilePlatformBatteryState

Returns:

Current battery percentage.

getStateOfHealth

public long getStateOfHealth()

Description copied from interface: IMobilePlatformBatteryState

Gets the battey state of health.

Specified by:

getStateOfHealth in interface IMobilePlatformBatteryState

Returns:

State of health.

getTotalCurrent

public double getTotalCurrent()

Description copied from interface: IMobilePlatformBatteryState

Gets the charging current [A].

Specified by:

getTotalCurrent in interface IMobilePlatformBatteryState

Returns:

Charging current in amperes.

getBatteryWarningState

public MobilePlatformBatteryWarningState getBatteryWarningState()

Description copied from interface: IMobilePlatformBatteryState

Gets the battery warning state [critical, warning, normal].

Specified by:

getBatteryWarningState in interface IMobilePlatformBatteryState

Returns:

battery warning state

isChargingActive

public boolean isChargingActive()

Description copied from interface: IMobilePlatformBatteryState

Gets the state of charging, whether the charging is on or off.

Specified by:

isChargingActive in interface IMobilePlatformBatteryState

Returns:

true if the charging process is currently active, false otherwise.

isChargingEnabled

public boolean isChargingEnabled()

Description copied from interface: IMobilePlatformBatteryState

Gets the state of charging, whether the charing process is enabled or not.

Specified by:

isChargingEnabled in interface IMobilePlatformBatteryState

Returns:

true if the charging is enabled, false otherwise.

isChargingRelayEnabled

public boolean isChargingRelayEnabled()

Description copied from interface: IMobilePlatformBatteryState

Gets the state of charging, whether the charing relay is enabled or not.

Specified by:

isChargingRelayEnabled in interface IMobilePlatformBatteryState

Returns:

true if the charging relay is enabled, false otherwise.

isChargerConnected

public boolean isChargerConnected()

Description copied from interface: IMobilePlatformBatteryState

Gets the state of charging, whether the charging is plugged in or not.

Specified by:

isChargerConnected in interface IMobilePlatformBatteryState

Returns:

true if charger is connected, false otherwise.

getFirmwareVersionDay

public long getFirmwareVersionDay()

Description copied from interface: IMobilePlatformBatteryState

Gets the battery management system's firmware version.

Specified by:

getFirmwareVersionDay in interface IMobilePlatformBatteryState

Returns:

Day of firmware version.

getFirmwareVersionMonth

public long getFirmwareVersionMonth()

Description copied from interface: IMobilePlatformBatteryState

Gets the battery management system's firmware version.

Specified by:

getFirmwareVersionMonth in interface IMobilePlatformBatteryState

Returns:

Month of firmware version.

getFirmwareVersionYear

public long getFirmwareVersionYear()

Description copied from interface: IMobilePlatformBatteryState

Gets the battery management system's firmware version.

Specified by:

getFirmwareVersionYear in interface IMobilePlatformBatteryState

Returns:

Year of firmware version.

getIsReferenceChargeNeeded

public long getIsReferenceChargeNeeded()

Description copied from interface: IMobilePlatformBatteryState

Gets the state of reference charge, whether the reference charge is needed or not.

Specified by:

getIsReferenceChargeNeeded in interface IMobilePlatformBatteryState

Returns:

Is reference charge needed.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object