Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
FIFO Operation Functions
NAI Board Library - Module Functions » SD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOCount (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outCount)
 Retrieves the number of items in the S/D FIFO Buffer for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ReadFIFORaw32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint32_t p_outData[], uint32_t *p_outRead)
 Retrieves multiple values from the SD FIFO Buffer for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOValue (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outValue)
 Retrieves one value from the S/D FIFO Buffer for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOFloatValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outValue)
 Retrieves one value in floating-point format from the S/D FIFO Buffer for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOLoThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t threshold)
 Sets the number of data words the FIFO will have left before setting the LoThreshold bit in the FIFO status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOLoThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outThreshold)
 Retrieves the count set in the LoThreshold register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOHiThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t threshold)
 Sets the number of data words the FIFO will receive before setting the HiThreshold bit in the FIFO status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOHiThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outThreshold)
 Retrieves the count set in the HiThreshold register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOAlmostEmpty (int32_t cardIndex, int32_t module, int32_t channel, uint32_t empty)
 Sets the almost empty mark/threshold to set or to reset the SD channel's FIFO Status "Almost Empty" bit. When the SD channel's FIFO counter is less than or equal to the almost empty mark, the "Almost Empty" bit will be set (1). When the SD channel's FIFO counter is greater than the almost empty mark, the "Almost Empty" bit will be reset (0).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOAlmostEmpty (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outEmpty)
 Retrieves the "almost empty" mark/threshold used to set or to reset the SD channel's FIFO Status "Almost Empty" bit. When the SD channel's FIFO counter is less than or equal to the "almost empty" mark, the "Almost Empty" bit will be set (1). When the SD channel's FIFO counter is greater than the "almost empty" mark, the "Almost Empty" bit will be reset (0).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOAlmostFull (int32_t cardIndex, int32_t module, int32_t channel, uint32_t full)
 Sets the almost full mark/threshold to set or to reset the SD channel's FIFO Status "Almost Full" bit. When the SD channel's FIFO counter is greater than or equal to the almost full mark, the "Almost Full" bit will be set (1). When the SD channel's FIFO counter is less than the almost full mark, the "Almost Full" bit will be reset (0).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOAlmostFull (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outFull)
 Retrieves the "almost full" mark/threshold to set or to reset the SD channel's FIFO Status "Almost Full" bit. When the SD channel's FIFO counter is greater than or equal to the "almost full" mark, the "Almost Full" bit will be set (1). When the SD channel's FIFO counter is less than the "almost full" mark, the "Almost Full" bit will be reset (0).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFODelay (int32_t cardIndex, int32_t module, int32_t channel, uint32_t delay)
 Sets the time delay before samples are taken after the trigger occurs. The time delay is a function of sample time multiplied by the delay parameter. The sample time is set by the function naibrd_SD_SetFIFOSampleRate.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFODelay (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outDelay)
 Retrieves the time delay before samples are taken after the trigger occurs. The time delay is a function of sample time multiplied by the delay parameter. The sample time is set by the function naibrd_SD_SetFIFOSampleRate.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOSize (int32_t cardIndex, int32_t module, int32_t channel, uint32_t size)
 Sets the number of samples taken after the trigger occurs.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOSize (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outSize)
 Retrieves the number of samples taken after the trigger occurs.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOSampleRateValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t sampleRate)
 Sets the time in usec between samples taken in intervals of 4.096us.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOSampleRateValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outSampleRate)
 Retrieves the time in usec between samples taken in intervals of 4.096us.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOSampleRate (int32_t cardIndex, int32_t module, int32_t channel, uint32_t sampleRate)
 Sets the time between samples taken. The sample time has a base period of 4.096us.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOSampleRate (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outSampleRate)
 Retrieves the time between samples taken. The sample time has a base period of 4.096us.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFODataType (int32_t cardIndex, int32_t module, int32_t channel, uint32_t dataType)
 Sets the type of data to acquire in the buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFODataType (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outDataType)
 Retrieves the type of data to acquire in the buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearFIFO (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the S/D FIFO buffer for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOTrigMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t trigMode)
 Sets the trigger mode to start data buffering.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOTrigMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outTrigMode)
 Retrieves the trigger mode to start data buffering.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SoftwareTrigger (int32_t cardIndex, int32_t module)
 Sends a software trigger to all channels.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_status_type_t statusType, nai_status_bit_t *p_outStatus)
 Retrieves the event mapped status of a channel for a specific event mapped status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_event_mapped_status_type_t statusType)
 Clears the SD Event Mapped Latched Status for the specified channel and status type.
 

