Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetGainRange (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_gain_range_t range)
	This function will set the Gain Range for the specified SG channel per the table below.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetGainRange (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_gain_range_t *outrange)
	This function will read back the Gain range value setting for the specified SG channel per table below.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetExcitationMode (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_excitation_mode_t mode)
	This function will set the Excitation mode configuration for the specified SG channel per table below.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetExcitationMode (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_excitation_mode_t *outmode)
	This function will read the Excitation mode configuration for the specified SG channel per table below.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetExcitation (int32_t cardIndex, int32_t module, int32_t channel, float32_t excitationvolt)
	This function will set the Excitation/Drive Voltage setting for the specified SG channel. This function is only supported by Generation 3 SG modules.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetExcitation (int32_t cardIndex, int32_t module, int32_t channel, float32_t *outexcitationvolt)
	This function will read the Excitation/Drive voltage setting for the specified SG channel. This function is only supported by Generation 3 SG modules.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetBridgeSensitivity (int32_t cardIndex, int32_t module, int32_t channel, float32_t bridgesensitivity)
	This function will set the BridgeSensitivity/Drive Setting for the specified SG channel. Value should be specified in units of V/V (Volts per Volt). This function is only supported by Generation 3 SG modules.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetBridgeSensitivity (int32_t cardIndex, int32_t module, int32_t channel, float32_t *outbridgesensitivity)
	This function will read the BridgeSensitivity/Drive Setting for the specified SG channel. Value is returned in units of V/V (Volts per Volt). This function is only supported by Generation 3 SG modules.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetSensorFS (int32_t cardIndex, int32_t module, int32_t channel, float32_t sensorfs)
	This function will set the SensorFS Setting for the specified SG channel. Value in user defined units. This function is only supported by Generation 3 SG modules.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetSensorFS (int32_t cardIndex, int32_t module, int32_t channel, float32_t *outsensorfs)
	This function will read the SensorFS/Drive Setting for the specified SG channel. Value returned in user defined units. This function is only supported by Generation 3 SG modules.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetRemoteDriveSense (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_remote_sense_t sense)
	This function will set the Remote Sense Drive mode for the specified SG channel per table below.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetRemoteDriveSense (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_remote_sense_t *outsense)
	This function will read the Remote Sense Drive setting for the specified SG channel per table below.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetOutputDataCfg (int32_t cardIndex, int32_t module, nai_sg_chop_stab_enable_t ChopStabEnable, nai_sg_SINC_filter_t SINCFilter, uint32_t ODRScale, nai_sg_reject_60Hz_enable_t Reject60Hz, float32_t *outputdatarate)
	This function will set the Chopper Stabilization, SINC Filter, Output Data Rate (ODR) Scale, and 60 Hz Rejection Enable Configuration for the specified SG channel per table below. The Output Data Rate associated with this configuration is computed and returned.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetOutputDataCfg (int32_t cardIndex, int32_t module, nai_sg_chop_stab_enable_t outChopStabEnable, nai_sg_SINC_filter_t outSINCFilter, uint32_t outODRScale, nai_sg_reject_60Hz_enable_t outReject60Hz, float32_t *outputdatarate)
	This function will read the Chopper Stabilization, SINC Filter, Output Data Rate (ODR) Scale, and 60 Hz Rejection Enable Configuration for the specified SG channel per table below. The Output Data Rate associated with this configuration is computed and returned.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_ResetCal (int32_t cardIndex, int32_t module, uint32_t resetcommand)
	This function will reset the calibration values for the user offset and gain to factory programmed values. Override reset command word to be written is SG_GEN3_RESET_CAL_COMMAND. Command register is reset to zero when the reset operation is complete. This function is only supported by Generation 3 SG modules.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_Set_UserOrFactoryCalSel (int32_t cardIndex, int32_t module, uint32_t factorycalselectionword)

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_Get_UserOrFactoryCalSel (int32_t cardIndex, int32_t module, uint32_t *outfactorycalselectionword)

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetExcitationSignal (int32_t cardIndex, int32_t module, int32_t channel, float64_t excitationVolt)
	Sets the Excitation/Drive Voltage setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetExcitationSignal (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outexcitationVolt)
	Retrieves the Excitation/Drive Voltage setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetBridgeConfiguration (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_bridge_config_type_t bridgeConfig)
	Sets the Bridge Configuration type setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetBridgeConfiguration (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_bridge_config_type_t *outbridgeConfig)
	Retrieves the Bridge Configuration type setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetPGAGain (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_pga_gain_type_t pgaGain)
	Sets the PGA Gain setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. The PGA Gain is set based on the values in the table below:

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetPGAGain (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_pga_gain_type_t *outpgaGain)
	Retrieves the PGA Gain setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. The PGA Gain value is based on the values in the table below:

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetNominalResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t nominalResistance)
	Sets the Nominal Resistance setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetNominalResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outnominalResistance)
	Retrieves the Nominal Resistance setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. Resistance is in Ohms.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetGaugeFactor (int32_t cardIndex, int32_t module, int32_t channel, float64_t gaugeFactor)
	Sets the Gauge Factor setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetGaugeFactor (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outgaugeFactor)
	Retrieves the Gauge Factor setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetPoissonRatio (int32_t cardIndex, int32_t module, int32_t channel, float64_t poissonRatio)
	Sets the Poisson's Ratio setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetPoissonRatio (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outpoissonRatio)
	Retrieves the Poisson's Ratio setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetLeadResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t leadResistance)
	Sets the Lead Resistance setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetLeadResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outleadResistance)
	Retrieves the Lead Resistance setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetSampleRate (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_sample_rate_type_t sampleRate)
	Sets the Sample Rate setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. The Sample Rate is set based on the values in the table below:

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetSampleRate (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_sample_rate_type_t *outsampleRate)
	Retrieves the Sample Rate setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. The Sample Rate value is based on the values in the table below:

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetStrainAlertValue (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_strain_alert_value_type_t strainAlertValueType, float64_t strainAlertValue)
	Sets the Strain Alert Value of the specified type for the specified SG channel. This function only applies to modules that are Generation 5 or later. Valid Strain Alert Value types are High Strain Alert Value 1, High Strain Alert Value 2, Low Strain Alert Value 1, and Low Strain Alert Value 2.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetStrainAlertValue (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_strain_alert_value_type_t strainAlertValueType, float64_t *outstrainAlertValue)
	Retrieves the Strain Alert Value of the specified type for the specified SG channel. This function only applies to modules that are Generation 5 or later. Valid Strain Alert Value types are High Strain Alert Value 1, High Strain Alert Value 2, Low Strain Alert Value 1, and Low Strain Alert Value 2.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetImbalanceOffsetValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t imbalanceOffsetValue)
	Sets the Imbalance Offset Value for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetImbalanceOffsetValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outimbalanceOffsetValue)
	Retrieves the Imbalance Offset Value for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_ResetMinimumAndMaximumStrain (int32_t cardIndex, int32_t module, int32_t channel)
	Resets the minimum and maximum strain values to 0 microstrain for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetUseInternalBridgeCompletion (int32_t cardIndex, int32_t module, int32_t channel, bool_t useInternalBridgeCompletion)
	Sets the register bit that determines whether or not to use internal bridge completion for the specified SG channel. This function only applies to modules that are Generation 5 or later.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetUseInternalBridgeCompletion (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outuseInternalBridgeCompletion)
	Retrieves the register bit that determines whether or not to use internal bridge completion for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Detailed Description

