Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
	Enables/disables status reporting for the specified SG channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
	Retrieves the enabled/disabled state of status reporting for the specified SG channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_SG_SetRemoteDriveSense (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sg_remote_sense_t sense)
	Sets 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, naibrd_sg_remote_sense_t *p_outsense)
	Retrieves the Remote Sense Drive setting for the specified SG channel per table below.

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 *p_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, naibrd_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, naibrd_sg_bridge_config_type_t *p_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, naibrd_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, naibrd_sg_pga_gain_type_t *p_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 *p_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 *p_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 *p_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 *p_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, naibrd_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, naibrd_sg_sample_rate_type_t *p_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, naibrd_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, naibrd_sg_strain_alert_value_type_t strainAlertValueType, float64_t *p_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 *p_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 *p_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_GetBridgeConfiguration()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBridgeConfiguration	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_sg_bridge_config_type_t *	p_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]).
p_outbridgeConfig	: (Output) Bridge Config type read from module (see naibrd_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_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChanStatusEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	p_outenable )

Retrieves the enabled/disabled state of status reporting for the specified SG channel.

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]).
p_outenable	: (Output) 0 if channel status reporting is disabled or 1 if channel status reporting is enabled.

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 *	p_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]).
p_outexcitationVolt	: (Output) Excitation value read from module (0V - NAIBRD_SG_GEN5_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_GetGaugeFactor()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetGaugeFactor	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	p_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]).
p_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 *	p_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]).
p_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 *	p_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]).
p_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 *	p_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]).
p_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_GetPGAGain()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetPGAGain	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_sg_pga_gain_type_t *	p_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   naibrd_sg_pga_gain_type_t
*               0x0           1                NAIBRD_SG_PGA_GAIN_1
*               0x1           2                NAIBRD_SG_PGA_GAIN_2
*               0x2           4                NAIBRD_SG_PGA_GAIN_4
*               0x3           8                NAIBRD_SG_PGA_GAIN_8
*               0x4          16                NAIBRD_SG_PGA_GAIN_16
*               0x5          32                NAIBRD_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]).
p_outpgaGain	: (Output) PGA Gain setting read from module. Refer to naibrd_sg_pga_gain_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_GetPoissonRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetPoissonRatio	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	p_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]).
p_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,
		naibrd_sg_remote_sense_t *	p_outsense )

Retrieves the Remote Sense Drive setting for the specified SG channel per table below.

* Remote Drive Sense  -  4 for OFF (Local)
*                        6 for ON  (Remote)
*

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]).
p_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,
		naibrd_sg_sample_rate_type_t *	p_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)    naibrd_sg_sample_rate_type_t
*               0x0              2.5                                    NAIBRD_SG_SAMPLE_RATE_2P5_SPS
*               0x1              5                                      NAIBRD_SG_SAMPLE_RATE_5_SPS
*               0x2             10                                      NAIBRD_SG_SAMPLE_RATE_10_SPS
*               0x3             16.6666                                 NAIBRD_SG_SAMPLE_RATE_16P6666_SPS
*               0x4             20                                      NAIBRD_SG_SAMPLE_RATE_20_SPS
*               0x5             50                                      NAIBRD_SG_SAMPLE_RATE_50_SPS
*               0x6             60                                      NAIBRD_SG_SAMPLE_RATE_60_SPS
*               0x7            100                                      NAIBRD_SG_SAMPLE_RATE_100_SPS
*               0x8            400                                      NAIBRD_SG_SAMPLE_RATE_400_SPS
*               0x9           1200                                      NAIBRD_SG_SAMPLE_RATE_1200_SPS
*               0xA           2400                                      NAIBRD_SG_SAMPLE_RATE_2400_SPS
*               0xB           4800                                      NAIBRD_SG_SAMPLE_RATE_4800_SPS
*               0xC           7200                                      NAIBRD_SG_SAMPLE_RATE_7200_SPS
*               0xD          14400                                      NAIBRD_SG_SAMPLE_RATE_14400_SPS
*               0xE          19200                                      NAIBRD_SG_SAMPLE_RATE_19200_SPS
*               0xF          38400                                      NAIBRD_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]).
p_outsampleRate	: (Output) Sample Rate setting read from module. Refer to naibrd_sg_sample_rate_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_GetStrainAlertValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStrainAlertValue	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_sg_strain_alert_value_type_t	strainAlertValueType,
		float64_t *	p_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 type to read (see naibrd_sg_strain_alert_value_type_t definition).
