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

Enumerations

enum  fg_basicops_commands {
  FG_BASICOP_CMD_CHAN , FG_BASICOP_CMD_MODE , FG_BASICOP_CMD_FREQ , FG_BASICOP_CMD_AMPL ,
  FG_BASICOP_CMD_DCOFFSET , FG_BASICOP_CMD_PHASE , FG_BASICOP_CMD_PHLOCK , FG_BASICOP_CMD_STAT ,
  FG_BASICOP_CMD_POWER , FG_BASICOP_CMD_COUNT
}
 

Functions

static void Run_FG_BasicOps (int32_t cardIndex, int32_t module, uint32_t modid)
 
static void Cfg_FG_Channel (int32_t cardIndex, int32_t module, uint32_t ModuleID, int32_t MaxChannel)
 
static bool_t Display_FG_Status (int32_t cardIndex, int32_t module, int32_t chan, uint32_t ModuleID)
 
static nai_status_t Configure_FG_Freq (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_FG_SelectChan (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_FG_Amplitude (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_FG_DCOffset (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_FG_Phase (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_FG_Mode (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_FG_PhaseLock (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_FG_Status (int32_t paramCount, int32_t *p_params)
 
static nai_status_t Configure_FG_Power (int32_t paramCount, int32_t *p_params)
 
int32_t FG_BasicOps (void)
 The purpose of the fg_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_FG_BasicOp.txt"
 
static const int32_t DEF_FG_CHANNEL = 1
 
naiapp_cmdtbl_params_t FG_BasicOpMenuCmds []
 

Enumeration Type Documentation

◆ fg_basicops_commands

Enumerator
FG_BASICOP_CMD_CHAN 
FG_BASICOP_CMD_MODE 
FG_BASICOP_CMD_FREQ 
FG_BASICOP_CMD_AMPL 
FG_BASICOP_CMD_DCOFFSET 
FG_BASICOP_CMD_PHASE 
FG_BASICOP_CMD_PHLOCK 
FG_BASICOP_CMD_STAT 
FG_BASICOP_CMD_POWER 
FG_BASICOP_CMD_COUNT 

Function Documentation

◆ Cfg_FG_Channel()

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

◆ Configure_FG_Amplitude()

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

◆ Configure_FG_DCOffset()

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

◆ Configure_FG_Freq()

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

◆ Configure_FG_Mode()

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

◆ Configure_FG_Phase()

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

◆ Configure_FG_PhaseLock()

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

◆ Configure_FG_Power()

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

◆ Configure_FG_SelectChan()

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

◆ Configure_FG_Status()

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

◆ Display_FG_Status()

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

◆ FG_BasicOps()

int32_t FG_BasicOps ( void )

The purpose of the fg_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_FG_BasicOps()

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

Variable Documentation

◆ CONFIG_FILE

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

◆ DEF_FG_CHANNEL

const int32_t DEF_FG_CHANNEL = 1
static

◆ FG_BasicOpMenuCmds

naiapp_cmdtbl_params_t FG_BasicOpMenuCmds[]
Initial value:
= {
{"S", "FG Switch Selected Channel", FG_BASICOP_CMD_CHAN, Configure_FG_SelectChan},
{"Mode", "FG Set Mode", FG_BASICOP_CMD_MODE, Configure_FG_Mode},
{"Freq", "FG Set Frequency", FG_BASICOP_CMD_FREQ, Configure_FG_Freq},
{"Amp", "FG Set Amplitude", FG_BASICOP_CMD_AMPL, Configure_FG_Amplitude},
{"DC", "FG Set DC Offset", FG_BASICOP_CMD_DCOFFSET, Configure_FG_DCOffset},
{"Phase", "FG Set Phase", FG_BASICOP_CMD_PHASE, Configure_FG_Phase},
{"Lock", "FG Set Phase Lock", FG_BASICOP_CMD_PHLOCK, Configure_FG_PhaseLock},
{"Stat", "FG Display Status", FG_BASICOP_CMD_STAT, Configure_FG_Status},
{"Pow", "FG Power Enable", FG_BASICOP_CMD_POWER, Configure_FG_Power},
}
static nai_status_t Configure_FG_PhaseLock(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:499
static nai_status_t Configure_FG_Freq(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:335
@ FG_BASICOP_CMD_PHLOCK
Definition fg_basic_ops.c:48
@ FG_BASICOP_CMD_POWER
Definition fg_basic_ops.c:50
@ FG_BASICOP_CMD_DCOFFSET
Definition fg_basic_ops.c:46
@ FG_BASICOP_CMD_AMPL
Definition fg_basic_ops.c:45
@ FG_BASICOP_CMD_FREQ
Definition fg_basic_ops.c:44
@ FG_BASICOP_CMD_PHASE
Definition fg_basic_ops.c:47
@ FG_BASICOP_CMD_CHAN
Definition fg_basic_ops.c:42
@ FG_BASICOP_CMD_STAT
Definition fg_basic_ops.c:49
@ FG_BASICOP_CMD_MODE
Definition fg_basic_ops.c:43
static nai_status_t Configure_FG_Mode(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:447
static nai_status_t Configure_FG_Status(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:548
static nai_status_t Configure_FG_Amplitude(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:363
static nai_status_t Configure_FG_Phase(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:419
static nai_status_t Configure_FG_SelectChan(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:324
static nai_status_t Configure_FG_DCOffset(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:391
static nai_status_t Configure_FG_Power(int32_t paramCount, int32_t *p_params)
Definition fg_basic_ops.c:579