Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Common Configuration Operation Functions
Encoder Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetInputTermination (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, nai_enc_term_t termination)
 Sets the Input termination for the specified Encoder channel and port. Termination can be configured to enable or disable a 120 ohm termination resistor.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetInputTermination (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, nai_enc_term_t *outTermination)
 Retrieves the Input termination for the specified Encoder channel and port. Termination can be configured to enable or disable a 120 ohm termination resistor.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetDebounceTime (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, float64_t debounceTime)
 Sets the debounce time for the specified Encoder channel and port. Enter time in milliseconds. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetDebounceTime (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, float64_t *outdebounceTime)
 Retrieves the debounce time for the specified Encoder channel and port. Time returned in milliseconds. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetDebounceTimeWord (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, uint32_t debounceWord)
 Sets the debounce time word for the specified Encoder channel and port. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetDebounceTimeWord (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, uint32_t *outdebounceWord)
 Retrieves the debounce time word for the specified Encoder channel and port. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetDebounceEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, bool_t enable)
 Sets the debounce circuit to enabled or disabled for specified Encoder channel and port.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetDebounceEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, bool_t *outEnable)
 Retrieves the debounce enabled or disabled state for specified Encoder channel and port.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetInputThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t inputThreshold)
 Sets the input threshold for the specified Encoder channel. Enter threshold in volts. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetInputThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outInputThreshold)
 Retrieves the input threshold for the specified Encoder channel. Threshold returned in volts. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetInputThresholdWord (int32_t cardIndex, int32_t module, int32_t channel, uint32_t inputThresholdWord)
 Sets the input threshold word for the specified Encoder channel. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetInputThresholdWord (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outInputThresholdWord)
 Retrieves the input threshold word for the specified Encoder channel. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetHighVoltEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, bool_t enable)
 Enables or disables high voltage mode for the specified Encoder channel and port. When high voltage mode is enabled a 7.5kOhm resistor is put in series between the high leg of the transceiver and connector high pin. Also another 7.5kOhm resistor is put in series between the low leg of the transceiver and connector low pin.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetHighVoltEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_port_t port, bool_t *outEnable)
 Retrieves high voltage config for the specified Encoder channel and port. When high voltage mode is enabled a 7.5kOhm resistor is put in series between the high leg of the transceiver and connector high pin. Also another 7.5kOhm resistor is put in series between the low leg of the transceiver and connector low pin.
 

Detailed Description


Function Documentation

◆ naibrd_ENC_GetDebounceEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetDebounceEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
bool_t * outEnable )

Retrieves the debounce enabled or disabled state for specified Encoder channel and port.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
outEnable: (Output) 0 = disable debounce circuit, 1 = enable debounce circuit.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_GetDebounceTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetDebounceTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
float64_t * outdebounceTime )

Retrieves the debounce time for the specified Encoder channel and port. Time returned in milliseconds. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
outdebounceTime: (Output) Valid time, units of milliseconds.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_GetDebounceTimeWord()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetDebounceTimeWord ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
uint32_t * outdebounceWord )

Retrieves the debounce time word for the specified Encoder channel and port. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
outdebounceWord: (Output) Raw value, units of lsb.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_GetHighVoltEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetHighVoltEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
bool_t * outEnable )

Retrieves high voltage config for the specified Encoder channel and port. When high voltage mode is enabled a 7.5kOhm resistor is put in series between the high leg of the transceiver and connector high pin. Also another 7.5kOhm resistor is put in series between the low leg of the transceiver and connector low pin.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
outEnable: (Output) 0 = connect transceiver direct to connector, 1 = drop in 7.5kOhm resistor in series.
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_ENC_GetInputTermination()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetInputTermination ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
nai_enc_term_t * outTermination )

Retrieves the Input termination for the specified Encoder channel and port. Termination can be configured to enable or disable a 120 ohm termination resistor.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
outTermination: (Output) Mode Type: refer to nai_enc_term_t definition.
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_ENC_GetInputThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetInputThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outInputThreshold )

Retrieves the input threshold for the specified Encoder channel. Threshold returned in volts. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.

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]).
outInputThreshold: (Output) Valid threshold, units of volts.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_GetInputThresholdWord()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetInputThresholdWord ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outInputThresholdWord )

Retrieves the input threshold word for the specified Encoder channel. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.

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]).
outInputThresholdWord: (Output) Raw value, units of lsb.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_SetDebounceEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetDebounceEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
bool_t enable )

Sets the debounce circuit to enabled or disabled for specified Encoder channel and port.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
enable: (Input) 0 = disable debounce circuit, 1 = enable debounce circuit.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_SetDebounceTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetDebounceTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
float64_t debounceTime )

Sets the debounce time for the specified Encoder channel and port. Enter time in milliseconds. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
debounceTime: (Input) Valid time, units of milliseconds .
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_SetDebounceTimeWord()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetDebounceTimeWord ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
uint32_t debounceWord )

Sets the debounce time word for the specified Encoder channel and port. When a signal reaches a logic voltage level and maintains that level for a period longer than the debounce time a logic transition is validated. Signal pulse widths less than debounce time are filtered or ignored.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
debounceWord: (Input) Raw value, units of lsb.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_SetHighVoltEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetHighVoltEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
bool_t enable )

Enables or disables high voltage mode for the specified Encoder channel and port. When high voltage mode is enabled a 7.5kOhm resistor is put in series between the high leg of the transceiver and connector high pin. Also another 7.5kOhm resistor is put in series between the low leg of the transceiver and connector low pin.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
enable: (Input) 0 = connect transceiver direct to connector, 1 = drop in 7.5kOhm resistor in series.
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_ENC_SetInputTermination()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetInputTermination ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_port_t port,
nai_enc_term_t termination )

Sets the Input termination for the specified Encoder channel and port. Termination can be configured to enable or disable a 120 ohm termination resistor.

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]).
port: (Input) Port Type: refer to nai_enc_port_t definition.
termination: (Input) Format Type: refer to nai_enc_term_t definition.
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_ENC_SetInputThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetInputThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t inputThreshold )

Sets the input threshold for the specified Encoder channel. Enter threshold in volts. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.

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]).
inputThreshold: (Input) Valid threshold, units of volts.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_SetInputThresholdWord()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetInputThresholdWord ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t inputThresholdWord )

Sets the input threshold word for the specified Encoder channel. When a channel is set for singled ended mode, the input threshold is configured for all ports. When a channel is set for differential mode, the input threshold must be set to zero.

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]).
inputThresholdWord: (Input) Raw value, units of lsb.
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.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.