Software Library API naibrd 1.62
See all documentation at naii.docs.com
Raw Register Access Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_rly_raw_group_t type, uint32_t rawdata)
 Sets the raw data value in the register associated to the group and register type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetGroupRaw (int32_t cardIndex, int32_t module, int32_t group, nai_rly_raw_group_t type, uint32_t *outrawdata)
 Retrieves the raw data value in the register associated to the group and register type specified.
 

Detailed Description


Function Documentation

◆ naibrd_RLY_GetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetGroupRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_rly_raw_group_t type,
uint32_t * outrawdata )

Retrieves the raw data value in the register associated to the group and register type specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Group Type: Refer to nai_rly_raw_group_t definition.
outrawdata: (Output) Raw Data Code.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RLY_SetGroupRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetGroupRaw ( int32_t cardIndex,
int32_t module,
int32_t group,
nai_rly_raw_group_t type,
uint32_t rawdata )

Sets the raw data value in the register associated to the group and register type specified.

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]).
group: (Input) Channel Group Number to access (1 - [max channel groups for module]).
type: (Input) Group Type: Refer to nai_rly_raw_group_t definition.
rawdata: (Input) Raw Data Code.
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_VALUE when invalid group register type is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.