Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Printer Control Functions
Printer Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_SetControl (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_control_t control, uint32_t data)
 Sets the printer's control for the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetControl (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_control_t control, uint32_t *p_outdata)
 Retrieves the printer's control for the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_SetTerminationEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_termination_enable_t termEnable, uint32_t data)
 Enables/Disables the printer's termination resistors for the specified I/O lines on the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetTerminationEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_termination_enable_t termEnable, uint32_t *p_outdata)
 Retrieves the printer's I/O resistor termination for the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_status_type_t statusType, nai_prnt_status_t prntStatus, nai_status_bit_t *p_outstatusBit)
 Retrieves the printer's status for the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_status_type_t statusType, nai_prnt_status_t *p_outprntStatusRaw)
 Retrieves the printer's raw status register value for the specified module and channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_prnt_status_t prntStatus)
 Clears the printer's status corresponding to the specified status, module and channel.
 

Detailed Description


Function Documentation

◆ naibrd_PRNT_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_status_t prntStatus )

Clears the printer's status corresponding to the specified status, module and 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]).
prntStatus: (Input) Status Type: refer to nai_prnt_status_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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PRNT_GetControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_control_t control,
uint32_t * p_outdata )

Retrieves the printer's control for the specified module and 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]).
control: (Input) Control type. Can be one or more nai_prnt_control_t types or'd together
p_outdata: (Output) Control value. Data bits will align with the specified Control type(s).
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_PRNT_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_status_type_t statusType,
nai_prnt_status_t prntStatus,
nai_status_bit_t * p_outstatusBit )

Retrieves the printer's status for the specified module and 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]).
statusType: (Input) Status Type (RealTime or Latched): refer to nai_prnt_status_type_t definition.
prntStatus: (Input) Status: refer to nai_prnt_status_t definition.
p_outstatusBit: (Output) 0 for Normal, 1 BIT failure or Open Detected.
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 type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PRNT_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetStatusRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_status_type_t statusType,
nai_prnt_status_t * p_outprntStatusRaw )

Retrieves the printer's raw status register value for the specified module and 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]).
statusType: (Input) Status Type (RealTime or Latched): refer to nai_prnt_status_type_t definition.
p_outprntStatusRaw: (Output) Status: refer to nai_prnt_status_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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PRNT_GetTerminationEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_GetTerminationEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_termination_enable_t termEnable,
uint32_t * p_outdata )

Retrieves the printer's I/O resistor termination for the specified module and 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]).
termEnable: (Input) Termination Enable type. Can be one or more nai_prnt_termination_enable_t types or'd together
p_outdata: (Output) Termination Enable value. Data bits will align with the specified Termination Enable type(s).
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_PRNT_SetControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_SetControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_control_t control,
uint32_t data )

Sets the printer's control for the specified module and 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]).
control: (Input) Control type. Can be one or more nai_prnt_control_t types or'd together
data: (Input) Control value. Data bits must align with the specified Control type(s).
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_PRNT_SetTerminationEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PRNT_SetTerminationEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_prnt_termination_enable_t termEnable,
uint32_t data )

Enables/Disables the printer's termination resistors for the specified I/O lines on the specified module and 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]).
termEnable: (Input) Termination Enable type. Can be one or more nai_prnt_termination_enable_t types or'd together
data: (Input) Termination Enable value. Data bits must align with the specified Termination Enable type(s).
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.