THORLABS LDC40 Series User manual

Series 4000
LDC40xx
TED4015
ITC40xx
SCPI
Programmer's Reference
Manual
2015

Version:
Date:
3.3
08-Apr-2015
Copyright © 2015 Thorlabs

Foreword
Contents 4
1 General Information 5
2 Introduction to the SCPI Language 6
62.1 Syntax Conventions 72.2 Command Separators 72.3 Using the MIN, MAX and DEF Parameters 82.4 Querying Parameter Settings 82.5 Command Terminators 82.6 Parameter Types 82.6.1 Numeric Parameters 92.6.2 Discrete Parameters 92.6.3 Boolean Parameters 92.6.4 ASCII String Parameters
3 Commands by Subsystem 10
103.1 IEEE-488.2 Commands 113.1.1 *IDN? - Identification Query 113.1.2 *RST - Reset 123.1.3 *SAV, *RCL, *SDS - Save/Recall Setup 123.1.4 *TST? - Self Test 123.1.5 *OPC, *OPC? - Operation Complete 133.1.6 *WAI - Wait To Continue 133.1.7 *STB? 143.1.8 *SRE, *SRE? 143.1.9 *CLS 143.1.10 *ESR?, *ESE, *ESE? 163.2 System Subsystem Commands 163.2.1 Beeper 163.2.2 Error Query 173.2.3 Line Frequency 173.2.4 SCPI Version Query 183.3 Measurement Commands 223.3.1 Abort Measurement in Progres 223.3.2 Configuring a Measurement 243.3.3 Initiating a Measurement 243.3.4 Fetch a Measurement 263.3.5 Read Measurement Data 263.3.6 Simple Measurement 283.4 LD Output Commands 293.4.1 Output State

293.4.2 Switch-On Delay 303.4.3 Polarity 303.4.4 Noise Reduction Filter 313.4.5 Protection Voltage 313.4.6 Temperature Protection Mode 323.4.7 LD-ENABLE Input Mode 333.4.8 Protection Queries 343.5 PD Input Commands 343.5.1 Polarity 353.5.2 BIAS State 353.5.3 BIAS Voltage 363.5.4 Input Routing 373.6 Thermopile/Power Meter Input Commands 373.6.1 Input Routing 383.7 LD Source Commands 403.7.1 LD Source Function 403.7.2 LD Current Limit 413.7.3 LD Current Setpoint 413.7.4 LD Optical Power 433.7.5 LD Power Feedback 433.7.6 LD Amplitude Modulation 443.7.7 QCW Pulse Setting 453.8 PD Sense Commands 453.8.1 Photodiode Current Range 463.8.2 Photodiode Current Protection 463.8.3 Photodiode Responsivity 473.8.4 Photodiode Power Range 473.8.5 Photodiode Power Protection 473.9 Thermopile/Power Meter Sense Commands 483.9.1 Thermopile/Power Meter Voltage Range 493.9.2 Thermopile/Power Meter Voltage Protection 493.9.3 Thermopile/Power Meter Responsivity 503.9.4 Thermopile/Power Meter Power Range 503.9.5 Thermopile/Power Meter Power Protection 513.10QCW Pulse Trigger Commands 513.10.1 QCW Trigger Source 523.11TEC Source Commands 533.11.1 TEC Source Function 543.11.2 TEC Current Limit 543.11.3 TEC Current Setpoint 553.11.4 TEC Temperature Setpoint Limit 553.11.5 TEC Temperature Setpoint 563.11.6 PID Loop Constants

563.11.7 PID Auto Tune 583.12Temperature Sense Commands 603.12.1 Sensor Selection 603.12.2 Thermistor Calculations 613.12.3 Transducer Offset 623.12.4 Temperature Protection 633.13TEC Output Commands 633.13.1 Output State 643.13.2 Protection Queries 653.14Status Subsystem Commands 683.14.1 Programming and Reading Registers 693.14.2 Auxiliary Register Group 703.14.3 Measurement Register Group 713.14.4 Questionable Register Group 723.14.5 Operation Registers Group 733.14.6 Status Preset Command 743.15Memory Subsystem Commands 743.15.1 Number of State Memories 743.15.2 State Memories Names 753.16Display Subsystem Commands 753.16.1 Display Brightness 753.16.2 Display Contrast 763.17Digital I/O Output Commands 763.17.1 Digital I/O Output 773.17.2 Digital I/O Configuration 773.18Digital I/O Input Commands 783.18.1 Digital I/O Input 793.19Unit Subsystem Commands 793.19.1 Temperature Unit Commands 803.20Calibration Subsystem Commands 803.20.1 Calibration String
4 SCPI Error Messages 81
824.1 Command Errors 834.2 Execution Errors 844.3 Device Specific Errors 844.4 Query Errors 854.5 Instrument Errors
5 Appendix 86
865.1 Instrument Default Settings 915.2 Copyright and Exclusion of Reliability 925.3 Thorlabs Worldwide Contacts