Function Documentation

◆ naibrd_SG_Get_UserOrFactoryCalSel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_Get_UserOrFactoryCalSel	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t *	outfactorycalselectionword )

This function will read the present selection for the source of the calibration values used for the output readings.
Calibration values may be toggled between the factory calibration data from motherboard flash
or field adjustable values from CPLD flash (User Flash Memory)
Corresponding bit for channel selects source of cal data:
  FactoryCalSelectionWord - bitmapped cal selection word
       MSB |xxxx | xxxx | xxxx |4 3 2 1| LSB
    Bitmapped per channel
    0 indicates user cal selection (UFM)
    1 indicates factory cal selection

This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
outfactorycalselectionword	: (Output) bitmapped cal selection word MSB \|xxxx \| xxxx \| xxxx \|4 3 2 1\| LSB

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetBridgeConfiguration()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBridgeConfiguration	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_bridge_config_type_t *	outbridgeConfig )

Retrieves the Bridge Configuration type setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outbridgeConfig	: (Output) Bridge Configuration type read from module (see nai_sg_bridge_config_type_t definition).

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetBridgeSensitivity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBridgeSensitivity	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float32_t *	outbridgesensitivity )

This function will read the BridgeSensitivity/Drive Setting for the specified SG channel. Value is returned in units of V/V (Volts per Volt). This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outbridgesensitivity	: (Output) A pointer to where the BridgeSensitivity is returned.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetExcitation()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetExcitation	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float32_t *	outexcitationvolt )

