2470 High Voltage SourceMeter Instrument Reference Manual
Section 14: TSP command reference
2470-901-01 Rev. A /
May
2019
14-281
tspnet.read()
This function reads data from a remote device.
Type
TSP-Link accessible
Affected by
Where saved
Default value
Function
No
Usage
value1
= tspnet.read(
connectionID
)
value1
= tspnet.read(
connectionID
,
formatString
)
value1
,
value2
= tspnet.read(
connectionID
,
formatString
)
value1
,
...
,
valueN
= tspnet.read(
connectionID
,
formatString
)
value1
The first value decoded from the response message
value2
The second value decoded from the response message
valueN
The nth value decoded from the response message; there is one return value for
each format specifier in the format string
...
One or more values separated with commas
connectionID
The connection ID returned from
tspnet.connect()
formatString
Format string for the output, maximum of 10 specifiers
Details
This command reads available data from the remote instrument and returns responses for the
specified number of arguments.
The format string can contain the following specifiers:
%[width]s
Read data until the specified length
%[max width]t
Read data until the specified length or until punctuation is found, whichever comes first
%[max width]n
Read data until a newline or carriage return
%d
Read a number (delimited by punctuation)
A maximum of 10 format specifiers can be used for a maximum of 10 return values.
If
formatString
is not provided, the command returns a string that contains the data until a new
line is reached. If no data is available, the 2470 pauses operation until the requested data is available
or until a timeout error is generated. Use
tspnet.timeout
to specify the timeout period.
When the 2470 reads from a TSP-enabled remote instrument, the 2470 removes Test Script
Processor (TSP
®
) prompts and places any errors or events it receives from the remote instrument into
its own event queue. The 2470 prefaces events and errors from the remote device with
Remote
Error
, followed by the event number and description.
Example
tspnet.write(deviceID, "*idn?\r\n")
print("write/read returns:", tspnet.read(deviceID))
Send the
"*idn?\r\n"
message to the instrument connected as
deviceID
.
Display the response that is read from
deviceID
(based on the
*idn?
message).