Series 2600B System SourceMeter® instrument Reference Manual Section 9: TSP command reference
2600BS-901-01 Rev. F/August 2021 9-403
tspnet.read()
This function reads data from a remote device.
Usage
value1 = tspnet.read(connectionID)
value1 = tspnet.read(connectionID, formatString)
value1, value2 = tspnet.read(connectionID, formatString)
value1, ..., valueN = tspnet.read(connectionID, formatString)
The first value decoded from the response message
The second value decoded from the response message
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
The connection ID returned from tspnet.connect()
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:
Read data until the specified length
Read data until the specified length or until punctuation is found, whichever comes first
Read data until a newline or carriage return
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 2600B 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 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script
Processor (TSP
®
) prompts and places any errors it receives from the remote instrument into its own
error queue. The 2600B prefaces errors from the remote device with "Remote Error," followed by
the error number and error 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).
Also see
tspnet.connect() (on page 9-399)
tspnet.readavailable() (on page 9-404)
tspnet.timeout (on page 9-406)
tspnet.write() (on page 9-410)