This function will read the Excitation/Drive voltage setting for the specified SG channel. This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outexcitationvolt	: (Output) A pointer to where the Excitation voltage is returned.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetExcitationMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetExcitationMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_excitation_mode_t *	outmode )

This function will read the Excitation mode configuration for the specified SG channel per table below.

Excitation  -  0 for DC Excitation
               1 for AC Excitation

This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outmode	: (Output) A pointer to where the Excitation mode value is returned.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetExcitationSignal()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetExcitationSignal	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outexcitationVolt )

Retrieves the Excitation/Drive Voltage setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outexcitationVolt	: (Output) Excitation Voltage value read from module (0V - SG_MAX_EXCITATION_VOLT).

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetGainRange()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetGainRange	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_gain_range_t *	outrange )

This function will read back the Gain range value setting for the specified SG channel per table below.

The value (0 to 5) corresponding to the gain range shown below is returned.

  Value      Range
    0        128     (highest gain sensitivity, smallest input range)
    1         64
    2         32
    3         16
    4          8
    5          1     (lowest gain sensitivity, largest input range)

This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outrange	: (Output) A pointer to where the gain range value is returned.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetGaugeFactor()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetGaugeFactor	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outgaugeFactor )

Retrieves the Gauge Factor setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outgaugeFactor	: (Output) Gauge Factor setting read from module.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetImbalanceOffsetValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetImbalanceOffsetValue	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outimbalanceOffsetValue )

Retrieves the Imbalance Offset Value for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outimbalanceOffsetValue	: (Output) Imbalance Offset Value read from module.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetLeadResistance()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetLeadResistance	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outleadResistance )

Retrieves the Lead Resistance setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outleadResistance	: (Output) Lead Resistance setting in ohms read from module.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetNominalResistance()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetNominalResistance	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outnominalResistance )

Retrieves the Nominal Resistance setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. Resistance is in Ohms.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outnominalResistance	: (Output) Nominal Resistance setting in ohms read from module.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetOutputDataCfg()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetOutputDataCfg	(	int32_t	cardIndex,
		int32_t	module,
		nai_sg_chop_stab_enable_t *	outChopStabEnable,
		nai_sg_SINC_filter_t *	outSINCFilter,
		uint32_t *	outODRScale,
		nai_sg_reject_60Hz_enable_t *	outReject60Hz,
		float32_t *	outputdatarate )

This function will read the Chopper Stabilization, SINC Filter, Output Data Rate (ODR) Scale, and 60 Hz Rejection Enable Configuration for the specified SG channel per table below. The Output Data Rate associated with this configuration is computed and returned.

ChopStabEnable  - 0 to Disable
                  1 to Enable
SINCFilter      - 3 for SINC3
                - 4 for SINC4
ODRScale        - value between 1 and 1023
Reject60Hz      - 0 to Disable
                  1 to Enable

This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
outChopStabEnable	: (Output) A pointer to where the Chopper Stabilization is returned.
outSINCFilter	: (Output) A pointer to where the SINC Filter is returned.
outODRScale	: (Output) A pointer to where the Output Data Rate Scale is returned.
outReject60Hz	: (Output) A pointer to where the 60 Hz Rejection Enable is returned.
outputdatarate	: (Output) A pointer to where the computed Output Data Rate is returned.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetPGAGain()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetPGAGain	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_pga_gain_type_t *	outpgaGain )

