The following list is a summary of functions available for the GxSmu:
Driver Functions |
Description |
General |
|
GxSmuInitialize |
Initializes the driver for the specified slot using the HW device driver. |
GxSmuInitializeVisa |
Initializes the driver for the specified slot using VISA. |
GxSmuPanel |
Opens a virtual panel used to interactively control the GxSmu. |
GxSmuReset |
Resets the GxSmu board to its default settings. |
GxSmuGetBoardSummary |
Returns the board summary from the on-board EEPROM. |
GxSmuGetBoardType |
Returns the board type. |
GxSmuGetCalibrationInfo |
Returns the calibration information. |
GxSmuGetDriverSummary |
Returns the driver's name and version. |
GxSmuGetErrorString |
Returns the error string associated with the specified error number. |
GxSmuIsInCompliance |
Returns if the specified channel is operating at the compliance limit. |
GxSmuRecallSettings |
Recall and apply settings to all channels as they were last saved to the on-board EEPROM, by the user. |
GxSmuSaveSettings |
Saves all the channels’ settings to the on-board EEPROM. |
Source Functions |
|
GxSmuSourceAdjustClampUnderLoad |
Adjust the specified channel clamp to match the user’s specified clamp value and returns the actual adjusted clamp value. |
GxSmuSourceGetConstantCurrent |
Returns the specified channel’s current range, output voltage limit, and current and ramp time when in constant current mode (GX3104 only). |
GxSmuSourceGetConstantVoltage |
Returns the specified channel’s current range, output voltage and current limit, and ramp time when in voltage current mode (GX3104 only).. |
GxSmuSourceGetCurrent |
Returns the specified channel’s current settings when in constant current mode. |
GxSmuSourceGetCurrentLimit |
Returns the specified channel’s current limit settings when in constant voltage mode(GX3104 only). |
GxSmuSourceGetCurrentClamps |
Returns the specified channel’s programmed current limits source and sink settings when in constant voltage mode (GX3116e only). |
GxSmuSourceGetCurrentRange |
Returns the specified channel’s current range settings. |
GxSmuSourceGetMode |
Returns the specified channel’s operation mode, constant Voltage or Constant Current. |
GxSmuSourceGetOutputState |
Returns the specified channel’s output relay state. |
GxSmuSourceGetRangeMode |
Returns the specified channel’s current range mode. |
GxSmuSourceGetSenseMode |
Returns the specified channel’s sense mode to Local or Remote. |
GxSmuSourceGetTripMode |
Returns the specified channel’s trip mode. |
GxSmuSourceGetVoltage |
Returns the specified channel’s voltage settings when in constant voltage mode. |
GxSmuSourceGetVoltageLimit |
Returns the specified channel’s voltage limit settings when in constant current mode (GX3104 only). |
GxSmuSourceGetVoltageClamps |
Return the specified channel’s voltage limits high and low settings when in constant current mode (GX3116e only). |
GxSmuSourceResetChannel |
Reset the specified channel |
GxSmuSourceResetChannelArray |
Resets the specified array of channels to default settings. |
GxSmuSourceSetConstantCurrent |
Sets the specified channel’s current range, output voltage limit and current when in constant current mode. (GX3104 only). |
GxSmuSourceSetConstantVoltage |
Sets the specified channel’s current range, output voltage and current limit when in constant voltage mode (GX3104 only). |
GxSmuSourceSetCurrent |
Sets the specified channel’s current settings when in constant current mode. |
GxSmuSourceSetCurrentArray |
Sets the specified array of channels current settings when in constant current mode. |
GxSmuSourceSetCurrentLimit |
Sets the specified channel’s current limit when in constant voltage mode (GX3104). |
GxSmuSourceSetCurrentLimitArray |
Sets the specified array of channels current settings when in constant voltage mode (GX3104 only). |
GxSmuSourceSetCurrentClamps |
Sets the specified channel’s programmed current limits source and sink settings when in constant voltage mode (GX3116e only). |
GxSmuSourceSetCurrentClampsArray |
Sets the specified array of channels current limits source and sink settings when in constant voltage mode (GX3116e only). |
GxSmuSourceSetCurrentRange |
Sets the specified channel’s current range. |
GxSmuSourceSetCurrentRangeArray |
Sets the specified array of channels current range. |
GxSmuSourceSetMode |
Sets the specified channel’s operation mode, constant Voltage or Constant Current. |
GxSmuSourceSetModeArray |
Sets the specified array of channels operation mode, constant Voltage or Constant Current. |
GxSmuSourceSetOutputState |
Sets the specified channel’s output relay state. |
GxSmuSourceSetOutputStateArray |
Sets the specified array of channels output relay state. |
GxSmuSourceSetOutputStateEx |
Sets the specified channel’s output relay state, and apply voltage/currents gradually. |
GxSmuSourceSetOutputStateExArray |
Sets the specified array of channels output relay state, and apply voltage/currents gradually. |
GxSmuSourceSetRangeMode |
Sets the specified channel’s current range mode. |
GxSmuSourceSetRangeModeArray |
Sets the specified array of channels current range mode. |
GxSmuSourceSetSenseMode |
Sets the specified channel’s sense mode to Local or Remote. |
GxSmuSourceSetSenseModeArray |
Sets the specified array of channels sense mode to Local or Remote. |
GxSmuSourceSetTripMode |
Sets the specified channel’s trip mode. |
GxSmuSourceSetTripModeArray |
Sets the specified channel’s trip mode. |
GxSmuSourceSetVoltage |
Sets the specified channel’s voltage settings when in constant voltage mode. |
GxSmuSourceSetVoltageArray |
Sets the specified array of channels voltage settings when in constant voltage mode. |
GxSmuSourceSetVoltageLimit |
Sets the specified channel’s voltage limit settings when in constant current mode. |
GxSmuSourceSetVoltageLimitArray |
Sets the specified array of channels voltage settings when in constant voltage mode (GX3104 only). |
GxSmuSourceSetVoltageClamps |
Sets the specified channel’s voltage limits high and low settings when in constant current mode (GX3116e only). |
GxSmuSourceSetVoltageLimitsArray |
Sets the specified array of channels voltage high and low limits settings when in constant voltage mode (GX3116e only). |
GxSmuSourceSetVoltageAndCurrentLimitRamp |
Ramping the voltage and current limit settings both gradually over the specified time. |
GxSmuGetStatusRegister |
Returns the board status register. |
GxSmuGetStatusRegisterChannel |
Returns the board specified channel’s status register (GX3116e only). |
GxSmuGetThermalOverloadStatus |
Returns the board thermal shutdown status. |
Measure Functions |
|
GxSmuMeasure |
Measures the specified channel’s current or voltage. |
GxSmuMeasureSetParamters |
Returns the specified channel’s measurement settings. |
GxSmuMeasureGetPowerLineFrequency |
Returns the specified channel’s measurement Power Line Frequency settings. |
GxSmuMeasureGetSenseMode |
Returns the specified channel’s current sense mode. |
| GxSmuMeasureGetParamters | Sets the specified channel’s measurement parameters. |
GxSmuMeasureSetPowerLineFrequency |
Sets the specified channel’s measurement Power Line Frequency. |
GxSmuMeasureSetSenseMode |
Sets the specified channel’s current sense mode. |
GxSmuMeasureSetSenseModeArray |
Sets the specified array of channels current sense mode to Local or Remote. |
GxSmuMeasureString |
Measures the specified channel’s current or voltage and returns a formatted string. |
Trigger (GX3116e only) |
|
GxSmuTriggerGroup |
Issue a software trigger to the specified group of channels. |
GxSmuTrigGetAnyTriggerToAllGroups |
Returns the state of any trigger to both group A and B. |
GxSmuTrigGetAnyTriggerToConnector |
Returns the trigger to the front connector from any selected trigger state. |
GxSmuTrigGetExternalTriggerToGroup |
Returns the specified group’s external trigger state. |
GxSmuTrigGetPxiTriggerBusLineToGroup |
Returns the specified PXI trigger bus to the specified group settings. |
GxSmuTrigGetStarTriggerToGroup |
Returns the star triggers that are currently connected to the specified group. |
GxSmuTrigGetTriggerStatus |
Returns the status of the different trigger lines. |
GxSmuTrigGetTriggerToPxiBusLine |
Returns the specified Trigger to PXI bus trigger line to drive the backplane and if the PXI bus trigger is enabled. |
GxSmuTrigSetAnyTriggerToAllGroups |
Sets the state of any trigger to both group A and B. |
GxSmuTrigSetAnyTriggerToConnector |
Sets the trigger to the front connector from any selected trigger state. |
GxSmuTrigSetExternalTriggerToGroup |
Sets the specified group’s external trigger state. |
GxSmuTrigSetPxiTriggerBusLineToGroup |
Sets the specified PXI trigger bus to the specified group settings. |
GxSmuTrigSetStarTriggerToGroup |
Sets the star triggers that are currently connected to the specified group. |
GxSmuTrigSetTriggerToPxiBusLine |
Sets the specified Trigger to PXI bus trigger line to drive the backplane and if the PXI bus trigger is enabled. |