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

Enumerations

enum  rly_basicops_commands {
  RLY_BASICOP_CMD_HELP , RLY_BASICOP_CMD_OPEN , RLY_BASICOP_CMD_CLOSE , RLY_BASICOP_CMD_SETWORD ,
  RLY_BASICOP_CMD_INTERRUPT_ENABLE , RLY_BASICOP_CMD_TOGGLE , RLY_BASICOP_CMD_CLEAR , RLY_BASICOP_CMD_INTERRUPT_TRIG ,
  RLY_BASICOP_CMD_COUNT
}
 

Functions

static void Run_RLY_BasicOps (int32_t cardIndex, int32_t module, uint32_t modid)
 
static void Cfg_RLY_Channel (int32_t cardIndex, int32_t module, uint32_t ModuleID, int32_t MaxChannel)
 
static bool_t Display_RLY_Status (int32_t cardIndex, int32_t module, int32_t chan, uint32_t ModuleID)
 
static nai_status_t Configure_RLY_StateWord (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_RLY_Interrupt_Enable (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_RLY_Interrupt_Trigger (int32_t paramCount, int32_t *p_params)
 
static nai_status_t DisplayHelp (int32_t paramCount, int32_t *p_params)
 
int32_t RLY_BasicOps (void)
 The purpose of the rly_basic_ops is to illustrate the methods to call in the naibrd library to perform basic operations with the relay modules for configuration setup, controlling the drive outputs, and reading the channels.
 

Variables

static const int8_t * CONFIG_FILE = (const int8_t *)"default_RLY_BasicOp.txt"
 
bool_t bShowBIT = NAI_TRUE
 
static const int32_t DEF_RLY_CHANNEL = 1
 
naiapp_cmdtbl_params_t RLY_BasicOpMenuCmds []
 
naiapp_cmdtbl_params_t RLY_GEN5_MenuCmds []
 

Enumeration Type Documentation

◆ rly_basicops_commands

Enumerator
RLY_BASICOP_CMD_HELP 
RLY_BASICOP_CMD_OPEN 
RLY_BASICOP_CMD_CLOSE 
RLY_BASICOP_CMD_SETWORD 
RLY_BASICOP_CMD_INTERRUPT_ENABLE 
RLY_BASICOP_CMD_TOGGLE 
RLY_BASICOP_CMD_CLEAR 
RLY_BASICOP_CMD_INTERRUPT_TRIG 
RLY_BASICOP_CMD_COUNT 

Function Documentation

◆ Cfg_RLY_Channel()

static void Cfg_RLY_Channel ( int32_t cardIndex,
int32_t module,
uint32_t ModuleID,
int32_t MaxChannel )
static

◆ Configure_RLY_Interrupt_Enable()

static nai_status_t Configure_RLY_Interrupt_Enable ( int32_t paramCount,
int32_t * p_params )
static

◆ Configure_RLY_Interrupt_Trigger()

static nai_status_t Configure_RLY_Interrupt_Trigger ( int32_t paramCount,
int32_t * p_params )
static

◆ Configure_RLY_StateWord()

static nai_status_t Configure_RLY_StateWord ( int32_t paramCount,
int32_t * p_params )
static

◆ Display_RLY_Status()

static bool_t Display_RLY_Status ( int32_t cardIndex,
int32_t module,
int32_t chan,
uint32_t ModuleID )
static

◆ DisplayHelp()

static nai_status_t DisplayHelp ( int32_t paramCount,
int32_t * p_params )
static

◆ RLY_BasicOps()

int32_t RLY_BasicOps ( void )

The purpose of the rly_basic_ops is to illustrate the methods to call in the naibrd library to perform basic operations with the relay modules for configuration setup, controlling the drive outputs, and reading the channels.

◆ Run_RLY_BasicOps()

static void Run_RLY_BasicOps ( int32_t cardIndex,
int32_t module,
uint32_t modid )
static

Variable Documentation

◆ bShowBIT

bool_t bShowBIT = NAI_TRUE

◆ CONFIG_FILE

const int8_t* CONFIG_FILE = (const int8_t *)"default_RLY_BasicOp.txt"
static

◆ DEF_RLY_CHANNEL

const int32_t DEF_RLY_CHANNEL = 1
static

◆ RLY_BasicOpMenuCmds

naiapp_cmdtbl_params_t RLY_BasicOpMenuCmds[]
Initial value:
= {
{"Help", "RLY Notes", RLY_BASICOP_CMD_HELP, DisplayHelp},
{"Open", "RLY Open Relay", RLY_BASICOP_CMD_OPEN, NULL},
{"CLOse", "RLY Close Relay", RLY_BASICOP_CMD_CLOSE, NULL},
{"ENable", "RLY Select Interrupt Enable", RLY_BASICOP_CMD_INTERRUPT_ENABLE, Configure_RLY_Interrupt_Enable},
{"Status", "RLY Toggle Status Display", RLY_BASICOP_CMD_TOGGLE, NULL}
}
@ RLY_BASICOP_CMD_OPEN
Definition rly_basic_ops.c:40
@ RLY_BASICOP_CMD_CLOSE
Definition rly_basic_ops.c:41
@ RLY_BASICOP_CMD_HELP
Definition rly_basic_ops.c:39
@ RLY_BASICOP_CMD_INTERRUPT_ENABLE
Definition rly_basic_ops.c:43
@ RLY_BASICOP_CMD_SETWORD
Definition rly_basic_ops.c:42
@ RLY_BASICOP_CMD_TOGGLE
Definition rly_basic_ops.c:44
static nai_status_t DisplayHelp(int32_t paramCount, int32_t *p_params)
Definition rly_basic_ops.c:453
static nai_status_t Configure_RLY_Interrupt_Enable(int32_t paramCount, int32_t *p_params)
Definition rly_basic_ops.c:357
static nai_status_t Configure_RLY_StateWord(int32_t paramCount, int32_t *p_params)
Definition rly_basic_ops.c:319

◆ RLY_GEN5_MenuCmds

naiapp_cmdtbl_params_t RLY_GEN5_MenuCmds[]
Initial value:
= {
{"R", "RLY Reset BIT Status", RLY_BASICOP_CMD_CLEAR, NULL},
{"EDge", "RLY Select Interrupt Trig", RLY_BASICOP_CMD_INTERRUPT_TRIG, Configure_RLY_Interrupt_Trigger}
}
@ RLY_BASICOP_CMD_CLEAR
Definition rly_basic_ops.c:45
@ RLY_BASICOP_CMD_INTERRUPT_TRIG
Definition rly_basic_ops.c:46
static nai_status_t Configure_RLY_Interrupt_Trigger(int32_t paramCount, int32_t *p_params)
Definition rly_basic_ops.c:405