Retrieves the PGA Gain setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. The PGA Gain value is based on the values in the table below:

   Register Value          PGA Gain in V/V   nai_sg_pga_gain_type_t
              0x0           1                SG_PGA_GAIN_1
              0x1           2                SG_PGA_GAIN_2
              0x2           4                SG_PGA_GAIN_4
              0x3           8                SG_PGA_GAIN_8
              0x4          16                SG_PGA_GAIN_16
              0x5          32                SG_PGA_GAIN_32

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outpgaGain	: (Output) PGA Gain setting read from module. Refer to nai_sg_pga_gain_type_t for definition.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetPoissonRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetPoissonRatio	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outpoissonRatio )

Retrieves the Poisson's Ratio setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outpoissonRatio	: (Output) Poisson's Ratio setting read from module.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetRemoteDriveSense()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRemoteDriveSense	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_remote_sense_t *	outsense )

This function will read the Remote Sense Drive setting for the specified SG channel per table below.

Remote Drive Sense  -  0 for OFF
                       1 for ON

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outsense	: (Output) A pointer to where the Remote Drive Sense setting is returned.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetSampleRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetSampleRate	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_sample_rate_type_t *	outsampleRate )

Retrieves the Sample Rate setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. The Sample Rate value is based on the values in the table below:

   Register Value          Sample Rate in SPS (samples per second)    nai_sg_sample_rate_type_t
              0x0              2.5                                    NAI_SG_SAMPLE_RATE_2P5_SPS 
              0x1              5                                      NAI_SG_SAMPLE_RATE_5_SPS
              0x2             10                                      NAI_SG_SAMPLE_RATE_10_SPS
              0x3             16.6666                                 NAI_SG_SAMPLE_RATE_16P6666_SPS
              0x4             20                                      NAI_SG_SAMPLE_RATE_20_SPS
              0x5             50                                      NAI_SG_SAMPLE_RATE_50_SPS
              0x6             60                                      NAI_SG_SAMPLE_RATE_60_SPS
              0x7            100                                      NAI_SG_SAMPLE_RATE_100_SPS
              0x8            400                                      NAI_SG_SAMPLE_RATE_400_SPS
              0x9           1200                                      NAI_SG_SAMPLE_RATE_1200_SPS
              0xA           2400                                      NAI_SG_SAMPLE_RATE_2400_SPS
              0xB           4800                                      NAI_SG_SAMPLE_RATE_4800_SPS
              0xC           7200                                      NAI_SG_SAMPLE_RATE_7200_SPS
              0xD          14400                                      NAI_SG_SAMPLE_RATE_14400_SPS
              0xE          19200                                      NAI_SG_SAMPLE_RATE_19200_SPS
              0xF          38400                                      NAI_SG_SAMPLE_RATE_38400_SPS

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outsampleRate	: (Output) Sample Rate setting read from module. Refer to nai_sg_sample_rate_type_t for definition.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetSensorFS()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetSensorFS	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float32_t *	outsensorfs )

This function will read the SensorFS/Drive Setting for the specified SG channel. Value returned in user defined units. This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outsensorfs	: (Output) A pointer to where the SensorFS value is returned.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetStrainAlertValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStrainAlertValue	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_strain_alert_value_type_t	strainAlertValueType,
		float64_t *	outstrainAlertValue )

Retrieves the Strain Alert Value of the specified type for the specified SG channel. This function only applies to modules that are Generation 5 or later. Valid Strain Alert Value types are High Strain Alert Value 1, High Strain Alert Value 2, Low Strain Alert Value 1, and Low Strain Alert Value 2.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
strainAlertValueType	: (Input) Strain Alert Value type to read (see nai_sg_strain_alert_value_type_t definition).
outstrainAlertValue	: (Output) Strain Alert Value in units of microstrain read from module.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_INVALID_VALUE when invalid strainAlertValueType parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_GetUseInternalBridgeCompletion()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetUseInternalBridgeCompletion	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outuseInternalBridgeCompletion )

