com.kuka.roboticsAPI.controllerModel.sunrise.state.kmp
Interface IMobilePlatformBatteryState

All Known Implementing Classes:

VoltaboxBatteryState

public interface IMobilePlatformBatteryState

Interface of mobile platform battery state.

Method Summary

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].
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.

Method Detail

getLoadCycles

long getLoadCycles()

Gets the load cycles of the battery.

Returns:

Load cycles.

getOperatingHours

long getOperatingHours()

Gets the operating hours of the battery.

Returns:

Operating hours.

getStateOfCharge

long getStateOfCharge()

Gets the battery state of charge [%].

Returns:

Current battery percentage.

getStateOfHealth

long getStateOfHealth()

Gets the battey state of health.

Returns:

State of health.

getTotalCurrent

double getTotalCurrent()

Gets the charging current [A].

Returns:

Charging current in amperes.

isChargingActive

boolean isChargingActive()

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

Returns:

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

isChargerConnected

boolean isChargerConnected()

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

Returns:

true if charger is connected, false otherwise.

isChargingEnabled

boolean isChargingEnabled()

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

Returns:

true if the charging is enabled, false otherwise.

isChargingRelayEnabled

boolean isChargingRelayEnabled()

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

Returns:

true if the charging relay is enabled, false otherwise.

getBatteryWarningState

MobilePlatformBatteryWarningState getBatteryWarningState()

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

Returns:

battery warning state

getFirmwareVersionYear

long getFirmwareVersionYear()

Gets the battery management system's firmware version.

Returns:

Year of firmware version.

getFirmwareVersionMonth

long getFirmwareVersionMonth()

Gets the battery management system's firmware version.

Returns:

Month of firmware version.

getFirmwareVersionDay

long getFirmwareVersionDay()

Gets the battery management system's firmware version.

Returns:

Day of firmware version.

getIsReferenceChargeNeeded

long getIsReferenceChargeNeeded()

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

Returns:

Is reference charge needed.