5. Subsystem command reference
This section summarizes the Standard Commands for Programmable Instruments (SCPI) available to program the BB3 remotely.
5.1. ABORT
Abort commands cancel any triggered actions.
SCPI command |
Description |
Resets the trigger system to the Idle state |
|
Stops the internal data logging session |
5.1.1. ABORt
Syntax |
ABORt |
Description |
The ABORt command resets the trigger system and places all trigger sequences in the IDLE state. Any actions related to the trigger system that are in progress will be also aborted as quickly as possible. As a result, subsequent triggers have no effect on the input level.
ABORt is also executed at power-on and upon execution of the *RST command. |
Usage example |
ABOR |
Related Commands |
*RST INITiate [SOURce[<n>]]:CURRent:TRIGgered [SOURce[<n>]]:VOLTage:TRIGgered [SOURce[<n>]]:LIST:COUNt |
5.1.2. ABORt:DLOG
Syntax |
ABORt:DLOG |
Description |
This command stops the internal data logging session.
ABORt:DLOG is also executed at power-on and upon execution of the *RST command. |
Usage example |
ABOR:DLOG |
Related Commands |
*RST |
5.2. CALibration
This subsystem provides commands for the module output calibration. Only one channel can be calibrated at a time. If calibration mode has not been enabled with CALibration:STATe, the calibration commands will generate an error. Use CALibration:SAVE to save any changes, otherwise all changes will be lost on exit from calibration mode. Within the same calibration session both output voltage and current can be calibrated for the currently selected channel.
Calibration cannot start if channel output is not enabled (OUTPut[:STATe] ON).
During calibration process up to 20 measurement points can be entered within range for selected module and value (e.g. 0 to 40 V for DCP405 power module). The minimum recommended number of measurement points is two to compensate slope and offset errors.
SCPI Command |
Description |
Enables/disables calibration mode |
|
Clears all calibration parameters |
|
:CURRent |
|
Enters the calibration value for set point |
|
Calibrates the output current programming |
|
Initiates current calibration measurement |
|
Sets current range for multiple current range module |
|
:PASSword |
|
Changes calibration password |
|
Saves calibration information |
|
Saves the new cal constants in non-volatile memory |
|
Initiates touchscreen calibration procedure |
|
Enables calibration parameters |
|
:VOLTage |
|
Enters the calibration value for set point |
|
Calibrates the output voltage programming |
|
Initiates voltage calibration measurement |
5.2.1. CALibration[:MODE]
Syntax |
CALibration[:MODE] {<bool>}, {<password>} CALibration[:MODE]? |
|||
Modules |
DCP DCM SMX MIO |
|||
Description |
This command enables or disables calibration mode. Calibration mode must be enabled for the channel to accept any calibration commands. The first parameter specifies the ON (1) or OFF (0) state. The second parameter is the password. Successful execution of this command set both output VOLTage and CURRent of the selected channel to the MINimum value (see Section 8.1). Execution of this command also affects bit 0 (CALibrating) of the Operation Instrument Isummary register (see Section 3.3.2).
If both voltage and current calibration parameters exists on calibration mode exit (CALibration[:MODE] OFF) the CALibration:STATe ON command will automatically follows. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
OFF |
|
|
<password> |
Quoted string |
4 to 16 characters |
"eezbb3" |
Return |
The returned parameter is 0 (OFF) or 1 (ON). |
|||
Usage example |
See Section 10.2 |
|||
Errors |
102,"Invalid cal password" 104,"Bad sequence of calibration commands" 312,"Cannot execute when the channels are coupled" |
|||
Related Commands |
CALibration:STATe DIAGnostic[:INFOrmation]:OTIMe? INSTrument:COUPle:TRACking |
5.2.2. CALibration:CLEar
Syntax |
CALibration:CLEar {<password>} |
|||
Modules |
DCP DCM SMX MIO |
|||
Description |
Clear all calibration parameters stored in the module non-volatile memory for the currently selected channel. After successful execution of this command CALibration:STATe will be set to OFF (0) and further usage of the calibration data will be disabled. This command will be also filled calibration remark with the date and note that calibration data has been cleared. |
|||
Parameters |
Name |
Type |
Range |
Default |
<password> |
Quoted string |
4 to 16 characters |
"eezbb3" |
|
Return |
None |
|||
Usage example |
DIAG:CAL? "remark=2020-04-28 new cal", "u_cal_params_exists=1", "u_point1_dac=0.150000", "u_point1_data=0.145000", "u_point1_adc=0.178900", "u_point2_dac=38.000000", "u_point2_data=39.292000", "u_point2_adc=38.032799", "i_5A_cal_params_exists=1", "i_5A_point1_dac=0.050000", "i_5A_point1_data=0.060100", "i_5A_point1_adc=0.059840", "i_5A_point2_dac=4.800000", "i_5A_point2_data=5.072900", "i_5A_point2_adc=4.810040", "i_50mA_cal_params_exists=1", "i_50mA_point1_dac=0.000500", "i_50mA_point1_data=0.000591", "i_50mA_point1_adc=0.000600", "i_50mA_point2_dac=0.048000", "i_50mA_point2_data=0.049897", "i_50mA_point2_adc=0.048100" CAL:STAT? 1 CAL:CLE "eezbb3" CAL:STAT? 0 DIAG:CAL? "remark= Not calibrated", "u_cal_params_exists=0", "i_cal_params_exists=0" |
|||
Errors |
102,"Invalid cal password" |
|||
Related Commands |
CALibration:STATe DIAGnostic[:INFOrmation]:CALibration? |
5.2.3. CALibration:CURRent[:DATA]
Syntax |
CALibration:CURRent[:DATA] {<value>} |
|||
Modules |
DCP DCM MIO |
|||
Description |
This command can only be used when calibration is enabled and the output state of the currently selected channel is ON. It enters a current value that is obtained by reading an external meter. The calibration level (CALibration:CURRent:LEVel {<point>, <level>}) has to be selected first for the value being entered. The BB3 then computes new current calibration constants. These constants has to be stored in non-volatile memory with CALibration:SAVE command. |
|||
Parameters |
Name |
Type |
Range |
Default |
<value> |
NR2 |
-0.5 A to MAX +0.5 A The maximum value is dependent on the power module current rating. See Section 8.1 |
– |
|
Return |
None |
|||
Usage example |
See Section 10.2 |
|||
Errors |
104,"Bad sequence of calibration commands" 107,"Cal value out of range" |
|||
Related Commands |
CALibration:CURRent:LEVel |
5.2.4. CALibration:CURRent:LEVel
Syntax |
CALibration:CURRent:LEVel {<point>}, {<level>} |
|||
Modules |
DCP DCM MIO |
|||
Description |
This command can only be used when calibration is enabled and the output state of the currently selected channel is ON. It sets the power module to a calibration point that is entered with the CAL:CURR[:DATA] command. |
|||
Parameters |
Name |
Type |
Range |
Default |
<point> |
NR1 |
1 – 20 |
– |
|
<level> |
NR2 |
0 to MAX (see also Section 8.1) |
– |
|
Return |
None |
|||
Usage example |
See Section 10.2 |
|||
Errors |
101,"Calibration state is off" 104,"Bad sequence of calibration commands" |
|||
Related Commands |
CALibration:CURRent[:DATA] CALibration:STATe INSTrument:NSELect INSTrument[:SELect] [SOURce[<n>]]:CURRent |
5.2.5. CALibration:CURRent:MEASure?
Syntax |
CALibration:CURRent:MEASure? |
Modules |
MIO |
Return |
Use this query to initiate current measurement on the selected analog input of the MIO168 module and store that data for the selected calibration point. |
Usage example |
CAL:CURR:MEAS? 1 |
Errors |
101,"Calibration state is off" 104,"Bad sequence of calibration commands" |
Related Commands |
CALibration:STATe CALibration:VOLTage:MEASure? INSTrument[:SELect] |
5.2.6. CALibration:CURRent:RANGe
Syntax |
CALibration:CURRent:RANGe {<range>} |
|||
Modules |
DCP MIO |
|||
Description |
When BB3 is equipped with power modules that has multiple current range (e.g. DCP405 that can be find out with the SYSTem:CHANnel:MODel? command) it’s recommended to perform calibration of all ranges. Use this command to select current range on which calibration will be accomplished. |
|||
Parameters |
Name |
Type |
Range |
Default |
<range> |
Discrete|NR2 |
LOW|HIGH|0.05|5 |
HIGH|5 |
|
Return |
None |
|||
Usage example |
See Section 10.2 |
|||
Errors |
101,"Calibration state is off" -241,"Hardware missing" |
|||
Related Commands |
CALibration:CURRent:LEVel CALibration:STATe SYSTem:CHANnel:MODel? |
5.2.7. CALibration:PASSword:NEW
Syntax |
CALibration:PASSword:NEW {<old>}, {<new>} |
|||
Modules |
DCP DCM SMX MIO |
|||
Description |
Enter a new calibration password. To change the password, first unsecure the BB3 using the old password. Then, the new code has to be entered. The calibration code may contain up to 16 characters over the remote interface. Minimum length is 4 characters. The new password is automatically stored in non-volatile memory and does not have to be stored with CALibration:SAVE. |
|||
Parameters |
Name |
Type |
Range |
Default |
<old> |
Quoted string |
4 to 16 characters |
eezbb3 |
|
|
<new> |
Quoted string |
4 to 16 characters |
– |
Return |
None |
|||
Usage example |
CAL:PASS:NEW "eezbb3", "mycal1234" |
|||
Errors |
102,"Invalid cal password" 105,"Cal password too long" 106,"Cal password too short" |
5.2.8. CALibration:REMark
Syntax |
CALibration:REMark {<user remark>} CALibration:REMark? |
|||
Modules |
DCP DCM SMX MIO |
|||
Description |
Record calibration information about the power module. The BB3 should be in calibration mode before sending a calibration message. |
|||
Parameters |
Name |
Type |
Range |
Default |
<user remark> |
Quoted string |
0 to 32 characters |
"Calibration passed" |
|
Return |
Query the calibration message. |
|||
Usage example |
CAL:REM "Calibrated by EEZ" CAL:REM? "Calibrated by EEZ" See also Section 10.2 |
|||
Errors |
The following errors could be generated by command but not query: 101,"Calibration state is off" 104,"Bad sequence of calibration commands" |
|||
Related Commands |
CALibration:STATe |
5.2.9. CALibration:SAVE
Syntax |
CALibration:SAVE |
Modules |
DCP DCM SMX MIO |
Description |
This command saves calibration constants in non-volatile memory after the calibration procedure has been completed. If calibration mode is exited by programming CALibration:STATe OFF without first saving the new constants, the previous constants are restored. Execution of this command also affects bit 0 (CALibrating) of the Operation Instrument Isummary register (see Section 3.3.2). |
Return |
None |
Usage example |
See Section 10.2 |
Errors |
-340,"Calibration failed" 101,"Calibration state is off" 104,"Bad sequence of calibration commands" 111,"No new cal data exists" |
5.2.10. CALibration:SCReen:INIT
Syntax |
CALibration:SCReen:INIT |
Description |
Use this command to initiate touchscreen calibration procedure when calibration data are lost or corrupted. Calibration has to be performed locally on the BB3.
New calibration procedure can be initiated also by touching the screen and hold for more then 15 seconds. |
Return |
None |
Usage example |
CAL:SCR:INIT |
5.2.11. CALibration:STATe
Syntax |
CALibration:STATe {<bool>} CALibration:STATe? |
|||
Modules |
DCP DCM SMX MIO |
|||
Description |
This command enables or disables usage of calibration parameters if they exists. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
OFF|ON|0|1 |
ON |
|
Return |
The returned parameter is 0 (OFF) or 1 (ON). |
|||
Usage example |
CAL:STAT OFF |
|||
Errors |
110,"Cal params missing or corrupted" |
|||
Related Commands |
DIAGnostic[:INFOrmation]:OTIMe? |
5.2.12. CALibration:VOLTage[:DATA]
Syntax |
CALibration:VOLTage[:DATA] {<value>} |
|||
Modules |
DCP DCM SMX MIO |
|||
Description |
This command can only be used when calibration is enabled and the output state of the currently selected channel is ON. It enters a voltage value that you obtained by reading an external meter. The calibration level (see CALibration:VOLTage:LEVel {<point>, <level>}) for the value being entered. The BB3 then computes new voltage calibration constants. These constants has to be stored in non-volatile memory with CALibration:SAVE command. |
|||
Parameters |
Name |
Type |
Range |
Default |
<value> |
NR2 |
-1 V to MAX +1 V The maximum value is dependent on the power module voltage rating. See Section 8.1 |
– |
|
Return |
None |
|||
Usage example |
See Section 10.2 |
|||
Errors |
104,"Bad sequence of calibration commands" 107,"Cal value out of range" |
|||
Related Commands |
CALibration:SAVE CALibration:STATe CALibration:VOLTage:LEVel INSTrument:NSELect INSTrument[:SELect] |
5.2.13. CALibration:VOLTage:LEVel
Syntax |
CALibration:VOLTage:LEVel {<point>}, {<level>} |
|||
Modules |
DCP DCM SMX MIO |
|||
Description |
This command can only be used when calibration is enabled and the output state of the currently selected channel is ON. It sets the power module to a calibration point that is entered with the CAL:VOLT[:DATA] command. |
|||
Parameters |
Name |
Type |
Range |
Default |
<point> |
NR1 |
1 – 20 |
– |
|
<level> |
NR2 |
0 to MAX (see also Section 8.1) |
– |
|
Return |
None |
|||
Usage example |
See Section Section 10.2 |
|||
Errors |
101,"Calibration state is off" 104,"Bad sequence of calibration commands" |
|||
Related Commands |
CALibration:STATe CALibration:VOLTage[:DATA] INSTrument:NSELect INSTrument[:SELect] [SOURce[<n>]]:VOLTage |
5.2.14. CALibration:VOLTage:MEASure?
Syntax |
CALibration:VOLTage:MEASure? |
Modules |
MIO |
Return |
Use this query to initiate voltage measurement on the selected analog input of the MIO168 module and store that data for the selected calibration point. |
Usage example |
CAL:VOLT:MEAS? 1 |
Errors |
101,"Calibration state is off" 104,"Bad sequence of calibration commands" |
Related Commands |
CALibration:CURRent:MEASure? CALibration:STATe INSTrument[:SELect] |
5.3. DIAGnostic
The purpose of the DIAGnostic subsystem is to provide a tree node for all of the BB3 service and diagnostic routines used in routine maintenance and repair.
SCPI command |
Description |
DIAGnostic |
|
[:INFOrmation] |
|
Returns the latest values acquired by ADC |
|
Returns a list of the calibration parameters |
|
Returns the information about all protections. |
|
Returns results of the most recent self-test |
5.3.1. DIAGnostic[:INFOrmation]:ADC?
Syntax |
DIAGnostic[:INFOrmation]:ADC? [<channel>] |
|||
Description |
This query returns the latest values acquired by ADC (Analog-to-Digital Converter) of the currently selected channel. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
n/a |
|
Return |
Return a list of quoted strings. The U_SET and I_SET are values measure on DAC outputs, and U_MON and I_SET on the channel output terminals. |
|||
Usage example |
DIAG:ADC? CH2 "U_SET=10.1202", "U_MON=10.12", "I_SET=3.00", "I_MON=1.23" |
|||
Related Commands |
MEASure[:SCALar]:CURRent[:DC] MEASure[:SCALar][:VOLTage][:DC] [SOURce[<n>]]:CURRent[:LEVel][:IMMediate][:AMPLitude] [SOURce[<n>]]:VOLTage[:LEVel][:IMMediate][:AMPLitude] |
5.3.2. DIAGnostic[:INFOrmation]:CALibration?
Syntax |
DIAGnostic[:INFOrmation]:CALibration? [<channel>] |
|||
Description |
This query returns a list of calibration parameters for the currently selected channel. If the selected channel is in the calibration mode (CALibration[:MODE] ON) then all calibration information collected to the current calibration step will be returned. Otherwise the calibration data stored in non-volatile memory will be returned. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
n/a |
|
Return |
The information will be returned as a list of quoted strings. |
|||
Usage example |
Calibration parameters for BB3 when the channel 2 is not in the calibration mode: DIAG:INFO:CAL? CH2 "remark=20200123 cert", "u_cal_params_exists=1", "u_min_level=0.15V", "u_min_data=0.08V", "u_min_adc=0.114V", "u_mid_level=20V", "u_mid_data=20.597V", "u_mid_adc=19.9685V", "u_max_level=38V", "u_max_data=39.192V", "u_max_adc=37.973V", "u_min_range=0V", "u_max_range=40V", "i_5A_cal_params_exists=1", "i_5A_min_level=0.05A", "i_5A_min_data=0.0405A", "i_5A_min_adc=0.03695A", "i_5A_mid_level=2.425A", "i_5A_mid_data=2.4757A", "i_5A_mid_adc=2.4125A", "i_5A_max_level=4.8A", "i_5A_max_data=4.9122A", "i_5A_max_adc=4.78855A", "i_5A_min_range=0A", "i_5A_max_range=5A", "i_50mA_cal_params_exists=1", "i_50mA_min_level=0.0005A", "i_50mA_min_data=0.00041A", "i_50mA_min_adc=0.000371A", "i_50mA_mid_level=0.02425A", "i_50mA_mid_data=0.02545A", "i_50mA_mid_adc=0.0240945A", "i_50mA_max_level=0.048A", "i_50mA_max_data=0.05052A", "i_50mA_max_adc=0.047887A", "i_50mA_min_range=0A", "i_50mA_max_range=0A" The query results when a channel is just entered the calibration mode: DIAG:INFO:CAL? "u_level=none", "i_level=none" The query results when a channel is at the step MIDdle of the voltage calibration: DIAG:INFO:CAL? "u_min=0.11V", "u_level=mid", "u_level_value=24.05V", "u_adc=24.14V", "i_level=none" |
|||
Related Commands |
CALibration:REMark CALibration:SAVE |
5.3.3. DIAGnostic[:INFOrmation]:PROTection?
Syntax |
DIAGnostic[:INFOrmation]:PROTection? |
Description |
This query returns information about all supported output protection mechanisms. |
Return |
The information will be returned as a list of quoted strings. |
Usage example |
DIAG:PROT? "CH1 u_tripped=0", "CH1 u_state=0", "CH1 u_type=1", "CH1 u_delay=5 ms", "CH1 u_level=38V", "CH1 i_tripped=0", "CH1 i_state=0", "CH1 i_delay=20 ms", "CH1 p_tripped=0", "CH1 p_state=0", "CH1 p_delay=10 s", "CH1 p_level=155W", "CH2 u_tripped=0", "CH2 u_state=0", "CH2 u_type=0", "CH2 u_delay=5 ms", "CH2 u_level=40V", "CH2 i_tripped=0", "CH2 i_state=0", "CH2 i_delay=20 ms", "CH2 p_tripped=0", "CH2 p_state=1", "CH2 p_delay=10 s", "CH2 p_level=155W" |
Related Commands |
[SOURce[<n>]]:CURRent:PROTection:DELay[:TIME] [SOURce[<n>]]:CURRent:PROTection:STATe [SOURce[<n>]]:CURRent:PROTection:TRIPped? [SOURce[<n>]]:POWer:PROTection [SOURce[<n>]]:POWer:PROTection:DELay[:TIME] [SOURce[<n>]]:POWer:PROTection:STATe [SOURce[<n>]]:POWer:PROTection:TRIPped? [SOURce[<n>]]:VOLTage:PROTection:DELay[:TIME] [SOURce[<n>]]:VOLTage:PROTection:STATe [SOURce[<n>]]:VOLTage:PROTection:TRIPped? SYSTem:TEMPerature:PROTection[:HIGH][:LEVel] SYSTem:TEMPerature:PROTection[:HIGH]:DELay[:TIME] SYSTem:TEMPerature:PROTection[:HIGH]:STATe SYSTem:TEMPerature:PROTection[:HIGH]:TRIPped? |
5.3.4. DIAGnostic[:INFOrmation]:TEST?
Syntax |
DIAGnostic[:INFOrmation]:TEST? [<resource>] |
|||
Description |
This query returns results of the most recent self-test (see *TST? Command) for all or specified resource. |
|||
Parameters |
Name |
Type |
Range |
Default |
<resource> |
Discrete |
EEProm|SDCard|ETHernet|RTC| DATEtime|FAN|AUXTemp| CH1Temp|CH2Temp|CH3Temp| CH4Temp|CH5Temp|CH6Temp| CH1|CH2|CH3|CH4|CH5|CH6|SLOT1|SLOT2|SLOT3 |
– |
|
Return |
The information will be returned in the following format: "<return code, device name, installed, return message>" where the return code could be one of the following values:
This information format will repeat with as many iterations as the number of devices found in configuration parameters of the BB3. |
|||
Usage example |
Return self-test results when SD card is not found: DIAG:TEST? "2, EEPROM, installed, passed", "2, SD card, installed, passed", "2, Ethernet, installed, passed", "2, RTC, installed, passed", "2, DateTime, installed, passed", "2, Fan, installed, passed", "2, AUX temp, installed, passed", "2, CH1 temp, installed, passed", "2, CH2 temp, installed, passed", "2, CH3 temp, installed, passed", "2, CH4 temp, installed, passed", "2, SLOT1, installed, passed", "2, SLOT2, installed, passed", "2, SLOT3, installed, passed"
Check status of specified device, e.g. channel 2: DIAG:TEST? CH2 2 |
|||
Related Commands |
*TST? SYSTem:CHANnel:OPTion? |
5.4. DISPlay
The DISPlay commands are used to set the display mode, turn on or off the front panel TFT display, select main page appearance, display and clear the text sent using a controller application. DISPlay is independent of, and does not modify, how data is returned to the controller application.
SCPI command |
Description |
DISPlay |
|
Sets the intensity of the front panel TFT display |
|
Reads screen image data |
|
Sets the front panel TFT display main page appearance |
|
[:WINdow] |
|
Sets the front panel TFT display state |
|
:DIALog |
|
Displays content of the resource file |
|
Returns information about selected item |
|
Closes last opened dialog window |
|
Sets the value of the dialog data item |
|
Opens DLOG viewer |
|
Displays message box and generates error beep tone |
|
Displays entry form and waits for input on the front panel TFT display |
|
Displays pop-up display with multiple radio buttons |
|
Displays a message on the front panel TFT display |
|
Clear a message on the front panel TFT display |
5.4.1. DISPlay:BRIGhtness
Syntax |
DISPlay:BRIGhtness {<value>} DISPlay:BRIGhtness? |
|||
Description |
Controls the intensity of the front panel TFT display. The range of the parameter is 1 to 20, where 20 is full intensity and 1 is fully blanked. |
|||
Parameters |
Name |
Type |
Range |
Default |
<value> |
NR1 |
1 – 20 |
20 |
|
Return |
This query returns set front panel’s TFT display brightness value. |
|||
Usage example |
DISP:BRIG? 20 |
|||
Related Commands |
*RST |
5.4.2. DISPlay:DATA?
Syntax |
DISPlay:DATA? |
Description |
This query reads screen image data (i.e. create screenshot). The image is formatted as a .png file. Use the HCOPy[:IMMediate] or HCOPy:SDUMp[:IMMediate] command to capture screen image and save it as a file on the SD card.
An attempt to reads screen image data while DLOG recording is in progress will generate an execution error. |
Return |
Screen image data is returned in the IEEE-488.2 # data block format (see Section 2.10). |
Usage example |
DISP:DATA? #<length-digits><length><block> |
|
-200,"Execution error" |
Related Commands |
HCOPy[:IMMediate] HCOPy:SDUMp[:IMMediate] MMEMory:FEED |
5.4.3. DISPlay:VIEW
Syntax |
DISPlay:VIEW {<mode>} DISPlay:VIEW? |
|||
Description |
Use this command to set front panel TFT display main page appearance. The following modes are available:
|
|||
Parameters |
Name |
Type |
Range |
Default |
<mode> |
NR1|Discrete |
1 – 5|DEFault |
DEFault |
|
Return |
This query returns set front panel’s TFT display main page appearance numeric value (NR1). |
|||
Usage example |
DISP:VIEW 2 |
|||
Related Commands |
*RST |
5.4.4. DISPlay[:WINdow][:STATe]
Syntax |
DISPlay[:WINdow][:STATe] {<bool>} DISPlay[:WINdow][:STATe]? |
|||
Description |
Turn the front panel TFT display off or on. When the display is turned off, outputs are not sent to the display and all indicators are disabled except the Event view indicator. The display state is automatically turned on when you return to the local mode. Press and hold the display for about a second to return to the LOCal from the REMote control. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
– |
|
Return |
DISPlay? query the front panel TFT display state. Returns 0 (OFF) or 1 (ON). |
|||
Usage example |
DISP ON |
|||
Related Commands |
SYSTem:LOCal SYSTem:REMote |
5.4.5. DISPlay[:WINdow]:DIALog[:OPEN]
Syntax |
DISPlay[:WINdow]:DIALog[:OPEN] {<filename>} |
|||
Description |
Use this command to draw new page defined with resource file created in EEZ Studio and contains page widgets, actions and data items. The resource file has to be located on the SD card (see MMEMory subsystem) and the full path to the file must be specified. The new displayed page can be closed (removed) by using the DISPlay[:WINdow]:DIALog:CLOSe to close the page. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
– |
– |
|
Usage example |
DISP:DIAL "/Scripts/Diode Tester.res"
|
|||
Related Commands |
DISPlay[:WINdow]:DIALog:CLOSe DISPlay[:WINdow]:DIALog:DATA |
5.4.6. DISPlay[:WINdow]:DIALog:ACTIon
Syntax |
DISPlay[:WINdow]:DIALog:ACTIon? [<timeout>] |
|||
Description |
This command waits for timeout (in seconds) to get information about what action item is selected on the currently displayed page as defined in resource file activated with the DISPlay[:WINdow]:DIALog[:OPEN] command. The default timeout value is 0 and command will wait until user select one of the action items. |
|||
Parameters |
Name |
Type |
Range |
Default |
<timeout> |
NR1 |
– |
0 |
|
Return |
Returns name of the latest action item selected by user. 0 will be returned if currently opened page does not contain any action dialog. 1 is returned when timeout parameter is used and set time expired without user action. |
|||
Usage example |
DISP:DIAL:ACTI? "input_diode_name" |
|||
Related Commands |
DISPlay[:WINdow]:DIALog[:OPEN] |
5.4.7. DISPlay[:WINdow]:DIALog:CLOSe
Syntax |
DISPlay[:WINdow]:DIALog:CLOSe |
Description |
Use this command to close last dialog window opened with the DISPlay[:WINdow]:DIALog[:OPEN] command. |
Parameters |
|
|
|
Usage example |
DISP:DIAL:CLOS |
Related Commands |
DISPlay[:WINdow]:DIALog[:OPEN] |
5.4.8. DISPlay[:WINdow]:DIALog:DATA
Syntax |
DISPlay[:WINdow]:DIALog:DATA {<name>}, {<type>}, [{<unit>}], {<value>} |
|||
Description |
Use this command to set the value of the dialog data item defined as <name>. The list of possible data items is defined within the dialog resource file created in the EEZ Studio and specified with the DISPlay[:WINdow]:DIALog:OPEN command.
If <type> is FLOat then <unit> has to be specified, too. |
|||
Parameters |
Name |
Type |
Range |
Default |
<name> |
Quoted string |
|
– |
|
<type> |
NR1|NR3|Quoted string |
INTeger|FLOat|STRing |
– |
|
<unit> |
Discrete |
UNKNown|VOLT| AMPEr|WATT|JOULe|SECOnd|OHM|FARAd|HERTz |
– |
|
Usage example |
DISP:DIAL:DATA "test", INT |
|||
Related Commands |
DISPlay[:WINdow]:DIALog:OPEN |
5.4.9. DISPlay[:WINdow]:DLOG
Syntax |
DISPlay[:WINdow]:DLOG [<filename>] |
|||
Description |
This command opens DLOG viewer and displays specified by filename. If filename is omitted it displays the last log file during or after recording is finished. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
1 – 255 characters |
– |
|
Usage example |
DISP:DLOG "Recording/test_log.dlog" |
|||
Related Commands |
INITiate:DLOG INITiate:DLOG:TRACe |
5.4.10. DISPlay[:WINdow]:ERRor
Syntax |
DISPlay[:WINdow]:ERRor {<message>} |
|||
Description |
Use this command to display message box and generates error beep tone. |
|||
Parameters |
Name |
Type |
Range |
Default |
<message> |
Quoted string |
1 – 128 characters |
– |
|
Usage example |
DISP:ERR "Test message!" |
|||
Related Commands |
DISPlay[:WINdow]:TEXT SYSTem:BEEPer[:IMMediate] |
5.4.11. DISPlay[:WINdow]:INPut
Syntax |
DISPlay[:WINdow]:INPut? {<label>}, {<type>} [, <min>, <max>, <value>] |
|||
Description |
Use this command to define input field on the display that can returns a value of type <type> which can be TEXT | NUMBer | INTeger | MENU. The following variants are possible:
<min> and <max> values should be defined for TEXT, NUMBer and INTeger. For NUMBer and INTeger this is the minimum and maximum allowable value, and for STRing it is the minimum and maximum allowable text length. NUMBer should also be set to <unit> (see above which units are allowed). If <type> is MENU then you should set <menu_type> (which can only be BUTTon) and up to max. 4 menu items (button texts) to be offered for selection. A numeric keypad will be open for NUMBer and INTeger, and a full keypad will be open for TEXT. The default <label> (quoted string) will be displayed on the screen. In all variants except MENU (where no need to be specified), the <value> parameter is the initial (or default) value. |
|||
Parameters |
Name |
Type |
Range |
Default |
<label> |
Quoted string |
– |
– |
|
|
<type> |
Discrete |
TEXT|NUMBer|MENU |
|
Return |
This query returns value of defined type. |
|||
Usage example |
DISP:INP? "Enter you text", TEXT, 2, 10, "Hello" "Test" |
5.4.12. DISPlay[:WINdow]:SELect?
Syntax |
DISPlay[:WINdow]:SELect? {<defaultSelection>, {<optionText>}[, …] |
|||
Description |
Display pop-up display with multiple radio buttons. The <defaultSelection> specify which of the presented option will be selected by default. |
|||
Parameters |
Name |
Type |
Range |
Default |
<defaultSelection> |
NR1 |
1 to the total number of options |
– |
|
|
<optionText> |
Quoted string |
– |
– |
Return |
The query returns NR1 value of the selected option. |
|||
Usage example |
Default option is 2 and query returns 3 when "Option 3" is selected: DISP:SEL? 2, "Option 1", "Option 2", "Option 3" 3 |
|||
Related Commands |
DISPlay[:WINdow]:DIALog:CLOSe DISPlay[:WINdow]:DIALog:DATA DISPlay[:WINdow]:INPut |
5.4.13. DISPlay[:WINdow]:TEXT
Syntax |
DISPlay[:WINdow]:TEXT {<text message>} DISPlay[:WINdow]:TEXT? |
|||
Description |
Display a message on the front panel TFT display. The BB3 will display up to 32 characters in a message. |
|||
Parameters |
Name |
Type |
Range |
Default |
<text message> |
Quoted string |
– |
– |
|
Return |
Query the message sent to the front panel TFT display and returns a quoted string. |
|||
Usage example |
Send "Hello world" textual message: DISP:TEXT "Hello world" |
|||
Related Commands |
DISPlay[:WINdow]:TEXT:CLEar |
5.4.14. DISPlay[:WINdow]:TEXT:CLEar
Syntax |
DISPlay[:WINdow]:TEXT:CLEar |
Description |
Clear the message displayed on the front panel TFT display. |
Return |
None |
Usage example |
DISP:TEXT:CLE |
Related Commands |
DISPlay[:WINdow]:TEXT |
5.5. FETCh (not implemented yet)
Fetch commands return measurement data that has been previously acquired. FETCh queries do not generate new measurements, but allow additional measurement calculations from the same acquired data.
5.6. HCOPy (not implemented yet)
The Hardcopy commands are used to print the entire display to a specified file rather than “printing” to an external device.
5.7. INITiate
INITiate commands initialize the trigger system. This enables the trigger system to receive triggers.
SCPI command |
Description |
INITiate |
|
Completes one full trigger cycle |
|
Initiates automated internal data log session |
|
|
|
Enables/disables continuous transient triggers |
5.7.1. INITiate
Syntax |
INITiate[:IMMediate] |
Description |
The INITiate command is used to initialize the trigger system of the BB3. This command completes one full trigger cycle when the trigger source is an IMMediate and initiates the trigger subsystem when the trigger source is BUS.
For example, when the IMMediate is selected as a trigger source, an INITiate command immediately transfers the VOLTage:TRIGgered[:AMPLitude] and CURRent:TRIGgered[:AMPLitude] values to VOLTage[:LEVel][:IMMediate][:AMPLitude] and CURRent[:LEVel][:IMMediate][:AMPLitude] values. Any delay is ignored.
Execution of this command also affects bit 5 (Waiting for TRIGger) of the Operation Instrument Isummary register (see Section 3.3.2). |
Usage example |
Generate a trigger operation after 5 seconds: TRIG:SOUR BUS TRIG:DEL 5 INIT *TRG |
Errors |
-213,"Init ignored" 307,"List lengths are not equivalent" 308,"Cannot be changed while transient trigger is initiated" 309,"Cannot initiate while in fixed mode" |
Related Commands |
*TRG INSTrument:COUPle:TRIGger |
5.7.2. INITiate:DLOG
Syntax |
INITiate:DLOG {<filename>} |
||||||||
Description |
The command starts automated internal data logging session. All selected measurements defined with SENSe:DLOG:FUNCtion:CURRent, SENSe:DLOG:FUNCtion:POWer and SENSe:DLOG:FUNCtion:VOLTage commands will be recorded periodically in the specified log filename that is formatted as described below. The data logging session will last until time specified with the SENSe:DLOG:TIME not expired or is not interrupted prematurely using the e.g. ABORt:DLOG, SYSTem:REStart or *RST command.
Log file format
Data log structure allows recording of multiple values simultaneously that can be also viewed simultaneously on the same X-Y graph as in case of e.g. curve tracer when each Y-axis data set (column) represents one trace. This minimizes the required size of the data log file because the X-axis content is common for multiple values to be displayed on the Y-axis. Data log file contains fixed header, flexible header and data section.
Fixed header The fixed header includes the following information in little-endian format, i.e. the least significant byte (LSB) value is at the lowest address:
|
||||||||
|
Position |
Type |
Description |
||||||
|
0 – 7 |
ASCII |
Always contains “EEZ-DLOG” text in ASCII format |
||||||
|
8 – 9 |
UINT16 |
File format version (e.g. 0x00 0x02) |
||||||
|
10 – 11 |
UINT16 |
Number of columns |
||||||
|
12 – 15 |
UINT32 |
File offset to data rows |
||||||
|
Flexible header The flexible header contains meta information about data that follows. The number of fields defined in the flexible header is arbitrary (hence the name flexible header) formatted as follows:
<Field 1 length><Field 1 ID><Field 1 data> <Field 2 length><Field 2 ID><Field 2 data> <Field 3 length><Field 3 ID><Field 3 data> … <Field N length><Field N ID><Field N data>
|
||||||||
|
Name |
Length |
|
Description |
|||||
|
Field length |
UINT16 |
|
Total length of the field. |
|||||
|
Field ID |
UINT8 |
|
Field unique identification number (see below the list of currently supported fields). |
|||||
|
Field data |
For example if the <Field ID> is 14 or "X-axis label", then the field is of type String. Text string begins with UINT16 that contains its length, followed by length * UINT8 data. |
|
Field data as specified below in the list of currently supported fields. |
|||||
|
|
|
|||||||
|
List of currently supported fields:
|
||||||||
|
ID |
Name |
Data type |
Description |
|||||
|
1 |
Comment |
String |
Data log user comment. Max. length is 128 characters. |
|||||
|
10 |
Unit |
UINT8 |
0 – Unknown 1 – Volt 3 – Ampere 6 – Watt 8 – Second 12 – Ohm 16 – Hertz 17 – Joule/Ws 21 – Farad |
|||||
|
11 |
X-axis step |
Float |
X-axis resolution in units as specified in ID10. For example, if X-axis unit is 8 (seconds), when period of data logger is set to 20 ms this field will contains 0.02. |
|||||
|
12 |
X-axis range min value |
Float |
X-axis minimal or starting value which is 0 in most of the cases. |
|||||
|
13 |
X-axis range max value |
Float |
X-axis maximal or ending value. |
|||||
|
14 |
X-axis label |
String |
X-axis data description |
|||||
|
15 |
X-axis scale |
UINT8 |
0 – Linear 1 – Logarithmic |
|||||
|
30 |
Y-axis unit |
UINT8 + UINT8 |
First UINT8 value specifies column number and second UINT8 contains Y-axis unit similar as X-axis unit specified under ID10. |
|||||
|
32 |
Y-axis range min value |
UINT8 + Float |
UINT8 value specifies column number followed by minimum recorded value. |
|||||
|
33 |
Y-axis range max value |
UINT8 + Float |
UINT8 value specifies column number followed by maximum recorded value. For example for uncoupled DCP405 module that will be 40 V and 5 A or for coupled in series or parallel 80 V or 10 A. This parameter is used by Auto-scale option in BB3 built-in log viewer. |
|||||
|
34 |
Y-axis label |
UINT8 + String |
UINT8 value specifies column number followed by Y-axis data description. This field is optional and if its value is not defined, the data log viewer (e.g. BB3 built-in viewer) could generate it from the channel number and unit symbol, for example: U1 for recorded voltage on the channel 1. |
|||||
|
35 |
Y-axis channel |
UINT8 + UINT8 |
First UINT8 value specifies column number and second UINT8 contains instrument channel that is recorded |
|||||
|
36 |
Y-axis scale |
UINT8 + UINT8 |
Similar to X-axis scale: first UINT8 value specifies column number and second UINT8 can contains: 0 – Linear 1 – Logarithmic |
|||||
|
50 |
Channel module type |
UINT8 + UINT16 |
UINT8 value specifies channel number, and UINT16 contains module type ID as follows: 220 – DCM220 405 – DCP405 |
|||||
|
51 |
Channel revision |
UINT8 + UINT16 |
UINT8 value specifies channel number, and UINT16 contains module version number, for example 0x0206 for “R2B6”. |
|||||
|
Logged data |
||||||||
|
For the each X-axis step the series of Y values (columns) are recorded. All Y values are of type float.
<Y1 value><Y2 value>…<Yn value> <Y1 value><Y2 value>…<Yn value> …
This command will automatically set the following fields:
For example when voltage and current are logged for channel 1 and 2 on two DCP405 modules, additional fields will be populated as follows:
|
||||||||
Parameters |
Name |
Type |
Range |
Default |
|||||
|
<filename> |
Quoted string |
File name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|||||
Usage example |
Start data logging of channel 1 voltage and current with resolution of 0.1 seconds that lasts 60 seconds: SENS:DLOG:PER 0.1 SENS:DLOG:TIME 60 SENS:DLOG:FUNC:VOLT ON, CH1 SENS:DLOG:FUNC:CURR ON, CH1 INIT:DLOG "Recordings/test_log.dlog" |
||||||||
Related Commands |
*RST ABORt:DLOG DISPlay[:WINdow]:DLOG INITiate:DLOG:TRACe MMEMory:INFOrmation? SENSe:DLOG:FUNCtion:CURRent SENSe:DLOG:FUNCtion:POWer SENSe:DLOG:FUNCtion:VOLTage SENSe:DLOG:PERiod SENSe:DLOG:TIME |
5.7.3. INITiate:DLOG:TRACe
Syntax |
INITiate:DLOG:TRACe {<filename>} |
|||
Description |
The command starts internal data logging session. Single X-axis and multiple Y-axis are allowed as in case on the INITiate:DLOG:TRACe command, but offering more flexibility in defining recording parameters. The duration of data logging is not defined in advance and new data can be added until termination command is not executed e.g. ABORt:DLOG, SYSTem:REStart or *RST command. |
|||
Parameters |
Name |
Type |
Range |
Default |
|
<filename> |
Quoted string |
File name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
Usage example |
Data logging is a four step process as follows:
1. Define X- and Y-axis parameters. Number of Y-axis is arbitrary and two is used in this example. Data log file remark is not mandatory. SENS:DLOG:TRAC:X:UNIT SECO SENS:DLOG:TRAC:X:STEP 0.01 SENS:DLOG:TRAC:X:RANG:MIN 0 SENS:DLOG:TRAC:X:RANG:MAX 20 SENS:DLOG:TRAC:X:LAB "t" SENS:DLOG:TRAC:Y1:UNIT VOLT SENS:DLOG:TRAC:Y1:LAB "U" SENS:DLOG:TRAC:Y1:RANG:MIN 0 SENS:DLOG:TRAC:Y1:RANG:MAX 40 SENS:DLOG:TRAC:Y2:UNIT AMPE SENS:DLOG:TRAC:Y2:LAB "I" SENS:DLOG:TRAC:Y2:RANG:MIN 0 SENS:DLOG:TRAC:Y2:RANG:MAX 5 SENS:DLOG:TRAC:X:SCAL LIN SENS:DLOG:TRAC:Y:SCAL LIN 2. Define data log filename and comment/description. SENS:DLOG:TRAC:REM "data log test" INIT:DLOG:TRAC "Recordings/test_log.dlog" 3. Add arbitrary number of recordings: SENS:DLOG:TRAC:DATA 10.1,2.55 SENS:DLOG:TRAC:DATA 12.0,2.66 SENS:DLOG:TRAC:DATA 16.34,3.63 … 4. Close data logging session. ABOR:DLOG |
|||
Related Commands |
*RST ABORt:DLOG DISPlay[:WINdow]:DLOG INITiate:DLOG MMEMory:INFOrmation? SENSe:DLOG:TRACe:REMark SYSTem:REStart |
5.7.4. INITiate:CONTinuous
Syntax |
INITiate:CONTinuous {<bool>} INITiate:CONTinuous? |
|||
Description |
This command is used to select whether the trigger system is continuously initiated or not. With CONTinuous set to OFF, the trigger system remain in the IDLE state until CONTinuous is set to ON or INITiate:IMMediate is received. Once CONTinuous is set to ON, the trigger system will be initiated and exit the IDLE state. On completion of each trigger cycle, with CONTinuous ON, the trigger system immediately commence another trigger cycle without entering the IDLE state. When INITiate:CONTinuous is set to OFF, the current trigger cycle will be completed before entering the IDLE state. The return to IDLE also occur as the result of an ABORt or *RST command.
The ABORt command force the trigger system to the IDLE state; however, the value of INITiate:CONTinuous is unaffected.
If INITiate:CONTinuous was set to ON prior to receiving ABORt, it remains ON and the trigger system immediately exit the IDLE state. |
|||
Parameters |
Name |
Type |
Range |
Default |
|
<bool> |
Boolean |
OFF|ON|0|1 |
OFF |
Return |
The query command returns 0 if continuous transients are disabled (OFF), and 1 if continuous transients are enabled (ON). |
|||
Usage example |
INIT:CONT ON |
|||
Related Commands |
*RST ABORt |
5.8. INSTrument
Each channel of the BB3 is considered as separate (logical) instrument, which is required by the SCPI standard. The INSTrument subsystem provides a mechanism to identify and select instruments and establish coupling to simplify programming of more channels at once.
SCPI command |
Description |
INSTrument |
|
Selects the output to be programmed |
|
Returns a quoted string of the list of valid choices for the instrument channels |
|
Returns a list of string – number pairs |
|
:COUPle |
|
Selects independent, common ground-tracking, split rail-tracking, parallel-tracking, or series-tracking mode |
|
Selects a coupling between channels trigger systems |
|
:DISPlay |
|
Sets full scale value |
|
Selects output value on the specified display trace |
|
Swaps positions of selected output values |
|
:YT |
|
Selects YT view sample duration |
|
Selects the output to be programmed |
5.8.1. INSTrument[:SELect]
Syntax |
INSTrument[:SELect] {<channel>} INSTrument[:SELect]? |
|||
Description |
This command selects the output to be programmed by the output identifier. The outputs of the BB3 are considered as separate logical instruments. The INSTrument command provides a mechanism to identify and select an output. When one output is selected, the other output is unavailable for programming until selected. The following commands are affected by the INSTrument command: SOURce, MEASure, and CALibration. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
Query returns the currently selected output by the INSTrument[:SELect] or INSTrument:NSELect command. The returned value is (@ncc), where n is the instrument slot number and cc is the instrument channel number. |
|||
Usage example |
Select power channel and determine its position in slot 1: INST CH1 INST:SEL? (@101)
Select AO1 channel on the SMX46 module installed in slot 3: INST (@301) |
|||
Related Commands |
INSTrument:CATalog? INSTrument:CATalog:FULL? INSTrument:NSELect |
5.8.2. INSTrument:CATalog?
Syntax |
INSTrument:CATalog? |
Description |
This query returns a comma-separated list of strings which contains the names of all logical instruments. If no logical instruments are defined, a single null string is returned.
Returned names can only be used with the INSTrument[:SELect] command. |
Usage example |
INST:CAT? "CH1","CH2","CH3","CH4" |
Related Commands |
INSTrument[:SELect] INSTrument:CATalog:FULL? INSTrument:NSELect |
5.8.3. INSTrument:CATalog:FULL?
Syntax |
INSTrument:CATalog:FULL? |
Description |
Use this query to get a list of string – number pairs. The string contains the name of the logical instrument. The immediately following NR1-formatted number is its associated logical instrument number. All response data elements are comma separated. If no logical instrument is defined, a null string followed by a zero is returned.
Returned logical instrument numbers can only be used with the INSTrument:NSELect command. |
Usage example |
INST:CAT:FULL? "CH1",1,"CH2",2 |
Related Commands |
INSTrument[:SELect] INSTrument:CATalog? INSTrument:NSELect |
5.8.4. INSTrument:COUPle:TRACking
Syntax |
INSTrument:COUPle:TRACking {<type>} INSTrument:COUPle:TRACking? |
|||
Description |
This command selects how channel’s outputs will be internally connected:
When channels are coupled, resulting output will be present on different output terminals as indicated with red module’s OE LED instead of green OE LED. Coupled channels in series or parallel will be seen as single channel. Therefore the following commands will affect the both channel regardless of which channel is currently selected using the INSTrument[:SELect] or INSTrument:NSELect command):
The following channel specific commands will generate a device specific error 312 when channels are coupled:
Channels coupled in parallel could have only one down-programmer circuit active that is on the channel 1. State of the channel 2 down-programmer will always be off regardless of what is set with the OUTPut:DPRog command.
If channels are calibrated (CAL:STAT? 1) a max. value of the channel that has lower calibrated value will be used as a reference and multiplied by two. For example, if channel 1 max. voltage is 39.98 V and channel 2 max. voltage is 40.00 V the new max. value for the SERies-tracking will become 79.96 V instead of 80.00 V.
Two conditions requires special attention: that is entering CC mode while channels are coupled in SERies or entering CV mode when PARallel coupling is active. For example when coupled in SERies and output voltage is set to 60 V and current to 1.7 A with connected load of 1 Ω the power module will enters the CC mode of operation (see OUTPut:MODE?) and output voltage will drop to 1.7 V. Coupling mechanism will set both channels to 30 V (initally set value divided by two) but that value cannot be maintained on any output and there is no warranty that new voltage will be equally shared between channels (i.e. 1.7 / 2 = 1.35 V per channel). It’s even possible that outputs become unbalanced in a way that one of the channels becomes negative like -0.6 V on one channel and +2.3 V on another that still resulting in required +1.7 V limited by max. current. To avoid such situation coupling mechanism also include balancing to ensure that such deviation when one channel is pushed to sink instead of source power is rectified. That is accomplished by calculating and set more appropriate output voltage values during the CC mode of operation. The measured output voltage (using the MEASure[:SCALar][:VOLTage][:DC]? Command) will return that newly programmed value, that could be e.g. 30.93 V instead of 60 V. When output come back to CV mode of operation (e.g. load is disconnected), initial set 60 V will be measured again.
Execution of this command also affects bit 8 (PARAlell) or bit 9 (SERies) of the Operation status register (see Section 3.3).
At *RST, channels will be uncoupled (NONE). |
|||
Parameters |
Name |
Type |
Range |
Default |
<type> |
Discrete |
NONE|CGND|SRAil|PARallel|SERies |
NONE |
|
Return |
Query returns the currently selected output coupling state. |
|||
Usage example |
INST:COUP:TRAC SER VOLT 70 VOLT? 70.00 INST:COUP:TRAC PAR CURR 9 CURR? 9.00 |
|||
Errors |
312,"Cannot execute when the channels are coupled" |
|||
Related Commands |
*SAV MEASure[:SCALar]:CURRent[:DC] MEASure[:SCALar][:VOLTage][:DC] OUTPut:DPRog OUTPut:MODE? OUTPut:TRACk[:STATe] |
5.8.5. INSTrument:DISPlay:SCALe[<n>]
Syntax |
INSTrument:DISPlay:SCALe[<n>] {<value>} INSTrument:DISPlay:SCALe[<n>]? |
|||
Description |
This command sets the full scale vale of YT and bar graph views on the display position (trace) defined with [<n>]. |
|||
Parameters |
Name |
Type |
Range |
Default |
<value> |
Discrete|NR2 |
AUTO|LIMit|MAXimum |
– |
|
Return |
Query returns the currently selected full scale value on the selected display position (trace). |
|||
Usage example |
INST:DISP:SCAL2? "LIM" |
|||
Errors |
-222,"Data out of range" |
|||
Related Commands |
DISPlay:VIEW |
5.8.6. INSTrument:DISPlay:TRACe[<n>]
Syntax |
INSTrument:DISPlay:TRACe[<n>] {<value>} INSTrument:DISPlay:TRACe[<n>]? |
|||
Description |
This command sets the output value that will be displayed on the display position (trace) defined with [<n>]. This command affects only display modes 2, 3 and 4 (see the DISPlay:VIEW command). An attempt to select the same value on both positions (traces) will generate an execution error. |
|||
Parameters |
Name |
Type |
Range |
Default |
<value> |
Discrete |
VOLTage|CURRent|POWer |
– |
|
Return |
Query returns the currently selected displayed output value on the selected display position (trace). |
|||
Usage example |
INST:DISP:TRAC2? "CURR" |
|||
Errors |
-200,"Execution error" |
|||
Related Commands |
DISPlay:VIEW INSTrument:DISPlay:TRACe:SWAP INSTrument:DISPlay:YT:RATE |
5.8.7. INSTrument:DISPlay:TRACe:SWAP
Syntax |
INSTrument:DISPlay:TRACe:SWAP |
Description |
Use this command to swap output values display positions. |
Usage example |
INST:DISP:TRAC1? "VOLT" INST:DISP:TRAC2? "CURR" INT:DISP:TRAC:SWAP INST:DISP:TRAC1? "CURR" INST:DISP:TRAC2? "VOLT" |
Related Commands |
DISPlay:VIEW INSTrument:DISPlay:TRACe[<n>] {<value>} INSTrument:DISPlay:YT:RATE |
5.8.8. INSTrument:DISPlay:YT:RATE
Syntax |
INSTrument:DISPlay:YT:RATE {<duration>} INSTrument:DISPlay:YT:RATE? |
|||
Description |
This command sets the sample duration in seconds when YT (mode 4, see the DISPlay:VIEW command) display view is selected. |
|||
Parameters |
Name |
Type |
Range |
Default |
<duration> |
NR2 |
0.02 – 300 |
0.1 |
|
Return |
The query command returns the programmed sample duration in seconds. |
|||
Usage example |
INST:DISP:YT:RATE 10 |
|||
Related Commands |
DISPlay:VIEW INSTrument:DISPlay:TRACe[<n>] {<value>} INSTrument:DISPlay:TRACe:SWAP |
5.8.9. INSTrument:COUPle:TRIGger
Syntax |
INSTrument:COUPle:TRIGger {<mode>} INSTrument:COUPle:TRIGger? |
|||
Description |
Not implemented yet
This command defines a coupling between channels trigger systems. Use ALL parameter to couple or NONE to remove coupling.
At *RST, trigger systems are uncoupled. |
|||
Parameters |
Name |
Type |
Range |
Default |
<mode> |
ChannelList |
ALL|CH1|CH2|CH3|CH4|CH5|CH6|NONE |
ALL |
|
Return |
This query returns the currently coupled output. |
|||
Usage example |
INST:SEL CH1 VOLT:TRIG 12 CURR:TRIG 1.5 INST:SEL CH2 VOLT:TRIG 5 CURR:TRIG MAX INST:COUP:TRIG ALL TRIG:SOUR IMM INIT |
|||
Related Commands |
*RST INSTrument:COUPle:TRACking |
5.8.10. INSTrument:NSELect
Syntax |
INSTrument:NSELect {<channel>} INSTrument:NSELect? |
|||
Description |
This command is used in conjunction with the SELect command. It serves the same purpose, except that it uses a numeric value instead of the identifier used in the SELect command. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
NR1 |
1 – 6 |
– |
|
Return |
When queried it returns the logical instrument number of the currently selected BB3 channel. Note that the numbering used for logical instruments directly corresponds to the numbers used in status reporting for multiple instruments; specifically the STATus:QUEStionable:INSTrument and STATus:OPERation:INSTrument commands. |
|||
Usage example |
INST:NSEL 2 INST:NSEL? 2 |
|||
Related Commands |
STATus:QUEStionable:INSTrument STATus:OPERation:INSTrument |
5.9. MEASure
Measure commands return back the output voltage, current, power or temperature. They trigger the acquisition of new data before returning the reading. Measurements are performed by digitizing the instantaneous output voltage, current or temperature. Output power is calculated as product of measured voltage and current. Keyword [:DC] is optional since all measurement are by default of the DC level of the signal.
SCPI command |
Description |
MEASure |
|
Takes a measurement; returns digital logic state |
|
[:SCALar] |
|
:CURRent |
|
Takes a measurement; returns the average current |
|
:POWer |
|
Takes a measurement; returns the average power |
|
[:VOLTage] |
|
Takes a measurement; returns the average voltage |
|
:TEMPerature |
|
Takes a measurement; returns the average temperature |
5.9.1. MEASure:DIGital[:BYTE]
Syntax |
MEASure:DIGital[:BYTE]? [<channel>] |
|||
Modules |
MIO |
|||
Description |
Query the digital logic state of the all 8 digital inputs on the MIO168 module. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
(@n01) where n is the slot number |
– |
|
Return |
Returns a binary-weighted decimal representing the bits set on the selected digital input channel. |
|||
Usage example |
MEAS:DIG? (@101) 3 |
|||
Related Commands |
SOURce:DIGital:SPEed SOURce:DIGital:RANGe |
5.9.2. MEASure[:SCALar]:CURRent[:DC]
Syntax |
MEASure[:SCALar]:CURRent[:DC]? [<channel>] |
|||
Modules |
DCP DCM MIO |
|||
Description |
Query the current measured across the current sense resistor inside the power module. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
Returns the average output current in amperes as decimal number (NR2). |
|||
Usage example |
Measure current on the currently selected channel (CH1) and CH2: MEAS:CURR?;:MEAS:CURR? CH2 1.23;0.12 |
|||
Related Commands |
INSTrument:COUPle:TRACking |
5.9.3. MEASure[:SCALar]:POWer[:DC]
Syntax |
MEASure[:SCALar]:POWer[:DC]? [<channel>] |
|||
Modules |
DCP DCM |
|||
Description |
Query the output power calculated as product of measured voltage and current value. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
Returns the average output power in watts as decimal number (NR2). |
|||
Usage example |
MEAS:POW? CH2 80.44 |
|||
Related Commands |
|
5.9.4. MEASure[:SCALar][:VOLTage][:DC]
Syntax |
MEASure[:SCALar][:VOLTage][:DC]? [<channel>] |
|||
Modules |
DCP DCM MIO |
|||
Description |
Query the voltage measured at the sense terminals of the selected channel. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
Returns the average output voltage in volts as decimal number (NR2). |
|||
Usage example |
MEAS:VOLT? CH1 43.25 Query voltage of the channel 2 that is currently selected: INST CH2 MEAS? 12.40 |
|||
Related Commands |
INSTrument:COUPle:TRACking |
5.9.5. MEASure[:SCALar]:TEMPerature[:THERmistor][:DC]
Syntax |
MEASure[:SCALar]:TEMPerature[:THERmistor][:DC]? [<chanlist>] |
|||
Modules |
MUX |
|||
Description |
Query the temperature measured on the temperature sensor of the selected channel. |
|||
Parameters |
Name |
Type |
Range |
Default |
<chanlist> |
ChannelList |
MUX: (@n31) where n is the slot number |
– |
|
Return |
Returns the average output voltage in volts as decimal number (NR2). |
|||
Usage example |
MEAS:TEMP? (@131) 29 |
|||
Related Commands |
SYSTem:MEASure[:SCALar]:TEMPerature[:THERmistor][:DC] |
5.10. MEMory
The MEMory subsystem works with BB3 state files that are saved to (*SAV) and recalled from (*RCL) non-volatile storage locations numbered 0 through 9. The storage location 0 named “Power down state” is used to store the current BB3 parameters.
SCPI command |
Description |
MEMory |
|
Returns total number of state storage memory locations |
|
:STATe |
|
Lists the names associated with all ten state storage locations |
|
Deletes the contents of a state storage location |
|
:ALL |
Deletes the contents of all state storage locations |
Freezes saving changes into profile 0 |
|
Assigns a custom name to a state storage locations |
|
:RECall |
|
Specifies whether the power-down state is recalled from location 0 on power-on |
|
Specifies which BB3 state will be used at power on |
|
Determines whether a storage location contains a valid state |
5.10.1. MEMory:NSTates
Syntax |
MEMory:NSTates? |
Description |
Returns the total number of *SAV/*RCL states available in the BB3. |
Return |
Returns numeric value (NR1) which is one greater than the maximum that can be sent as a parameter to the *SAV and *RCL commands. |
Usage example |
MEM:NST? 10 |
5.10.2. MEMory:STATe:CATalog
Syntax |
MEMory:STATe:CATalog? |
Description |
This query requests a list of defined names in the MEMory:STATe subsystem. |
Return |
The BB3 returns a list of defined <name>’s in a comma separated list. Each <name> is returned in a quoted string. |
Usage example |
MEM:STAT:CAT? "", "12V/1A", "list V", "4ch", "tracking", "parallel", "long lists", "list all channels", "Saved at 2019-10-22 09:33:55", "–Empty–" |
Related Commands |
MEMory:STATe:NAME
|
5.10.3. MEMory:STATe:DELete
Syntax |
MEMory:STATe:DELete {<profile>} MEMory:STATe:DELete:ALL |
|||
Description |
When used with a profile number this command deletes the contents of the specified storage location. The MEMory:STATe:DELete:ALL deletes the contents of storage locations 1 through 9.
An error is generated on an attempt to recall a deleted state. |
|||
Parameters |
Name |
Type |
Range |
Default |
<profile> |
NR1 |
1 – 9 |
– |
|
Return |
None |
|||
Usage example |
MEM:STAT:DEL 2 |
|||
Related Commands |
*RCL *SAV |
5.10.4. MEMory:STATe:FREEze
Syntax |
MEMory:STATe:FREEze {<bool>} MEMory:STATe:FREEze? |
|||
Description |
This command prohibits saving any further changes to profile 0. It can be used, for example, to freeze program states before running the MicroPython script because the script will change some of the parameters. Once the script is complete, saving changes caused by further user activity can be re-enabled. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
– |
|
Return |
The command returns 0 if saving changes to profiles 0 is enabled, or returns 1 if saving changes to profiles 0 is disabled. |
|||
Usage example |
MEM:STAT:FREE 1 |
|||
Related Commands |
*SAV |
5.10.5. MEMory:STATe:NAME
Syntax |
MEMory:STATe:NAME {<profile>}, {<name>} MEMory:STATe:NAME? {<profile>} |
|||
Description |
This command associates a <name> with a *SAV/*RCL register number. May assign same name to different locations and state names are unaffected by *RST. Deleting a storage location’s contents MEMory:STATe:DELete resets associated name to “–Empty–” |
|||
Parameters |
Name |
Type |
Range |
Default |
<profile> |
NR1 |
1 – 9 |
– |
|
<name> |
Quoted string |
0 to 32 characters |
– |
|
Return |
Returns a *SAV/*RCL register number associates with profile number. |
|||
Usage example |
MEM:STAT:DEF, 2, "All outputs on" MEM:STAT:DEF? 2 "All outputs on" |
|||
Related Commands |
MEMory:STATe:DELete
|
5.10.6. MEMory:STATe:RECall:AUTO
Syntax |
MEMory:STATe:RECall:AUTO {<bool>} MEMory:STATe:RECall:AUTO? |
|||
Description |
This command disables or enables the automatic recall of a specific stored BB3 state selected using the MEMory:STATe:RECall:SELect command when power is turned on. Select ON to automatically recall one of the ten stored states or the “power-down” state (location 0) when power is turned on. Select OFF to issue a reset (*RST) when power is turned on. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
– |
|
Return |
The query command returns 0 (OFF) or 1 (ON). |
|||
Usage example |
MEM:STAT:REC:AUTO? 1 |
|||
Related Commands |
*SAV MEMory:STATe:RECall:SELect SYSTem:POWer |
5.10.7. MEMory:STATe:RECall:SELect
Syntax |
MEMory:STATe:RECall:SELect {<profile>} MEMory:STATe:RECall:SELect? |
|||
Description |
This command selects which BB3 state will be used at power on if the automatic recall mode is enabled (see MEMory:STATe:RECall:AUTO ON command). If the automatic recall mode is disabled (MEMory:STATe:RECall:AUTO OFF), then a “factory reset” (return to the default values) is issued when power is turned on. |
|||
Parameters |
Name |
Type |
Range |
Default |
<profile> |
NR1 |
0 – 9 |
– |
|
Return |
The query command returns numeric value (NR1) for 0 to 9 indicating which instrument state will be used at power on. |
|||
Usage example |
MEM:STAT:REC:SEL? 2 |
|||
Related Commands |
*SAV MEMory:STATe:RECall:AUTO SYSTem:POWer |
5.10.8. MEMory:STATe:VALid
Syntax |
MEMory:STATe:VALid? {<profile>} |
|||
Description |
This command queries the specified storage location to determine if a valid state is currently stored in this location.
Use this command before sending the *RCL command to determine if a valid state has been previously stored on queried location. |
|||
Parameters |
Name |
Type |
Range |
Default |
<profile> |
NR1 |
0 – 9 |
– |
|
Return |
Returns 0 if no state has been stored or if it has been deleted. It returns 1 if a valid state is stored in this location. |
|||
Usage example |
MEM:STAT:VAL? 2 1 |
|||
Related Commands |
*RCL *SAV |
5.11. MMEMory
The MMEMory commands are used to store, read or delete file in the BB3’s SD card. It can also query SD card information. In addition it is used for storing and recalling values used by [SOURce[<n>]]:LIST subsystem. File and directory (folder) names cannot contain the following characters:\ / : * ? " < > |
SCPI command |
Description |
MMEMory |
|
Returns a list of items in the specified directory (folder) |
|
Returns the number of items in the specified directory |
|
Changes the current directory |
|
Copies <source> to <destination> |
|
Returns date that the specified file was last saved |
|
Deletes an existing file |
|
:DOWNload |
|
Aborts current download session |
|
Downloads data from the host computer |
|
Creates or opens the specified filename for download data |
|
Sets information about file size used for progress bar |
|
Sets data handle used to feed data into the file |
|
Returns used and free space |
|
:LOAD |
|
Loads stored LIST to the specified channel |
|
Loads stored user profile |
|
Sets write protection |
|
Makes a new directory |
|
Moves or renames <source> to <destination> |
|
Sets the file name ro be opened or closed |
|
Removes the specified directory |
|
:STORe |
|
Saves specified channel LIST |
|
Saves specified user profile |
|
Returns time that the specified file was last saved |
|
Clears write protection |
|
Uploads data to the host computer |
5.11.1. MMEMory:CATalog
Syntax |
MMEMory:CATalog? [<directory>] |
|||
Description |
Returns the list of files and directories (folders) names, types and sizes in the current or specified directory. Number of items (files/directories) corresponds to the value returned by the MMEMory:CATalog:LENgth? command.
To read out the information in the root directory (folder), specify "\" (backslash) or "/". If <directory> is not set, this function is applied to the current directory. If directory=<path>, this function is applied to <current directory>\<path>.
Error occurs if the specified directory does not exist. |
|||
Parameters |
Name |
Type |
Range |
Default |
<directory> |
Quoted string |
Directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Return |
Returns all files in the directory as list of comma delimited quoted strings of <filename>, <filetype> and <filesize>. The following file types are supported:
|
|||
Usage example |
MMEM:CAT? "USER,FOLD,0","SCPI.PDF,BIN,1274844","SCH5B13A.PDF,BIN,296589",
MMEM:CAT? "USER" "LST_2_3.CSV,BIN,88","FERY2.PDF,BIN,2443" |
|||
Errors |
-250,"Mass storage error" -251,"Missing mass storage" -252,"Missing media" -256,"File name not found" |
|||
Related Commands |
MMEMory:CATalog:LENgth? MMEMory:INFOrmation? MMEMory:DATE? MMEMory:TIME? |
5.11.2. MMEMory:CATalog:LENgth
Syntax |
MMEMory:CATalog:LENgth? [<directory>] |
|||
Description |
This command returns the number of items in the current or specified directory (folder). The result corresponds to the number of files returned by the MMEMory:CATalog? command. |
|||
Parameters |
Name |
Type |
Range |
Default |
<directory> |
Quoted string |
Directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Return |
The query command returns number (NR1) of items (files and directories). |
|||
Usage example |
MMEM:CAT:LEN? "USER" 2 |
|||
Errors |
-256,"File name not found" |
|||
Related Commands |
MMEMory:CATalog? |
5.11.3. MMEMory:CDIRectory
Syntax |
MMEMory:CDIRectory {<directory>} MMEMory:CDIRectory? |
|||
Description |
Changes the current directory to the specified directory (folder). This directory must exist otherwise an error will be generated.
At *RST, this value is set to the root path. |
|||
Parameters |
Name |
Type |
Range |
Default |
<directory> |
Quoted string |
Directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Return |
This query returns the full path of the current directory. |
|||
Usage example |
MMEM:CDIR "TEST/Test folder2" MMEM:CDIR? "TEST/Test folder2" |
|||
Errors |
-256,"File name not found" |
|||
Related Commands |
*RST MMEMory:CATalog? MMEMory:MDIRectory MMEMory:RDIRectory |
5.11.4. MMEMory:COPY
Syntax |
MMEMory:COPY {<source>}, {<destination>} |
|||
Description |
Makes a copy of an existing file in the current directory. The file names must include any file extension. If <destination> is a file name, the copy file is created in the current directory. When <destination> is a <path> (e.g. “test lists/test022”) the source file is duplicated in <current directory>/<path>. |
|||
Parameters |
Name |
Type |
Range |
Default |
<source> |
Quoted string |
Source file name, 1 to 255 characters |
– |
|
<destination> |
Quoted string |
Copy file name or directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEM:COPY "test.bin", "new2/test_new.bin" |
|||
Errors |
-253,"Corrupt media" -254,"Media full" -256,"File name not found" -258,"Media protected" |
|||
Related Commands |
MMEMory:CATalog? MMEMory:CDIRectory MMEMory:LOCK MMEMory:MDIRectory MMEMory:MOVE |
5.11.5. MMEMory:DATE
Syntax |
MMEMory:DATE? {<filename>} |
|||
Description |
Returns the (year, month, day) that the specified file was last saved. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name or directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Return |
Comma-separated numbers (NR1) of year, month, day formated as yyyy, mm, dd |
|||
Usage example |
MMEM:DATE? "test.002" 2017, 10, 1 |
|||
Errors |
-256,"File name not found" |
|||
Related Commands |
MMEMory:TIME |
5.11.6. MMEMory:DELete
Syntax |
MMEMory:DELete {<filename>} |
|||
Description |
Use this command to delete a file in the current directory. If SD card is locked using the MMEMory:LOCK command, an error -258 will be generated. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEM:DEL "test.002" |
|||
Errors |
-256,"File name not found" -258,"Media protected" |
|||
Related Commands |
MMEMory:CATalog? MMEMory:CDIRectory MMEMory:RDIRectory MMEMory:LOCK |
5.11.7. MMEMory:DOWNload:ABORt
Syntax |
MMEMory:DOWNload:ABORt |
Description |
Use this command to abort currenlty running file transfer from the host initiated with the MMEMory:DOWNload:DATA command. If not active file transfer exists, the command will be ignored without generating any error. |
Usage example |
MMEM:ABOR |
Related Commands |
MMEMory:DOWNload:DATA |
5.11.8. MMEMory:DOWNload:DATA
Syntax |
MMEMory:DOWNload:DATA {<block>} |
|||
Description |
Downloads data from the host computer to a file in the SD card. This is a multiple steps process:
Use MMEMory:INFOrmation? command first to check available space. |
|||
Parameters |
Name |
Type |
Range |
Default |
<block> |
Data block |
– |
– |
|
Usage example |
Downloads text Hello world and store into the file "test file" in the current directory. Digit 2 denotes two digits of data length (11). MMEM:DOWN:FNAM "test file" MMEM:DOWN:DATA #211Hello world MMEM:DOWN:FNAM "" |
|||
Errors |
-253,"Corrupt media" -254,"Media full" -258,"Media protected" |
|||
Related Commands |
MMEMory:DOWNload:FNAMe MMEMory:INFOrmation? MMEMory:LOCK |
5.11.9. MMEMory:DOWNload:FNAMe
Syntax |
MMEMory:DOWNload:FNAMe {<filename>} |
|||
Description |
Creates or opens the specified filename prior to writing data to that file with MMEMory:DOWNload:DATA. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEMory:DOWNload:FNAMe "new_list.bin" |
|||
Errors |
-258,"Media protected" |
|||
Related Commands |
MMEMory:DOWNload:DATA |
5.11.10. MMEMory:DOWNload:SIZE
Syntax |
MMEMory:DOWNload:SIZE {<filesize>} |
|||
Description |
This command define filesize used by progress bar displayed on the local console during the file transfer. If filesize is not provided, progress bar will not be displayed. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filesize> |
NR1 |
0 to 2.147.483.648 (2 GiB) as limited by SD Card FAT |
0 |
|
Usage example |
MMEMory:DOWNload:SIZE 124000 |
|||
Related Commands |
MMEMory:DOWNload:DATA MMEMory:DOWNload:FNAMe |
5.11.11. MMEMory:INFOrmation
Syntax |
MMEMory:INFOrmation? |
Description |
Use this command to find out total amount of storage currently used and storage available on the SD card. The sum of that two amounts represents SD card capacity in bytes. |
Return |
The command returns used space and free space as two comma separated integers. |
Usage example |
MMEM:INFO? 3932160,7732461568 |
Related Commands |
MMEMory:DOWNload:DATA |
5.11.12. MMEMory:LOAD:LIST
Syntax |
MMEMory:LOAD:LIST<n> {<filename>} |
|||
Description |
Load stored LIST program from SD card location defined by <filename> to the channel defined with <n>. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEM:LOAD:LIST1 "DC_DC conv testing.list" MMEM:LOAD:LIST2 "DC_DC conv testing.list" TRIG:SOUR BUS INIT *TRG |
|||
Errors |
-200,"Execution error" -256,"File name not found" |
|||
Related Commands |
MMEMory:STORe:LIST[<n>] [SOURce[<n>]]:LIST:COUNt [SOURce[<n>]]:LIST:CURRent[:LEVel] [SOURce[<n>]]:LIST:DWELl [SOURce[<n>]]:LIST:VOLTage[:LEVel] |
5.11.13. MMEMory:LOAD:PROFile
Syntax |
MMEMory:LOAD:PROFile {<filename>} |
|||
Description |
This command loads data from user profile file to the user profile 0. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEM:LOAD:PROF "old settings.profile" |
|||
Errors |
-256,"File name not found" |
|||
Related Commands |
*RCL *SAV MEMory:STATe:RECall:AUTO MMEMory:STORe:PROFile |
5.11.14. MMEMory:LOCK
Syntax |
MMEMory:LOCK {<password>} MMEMory:LOCK? |
|||
Description |
Use this command to enable write protection of SD card. All writing, deleting or modifying attempts on files or directories will generate an error if SD card is locked. |
|||
Parameters |
Name |
Type |
Range |
Default |
<password> |
Quoted string |
System password (4 to 16 characters) |
– |
|
Return |
This query returns 0 if SD card is unlocked, or 1 if SD card is locked. |
|||
Usage example |
MMEM:LOCK "test123" MMEM:LOCK? 1 |
|||
Errors |
122,"Invalid sys password" |
|||
Related Commands |
MMEMory:UNLock SYSTem:PASSword:NEW |
5.11.15. MMEMory:MDIRectory
Syntax |
MMEMory:MDIRectory {<directory>} |
|||
Description |
This command creates a new directory. If directory=<path>, this command creates a <current directory>/<path> directory. |
|||
Parameters |
Name |
Type |
Range |
Default |
<directory> |
Quoted string |
Directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEM:MDIR "test folder" |
|||
Errors |
-258,"Media protected" |
|||
Related Commands |
MMEMory:CDIRectory MMEMory:RDIRectory |
5.11.16. MMEMory:MOVE
Syntax |
MMEMory:MOVE {<source>}, {<destination>} |
|||
Description |
This command moves or renames an existing file. If destination is a file name, the source file is renamed to the new file name in the current directory. When destination=<path>, the source file is moved to <current directory>/<path>.
Error occurs if the source file does not exist or the destination file already exists. |
|||
Parameters |
Name |
Type |
Range |
Default |
<source> |
Quoted string |
Source file name, 1 to 255 characters |
– |
|
<destination> |
Quoted string |
New file name or directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
Rename file: MMEM:MOVE "old name","new name" Move file from current directory to “/Test” directory: MMEM:MOVE "new name","/Test/new name" Move and rename file: MMEM:MOVE "/Test/new name","/Documents/new doc" |
|||
Errors |
-256,"File name not found" -258,"Media protected" |
|||
Related Commands |
MMEMory:CDIRectory MMEMory:COPY |
5.11.17. MMEMory:MDIRectory
Syntax |
MMEMory:MDIRectory {<directory>} |
|||
Description |
This command creates a new directory. If directory=<path>, this command creates a <current directory>/<path> directory. |
|||
Parameters |
Name |
Type |
Range |
Default |
<directory> |
Quoted string |
Directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEM:MDIR "test folder" |
|||
Errors |
-258,"Media protected" |
|||
Related Commands |
MMEMory:CDIRectory MMEMory:RDIRectory |
5.11.18. MMEMory:STORe:LIST
Syntax |
MMEMory:STORe:LIST<n> {<filename>} |
|||
Description |
Store LIST program of channel defined with <n> to SD card location defined by <filename>. Stored file type will be TRAC. Default file extension is .list |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEM:STOR:LIST1 "DC_DC conv testing.list" |
|||
Errors |
-258,"Media protected" |
|||
Related Commands |
MMEMory:LOAD:STATe [SOURce[<n>]]:LIST:COUNt [SOURce[<n>]]:LIST:CURRent[:LEVel] [SOURce[<n>]]:LIST:DWELl [SOURce[<n>]]:LIST:VOLTage[:LEVel] |
5.11.19. MMEMory:STORe:PROFile
Syntax |
MMEMory:STORe:PROFile {<filename>} |
|||
Description |
This command stores the BB3 state (i.e. user profile 0) to SD card location defined by <filename>. Stored file type will be STAT. Default file extension is .conf |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Usage example |
MMEM:STOR:PROF "Both channels 5V_3A.profile" |
|||
Errors |
-258,"Media protected" |
|||
Related Commands |
*RCL *SAV MEMory:STATe:RECall:AUTO MMEMory:LOAD:PROFile |
5.11.20. MMEMory:TIME
Syntax |
MMEMory:TIME? {<filename>} |
|||
Description |
Returns the (hours, minute, seconds) that the specified file was last saved. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name or directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Return |
Comma-separated numbers (NR1) of hours, minute, seconds formatted as hh, mm, ss |
|||
Usage example |
MMEM:TIME? "test.002" 22, 10, 14 |
|||
Errors |
-256,"File name not found" |
|||
Related Commands |
MMEMory:DATE |
5.11.21. MMEMory:UNLock
Syntax |
MMEMory:UNLock {<password>} |
|||
Description |
Disable write protection of SD card activated by the MMEMory:LOCK command. |
|||
Parameters |
Name |
Type |
Range |
Default |
<password> |
Quoted string |
System password (4 to 16 characters) |
– |
|
Usage example |
MMEM:LOCK? 1 MMEM:UNL "test123" MMEM:LOCK? 0 |
|||
Errors |
122,"Invalid sys password" |
|||
Related Commands |
MMEMory:LOCK SYSTem:PASSword:NEW |
5.11.22. MMEMory:UPLoad
Syntax |
MMEMory:UPLoad? {<filename>} |
|||
Description |
This command uploads the contents of a file from the instrument to the host computer. The format for <file> is "[<path>]<file_name>", where <path> must be an absolute folder path. If <path> is omitted, the folder specified by the MMEMory:CDIRectory command is used. Absolute paths begin with a "\" or "/" and start at the root folder of SD card. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
File name or directory name, either / (slash) or \ (backslash) can be used as the path separator. 1 to 255 characters |
– |
|
Return |
The query returns the file contents are returned as an IEEE 488.2 definite-length block. |
|||
Usage example |
MMEM:UPL? "test file" #211Hello world |
|||
Errors |
-257,"File name error" |
|||
Related Commands |
MMEMory:DOWNload:DATA |
5.12. OUTPut
The OUTPut subsystem controls the output state, coupling outputs and protections, protection clear and tracking state.
SCPI command |
Description |
OUTPut |
|
Controls the specified channel output state |
|
Controls channel output state with trigger |
|
:DELay |
|
Sets the output start delay duration |
|
Controls down-programmer circuit |
|
Returns the channel mode of operation |
|
:PROTection |
|
Resets latched protection |
|
Enables channel coupling for protection faults |
|
Enables measuring of output voltage before channel output is turned on |
|
Enables channels to operate in the track mode |
5.12.1. OUTPut[:STATe]
Syntax |
OUTPut[:STATe] {<bool>} [, <chanlist>] OUTPut[:STATe]? [<chanlist>] |
|||
Description |
This command enables or disables the specified output channel(s). The enabled state is ON (1); the disabled state is OFF (0). The state of a disabled output is a condition of zero output voltage and zero source current. Execution of this command also affects bit 10 (OE) and bit 11 (DP) of the Operation Instrument Isummary register (see Section 3.3.2). Self-test operation initiated by *TST? command will put all BB3 modules into disable state. When channels are not coupled together (INSTrument:COUPle:TRACking) this command activate green OE LED indicator between output terminals.
Execution of the OUTP ON command on the channel which has one or more protection tripped (OCP, OVP, OPP or OTP) will generate error 201. Use OUTPut:PROTection:CLEar command to clear all tripped protections. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
– |
|
<chanlist> |
ChannelList |
ALL|CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
The query command returns 0 if the output is OFF, and 1 if the output is ON. |
|||
Usage example |
Set and check output on channel 1: OUTP ON, CH1 OUTP? CH1 1 Set outputs on channels 1,2 and 4, and check all outputs state: OUTP ON, (@1:2,4) OUTP? ALL 1,1,0,1 |
|||
Errors |
108,"Cal output disabled" 201,"Cannot execute before clearing protection" |
|||
Related Commands |
*TST INSTrument:COUPle:TRACking OUTPut:PROTection:CLEar [SOURce:]VOLTage:SENSe[:SOURce] |
5.12.2. OUTPut[:STATe]:TRIGgered
Syntax |
OUTPut[:STATe]:TRIGgered {<bool>} [, <channel>] OUTPut[:STATe]:TRIGgered? [<channel>] |
|||
Description |
This command programs the pending triggered channel’s output state. The pending triggered output state is a stored value that is transferred to the output terminals when a trigger occurs. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
– |
|
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
Query the triggered output state presently programmed. If no triggered level is programmed, the OUTPut? state is returned. |
|||
Usage example |
OUTP? 0 OUTP:TRIG ON TRIG:SOUR IMM INIT OUTP? 1 |
|||
Errors |
108,"Cal output disabled" 201,"Cannot execute before clearing protection" |
|||
Related Commands |
*TST OUTPut:PROTection:CLEar [SOURce:]VOLTage:SENSe[:SOURce] |
5.12.3. OUTPut:DELay:DURation
Syntax |
OUTPut:DELay:DURation {<duration>} [, <channel>] OUTPut:DELay:DURation? [<channel>] |
|||
Description |
This command sets the power output turn on delay in seconds on the specified output channel. |
|||
Parameters |
Name |
Type |
Range |
Default |
<duration> |
NR2 |
0.002 – 10 |
– |
|
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
The query command returns the programmed output turn on delay in seconds. |
|||
Usage example |
OUTP:DEL:DUR 0.1 |
|||
Related Commands |
OUTPut:DELay[:STATe] |
5.12.4. OUTPut:DPRog
Syntax |
OUTPut:DPRog {<DprogState>} OUTPut:DPRog? |
|||
Modules |
DCP |
|||
Description |
A down-programmer is a circuit built into the channel’s output of a power module that actively pulls the output voltage down when the programmed output voltage value is moving from a higher setting to a lower setting. The down-programmer circuit is active by default and only rare situation requires to be turned off. One such situation is when battery is connected as a load. Another one is connecting two channel in parallel when only one down-programmer circuit is enough for actively pulls the output voltage down while lower voltage is set. Execution of this command also affects bit 11 (DP) of the Operation Instrument Isummary register (see Section Section 3.3.2).
Despite of the down-programmer state programmed by this command, it will be deactivated when the channel output is turned off (i.e. OUTPut[:STATe] OFF) after DP_OFF_DELAY_PERIOD in seconds). When the channel output is turned on again, down-programmer will be set back to the state programmed with this command.
If negative output power (DP_NEG_LEV) is measured and last more then DP_NEG_DELAY seconds the down-programmer will be switched off and an error 500 will be generated. |
|||
Parameters |
Name |
Type |
Range |
Default |
<DprogState> |
Discrete |
ON|OFF |
ON |
|
Return |
This query returns 0 (OFF) if down-programmer is disabled, or 1 (ON) when down-programmer is enabled. |
|||
Usage example |
OUTP:DPR? "ON" |
|||
Errors |
500,"Down-programmer on CH1 switched off" 501,"Down-programmer on CH2 switched off" |
|||
Related Commands |
OUTPut[:STATe] |
5.12.5. OUTPut:MODE?
Syntax |
OUTPut:MODE? [<channel>] |
|||
Description |
This command simplify resolving a results that can be obtained reading the bit 8 (CV) and 9 (CC) of the read-only Instrument Isummary Operation Status register for a specific channel (see table in the Section 3.3.2). The power module can works in one of the three output modes:
The UR mode is not supported by DCM220 module and in software simulator. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
The query returns CV, CC or UR. |
|||
Usage example |
Set output voltage to 20 V and max. current, check that output voltage is as defined that indicate the constant voltage mode of operation: VOLT 20; CURR MAX MEAS:VOLT? 20.0 OUTP:MODE? CV |
|||
Related Commands |
STATus:OPERation:INSTrument:ISUMmary[<n>][:EVENt] STATus:OPERation:INSTrument:ISUMmary[<n>]:CONDition STATus:OPERation:INSTrument:ISUMmary[<n>]:ENABle |
5.12.6. OUTPut:PROTection:CLEar
Syntax |
OUTPut:PROTection:CLEar [<channel>] |
|||
Description |
This command clears the latched protection status that disables the output when an over-voltage, over-current or a power-limit condition is detected. All conditions that generate the fault must be removed before the latched status can be cleared. The output is restored to the state it was in before the fault condition occurred. |
|||
Parameters |
Name |
Type |
Range |
Default |
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Usage example |
The following command clears the latched protection status on all channels: OUTP:PROT:CLE |
|||
Related Commands |
[SOURce[<n>]]:CURRent:PROTection:STATe [SOURce[<n>]]:POWer:PROTection:STATe [SOURce[<n>]]:VOLTage:PROTection:STATe |
5.12.7. OUTPut:PROTection:COUPle
Syntax |
OUTPut:PROTection:COUPle {<bool>} OUTPut:PROTection:COUPle? |
|||
Description |
This command enables or disables output coupling for protection faults. When enabled, all output channels are disabled when a protection fault occurs on any output channel. When disabled, only the affected output channel is disabled when a protection fault is triggered. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
OFF |
|
Return |
The query command returns 0 if the protection coupling is OFF (disabled), and 1 if the protection coupling is ON (enabled). |
|||
Usage example |
OUTP:PROT:COUP ON OUTP:PROT:COUP? 1 |
|||
Related Commands |
OUTPut:PROTection:CLEar |
5.12.8. OUTPut:PROTection:MEASure
Syntax |
OUTPut:PROTection:MEASure {<bool>} OUTPut:PROTection:MEASure? |
|||
Modules |
DCP |
|||
Description |
This command enables or disables the voltage on the output terminals to be monitored even when the output is disabled. When it is active, the output cannot be turned on as long as the measured voltage is greater than 500 mV. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
ON |
|
Return |
The query command returns 0 if the output voltage monitoring is OFF (disabled), and 1 if the output voltage monitoring is ON (enabled). |
|||
Usage example |
OUTP:PROT:MEAS OFF OUTP:PROT:MEAS? 0 |
5.12.9. OUTPut:TRACk[:STATe]
Syntax |
OUTPut:TRACk[:STATe] {<chanlist>} OUTPut:TRACk[:STATe]? |
|||
Description |
This command enables or disables two or more channels to operate in the track mode defined with the channel list. Once enabled, any change on any of the channel from the channel list will be applied to the whole channel list.
The OUTPut:TRACk OFF command returns all affected channels to the non-track mode.
A device-specific error 312 will be generated if this command is tried to executed when channels are in any of coupled mode.
The following commands will affect the both channel regardless of which channel is currently selected using the INSTrument[:SELect] or INSTrument:NSELect command):
The following channel specific commands will generate a device-specific error 313 when channels are in tracking mode:
At *RST, the tracking mode is disabled. |
|||
Parameters |
Name |
Type |
Range |
Default |
<chanlist> |
Boolean|ChannelList |
List of channels, OFF|0 |
OFF |
|
Return |
Query the tracking mode state of the power modules. The returned value is 0 (OFF) or 1 (ON). |
|||
Usage example |
Define track group that contains channel 1, 3 and 4:
OUTP:TRAC (@1,3:4) VOLT 12 MEAS? 12.00 MEAS? CH3 12.00 |
|||
Errors |
312,"Cannot execute when the channels are coupled" 313,"Cannot execute in tracking mode" |
|||
Related Commands |
*RST INSTrument:COUPle:TRACking |
5.13. ROUTe
The ROUTe command subsystem controls switching operations for relay modules such as SMX46 and PREL6 and defines channel labels.
Please note that when list of channels separated with comma is specified no space is allowed. For example (@111,121) instead of (@111, 121) or (@111 , 121).
SCPI command |
Description |
ROUTe |
|
Closes (turns on) specified relay channels |
|
Closes exclusively specified relay channel |
|
:LABel |
|
Sets relay matrix column label |
|
Sets relay matrix row label |
|
Opens (turns off) specified relay channels |
5.13.1. ROUTe:CLOSe
Syntax |
ROUTe:CLOSe {<chanlist>} ROUTe:CLOSe? {<chanlist>} |
|||
Modules |
SMX PREL MUX |
|||
Description |
This command closes (turns it on) the relay channels specified by <chanlist>. The <chanlist> on the SMX module has the form (@nrc) where n is the module slot number, r is the channel row number and c is the column number. On other modules <chanlist> has a form (@nxx) where n is the module slot number, and xx is channel number. |
|||
Parameters |
Name |
Type |
Range |
Default |
<chanlist> |
ChannelList |
SMX: (@n03) and (@n11) to (@n46), PREL: (@n01) to (@n06), MUX: (@n01) to (@n03), (@n11) to (@n17) and (@n21) to (@n27) where n is the slot number |
– |
|
Return |
Returns the current state of the channel(s) queried. The command returns "1" if channel(s) are closed (relay is energized) or returns "0" if channel(s) are open (relay is idle). |
|||
Usage example |
Closing (activating) four crosspoints (X1Y1, X2Y1, X3Y1, X4Y1) at once on the SMX46 inserted into slot 1: ROUT:CLOS (@111,112,113,114) Closing all crosspoints in row 3 (X3Y1 to X3Y6) at once on the SMX46 inserted into slot 1: ROUT:CLOS (@113:163) Closing power relay on SMX46 inserted in slot 2: ROUT:CLOS (@203) |
|||
Errors |
-200,"Execution error" |
|||
Related Commands |
ROUTe:OPEN SYSTem:RELay:CYCLes? |
5.13.2. ROUTe:CLOSe:EXCLusive
Syntax |
ROUTe:CLOSe:EXCLusive {<chanlist>} |
|||
Modules |
PREL MUX |
|||
Description |
Use this command to close relay channel specified by <chanlist> and open all currently closed channels on the destionation module. <chanlist> has the form (@nxx) where n is the module slot number, and xx is channel number.
If the EXT channel (@n03) is closed on the MUX module, then the scope of this command is extended to another multiplexer (P2). |
|||
Parameters |
Name |
Type |
Range |
Default |
<chanlist> |
ChannelList |
PREL: (@n01) to (@n06), MUX: (@n11) to (@n17) and (@n21) to (@n27) where n is the slot number |
– |
|
Usage example |
Closing (activating) three channels (@211, @212, @213) at once on the MUX module on slot 2: ROUT:CLOS (@211:213) Channel @214 closes exclusively, which will open three previously closed channels: ROUT:CLOS:EXCL (@214) ROUT:CLOS? (@211:213) 0,0,0 |
|||
Errors |
-200,"Execution error" |
|||
Related Commands |
ROUTe:CLOSe ROUTe:OPEN SYSTem:RELay:CYCLes? |
5.13.3. ROUTe:LABel:COLumn
Syntax |
ROUTe:LABel:COLumn {<slot>}, {<column>}, {<label>} ROUTe:LABel:COLumn? {<slot>}, {<column>} |
|||
Modules |
SMX |
|||
Description |
Use this command to define the column label of the relay specified by <slot> and <column>. |
|||
Parameters |
Name |
Type |
Range |
Default |
<slot> |
NR1 |
1 – 3 |
– |
|
<column> |
NR1 |
1 – 6 |
– |
|
<label> |
Quoted string |
Max. 5 characters |
– |
|
Return |
Returns the label of the column queried on the specified slot as a quoted string. |
|||
Usage example |
Set label “Sense” for the fifth column of the SMX46 inserted into slot 2: ROUT:LAB:COL 2, 5, "Sense" |
|||
Errors |
-200,"Execution error" |
|||
Related Commands |
ROUTe:CLOSe ROUTe:LABel:ROW ROUTe:OPEN |
5.13.4. ROUTe:LABel:ROW
Syntax |
ROUTe:LABel:ROW {<slot>}, {<row>}, {<label>} ROUTe:LABel:ROW? {<slot>}, {<row>} |
|||
Modules |
SMX |
|||
Description |
Use this command to define the column label of the relay specified by <slot> and <row>. |
|||
Parameters |
Name |
Type |
Range |
Default |
<slot> |
NR1 |
1 – 3 |
– |
|
<row> |
NR1 |
1 – 4 |
– |
|
<label> |
Quoted string |
Max. 5 characters |
– |
|
Return |
Returns the label of the row queried on the specified slot as a quoted string. |
|||
Usage example |
Set label “Bias” for the third row of the SMX46 inserted into slot 2: ROUT:LAB:COL 2, 3, "Bias" |
|||
Errors |
-200,"Execution error" |
|||
Related Commands |
ROUTe:CLOSe ROUTe:LABel:COLumn ROUTe:OPEN |
5.13.5. ROUTe:OPEN
Syntax |
ROUTe:OPEN {<chanlist>} ROUTe:OPEN? {<chanlist>} |
|||
Modules |
SMX PREL MUX |
|||
Description |
This command closes (turns it off) the relay channels specified by <chanlist>. The <chanlist> on the SMX module has the form (@nrc) where n is the module slot number, r is the channel row number and c is the column number. On other modules <chanlist> has a form (@nxx) where n is the module slot number, and xx is channel number.
The *RST command will open all channels of all modules. |
|||
Parameters |
Name |
Type |
Range |
Default |
<chanlist> |
ChannelList |
SMX: (@n03) and (@n11) to (@n46), PREL: (@n01) to (@n06), MUX: (@n01) to (@n03), (@n11) to (@n17) and (@n21) to (@n27) where n is the slot number |
– |
|
Return |
Returns the current state of the channel(s) queried. The command returns "1" if channel(s) are open (relay is idle) or returns "0" if channel(s) are closed (relay is energized). |
|||
Usage example |
Open (deactivate) two crosspoints (X1Y3 and X4Y2) at once on the SMX46 inserted into slot 1: ROUT:OPEN (@131,124) Open two sequence of crosspoints (X2Y2 to X4Y2 and X2Y4 to X4Y4, i.e. six crosspoints in total) at once on the SMX46 inserted into slot 1: ROUT:OPEN (@122:124,142:144) Open power relay on SMX46 inserted in slot 2: ROUT:OPEN (@203) |
|||
Errors |
-200,"Execution error" |
|||
Related Commands |
*RST ROUTe:CLOSe |
5.14. SCRipt
The SCRipt subsystem allows you to start and stop MicroPython scripts. It is also possible to define scripts that will be executed during startup.
SCPI command |
Description |
SCRipt |
|
Sets the script to run on the startup |
|
Clear currently selected startup script |
|
Enables/disables startup script confirmation |
|
Sets a script to be executed immediately |
|
Forcibly stops the currently active script |
5.14.1. SCRipt:RECall
Syntax |
SCRipt:RECall {<filename>} SCRipt:RECall? |
|||
Description |
Use this command to select the MicroPython script to run on the startup. The full path to the file must be specified. This filename must exist on the SD card otherwise an error will be generated. Use the MMEMory:CATalog? command to check which scripts exist in the specified folder. |
|||
Parameters |
Name |
Type |
Range |
Default |
<filename> |
Quoted string |
– |
– |
|
Return |
The query command returns the full path of the script that will be run at startup. |
|||
Usage example |
SCR:REC "/Scripts/AutoStart.py" |
|||
Errors |
-256,"File name not found" |
|||
Related Commands |
MMEMory:CATalog SCRipt:RECall:CONFirmation SCRipt:RUN SCRipt:STOP |
5.14.2. SCRipt:RECall:CLEar
Syntax |
SCRipt:RECall:CLEar |
Description |
Use this command to clear currently defined startup script. |
Usage example |
SCR:REC:CLE |
Related Commands |
SCRipt:RECall SCRipt:RECall:CONFirmation |
5.14.3. SCRipt:RECall:CONFirmation
Syntax |
SCRipt:RECall:CONFirmation {<bool>} SCRipt:RECall:CONFirmation? |
|||
Description |
Use this command to specify whether a dialog box will appear on the screen during startup with information about the name of the script whose execution will need to be confirmed. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
– |
|
Return |
The query command returns 0 if the script confirmation mode is OFF, and 1 if the confirmation mode is ON. |
|||
Usage example |
SCR:REC:CONF 1 |
|||
Related Commands |
SCRipt:RECall |
5.14.4. SCRipt:RUN
Syntax |
SCRipt:RUN {<filename>} SCRipt:RUN? |
|||
Description |
Use this command to run the MicroPython script specified with the full path name to the file. This filename must exist on the SD card otherwise an error will be generated. Use the MMEMory:CATalog? command to check which scripts exist in the specified folder. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
– |
– |
|
Return |
The query command returns the present setting of the integration time. |
|||
Usage example |
SCR:RUN "/Scripts/Hello world.py" SCR:RUN? "/Scripts/Hello world.py" |
|||
Errors |
310,"File not found" 770,"Script engine is already running" |
|||
Related Commands |
MMEMory:CATalog SCRipt:RECall |
5.14.5. SCRipt:STOP
Syntax |
SCRipt:STOP |
Description |
Use this command to forcibly stop currently active script. Useful in case when script got stuck without need to restart the BB3. |
Usage example |
SCR:STOP |
Related Commands |
SCRipt:RECall SCRipt:RUN |
5.15. SENSe
The SENSe control the current measurement range, energy counting/window, the data acquisition sequence and DLOG viewer parameters.
SCPI command |
Description |
SENSe |
|
Sets the integration time |
|
:CURRent |
|
[:DC] |
|
Selects a DC current measurement range |
|
:DIGital |
|
Set the range of the digital input |
|
Set the speed of the digital input |
|
:DLOG |
|
Resets DLOG settings |
|
:FUNCtion |
|
Enables/disables output current internal data logging |
|
:DIGital |
|
Enables/disables digital input internal data logging |
|
Enables/disables output power internal data logging |
|
Enables/disables output voltage internal data logging |
|
Sets the sample period for internal data logging |
|
Sets the sample duration for internal data logging |
|
:TRACe |
|
Adds new data into log file |
|
Adds a bookmark into the active DLOG |
|
Adds user description to the log file |
|
:X |
|
Sets X-axis label |
|
Sets X-axis min. value |
|
Sets X-axis max. value |
|
|
|
Sets X-axis step value |
|
Sets X-axis units |
|
:Y<n> |
|
Sets Y-axis<n> label |
|
Sets Y-axis<n> min. value |
|
Sets Y-axis<n> max. value |
|
|
|
Sets Y-axis<n> units |
|
:FUNCtion |
|
Sets the MIO160 module analog outputs mode |
|
Sets the number of power line cycles (NPLC) |
|
:VOLTage |
|
[:DC] |
|
Selects a DC voltage measurement range |
5.15.1. SENSe:APERture
Syntax |
SENSe:APERture {<period>} SENSe:APERture? |
|||
Modules |
MIO |
|||
Description |
This command sets the integration time for one point measurement.
The APERture value is coupled to NPLCycles by the equation: APERture = NPLCycles / selected AC line frequency. For example, for NPLC of 5 and 50 Hz the integration time is 100 ms.
The AC line frequency is not detected automatically, therefore it has to be set with the SYSTem:LFRequency command.
Using an integer number of power line cycles can reduce measurement noise from line frequency sources. |
|||
Parameters |
Name |
Type |
Range |
Default |
<period> |
NR2 |
0 – 0.5 |
– |
|
Return |
The query command returns the present setting of the integration time. |
|||
Usage example |
SENS:NPLC 5 SENS:APER? 0.1 |
|||
Errors |
-241,"Hardware missing" |
|||
Related Commands |
SENSe:NPLCycles SYSTem:LFRequency |
5.15.2. SENSe:CURRent[:DC]:RANGe
Syntax |
SENSe:CURRent[:DC]:RANGe {<range>} [, <channel>] SENSe:CURRent[:DC]:RANGe? [<channel>] |
|||
Modules |
DCP MIO |
|||
Description |
This command selects a DC current measurement range when module with multiple current ranges is installed (e.g. DCP405 that can be find out with the SYSTem:CHANnel:MODel? Command). The entered range must be higher than the maximum current that you expect to measure. Units are in amperes.
When used on the MIO168 (i.e. its AFE) use range 0 for auto-ranging function. |
|||
Parameters |
Name |
Type |
Range |
Default |
<range> |
NR2|Discrete |
DCP: 0.5, 5, LOW|HIGH|BEST, |
BEST |
|
|
<channel> |
Channel |
DCP: CH1|CH2|CH3|CH4|CH5|CH6, |
– |
Return |
The query returns the presently selected current range. |
|||
Usage example |
SENS:CURR:RANG? 0.05 |
|||
Errors |
-241,"Hardware missing" |
|||
Related Commands |
SENSe:VOLTage[:DC]:RANGe SYSTem:CHANnel:MODel? |
5.15.3. SENSe:DIGital:RANGe
Syntax |
SENSe:DIGital:RANGe {<pin>}, {<range>} SENSe:DIGital:RANGe? |
|||
Modules |
MIO |
|||
Description |
Use this command to set the voltage range of the input specified by <pin> on the 8-bit digital port (@n01) where n is the MIO168 module slot number:
|
|||
Parameters |
Name |
Type |
Range |
Default |
<pin> |
NR1 |
1 – 8 |
– |
|
|
<range> |
Discrete |
LOW|HIGH |
– |
Return |
The query command returns the voltage range of the selected digital input. |
|||
Usage example |
INST (@301) SENS:DIG:RANG 1,HIGH SENS:DIG:RANG? 1 "HIGH" |
|||
Related Commands |
MEASure:DIGital[:BYTE] SENSe:DIGital:SPEed |
5.15.4. SENSe:DIGital:SPEed
Syntax |
SENSe:DIGital:SPEed {<pin>}, {<speed>} SENSe:DIGital:SPEed? |
|||
Modules |
MIO |
|||
Description |
Use this command to set the speed of the input specified by <pin> on the digital port (@n01) where n is the MIO168 module slot number. This command is applicable only to pin 1 and 2. |
|||
Parameters |
Name |
Type |
Range |
Default |
<pin> |
NR1 |
1 – 2 |
– |
|
|
<speed> |
Discrete |
FAST|SLOW |
– |
Return |
The query command returns the speed of the selected digital input. |
|||
Usage example |
INST (@301) SENS:DIG:SPE 1,FAST |
|||
Related Commands |
MEASure:DIGital[:BYTE] SENSe:DIGital:RANGe |
5.15.5. SENSe:DLOG:CLEar
Syntax |
SENSe:DLOG:CLEar |
Description |
This command resets all DLOG parameters. |
Usage example |
SENS:DLOG:CLE |
Errors |
-241,"Hardware missing" |
5.15.6. SENSe:DLOG:FUNCtion:CURRent
Syntax |
SENSe:DLOG:FUNCtion:CURRent {<bool>}, {<channel>} SENSe:DLOG:FUNCtion:CURRent? {<channel>} |
|||
Description |
Use this command to enable or disable output current internal data logging on the specified channel. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
OFF |
|
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
The query command returns the status (0 or 1) of the output current internal data logging enabled on the specified channel |
|||
Usage example |
SENS:DLOG:FUNC:CURR ON, CH1 |
|||
Related Commands |
INIT:DLOG SENSe:DLOG:FUNCtion:POWer SENSe:DLOG:FUNCtion:VOLTage SENSe:DLOG:PERiod SENSe:DLOG:TIME |
5.15.7. SENSe:DLOG:FUNCtion:DIGital[:INPut]
Syntax |
SENSe:DLOG:FUNCtion:DIGital[:INPut] {<pin>}, {<enable>}, {<channel>} SENSe:DLOG:FUNCtion:DIGital[:INPut]? {<pin>}, {<channel>} |
|||
Modules |
MIO |
|||
Description |
Use this command to enable or disable digital input internal data logging on the specified channel. |
|||
Parameters |
Name |
Type |
Range |
Default |
<pin> |
NR1 |
1 – 8 |
– |
|
<enable> |
Boolean |
ON|OFF|0|1 |
OFF |
|
<channel> |
Channel |
(@n02) where n is the slot number |
– |
|
Return |
The query command returns the status (0 or 1) of the digital input internal data logging enabled on the specified channel |
|||
Usage example |
SENS:DLOG:FUNC:DIG 1, ON, (@302) |
|||
Related Commands |
INIT:DLOG SENSe:DLOG:CURRent SENSe:DLOG:FUNCtion:POWer SENSe:DLOG:FUNCtion:VOLTage SENSe:DLOG:PERiod SENSe:DLOG:TIME |
5.15.8. SENSe:DLOG:FUNCtion:POWer
Syntax |
SENSe:DLOG:FUNCtion:POWer {<bool>}, {<channel>} SENSe:DLOG:FUNCtion:POWer? {<channel>} |
|||
Description |
Use this command to enable or disable output power internal data logging on the specified channel. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
OFF |
|
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
The query command returns the status (0 or 1) of the output power internal data logging enabled on the specified channel |
|||
Usage example |
SENS:DLOG:FUNC:VOLT OFF, CH2 |
|||
Related Commands |
INIT:DLOG SENSe:DLOG:FUNCtion:CURRent SENSe:DLOG:FUNCtion:VOLTage SENSe:DLOG:PERiod SENSe:DLOG:TIME |
5.15.9. SENSe:DLOG:FUNCtion:VOLTage
Syntax |
SENSe:DLOG:FUNCtion:VOLTage {<bool>}, {<channel>} SENSe:DLOG:FUNCtion:VOLTage? {<channel>} |
|||
Description |
Use this command to enable or disable output voltage internal data logging on the specified channel. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bool> |
Boolean |
ON|OFF|0|1 |
OFF |
|
<channel> |
Channel |
CH1|CH2|CH3|CH4|CH5|CH6 |
– |
|
Return |
The query command returns the status (0 or 1) of the output voltage internal data logging enabled on the specified channel |
|||
Usage example |
SENS:DLOG:FUNC:VOLT OFF, CH2 |
|||
Related Commands |
INIT:DLOG SENSe:DLOG:FUNCtion:CURRent SENSe:DLOG:FUNCtion:POWer SENSe:DLOG:PERiod SENSe:DLOG:TIME |
5.15.10. SENSe:DLOG:PERiod
Syntax |
SENSe:DLOG:PERiod {<time>} SENSe:DLOG:PERiod? |
|||
Description |
Use this command to set the data logging sample period in seconds. |
|||
Parameters |
Name |
Type |
Range |
Default |
<time> |
NR2 |
0.005 – 120 |
0.02 |
|
Return |
The query command returns the sample period in seconds. |
|||
Usage example |
SENS:DLOG:PER 1 |
|||
Related Commands |
INITiate:DLOG SENSe:DLOG:TIME |
5.15.11. SENSe:DLOG:TIME
Syntax |
SENSe:DLOG:TIME {<time>} SENSe:DLOG:TIME? |
|||
Description |
This command sets the data logging sample duration, the entered value is in seconds. For sample duration, the maximum is 86 400 000 seconds or 24 000 hours or 1000 days (depending of the available space on the installed SD Card, see the MMEMory:INFOrmation? command). |
|||
Parameters |
Name |
Type |
Range |
Default |
<time> |
NR1 |
1 – 86400000 |
60 |
|
Return |
The query command returns the sample duration in seconds. |
|||
Usage example |
SENS:DLOG:TIME 3600 |
|||
Related Commands |
INITiate:DLOG MMEMory:INFOrmation? SENSe:DLOG:PERiod |
5.15.12. SENSe:DLOG:TRACe:BOOKmark
Syntax |
SENSe:DLOG:TRACe:BOOKmark {<bookmark>} |
|||
Description |
Use this command to add a bookmark into the active DLOG. |
|||
Parameters |
Name |
Type |
Range |
Default |
<bookmark> |
Quoted string |
1 to 25 characters |
– |
|
Usage example |
SENS:DLOG:BOOK "start fan" |
|||
Related Commands |
ABORt:DLOG INITiate:DLOG {<filename>} |
5.15.13. SENSe:DLOG:TRACe[:DATA]
Syntax |
SENSe:DLOG:TRACe[:DATA] {<value>}[, …] |
|||
Description |
When the X-axis and all Y-axes is defined, and when the DLOG file name is specified, it remains to add points (data) into DLOG. Use this command to do this as many times as needed. The first time this command is called, the Y-axis values are set for the first point (as many <value> parameters as the Y-axis should be set), the second time for the second point, etc. When the values of all points are defined, execute the ABORt:DLOG command and the creation of the DLOG file is complete. |
|||
Parameters |
Name |
Type |
Range |
Default |
<value> |
NR2 |
Y:RANGe:MINimum to Y:RANGe:MAXimum |
– |
|
Usage example |
SENS:DLOG:TRAC 10.2, 33.34, 0.022 |
|||
Related Commands |
ABORt:DLOG |
5.15.14. SENSe:DLOG:TRACe:REMark
Syntax |
SENSe:DLOG:TRACe:REMark {<user remark>} SENSe:DLOG:TRACe:REMark? |
|||
Description |
Use this command to add description to the log file. |
|||
Parameters |
Name |
Type |
Range |
Default |
<user remark> |
Quoted string |
0 to 128 characters |
– |
|
Return |
The query command returns log file description as a quoted string. |
|||
Usage example |
SENS:DLOG:TRAC:REM "Test data log" |
|||
Related Commands |
INITiate:DLOG INITiate:DLOG:TRACe SENSe:DLOG:TRACe[:DATA] |
5.15.15. SENSe:DLOG:TRACe:X:LABel
Syntax |
SENSe:DLOG:TRACe:X:LABel {<label>} SENSe:DLOG:TRACe:X:LABel? |
|||
Description |
Use this command to set DLOG X-axis label name. |
|||
Parameters |
Name |
Type |
Range |
Default |
<label> |
Quoted string |
0 to 32 characters |
– |
|
Return |
The query returns X-axis label name as quoted string. |
|||
Usage example |
SENS:DLOG:TRAC:X:LAB "Imon" |
|||
Related Commands |
SENSe:DLOG:TRACe:X:STEP SENSe:DLOG:TRACe:X:UNIT |
5.15.16. SENSe:DLOG:TRACe:X:UNIT
Syntax |
SENSe:DLOG:TRACe:X:UNIT {<unit>} SENSe:DLOG:TRACe:X:UNIT? |
|||
Description |
This command specifies DLOG X-axis unit, typically this is the time, or SECond. |
|||
Parameters |
Name |
Type |
Range |
Default |
<unit> |
Discrete |
VOLT|AMPEr|WATT|JOULe|SECOnd|OHM|FARAd|HERTz |
– |
|
Return |
The query command returns log file X-axis units name as quoted string. |
|||
Usage example |
SENS:DLOG:TRAC:X:UNIT VOLT |
|||
Related Commands |
SENSe:DLOG:TRACe:X:STEP SENSe:DLOG:TRACe:X:LABel |
5.15.17. SENSe:DLOG:TRACe:X:STEP
Syntax |
SENSe:DLOG:TRACe:X:STEP {<step>} SENSe:DLOG:TRACe:X:STEP? |
|||
Description |
Use this command to set step or ∆x, i.e. the distance between two points on the X-axis of the DLOG. |
|||
Parameters |
Name |
Type |
Range |
Default |
<step> |
NR2 |
Greater then zero |
– |
|
Return |
The query command returns X-axis step value. |
|||
Usage example |
SENS:DLOG:TRAC:X:STEP 0.1 |
|||
Related Commands |
SENSe:DLOG:TRACe:X:LABel SENSe:DLOG:TRACe:X:UNIT |
5.15.18. SENSe:DLOG:TRACe:X[:RANGe]:MIN
Syntax |
SENSe:DLOG:TRACe:X[:RANGe]:MIN {<min>} SENSe:DLOG:TRACe:X[:RANGe]:MIN? |
|||
Description |
Use this command to set the first point of the DLOG X-axis. The next point has the value MIN + STEP, then MIN + 2 * STEP, etc. |
|||
Parameters |
Name |
Type |
Range |
Default |
<min> |
NR2 |
– |
– |
|
Return |
The query command returns set X-axis minimal value. |
|||
Usage example |
SENS:DLOG:TRAC:X:MIN 0 |
|||
Related Commands |
SENSe:DLOG:TRACe:X:UNIT |
5.15.19. SENSe:DLOG:TRACe:X[:RANGe]:MAX
Syntax |
SENSe:DLOG:TRACe:X[:RANGe]:MAX {<max>} SENSe:DLOG:TRACe:X[:RANGe]:MAX? |
|||
Description |
Optional command to set the value of the last point on the DLOG X-axis. |
|||
Parameters |
Name |
Type |
Range |
Default |
<max> |
NR2 |
– |
– |
|
Return |
The query command returns set X-axis maximum value. |
|||
Usage example |
SENS:DLOG:TRAC:X:MAX 20 |
|||
Related Commands |
SENSe:DLOG:TRACe:X:UNIT |
5.15.20. SENSe:DLOG:TRACe:X:SCALe
Syntax |
SENSe:DLOG:TRACe:X:SCALe {<scale>} SENSe:DLOG:TRACe:X:SCALe? |
|||
Description |
Use this command to set the X-axis scale.
Currently, only linear (LINear) scale is supported.
|
|||
Parameters |
Name |
Type |
Range |
Default |
<scale> |
Discrete |
LINear|LOGarithmic |
– |
|
Return |
The query command returns X-axis scale type. |
|||
Usage example |
SENS:DLOG:TRAC:X:SCAL LIN |
|||
Related Commands |
SENSe:DLOG:TRACe:Y:SCALe |
5.15.21. SENSe:DLOG:TRACe:Y<n>:LABel
Syntax |
SENSe:DLOG:TRACe:Y<n>:LABel {<label>} SENSe:DLOG:TRACe:Y<n>:LABel? |
|||
Description |
Use this command to set DLOG Y-axis label name. DLOG file could contains up to 18 Y-axis defined by <n>. |
|||
Parameters |
Name |
Type |
Range |
Default |
<label> |
Quoted string |
0 to 32 characters |
– |
|
Return |
The query returns label name as quoted string of the selected Y-axis. |
|||
Usage example |
SENS:DLOG:TRAC:Y1:LAB "Umon" |
|||
Related Commands |
SENSe:DLOG:TRACe:Y<n>:UNIT |
5.15.22. SENSe:DLOG:TRACe:Y<n>[:RANGe]:MIN
Syntax |
SENSe:DLOG:TRACe:Y<n>[:RANGe]:MIN {<min>} SENSe:DLOG:TRACe:Y<n>[:RANGe]:MIN? |
|||
Description |
Use this command to set the first point of the <n> Y-axis. The next point has the value MIN + STEP, then MIN + 2 * STEP, etc. |
|||
Parameters |
Name |
Type |
Range |
Default |
<min> |
NR2 |
– |
– |
|
Return |
The query command returns set <n> Y-axis minimal value. |
|||
Usage example |
SENS:DLOG:TRAC:Y1:MIN 1 |
|||
Related Commands |
SENSe:DLOG:TRACe:Y<n>[:RANGe]:MAX SENSe:DLOG:TRACe:Y<n>:UNIT |
5.15.23. SENSe:DLOG:TRACe:Y<n>[:RANGe]:MAX
Syntax |
SENSe:DLOG:TRACe:Y<n>[:RANGe]:MAX {<max>} SENSe:DLOG:TRACe:Y<n>[:RANGe]:MAX? |
|||
Description |
Optional command to set the value of the last point on the <n> Y-axis. |
|||
Parameters |
Name |
Type |
Range |
Default |
<max> |
NR2 |
– |
– |
|
Return |
The query command returns set <n> Y-axis maximum value. |
|||
Usage example |
SENS:DLOG:TRAC:Y1:MAX 50 |
|||
Related Commands |
SENSe:DLOG:TRACe:Y<n>[:RANGe]:MIN SENSe:DLOG:TRACe:Y<n>:UNIT |
5.15.24. SENSe:DLOG:TRACe:Y:SCALe
Syntax |
SENSe:DLOG:TRACe:Y:SCALe {<scale>} SENSe:DLOG:TRACe:Y:SCALe? |
|||
Description |
Use this command to set the Y-axis scale. |
|||
Parameters |
Name |
Type |
Range |
Default |
<scale> |
Discrete |
LINear|LOGarithmic |
– |
|
Return |
The query command returns Y-axis scale type. |
|||
Usage example |
SENS:DLOG:TRAC:Y:SCAL LIN |
|||
Related Commands |
SENSe:DLOG:TRACe:X:SCALe |
5.15.25. SENSe:DLOG:TRACe:Y<n>:UNIT
Syntax |
SENSe:DLOG:TRACe:Y<n>:UNIT {<unit>} SENSe:DLOG:TRACe:Y<n>:UNIT? |
|||
Description |
This command specifies DLOG <n> Y-axis unit. |
|||
Parameters |
Name |
Type |
Range |
Default |
<unit> |
Discrete |
VOLT|AMPEr|WATT|JOULe|SECOnd|OHM|FARAd|HERTz |
– |
|
Return |
The query command returns <n> Y-axis units name as quoted string. |
|||
Usage example |
SENS:DLOG:TRAC:Y1:UNIT "AMPE" |
|||
Related Commands |
SENSe:DLOG:TRACe:Y<n>:LABel SENSe:DLOG:TRACe:Y<n>:UNIT |
5.15.26. SENSe:FUNCtion[:ON]
Syntax |
SENSe:FUNCtion[:ON] {<function>}[, <channel>] SENSe:FUNCtion[:ON]? [<channel>] |
|||
Modules |
MIO |
|||
Description |
This command defines AIN1 to AIN4 input mode of the MIO168 module with AFE1 that could be current or voltage. |
|||
Parameters |
Name |
Type |
Range |
Default |
<function> |
Discrete |
CURRent|VOLTage |
– |
|
|
<channel> |
channel |
(@n03) to (@n06) where n is the slot number |
|
Return |
The query command returns set analog input mode. |
|||
Usage example |
SENS:FUNC CURR,(@304)
|
|||
Related Commands |
SENSe:CURRent[:DC]:RANGe SENSe:VOLTage[:DC]:RANGe SOURce:FUNCtion[:ON] |
5.15.27. SENSe:NPLCycles
Syntax |
SENSe:NPLCycles {<cycles>} SENSe:NPLCycles? |
|||
Modules |
MIO |
|||
Description |
Use this command to specify the number of AC power line cycles (NPLC) that the measurement will span (i.e. integration time where 1 NPLC=20 ms for 50 Hz, or 16.67 ms for 60 Hz AC power line). It insures better measurement accuracy and reduces measurement noise on low current and voltage measurements.
The AC line frequency is not detected automatically, therefore it has to be set with the SYSTem:LFRequency command.
The NPLC value is coupled to APERture by the equation: NPLCycles = APERture x selected AC line frequency. For example, for APERture of 0.1 and 50 Hz the NPLC is 5.
Using an integer number of power line cycles can reduce measurement noise from line frequency sources. |
|||
Parameters |
Name |
Type |
Range |
Default |
<cycles> |
NR2 |
0 – 25 |
– |
|
Return |
Returns the present setting of the number of power line cycles. |
|||
Usage example |
SENS:NPLC 5 |
|||
Errors |
-241,"Hardware missing" |
|||
Related Commands |
SENSe:APERture SYSTem:LFRequency |
5.15.28. SENSe:VOLTage[:DC]:RANGe
Syntax |
SENSe:VOLTage[:DC]:RANGe {<range>} [, <channel>] SENSe:VOLTage[:DC]:RANGe? [<channel>] |
|||
Modules |
MIO |
|||
Description |
This command selects a DC voltage measurement range. The entered range must be higher than the maximum voltage that you expect to measure. Units are in volts.
Use range 0 for auto-ranging function. |
|||
Parameters |
Name |
Type |
Range |
Default |
<range> |
NR1 |
MIO+AFE3: 0 – 3 |
– |
|
|
<channel> |
Channel |
MIO+AFE3: (@n03), (@n05) |
– |
Return |
The query returns the presently selected voltage range. |
|||
Usage example |
SENS:VOLT:RANG? 0 |
|||
Errors |
-241,"Hardware missing" |
|||
Related Commands |
SENSe:CURRent[:DC]:RANGe |
5.16. SOURce
The SOURce commands are used to set the output voltage, current and power values, remote voltage sensing, and implemented protection mechanisms on the specified channel. Although the APPLy command provides the most straightforward method to program the BB3 over the remote interfaces, the SOURce commands give you more flexibility to change individual parameters.
SCPI command |
Description |
[SOURce[<n>]] |
|
:CURRent |
|
[:LEVel] |
|
Sets the output current |
|
Sets the step of the current change |
|
Sets the triggered output current |
|
:FUNCtion |
|
Sets the output current waveform amplitude |
|
Sets the output current waveform duty cycle |
|
Sets the output current waveform frequency |
|
Sets the output current waveform offset |
|
Sets the output current waveform phase shift |
|
Sets the output current waveform type |
|
:LIMit |
|
Sets the output current limit |
|
Sets the current trigger mode |
|
:PROTection |
|
:DELay |
|
Sets the over-current protection (OCP) programming delay |
|
Enables/disables the over-current protection on the selected channel |
|
Returns the status of over-current protection activation |
|
Sets the output current ramp duration |
|
[:DC] |
|
Selects a DC output current range |
|
:DIGital |
|
Set output states of the digital output channel |
|
:FUNCtion |
|
Sets the digital output waveform duty cycle |
|
Sets the digital output waveform frequency |
|
Sets the digital output waveform phase shift |
|
Sets the digital output waveform type |
|
Sets the digital output trigger mode |
|
:LIST |
|
Sets the number of times that the list is executed |
|
Specifies the current setting for each list step |
|
Specifies the dwell time for each list step |
|
Specifies the voltage setting for each list step |
|
:POWer |
|
Sets the output power limit |
|
Sets the over-power protection (OPP) level |
|
:DELay |
|
Sets the over-power protection programming delay |
|
Enables/disables over-power protection on the selected channel |
|
Returns the status of over-power protection activation |
|
:PWM |
|
Sets the duty cycle of the output |
|
Sets the frequency of the output |
|
Enables/disables PWM |
|
:VOLTage |
|
[:LEVel] |
|
Sets the output voltage |
|
Sets the step of the voltage change |
|
Sets the triggered output voltage |
|
:FUNCtion |
|
Sets the output voltage waveform amplitude |
|
Sets the output voltage waveform duty cycle |
|
Sets the output voltage waveform frequency |
|
Sets the output voltage waveform offset |
|
Sets the output voltage waveform phase shift |
|
Sets the output voltage waveform type |
|
:LIMit |
|
Sets the output voltage limit |
|
Sets the voltage trigger mode |
|
Sets the voltage programming source |
|
Sets the over-voltage protection (OVP) level |
|
:DELay |
|
Sets the over-voltage protection (OVP) programming delay |
|
Enables/disables over-voltage protection on the selected channel |
|
Returns status of over-voltage protection activation |
|
Selects the over-voltage protection (OVP) type |
|
Sets the output voltage ramp duration |
|
[:DC] |
|
Selects a DC output voltage range |
|
Sets the voltage sense inputs source |
5.16.1. [SOURce[<n>]]:CURRent
Syntax |
[SOURce[<n>]]:CURRent[:LEVel][:IMMediate][:AMPLitude] {<current>} [SOURce[<n>]]:CURRent[:LEVel][:IMMediate][:AMPLitude]? [<query current>] |
|||
Modules |
DCP DCM |
|||
Description |
This command sets the immediate current level of the channel. Units are in amperes. When [:SOURce[<n>]] or [<n>] is omitted, the currently selected channel will be affected by this command.
This command also increases or decreases the immediate current level using the ‘UP’ or DOWN parameter by a predetermined amount. The command CURRent:STEP sets the amount of increase or decrease. A new increment setting will not cause an execution error -222,"Data out of range" when the maximum or the minimum rated current is exceeded – the output value will be set to the maximum or the minimum value instead.
At *RST, the signal being sourced will be set to a "safe" con |