Retrieves the register bit that determines whether or not to use internal bridge completion for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outuseInternalBridgeCompletion	: (Output) 1 if using internal bridge completion, 0 otherwise.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_ResetCal()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ResetCal	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	resetcommand )

This function will reset the calibration values for the user offset and gain to factory programmed values. Override reset command word to be written is SG_GEN3_RESET_CAL_COMMAND. Command register is reset to zero when the reset operation is complete. This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
resetcommand	: (Input) Required command word for reset: 0xC1EA. (Any other word will have no effect).

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_ResetMinimumAndMaximumStrain()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ResetMinimumAndMaximumStrain	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel )

Resets the minimum and maximum strain values to 0 microstrain for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_Set_UserOrFactoryCalSel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_Set_UserOrFactoryCalSel	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	factorycalselectionword )

This function will select the source of the calibration values used for the output readings.
Calibration values may be toggled between the factory calibration data from motherboard flash
or field adjustable values from CPLD flash (User Flash Memory)
  FactoryCalSelectionWord - bitmapped cal selection word
       MSB |xxxx | xxxx | xxxx |4 3 2 1| LSB
    Bitmapped per channel
    0 indicates user cal selection (UFM)
    1 indicates factory cal selection

This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
factorycalselectionword	: (Input) bitmapped cal selection word.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetBridgeConfiguration()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBridgeConfiguration	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_bridge_config_type_t	bridgeConfig )

Sets the Bridge Configuration type setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
bridgeConfig	: (Input) Bridge Configuration type to set (see nai_sg_bridge_config_type_t definition).

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_INVALID_VALUE when invalid bridgeConfig parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetBridgeSensitivity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBridgeSensitivity	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float32_t	bridgesensitivity )

This function will set the BridgeSensitivity/Drive Setting for the specified SG channel. Value should be specified in units of V/V (Volts per Volt). This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
bridgesensitivity	: (Input) BridgeSensitivity value to set, V/V (Volts per Volt) (0 - SG_MAX_BRIDGESENSITIVITY).

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetExcitation()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetExcitation	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float32_t	excitationvolt )

This function will set the Excitation/Drive Voltage setting for the specified SG channel. This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
excitationvolt	: (Input) Excitation Voltage value to set (0V - SG_MAX_EXCITATION_VOLT).

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetExcitationMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetExcitationMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_excitation_mode_t	mode )

This function will set the Excitation mode configuration for the specified SG channel per table below.

Excitation  -  0 for DC Excitation
               1 for AC Excitation

This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
mode	: (Input) Excitation Configuration to set refer to nai_sg_excitation_mode_t definition.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetExcitationSignal()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetExcitationSignal	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	excitationVolt )

Sets the Excitation/Drive Voltage setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
excitationVolt	: (Input) Excitation Voltage value to set (0V - SG_MAX_EXCITATION_VOLT).

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_INVALID_VALUE when the excitationVolt exceeds limit.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetGainRange()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetGainRange	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_gain_range_t	range )

This function will set the Gain Range for the specified SG channel per the table below.

Write the value shown below to set the corresponding range for the channel.

  Value      Range
    0        128     (highest gain sensitivity, smallest input range)
    1         64
    2         32
    3         16
    4          8
    5          1     (lowest gain sensitivity, largest input range)

This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
range	: (Input) Gain range Value to set refer to nai_sg_gain_range_t for definitions.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_INVALID_VALUE when invalid range parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetGaugeFactor()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetGaugeFactor	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	gaugeFactor )

Sets the Gauge Factor setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
gaugeFactor	: (Input) Gauge Factor setting to set.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetImbalanceOffsetValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetImbalanceOffsetValue	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	imbalanceOffsetValue )

Sets the Imbalance Offset Value for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
imbalanceOffsetValue	: (Input) Imbalance Offset Value to set.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetLeadResistance()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetLeadResistance	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	leadResistance )

Sets the Lead Resistance setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
leadResistance	: (Input) Lead Resistance setting to set in ohms.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetNominalResistance()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetNominalResistance	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	nominalResistance )

