Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Channel Configuration Functions
NAI Board Library - Module Functions » CD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetEnabledChannels (int32_t cardIndex, int32_t module, uint32_t enableChannelsMask)
 Enables the specified channels based upon the bits set in the enableChannelsMask param passed in.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetEnabledChannels (int32_t cardIndex, int32_t module, uint32_t *p_outenabledChannels)
 Retrieves the 32 bit value whereby the first 6 bits determine which of the 6 channels are enabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_InitiateManualBurnChannels (int32_t cardIndex, int32_t module, uint32_t manualBurnChannelsMask)
 Initiates manual burn on the channels specified in the manualBurnChannelsMask param passed in.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetManualBurnChannels (int32_t cardIndex, int32_t module, uint32_t *p_outmanualBurnChannels)
 Retrieves which channels are currently performing a manual burn.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetAutoBurnMaxCount (int32_t cardIndex, int32_t module, int32_t channel, int32_t autoBurnMaxCount)
 Specifies the given channel's Auto Burn Max Count. Once Auto burn is initiated, it will burn up to the specified count.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetAutoBurnMaxCount (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outautoBurnMaxCount)
 Retrieves the the given channel's Auto Burn Max Count.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetAutoBurnCount (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outautoBurnCount)
 Retrieves the the given channel's Auto Burn Count. This is the actual Auto Burn Count.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_InitiateAutoBurnChannels (int32_t cardIndex, int32_t module, uint32_t autoBurnChannelsMask)
 Initiates auto burn on the channels specified in the autoBurnChannelsMask param passed in.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetAutoBurnChannels (int32_t cardIndex, int32_t module, uint32_t *p_outautoBurnChannels)
 Retrieves which channels are currently performing a auto burn.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanEnergySetting (int32_t cardIndex, int32_t module, int32_t channel, float32_t energySetting)
 Specifies the given channel's energy level in Joules. When a burn takes place this is the energy level at which the burn will be configured.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanEnergySetting (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outenergySetting)
 Retrieves the given channel's energy level in Joules.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanResistance (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outresistance)
 Retrieves the given channel's measured resistance (in ohms).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanFaultResistanceThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t faultResistanceThreshold)
 Specifies the given channel's fault resistance threshold. If measured resistance drops below this value, a burn is needed (either auto or manual) until the measured resistance raises above this minimum value set.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanFaultResistanceThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outfaultResistanceThreshold)
 Retrieves the given channel's fault resistance threshold.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanWarningResistanceThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t warningResistanceThreshold)
 Specifies the given channel's warning resistance threshold.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanWarningResistanceThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outwarningResistanceThreshold)
 Retrieves the given channel's warning resistance threshold.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanOpenResistanceThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t openResistanceThreshold)
 Specifies the given channel's open resistance threshold.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanOpenResistanceThreshold (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outopenResistanceThreshold)
 Retrieves the given channel's open resistance threshold.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables/disables status reporting for the specified CD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Retrieves the enabled/disabled state of status reporting for the specified CD channel.
 

Detailed Description

Function Documentation

◆ naibrd_CD_GetAutoBurnChannels()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetAutoBurnChannels ( int32_t cardIndex,
int32_t module,
uint32_t * p_outautoBurnChannels )

Retrieves which channels are currently performing a auto burn.

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]).
p_outautoBurnChannels: (Output) Bitwise value indicating which channels are performing a manual burn. Bits 1 - 6 (D0 - D5) correspond to channels 1 - 6 respectively. If a bit is set to "1", that channel is actively performing a manual burn. "0" indicates the channel is not currently performing a manual burn.
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetAutoBurnCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetAutoBurnCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outautoBurnCount )

Retrieves the the given channel's Auto Burn Count. This is the actual Auto Burn Count.

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_outautoBurnCount: (Output) The channel's Auto Burn Max Count (Valid values: 0 - 20)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetAutoBurnMaxCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetAutoBurnMaxCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outautoBurnMaxCount )

Retrieves the the given channel's Auto Burn Max Count.

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_outautoBurnMaxCount: (Output) The channel's Auto Burn Max Count (Valid values: 0 - 20)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetChanEnergySetting()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanEnergySetting ( int32_t cardIndex,
int32_t module,
int32_t channel,
float32_t * p_outenergySetting )

Retrieves the given channel's energy level in Joules.

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_outenergySetting: (Output) The channel's energy level in hundredths of Joules
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetChanFaultResistanceThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanFaultResistanceThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outfaultResistanceThreshold )

Retrieves the given channel's fault resistance threshold.

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_outfaultResistanceThreshold: (Output) Retrieves the channel's fault resistance threshold in ohms (Valid values: 0 - 100000)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetChanOpenResistanceThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanOpenResistanceThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outopenResistanceThreshold )

Retrieves the given channel's open resistance threshold.

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_outopenResistanceThreshold: (Output) Retrieves the channel's open resistance threshold in ohms (Valid values: 0 - 100000)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetChanResistance()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanResistance ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outresistance )

