[python source code]

battery

The battery commands module.

These commands are used in the following models: MSO2

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries 
- BATTery:ACPOWer?
- BATTery:SLOT<1,2>:CHARGE?
- BATTery:SLOT<1,2>:INSTalled?
- BATTery:SLOT<1,2>:SERIALnumber?
- BATTery:SLOT<1,2>:TIMETOEMPty?
- BATTery:SLOT<1,2>:TIMETOFULL?

Battery

Bases: SCPICmdRead

The BATTery command tree.

Usage
  • Using the .query() method will send the BATTery? query.
  • Using the .verify(value) method will send the BATTery? query and raise an AssertionError if the returned value does not match value.
Properties
  • .acpower: The BATTery:ACPOWer command.
  • .slot: The BATTery:SLOT<1,2> command tree.

acpower property 

acpower: BatteryAcpower

Return the BATTery:ACPOWer command.

Description
  • This command queries the state of AC power being plugged in.
Usage
  • Using the .query() method will send the BATTery:ACPOWer? query.
  • Using the .verify(value) method will send the BATTery:ACPOWer? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:ACPOWer?

slot property 

slot: dict[int, BatterySlotItem]

Return the BATTery:SLOT<1,2> command tree.

Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>? query and raise an AssertionError if the returned value does not match value.
Sub-properties
  • .charge: The BATTery:SLOT<1,2>:CHARGE command.
  • .installed: The BATTery:SLOT<1,2>:INSTalled command.
  • .serialnumber: The BATTery:SLOT<1,2>:SERIALnumber command.
  • .timetoempty: The BATTery:SLOT<1,2>:TIMETOEMPty command.
  • .timetofull: The BATTery:SLOT<1,2>:TIMETOFULL command.

BatteryAcpower

Bases: SCPICmdRead

The BATTery:ACPOWer command.

Description
  • This command queries the state of AC power being plugged in.
Usage
  • Using the .query() method will send the BATTery:ACPOWer? query.
  • Using the .verify(value) method will send the BATTery:ACPOWer? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:ACPOWer?

BatterySlotItem

Bases: ValidatedDynamicNumberCmd, SCPICmdRead

The BATTery:SLOT<1,2> command tree.

Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>? query and raise an AssertionError if the returned value does not match value.
Properties
  • .charge: The BATTery:SLOT<1,2>:CHARGE command.
  • .installed: The BATTery:SLOT<1,2>:INSTalled command.
  • .serialnumber: The BATTery:SLOT<1,2>:SERIALnumber command.
  • .timetoempty: The BATTery:SLOT<1,2>:TIMETOEMPty command.
  • .timetofull: The BATTery:SLOT<1,2>:TIMETOFULL command.

charge property 

charge: BatterySlotItemCharge

Return the BATTery:SLOT<1,2>:CHARGE command.

Description
  • This command queries the current charge of the battery.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:CHARGE? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:CHARGE? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:CHARGE?

installed property 

installed: BatterySlotItemInstalled

Return the BATTery:SLOT<1,2>:INSTalled command.

Description
  • This command queries if a battery is installed.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:INSTalled? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:INSTalled? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:INSTalled?

serialnumber property 

serialnumber: BatterySlotItemSerialnumber

Return the BATTery:SLOT<1,2>:SERIALnumber command.

Description
  • This command queries the serial number of the battery.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:SERIALnumber? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:SERIALnumber? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:SERIALnumber?

timetoempty property 

timetoempty: BatterySlotItemTimetoempty

Return the BATTery:SLOT<1,2>:TIMETOEMPty command.

Description
  • This command queries the time to empty of the battery.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:TIMETOEMPty? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:TIMETOEMPty? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:TIMETOEMPty?

timetofull property 

timetofull: BatterySlotItemTimetofull

Return the BATTery:SLOT<1,2>:TIMETOFULL command.

Description
  • This command queries the time to full of the battery.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:TIMETOFULL? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:TIMETOFULL? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:TIMETOFULL?

BatterySlotItemCharge

Bases: SCPICmdRead

The BATTery:SLOT<1,2>:CHARGE command.

Description
  • This command queries the current charge of the battery.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:CHARGE? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:CHARGE? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:CHARGE?

BatterySlotItemInstalled

Bases: SCPICmdRead

The BATTery:SLOT<1,2>:INSTalled command.

Description
  • This command queries if a battery is installed.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:INSTalled? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:INSTalled? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:INSTalled?

BatterySlotItemSerialnumber

Bases: SCPICmdRead

The BATTery:SLOT<1,2>:SERIALnumber command.

Description
  • This command queries the serial number of the battery.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:SERIALnumber? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:SERIALnumber? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:SERIALnumber?

BatterySlotItemTimetoempty

Bases: SCPICmdRead

The BATTery:SLOT<1,2>:TIMETOEMPty command.

Description
  • This command queries the time to empty of the battery.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:TIMETOEMPty? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:TIMETOEMPty? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:TIMETOEMPty?

BatterySlotItemTimetofull

Bases: SCPICmdRead

The BATTery:SLOT<1,2>:TIMETOFULL command.

Description
  • This command queries the time to full of the battery.
Usage
  • Using the .query() method will send the BATTery:SLOT<1,2>:TIMETOFULL? query.
  • Using the .verify(value) method will send the BATTery:SLOT<1,2>:TIMETOFULL? query and raise an AssertionError if the returned value does not match value.
SCPI Syntax 
- BATTery:SLOT<1,2>:TIMETOFULL?