Software Library API naibrd 1.62
See all documentation at naii.docs.com
SSI Standard Control Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_Mode (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_mode_t mode)
 Sets the SSI Mode configuration for the specified Encoder channel. Channel can be configured as an SSI interface controller or listener.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_Mode (int32_t cardIndex, int32_t module, int32_t channel, nai_enc_ssi_mode_t *outMode)
 Retrieves the Mode configuration for the specified Encoder channel. Channel can be configured as an SSI interface controller or listener.
 

Detailed Description


Function Documentation

◆ naibrd_ENC_GetSSI_Mode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_GetSSI_Mode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_ssi_mode_t * outMode )

Retrieves the Mode configuration for the specified Encoder channel. Channel can be configured as an SSI interface controller or listener.

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]).
outMode: (Output) Mode Type: refer to nai_enc_ssi_mode_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_Mode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_ENC_SetSSI_Mode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_enc_ssi_mode_t mode )

Sets the SSI Mode configuration for the specified Encoder channel. Channel can be configured as an SSI interface controller or listener.

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]).
mode: (Input) Mode Type: refer to nai_enc_ssi_mode_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.