Detailed Description

Function Documentation

◆ naibrd_SD_ClearEventMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearEventMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_status_type_t statusType )

Clears the SD Event Mapped Latched Status for the specified channel and status type.

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]).
statusType: (Input) Event Mapped Status Type: refer to naibrd_sd_event_mapped_status_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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_ClearFIFO()

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

Clears the S/D FIFO buffer for the specified 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]).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetEventMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEventMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_event_mapped_status_type_t statusType,
nai_status_bit_t * p_outStatus )

Retrieves the event mapped status of a channel for a specific event mapped status type.

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]).
statusType: (Input) Event Mapped Status Type: refer to naibrd_sd_event_mapped_status_type_t definition.
p_outStatus: (Output) Event Mapped Status (NAI_STATUS_BIT_LO or NAI_STATUS_BIT_HI).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOAlmostEmpty()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOAlmostEmpty ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outEmpty )

Retrieves the "almost empty" mark/threshold used to set or to reset the SD channel's FIFO Status "Almost Empty" bit. When the SD channel's FIFO counter is less than or equal to the "almost empty" mark, the "Almost Empty" bit will be set (1). When the SD channel's FIFO counter is greater than the "almost empty" mark, the "Almost Empty" bit will be reset (0).

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_outEmpty: (Output) Almost Empty Mark. (module specific range- see spec).
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_SD_GetFIFOAlmostFull()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOAlmostFull ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outFull )

Retrieves the "almost full" mark/threshold to set or to reset the SD channel's FIFO Status "Almost Full" bit. When the SD channel's FIFO counter is greater than or equal to the "almost full" mark, the "Almost Full" bit will be set (1). When the SD channel's FIFO counter is less than the "almost full" mark, the "Almost Full" bit will be reset (0).

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_outFull: (Output) Almost Full Mark. (module specific range- see spec).
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_SD_GetFIFOCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outCount )

Retrieves the number of items in the S/D FIFO Buffer for the specified 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_outCount: (Output) FIFO count.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFODataType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFODataType ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outDataType )

Retrieves the type of data to acquire in the buffer.

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_outDataType: (Output) Data Type to acquire in buffer per table below. 
  D0  = Angle Data
  D1  = Velocity Data
  D2  = Time Stamp. An integer counter that counts from 0 to 65535 and wraps around when it overflows
  D31 - D3 = Reserved
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFODelay()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFODelay ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outDelay )

Retrieves the time delay before samples are taken after the trigger occurs. The time delay is a function of sample time multiplied by the delay parameter. The sample time is set by the function naibrd_SD_SetFIFOSampleRate.

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_outDelay: (Output) Raw Delay count.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOFloatValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOFloatValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outValue )

Retrieves one value in floating-point format from the S/D FIFO Buffer for the specified 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_outValue: (Output) FIFO floating-point value retrieved.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOHiThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOHiThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outThreshold )

Retrieves the count set in the HiThreshold register.

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_outThreshold: (Output) Threshold value.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOLoThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOLoThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outThreshold )

Retrieves the count set in the LoThreshold register.

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_outThreshold: (Output) Threshold value.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOSampleRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOSampleRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outSampleRate )

Retrieves the time between samples taken. The sample time has a base period of 4.096us.

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.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOSampleRateValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOSampleRateValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outSampleRate )

Retrieves the time in usec between samples taken in intervals of 4.096us.

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 value.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOSize()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOSize ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outSize )

Retrieves the number of samples taken after the trigger occurs.

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_outSize: (Output) Number of Samples.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOTrigMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOTrigMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outTrigMode )

