OpenTAP 9.25
API Reference
Public Member Functions | Properties | List of all members
OpenTap.IScpiInstrument Interface Reference

Represents a connection to talk to any SCPI-enabled instrument. More...

Inheritance diagram for OpenTap.IScpiInstrument:
OpenTap.IInstrument OpenTap.IResource OpenTap.ITapPlugin OpenTap.ScpiInstrument

Public Member Functions

void ScpiCommand (string command)
 Sends a SCPI command to the instrument. More...
 
string ScpiQuery (string query, bool isSilent=false)
 Sends a SCPI query to the instrument and waits for a response. More...
 
void ScpiIEEEBlockCommand (string command, byte[] data)
 Sends a IEEE Block SCPI command to the instrument.
 
byte[] ScpiQueryBlock (string query)
 Sends a IEEE Block SCPI query to the instrument and waits for a response. The response is assumed to be IEEE block data. More...
 
- Public Member Functions inherited from OpenTap.IResource
void Open ()
 When overridden in a derived class, opens a connection to the resource represented by this class.
 
void Close ()
 When overridden in a derived class, closes the connection made to the resource represented by this class.
 

Properties

IScpiIO IO [get]
 Get access to the low-level primitives of the connection.
 
- Properties inherited from OpenTap.IResource
string Name [getset]
 A short name to display in the user interface in areas with limited space.
 
bool IsConnected [get]
 Indicates whether this DUT is currently connected. This value should be set by Open() and Close().
 

Detailed Description

Represents a connection to talk to any SCPI-enabled instrument.

Member Function Documentation

◆ ScpiCommand()

void OpenTap.IScpiInstrument.ScpiCommand ( string  command)

Sends a SCPI command to the instrument.

Parameters
commandThe command to send.

Non-blocking.

Implemented in OpenTap.ScpiInstrument.

◆ ScpiQuery()

string OpenTap.IScpiInstrument.ScpiQuery ( string  query,
bool  isSilent = false 
)

Sends a SCPI query to the instrument and waits for a response.

Parameters
queryThe SCPI query to send.
isSilentTrue to suppress log messages.
Returns
The response from the instrument.

Implemented in OpenTap.ScpiInstrument.

◆ ScpiQueryBlock()

byte[] OpenTap.IScpiInstrument.ScpiQueryBlock ( string  query)

Sends a IEEE Block SCPI query to the instrument and waits for a response. The response is assumed to be IEEE block data.

Parameters
queryThe SCPI query to send.
Returns
The response from the instrument.

Implemented in OpenTap.ScpiInstrument.

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:24