GeneralInstrumentsAPI.proto

Provide various functions that allow you to configure the instrument. The functions are:

Be sure to input the Mandatory settings for the parameters. You may skip the Optional settings.

ImplementConfig

Load the instrument state files to the instrument.

Input

Type Parameter Input Input Option
string modelNumber The model number of the instrument. Optional
string visaAddress The visa address of the instrument. Mandatory
string serialNumber The serial number of the instrument. Optional
string firmwareVersion The firmware version of the instrument. Optional
string configFilePath The path where the instrument state file is located. Mandatory

Response

Type Name Response
bool status true - When no error is detected
ErrorData error Show error information if there is any error.
  • string description - Description of the error
  • string suggestedAction - Suggested action to take

RunOrStopApp

Run or stop data logging feature of the AC Source application.

Input

Type Parameter Input Input Option
string modelNumber The model number of the instrument. Optional
string visaAddress The visa address of the instrument. Mandatory
string serialNumber The serial number of the instrument. Optional
string firmwareVersion The firmware version of the instrument. Optional
RunOrStopAction action 0 - To stop the data logging
1 - To start the data logging		 Mandatory

Response

Type Name Response
bool status true - When no error is detected
ErrorData error Show error information if there is any error.
  • string description - Description of the error
  • string suggestedAction - Suggested action to take

CheckSupportedModel

Check if the specified instrument model number is supported by the AC Source application.

Input

Type Parameter Input Input Option
string modelNumber The model number of the instrument you want to check. Mandatory

Response

Type Name Response
string supportedModels Show a list of supported instrument model numbers.
bool isModelSupported true - The instrument model number is supported.
false - The instrument model number is not supported.

SetupInstrumentOutputMode

Configure the output mode of the connected instrument.

Input

Type Parameter Input Input Option
string modelNumber The model number of the instrument. Optional
string visaAddress The visa address of the instrument. Mandatory
string serialNumber The serial number of the instrument. Optional
string firmwareVersion The firmware version of the instrument. Optional
OutputMode outputMode 0 - To select 1P mode
1 - To select 1P3W mode
2 - To select 3P mode		 Mandatory

Response

Type Name Response
bool status true - When no error is detected
ErrorData error Show error information if there is any error.
  • string description - Description of the error
  • string suggestedAction - Suggested action to take

SetupInstrumentOutputCouplingMode

Configure the output coupling mode of the connected instrument.

Input

Type Parameter Input Input Option
string modelNumber The model number of the instrument. Optional
string visaAddress The visa address of the instrument. Mandatory
string serialNumber The serial number of the instrument. Optional
string firmwareVersion The firmware version of the instrument. Optional
OutputCouplingMode outputCouplingMode 0 - To select AC mode
1 - To select DC mode
2 - To select ACDC mode		 Mandatory

Response

Type Name Response
bool status true - When no error is detected
ErrorData error Show error information if there is any error.
  • string description - Description of the error
  • string suggestedAction - Suggested action to take

SetupInstrumentVoltageRange

Configure the voltage range mode of the connected instrument.

Input

Type Parameter Input Input Option
string modelNumber The model number of the instrument. Optional
string visaAddress The visa address of the instrument. Mandatory
string serialNumber The serial number of the instrument. Optional
string firmwareVersion The firmware version of the instrument. Optional
VoltageRangeMode voltageRange 0 - To select high (H) voltage range
1 - To select low (L) voltage range
 Mandatory

Response

Type Name Response
bool status true - When no error is detected
ErrorData error Show error information if there is any error.
  • string description - Description of the error
  • string suggestedAction - Suggested action to take

SaveConfig

Save the current instrument state of the connected instrument.

Input

Type Parameter Input Input Option
string modelNumber The model number of the instrument. Optional
string visaAddress The visa address of the instrument. Mandatory
string serialNumber The serial number of the instrument. Optional
string firmwareVersion The firmware version of the instrument. Optional
string configFilePath The path where the instrument state file will be saved. Mandatory

Response

Type Name Response
bool status true - When no error is detected
ErrorData error Show error information if there is any error.
  • string description - Description of the error
  • string suggestedAction - Suggested action to take

See Also

gRPC Service

Using gRPC Service