THORLABS TSP01 User manual

Environmental Measurement
TSP01
Operation Manual
2018

Version:
Date: 1.4 21-Nov-2018
Copyright © 2018 Thorlabs

Foreword
Contents 3
1 General Information 4
41.1 Ordering Codes and Accessories
2 Getting Started 5
52.1 Parts List
52.2 Requirements
52.2.1 Hardware Requirements 52.2.2 Software Requirements
62.3 Software Installation
3 Operating Instructions 7
73.1 Quick Start 113.2 Detailed GUI Description
113.2.1 Controls
123.2.2 Settings
133.2.3 Tab Measurement 133.2.4 Tab Table
143.2.5 Tab Graph
143.2.6 Graph Display Option Menus
153.2.7 Logging Panel 163.2.8 Save Data
163.2.9 Load Data
173.2.10 Export Settings
173.2.11 Import Settings 183.2.12 Device Information
4 Write Your Own Application 19
194.1 WYOA for TSP01 RevB Sensors
194.1.1 Driver Installation and Location for TSP01 RevB Sensors 214.1.2 Changing the Driver for TSP01 RevB
224.2 WYOA for Previous-Revision Sensors
234.2.1 Driver Installation and Location for Previous-Revision TSP01 sensors
254.2.2 Command Reference 254.2.2.1 IEEE488.2 Common Commands
264.2.2.2 SCPI Command Reference
5 Maintenance and Service 29
295.1 Version Information
6 Troubleshooting 30
7 Appendix 31

317.1 Technical Data
327.2 List of Acronyms
337.3 Safety
347.4 Certifications and Compliances 357.5 Warranty
357.6 Copyright and Exclusion of Reliability
367.7 Thorlabs Worldwide Contacts

© 2018 Thorlabs
We aim to develop and produce the best solutions for your
applications in the field of optical measurement techniques. To help
us to live up to your expectations and constantly improve our
products, we need your ideas and suggestions. 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 this advice carefully!
This manual also contains "NOTES" and "HINTS" written in this form.
Attention
Paragraphs preceded by this symbol explain hazards that could
damage the instrument and the connected equipment or may cause
loss of data.
Note
3

© 2018 Thorlabs4
TSP01
1 General Information
The TSP01 is a device of the size of a USB thumb drive that can be plugged to any USB port
for reading up to three different temperature values and relative humidity.
The combined humidity and temperature sensor is embedded into the USB stick, a second
NTC temperature sensor TSP-TH is included and can be connected to the housing. A third op-
tional temperature sensor can be plugged to the USB housing. External temperature sensors
can be an additional Thorlabs TSP-TH or any other NTC type sensor. The Thorlabs TSP01 Ap-
plication software allows to enter individual NTC parameters, such as R0 (reference resist-
ance), T0 (reference temperature) and the B coefficient.
The TSP01 can be run and data can be displayed in the Thorlabs TSP01 Application software
as a separate GUI. Alternatively, the TSP01 can be run from the Thorlabs' Beam Profiler Soft-
ware.
Further, users have the choice to write a separate application or use a third party GUI. For this,
please see the chapter Write-Your-Own-Application .
Attention
Please find all safety information and warnings concerning this product in the chapter Safety
in the Appendix.
1.1 Ordering Codes and Accessories
.
TSP01
Temperature and Humidity USB Sensor Probe with external temperature
sensor
TSP-TH
External temperature probe for TSP01
19
33