p_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 *	p_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]).
p_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_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_SetBridgeConfiguration()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBridgeConfiguration	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_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 naibrd_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_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetChanStatusEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	enable )

Enables/disables status reporting for the specified SG channel.

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]).
enable	: (Input) 0 to disable or 1 to enable status reporting for a channel.

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 enable 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 - NAIBRD_SG_GEN5_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 parameter is out of range.
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_SetPGAGain()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetPGAGain	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_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   naibrd_sg_pga_gain_type_t
*               0x0           1                NAIBRD_SG_PGA_GAIN_1
*               0x1           2                NAIBRD_SG_PGA_GAIN_2
*               0x2           4                NAIBRD_SG_PGA_GAIN_4
*               0x3           8                NAIBRD_SG_PGA_GAIN_8
*               0x4          16                NAIBRD_SG_PGA_GAIN_16
*               0x5          32                NAIBRD_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 naibrd_sg_pga_gain_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 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,
		naibrd_sg_remote_sense_t	sense )

Sets the Remote Sense Drive mode for the specified SG channel per table below.

* Remote Drive Sense  -  4 for OFF (Local)
*                        6 for ON  (Remote)
*

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_INVALID_VALUE when invalid sense 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,
		naibrd_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)    naibrd_sg_sample_rate_type_t
*               0x0              2.5                                    NAIBRD_SG_SAMPLE_RATE_2P5_SPS
*               0x1              5                                      NAIBRD_SG_SAMPLE_RATE_5_SPS
*               0x2             10                                      NAIBRD_SG_SAMPLE_RATE_10_SPS
*               0x3             16.6666                                 NAIBRD_SG_SAMPLE_RATE_16P6666_SPS
*               0x4             20                                      NAIBRD_SG_SAMPLE_RATE_20_SPS
*               0x5             50                                      NAIBRD_SG_SAMPLE_RATE_50_SPS
*               0x6             60                                      NAIBRD_SG_SAMPLE_RATE_60_SPS
*               0x7            100                                      NAIBRD_SG_SAMPLE_RATE_100_SPS
*               0x8            400                                      NAIBRD_SG_SAMPLE_RATE_400_SPS
*               0x9           1200                                      NAIBRD_SG_SAMPLE_RATE_1200_SPS
*               0xA           2400                                      NAIBRD_SG_SAMPLE_RATE_2400_SPS
*               0xB           4800                                      NAIBRD_SG_SAMPLE_RATE_4800_SPS
*               0xC           7200                                      NAIBRD_SG_SAMPLE_RATE_7200_SPS
*               0xD          14400                                      NAIBRD_SG_SAMPLE_RATE_14400_SPS
*               0xE          19200                                      NAIBRD_SG_SAMPLE_RATE_19200_SPS
*               0xF          38400                                      NAIBRD_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 naibrd_sg_sample_rate_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 sampleRate 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,
		naibrd_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 type to set (see naibrd_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_INVALID_VALUE when invalid useInternalBridgeCompletion parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

Functions

Detailed Description

Function Documentation

◆ naibrd_SG_GetBridgeConfiguration()

◆ naibrd_SG_GetChanStatusEnable()

◆ naibrd_SG_GetExcitationSignal()

◆ naibrd_SG_GetGaugeFactor()

◆ naibrd_SG_GetImbalanceOffsetValue()

◆ naibrd_SG_GetLeadResistance()

◆ naibrd_SG_GetNominalResistance()

◆ naibrd_SG_GetPGAGain()

◆ naibrd_SG_GetPoissonRatio()

◆ naibrd_SG_GetRemoteDriveSense()

◆ naibrd_SG_GetSampleRate()

◆ naibrd_SG_GetStrainAlertValue()

◆ naibrd_SG_GetUseInternalBridgeCompletion()

◆ naibrd_SG_ResetMinimumAndMaximumStrain()

◆ naibrd_SG_SetBridgeConfiguration()

◆ naibrd_SG_SetChanStatusEnable()

◆ naibrd_SG_SetExcitationSignal()

◆ naibrd_SG_SetGaugeFactor()

◆ naibrd_SG_SetImbalanceOffsetValue()

◆ naibrd_SG_SetLeadResistance()

◆ naibrd_SG_SetNominalResistance()

◆ naibrd_SG_SetPGAGain()

◆ naibrd_SG_SetPoissonRatio()

◆ naibrd_SG_SetRemoteDriveSense()

◆ naibrd_SG_SetSampleRate()

◆ naibrd_SG_SetStrainAlertValue()

◆ naibrd_SG_SetUseInternalBridgeCompletion()