Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
tc_summary.c File Reference

Enumerations

enum  tc_basic_interrupt_commands { TC_SUMMARY_INTERRUPT_CMD_CONFIGURE , TC_SUMMARY_INTERRUPT_CMD_STATUS_READ , TC_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR , TC_SUMMARY_INTERRUPT_CMD_COUNT }
 

Functions

static int32_t Run_TC_Summary (int32_t cardIndex, int32_t module, uint32_t modid)
 Run_TC_Summary prompts the user for the card, module and channel to use for the application and calls Cfg_TC_Channel if the card, module, and channel specified are all valid for the TC module.
 
static void Cfg_TC_Channel (int32_t cardIndex, int32_t module, int32_t MaxChannel)
 Cfg_TC_Channel handles calling the Display_TC_ChannelCfg routine to display the thermocouple channel configuration and calling the routines associated with the user's menu commands.
 
static void Verify_TC_ParamCnt (int32_t paramCnt)
 Verify_TC_ParamCnt verifies parameter count and displays error message if invalid.
 
static nai_status_t Display_TC_Status (int32_t paramCnt, int32_t *p_params)
 Display_TC_Status illustrates the methods to call in the naibrd library to retrieve the status states.
 
static nai_status_t Clear_TC_Status (int32_t paramCnt, int32_t *p_params)
 
static nai_status_t Configure_TC_Interrupt (int32_t paramCnt, int32_t *p_params)
 
static void SampleCallBack (uint32_t vector)
 
int32_t tc_summary (void)
 The purpose of the tc_summary example is to illustrate the methods to call in the naibrd library to perform basic operations with thermocouple modules for interrupt configuration, reading fault statuses including the summary status register, and clearing status bits. The summary register is bit-mapped by channel (bit index zero is channel 1) and reports a '1' if the corresponding channel has detected a fault (including BIT). A latched summary bit can be cleared by writing a '1' to the bit.
 

Variables

static const int8_t * DEF_CONFIG_FILE = (const int8_t *)"default_TC_Summary.txt"
 
static const int32_t DEF_TC_CARD_INDEX = 0
 
static const int32_t DEF_TC_MODULE = 1
 
static const int32_t DEF_TC_CHANNEL = 1
 
static naiapp_cmdtbl_params_t TC_SummaryMenuCmds []
 

Enumeration Type Documentation

◆ tc_basic_interrupt_commands

Enumerator
TC_SUMMARY_INTERRUPT_CMD_CONFIGURE 
TC_SUMMARY_INTERRUPT_CMD_STATUS_READ 
TC_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR 
TC_SUMMARY_INTERRUPT_CMD_COUNT 

Function Documentation

◆ Cfg_TC_Channel()

static void Cfg_TC_Channel ( int32_t cardIndex,
int32_t module,
int32_t MaxChannel )
static

Cfg_TC_Channel handles calling the Display_TC_ChannelCfg routine to display the thermocouple channel configuration and calling the routines associated with the user's menu commands.

◆ Clear_TC_Status()

static nai_status_t Clear_TC_Status ( int32_t paramCnt,
int32_t * p_params )
static

◆ Configure_TC_Interrupt()

static nai_status_t Configure_TC_Interrupt ( int32_t paramCnt,
int32_t * p_params )
static

◆ Display_TC_Status()

static nai_status_t Display_TC_Status ( int32_t paramCnt,
int32_t * p_params )
static

Display_TC_Status illustrates the methods to call in the naibrd library to retrieve the status states.

◆ Run_TC_Summary()

static int32_t Run_TC_Summary ( int32_t cardIndex,
int32_t module,
uint32_t modid )
static

Run_TC_Summary prompts the user for the card, module and channel to use for the application and calls Cfg_TC_Channel if the card, module, and channel specified are all valid for the TC module.

◆ SampleCallBack()

static void SampleCallBack ( uint32_t vector)
static

◆ tc_summary()

int32_t tc_summary ( void )

The purpose of the tc_summary example is to illustrate the methods to call in the naibrd library to perform basic operations with thermocouple modules for interrupt configuration, reading fault statuses including the summary status register, and clearing status bits. The summary register is bit-mapped by channel (bit index zero is channel 1) and reports a '1' if the corresponding channel has detected a fault (including BIT). A latched summary bit can be cleared by writing a '1' to the bit.

◆ Verify_TC_ParamCnt()

static void Verify_TC_ParamCnt ( int32_t paramCnt)
static

Verify_TC_ParamCnt verifies parameter count and displays error message if invalid.

Variable Documentation

◆ DEF_CONFIG_FILE

const int8_t* DEF_CONFIG_FILE = (const int8_t *)"default_TC_Summary.txt"
static

◆ DEF_TC_CARD_INDEX

const int32_t DEF_TC_CARD_INDEX = 0
static

◆ DEF_TC_CHANNEL

const int32_t DEF_TC_CHANNEL = 1
static

◆ DEF_TC_MODULE

const int32_t DEF_TC_MODULE = 1
static

◆ TC_SummaryMenuCmds

naiapp_cmdtbl_params_t TC_SummaryMenuCmds[]
static
Initial value:
= {
{"INT", "TC Configure Interrupt", TC_SUMMARY_INTERRUPT_CMD_CONFIGURE, Configure_TC_Interrupt},
}
@ TC_SUMMARY_INTERRUPT_CMD_STATUS_CLEAR
Definition tc_summary.c:44
@ TC_SUMMARY_INTERRUPT_CMD_STATUS_READ
Definition tc_summary.c:43
@ TC_SUMMARY_INTERRUPT_CMD_CONFIGURE
Definition tc_summary.c:42
static nai_status_t Clear_TC_Status(int32_t paramCnt, int32_t *p_params)
Definition tc_summary.c:275
static nai_status_t Display_TC_Status(int32_t paramCnt, int32_t *p_params)
Display_TC_Status illustrates the methods to call in the naibrd library to retrieve the status states...
Definition tc_summary.c:233
static nai_status_t Configure_TC_Interrupt(int32_t paramCnt, int32_t *p_params)
Definition tc_summary.c:297