Retrieves the trigger mode to start data buffering.

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_outTrigMode: (Output) Trigger Mode as specified in table below. 
  D1 - D0 : 0x00 = Ext Trigger, 0x01 = Reserved, 0x02 = Software Trigger, 0x03 = Reserved
  D3 - D2 : Reserved
  D4 = Trigger Slope (0 = Positive, 1 = Negative)
  D5 = Trigger Enable
  D6 = Enable Trigger Always
  D31 - D7 : Reserved
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFIFOValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFIFOValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outValue )

Retrieves one value from the S/D FIFO Buffer for the specified 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_outValue: (Output) FIFO value.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_ReadFIFORaw32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ReadFIFORaw32 ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t count,
uint32_t p_outData[],
uint32_t * p_outRead )

Retrieves multiple values from the SD FIFO Buffer for the specified 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]).
count: (Input) Number of items to be read out of the FIFO.
p_outData: (Output) Items read from the FIFO.
p_outRead: (Output) Number of items read out of the FIFO.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid count parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFOAlmostEmpty()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOAlmostEmpty ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t empty )

Sets the almost empty mark/threshold to set or to reset the SD channel's FIFO Status "Almost Empty" bit. When the SD channel's FIFO counter is less than or equal to the almost empty mark, the "Almost Empty" bit will be set (1). When the SD channel's FIFO counter is greater than the almost empty mark, the "Almost Empty" bit will be reset (0).

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]).
empty: (Input) Almost Empty Mark (module specific range- see spec).
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 empty parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFOAlmostFull()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOAlmostFull ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t full )

Sets the almost full mark/threshold to set or to reset the SD channel's FIFO Status "Almost Full" bit. When the SD channel's FIFO counter is greater than or equal to the almost full mark, the "Almost Full" bit will be set (1). When the SD channel's FIFO counter is less than the almost full mark, the "Almost Full" bit will be reset (0).

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]).
full: (Input) Almost Full Mark. (module specific range- see spec).
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 full parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFODataType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFODataType ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t dataType )

Sets the type of data to acquire in the buffer.

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]).
dataType: (Input) Data Type to acquire in buffer as specified in table below. 
  D0  = Angle Data
  D1  = Velocity Data
  D2  = Time Stamp. An integer counter that counts from 0 to 65535 and wraps around when it overflows
  D31 - D3 = Reserved
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid dataType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFODelay()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFODelay ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t delay )

Sets the time delay before samples are taken after the trigger occurs. The time delay is a function of sample time multiplied by the delay parameter. The sample time is set by the function naibrd_SD_SetFIFOSampleRate.

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]).
delay: (Input) Raw Delay count.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFOHiThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOHiThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t threshold )

Sets the number of data words the FIFO will receive before setting the HiThreshold bit in the FIFO status register.

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]).
threshold: (Input) Number of words.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid threshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFOLoThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOLoThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t threshold )

Sets the number of data words the FIFO will have left before setting the LoThreshold bit in the FIFO status register.

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]).
threshold: (Input) Number of words.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid threshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFOSampleRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOSampleRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t sampleRate )

Sets the time between samples taken. The sample time has a base period of 4.096us.

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.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_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_SD_SetFIFOSampleRateValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOSampleRateValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t sampleRate )

Sets the time in usec between samples taken in intervals of 4.096us.

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) Time in usec (0 to 671078).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_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_SD_SetFIFOSize()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOSize ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t size )

Sets the number of samples taken after the trigger occurs.

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]).
size: (Input) Number of Samples.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid size parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFIFOTrigMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFIFOTrigMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t trigMode )

Sets the trigger mode to start data buffering.

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]).
trigMode: (Input) Trigger Mode to acquire in buffer as specified in table below. 
  D1 - D0 : 0x00 = Ext Trigger, 0x01 = Reserved, 0x02 = Software Trigger, 0x03 = Reserved
  D3 - D2 : Reserved
  D4 = Trigger Slope (0 = Positive, 1 = Negative)
  D5 = Trigger Enable
  D6 = Enable Trigger Always
  D31 - D7 : Reserved
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid trigMode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SoftwareTrigger()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SoftwareTrigger ( int32_t cardIndex,
int32_t module )

Sends a software trigger to all channels.

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]).
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_SUPPORTED when function is not supported.