Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Standard Operation Functions
NAI Board Library - Module Functions » RLY Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetRelayState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rly_state_t state)
 Sets the relay control state for the specified RLY channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetRelayState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rly_state_t *p_outstate)
 Retrieves the control setting state for the specified RLY channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetRelayPosition (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rly_state_t *p_outstate)
 Retrieves the physical relay position for the specified RLY channel, via reading of secondary pole contacts.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rly_chan_mapped_status_type_t type, nai_status_bit_t *p_outstatusBit)
 Retrieves the status for the specified status type and RLY channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rly_chan_mapped_status_type_t type)
 Clears the latched status for the specified RLY channel and status type. (Applicable for latched status types only)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type, nai_status_bit_t *p_outstatusBit)
 Retrieves the status for the specified status type and RLY channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_rly_status_type_t type)
 Clears the latched status for the specified RLY channel and status type. (Applicable for latched status types only)
 

Detailed Description

Function Documentation

◆ naibrd_RLY_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_rly_chan_mapped_status_type_t type )

Clears the latched status for the specified RLY channel and status type. (Applicable for latched status types only)

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 naibrd_rly_chan_mapped_status_type_t definitions (Latched types only).
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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rly_status_type_t type )

Clears the latched status for the specified RLY channel and status type. (Applicable for latched status types only)

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_rly_status_type_t definition (Latched types only).
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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_rly_chan_mapped_status_type_t type,
nai_status_bit_t * p_outstatusBit )

Retrieves the status for the specified status type and RLY 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]).
type: (Input) Status Type: refer to naibrd_rly_chan_mapped_status_type_t definition.
p_outstatusBit: (Output) Refer to nai_status_bit_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_RLY_GetRelayPosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetRelayPosition ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_rly_state_t * p_outstate )

Retrieves the physical relay position for the specified RLY channel, via reading of secondary pole contacts.

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]).
p_outstate: (Output) Refer to naibrd_rly_state_t definitions.
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_RLY_GetRelayState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetRelayState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_rly_state_t * p_outstate )

Retrieves the control setting state for the specified RLY channel. 

NAIBRD_RLY_STATE_OPEN:  Normally Open (N.O.) relay contact open, Normally Closed (N.C.) contact connected to COM.
NAIBRD_RLY_STATE_CLOSE: N.O. relay contact connected to COM. N.C. contact open.
Power on default state for non-latching relay modules KN and RY1 is N.C.
Latching relay modules KL and RY2 will remain in the last prior state from power down.
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]).
p_outstate: (Output) Refer to naibrd_rly_state_t definitions.
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_RLY_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rly_status_type_t type,
nai_status_bit_t * p_outstatusBit )

Retrieves the status for the specified status type and RLY channel.

These functions are deprecated and replaced by API functions in naibrd_rly.c

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_rly_status_type_t definition.
p_outstatusBit: (Output) Refer to nai_status_bit_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_RLY_SetRelayState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetRelayState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_rly_state_t state )

Sets the relay control state for the specified RLY channel. 

NAIBRD_RLY_STATE_CLOSE: Normally Open (N.O.) relay contact connected to Common (COM). 
NAIBRD_RLY_STATE_OPEN:  Normally Closed (N.C.)
Power on default state for non-latching relay modules KN and RY1 is N.C.
Latching relay modules KL and RY2 will remain in the last prior state from power down.
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]).
state: (Input) Refer to naibrd_rly_state_t definitions.
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 state parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.