sg_basic_ops.c File Reference

Enumerations
enum	sg_basicOps_commands { SG_BASICOP_CMD_CONFIG , SG_BASICOP_CMD_STANDARDOPS , SG_BASICOP_CMD_COUNT }
enum	sg_config_commands {   SG_GEN5_CONFIG_CMD_READ , SG_GEN5_CONFIG_CMD_EXCITATION , SG_GEN5_CONFIG_CMD_BRIDGE_CONFIG , SG_GEN5_CONFIG_CMD_PGA_GAIN ,   SG_GEN5_CONFIG_CMD_REMOTE_SENSE , SG_GEN5_CONFIG_CMD_NOMINAL_RES , SG_GEN5_CONFIG_CMD_GAUGE_FACTOR , SG_GEN5_CONFIG_CMD_POISSON_RATIO ,   SG_GEN5_CONFIG_CMD_LEAD_RES , SG_GEN5_CONFIG_CMD_SAMPLE_RATE , SG_GEN5_CONFIG_CMD_STRAIN_ALARM_LO , SG_GEN5_CONFIG_CMD_STRAIN_ALERT_LO ,   SG_GEN5_CONFIG_CMD_STRAIN_ALERT_HI , SG_GEN5_CONFIG_CMD_STRAIN_ALARM_HI , SG_GEN5_CONFIG_CMD_IMBALANCE_OFFSET , SG_GEN5_CONFIG_CMD_INTERNAL_BRIDGE_COMPLETION ,   SG_GEN5_CONFIG_CMD_TOGGLE_HEX_MODE , SG_GEN5_CONFIG_CMD_COUNT }
enum	sg_gen5_standard_operations_commands {   SG_GEN5_STANDARD_OPERATIONS_CMD_READ_DATA , SG_GEN5_STANDARD_OPERATIONS_CMD_CHAN_STATUS_ENABLE , SG_GEN5_STANDARD_OPERATIONS_CMD_RESET_MIN_MAX_STRAIN , SG_GEN5_STANDARD_OPERATIONS_CMD_CLEAR_STATUS ,   SG_GEN5_STANDARD_OPERATIONS_CMD_TOGGLE_HEX_MODE , SG_GEN5_STANDARD_OPERATIONS_CMD_COUNT }

Functions
static bool_t	SGBasicOps_run (int32_t cardIndex, int32_t module, uint32_t modId)
	SGBasicOps_run illustrates the channel configuration and prepares the menu which will handle user command requests. Returns NAI_TRUE if the user enters the Quit Command at any point within its scope.
static nai_status_t	SGBasicOps_handleConfiguration (int32_t paramCount, int32_t *p_params)
	SGBasicOps_handleConfiguration is called if the user chooses to configure the SG module or to read the configuration data.
static nai_status_t	SGBasicOps_handleStandardOperation (int32_t paramCount, int32_t *p_params)
	SGBasicOps_handleStandardOperation is called if the user chooses to perform SG standard operations checks to retrieve the SG standard operations data.
static nai_status_t	SGBasicOps_toggleNumDisplay (int32_t paramCount, int32_t *p_params)
	SGBasicOps_toggleNumDisplay toggles the display raw hex mode.
static nai_status_t	SGBasicOps_toggleHexModeOps (int32_t paramCount, int32_t *p_params)
	SGBasicOps_toggleHexModeOps toggles the display raw hex mode and then displays all of the standard operations data.
static nai_status_t	SGBasicOps_toggleHexModeConfig (int32_t paramCount, int32_t *p_params)
	SGBasicOps_toggleHexModeConfig toggles the display raw hex mode and then displays all of the configuration data.
static nai_status_t	SGBasicOps_displayChannelCfg (int32_t paramCount, int32_t *p_params)
	SGBasicOps_displayChannelCfg displays the configuration data for the SG module (excitation voltage, bridge configuration, PGA gain, remote/local sense mode, nominal resistance, gauge factor, poisson ratio, lead resistance, sample rate, strain alarm low threshold, strain alert low threshold, strain alert high threshold, strain alarm high threshold, imbalance offset, and internal bridge completion enable value).
