Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Watchdog Functions
PWM Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetSerialWatchdogTimeout (int32_t cardIndex, int32_t module, float32_t timeout_ms)
 Sets the Watchdog Timer for Serial communication. This API provides the capability to define the watchdog timeout interval for a SLDC activity monitor. If a valid data frame is not received within the defined interval, the PWM card shall disable both the output channels (regardless of battlefield override state). The Watchdog Timer Value is between 0 and 250 msec.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetSerialWatchdogTimeout (int32_t cardIndex, int32_t module, float32_t *p_outtimeout_ms)
 Retrieves the Watchdog Timer for Serial communication. This API provides the capability to define the watchdog timeout interval for a SLDC activity monitor. If a valid data frame is not received within the defined interval, the PWM card shall disable both the output channels (regardless of battlefield override state). The Watchdog Timer Value is between 0 and 250 msec.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetSerialWatchdogEnable (int32_t cardIndex, int32_t module, bool_t enable)
 Enables or disables the Watchdog for Serial communication.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetSerialWatchdogEnable (int32_t cardIndex, int32_t module, bool_t *p_outenable)
 Retrieves the Watchdog Enable State for Serial communication.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetWatchdogTimeout (int32_t cardIndex, int32_t module, float32_t timeout_ms)
 Sets the Watchdog Timer for VME/PCIe and Ethernet communication. The Watchdog Timer Value is between 0 and 250 msec.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetWatchdogTimeout (int32_t cardIndex, int32_t module, float32_t *p_outtimeout_ms)
 Retrieves the Watchdog Timer for VME/PCIe and Ethernet communication. The Watchdog Timer Value is between 0 and 256 msec.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetWatchdogEnable (int32_t cardIndex, int32_t module, bool_t enable)
 Enables or disables the Watchdog for VME/PCIe and Ethernet communication.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetWatchdogEnable (int32_t cardIndex, int32_t module, bool_t *p_outenable)
 Retrieves the Watchdog Enable State for VME/PCIe and Ethernet communication.
 

Detailed Description


Function Documentation

◆ naibrd_PWM_GetSerialWatchdogEnable()

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

Retrieves the Watchdog Enable State for Serial communication.

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_outenable: (Output) Enables (1) or Disables (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_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetSerialWatchdogTimeout()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetSerialWatchdogTimeout ( int32_t cardIndex,
int32_t module,
float32_t * p_outtimeout_ms )

Retrieves the Watchdog Timer for Serial communication. This API provides the capability to define the watchdog timeout interval for a SLDC activity monitor. If a valid data frame is not received within the defined interval, the PWM card shall disable both the output channels (regardless of battlefield override state). The Watchdog Timer Value is between 0 and 250 msec.

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_outtimeout_ms: (Output) Timeout in milliseconds.
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_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetWatchdogEnable()

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

Retrieves the Watchdog Enable State for VME/PCIe and Ethernet communication.

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_outenable: (Output) Enables (1) or Disables (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_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_GetWatchdogTimeout()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_GetWatchdogTimeout ( int32_t cardIndex,
int32_t module,
float32_t * p_outtimeout_ms )

Retrieves the Watchdog Timer for VME/PCIe and Ethernet communication. The Watchdog Timer Value is between 0 and 256 msec.

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_outtimeout_ms: (Output) Timeout in milliseconds.
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_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetSerialWatchdogEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetSerialWatchdogEnable ( int32_t cardIndex,
int32_t module,
bool_t enable )

Enables or disables the Watchdog for Serial communication.

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]).
enable: (Input) Enables (1) or Disables (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_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetSerialWatchdogTimeout()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetSerialWatchdogTimeout ( int32_t cardIndex,
int32_t module,
float32_t timeout_ms )

Sets the Watchdog Timer for Serial communication. This API provides the capability to define the watchdog timeout interval for a SLDC activity monitor. If a valid data frame is not received within the defined interval, the PWM card shall disable both the output channels (regardless of battlefield override state). The Watchdog Timer Value is between 0 and 250 msec.

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]).
timeout_ms: (Input) Timeout in milliseconds.
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_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetWatchdogEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetWatchdogEnable ( int32_t cardIndex,
int32_t module,
bool_t enable )

Enables or disables the Watchdog for VME/PCIe and Ethernet communication.

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]).
enable: (Input) Enables (1) or Disables (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_SUPPORTED when function is not supported.

◆ naibrd_PWM_SetWatchdogTimeout()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PWM_SetWatchdogTimeout ( int32_t cardIndex,
int32_t module,
float32_t timeout_ms )

Sets the Watchdog Timer for VME/PCIe and Ethernet communication. The Watchdog Timer Value is between 0 and 250 msec.

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]).
timeout_ms: (Input) Timeout in milliseconds.
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_INVALID_VALUE when invalid value parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.