Returns the device identification string.
SCPI COMMAND REFERENCE
The Keithley 2308 is Keithley's battery/charger simulator in the Series 2300 — Model 2308 Portable Device Battery/Charger Simulator family. Its SCPI remote-control interface exposes 250 commands across 41 subsystems - 149 settable and 101 queries - and every command is documented here with its parameters, accepted values, return format, and a copy-paste PyVISA example for automating test and measurement.
250
Commands
149
Settable
101
Queries
41
Subsystems
SCPI
Verified
2026-07-16
All commands
Returns 0 if the instrument passes its internal self-test, or an error code if the test fails.
Recalls a saved setup to memory location SAV0-SAV3, or restores the RST defaults. For GPIB operation, setups are recalled using the *RCL command.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | RST | SAV0 | SAV1 | SAV2 | SAV3 | Setup location to recall. |
Saves the present power supply setup to a memory location. The available saved setups are SAV0 through SAV3.
| Name | Type | Values | Description |
|---|---|---|---|
| location | enum | SAV0 | SAV1 | SAV2 | SAV3 | Memory location to save the current setup to. |
Reads the status byte register. When *STB? is used, bit B6 is the MSS bit; during serial poll, the same byte uses B6 as the RQS bit.
Reads the service request enable register.
Sets or queries the standard event status enable register. The register enables individual standard event status bits such as power on, user request, command error, execution error, device-dependent error, query error, and operation complete.
| Name | Type | Values | Description |
|---|---|---|---|
| value | integer | 0 - 255 | Bit mask for the standard event status enable register. |
Triggers buffer data. The programming example shows it used after enabling the measurement event register to start buffer acquisition.
*TRG
Pauses execution until all previously received commands have finished executing, or until a parser/command error occurs.
Sets the power supply to default reset conditions.
*RST // Set the power supply to default reset conditions
Enables SRQ generation on error when the EAV bit is set. The manual shows the example `*SRE 4` for this use.
| Name | Type | Values | Description |
|---|---|---|---|
| value | integer | - | Sets the service request enable register value. |
*SRE 4
Returns the status byte. Test bit 2 (EAV) to see whether an error is available in the error queue.
Clears the status registers. Sending *CLS also clears the error queue and operation complete status.
Enables the operation complete bit in the standard event enable register. In the calibration workflow, sending *ESE 1 allows operation complete status to set ESB when *OPC is detected.
| Name | Type | Values | Description |
|---|---|---|---|
| value | integer | 0 - 255 | Bit mask written to the standard event enable register. |
Returns the contents of the standard event status register. Reading the response clears the standard event status register.
Used to indicate operation complete at the end of a calibration command sequence. It is typically sent immediately after a calibration command so the controller can detect when the step has finished.
:CAL:PROT:STEP0 14;*OPC
Operation complete query. The instrument places an ASCII 1 in the output queue when it has completed each step.
*OPC? :CAL:PROT:STEP0 14;*OPC?
Recalls a previously saved instrument state from nonvolatile memory. The command takes a register number as its single parameter.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | integer | 0 - 9 | Register number to recall. |
Reads the detected line frequency of the instrument's power input. The manual notes that line voltage and frequency are automatically sensed.
Selects the setup to use at power-up. The available choices are RST or SAV0-SAV3.
| Name | Type | Values | Description |
|---|---|---|---|
| setup | enum | RST | SAV0 | SAV1 | SAV2 | SAV3 | Power-on setup to select. |
Sets the auto zero state, which controls whether background readings are taken. Turning auto zero off improves measurement speed.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | 0 | 1 | OFF | ON | Enables or disables auto zero state. |
Sets or queries the Message Exchange Protocol (MEP) state. A returned value of 1 means MEP is enabled and the SCPI protocol is selected; 0 means MEP is disabled and the 488.1 protocol is selected.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | 1 | ON | 0 | OFF | Selects the GPIB protocol state. |
:SYSTem:MEP[:STATe]? :SYSTem:MEP[:STATe] <1 or ON> :SYSTem:MEP[:STATe] <0 or OFF>
Queries the state of Message Exchange Protocol (MEP) to determine whether SCPI or 488.1 protocol is enabled. A returned value of 1 means MEP is enabled (SCPI), and 0 means MEP is disabled (488.1).
:SYSTem:MEP[:STATe]?
Sets trigger-on-talk behavior. Set 1/ON to enable 2-reading trigger on talk, or 0/OFF to disable it and read the active channel.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | 1 | ON | 0 | OFF | Enables or disables trigger-on-talk mapping. |
Clears the error queue.
Reads and clears the oldest message in the error queue.
Queries the power line frequency setting.
Queries the power-on setup setting.
Queries the SCPI version level.
Queries the selected auto zero state.
Sets trigger continuous mode. Enabling it automatically turns the display off; disabling it turns the display back on.
| Name | Type | Values | Description |
|---|---|---|---|
| state | boolean | - | Enables (ON or 1) or disables (OFF or 0) trigger continuous mode. |
Queries the trigger continuous mode state. The mode enables automatic triggering and turns the display off; when disabled, the display turns back on.
Queries the trigger-on-talk setting.
Sets the current measurement range for the current function. The expected current range is specified in amps.
| Name | Type | Values | Description |
|---|---|---|---|
| upperopt | real | 0 - 5 | Specify the expected current in amps. |
Enables or disables auto range for the current measurement range.
| Name | Type | Values | Description |
|---|---|---|---|
| state | boolean | - | Turns auto ranging on or off. |
Set the current limit value for source channel 1. The range is 0.006 to 5 A with 100 µA resolution.
| Name | Type | Values | Description |
|---|---|---|---|
| n | real | 0.006 - 5 | Current limit value in amps. |
Sets the voltage amplitude for the specified source channel. The command applies to battery channel 1 when used as [SOURce[1]]:VOLTage, and the manual states the amplitude range is 0 to 15 V with 1 mV resolution.
| Name | Type | Values | Description |
|---|---|---|---|
| n | real | 0 - 15 | Voltage amplitude to set. |
Returns whether the current limit condition is active for the selected channel. With LIMit selected, it returns "1" when the power supply is operating as a constant-current source; with TRIP selected, it returns "1" if the output has tripped off due to current limit.
Specifies the output bandwidth for the battery channel. The command accepts HIGH or LOW bandwidth and can be programmed at any time.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | HIGH | LOW | Bandwidth setting. |
Sets the battery channel output impedance. This battery-channel-only command may be set while the output is ON or OFF.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 0 - 1 | Output impedance in ohms, in 0.01 Ω steps. |
OUTPut subsystem for battery channel #1.
| Name | Type | Values | Description |
|---|---|---|---|
| stateopt | enum | ON | OFF | Turn output ON or OFF. |
Specifies HIGH or LOW bandwidth for the output when the output is ON. When the output is OFF, the bandwidth is LOW and the user setting is not applied.
Queries the bandwidth setting for when the output is ON. The manual states that bandwidth can be HIGH or LOW, but does not document a returned value format for this query.
Specifies the output impedance to apply. The allowed range is 0 (OFF) to 1 Ω in 10 mΩ steps.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 0 - 1 | Output impedance value to apply. |
Queries the output impedance setting for output channel 1.
Closes or opens relay control circuit 1 for output channel 1. The manual states ONE closes the circuit and ZERO opens it.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | ONE | ZERO | Controls relay 1 control circuit state. |
Queries the value at relay 1 port pin digital I/O for output channel 1.
Turns output ON or OFF for output channel 1. The query returns the current output state.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | ON | OFF | Sets the output state. |
Queries the state of output 1. Returns whether the output is ON or OFF.
Sets or reads the averaging configuration for the specified sense channel. The manual slice indicates this is part of measurement configuration, but it does not document any syntax, parameters, or return value for this command on the provided page.
Selects the function for sense channel 1. The slice does not document the available function values or any query form for this command.
Sets the integration rate, in line cycles, for voltage and current measurements on channel 1. The allowed range is 0.002 to 10.
| Name | Type | Values | Description |
|---|---|---|---|
| n | real | 0.002 - 10 | Integration rate in line cycles for voltage and current measurements. |
Queries the average count for voltage and current on battery channel 1. The command is part of the SENSe subsystem for the battery channel.
Enable or disable auto range for the current measurement range. This command is part of the :SENSe[1]:CURRent[:DC]:RANGe path.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | OFF | ON | Turns auto ranging off or on. |
Queries whether auto range is enabled for the current measurement range. This is the query form of the current DC range auto setting.
Sets the upper current measurement range for the current measurement function. The value selects one of four ranges: 5 mA, 50 mA, 500 mA, or 5 A.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 5.0 | Range value used to change the current measurement range. |
Queries the upper current measurement range for the :SENSe[1]:CURRent[:DC]:RANGe subsystem. The range is based on one of four ranges designated by the current NRf setting.
Queries the selected measurement function for SENSe[1].
Queries the integration rate in line cycles for voltage and current on the selected battery channel. The rate applies to voltage and current measurements.
Specifies the average count for pulse-current measurements. This command belongs to the :SENSe[1]:PCURrent subsystem and is used to configure averaging for that measurement function.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | integer | 1 - 100 | Average count for pulse-current measurements when SYNC:STAT is ON. |
| NRf | integer | 1 - 5000 | Average count for pulse current digitization when SYNC:STAT is OFF. |
Queries the average count for pulse-current measurements. The count is dependent on SYNC:STATe.
Selects the pulse-current measurement mode. The available modes are HIGH, HIGH LOW, and AVERage.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | HIGH | HIGH LOW | AVERage | Pulse-current measurement mode. |
Queries the pulse-current measurement mode for the selected battery channel. The mode can be HIGH, HIGH LOW, or AVERage when set with the corresponding command.
Power supply sets the pulse-current integration times, accounting for internal trigger delay but not user delay (:DEL).
Sets the pulse-current high integration time. The value is applied when SYNC:STATe is ON and does not account for internal trigger delay or user delay.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 33.33E-06 - 0.8333 | Integration time for high pulse measurements. |
Queries the high pulse-current integration time for the pulse-current measurement function. The setting applies when SYNC:STATe is ON.
Sets the state for performing step measurements. The setting can be ON or OFF.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | OFF | ON | State for performing step measurements. |
Sets the step delay. The delay range is 0 ms to 100 ms in 10 ms steps.
| Name | Type | Values | Description |
|---|---|---|---|
| delay | real | 0msec - 100msec | Step delay value. |
Defines a delay sequence for step measurements using an index and a time value. Up to 19 delay sequence values can be specified.
| Name | Type | Values | Description |
|---|---|---|---|
| index | integer | 1 - 19 | Sequence index to set. |
| time | real | 0 - 100e-3 | Delay time value for the specified sequence index. |
Sets the number of DOWN steps for step measurements. The value range is 0 to 20, with a maximum of 1 for both up and down combined.
| Name | Type | Values | Description |
|---|---|---|---|
| count | integer | 0 - 20 | Number of DOWN steps. |
Queries the number of DOWN steps specified for step measurements.
Specify step integration time for UP plus DOWN steps. The allowed range is 33.3 µsec to 100 msec, with a default of 200 µsec.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 33.3µsec - 100msec | Step integration time for UP plus DOWN steps. |
Queries the step integration time specified for UP plus DOWN steps. The setting applies to step measurements in the SENSe:PCURrent:STEP subsystem.
Specifies the step timeout for all steps except the first step. The allowed range is 2 ms to 200 ms.
| Name | Type | Values | Description |
|---|---|---|---|
| time-out | real | 2ms - 200msec | Step TimeOUT for steps other than the first step. |
Sets the TimeOUT for the first step. The allowed range is 10 msec to 60 secs.
| Name | Type | Values | Description |
|---|---|---|---|
| value | real | 10msec - 60secs | TimeOUT for the first step. |
Queries the TimeOUT setting for the first step. This is the initial timeout value for step measurements; the manual gives a range of 10 msec to 60 s.
Queries the step TimeOUT setting for all steps but the first step.
Sets the number of UP steps for step measurements. The maximum is 20, with UP and DOWN combined limited to 20.
| Name | Type | Values | Description |
|---|---|---|---|
| count | integer | 0 - 20 | Number of UP steps specified. |
Queries the number of UP steps specified for step measurements.
Queries the state for performing step measurements.
Sets the integration time in seconds for pulse average measurements. The setting applies when SYNC:STATe is ON and does not include internal trigger delay or user delay.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 33.33E-05 - 0.8333 | Integration time for pulse average measurements. |
Queries the average integration time for pulse measurements when SYNC:STATe is ON.
Specifies the integration time in seconds for digitizing or burst measurements. This setting applies when SYNC:STATe is OFF, and the valid range is 33.33e-6 to 0.8333 s.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 33.33e-6 - 0.8333 | Integration time for digitizing or burst measurements. |
Queries the integration time for digitizing or burst measurements when SYNC:STATe is OFF.
Specifies the integration time in seconds for low pulse measurements when SYNC:STATe is ON. The setting neither includes internal trigger delay nor user delay.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 33.33E-06 - 0.8333 | Integration time for low pulse measurements. |
Queries the low integration time used for pulse measurements when SYNC:STATe is ON.
Queries the specified step delay setting for pulse current measurements or pulse current digitization, depending on the pulse measurement type. No separate return format is given beyond the fact that it is a query.
Sets the trigger level for each TLEV step. The step index x is 1–20, and maximum settings depend on the selected current range, so the current range must be selected before setting these values.
| Name | Type | Values | Description |
|---|---|---|---|
| value | real | 0.0 | Trigger level value for the specified TLEV step. |
Queries the trigger level for each TLEV step. x corresponds to steps 1 through 20.
Pulse detection triggering synchronization for pulse current measurements or digitization.
| Name | Type | Values | Description |
|---|---|---|---|
| stateopt | boolean | - | Selects pulse current measurements ON or OFF to select pulse current digitization. |
Specifies the trigger delay in seconds for pulse current synchronize operation. The valid range depends on whether pulse current measurements or pulse current digitization is selected.
| Name | Type | Values | Description |
|---|---|---|---|
| delay | real | 0.0 - 0.1 | Trigger delay in seconds for pulse current measurements. |
Queries the specified trigger delay for pulse current synchronization. The returned value depends on the synchronize state.
Sets the trigger level used by pulse current synchronization. The page shows the TLEVel subtree with range-specific subcommands for different current ranges, and notes that the current range must be selected before setting step trigger levels.
Sets the trigger level in amps for use on the 50 mA current range. The allowed range is 0.0 mA to 50 mA in 0.05 mA or 50 A steps.
| Name | Type | Values | Description |
|---|---|---|---|
| value | real | 0.0 mA - 50 mA | Trigger level to use on the 50 mA current range. |
Queries the trigger level in amps for use when on the 50 mA current range.
Sets the trigger level in amps for use on the 5 mA current range. The valid range is 0.0 mA to 5 mA in 0.005 mA or 5 μA steps.
| Name | Type | Values | Description |
|---|---|---|---|
| <NRf> | real | 0.0 mA - 5 mA | Trigger level for the 5 mA current range. |
Queries the trigger level in amps for use on the 5 mA current range. No short form exists for this query.
Sets the trigger level in amps for use when on the 500 mA current range. The allowed range is 0.0 mA to 500 mA in 0.5 mA or 500 μA steps.
| Name | Type | Values | Description |
|---|---|---|---|
| value | real | 0.0 mA - 500 mA | Trigger level used on the 500 mA current range. |
Queries the trigger level in amps for use on the 500 mA current range.
Sets the trigger level in amps for pulse current measurements on the 5 A current range. The manual states this level is 0.0 A to 5.0 A in 5 mA steps.
| Name | Type | Values | Description |
|---|---|---|---|
| ampopt | real | 0.0 A - 5.0 A | Trigger level in amps for use on the 5 A current range. |
Sets or queries the trigger level in amps for pulse current synchronization. The setting applies when using the 5 A current range.
Pulse detection triggering control for current measurements. The optional state selects pulse current measurements ON or OFF, or queries the present pulse current measurement type.
| Name | Type | Values | Description |
|---|---|---|---|
| stateopt | boolean | - | Send ON to select pulse current measurements or OFF to select pulse current digitization. |
Selects pulse current measurements or pulse current digitization for synchronize pulse detection triggering. The state is queried with :SENSe[1]:PCURrent:SYNChronize[:STATe]?
| Name | Type | Values | Description |
|---|---|---|---|
| stateopt | enum | ON | OFF | Select pulse current measurements or pulse current digitization. |
Enable or disable pulse current detection mode.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | OFF | ON | Turns pulse current detection mode on or off. |
Enables or disables pulse current detection mode, or queries the current detection mode setting.
Enables or disables pulse current fast readings.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | OFF | ON | Enable or disable pulse current fast readings. |
Queries the pulse current fast reading setting.
Sets the trigger edge used to start long integration measurements.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | RISING | FALLING | NEITHER | Selects the trigger edge. |
Sets the trigger edge used to start a long integration measurement.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | RISING | FALLING | NEITHER | Trigger edge to use for starting long integration measurements. |
Sets the integration time in seconds for long integration measurements. The valid range is X to 60, where X is 0.850 for 60 Hz line frequency or 0.840 for 50 Hz line frequency.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | X - 60 | Integration time in seconds. |
Sets the integration time to automatic mode. The power supply sets the integration time.
Queries the integration time setting for long integration measurements. This command is part of the :SENSe[:LINTegration] subtree.
Sets the trigger level path for long integration measurements. The command has range-specific trigger level forms for the 5 A, 500 mA, 50 mA, and 5 mA current ranges.
| Name | Type | Values | Description |
|---|---|---|---|
| ampopt | real | 0.0 A - 5.0 A | Trigger level in amps for use on the 5 A current range. |
| hundredopt | real | 0.0 mA - 500 mA | Trigger level in amps for use on the 500 mA current range. |
| fiftyopt | real | 0.0 mA - 50 mA | Trigger level in amps for use on the 50 mA current range. |
| fiveopt | real | 0.0 mA - 5 mA | Trigger level in amps for use on the 5 mA current range. |
Queries the trigger level setting for the long integration measurement path. The slice lists separate query forms for the 5 A, 500 mA, 50 mA, and 5 mA ranges.
Enable or disable pulse current search.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | ON | OFF | Turns pulse current search on or off. |
Queries the pulse current search setting.
Specifies the pulse current timeout length.
| Name | Type | Values | Description |
|---|---|---|---|
| timeout | real | 5ms - 32s | Length of the timeout, in seconds, with 1 ms increments. |
Queries the timeout setting.
Sets the current limit for the selected channel. In the example, `CURR 750e-3` sets the current limit to 750 mA.
| Name | Type | Values | Description |
|---|---|---|---|
| current | real | A | Current limit value to set. |
Selects the current limit operating mode. The example shows TRIP for the battery channel and LIM for the charger channel.
| Name | Type | Values | Description |
|---|---|---|---|
| mode | enum | TRIP | LIM | Current limit mode. |
Enables or disables automatic current range selection for the SENS2 current measurement subsystem.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | ON | OFF | Turns auto ranging on or off. |
SENS2:CURR:RANG:AUTO ON
Selects the current measurement range for the active channel. The manual shows four available ranges: 5 A, 500 mA, 50 mA, and 5 mA.
| Name | Type | Values | Description |
|---|---|---|---|
| range | real | A | Current range to use for pulse current measurements. |
SENS2:CURR:RANG 5
Enables or disables pulse detection mode for long integration measurements.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | ON | OFF | Turns pulse detection mode on or off. |
Enables or disables long integration fast readings.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | ON | OFF | Enable or disable long integration fast readings. |
Enables or disables pulse search for long integration measurements. This command applies to the long integration function on channel 2.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | ON | OFF | Enable or disable pulse search. |
Sets the current type for the charger channel. The programming example shows TRIP and LIM as the available modes.
| Name | Type | Values | Description |
|---|---|---|---|
| mode | enum | TRIP | LIM | Current type mode. |
SOUR2:CURR:TYPE TRIP SOUR2:CURR:TYPE LIM
Specify the average count for pulse current measurements or pulse current digitization. The manual lists a default of 1 and a range of 1 to 100 for pulse current measurements or 1 to 5000 for pulse current digitization.
| Name | Type | Values | Description |
|---|---|---|---|
| count | integer | 1 - 100 | Average count to use. |
Selects the pulse current measurement mode. The available modes are HIGH, LOW, or AVERage.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | HIGH | LOW | AVERage | Measurement mode to use. |
Controls pulse current detection triggering for pulse current measurements. It can enable pulse current measurements versus pulse current digitization, and provides trigger level settings for different current ranges.
| Name | Type | Values | Description |
|---|---|---|---|
| stateopt | enum | ON | OFF | Select pulse current measurements or pulse current digitization. |
| trigger level | - | - | Trigger level settings for pulse current detection. |
Set the integration time for pulse current measurements in seconds. This command is part of the :PCURrent:TIME subsystem, which also supports AUTO and range-specific integration time settings.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 33.33e-6 - 0.8333 | Integration time for pulse current measurements. |
Sets the pulse current integration time selection to automatic. This is part of the pulse current configuration time settings.
Sets the average count for pulse current measurements or pulse current digitization. The manual lists a default of 1 and notes different numeric ranges depending on the measurement type.
| Name | Type | Values | Description |
|---|---|---|---|
| count | integer | 1 - 100 | Average count for pulse current measurements; the manual also notes 1 to 5000 for pulse current digitization. |
Sets the pulse current digitize integration time. The value is specified in seconds and applies to digitizing or burst measurements.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 33.33e-6 - 0.8333 | Integration time for digitizing or burst measurements. |
Sets the trigger level for high pulse current measurements. The slice specifies this setting as part of pulse current measurement timing/trigger configuration.
| Name | Type | Values | Description |
|---|---|---|---|
| nrf | real | 33.33e-6 - 0.8333 | Integration time in seconds for high pulse measurements. |
Sets the low integration time for pulse current measurements. The time is specified in seconds and is available for the low pulse current mode.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 33.33e-6 - 0.8333 | Integration time in seconds for low pulse measurements. |
Sets the pulse current trigger level for the selected current range. The specific trigger-level setting available depends on the range in use.
| Name | Type | Values | Description |
|---|---|---|---|
| range | enum | AMP | HUNDred | FIFTy | FIVE | Selects which current range the trigger level applies to. |
| level | real | 0.0 - 5.0 | Trigger level value in amps. |
Sets the trigger level in amps for the 5 A current range. The manual shows this as the :TLEVel branch under pulse current synchronization.
| Name | Type | Values | Description |
|---|---|---|---|
| ampopt | real | 0.0 A - 5.0 A | Trigger level to use when on the 5 A current range. |
Sets the trigger level used for pulse current measurements. The available level command depends on the selected current range, with separate forms for 5 A, 500 mA, 50 mA, and 5 mA ranges.
| Name | Type | Values | Description |
|---|---|---|---|
| ampopt | real | 0.0 A - 5.0 A | Trigger level in amps for use on the 5 A current range. |
Set the trigger level in amps for use when on the 50 mA current range. The level is adjustable from 0.0 mA to 50 mA in 0.05 mA or 50 µA steps.
| Name | Type | Values | Description |
|---|---|---|---|
| level | real | 0.0 mA - 50 mA | Trigger level to use on the 50 mA current range. |
Set the trigger level in amps for use when on the 5 mA current range. The value is adjustable from 0.0 to 5 mA in 5 µA steps.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 0.0 - 5 mA | Trigger level value in amps for the 5 mA current range. |
Set the pulse current trigger level for the 500 mA current range. The level is specified in amps and applies only for the 500 mA range.
| Name | Type | Values | Description |
|---|---|---|---|
| count | real | 0.0 mA - 500 mA | Trigger level in amps for use when on the 500 mA current range. |
Enable or disable pulse current detection mode.
Enable or disable pulse current fast readings.
Enable or disable pulse current search.
Sets the pulse current step method configuration.
Specifies the trigger delay in seconds for pulse current step measurements. The documented range is 0.0 to 0.1 for pulse current measurements or 0.0 to 5.0 for pulse current digitization.
| Name | Type | Values | Description |
|---|---|---|---|
| delay | real | 0.0 - 0.1 | Trigger delay in seconds. |
Sets the number of downward steps used in the pulse current step method. The allowed range is 0 to 20, with the maximum applying to the combined up and down counts.
| Name | Type | Values | Description |
|---|---|---|---|
| count | integer | 0 - 20 | Number of down steps. |
Defines the delay sequence length for pulse current stepping. A value of zero causes the instrument to always use the :PCURrent:STEP:DELay value.
| Name | Type | Values | Description |
|---|---|---|---|
| length | integer | 0 - 19 | Length of the delay sequence. |
Defines up to 19 delay sequence values for pulse current step measurements using an index and a time value. The sequence length can be set separately, and zero length uses the :PCURrent:STEP:DELay value.
| Name | Type | Values | Description |
|---|---|---|---|
| index | integer | 1 - 19 | Sequence entry index. |
| time | real | 0 - 100e-3 | Delay time value for the indexed sequence entry. |
Specify whether sequential triggers are skipped. A value of 1 requires only one trigger; 0 requires multiple triggers.
| Name | Type | Values | Description |
|---|---|---|---|
| b | boolean | - | Specifies whether sequential triggers are skipped. |
Sets the pulse current step integration time. The allowed range is 33.3 μsec to 100 msec, with a default of 200 μsec.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 33.3μsec - 100msec | Integration time for pulse current step measurements. |
Set the trigger level for each TLEV step. x identifies the step number from 1 to 20; the current range must be selected before setting the step trigger level values.
| Name | Type | Values | Description |
|---|---|---|---|
| level | real | 0.0 | Trigger level value for the specified step. |
Specifies the timeout for step measurements other than the first. The first timeout is set separately with :INITial <NRf>.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 2 msec - 200 msec | Timeout for step measurements other than the first. |
Sets the initial timeout step for pulse current step measurements. The value controls the first TimeOUT step and is specified in seconds.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 10msec - 60secs | First TimeOUT step value. |
Sets the step-up count used by pulse current step measurements. The manual lists it as part of the :PCURrent:STEP configuration and gives a value range of 0 to 20.
| Name | Type | Values | Description |
|---|---|---|---|
| count | integer | 0 - 20 | Number of up steps to perform; the maximum is shared for up and down combined. |
Specifies the timeout length for pulse current measurements. The first timeout uses :INITial; this command sets the timeout for other steps.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | 2 ms - 200 msec | Timeout for pulse current measurement steps other than the first. |
Triggers and returns an array of pulse current readings. The manual notes that for MEASure:ARRay? the average count specifies how many pulse current measurement conversions are placed in the array.
Triggers and returns one pulse current reading. The notes say that for single readings, the average count specifies how many conversions are averaged for the result, and for array readings it specifies how many measurements are placed in the array.
Performs a READ:ARRay? on the specified battery or charger channel function. It is the array form of :MEASure[1][:<function>]?.
| Name | Type | Values | Description |
|---|---|---|---|
| functionopt | enum | - | Measurement function to use. |
Performs a READ? on the specified battery channel and function.
| Name | Type | Values | Description |
|---|---|---|---|
| functionopt | enum | - | Specified measurement function. |
Sets the pulse current integration time for the selected channel. The note says AUTO time accounts for the internal trigger delay, but HIGH, LOW, and AVERage do not account for user trigger delay.
| Name | Type | Values | Description |
|---|---|---|---|
| time | real | s | Integration time used for pulse current measurements. |
Enables or disables FAST pulse current mode for the selected channel. The manual refers to detailed usage information for FAST, SEARch, and DETect.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | ON | 1 | OFF | 0 | Turns FAST pulse current mode on or off. |
Configures pulse current detection for the selected sense channel. The manual notes it applies to battery channel (#1) and charger channel (#2) and refers to the FAST, SEARch, and DETect usage section for details.
| Name | Type | Values | Description |
|---|---|---|---|
| b | boolean | - | Enables or disables pulse current detection. |
Searches for a pulse current and retains quick response to measurement commands while ensuring the instrument is configured correctly for pulse detection. Applies to battery channel (#1).
| Name | Type | Values | Description |
|---|---|---|---|
| b | boolean | - | Enables or disables pulse current search. |
Sets the timeout length used for searching for the pulse in pulse current measurements. The default setting is 1 second, and the value should allow enough time for detection of the pulse edge plus the pulse period.
| Name | Type | Values | Description |
|---|---|---|---|
| timeout | real | s | Timeout length for searching for the pulse. |
Clears the operation status structure by resetting it to a preset state.
:stat:pres
Reads and clears the oldest error/status message from the status queue. This query is part of the STATus subsystem error queue handling.
Resets the status subsystem enable registers to 0 at power-up; the manual also notes it has no effect on the event registers. It resets the operation, measurement, and questionable enable registers, but not *ESE.
Read the measurement status condition register.
Programs the enable register for the measurement event status subsystem. The corresponding query reads the enable register.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 0 | Enable-register mask value. |
Reads the measurement status enable register.
Reads the measurement event register in the status subsystem.
Programs the enable register for the operation status registers. The command is part of the :STATus subsystem and is not affected by *RST.
| Name | Type | Values | Description |
|---|---|---|---|
| value | integer | - | Value to program into the enable register. |
Reads the operation status event register.
Read the condition register.
Read the enable register.
Clear all messages from the error queue.
Specifies messages not to be placed in the error queue.
| Name | Type | Values | Description |
|---|---|---|---|
| list | string | - | Messages to disable from being placed in the queue. |
Reads the disabled messages in the error queue.
Specifies the error and status messages that are enabled for the queue. This command belongs to the :STATus:QUEue subsystem.
| Name | Type | Values | Description |
|---|---|---|---|
| list | enum | <list> | Error and status messages to enable for the queue. |
Read the enabled list of messages for the error queue status subsystem.
Reads the least recent error message from the error queue.
Reads the questionable condition register. The register is real-time and read-only, reflecting the present operating conditions of the instrument.
Sets the enable register for the questionable event status. The register controls which questionable event bits are enabled.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | integer | 0 - 65535 | Numeric register value to load into the questionable event enable register. |
Reads the questionable event enable register. The register controls which questionable-event bits contribute to the status byte.
Reads the questionable event register. The register is latched until read, and reading it clears the bits in that register.
Returns the channel 1 and channel 2 readings in a single message, separated by a comma. After completion, the display is set for Channel #1.
Sets the battery channel (#1) and then the charger channel (#2) to the function specified by name. Valid names are VOLTage, CURRent, PCURrent, or LINTegration.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | VOLTage | CURRent | PCURrent | LINTegration | Function to assign to both channels. |
Triggers a reading on channel 1 and then channel 2. After the command completes, the display is set for Channel #2.
Returns the last array of readings from battery channel (#1). Triggered before reading(s).
Returns the last reading from battery channel (#1). The reading is triggered before the reading(s).
Switches to the 5 A range and takes a measurement on battery channel (#1).
Triggers and returns a new array of battery channel (#1) readings.
Triggers and returns a new battery channel (#1) reading in the 50 mA range. This command switches to the 50 mA range before taking the measurement.
Triggers and returns a new 5 mA-range battery channel (#1) reading.
Switches to the 500 mA range and then takes a measurement on battery channel (#1).
:READ[1]:HUNDred?
Triggers and returns a new battery channel (#1) reading.
Sets or clears the Message Exchange Protocol (MEP). The manual notes that when the 488.1 protocol is selected, MEP is disabled to speed up GPIB operation.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | ON | OFF | Enables or disables MEP. |
SYST:MEP ON SENS:NPLC 1.5; :SYST:MEP OFF
Returns the reading for the active channel. If Trigger on talk both channels is enabled, it returns two readings comma-delimited, one from each channel.
Sets the VFD display brightness. The allowable range is 0 to 1.0, where 0 blanks the display and 1.0 is full brightness.
| Name | Type | Values | Description |
|---|---|---|---|
| brightness | real | 0 - 1.0 | Brightness setting for the VFD display. |
Changes the active display channel. Channel 1 selects the battery display and channel 2 selects the charger display.
| Name | Type | Values | Description |
|---|---|---|---|
| channel | real | 1 - 2 | Active display channel to select. |
Enables or disables the dual V and I display. The power-on value is 0.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | 1 | 0 | Enables or disables dual V and I display. |
Enables or disables the front-panel display circuitry. When disabled, the instrument operates at a higher speed and the display is blank.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | 0 | OFF | 1 | ON | Controls display on/off state. |
Defines a text message for the display. The message is up to 32 characters long; spaces are counted and an indefinite block message must be the only command or the last command in the program message.
| Name | Type | Values | Description |
|---|---|---|---|
| a | string | - | ASCII characters for the display message. |
Enables or disables the text message mode. When enabled, the text message is displayed; when disabled, the message is removed from the display and the normal display state returns.
| Name | Type | Values | Description |
|---|---|---|---|
| state | enum | 0 | OFF | 1 | ON | Enables or disables text message mode. |
Queries the display brightness setting. Power-on value is 0.
Enables or disables the dual V and I display. Use 1 to enable and 0 to disable.
| Name | Type | Values | Description |
|---|---|---|---|
| state | boolean | - | Turns the dual V and I display on or off. |
Query the state of the display.
Queries the text message defined for the display window. The command is part of the display text subsystem under :DISPlay[:WINDow[1]]:TEXT.
Queries the state of the user text message mode in the display subsystem. The message mode is controlled by the :DISPlay[:WINDow[1]]:TEXT:STATe setting.
Sets whether trigger-on-talk returns two readings or only the active channel reading. 1 or ON enables the mode; 0 or OFF disables it.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | 1 | ON | 0 | OFF | Enables or disables trigger on talk behavior. |
:BOTH <b>
Queries trigger on talk.
Queries the trigger-on-talk setting.
Selects the data format for readings. The example shows using SRE to select SReal format for faster reading speed.
| Name | Type | Values | Description |
|---|---|---|---|
| format | enum | SRE | Selects the reading format. |
FORM SRE
Selects the data format used for transferring readings over the bus. The reading format depends on the presently selected function.
| Name | Type | Values | Description |
|---|---|---|---|
| type | enum | ASCii | SREal | DREal | Data format to use for transferred readings. |
Selects the data format used when transferring readings over the bus. The available formats are ASCII, IEEE-754 single precision, and IEEE-754 double precision.
| Name | Type | Values | Description |
|---|---|---|---|
| type | enum | ASCii | SREal | DREal | Data format to use for reading transfers. |
Queries the byte order setting.
Queries the current data format.
Turns both power supply channels OFF.
Turns both power supply channels on or off depending on the command variant shown in the table. The manual notes that no query or short form exists.
Queries the pulse current trigger level setting. The trigger level is used for pulse current measurements and is set in 5 mA steps over 0 to 5 A.
Sets the battery channel (#1), then the charger channel (#2) to the specified function. Valid function names are VOLTage, CURRent, PCURrent, and LINTegration.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | VOLTage | CURRent | PCURrent | LINTegration | Function to assign to the battery and charger channels. |
Queries the state of the current limit. It reports 1 when the output is in current limit for LIMit type or tripped for TRIP type, and 0 when not in LIMit/TRIP.
Selects the current limit type for the source current limit path. The manual lists the available types as LIMit or TRIP, with a default of LIM.
| Name | Type | Values | Description |
|---|---|---|---|
| name | enum | LIMit | TRIP | Select the current limit type. |
Queries the current limit type for the selected source channel. The documented choices for the corresponding setter are LIMit or TRIP.
Sets the current limit value for the source current path. The value is specified in amps with 100 bcA resolution.
| Name | Type | Values | Description |
|---|---|---|---|
| value | real | 0.006 - 5 | Current limit value. |
Queries the current limit value for the source current subsystem. The manual states this query returns the configured current limit.
Sets the VPT offset for the battery channel. The offset range is 0 to 8 V.
| Name | Type | Values | Description |
|---|---|---|---|
| NRf | real | 0 - 8 | VPT offset value. |
Sets the VPT clamp mode for the selected source channel. The mode can be set to ON or OFF.
| Name | Type | Values | Description |
|---|---|---|---|
| b | enum | ON | OFF | Clamp mode state. |
Sets the VPT clamp mode for the battery channel. The mode can be turned ON or OFF.
| Name | Type | Values | Description |
|---|---|---|---|
| mode | enum | ON | OFF | Sets the VPT clamp mode. |
Queries the state of VPT for channel 1. The manual notes there is no associated command.
Queries the setting for the VPT offset for source channel 1. The offset is part of the source voltage protection path.
Sets the voltage amplitude for the source output in volts. The amplitude can be queried with the corresponding amplitude query.
| Name | Type | Values | Description |
|---|---|---|---|
| n | real | 0 - 15 | Voltage amplitude to set. |
Queries the voltage amplitude for the immediate voltage level in the source subsystem. The command is part of the voltage path under :SOURce[1]:VOLTage[:LEVel][:IMMediate][:AMPLitude].
Selects a calibration step number for protection calibration. Table 13-2 notes that step numbers correspond to this command’s values.
| Name | Type | Values | Description |
|---|---|---|---|
| step | integer | 0 - 20 | Calibration step number. |
Unlocks calibration when the correct code is sent. The manual shows it being used before :CAL:PROT:INIT to begin remote calibration.
| Name | Type | Values | Description |
|---|---|---|---|
| code | string | - | Calibration unlock code. |
CAL:PROT:CODE ‘KI002308’
Initiates the remote calibration procedure after calibration has been unlocked with the correct code. It starts the sequence of calibration steps performed over the IEEE-488 bus.
CAL:PROT:INIT
Sets the calibration date. The year, month, and date must be separated by commas, with year range 2008 to 2107, month 1 to 12, and date 1 to 31.
| Name | Type | Values | Description |
|---|---|---|---|
| yyyy | integer | 2008 - 2107 | Year of the calibration date. |
| mm | integer | 1 - 12 | Month of the calibration date. |
| dd | integer | 1 - 31 | Day of the calibration date. |
Locks out calibration after the calibration constants are saved.
Saves the calibration constants to EEROM. Calibration data will not be saved if calibration is locked, invalid data exists, or all steps were not completed in the proper sequence.
:CAL:PROT:SAVE
Returns the number of times the instrument has been calibrated. Used for remote acquisition of the calibration count.
Returns the last calibration date. Use CAL:PROT:COUN? to read the calibration count.
Resets the protected calibration code to the default value. The command saves the password as "KI002308" so calibration can be unlocked with that code.
Returns the number of remote calibration commands that have been executed in the current calibration session. It is part of the calibration subsystem summary, with the count reported as a numeric value.
Initiates the calibration procedure by unlocking calibration with the password code. The correct code must be sent before any other calibration command; the default remote code is KI002308.
| Name | Type | Values | Description |
|---|---|---|---|
| code | string | - | Up to an 8-character ASCII string, including letters and numbers, enclosed in single quotes. |
:CAL:PROT:CODE 'KI002308' Send default code of KI002308.
Locks out calibration-protected commands until the correct calibration code is sent. The code must be sent before any other calibration command, and the default remote code is KI002308.
:CAL:PROT:CODE 'KI002308'
Saves calibration data, but only if calibration was unlocked and the calibration procedure completed properly. The manual notes that calibration data will not be saved if invalid data exists or the steps were not performed in the proper sequence.
:CAL:PROT:CODE 'KI002308'
Performs calibration step 10, which outputs 5 mA nominal current for Channel 1 5 mA range full-scale calibration.
:CAL:PROT:STEP10