class BatteryKey

class BatteryKey extends DJIKey

Package:	dji.keysdk
Inherits From:	`DJIKey`

Description:

BatteryKey is a key dedicated to accessing Battery related attributes.

Class Members:

Single Battery Products

method

create

method create

static BatteryKey create(@BatteryParamKey @NonNull String paramKey)

Package:

dji.keysdk

Description:

Creates a Battery key.

Input Parameters:

@BatteryParamKey @NonNull String paramKey

A valid paramKey.

Return:

static BatteryKey

Battery Key

Multi Battery Products

method

create

method create

static BatteryKey create(@BatteryParamKey @NonNull String paramKey,
                                   @IntRange(from = 0, to = MAX_COMPONENT_INDEX) int componentIndex)

Package:

dji.keysdk

Description:

Creates a battery key at selected index. Use this when the product supports multiple batteries.

Input Parameters:

@BatteryParamKey @NonNull String paramKey	A valid paramKey.
@IntRange(from = 0, to = MAX_COMPONENT_INDEX) int componentIndex	The index of the Battery component.

Return:

static BatteryKey

Battery Key

Battery AggregationKey

method

createBatteryAggregationKey

method createBatteryAggregationKey

static  BatteryKey createBatteryAggregationKey(@BatteryAggregationParamKey @NonNull String paramKey)

Package:

dji.keysdk

Description:

Creates a Battery Aggregation key.

Input Parameters:

@BatteryAggregationParamKey @NonNull String paramKey

A valid paramKey.

Return:

static BatteryKey An object of BatteryKey.

Inherited Methods:

Class Keys:

SELF_DISCHARGE_IN_DAYS
Access:	SET, GET
Type:	`Integer`
API:	`setSelfDischargeInDays`
	`getSelfDischargeInDays`
BATTERY_TYPE
Access:	GET
Type:	`DataSmartBatteryGetStaticData.SmartBatteryType`
API:	-
OVERVIEWS
Access:	GET
Type:	`BatteryOverview[]`
API:	`getBatteryOverviews`
	`BatteryOverview`
SELF_HEATING_STATE
Access:	GET
Type:	`SelfHeatingState`
API:	-
AGGREGATION_STATE
Access:	GET
Type:	`AggregationState`
API:	`AggregationState`
	`Callback`
	`setAggregationStateCallback`
	`onUpdate`
BATTERY_LEDS_ENABLED
Access:	SET, GET
Type:	`Boolean`
API:	-
LEVEL_2_CELL_VOLTAGE_BEHAVIOR
Access:	SET, GET
Type:	`LowVoltageBehavior`
API:	`setLevel2CellVoltageBehavior`
	`getLevel2CellVoltageBehavior`
	`LowVoltageBehavior`
LEVEL_2_CELL_VOLTAGE_THRESHOLD
Access:	SET, GET
Type:	`Integer`
API:	`setLevel2CellVoltageThreshold`
	`getLevel2CellVoltageThreshold`
FIRMWARE_VERSION
Access:	GET
Type:	`String`
API:	-
IS_BATTERY_SELF_HEATING
Access:	PUSH, GET
Type:	`ConnectionState`
API:	-
CURRENT
Access:	PUSH, GET
Type:	`Integer`
API:	`getCurrent`
	`getCurrent`
DESIGN_CAPACITY
Access:	GET
Type:	`Integer`
API:	-
IS_CELL_DAMAGED
Access:	GET
Type:	`Boolean`
API:	`isCellDamaged`
IS_FIRMWARE_DIFFERENCE_DETECTED
Access:	GET
Type:	`Boolean`
API:	`isFirmwareDifferenceDetected`
IS_LOW_CELL_VOLTAGE_DETECTED
Access:	PUSH, GET
Type:	`Boolean`
API:	`isLowCellVoltageDetected`
CHARGE_REMAINING
Access:	PUSH, GET
Type:	`Integer`
API:	`getChargeRemaining`
	`getChargeRemaining`
CHARGE_REMAINING_IN_PERCENT
Access:	PUSH, GET
Type:	`Integer`
API:	`getChargeRemainingInPercent`
	`getChargeRemainingInPercent`
