Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Input Debounce Functions
TTL Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetDebounceTime (int32_t cardIndex, int32_t module, int32_t channel, float64_t debounceTime_mS)
 Sets the debounce time for the specified channel. Enter time in milliseconds. When a signal level is within a valid logic range and maintains that level for a period longer than the debounce time, the logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
Once valid, the transition status is set and the output logic changes state.
Enter a value of 0 to disable debounce filtering. Debounce defaults to 0 upon power on or reset.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetDebounceTime (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outdebounceTime_mS)
 Retrieves the debounce time for the specified TTL channel, in units of milliseconds. When a signal level is within a valid logic range and maintains that level for a period longer than the debounce time, the logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
Once valid, the transition status is set and the output logic changes state.
A value of 0 disables debounce filtering. Debounce defaults to 0 upon power on or reset.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetDebounceLSB (int32_t cardIndex, int32_t module, float64_t debounceTimeLSB_mS)
 Sets the debounce LSB time value (applies to all the channels on the module). This debounce LSB time value coupled with the value in the individual channel debounce time registers will determine the effective debounce time for each channel. Feature presently available only on the D7 TTL module; LSB is fixed on other modules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetDebounceLSB (int32_t cardIndex, int32_t module, float64_t *outdebounceLSB_mS)
 Retrieves the debounce LSB time value, applicable for all channels on the module. This value, multiplied by the value set in the individual channel debounce time register determines the effective debounce time for each channel. For the D7 module, this LSB unit is user configurable. Debounce LSB is fixed in other modules.
 

Detailed Description


Function Documentation

◆ naibrd_TTL_GetDebounceLSB()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetDebounceLSB ( int32_t cardIndex,
int32_t module,
float64_t * outdebounceLSB_mS )

Retrieves the debounce LSB time value, applicable for all channels on the module. This value, multiplied by the value set in the individual channel debounce time register determines the effective debounce time for each channel. For the D7 module, this LSB unit is user configurable. Debounce LSB is fixed in other 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]).
outdebounceLSB_mS: (Output) Debounce Time LSB in mS. Range 0.000160 to 5.24288 mS, in powers of 2 steps)
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetDebounceTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetDebounceTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outdebounceTime_mS )

Retrieves the debounce time for the specified TTL channel, in units of milliseconds. When a signal level is within a valid logic range and maintains that level for a period longer than the debounce time, the logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
Once valid, the transition status is set and the output logic changes state.
A value of 0 disables debounce filtering. Debounce defaults to 0 upon power on or reset.

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]).
outdebounceTime_mS: (Output) Valid time in mS.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_TTL_SetDebounceLSB()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetDebounceLSB ( int32_t cardIndex,
int32_t module,
float64_t debounceTimeLSB_mS )

Sets the debounce LSB time value (applies to all the channels on the module). This debounce LSB time value coupled with the value in the individual channel debounce time registers will determine the effective debounce time for each channel. Feature presently available only on the D7 TTL module; LSB is fixed on other 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]).
debounceTimeLSB_mS: (Input) Debounce time LSB value, entered in milliseconds. Allowable range 0.000160 to 5.24288 mS, in power of 2 steps)
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetDebounceTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetDebounceTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t debounceTime_mS )

Sets the debounce time for the specified channel. Enter time in milliseconds. When a signal level is within a valid logic range and maintains that level for a period longer than the debounce time, the logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
Once valid, the transition status is set and the output logic changes state.
Enter a value of 0 to disable debounce filtering. Debounce defaults to 0 upon power on or reset.

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]).
debounceTime_mS: (Input) Valid time entered in mS.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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.