© 2015 Thorlabs
We aim to develop and produce the best solution for your application
in the field of optical measurement technique. To help us to live up to
your expectations and improve our products permanently we need
your ideas and suggestions. Therefore, please let us know about
possible criticism or ideas. We and our international partners are
looking forward to hearing from you.
Thorlabs GmbH
Warning
Sections marked by this symbol explain dangers that might result in
personal injury or death. Always read the associated information
carefully, before performing the indicated procedure.
Please read these advices carefully!
This manual also contains "NOTES" and "HINTS" written in this form.
Attention
Paragraphs preceeded by this symbol explain hazards that could
damage the instrument and the connected equipment or may cause
loss of data.
Note
4

© 2015 Thorlabs
1 General Information
5
1 General Information
This part of the programmer’s reference manual contains specific information about the SCPI
command set of the Series 4000 instruments. A general description is followed by explanations
of how to use the SCPI commands. The command set is according to the SCPI 1999.0
standard.
The Series 4000 instruments provide a USB 2.0 Full Speed link according to the USB 2.0
specification, the USBTMC specification and the USBTMC USB488 specification.
The instrument’s command buffer accepts commands with a maximum length of 255
characters. The instrument’s message output buffer can contain response messages of up to
255 characters.
There are VXIpnp/VISA instrument drivers available for Series 4000 instruments. See
www.thorlabs.com for downloads.
Related documents:
TED4000 Series Operation Manual available at www.thorlabs.com
LDC4000 Series Operation Manual available at www.thorlabs.com
ITC4000 Series Operation Manual available at www.thorlabs.com
USB Test and Measurement Class (USBTMC) Specification, Revision 1.0, available at
www.usb.org
USB Test and Measurement Class, Subclass USB488 Specification (USBTMC USB488),
Revision 1.0, available at www.usb.org
IEEE Std 488.2-1992, IEEE Standard Codes, Formats, Protocols, and Common
Commands, available at www.ieee.org
SCPI Specification, Version 1999.0, May, 1999, available at www.ivifoundation.org

© 2015 Thorlabs6
Series 4000 SCPI Programmers Reference Manual
2 Introduction to the SCPI Language
SCPI (Standard Commands for Programmable Instruments) is an ASCII based instrument
command language designed for test and measurement instruments, based on a hierarchical
tree structure. It means associated commands are grouped together under a common node.
For example:
SOURce[1]
:CURRent
:LIMit
[:AMPLitude] {MIN|MAX|<amps>}
SOURce is the root level keyword of the command, CURRent is the second level keyword, LIMit
is the third level keyword and AMPLitude is the fourth level keyword, which can be omitted in
this case. A colon (:) separates between command levels.
For further information about SCPI please see SCPI Standard available at
www.ivifoundation.org.
2.1 Syntax Conventions
The format used in this manual for commands is illustrated below:
SOURce[1]:CURRent {MINimum|MAXimum|<amps>}
The command syntax shows most commands (and some parameters) as a mixture of upper-
and lower-case letters. The upper-case letters indicate the abbreviated spelling for the
command. For shorter program lines, you can use the abbreviated form. For better program
readability, you can send the long form. In the above example CURR and CURRent are both
acceptable syntax spellings. Other spellings like CUR or CURRe are not allowed and will generate
an error. Commands are not case sensitive.
Curly braces ({}) enclose the parameter choices for a given command string. Braces are not
sent with the command string.
A vertical bar (|) separates multiple parameter choices for a given command string. For
example, {MINimum|MAXimum|<amps>} in the above command indicates that you can specify a
numeric current parameter, or MINimum, or MAXimum. The bar is not sent with the command
string.
Triangle brackets (<>) indicate that you must specify a value for the enclosed parameter. For
example, the above syntax statement shows the <amps> parameter enclosed in triangle
brackets. The brackets are not sent with the command string. You must specify a value for the
parameter (for example 5.0) unless you select one of the other options shown in the syntax (for
example MIN).
Some parameters and even parts of the command itself are enclosed in square brackets ([]).
This indicates that the part of the command or the parameter is optional and can be omitted.
The brackets are not sent with the command string. If you do not specify a value for an optional
parameter, the instrument chooses a default value.

