Software Library API naibrd 1.62
See all documentation at naii.docs.com
Macros | Functions
naibrd_sg.c File Reference
#include <stdlib.h>
#include <string.h>
#include "functions/naibrd_sg.h"
#include "maps/nai_map_sg.h"
#include "maps/nai_map_modCommon.h"
#include "advanced/naibrd_adv.h"
#include "naibrd_config.h"
#include "boards/naibrd_gen5.h"

Macros

#define SG_GEN3_BUFFER_MODE_ENABLE   0xBEEFu
 
#define SG_GEN3_BUFFER_MODE_DISABLE   0u
 

Functions

NAIBRDFUNC int32_t NAIAPI naibrd_SG_GetChannelCount (uint32_t modid)
 Returns the number of channels for the specified Strain Gauge Module ID.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetOutput (int32_t cardIndex, int32_t module, int32_t channel, float32_t *output)
 This function will return the measurement data for the specified SG channel by reading the dataword, internally scaled by the channel's range, sensitivity, and sensor output scaling settings. Units are determined by the user's entry for Sensor Full Scale, e.g. pound force(lbf) or newtons (N). This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetOutputVV (int32_t cardIndex, int32_t module, int32_t channel, float32_t *outputvv)
 This function will return the Volts per Volt floating point data value for the specified SG channel. Units in V/V: e.g. 0.0030 represents 3.0 mV/V. Internally adjusted for range selection. (Not scaled by the sensitivity or full scale settings.) This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRawOutput (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_channel_output_t type, int32_t *outdata)
 Retrieves the digital data value in the register associated with the channel and register type specified. Note: Data returned may be 16 bit or 24 bit bipolar values, depending on the selection of the data type being accessed. This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStrain (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outstrain)
 Retrieves the calculated strain for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetOutputVoutVexc (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outoutputvv)
 Retrieves the Vout/Vexcitation voltage ratio for the specified SG Channel in units of V/V. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetMinStrainValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outminStrainValue)
 Retrieves the minimum strain value recorded for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetMaxStrainValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outmaxStrainValue)
 Retrieves the maximum strain value recorded for the specified SG Channel in units of microstrain. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRawADReading (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outrawADReading)
 Retrieves the raw A/D channel voltage reading for the specified SG Channel. This function is only supported by modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, nai_status_bit_t *outstatusBit)
 Retrieves the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type)
 Clears the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status for the specified SG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBusy (int32_t cardIndex, int32_t module, uint32_t *outbusy)
 This function will read the Busy state word for all the SG Channels in the specified module. This function is only supported by Generation 3 SG modules.
 
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.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBufferTrigger (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_buffer_trigger_t trigger)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBufferTrigger (int32_t cardIndex, int32_t module, nai_sg_buffer_trigger_t *outtrigger)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBufferData (int32_t cardIndex, int32_t module, uint32_t *outbufferdataword)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBufferDataIndex (int32_t cardIndex, int32_t module, uint32_t bufferindex)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBufferDataEnable (int32_t cardIndex, int32_t module, nai_sg_buffer_mode_enable_t bufferreadenable)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, bool_t enable)
 Sets the bit corresponding to the specified SG Channel in the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Interrupt Enable register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, bool_t *outenable)
 Retrieves the bit corresponding to the specified SG Channel in the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Interrupt Enable register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptVector (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t vector)
 This function will set the vector for the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptVector (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t *outvector)
 This function will read the vector for the BIT, Open, AD Error, AD No Reference, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, nai_sg_edgelevel_t edgelevel)
 Sets the bit corresponding to the specified SG channel in the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 edge/level interrupt register. This function only applies to modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_status_type_t type, nai_sg_edgelevel_t *outedgelevel)
 Retrieves the bit corresponding to the specified SG channel in the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 edge/level interrupt register. This function only applies to modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, naibrd_int_steering_t steering)
 This function will set the interrupt steering, which indicates the interrupt direction, for the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt. This function only applies to modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, naibrd_int_steering_t *outsteering)
 This function retrieves the interrupt steering, which indicates the interrupt direction, for the BIT, Open, High Strain Alert 1, High Strain Alert 2, Low Strain Alert 1, or Low Strain Alert 2 Status interrupt. This function only applies to modules that are Generation 5 or later.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBitOpenInterval (int32_t cardIndex, int32_t module, uint32_t bitopeninterval)
 This function will set the BIT/OPEN Interval time word for all the SG Channels in the specified module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBitOpenInterval (int32_t cardIndex, int32_t module, uint32_t *outbitopeninterval)
 This function will read the BIT/OPEN Interval time word for all the SG Channels in the specified module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetCalInterval (int32_t cardIndex, int32_t module, uint32_t calinterval)
 This function will set the background calibration interval time word for all the SG Channels in the specified module. This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetCalInterval (int32_t cardIndex, int32_t module, uint32_t *outcalinterval)
 This function will read the background calibration interval time word for all the SG Channels in the specified module. This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetCalType (int32_t cardIndex, int32_t module, nai_sg_cal_type_t caltype)
 This function will set the cal type selection for the specified module. Set per module (Applies to all channels in module). This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetCalType (int32_t cardIndex, int32_t module, nai_sg_cal_type_t *outcaltype)
 This function will read the cal type selection for the specified module. This function is only supported by Generation 3 SG modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetRaw (int32_t cardIndex, int32_t module, nai_sg_raw_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRaw (int32_t cardIndex, int32_t module, nai_sg_raw_t type, uint32_t *outrawdata)
 Retrieves the raw digital data value in the register associated to the register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_raw_channel_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the channel and register type specified. Note: values written to data output registers will have no effect; only the excitation voltage selection is valid.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_sg_raw_channel_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the channel and register type specified. Note: Data format may be in floating point or signed integer, depending on the selection of the data type being accessed.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetStatusRaw (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t *outrawdata)
 Retrieves the raw status data value in the register associated to the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_ClearStatusRaw (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t rawdata)
 Clears the bits set in the rawdata parameter in the status register associated to the status type specified. The status registers are bitmapped per channel, with the LSB corresponding to Channel 1 and the MSB corresponding to the max SG Channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetIntEnableRaw (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t rawdata)
 Sets the raw interrupt enable data value in the register associated to the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetIntEnableRaw (int32_t cardIndex, int32_t module, nai_sg_status_type_t type, uint32_t *outrawdata)
 Retrieves the raw interrupt enable data value in the register associated to the status type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetCalFactors (int32_t cardIndex, int32_t module, int32_t range, int32_t channel, int32_t caloffset, int32_t calgain)
 
NAIBRDFUNC float32_t NAIAPI naibrd_SG_ComputeOutputDataRate (nai_sg_chop_stab_enable_t ChopStabEnable, nai_sg_SINC_filter_t SINCFilter, uint32_t ODRScale)
 
NAIBRDFUNC float32_t NAIAPI naibrd_SG_GainRangeLSB (uint32_t gainRange)
 

Macro Definition Documentation

◆ SG_GEN3_BUFFER_MODE_DISABLE

#define SG_GEN3_BUFFER_MODE_DISABLE   0u

◆ SG_GEN3_BUFFER_MODE_ENABLE

#define SG_GEN3_BUFFER_MODE_ENABLE   0xBEEFu

Function Documentation

◆ naibrd_SG_ComputeOutputDataRate()

NAIBRDFUNC float32_t NAIAPI naibrd_SG_ComputeOutputDataRate ( nai_sg_chop_stab_enable_t ChopStabEnable,
nai_sg_SINC_filter_t SINCFilter,
uint32_t ODRScale )

◆ naibrd_SG_GainRangeLSB()

NAIBRDFUNC float32_t NAIAPI naibrd_SG_GainRangeLSB ( uint32_t gainRange)

◆ naibrd_SG_GetBufferData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBufferData ( int32_t cardIndex,
int32_t module,
uint32_t * outbufferdataword )

◆ naibrd_SG_GetBufferTrigger()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetBufferTrigger ( int32_t cardIndex,
int32_t module,
nai_sg_buffer_trigger_t * outtrigger )

◆ naibrd_SG_GetRawOutput()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_GetRawOutput ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sg_channel_output_t type,
int32_t * outdata )

Retrieves the digital data value in the register associated with the channel and register type specified. Note: Data returned may be 16 bit or 24 bit bipolar values, depending on the selection of the data type being accessed. 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]).
type: (Input) Channel Register Type: refer to nai_sg_channel_output_t type definition.
outdata: (Output) Output Data.
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.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SG_SetBufferDataEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBufferDataEnable ( int32_t cardIndex,
int32_t module,
nai_sg_buffer_mode_enable_t bufferreadenable )

◆ naibrd_SG_SetBufferDataIndex()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBufferDataIndex ( int32_t cardIndex,
int32_t module,
uint32_t bufferindex )

◆ naibrd_SG_SetBufferTrigger()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetBufferTrigger ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sg_buffer_trigger_t trigger )

◆ naibrd_SG_SetCalFactors()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SG_SetCalFactors ( int32_t cardIndex,
int32_t module,
int32_t range,
int32_t channel,
int32_t caloffset,
int32_t calgain )