© 2018 Thorlabs
2 Getting Started
5
2 Getting Started
2.1 Parts List
Inspect the shipping container for damage.
If the shipping container seems to be damaged, keep it until you have inspected the contents
for completeness and tested the TSP01 mechanically and electrically.
Verify that you have received the following items within the package:
1. TSP01: Temperature and Humidity USB Sensor Probe
2. TSP-TH: External Temperature Probe for TSP01
3. USB Extension Cable, 1.8 m
4. Quick Reference
2.2 Requirements
The TSP01 is controlled and data read out is monitored through software on a connected PC.
Users have the choice to either use the Thorlabs TSP01 Application software as a separate
GUI or to run the TSP01 from other Thorlabs' software such as the Beam Profiler Software.
Users are also free to write a separate application or use a third party GUI. For this, please see
the chapter Write-Your-Own-Application .
The following are the requirements for the PC to be used for remote operation of the TSP01.
2.2.1 Hardware Requirements
.
CPU
1 GHz or higher
RAM
512 MB or more
Graphic Card
at least 32 MB memory
Graphic Resolution
min. 1024 x 768
Hard Disc
min. 100 MB of available disk space (32 bit)
min. 100 MB of available disk space (64 bit)
Interface
free USB 2.0 port, USB cable according the USB 2.0
specification
2.2.2 Software Requirements
The TSP01 software is compatible with the following operating systems:
·Windows®XP (32-bit) SP3
·Windows®Vista (32-bit, 64-bit)
·Windows®7 (32-bit, 64-bit)
·Windows®8.1 (32-bit, 64-bit)
·Windows®10 (32-bit, 64-bit)
Note
As of 12/2018, Thorlabs introduces the TSP01 revision B. These revised TSP01 devices are
labeled "RevB" on the underside and use an instrument driver that no longer requires NI-
VISA™. For operation of the previous version of the TSP01 without the RevB label, NI-VISA™
(version 5.1 or higher) is required for the driver.
19

© 2018 Thorlabs6
TSP01
The NI-VISA™engine can be installed from the following sources:
·The software CD shipped with previous-revision TSP01 sensors (not labeled RevB). The in-
staller includes NI-VISA™.
·The National Instruments' website www.ni.com
2.3 Software Installation
Please download the TSP01 Application from the software tab on the TSP01 website.
Attention
Do not connect the TSP01 to the PC during software installation! Please make sure that the in-
stallation is carried out completely, including the reboot requests.
·Save the ZIP file to your computer and unpack the archive.
·Double click the setup.exe to install Shield Wizard.
·Read and accept the End-user License Agreement.
·Note the Readme Information during the installation process:
"V 2.0: - Temperature sensor TSP01 RevB supported (includes a new library TLTSPB)
- NIVISA Runtime removed from installer. "
NI-VISA™ has been removed from the installer since it is not required for TSP01 sensors
labeled "RevB". TSP01 sensors without the RevB label will require the installation of NI-VISA™
software.

© 2018 Thorlabs
3 Operating Instructions
7
3 Operating Instructions
After installation of the software connect the TSP01 to a free USB 2.0 port.
Note
The TSP01 should always be positioned away from heat and humidity sources that are not of
interest for the measurement to prevent background. For this, the 1.8 m USB cable is supplied
to position the TSP01 away from the PC/HUB.
The operating system recognizes a USB device and automatically installs the device drivers.
Start the GUI from the desktop icon.
For detailed information on how to use the TSP01 Application software, please see
the chapter Detailed GUI Description .
3.1 Quick Start
This chapter gives a short overview on how to use the TSP01 Application. A detailed descrip-
tion of the GUI can be found in the chapter Detailed GUI Description .
At the first connect, you will be prompted to select the pre-
ferred unit for temperature display. Confirm your choice
with "OK". The software now automatically connects to the
TSP01 and the actual temperature and relative humidity
are displayed as measured on the internal sensor. If an ex-
ternal sensor is connected, it will be recognized and en-
abled automatically, and the temperature of the external
sensor is now displayed.
11
11

© 2018 Thorlabs8
TSP01
Tab Measurement
The Measurement tab displays the actual mea-
surement values of all enabled sensors in numeri-
cal values and within a bar.
The bar indication range can be set individually in
the Settings menu. Additionally, two limits can
be defined for each bar that control the bar color
(blue - green - red) depending on the actual value
with respect to these two limits.
Logging Panel
.
·Logging Control: Choose between: manual start/stop, timed log-
ging or logging of a number of samples.
·Measurement Interval: Set the logging interval (time between two
measurements) between 1 and 10000 seconds.
·Averaging: Averaging unchecked: A single measured value per
selected measurement interval will be logged.
Averaging checked: All values that are measured each second
within the selected measurement interval will be averaged and
only this average value will be logged. Only one single value will
be logged for both options.
·Time Axis Scale: Three selections are available: time in seconds,
time in hh:mm:ss and time stamp (date and time). The complete
time stamp will be displayed only in the Table Tab.
·Start / Stop Logging: This is a toggle button to start / stop log-
ging.
·Results: In this pane logging statistics are displayed.
12