© 2015 Thorlabs
2 Introduction to the SCPI Language
7
2.2 Command Separators
A colon (:) is used to separate a command keyword from a lower-level keyword. You must
insert a blank space to separate a parameter from a command keyword. If a command requires
more than one parameter, you must separate adjacent parameters using a comma (,) as
shown below:
MEM:STAT:NAME 1,"My setting"
A semicolon (;) is used to separate commands within the same subsystem, and can also
minimize typing. For example, sending the following command string:
DISP:BRIG 1;CONT 0.5
... is the same as sending the following two commands:
DISP:BRIG 1
DISP:CONT 0.5
Use a semicolon and a colon to link commands from different subsystems. The colon resets
the command tree to the root level. For example:
SOURce:CURRent 0.5;:OUTPut ON
2.3 Using the MIN, MAX and DEF Parameters
For many commands, you can substitute MINimum or MAXimum in place of a parameter. In some
cases you may also substitute DEFault.
For example, consider the following command:
SOURce:TEMPerature:PROTection:WINDow {MIN|MAX|DEF|<temp>}
SOURce[1]
:CURRent
:LIMit
[:AMPLitude] {MIN|MAX|<amps>}
Instead of selecting a specific value for the <temp> parameter, you can substitute MIN or
MINimum to set the value to its minimum, MAX or MAXimum to set the value to its maximum, DEF
or DEFault to set the value to the default value.
For reasons of clarity the following parts of commands are written in short form only throughout
this manual:
Original Form
Short Form
{MINimum|MAXimum|DEFault|<value>}
{MIN|MAX|DEF|<value>}
{MINimum|MAXimum|DEFault}
{MIN|MAX|DEF}
{MINimum|MAXimum|<value>}
{MIN|MAX|<value>}
{MINimum|MAXimum}
{MIN|MAX}

© 2015 Thorlabs8
Series 4000 SCPI Programmers Reference Manual
2.4 Querying Parameter Settings
You can query the current value of most parameters by adding a question mark (?) to the
command. For example, the following command sets the temperature setpoint:
SOURce:CURRent 5.0
You can then query the value by typing:
SOURce:CURRent?
You can also query the minimum or maximum and - where specified - the default values as
follows:
SOURce:CURRent? MINimum
SOURce:CURRent? MAXimum
2.5 Command Terminators
A command string sent to the instrument must terminate with a <new line> (<NL>) character.
Command string termination will always reset the current SCPI command path to the root level.
2.6 Parameter Types
The SCPI language defines several data formats to be used in program messages and
response messages.
2.6.1 Numeric Parameters
Commands that require numeric parameters will accept all commonly used decimal
representations of numbers including optional signs, decimal points, and scientific notation.
Special values for numeric parameters such as MIN, MAX, and DEF may also be accepted. You
can also send engineering unit suffixes with numeric parameters (e.g., M, k, m, or u). If a
command accepts only certain specific values, the instrument will automatically round the input
numeric parameter to the accepted values.
Additionally numeric parameters can be programmed using binary, decimal, hexadecimal or
octal data formats for the parameter value (for a detailed description of numeric formats see
chapter 7.7.4 <NONDECIMAL NUMERIC PROGRAM DATA> of IEEE488.2-1992).
Example
The four commands program the Auxiliary Enable Register to the same value:
STAT:AUX:ENAB 2081
Program the Auxiliary Enable Register with 2018 decimal.
STAT:AUX:ENAB #H821
Program the Auxiliary Enable Register with 821 hexadecimal.
STAT:AUX:ENAB #Q4041
Program the Auxiliary Enable Register with 4041 octal.
STAT:AUX:ENAB #B100000100001
Program the Auxiliary Enable Register with 100000100001 binary.