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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ClockRate (int32_t cardIndex, int32_t module, int32_t channel, int32_t clockRate)
 Sets the SSI Clock rate for encoder serial clock speed in steps of 1uS. Range is configurable from steps of 1 to 32, value of 0 will stop SSI interface. In SSI listener mode clock rate setting is ignored and will be automatically detected.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ClockRate (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outclockRate)
 Gets the SSI Clock rate for encoder serial clock speed in steps of 1uS. Range is configurable from steps of 1 to 32, value of 0 will stop SSI interface. In SSI listener mode clock rate setting is ignored and will be automatically detected.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ClockEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_clock_t clockEdge)
 Sets the Clock Edge configuration for the specified Encoder channel. Channel can be configured to clock SSI data on rising or falling edges.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ClockEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_clock_t *outclockEdge)
 Gets the Clock Edge configuration for the specified Encoder channel. Channel can be configured to clock SSI data on rising or falling edges.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_DataBits (int32_t cardIndex, int32_t module, int32_t channel, int32_t dataBits)
 Sets the number of data bits for the specified Encoder channel, configurable from 1 to 32.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_DataBits (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outdataBits)
 Gets the number of data bits for the specified Encoder channel, configurable from 1 to 32.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_Parity (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_parity_t parity)
 Sets the Parity configuration for the specified Encoder channel. Channel can be configured for odd or even parity.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_Parity (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_parity_t *outParity)
 Gets the Parity configuration for the specified Encoder channel. Channel can be configured for odd or even parity.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ParityEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables or Disables Parity error detection for the specified Encoder channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ParityEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEnable)
 Retrieves Parity error detection Enabled/Disabled configuration for the specified Encoder channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ErrorBreakEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Set error break configuration for the specified encoder channel, break on read error if enabled and ignore read errors if disabled. This feature is only available in SSI listener configuration.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ErrorBreakEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEnable)
 Retrieves error break configuration for the specified encoder channel, break on read error if enabled and ignore read errors if disabled. This feature is only available in SSI listener mode.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ZeroBitEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Set zero bit mode to enabled/disabled for the specified encoder channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ZeroBitEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEnable)
 Retrieves zero bit mode configuration for the specified encoder channel, enabled or disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_DwellCount (int32_t cardIndex, int32_t module, int32_t channel, int32_t dwellCount)
 Sets the SSI Dwell count for the specified encoder channel. Dwell count corresponds to number of bit cycles the clock will idle for after an SSI read.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_DwellCount (int32_t cardIndex, int32_t module, int32_t channel, int32_t *outdwellCount)
 Gets the SSI Dwell count for the specified encoder channel. Dwell count corresponds to number of bit cycles the clock will idle for after an SSI read.
 

Detailed Description


Function Documentation

◆ naibrd_ENC_GetSSI_ClockEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ClockEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_ssi_clock_t * outclockEdge )

Gets the Clock Edge configuration for the specified Encoder channel. Channel can be configured to clock SSI data on rising or falling edges.

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]).
outclockEdge: (Output) Mode Type: refer to nai_enc_ssi_clock_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_GetSSI_ClockRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ClockRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * outclockRate )

Gets the SSI Clock rate for encoder serial clock speed in steps of 1uS. Range is configurable from steps of 1 to 32, value of 0 will stop SSI interface. In SSI listener mode clock rate setting is ignored and will be automatically detected.

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]).
outclockRate: (Output) Clock Rate, steps of 1uS and configurable from 1 to 32.
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_GetSSI_DataBits()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_DataBits ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * outdataBits )

Gets the number of data bits for the specified Encoder channel, configurable from 1 to 32.

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]).
outdataBits: (Output) Data bits, valid range from 1 to 32.
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_GetSSI_DwellCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_DwellCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * outdwellCount )

Gets the SSI Dwell count for the specified encoder channel. Dwell count corresponds to number of bit cycles the clock will idle for after an SSI read.

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]).
outdwellCount: (Output) Number of bit cycles to idle after SSI read.
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_GetSSI_ErrorBreakEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ErrorBreakEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outEnable )

Retrieves error break configuration for the specified encoder channel, break on read error if enabled and ignore read errors if disabled. This feature is only available in SSI listener mode.

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]).
outEnable: (Output) 0 = Disabled, 1 = Enabled.
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_GetSSI_Parity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_Parity ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_ssi_parity_t * outParity )

Gets the Parity configuration for the specified Encoder channel. Channel can be configured for odd or even parity.

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]).
outParity: (Output) Parity Type: refer to nai_enc_ssi_parity_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_GetSSI_ParityEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ParityEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outEnable )

Retrieves Parity error detection Enabled/Disabled configuration for the specified Encoder 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]).
outEnable: (Output) 0 = Disabled, 1 = Enabled.
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_GetSSI_ZeroBitEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_ZeroBitEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outEnable )

Retrieves zero bit mode configuration for the specified encoder channel, enabled or disabled.

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]).
outEnable: (Output) 0 = Disabled, 1 = Enabled.
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_SetSSI_ClockEdgeLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ClockEdgeLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_ssi_clock_t clockEdge )

Sets the Clock Edge configuration for the specified Encoder channel. Channel can be configured to clock SSI data on rising or falling edges.

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]).
clockEdge: (Input) Mode Type: refer to nai_enc_ssi_clock_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_SetSSI_ClockRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ClockRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t clockRate )

Sets the SSI Clock rate for encoder serial clock speed in steps of 1uS. Range is configurable from steps of 1 to 32, value of 0 will stop SSI interface. In SSI listener mode clock rate setting is ignored and will be automatically detected.

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]).
clockRate: (Input) Clock Rate, steps of 1uS and configurable from 1 to 32.
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_INVALID_VALUE when invalid clock rate parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_SetSSI_DataBits()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_DataBits ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t dataBits )

Sets the number of data bits for the specified Encoder channel, configurable from 1 to 32.

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]).
dataBits: (Input) Data bits, valid range from 1 to 32.
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_SetSSI_DwellCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_DwellCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t dwellCount )

Sets the SSI Dwell count for the specified encoder channel. Dwell count corresponds to number of bit cycles the clock will idle for after an SSI read.

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]).
dwellCount: (Input) Number of bit cycles to idle after SSI read.
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_INVALID_VALUE when invalid clock rate parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_ENC_SetSSI_ErrorBreakEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ErrorBreakEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Set error break configuration for the specified encoder channel, break on read error if enabled and ignore read errors if disabled. This feature is only available in SSI listener configuration.

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]).
enable: (Input) 0 = Disabled, 1 = Enabled.
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_SetSSI_Parity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_Parity ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_ssi_parity_t parity )

Sets the Parity configuration for the specified Encoder channel. Channel can be configured for odd or even parity.

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]).
parity: (Input) Parity Type: refer to nai_enc_ssi_parity_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_SetSSI_ParityEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ParityEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables or Disables Parity error detection for the specified Encoder 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]).
enable: (Input) 0 = Disabled, 1 = Enabled.
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_SetSSI_ZeroBitEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_ZeroBitEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Set zero bit mode to enabled/disabled for the specified encoder 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]).
enable: (Input) 0 = Disabled, 1 = Enabled.
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.