© 2018 Thorlabs
3 Operating Instructions
9
Tab Table
.
In the tab Table all logged data versus time are
displayed numerically.
Column description:
Time: Format as selected for "Time Axis Scale"
Results: The values from all sensors are dis-
played. If an external sensor is not enabled or not
present, the values show "--.---"
Remarks: This column is empty if no error oc-
curred. Otherwise, an error message will be dis-
played.
Tab Graph
.
If enabled in the Settings menu, the tab Graph,
will display all logged data versus time.
Temperature: Up to three curves can be dis-
played: blue for internal sensor, green for external
sensor TH1 and red for external sensor TH2.
Rel. Humidity: If enabled, the relative humidity
value versus time will be shown in black color.
12

© 2018 Thorlabs10
TSP01
Settings panel
.
To adjust settings, click to the icon or select
"Settings" from the "Option" menu.
From this panel you can adjust the appearance of
the GUI, change thermistor settings and en-
able/disable a sensor. Tool tips appear when
moving the mouse pointer over the appropriate
parameter.
Detailed explanations can be found in the chapter
Detailed GUI Description .
In the following section the functionality is described in detail.
11

© 2018 Thorlabs
3 Operating Instructions
11
3.2 Detailed GUI Description
The Graphic User Interfaces automatically connects to the detected TSP01. The software
starts with the most recent settings and configuration.
3.2.1 Controls
TSP01 GUI Controls
The following table summarizes the function of controls. For detailed information, click to the
text in the Function column.
Menu
Menu Topic
Icon
Function
Load Data
Load measurement data from a
file
Save Data
Save measurement data to a
file
Import Settings
Import configuration file
Export Setting
Export configuration to a file
Exit
Exit GUI
Connect Device
Disconnect Device
Device Information
-
Recall TSP01 info
Zoom Panel *)
*)
Opens Zoom Dialog panel
(Graph axes)
Zoom Home *)
*)
Resets zoom of Graph display
Hide Grid *)
*)
Hide / show grid in Graph dis-
play
Clear Measurement Data
Clears all logged data
Settings
Opens Settings dialog panel
16
16
17
17
18
14
14
14
12

© 2018 Thorlabs12
TSP01
Menu
Menu Topic
Icon
Function
Visit Thorlabs Website
View License Agreement
About
Display info about the software
*) Option is displayed only when Graph tab is selected
3.2.2 Settings
The upper two frames contain settings for the
TSP01 internal sensor which combines a tem-
perature and a humidity probe. The lower
frames are related to external thermistor(s).
·Temperature Units: Select the required unit
(°C, °F or K)
·Temperature/Humidity Sensor: Check the
box to enable the sensor. Default settings: In-
ternal sensors enabled, external enabled if rec-
ognized.
·Show Plot in Graph Tab: Enable the dis-
play of logged values for this sensor in the
Graph tab.
·Identifier: For external thermistors, a cus-
tom identifier can be assigned (max. 25 charac-
ters).
·Use this sensor as Reference: When
checking this box, the values of all sensors will
be equalized to the value of the reference
sensor by adding a positive or negative offset.
This individual offset is displayed for each af-
fected sensor. Unchecking this box returns all
sensors to display of the actually measured
value.
·Offset: For each sensor, an individual offset
can be entered manually.
·Thermometer (Hygrometer) Bar Range:
Upper and lower limits of the bar display in Measurement tab. The default value depends
on the actual measured values at start of the application or connect to a TSP01.
·Temperature (Humidity) Window: The color of the bar displayed in the window can
change depending on the actual measured value. Low and High are the thresholds for
changing from blue to green or green to red, respectively.
·Measurement Range: This is the physical measurement range of the sensor. It is not ed-
itable. For the internal combined sensor, the ranges are fixed, for external thermistors the
range is calculated based on the entered R0, T0and Bvalues.
For explanations on the Settings Dialog, please also use the tool tips which appear when mov-
ing the mouse pointer over them.
29