HISTORICAL_WARNING_RECORDS
Access:	GET
Type:	`WarningRecord[]`
API:	`getWarningRecords`
	`WarningRecord`
LATEST_WARNING_RECORD
Access:	GET
Type:	`WarningRecord`
API:	`getLatestWarningRecord`
	`WarningRecord`
MANUFACTURE_DATE
Access:	GET
Type:	`Date`
API:	-
PAIR_BATTERIES
Access:	ACTION
Type:	`-`
API:	`pairBatteries`
IS_IN_SINGLE_BATTERY_MODE
Access:	PUSH
Type:	`Boolean`
API:	`isInSingleBatteryMode`
NUMBER_OF_DISCHARGES
Access:	PUSH, GET
Type:	`Integer`
API:	`getNumberOfDischarges`
CELL_VOLTAGES
Access:	GET
Type:	`Integer[]`
API:	`getCellVoltages`
TEMPERATURE
Access:	PUSH, GET
Type:	`Float`
API:	`getTemperature`
VOLTAGE
Access:	PUSH, GET
Type:	`Integer`
API:	`getVoltage`
	`getVoltage`
PAIRING_STATE
Access:	GET
Type:	`PairingState`
API:	`getPairingState`
	`PairingState`
LEVEL_1_CELL_VOLTAGE_BEHAVIOR
Access:	SET, GET
Type:	`LowVoltageBehavior`
API:	`setLevel1CellVoltageBehavior`
	`getLevel1CellVoltageBehavior`
	`LowVoltageBehavior`
CELL_VOLTAGE_LEVEL
Access:	PUSH
Type:	`BatteryCellVoltageLevel`
API:	`getCellVoltageLevel`
	`BatteryCellVoltageLevel`
IS_BIG_BATTERY
Access:	GET
Type:	`Boolean`
API:	-
CONNECTION_STATE
Access:	PUSH, GET
Type:	`ConnectionState`
API:	`ConnectionState`
NUMBER_OF_CONNECTED_BATTERIES
Access:	GET
Type:	`Integer`
API:	`getNumberOfConnectedBatteries`
FULL_CHARGE_CAPACITY
Access:	PUSH, GET
Type:	`Integer`
API:	`getFullChargeCapacity`
	`getFullChargeCapacity`
BATTERY_EMBED_OK
Access:	PUSH
Type:	`Boolean`
API:	-
IS_SMART_BATTERY
Access:	GET
Type:	`Boolean`
API:	`isSmartBattery`
SERIAL_NUMBER
Access:	GET
Type:	`String`
API:	-
NUMBER_OF_CELLS
Access:	SET, GET
Type:	`Integer`
API:	`getNumberOfCells`
	`setNumberOfCells`
LIFETIME_REMAINING
Access:	PUSH, GET
Type:	`Integer`
API:	`getLifetimeRemaining`
HIGHEST_TEMPERATURE
Access:	GET
Type:	`Integer`
API:	`getHighestTemperature`
LEVEL_1_CELL_VOLTAGE_THRESHOLD
Access:	SET, GET
Type:	`Integer`
API:	`setLevel1CellVoltageThreshold`
	`getLevel1CellVoltageThreshold`
IS_BEING_CHARGED
Access:	PUSH
Type:	`Boolean`
API:	`isBeingCharged`
IS_ANY_BATTERY_DISCONNECTED
Access:	GET
Type:	`Boolean`
API:	`isAnyBatteryDisconnected`
IS_VOLTAGE_DIFFERENCE_DETECTED
Access:	GET
Type:	`Boolean`
API:	`isVoltageDifferenceDetected`

Mobile SDK

class BatteryKey

Description:

Class Members:

method create

Description:

Input Parameters:

Return:

method create

Description:

Input Parameters:

Return:

method createBatteryAggregationKey

Description:

Input Parameters:

Return:

Inherited Methods:

Class Keys:

Search Mobile SDK Document

{{{(item.highlights && item.highlights.title) || item.title}}}