static nai_status_t	SGBasicOps_setExcitation (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setExcitation sets the excitation voltage to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setRemoteDriveSense (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setRemoteDriveSense sets the remote drive sense to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setBridgeConfig (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setBridgeConfig sets the bridge configuration to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setNominalRes (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setNominalRes sets the nominal resistance to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setGaugeFactor (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setGaugeFactor sets the gauge factor to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setPoissonRatio (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setPoissonRatio sets the poisson ratio to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setLeadRes (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setLeadRes sets the lead resistance to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setSampleRate (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setSampleRate sets the sample rate to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setStrainAlarmLo (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setStrainAlarmLo sets the strain alarm low threshold to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setStrainAlertLo (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setStrainAlertLo sets the strain alert low threshold to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setStrainAlertHi (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setStrainAlertHi sets the strain alert high threshold to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setStrainAlarmHi (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setStrainAlarmHi sets the strain alarm high threshold to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setImbalanceOffset (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setImbalanceOffset sets the imbalance offset value to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setBridgeComp (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setBridgeComp sets the internal bridge completion enabled/disabled setting to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_setPGAGain (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setPGAGain sets the PGA Gain setting to the value specified by the user and then displays all of the configuration data.
static nai_status_t	SGBasicOps_displayStandardOpsData (int32_t paramCount, int32_t *p_params)
	SGBasicOps_displayStandardOpsData calls SGUtils_DisplayStandardOpsData to display the SG Standard Operations Table for Gen 5 SG modules.
static nai_status_t	SGBasicOps_setChanStatusEnable (int32_t paramCount, int32_t *p_params)
	SGBasicOps_setChanStatusEnable sets the channel status reporting enabled/disabled setting to the value specified by the user and then displays all of the standard operations data.
static nai_status_t	SGBasicOps_resetMinMaxStrain (int32_t paramCount, int32_t *p_params)
	SGBasicOps_resetMinMaxStrain resets the min and max strain values stored in the module (if the user chooses to) and then displays all of the standard operations data.
static nai_status_t	SGBasicOps_clearStatus (int32_t paramCount, int32_t *p_params)
	SGBasicOps_clearStatus clears the status corresponding to the status type specified by the user (if the user chooses to) and then displays all of the standard operations data.
int32_t	SG_BasicOps (void)
	The purpose of the SG_BasicOps is to illustrate the methods to call in the naibrd library to perform basic operations with the SG modules for configuration setup and reading the channels.

Variables
static const int8_t *	SAMPLE_PGM_NAME = (const int8_t *)"SG Module Basic Operation Program"
static const int8_t *	CONFIG_FILE = (const int8_t *)"default_SG_BasicOps.txt"
static const int32_t	DEF_SG_CARD_INDEX = 0
static const int32_t	DEF_SG_MODULE = 1
static const int32_t	DEF_SG_CHANNEL = 1
naiapp_cmdtbl_params_t	SG_BasicOpMenuCmds []
naiapp_cmdtbl_params_t	SG_ConfigMenuCmds []
naiapp_cmdtbl_params_t	SG_StandardOperationMenuCmds []

Enumeration Type Documentation

sg_basicOps_commands

enum sg_basicOps_commands

Enumerator
SG_BASICOP_CMD_CONFIG
SG_BASICOP_CMD_STANDARDOPS
SG_BASICOP_CMD_COUNT

sg_config_commands

enum sg_config_commands

Enumerator
SG_GEN5_CONFIG_CMD_READ
SG_GEN5_CONFIG_CMD_EXCITATION
SG_GEN5_CONFIG_CMD_BRIDGE_CONFIG
SG_GEN5_CONFIG_CMD_PGA_GAIN
SG_GEN5_CONFIG_CMD_REMOTE_SENSE
SG_GEN5_CONFIG_CMD_NOMINAL_RES
SG_GEN5_CONFIG_CMD_GAUGE_FACTOR
SG_GEN5_CONFIG_CMD_POISSON_RATIO
SG_GEN5_CONFIG_CMD_LEAD_RES
SG_GEN5_CONFIG_CMD_SAMPLE_RATE
SG_GEN5_CONFIG_CMD_STRAIN_ALARM_LO
SG_GEN5_CONFIG_CMD_STRAIN_ALERT_LO
SG_GEN5_CONFIG_CMD_STRAIN_ALERT_HI
SG_GEN5_CONFIG_CMD_STRAIN_ALARM_HI
SG_GEN5_CONFIG_CMD_IMBALANCE_OFFSET
SG_GEN5_CONFIG_CMD_INTERNAL_BRIDGE_COMPLETION
SG_GEN5_CONFIG_CMD_TOGGLE_HEX_MODE
SG_GEN5_CONFIG_CMD_COUNT

sg_gen5_standard_operations_commands

enum sg_gen5_standard_operations_commands

Enumerator
SG_GEN5_STANDARD_OPERATIONS_CMD_READ_DATA
SG_GEN5_STANDARD_OPERATIONS_CMD_CHAN_STATUS_ENABLE
SG_GEN5_STANDARD_OPERATIONS_CMD_RESET_MIN_MAX_STRAIN
SG_GEN5_STANDARD_OPERATIONS_CMD_CLEAR_STATUS
SG_GEN5_STANDARD_OPERATIONS_CMD_TOGGLE_HEX_MODE
SG_GEN5_STANDARD_OPERATIONS_CMD_COUNT

Function Documentation

SG_BasicOps()

int32_t SG_BasicOps

(

void

)

The purpose of the SG_BasicOps is to illustrate the methods to call in the naibrd library to perform basic operations with the SG modules for configuration setup and reading the channels.

SGBasicOps_clearStatus()

static nai_status_t SGBasicOps_clearStatus ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_clearStatus clears the status corresponding to the status type specified by the user (if the user chooses to) and then displays all of the standard operations data.

SGBasicOps_displayChannelCfg()

static nai_status_t SGBasicOps_displayChannelCfg ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_displayChannelCfg displays the configuration data for the SG module (excitation voltage, bridge configuration, PGA gain, remote/local sense mode, nominal resistance, gauge factor, poisson ratio, lead resistance, sample rate, strain alarm low threshold, strain alert low threshold, strain alert high threshold, strain alarm high threshold, imbalance offset, and internal bridge completion enable value).

SGBasicOps_displayStandardOpsData()

static nai_status_t SGBasicOps_displayStandardOpsData ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_displayStandardOpsData calls SGUtils_DisplayStandardOpsData to display the SG Standard Operations Table for Gen 5 SG modules.

SGBasicOps_handleConfiguration()

static nai_status_t SGBasicOps_handleConfiguration ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_handleConfiguration is called if the user chooses to configure the SG module or to read the configuration data.

SGBasicOps_handleStandardOperation()

static nai_status_t SGBasicOps_handleStandardOperation ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_handleStandardOperation is called if the user chooses to perform SG standard operations checks to retrieve the SG standard operations data.

SGBasicOps_resetMinMaxStrain()

static nai_status_t SGBasicOps_resetMinMaxStrain ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_resetMinMaxStrain resets the min and max strain values stored in the module (if the user chooses to) and then displays all of the standard operations data.

SGBasicOps_run()

static bool_t SGBasicOps_run ( int32_t cardIndex, int32_t module, uint32_t modId )

static

SGBasicOps_run illustrates the channel configuration and prepares the menu which will handle user command requests. Returns NAI_TRUE if the user enters the Quit Command at any point within its scope.

SGBasicOps_setBridgeComp()

static nai_status_t SGBasicOps_setBridgeComp ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setBridgeComp sets the internal bridge completion enabled/disabled setting to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setBridgeConfig()

static nai_status_t SGBasicOps_setBridgeConfig ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setBridgeConfig sets the bridge configuration to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setChanStatusEnable()

static nai_status_t SGBasicOps_setChanStatusEnable ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setChanStatusEnable sets the channel status reporting enabled/disabled setting to the value specified by the user and then displays all of the standard operations data.

SGBasicOps_setExcitation()

static nai_status_t SGBasicOps_setExcitation ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setExcitation sets the excitation voltage to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setGaugeFactor()

static nai_status_t SGBasicOps_setGaugeFactor ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setGaugeFactor sets the gauge factor to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setImbalanceOffset()

static nai_status_t SGBasicOps_setImbalanceOffset ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setImbalanceOffset sets the imbalance offset value to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setLeadRes()

static nai_status_t SGBasicOps_setLeadRes ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setLeadRes sets the lead resistance to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setNominalRes()

static nai_status_t SGBasicOps_setNominalRes ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setNominalRes sets the nominal resistance to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setPGAGain()

static nai_status_t SGBasicOps_setPGAGain ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setPGAGain sets the PGA Gain setting to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setPoissonRatio()

static nai_status_t SGBasicOps_setPoissonRatio ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setPoissonRatio sets the poisson ratio to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setRemoteDriveSense()

static nai_status_t SGBasicOps_setRemoteDriveSense ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setRemoteDriveSense sets the remote drive sense to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setSampleRate()

static nai_status_t SGBasicOps_setSampleRate ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setSampleRate sets the sample rate to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setStrainAlarmHi()

static nai_status_t SGBasicOps_setStrainAlarmHi ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setStrainAlarmHi sets the strain alarm high threshold to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setStrainAlarmLo()

static nai_status_t SGBasicOps_setStrainAlarmLo ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setStrainAlarmLo sets the strain alarm low threshold to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setStrainAlertHi()

static nai_status_t SGBasicOps_setStrainAlertHi ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setStrainAlertHi sets the strain alert high threshold to the value specified by the user and then displays all of the configuration data.

SGBasicOps_setStrainAlertLo()

static nai_status_t SGBasicOps_setStrainAlertLo ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_setStrainAlertLo sets the strain alert low threshold to the value specified by the user and then displays all of the configuration data.

SGBasicOps_toggleHexModeConfig()

static nai_status_t SGBasicOps_toggleHexModeConfig ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_toggleHexModeConfig toggles the display raw hex mode and then displays all of the configuration data.

SGBasicOps_toggleHexModeOps()

static nai_status_t SGBasicOps_toggleHexModeOps ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_toggleHexModeOps toggles the display raw hex mode and then displays all of the standard operations data.

SGBasicOps_toggleNumDisplay()

static nai_status_t SGBasicOps_toggleNumDisplay ( int32_t paramCount, int32_t * p_params )

static

SGBasicOps_toggleNumDisplay toggles the display raw hex mode.

Variable Documentation

CONFIG_FILE

const int8_t* CONFIG_FILE = (const int8_t *)"default_SG_BasicOps.txt"

static

DEF_SG_CARD_INDEX

const int32_t DEF_SG_CARD_INDEX = 0

static

DEF_SG_CHANNEL

const int32_t DEF_SG_CHANNEL = 1

static

DEF_SG_MODULE

const int32_t DEF_SG_MODULE = 1

static

SAMPLE_PGM_NAME

const int8_t* SAMPLE_PGM_NAME = (const int8_t *)"SG Module Basic Operation Program"

static

SG_BasicOpMenuCmds

naiapp_cmdtbl_params_t SG_BasicOpMenuCmds[]

Initial value:

=
{
   {"CFG", "SG Configuration Functions",                  SG_BASICOP_CMD_CONFIG,              SGBasicOps_handleConfiguration},
   {"OPS", "SG Standard Operation Functions",             SG_BASICOP_CMD_STANDARDOPS,         SGBasicOps_handleStandardOperation},
}

SG_ConfigMenuCmds

naiapp_cmdtbl_params_t SG_ConfigMenuCmds[]

Initial value:

= {
   {"READ       ", "Retrieve Configuration",                    SG_GEN5_CONFIG_CMD_READ,                       SGBasicOps_displayChannelCfg},
   {"EXCITATION ", "Set Excitation Voltage",                    SG_GEN5_CONFIG_CMD_EXCITATION,                 SGBasicOps_setExcitation},
   {"DCONFIG    ", "Set Bridge Configuration",                  SG_GEN5_CONFIG_CMD_BRIDGE_CONFIG,              SGBasicOps_setBridgeConfig},
   {"GAIN       ", "Set PGA Gain",                              SG_GEN5_CONFIG_CMD_PGA_GAIN,                   SGBasicOps_setPGAGain},
   {"SENSE      ", "Set Remote Sense Mode",                     SG_GEN5_CONFIG_CMD_REMOTE_SENSE,               SGBasicOps_setRemoteDriveSense},
   {"NOMINAL RES", "Set Nominal Resistance",                    SG_GEN5_CONFIG_CMD_NOMINAL_RES,                SGBasicOps_setNominalRes},
   {"FACTOR     ", "Set Gauge Factor",                          SG_GEN5_CONFIG_CMD_GAUGE_FACTOR,               SGBasicOps_setGaugeFactor},
   {"POISSON    ", "Set Poisson Ratio",                         SG_GEN5_CONFIG_CMD_POISSON_RATIO,              SGBasicOps_setPoissonRatio},
   {"LEAD RES   ", "Set Lead Resistance",                       SG_GEN5_CONFIG_CMD_LEAD_RES,                   SGBasicOps_setLeadRes},
   {"RATE       ", "Set Sample Rate",                           SG_GEN5_CONFIG_CMD_SAMPLE_RATE,                SGBasicOps_setSampleRate},
   {"MIN THRESH ", "Set Strain Alarm Lo Threshold",             SG_GEN5_CONFIG_CMD_STRAIN_ALARM_LO,            SGBasicOps_setStrainAlarmLo},
   {"LOW THRESH ", "Set Strain Alert Lo Threshold",             SG_GEN5_CONFIG_CMD_STRAIN_ALERT_LO,            SGBasicOps_setStrainAlertLo},
   {"HIGH THRESH", "Set Strain Alert Hi Threshold",             SG_GEN5_CONFIG_CMD_STRAIN_ALERT_HI,            SGBasicOps_setStrainAlertHi},
   {"MAX THRESH ", "Set Strain Alarm Hi Threshold",             SG_GEN5_CONFIG_CMD_STRAIN_ALARM_HI,            SGBasicOps_setStrainAlarmHi},
   {"IMBALANCE  ", "Set Imbalance Offset",                      SG_GEN5_CONFIG_CMD_IMBALANCE_OFFSET,           SGBasicOps_setImbalanceOffset},
   {"COMPLETION ", "Enable/Disable Internal Bridge Completion", SG_GEN5_CONFIG_CMD_INTERNAL_BRIDGE_COMPLETION, SGBasicOps_setBridgeComp},
   {"TOGGLE HEX ", "Enable/Disable Raw Hex Mode",               SG_GEN5_CONFIG_CMD_TOGGLE_HEX_MODE,            SGBasicOps_toggleHexModeConfig}
}

SG_StandardOperationMenuCmds

naiapp_cmdtbl_params_t SG_StandardOperationMenuCmds[]

Initial value:

= {
   {"GET   ", "Retrieve Data",                           SG_GEN5_STANDARD_OPERATIONS_CMD_READ_DATA,            SGBasicOps_displayStandardOpsData},
   {"ENABLE", "Enable/Disable Channel Status Reporting", SG_GEN5_STANDARD_OPERATIONS_CMD_CHAN_STATUS_ENABLE,   SGBasicOps_setChanStatusEnable},
   {"RESET ", "Reset Min and Max Strain",                SG_GEN5_STANDARD_OPERATIONS_CMD_RESET_MIN_MAX_STRAIN, SGBasicOps_resetMinMaxStrain},
   {"CLEAR ", "Clear Statuses",                          SG_GEN5_STANDARD_OPERATIONS_CMD_CLEAR_STATUS,         SGBasicOps_clearStatus},
   {"HEX   ", "Enable/Disable Raw Hex Mode",             SG_GEN5_STANDARD_OPERATIONS_CMD_TOGGLE_HEX_MODE,      SGBasicOps_toggleHexModeOps}
}