© 2018 Thorlabs
3 Operating Instructions
13
3.2.3 Tab Measurement
The tab Measurement displays by de-
fault the actual measurement results for
internal sensors and recognized external
thermistor sensors. Displayed sensors
can be hidden, see Settings .
For each sensor, the result is displayed
numerically and on a vertical bar. The
bar color changes depending on the
value. The thresholds for color change
as well as upper and lower limit of the
bar can be adjusted in the Settings
panel.
3.2.4 Tab Table
In the tab Table the logging results are dis-
played.
The first column contains the time in the
format selected in the Logging panel (time
in seconds / days:hours:minutes:seconds or
complete time stamp).
The next columns display the logged data
from all sensors. If an external sensor is not
recognized (not connected), its measurement
values will be displayed as "--.---".
12
12
15

© 2018 Thorlabs14
TSP01
3.2.5 Tab Graph
The graph displayed in this tab shows
the logged measurement values based
on the data in the table of logged val-
ues. It is displayed when with the box
"Show Plot in Graph Tab" in the Set-
tings panel is selected. Thus, logged
data can be shown or hidden in the
graphical display.
The graph display
can be zoomed:
move the mouse
pointer into the graph
- it changes to .
Press and hold the
left mouse button -
the center of the
mouse pointer
changes to white
color. Drag a rect-
angle over the area
to be zoomed and release the mouse button.
In order to return to the full graphical display (auto scaling), click to the Zoom Home button.
The time axis shows time in [sec] or [hh:min:sec] formats, a complete time stamp cannot be
shown.
For scaling of the graph, click the Zoom Dialog icon.
The grid can be toggled, see Graph Display Options .
3.2.6 Graph Display Option Menus
The following icons are only visible when the tab Graph is selected.
Zoom Panel
By default, Auto Scaling is enabled. By un-
checking the "Auto Scale..." box, the limits of
the appropriate axis can be changed.
Zoom Home: Click to this icon to display the entire graph (auto scaling).
12
14
15

© 2018 Thorlabs
3 Operating Instructions
15
Show / Hide Grid: This button toggles the grid of the graph display on/off.
Above functions can be reached via the Options drop-down menu as well.
3.2.7 Logging Panel
This is the control panel for recording of temperature(s)
and/or humidity over time.
·Measurement Interval: The logging interval (time
between two measurements) can be set from 1 to 10000
seconds.
·Averaging: When averaging is unchecked, a single meas-
ured value per selected measurement interval will be logged.
By checking this box, all values that are measured each
second will be averaged over the period of the selected mea-
surement interval and only this average value will be logged.
That means per measurement interval for both options one
single value will be logged only.
·Logging Control: Three modes can be set: manual
start/stop, timed logging or logging of a number of samples.
·Time Axis Scale: Three selections are available: time in
seconds, time in hours:minutes:seconds and time stamp
(date an time). The complete time stamp (date and time) will
be displayed only in the Table tab.
·Start / Stop Logging This is a toggle button to start / stop
logging process.
·Results In this pane logging statistics are displayed.
·Start of Measurement: time in [date] hh:min:sec. The date will be displayed only, if the start
date is different from the actual date.
·Duration of measurement: a value will be displayed only in time or samples logging modes
·Samples of measurement: a value will be displayed only in time or samples logging modes
·Below the progress bar, numerical values (minimum, maximum, average and fluctuation). All
values are updated with each new logged value. Fluctuation is the difference between Min
and Max.

© 2018 Thorlabs16
TSP01
3.2.8 Save Data
Logged data can be saved to a tab separated *.txt file. Click to the icon or select from the
menu File the Save Data item. A dialog opens:
Type in a file name and click "Save". The file includes a header with sensor and software in-
formation, application settings and the logged measurement data.
3.2.9 Load Data
Saved data can be loaded into the GUI. Click to the icon or select from the menu File the
Load Data item. A dialog opens:
Select the desired file and click "Open". The file is loaded into the GUI and will be displayed
with all appropriate application settings, as saved in the file header.

© 2018 Thorlabs
3 Operating Instructions
17
3.2.10 Export Settings
The complete GUI settings can be saved to a *.txt file. Click to the icon or select from the
menu File the Export Settings item. A dialog opens:
Type in a file name and click "Save". The file includes the sensor and software information and
the application settings.
3.2.11 Import Settings
Saved settings can be loaded into the GUI. Click to the icon or select from the menu File
the Import Settings item. A dialog opens:
Select the desired file and click "Open".

© 2018 Thorlabs18
TSP01
3.2.12 Device Information
The Device Information menu retrieves information on the connected TSP01: