Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Standard Operation Functions
Discrete Switch Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetSwitchState (int32_t cardIndex, int32_t module, int32_t channel, nai_dsw_switch_state_t switchstate)
 Sets the switch closure state for the specified Discrete Switch channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetSwitchState (int32_t cardIndex, int32_t module, int32_t channel, nai_dsw_switch_state_t *outswitchstate)
 Retrieves the Output State for the specified Discrete Switch channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetInputState (int32_t cardIndex, int32_t module, int32_t channel, nai_dsw_state_t *outstate)
 Retrieves the Input State for the specified Discrete Switch channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outvoltage)
 Retrieves the voltage measurement for the specified Discrete Switch channel. releases.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetCurrent (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outcurrent)
 Retrieves the current measurement for the specified Discrete Switch channel. releases.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetOverCurrent (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outovercurrent)
 Retrieves the current measurement for the specified Discrete Switch channel. releases.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetOverCurrent (int32_t cardIndex, int32_t module, int32_t channel, float64_t overcurrent)
 Retrieves the current measurement for the specified Discrete Switch channel. releases.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetAvgVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outvoltage)
 Retrieves the RMS voltage measurement for the specified Discrete Switch channel. Reading will be positive for both pos and neg polarity. releases.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetAvgCurrent (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outcurrent)
 Retrieves the average current measurement for the specified Discrete Switch channel. releases.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dsw_status_type_t type, nai_status_bit_t *outstatusBit)
 Retrieves the status for the specified Discrete Switch channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dsw_status_type_t type)
 Clears the latched status for the specified channel and status type.
 

Detailed Description


Function Documentation

◆ naibrd_DSW_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dsw_status_type_t type )

Clears the latched status for the specified channel and status type.

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]).
type: (Input) Status Type: refer to nai_dsw_status_type_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_INVALID_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_GetAvgCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetAvgCurrent ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outcurrent )

Retrieves the average current measurement for the specified Discrete Switch channel. releases.

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]).
outcurrent: (Output) Current reading in amps.
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_DSW_GetAvgVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetAvgVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outvoltage )

Retrieves the RMS voltage measurement for the specified Discrete Switch channel. Reading will be positive for both pos and neg polarity. releases.

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]).
outvoltage: (Output) RMS Voltage reading in 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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_GetCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetCurrent ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outcurrent )

Retrieves the current measurement for the specified Discrete Switch channel. releases.

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]).
outcurrent: (Output) Current reading in amps.
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_DSW_GetInputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetInputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dsw_state_t * outstate )

Retrieves the Input State for the specified Discrete Switch 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]).
outstate: (Output) NAI_DSW_STATE_LO or NAI_DSW_STATE_HI.
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_DSW_GetOverCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetOverCurrent ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outovercurrent )

Retrieves the current measurement for the specified Discrete Switch channel. releases.

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]).
outovercurrent: (Output) Current reading in amps.
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_DSW_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dsw_status_type_t type,
nai_status_bit_t * outstatusBit )

Retrieves the status for the specified Discrete Switch channel and status type.

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]).
type: (Input) Status Type: refer to nai_dsw_status_type_t definition.
outstatusBit: (Output) 0 for Normal, 1 Failure Detected.
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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_GetSwitchState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetSwitchState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dsw_switch_state_t * outswitchstate )

Retrieves the Output State for the specified Discrete Switch 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]).
outswitchstate: (Output) NAI_DSW_STATE_LO or NAI_DSW_STATE_HI.
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_DSW_GetVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outvoltage )

Retrieves the voltage measurement for the specified Discrete Switch channel. releases.

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]).
outvoltage: (Output) Voltage reading in 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 is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DSW_SetOverCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetOverCurrent ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t overcurrent )

Retrieves the current measurement for the specified Discrete Switch channel. releases.

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]).
overcurrent: (Output) Current reading in amps.
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_DSW_SetSwitchState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_SetSwitchState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dsw_switch_state_t switchstate )

Sets the switch closure state for the specified Discrete Switch 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]).
switchstate: (Input) NAI_DSW_STATE_LO or NAI_DSW_STATE_HI.
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.