Sets the Nominal Resistance setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
nominalResistance	: (Input) Nominal Resistance setting to set in ohms.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetOutputDataCfg()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetOutputDataCfg	(	int32_t	cardIndex,
		int32_t	module,
		nai_sg_chop_stab_enable_t	ChopStabEnable,
		nai_sg_SINC_filter_t	SINCFilter,
		uint32_t	ODRScale,
		nai_sg_reject_60Hz_enable_t	Reject60Hz,
		float32_t *	outputdatarate )

This function will set the Chopper Stabilization, SINC Filter, Output Data Rate (ODR) Scale, and 60 Hz Rejection Enable Configuration for the specified SG channel per table below. The Output Data Rate associated with this configuration is computed and returned.

ChopStabEnable  - 0 to Disable
                  1 to Enable
SINCFilter      - 3 for SINC3
                - 4 for SINC4
ODRScale        - value between 1 and 1023
Reject60Hz      - 0 to Disable
                  1 to Enable

This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
ChopStabEnable	: (Input) Chopper Stabilization to set.
SINCFilter	: (Input) SINC Filter to set.
ODRScale	: (Input) Output Data Rate Scale to set.
Reject60Hz	: (Input) 60 Hz Rejection Enable to set.
outputdatarate	: (Output) A pointer to where the computed Output Data Rate is returned.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_INVALID_VALUE when an invalid parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetPGAGain()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetPGAGain	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_pga_gain_type_t	pgaGain )

Sets the PGA Gain setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. The PGA Gain is set based on the values in the table below:

   Register Value          PGA Gain in V/V   nai_sg_pga_gain_type_t
              0x0           1                SG_PGA_GAIN_1
              0x1           2                SG_PGA_GAIN_2
              0x2           4                SG_PGA_GAIN_4
              0x3           8                SG_PGA_GAIN_8
              0x4          16                SG_PGA_GAIN_16
              0x5          32                SG_PGA_GAIN_32

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
pgaGain	: (Input) PGA Gain setting to set. Refer to nai_sg_pga_gain_type_t for definition.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_INVALID_VALUE when invalid pgaGain parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetPoissonRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetPoissonRatio	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	poissonRatio )

Sets the Poisson's Ratio setting for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
poissonRatio	: (Input) Poisson's Ratio setting to set.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetRemoteDriveSense()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetRemoteDriveSense	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_remote_sense_t	sense )

This function will set the Remote Sense Drive mode for the specified SG channel per table below.

Remote Drive Sense  -  0 for OFF
                       1 for ON

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
sense	: (Input) Remote Drive Sense to set.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetSampleRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetSampleRate	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_sample_rate_type_t	sampleRate )

Sets the Sample Rate setting for the specified SG channel. This function only applies to modules that are Generation 5 or later. The Sample Rate is set based on the values in the table below:

   Register Value          Sample Rate in SPS (samples per second)    nai_sg_sample_rate_type_t
              0x0              2.5                                    NAI_SG_SAMPLE_RATE_2P5_SPS 
              0x1              5                                      NAI_SG_SAMPLE_RATE_5_SPS
              0x2             10                                      NAI_SG_SAMPLE_RATE_10_SPS
              0x3             16.6666                                 NAI_SG_SAMPLE_RATE_16P6666_SPS
              0x4             20                                      NAI_SG_SAMPLE_RATE_20_SPS
              0x5             50                                      NAI_SG_SAMPLE_RATE_50_SPS
              0x6             60                                      NAI_SG_SAMPLE_RATE_60_SPS
              0x7            100                                      NAI_SG_SAMPLE_RATE_100_SPS
              0x8            400                                      NAI_SG_SAMPLE_RATE_400_SPS
              0x9           1200                                      NAI_SG_SAMPLE_RATE_1200_SPS
              0xA           2400                                      NAI_SG_SAMPLE_RATE_2400_SPS
              0xB           4800                                      NAI_SG_SAMPLE_RATE_4800_SPS
              0xC           7200                                      NAI_SG_SAMPLE_RATE_7200_SPS
              0xD          14400                                      NAI_SG_SAMPLE_RATE_14400_SPS
              0xE          19200                                      NAI_SG_SAMPLE_RATE_19200_SPS
              0xF          38400                                      NAI_SG_SAMPLE_RATE_38400_SPS

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
sampleRate	: (Input) Sample Rate setting to set. Refer to nai_sg_sample_rate_type_t for definition.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_INVALID_VALUE when invalid sampleRate parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetSensorFS()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetSensorFS	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float32_t	sensorfs )