Retrieves the given channel's measured resistance (in ohms).

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_outresistance: (Output) The channel's measured resistance in ohms (Valid values 0 - 100000)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outenable )

Retrieves the enabled/disabled state of status reporting for the specified CD 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]).
p_outenable: (Output) 0 if channel status reporting is disabled or 1 if channel status reporting is enabled.
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_CD_GetChanWarningResistanceThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetChanWarningResistanceThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outwarningResistanceThreshold )

Retrieves the given channel's warning resistance threshold.

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_outwarningResistanceThreshold: (Output) Retrieves the channel's warning resistance threshold in ohms (Valid values: 0 - 100000)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetEnabledChannels()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetEnabledChannels ( int32_t cardIndex,
int32_t module,
uint32_t * p_outenabledChannels )

Retrieves the 32 bit value whereby the first 6 bits determine which of the 6 channels are enabled.

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]).
p_outenabledChannels: (Output) Bitwise value indicating which channels are enabled. Bits 1 - 6 (D0 - D5) correspond to channels 1 - 6 respectively. If a bit is set to "1", that channel is enabled. "0" indicates the channel is disabled.
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_GetManualBurnChannels()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_GetManualBurnChannels ( int32_t cardIndex,
int32_t module,
uint32_t * p_outmanualBurnChannels )

Retrieves which channels are currently performing a manual burn.

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]).
p_outmanualBurnChannels: (Output) Bitwise value indicating which channels are performing a manual burn. Bits 1 - 6 (D0 - D5) correspond to channels 1 - 6 respectively. If a bit is set to "1", that channel is actively performing a manual burn. "0" indicates the channel is not currently performing a manual burn.
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_InitiateAutoBurnChannels()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_InitiateAutoBurnChannels ( int32_t cardIndex,
int32_t module,
uint32_t autoBurnChannelsMask )

Initiates auto burn on the channels specified in the autoBurnChannelsMask param passed in.

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]).
autoBurnChannelsMask: (Input) Bitwise value indicating which channels to initiate a auto burn on. Bits 1 - 6 (D0 - D5) correspond to channels 1 - 6 respectively. If a bit is set to "1", that channel is configured for auto burn. "0" indicates the channel is not configured for auto burn.
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_InitiateManualBurnChannels()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_InitiateManualBurnChannels ( int32_t cardIndex,
int32_t module,
uint32_t manualBurnChannelsMask )

Initiates manual burn on the channels specified in the manualBurnChannelsMask param passed in.

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]).
manualBurnChannelsMask: (Input) Bitwise value indicating which channels to initiate a manual burn on. Bits 1 - 6 (D0 - D5) correspond to channels 1 - 6 respectively. If a bit is set to "1", that channel is configured for manual burn. "0" indicates the channel is not configured for manual burn.
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_SetAutoBurnMaxCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetAutoBurnMaxCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t autoBurnMaxCount )

Specifies the given channel's Auto Burn Max Count. Once Auto burn is initiated, it will burn up to the specified count.

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]).
autoBurnMaxCount: (Input) Sets the channel's Auto Burn Max Count (Valid values: 0 - 0)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_SetChanEnergySetting()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanEnergySetting ( int32_t cardIndex,
int32_t module,
int32_t channel,
float32_t energySetting )

Specifies the given channel's energy level in Joules. When a burn takes place this is the energy level at which the burn will be configured.

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]).
energySetting: (Input) Sets the channel's energy level in Joules (Valid values: 0.25 - 2.25)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_SetChanFaultResistanceThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanFaultResistanceThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t faultResistanceThreshold )

Specifies the given channel's fault resistance threshold. If measured resistance drops below this value, a burn is needed (either auto or manual) until the measured resistance raises above this minimum value set.

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]).
faultResistanceThreshold: (Input) Sets the channel's fault resistance threshold in ohms (Valid values: 0 - 100000)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_SetChanOpenResistanceThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanOpenResistanceThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t openResistanceThreshold )

Specifies the given channel's open resistance threshold.

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]).
openResistanceThreshold: (Input) Sets the channel's open resistance threshold in ohms (Valid values: 0 - 100000)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables/disables status reporting for the specified CD 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]).
enable: (Input) 0 to disable or 1 to enable status reporting for a channel.
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 enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_SetChanWarningResistanceThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetChanWarningResistanceThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t warningResistanceThreshold )

Specifies the given channel's warning resistance threshold.

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]).
warningResistanceThreshold: (Input) Sets the channel's warning resistance threshold in ohms (Valid values: 0 - 100000)
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_CD_SetEnabledChannels()

NAIBRDFUNC nai_status_t NAIAPI naibrd_CD_SetEnabledChannels ( int32_t cardIndex,
int32_t module,
uint32_t enableChannelsMask )

Enables the specified channels based upon the bits set in the enableChannelsMask param passed in.

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]).
enableChannelsMask: (Input) Bitwise value indicating which channels to enable. Bits 1 - 6 (D0 - D5) correspond to channels 1 - 6 respectively. If a bit is set to "1", that channel will be enabled. "0" indicates disabling of the channel.
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.