Battery<Battery>

RepCap Settings

# Range: Ix1 .. Ix2
rc = driver.sense.base.battery.repcap_battery_get()
driver.sense.base.battery.repcap_battery_set(repcap.Battery.Ix1)

SCPI Command:

SENSe:BASE:BATTery:AVAilable
SENSe:BASE:BATTery:CAPacity
SENSe:BASE:BATTery:TTD
SENSe:BASE:BATTery:USAGe

class BatteryCls[source]

Battery commands group definition. 5 total commands, 1 Subgroups, 4 group commands Repeated Capability: Battery, default value after init: Battery.Ix1

get_available() → bool[source]

# SCPI: SENSe:BASE:BATTery:AVAilable
value: bool = driver.sense.base.battery.get_available()

Queries if at least one battery is inserted.

return:

batt_available: OFF | ON OFF: No battery inserted ON: One or two batteries inserted

get_capacity() → float[source]

# SCPI: SENSe:BASE:BATTery:CAPacity
value: float = driver.sense.base.battery.get_capacity()

Queries the total capacity (sum of available batteries) .

return:

batt_capacity: Range: 0 % to 100 %, Unit: %

get_ttd() → int[source]

# SCPI: SENSe:BASE:BATTery:TTD
value: int = driver.sense.base.battery.get_ttd()

Queries the estimated total remaining runtime for the sum of all available batteries. The value is calculated from the total capacity and the current discharge rate of the used battery.

return:

ttd: Time until discharged Unit: s

get_usage() → List[BatteryUsage][source]

# SCPI: SENSe:BASE:BATTery:USAGe
value: List[enums.BatteryUsage] = driver.sense.base.battery.get_usage()

Queries the state of both slots of the battery compartment. Two values are returned: <BattUsage>slot 1, <BattUsage>slot 2

return:

batt_usage: NAV | REMovable | USED NAV Slot empty REMovable Battery inserted but currently not used - can be removed USED Battery currently used - do not remove it

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.sense.base.battery.clone()

Subgroups

Info