|
nai_status_t NAIINLINE | verify_group (uint32_t modId, int32_t group) |
|
NAIBRDFUNC int32_t NAIAPI | naibrd_AD_GetChannelCount (uint32_t modId) |
| Returns the number of channels for the specified A/D Module ID.
|
|
NAIBRDFUNC int32_t NAIAPI | naibrd_AD_GetGroupCount (uint32_t modId) |
| Returns the number of channel groups for the specified A/D Module ID.
|
|
NAIBRDFUNC int32_t NAIAPI | naibrd_AD_GetGroupSize (uint32_t modId) |
| Returns the number of channel in each group for the specified A/D Module ID.
|
|
NAIBRDFUNC int32_t NAIAPI | naibrd_AD_GetMaxFIFOCount (uint32_t modId) |
| Returns the maximum size of the FIFO for the specified A/D Module ID.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outvoltage) |
| Retrieves the sampled voltage from the specified A/D channel data register. The sampled voltage is scaled per the voltage range and polarity register value.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetVoltageAll (int32_t cardIndex, int32_t module, int32_t arraysize, float64_t p_outvoltageall[]) |
| Retrieves the sampled voltage from all of the A/D channels. The sampled voltage is scaled per the voltage range and polarity register value.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetRMSVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outvoltage) |
| Retrieves the calculated RMS voltage from the specified A/D channel data register. The calculated RMS voltage is scaled per the LSB value.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetCurrent (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outcurrent) |
| Retrieves the measured current from the specified A/D channel data register. The measured current is scaled with full scale range from 0 - 25 mA.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetCurrentAll (int32_t cardIndex, int32_t module, int32_t arraysize, float64_t p_outcurrentall[]) |
| Retrieves the measured current from all of the A/D channels. The measured current is scaled with full scale range from 0 - 25 mA.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetLatch (int32_t cardIndex, int32_t module, bool_t latched) |
| Latches or unlatch all A/D channels.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetLatch (int32_t cardIndex, int32_t module, bool_t *p_outlatched) |
| Retrieves the Latch state (latched or unlatched) of all A/D channels.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_status_type_t type, nai_status_bit_t *p_outstatusBit) |
| Retrieves the A/D BIT or Open Status for the specified A/D channel. Reading any status bit will unlatch the entire register. BIT Status and Open Status is part of the background testing and the status register may be checked or polled at any given time.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_status_type_t type) |
| Clears the A/D Status corresponding to the specified A/D Status type for the specified A/D channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables/disables status reporting for the specified AD channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable) |
| Retrieves the enabled/disabled state of status reporting for the specified AD channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetRange (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_range_mode_t mode, float64_t range) |
| Sets the range and polarity for the specified A/D channel as follows:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetRange (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_range_mode_t *p_outmode, float64_t *p_outrange) |
| Retrieves the range and polarity for the specified A/D channel as follows:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetSampleRate (int32_t cardIndex, int32_t module, uint32_t rate) |
| Sets the sampling clock rate for the specified A/D module. The sampling clock rate can be specified from 2000Hz to 200 KHz with the LSB equal to 1 Hz. Note: AD1/AD2/AD3 max frequency is 256kHz, AD4/AD5/AD6/ is 400kHz distributed among active channels.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetSampleRate (int32_t cardIndex, int32_t module, uint32_t *p_outrate) |
| Retrieves the sampling clock rate for the specified A/D module. The sampling clock rate can be specified from 2000Hz to 200 KHz with the LSB equal to 1 Hz.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetBreakFrequency (int32_t cardIndex, int32_t module, int32_t channel, uint32_t freq) |
| Sets the filter break frequency for the specified A/D channel. The break frequency is the 3 db point of a single pole low pass filter. The break frequency can be specified between 10 Hz to 10 KHz with LSB equal to 1 Hz. Zero disables the filter.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetBreakFrequency (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outfreq) |
| Retrieves the filter break frequency for the specified A/D channel. The break frequency is the 3 db point of a single pole low pass filter. The break frequency can be between 10 Hz to 10 KHz with LSB equal to 1 Hz. Zero indicates a disabled filter.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_mode_t mode) |
| Sets the mode for the specified A/D channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_mode_t *p_outmode) |
| Retrieves the mode for the specified A/D channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFloatingPointOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t offset) |
| Sets the HW floating point offset for the specified A/D channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFloatingPointOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outoffset) |
| Retrieves the HW floating point offset for the specified A/D channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFloatingPointScaleFactor (int32_t cardIndex, int32_t module, int32_t channel, float64_t scaleFactor) |
| Sets the HW floating point scale factor for the specified A/D channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFloatingPointScaleFactor (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outscaleFactor) |
| Retrieves the HW floating point scale factor for the specified A/D channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetThresholdDetect (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_threshold_detect_id_type_t thresholdID, float64_t thresholdset, float64_t thresholdclear) |
| Sets the A/D thresholds that set and clear the status for the specified thresholdID (Threshold1 or Threshold2) and channel. The threshold direction and hysteresis, which are required by the H/W, are derived from 'set' and 'clear' values.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetThresholdDetect (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_threshold_detect_id_type_t thresholdID, float64_t *p_outthresholdset, float64_t *p_outthresholdclear) |
| Retrieves the A/D thresholds that set and clear the status for the specified thresholdID (Threshold1 or Threshold2) and channel. The threshold 'set', 'direction' and 'hysteresis' are read from the H/W and are used to derive the threshold 'clear' value.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetSaturationControl (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_saturation_control_type_t saturationType, bool_t enable) |
| Enables/Disables the Saturation Control for the specified saturation type and channel. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_LOW will limit the channel's lower reading to the value specified in the Low Saturation Level register. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_HIGH will limit the channel's upper reading to the value specified in the High Saturation Level register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetSaturationControl (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_saturation_control_type_t saturationType, bool_t *outenable) |
| Retrieves the Saturation Control for the specified saturation type and channel. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_LOW will limit the channel's lower reading to the value specified in the Low Saturation Level register. Enabling a saturation type of NAI_AD_SATURATION_CONTROL_HIGH will limit the channel's upper reading to the value specified in the High Saturation Level register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetSaturationLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_saturation_control_type_t saturationType, float64_t level) |
| Sets the Saturation level for the specified saturation type and channel. A saturation type of NAI_AD_SATURATION_CONTROL_LOW will set the lower limit of the channel's reading to the value specified. A saturation type of NAI_AD_SATURATION_CONTROL_HIGH will set the upper limit of the channel's upper reading to the value specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetSaturationLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_saturation_control_type_t saturationType, float64_t *p_outlevel) |
| Retrieves the Saturation level for the specified saturation type and channel. A saturation type of NAI_AD_SATURATION_CONTROL_LOW will get the lower saturation limit of the channel specified. A saturation type of NAI_AD_SATURATION_CONTROL_HIGH will get the upper saturation limit of the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetModuleSyncMode (int32_t cardIndex, int32_t module, naibrd_module_sync_config_type_t syncConfigType, naibrd_module_sync_mode_type_t syncMode, int32_t syncConfigModule) |
| Sets the Synchronization mode for the module specified. Sample clocks and FIFO triggers can be synchronized between modules via a shared internal GPIO (shared between modules on the same board). Boards can share (synchronize) clocks and FIFO triggers between each other via an external I/O connection (front or rear I/O). This API sets the board mapping of a clock/trigger source (module or external) to all/any slave modules that sync off that signal.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetModuleSyncMode (int32_t cardIndex, int32_t module, naibrd_module_sync_config_type_t syncConfigType, naibrd_module_sync_mode_type_t *outsyncMode, int32_t *outsyncConfigModule) |
| Retrieves the Synchronization mode for the module specified. Sample clocks and FIFO triggers can be synchronized between modules via a shared internal GPIO (shared between modules on the same board). Boards can share (synchronize) clocks and FIFO triggers between each other via an external I/O connection (front or rear I/O). This API sets the board mapping of a clock/trigger source (module or external) to all/any slave modules that sync off that signal.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetModuleSyncDecimation (int32_t cardIndex, int32_t module, uint32_t decimation) |
| Sets decimation (oversampling) rate of the User Supplied Signal for the Master Module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetModuleSyncDecimation (int32_t cardIndex, int32_t module, uint32_t *outdecimation) |
| Retrieves decimation (oversampling) rate of the User Supplied Signal for the Master Module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_Reset (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_reset_type_t resetType) |
| Resets the A/D channel as specified by the reset type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ResetAll (int32_t cardIndex, int32_t module, nai_ad_reset_type_t resetType) |
| Resets all channels on the module as specified by the reset type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetChannelState (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_state_t state) |
| Sets the bit corresponding to the specified channel in the Active Channel Register. Setting the active channel bit to "inactive" for unused channels will prevent false alarms (BIT or Open) from being generated for unused channels.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetChannelState (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_state_t *p_outstate) |
| Retrieves the bit corresponding to the specified channel in the Active Channel Register. Setting the active channel bit to "inactive" for unused channels will prevent false alarms (BIT or Open) from being generated for unused channels.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConfigureD0Test (int32_t cardIndex, int32_t module, nai_ad_range_mode_t mode, float64_t range, float64_t testlevel) |
| Sets the D0 Test Range and D0 Test Voltage for A/D module under test.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetD0TestSettings (int32_t cardIndex, int32_t module, nai_ad_range_mode_t *p_outmode, float64_t *p_outrange, float64_t *p_outtestlevel) |
| Retrieves the D0 Test Range and D0 Test Voltage for A/D module under test.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetTestEnable (int32_t cardIndex, int32_t module, nai_ad_test_type_t type, bool_t enable) |
| Sets the A/D D0, D2 or D3 BIT Test Enable state for the specified A/D module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetTestEnable (int32_t cardIndex, int32_t module, nai_ad_test_type_t type, bool_t *p_outenable) |
| Retrieves the A/D D0, D2 or D3 BIT Test Enable state for the specified A/D module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_CheckD2TestVerify (int32_t cardIndex, int32_t module) |
| Checks the D2 Test Verify register for the value of 0x55. When the D2 Test is enabled, the board will write 0x55 to the D2 Test Verify register. This register can be cleared to 0x00 and then read again, after approximately one second, to verify that background BIT testing is activated.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ClearD2TestVerify (int32_t cardIndex, int32_t module) |
| Clears the D2 Test Verify register. When the D2 Test is enabled, the board will write 0x55 to the D2 Test Verify register. After this register is cleared to 0x00, after approximately one second, call naibrd_AD_CheckD2TestVerify to verify that the board wrote 0x55 to the D2 Test Verify register, verifying that background BIT testing is activated.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_CheckPowerOnBITComplete (int32_t cardIndex, int32_t module, bool_t *p_outpbitComplete) |
| Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for the specified module. The PBIT result will be in the BIT status register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetModuleBITErrorThreshold (int32_t cardIndex, int32_t module, uint32_t threshold) |
| Sets the BIT Error Threshold for continuous BIT conditions. The Error Threshold is a scalar for the internal BIT +2/-1 counter. To filter our momentary or intermittent anomalies in background BIT errors, this value can be increased to allow the error the "come and go" before the BIT status is flagged.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetModuleBITErrorThreshold (int32_t cardIndex, int32_t module, uint32_t *p_outthreshold) |
| Retrieves the BIT Error Threshold for continuous BIT conditions. The Error Threshold is a scalar for the internal BIT +2/-1 counter. To filter our momentary or intermittent anomalies in background BIT errors, this value can be increased to allow the error the "come and go" before the BIT status is flagged.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ClearModuleBITLogic (int32_t cardIndex, int32_t module, int32_t channel) |
| Resets the Continuous BIT internal circuitry and counter mechanism for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_status_type_t type, bool_t enable) |
| Sets the A/D BIT or Open Status Interrupt Enable state for the specified A/D channel. BIT Status and Open Status is part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_status_type_t type, bool_t *p_outenable) |
| Retrieves the A/D BIT or Open Status Interrupt Enable state for the specified A/D channel. BIT Status and Open Status is part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetInterruptVector (int32_t cardIndex, int32_t module, nai_ad_status_type_t type, uint32_t vector) |
| Sets the A/D BIT or Open Status Interrupt Vector for the specified A/D module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetInterruptVector (int32_t cardIndex, int32_t module, nai_ad_status_type_t type, uint32_t *p_outvector) |
| Retrieves the A/D BIT or Open Status Interrupt Vector for the specified A/D module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_status_type_t type, nai_ad_edgelevel_t edgelevel) |
| Sets the edge or level triggered interrupt mask for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_status_type_t type, nai_ad_edgelevel_t *p_outedgelevel) |
| Retrieves the edge or level triggered interrupt mask for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_ad_status_type_t type, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering which indicates the interrupt direction for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_ad_status_type_t type, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOCount (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcount) |
| Retrieves the FIFO counter registers that indicate the number of data elements in the A/D channel's FIFO buffer. Each time a read operation is made to the A/D channel's FIFO Buffer, the corresponding FIFO counter register is decremented by one. The maximum number of items that can be stored in each A/D channel's FIFO is 26,213 (0x6665). The maximum number of items that can be stored in each gen5 A/D channel's FIFO is 2,097,151 (0x001FFFFF).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ReadFIFORaw16 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint16_t p_outdata[], uint32_t *p_outread) |
| Retrieves data elements from the A/D channel's FIFO buffer. The data is presented in two's complement format. For bipolar mode; 0x7FFF equals Positive Full Scale, 0x8000 equals Negative Full Scale. For unipolar mode, the range is from 0x0000 to 0xFFFF where 0xFFFF equals Full Scale.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ReadFIFORaw32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint32_t p_outdata[], uint32_t *p_outread) |
| Retrieves data elements from the A/D channel's FIFO buffer. The data is presented in two's complement format. For bipolar mode; 0x7FFF equals Positive Full Scale, 0x8000 equals Negative Full Scale. For unipolar mode, the range is from 0x0000 to 0xFFFF where 0xFFFF equals Full Scale.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ReadFIFO32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, float32_t p_outdata[], uint32_t *p_outread) |
| Retrieves data elements from the A/D channel's FIFO buffer. The data is retrieved in two's complement format, and is then converted into floating-point format. If floating-point mode is enabled for the module, the data will be converted into IEEE 754 (32-bit) floating-point format. If floating-point mode is disabled, the data is converted into floating-point format based on the following specifications: For bipolar mode; 0x7FFF equals Positive Full Scale, 0x8000 equals Negative Full Scale. For unipolar mode, the range is from 0x0000 to 0xFFFF where 0xFFFF equals Full Scale. Full Scale is the maximum value of the range.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOAlmostEmpty (int32_t cardIndex, int32_t module, int32_t channel, uint32_t empty) |
| Sets the almost empty mark to use to set or reset the A/D channel's FIFO Status "Almost Empty" bit. When the A/D channel's FIFO counter is less than or equal to the almost empty mark, the "Almost Empty" bit will be set. When the A/D channel's FIFO counter is greater than the almost empty mark, the "Almost Empty" bit will be reset.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOAlmostEmpty (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outempty) |
| Retrieves the "almost empty" mark used to set or reset the A/D channel's FIFO Status "Almost Empty" bit. When the A/D channel's FIFO counter is less than or equal to the "almost empty" mark, the "Almost Empty" bit will be set. When the A/D channel's FIFO counter is greater than the "almost empty" mark, the "Almost Empty" bit will be reset.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOAlmostFull (int32_t cardIndex, int32_t module, int32_t channel, uint32_t full) |
| Sets the almost full mark to use to set or reset the A/D channel's FIFO Status "Almost Full" bit. When the A/D channel's FIFO counter is less than or equal to the almost full mark, the "Almost Full" bit will be set. When the A/D channel's FIFO counter is greater than the almost full mark, the "Almost Full" bit will be reset.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOAlmostFull (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outfull) |
| Retrieves the "almost full" mark used to set or reset the A/D channel's FIFO Status "Almost Full" bit. When the A/D channel's FIFO counter is less than or equal to the "almost full" mark, the "Almost Full" bit will be set. When the A/D channel's FIFO counter is greater than the "almost full" mark, the "Almost Full" bit will be reset.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOLoThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t threshold) |
| Sets the low threshold level to use to set or reset the A/D channel's FIFO Status "Low Limit" bit. When the A/D channel's FIFO counter is less than or equal to the low threshold level, the "Low Limit" bit will be set. When the A/D channel's FIFO counter is greater than the low threshold level, the "Low Limit" bit will be reset.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOLoThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outthreshold) |
| Retrieves the low threshold level to use to set or reset the A/D channel's FIFO Status "Low Limit" bit. When the A/D channel's FIFO counter is less than or equal to the low threshold level, the "Low Limit" bit will be set. When the A/D channel's FIFO counter is greater than the low threshold level, the "Low Limit" bit will be reset.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOHiThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t threshold) |
| Sets the high threshold level to use to set or reset the A/D channel's FIFO Status "High Limit" bit. When the A/D channel's FIFO counter is greater than or equal to the high threshold level, the "High Limit" bit will be set. When the A/D channel's FIFO counter is less than the high threshold level, the "High Limit" bit will be reset.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOHiThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outthreshold) |
| Retrieves the high threshold level to use to set or reset the A/D channel's FIFO Status "High Limit" bit. When the A/D channel's FIFO counter is greater than or equal to the high threshold level, the "High Limit" bit will be set. When the A/D channel's FIFO counter is less than the high threshold level, the "High Limit" bit will be reset.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFODelay (int32_t cardIndex, int32_t module, int32_t channel, uint32_t delay) |
| Sets the number of delay samples before the actual FIFO data collection begins. The data collected during the delay period will be discarded.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFODelay (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outdelay) |
| Retrieves the number of delay samples before the actual FIFO data collection begins. The data collected during the delay period will be discarded.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOSize (int32_t cardIndex, int32_t module, int32_t channel, uint32_t size) |
| Sets the number of samples to be taken and placed into the FIFO before the A/D channel's FIFO Status "Sample Done" bit is set after a trigger occurs. Note that the size of each sample (number of words written to the FIFO per sample) is determined by the sample format described by the Buffer Control register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOSize (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outsize) |
| Retrieves the number of samples to be taken and placed into the FIFO before the A/D channel's FIFO Status "Sample Done" bit is set after a trigger occurs. Note that the size of each sample (number of words written to the FIFO per sample) is determined by the sample format described by the Buffer Control register.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOSkip (int32_t cardIndex, int32_t module, int32_t channel, uint32_t skip) |
| Sets the skip count for the FIFO buffer. The FIFO skip count sets how many samples to skip over in between each FIFO store. For example, if the sample rate for a channel is 10kHz, there would be a new sample every 100 micro-seconds. By setting the FIFO skip count to 1, the FIFO would store a new sample every 200us, or in other words, at a 5kHz rate.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOSkip (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outskip) |
| Retrieves the skip count for the FIFO buffer. The FIFO skip count sets how many samples to skip over in between each FIFO store. For example, if the sample rate for a channel is 10kHz, there would be a new sample every 100 micro-seconds. By setting the FIFO skip count to 1, the FIFO would store a new sample every 200us, or in other words, at a 5kHz rate.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFORate (int32_t cardIndex, int32_t module, int32_t channel, uint32_t rate) |
| Sets the sampling rate for the A/D channel's FIFO buffer. The FIFO sampling rate is value is based on the A/D module's sampling clock rate. For example, if the A/D module's sampling clock rate is 200 KHz, the A/D module's sampling rate is 5 usec. Setting the A/D channel's FIFO sampling rate value to 2 will result in the FIFO buffer to be sampling at 5 usec * 2 = 10 usec.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFORate (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outrate) |
| Retrieves the sampling rate for the A/D channel's FIFO buffer. The FIFO sampling rate is value is based on the A/D module's sampling clock rate. For example, if the A/D module's sampling clock rate is 200 KHz, the A/D module's sampling rate is 5 usec. Setting the A/D channel's FIFO sampling rate value to 2 will result in the FIFO buffer to be sampling at 5 usec * 2 = 10 usec.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOCtrl (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_ctrl_t ctrl) |
| Sets the format of the samples to be stored in the A/D channel's FIFO buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOCtrl (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_ctrl_t *p_outctrl) |
| Retrieves the format of the samples to be stored in the A/D channel's FIFO buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ClearFIFO (int32_t cardIndex, int32_t module, int32_t channel) |
| Clears the channel's data FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOTrigCtrl (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_trig_t ctrl) |
| Sets the A/D channel's FIFO buffer trigger control configuration.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOTrigCtrl (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_trig_t *p_outctrl) |
| Retrieves the A/D channel's FIFO buffer trigger control configuration.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SoftwareTrigger (int32_t cardIndex, int32_t module) |
| Sets the A/D module's FIFO Buffer Software Trigger register to 1. The Software trigger is used to kick start the FIFO buffer and the collection of data. The Trigger Control Configuration for each A/D channel's FIFO must be set up properly before invoking this routine. Setting the Software Trigger will start FIFO data collection for all A/D channels.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_status_type_t fifoStatusType, nai_ad_fifo_status_t *p_outstatus) |
| Retrieves the A/D channel's FIFO Buffer Status.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ResetFIFOTimestamp (int32_t cardIndex, int32_t module) |
| Resets the FIFO timestamp.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_status_t mask) |
| Sets the A/D Interrupt Enable setting for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_status_t *p_outmask) |
| Retrieves the A/D Interrupt Enable setting for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint16_t vector) |
| NOTE: It is recomended that naibrd_AD_SetFIFOInterruptVector32() is used instead of this API. Sets the Interrupt Vector for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOInterruptVector32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t vector32) |
| Sets the Interrupt Vector for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, uint16_t *p_outvector) |
| NOTE: It is recomended that naibrd_AD_GetFIFOInterruptVector32() is used instead of this API. Retrieves the Interrupt Vector for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOInterruptVector32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outvector32) |
| Retrieves the Interrupt Vector for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_status_t edgelevelmask) |
| Sets the edge or level triggered interrupt mask for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_status_t *p_outedgelevelmask) |
| Retrieves the edge or level triggered interrupt mask for the specified A/D channel's FIFO Buffer.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetFIFOInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering which indicates the interrupt direction for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetFIFOInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering which indicates the interrupt direction for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToVoltageRange (uint32_t modid, nai_ad_range_t rawdata, nai_ad_range_mode_t *p_outmode, float64_t *p_outrange) |
| Returns the unipolar/bipolar mode and voltage range associated with the A/D Module ID and raw data code.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToVoltageRangeRaw (uint32_t modid, nai_ad_range_mode_t mode, float64_t range, nai_ad_range_t *p_outrawdata) |
| Returns the raw data code associated with the A/D Module ID and the unipolar/bipolar mode and voltage range.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToVoltage (uint32_t modid, nai_ad_range_t range, uint32_t rawdata, float64_t *p_outvoltage) |
| Calculates the voltage in volts associated with the A/D Module ID and given range and raw data.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToLevelD0 (uint32_t modid, nai_ad_range_t range, uint32_t rawdata, float64_t *p_outlevel) |
| Calculates the voltage/current associated with the A/D Module ID and given range and raw data for D0.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToVoltageRaw (uint32_t modid, nai_ad_range_t range, float64_t voltage, uint32_t *p_outrawdata) |
| Calculates the raw voltage associated with the A/D Module ID and given range and voltage.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToLevelRawD0 (uint32_t modid, nai_ad_range_t range, float64_t level, uint32_t *p_outrawdata) |
| Calculates the raw voltage/current associated with the A/D Module ID and given range and voltage for D0.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToCurrentRange (uint32_t modid, nai_ad_range_t rawdata, nai_ad_range_mode_t *p_outmode, float64_t *p_outrange) |
| Returns the unipolar/bipolar mode and current range associated with the A/D Module ID and raw data code.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToCurrentRangeRaw (uint32_t modid, nai_ad_range_mode_t mode, float64_t range, nai_ad_range_t *p_outrawdata) |
| Returns the raw data code associated with the A/D Module ID and the unipolar/bipolar mode and voltage range.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToCurrent (uint32_t modid, nai_ad_range_t range, uint32_t rawdata, float64_t *p_outcurrent) |
| Calculates the current in Amps associated with the A/D Module ID and given range and raw data.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToCurrentRaw (uint32_t modid, nai_ad_range_t range, float64_t current, uint32_t *p_outrawdata) |
| Calculates the raw current associated with the A/D Module ID and given range and current.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetRaw (int32_t cardIndex, int32_t module, nai_ad_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_AD_GetRaw (int32_t cardIndex, int32_t module, nai_ad_raw_t type, uint32_t *p_outrawdata) |
| Retrieves the raw data value in the register associated to the register type specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_channel_raw_t type, uint32_t rawdata) |
| Sets the raw data value in the register associated to the channel and channel register type specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_channel_raw_t type, uint32_t *p_outrawdata) |
| Retrieves the raw data value in the register associated to the channel and channel register type specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetStatusRaw (int32_t cardIndex, int32_t module, nai_ad_status_type_t type, uint32_t *p_outrawdata) |
| Retrieves the raw status data value in the register associated to the group and status type specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ClearStatusRaw (int32_t cardIndex, int32_t module, nai_ad_status_type_t type, uint32_t rawdata) |
| Clears the status data value in the register associated to the group and status type specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ClearFIFOStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_ad_fifo_status_t mask) |
| Clears the FIFO status data value in the latched register associated to the channel specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToVoltageD0 (uint32_t modid, nai_ad_range_t range, uint32_t rawdata, float64_t *outvoltage) |
| Obsoleted. Please use naibrd_AD_ConvertToLevelD0() instead. Calculates the voltage associated with the A/D Module ID and given range and raw data for D0.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_ConvertToVoltageRawD0 (uint32_t modid, nai_ad_range_t range, float64_t voltage, uint32_t *outrawdata) |
| Obsoleted. Please use naibrd_AD_ConvertToLevelRawD0() instead. Calculates the raw voltage associated with the A/D Module ID and given range and voltage for D0.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetCalibrationIntervalDelay (int32_t cardIndex, int32_t module, uint32_t delay) |
| Sets the automatic background calibration interval delay between individual A/D channels. The calibration interval delay is specified in seconds with the LSB equal to 1 sec. The default calibration interval delay is 30 seconds. Note changing the calibration interval delay will effect the time for BIT and Open Status registers to be updated.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetCalibrationIntervalDelay (int32_t cardIndex, int32_t module, uint32_t *p_outdelay) |
| Retrieves the automatic background calibration interval delay between individual A/D channels. The calibration interval delay is specified in seconds with the LSB equal to 1 sec. The default calibration interval delay is 30 seconds. Note changing the calibration interval delay will effect the time for BIT and Open Status registers to be updated.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_SetCalRaw (int32_t cardIndex, int32_t module, nai_ad_cal_type_t type, uint32_t rawdata) |
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_AD_GetCalRaw (int32_t cardIndex, int32_t module, nai_ad_cal_type_t type, uint32_t *outrawdata) |
|