This function will set the SensorFS Setting for the specified SG channel. Value in user defined units. This function is only supported by Generation 3 SG modules.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
sensorfs	: (Input) SensorFS value to set, units based on user definition.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetStrainAlertValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetStrainAlertValue	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_sg_strain_alert_value_type_t	strainAlertValueType,
		float64_t	strainAlertValue )

Sets the Strain Alert Value of the specified type for the specified SG channel. This function only applies to modules that are Generation 5 or later. Valid Strain Alert Value types are High Strain Alert Value 1, High Strain Alert Value 2, Low Strain Alert Value 1, and Low Strain Alert Value 2.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
strainAlertValueType	: (Input) Strain Alert Value type to set (see nai_sg_strain_alert_value_type_t definition).
strainAlertValue	: (Input) Strain Alert Value to set in units of microstrain.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_INVALID_VALUE when invalid strainAlertValueType parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetUseInternalBridgeCompletion()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetUseInternalBridgeCompletion	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	useInternalBridgeCompletion )

Sets the register bit that determines whether or not to use internal bridge completion for the specified SG channel. This function only applies to modules that are Generation 5 or later.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
useInternalBridgeCompletion	: (Input) 1 to use internal bridge completion, 0 otherwise.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

Functions

Detailed Description

Function Documentation

◆ naibrd_SG_Get_UserOrFactoryCalSel()

◆ naibrd_SG_GetBridgeConfiguration()

◆ naibrd_SG_GetBridgeSensitivity()

◆ naibrd_SG_GetExcitation()

◆ naibrd_SG_GetExcitationMode()

◆ naibrd_SG_GetExcitationSignal()

◆ naibrd_SG_GetGainRange()

◆ naibrd_SG_GetGaugeFactor()

◆ naibrd_SG_GetImbalanceOffsetValue()

◆ naibrd_SG_GetLeadResistance()

◆ naibrd_SG_GetNominalResistance()

◆ naibrd_SG_GetOutputDataCfg()

◆ naibrd_SG_GetPGAGain()

◆ naibrd_SG_GetPoissonRatio()

◆ naibrd_SG_GetRemoteDriveSense()

◆ naibrd_SG_GetSampleRate()

◆ naibrd_SG_GetSensorFS()

◆ naibrd_SG_GetStrainAlertValue()

◆ naibrd_SG_GetUseInternalBridgeCompletion()

◆ naibrd_SG_ResetCal()

◆ naibrd_SG_ResetMinimumAndMaximumStrain()

◆ naibrd_SG_Set_UserOrFactoryCalSel()

◆ naibrd_SG_SetBridgeConfiguration()

◆ naibrd_SG_SetBridgeSensitivity()

◆ naibrd_SG_SetExcitation()

◆ naibrd_SG_SetExcitationMode()

◆ naibrd_SG_SetExcitationSignal()

◆ naibrd_SG_SetGainRange()

◆ naibrd_SG_SetGaugeFactor()

◆ naibrd_SG_SetImbalanceOffsetValue()

◆ naibrd_SG_SetLeadResistance()

◆ naibrd_SG_SetNominalResistance()

◆ naibrd_SG_SetOutputDataCfg()

◆ naibrd_SG_SetPGAGain()

◆ naibrd_SG_SetPoissonRatio()

◆ naibrd_SG_SetRemoteDriveSense()

◆ naibrd_SG_SetSampleRate()

◆ naibrd_SG_SetSensorFS()

◆ naibrd_SG_SetStrainAlertValue()

◆ naibrd_SG_SetUseInternalBridgeCompletion()