ad_basic_ops.c File Reference

Enumerations
enum	ad_basicOps_commands {   AD_BASICOPS_CMD_SET_POL_RNG , AD_BASICOPS_CMD_SET_BREAK_FREQ , AD_BASICOPS_CMD_SET_LATCH , AD_BASICOPS_CMD_SET_MODE ,   AD_BASICOPS_CMD_SET_CHANNEL_ACTIVE , AD_BASICOPS_CMD_SATURATION_MENU , AD_BASICOPS_CMD_SET_D0_TEST_ENABLE , AD_BASICOPS_CMD_FLOATING_POINT_MODE ,   AD_BASICOPS_CMD_FLOATING_POINT_OFFSET , AD_BASICOPS_CMD_FLOATING_POINT_SCALE_FACTOR , AD_BASICOPS_CMD_CHANNEL_STATUS_ENABLE , AD_BASICOPS_CMD_PBIT ,   AD_BASICOPS_CMD_BIT_THRESHOLD , AD_BASICOPS_CMD_MODULE_POWER_RESET_MENU , AD_BASICOPS_CMD_TOGGLE_NUMERIC_DISPLAY , AD_BASICOPS_CMD_COUNT }
enum	ad_basicOps_Saturation_commands {   AD_BASICOPS_SATURATION_CMD_SET_LOW , AD_BASICOPS_SATURATION_CMD_SET_HIGH , AD_BASICOPS_SATURATION_CMD_ENABLE_LOW , AD_BASICOPS_SATURATION_CMD_ENABLE_HIGH ,   AD_BASICOPS_SATURATION_CMD_COUNT }
enum	ad_basicOps_module_power_reset_commands { AD_BASICOPS_MODULE_POWER_RESET_CMD_BACK , AD_BASICOPS_MODULE_POWER_RESET_CMD_CLEAR_MODULE_POWER_RESET_STATUS , AD_BASICOPS_MODULE_POWER_RESET_CMD_SET_MODULE_POWER_RESET , AD_BASICOPS_MODULE_POWER_RESET_CMD_COUNT }

Functions
static bool_t	ADBasicOps_run (int32_t cardIndex, int32_t module, uint32_t modId)
	ADBasicOps_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 bool_t	CF1ADBasicOps_run (int32_t cardIndex, int32_t module, uint32_t modid)
static void	ADBasicOps_displayConfigurations (int32_t cardIndex, int32_t module, uint32_t modId, int32_t maxChannels, bool_t displayHex)
	ADBasicOps_displayConfigurations illustrates the methods to call in the naibrd library to retrieve the basic operation configuration states and status states as well as the current voltage reading for all channels.
static void	ADBasicOps_displaySaturationConfig (int32_t cardIndex, int32_t module, uint32_t modId, int32_t maxChannels, bool_t displayHex)
static nai_status_t	ADBasicOps_setRangePolarity (int32_t paramCount, int32_t *p_params)
	ADBasicOps_setRangePolarity handles the user request to set the configuration states of Range and Polarity for the selected channel.
static nai_status_t	ADBasicOps_setLatch (int32_t paramCount, int32_t *p_params)
	ADBasicOps_setLatch handles the user request to set the latch on all channel readings.
static nai_status_t	ADBasicOps_setMode (int32_t paramCount, int32_t *p_params)
	ADBasicOps_setMode handles the user request to set the configuration states of Mode for the selected channel.
static nai_status_t	ADBasicOps_setBreakFreq (int32_t paramCount, int32_t *p_params)
	ADBasicOps_setBreakFreq handles the user request to set the filter break frequency for the selected channel.
static nai_status_t	ADBasicOps_setActiveChannel (int32_t paramCount, int32_t *p_params)
	ADBasicOps_setActiveChannel handles the user request to set the active/inactive state for the selected channel.
static nai_status_t	ADBasicOps_saturationMenu (int32_t paramCount, int32_t *p_params)
static nai_status_t	ADBasicOps_setD0TestEnable (int32_t paramCount, int32_t *p_params)
	ADBasicOps_setD0TestEnable handles the user request to set the D0 Test Enabled/Disabled State and configure the D0 Test Settings. The only range available is the 10V range. Valid range modes are unipolar and bipolar. The D0 Test Level can also be set.
static nai_status_t	ADBasicOps_FloatingPointMode (int32_t paramCount, int32_t *p_params)
	This function enables/disables the hardware floating-point conversion mode of the DA module, as specified by the user.
static nai_status_t	ADBasicOps_FloatingPointOffset (int32_t paramCount, int32_t *p_params)
	This function sets the hardware floating-point conversion mode offset for the DA channel specified by the user. This function is only applicable when the hardware floating-point conversion mode for the module is enabled.
static nai_status_t	ADBasicOps_FloatingPointScaleFactor (int32_t paramCount, int32_t *p_params)
	This function sets the hardware floating-point conversion mode scale factor for the DA channel specified by the user. This function is only applicable when the hardware floating-point conversion mode for the module is enabled.
static nai_status_t	ADBasicOps_ChannelStatusEnable (int32_t paramCount, int32_t *p_params)
	This function Enables\Disables the reporting of the Channel Status. When enabled, the user will get status updates. When disabled, the statuses will not report and status-based interrupts will not assert.
static nai_status_t	ADBasicOps_CheckPowerOnBIT (int32_t paramCount, int32_t *p_params)
	ADBasicOps_CheckPowerOnBIT() Checks to see if the power-on BIT test has been run on the module. If the PBIT test has run, it checks the result of the test and reports it back.
static nai_status_t	ADBasicOps_BITThresholds (int32_t paramCount, int32_t *p_params)
	ADBasicOps_BITThresholds() allows the user to set and get the BIT error thresholds. This is an advanced feature.
static nai_status_t	ADBasicOps_toggleNumDisplay (int32_t paramCount, int32_t *p_params)
static nai_status_t	ADBasicOps_setSaturationLow (int32_t paramCount, int32_t *p_params)
static nai_status_t	ADBasicOps_setSaturationHigh (int32_t paramCount, int32_t *p_params)
static nai_status_t	ADBasicOps_enableSaturationLow (int32_t paramCount, int32_t *p_params)
static nai_status_t	ADBasicOps_enableSaturationHigh (int32_t paramCount, int32_t *p_params)
static bool_t	ADBasicOps_SaturationAvailable (int32_t paramCount, int32_t *p_params)
static nai_status_t	ADBasicOps_ModulePowerResetMenu (int32_t paramCount, int32_t *p_params)
	Configure_AD_ModulePowerResetMenu displays the menu for module power reset commands.
static nai_status_t	ADBasicOps_ClearModulePowerResetStatus (int32_t paramCount, int32_t *p_params)
	Configure_AD_ClearModulePowerResetStatus handles the user request to clear the module power reset status and calls the method in the naibrd library to clear the module power reset status. The user is prompted for the module power reset status type to clear.
static nai_status_t	ADBasicOps_SetModulePowerReset (int32_t paramCount, int32_t *p_params)
	Configure_AD_SetModulePowerReset handles the user request to set the module power reset request and calls the method in the naibrd library to set the module power reset request. The user is prompted for the module power reset request type to set, and then the user is prompted to set or reset the request bit.
static void	ADBasicOps_displayStatus (nai_status_bit_t BitStatus, nai_status_bit_t OpenStatus)
	ADBasicOps_displayStatus prints to stdin the range mode, BIT status, and Open Status in a format thats fits the table produced in displayChannelCfg.
int32_t	AD_BasicOps (void)
	The purpose of the AD_BasicOps is to illustrate the methods to call in the naibrd library to perform basic operations with the AD modules for configuration setup and reading the channels.

Variables
static const int8_t *	SAMPLE_PGM_NAME = (const int8_t *)"AD Module Basic Operation Program"
static const int8_t *	CONFIG_FILE = (const int8_t *)"default_AD_BasicOps.txt"
static const int8_t *	SATURATION_MENU = (const int8_t *)"AD Module Saturation Menu"
naiapp_cmdtbl_params_t	AD_BasicOpsCmds []
naiapp_cmdtbl_params_t	AD_BasicOps_SaturationCmds []
naiapp_cmdtbl_params_t	AD_BasicOps_ModulePowerResetMenuCmds [AD_BASICOPS_MODULE_POWER_RESET_CMD_COUNT]

Enumeration Type Documentation

ad_basicOps_commands

enum ad_basicOps_commands

Enumerator
AD_BASICOPS_CMD_SET_POL_RNG
AD_BASICOPS_CMD_SET_BREAK_FREQ
AD_BASICOPS_CMD_SET_LATCH
AD_BASICOPS_CMD_SET_MODE
AD_BASICOPS_CMD_SET_CHANNEL_ACTIVE
AD_BASICOPS_CMD_SATURATION_MENU
AD_BASICOPS_CMD_SET_D0_TEST_ENABLE
AD_BASICOPS_CMD_FLOATING_POINT_MODE
AD_BASICOPS_CMD_FLOATING_POINT_OFFSET
AD_BASICOPS_CMD_FLOATING_POINT_SCALE_FACTOR
AD_BASICOPS_CMD_CHANNEL_STATUS_ENABLE
AD_BASICOPS_CMD_PBIT
AD_BASICOPS_CMD_BIT_THRESHOLD
AD_BASICOPS_CMD_MODULE_POWER_RESET_MENU
AD_BASICOPS_CMD_TOGGLE_NUMERIC_DISPLAY
AD_BASICOPS_CMD_COUNT

ad_basicOps_module_power_reset_commands

enum ad_basicOps_module_power_reset_commands

Enumerator
AD_BASICOPS_MODULE_POWER_RESET_CMD_BACK
AD_BASICOPS_MODULE_POWER_RESET_CMD_CLEAR_MODULE_POWER_RESET_STATUS
AD_BASICOPS_MODULE_POWER_RESET_CMD_SET_MODULE_POWER_RESET
AD_BASICOPS_MODULE_POWER_RESET_CMD_COUNT

ad_basicOps_Saturation_commands

enum ad_basicOps_Saturation_commands

Enumerator
AD_BASICOPS_SATURATION_CMD_SET_LOW
AD_BASICOPS_SATURATION_CMD_SET_HIGH
AD_BASICOPS_SATURATION_CMD_ENABLE_LOW
AD_BASICOPS_SATURATION_CMD_ENABLE_HIGH
AD_BASICOPS_SATURATION_CMD_COUNT

Function Documentation

AD_BasicOps()

int32_t AD_BasicOps

(

void

)

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

The following system configuration routines from the nai_sys_cfg.c file are called to assist with the configuration setup for this program prior to calling the naibrd AD routines.

• ConfigDevice
• DisplayDeviceCfg
• GetBoardSNModCfg
• CheckModule

ADBasicOps_BITThresholds()

static nai_status_t ADBasicOps_BITThresholds ( int32_t paramCount, int32_t * p_paramas )

static

ADBasicOps_BITThresholds() allows the user to set and get the BIT error thresholds. This is an advanced feature.

ADBasicOps_ChannelStatusEnable()

static nai_status_t ADBasicOps_ChannelStatusEnable ( int32_t paramCount, int32_t * p_params )

static

This function Enables\Disables the reporting of the Channel Status. When enabled, the user will get status updates. When disabled, the statuses will not report and status-based interrupts will not assert.

ADBasicOps_CheckPowerOnBIT()

static nai_status_t ADBasicOps_CheckPowerOnBIT ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_CheckPowerOnBIT() Checks to see if the power-on BIT test has been run on the module. If the PBIT test has run, it checks the result of the test and reports it back.

ADBasicOps_ClearModulePowerResetStatus()

static nai_status_t ADBasicOps_ClearModulePowerResetStatus ( int32_t paramCount, int32_t * p_params )

static

Configure_AD_ClearModulePowerResetStatus handles the user request to clear the module power reset status and calls the method in the naibrd library to clear the module power reset status. The user is prompted for the module power reset status type to clear.

ADBasicOps_displayConfigurations()

static void ADBasicOps_displayConfigurations ( int32_t cardIndex, int32_t module, uint32_t modId, int32_t maxChannels, bool_t displayHex )

static

ADBasicOps_displayConfigurations illustrates the methods to call in the naibrd library to retrieve the basic operation configuration states and status states as well as the current voltage reading for all channels.

ADBasicOps_displaySaturationConfig()

static void ADBasicOps_displaySaturationConfig ( int32_t cardIndex, int32_t module, uint32_t modId, int32_t maxChannels, bool_t displayHex )

static

ADBasicOps_displayStatus()

static void ADBasicOps_displayStatus ( nai_status_bit_t BitStatus, nai_status_bit_t OpenStatus )

static

ADBasicOps_displayStatus prints to stdin the range mode, BIT status, and Open Status in a format thats fits the table produced in displayChannelCfg.

ADBasicOps_enableSaturationHigh()

static nai_status_t ADBasicOps_enableSaturationHigh ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_enableSaturationLow()

static nai_status_t ADBasicOps_enableSaturationLow ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_FloatingPointMode()

static nai_status_t ADBasicOps_FloatingPointMode ( int32_t paramCount, int32_t * p_params )

static

This function enables/disables the hardware floating-point conversion mode of the DA module, as specified by the user.

ADBasicOps_FloatingPointOffset()

static nai_status_t ADBasicOps_FloatingPointOffset ( int32_t paramCount, int32_t * p_params )

static

This function sets the hardware floating-point conversion mode offset for the DA channel specified by the user. This function is only applicable when the hardware floating-point conversion mode for the module is enabled.

ADBasicOps_FloatingPointScaleFactor()

static nai_status_t ADBasicOps_FloatingPointScaleFactor ( int32_t paramCount, int32_t * p_params )

static

This function sets the hardware floating-point conversion mode scale factor for the DA channel specified by the user. This function is only applicable when the hardware floating-point conversion mode for the module is enabled.

ADBasicOps_ModulePowerResetMenu()

static nai_status_t ADBasicOps_ModulePowerResetMenu ( int32_t paramCount, int32_t * p_params )

static

Configure_AD_ModulePowerResetMenu displays the menu for module power reset commands.

ADBasicOps_run()

static bool_t ADBasicOps_run ( int32_t cardIndex, int32_t module, uint32_t modid )

static

ADBasicOps_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.

ADBasicOps_SaturationAvailable()

static bool_t ADBasicOps_SaturationAvailable ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_saturationMenu()

static nai_status_t ADBasicOps_saturationMenu ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_setActiveChannel()

static nai_status_t ADBasicOps_setActiveChannel ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_setActiveChannel handles the user request to set the active/inactive state for the selected channel.

ADBasicOps_setBreakFreq()

static nai_status_t ADBasicOps_setBreakFreq ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_setBreakFreq handles the user request to set the filter break frequency for the selected channel.

ADBasicOps_setD0TestEnable()

static nai_status_t ADBasicOps_setD0TestEnable ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_setD0TestEnable handles the user request to set the D0 Test Enabled/Disabled State and configure the D0 Test Settings. The only range available is the 10V range. Valid range modes are unipolar and bipolar. The D0 Test Level can also be set.

ADBasicOps_setLatch()

static nai_status_t ADBasicOps_setLatch ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_setLatch handles the user request to set the latch on all channel readings.

ADBasicOps_setMode()

static nai_status_t ADBasicOps_setMode ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_setMode handles the user request to set the configuration states of Mode for the selected channel.

ADBasicOps_SetModulePowerReset()

static nai_status_t ADBasicOps_SetModulePowerReset ( int32_t paramCount, int32_t * p_params )

static

Configure_AD_SetModulePowerReset handles the user request to set the module power reset request and calls the method in the naibrd library to set the module power reset request. The user is prompted for the module power reset request type to set, and then the user is prompted to set or reset the request bit.

ADBasicOps_setRangePolarity()

static nai_status_t ADBasicOps_setRangePolarity ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_setRangePolarity handles the user request to set the configuration states of Range and Polarity for the selected channel.

ADBasicOps_setSaturationHigh()

static nai_status_t ADBasicOps_setSaturationHigh ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_setSaturationLow()

static nai_status_t ADBasicOps_setSaturationLow ( int32_t paramCount, int32_t * p_params )

static

ADBasicOps_toggleNumDisplay()

static nai_status_t ADBasicOps_toggleNumDisplay ( int32_t paramCount, int32_t * p_params )

static

CF1ADBasicOps_run()

static bool_t CF1ADBasicOps_run ( int32_t cardIndex, int32_t module, uint32_t modid )

static

Variable Documentation

AD_BasicOps_ModulePowerResetMenuCmds

naiapp_cmdtbl_params_t AD_BasicOps_ModulePowerResetMenuCmds[AD_BASICOPS_MODULE_POWER_RESET_CMD_COUNT]

Initial value:

=
{
   {"BACK",  "Back to Main Menu",               AD_BASICOPS_MODULE_POWER_RESET_CMD_BACK,                            NULL},
   {"CLEAR", "Clear Module Power Reset Status", AD_BASICOPS_MODULE_POWER_RESET_CMD_CLEAR_MODULE_POWER_RESET_STATUS, ADBasicOps_ClearModulePowerResetStatus},
   {"SET",   "Set Module Power Reset Request",  AD_BASICOPS_MODULE_POWER_RESET_CMD_SET_MODULE_POWER_RESET,          ADBasicOps_SetModulePowerReset}
}

AD_BasicOps_SaturationCmds

naiapp_cmdtbl_params_t AD_BasicOps_SaturationCmds[]

Initial value:

=
{
   {"SL",    "Set Saturation Low value",                    AD_BASICOPS_SATURATION_CMD_SET_LOW,        ADBasicOps_setSaturationLow },
   {"SH",    "Set Saturation High value",                   AD_BASICOPS_SATURATION_CMD_SET_HIGH,       ADBasicOps_setSaturationHigh },
   {"EL",    "Enable/Disable Saturation Low",               AD_BASICOPS_SATURATION_CMD_ENABLE_LOW,     ADBasicOps_enableSaturationLow },
   {"EH",    "Enable/Disable Saturation High",              AD_BASICOPS_SATURATION_CMD_ENABLE_LOW,     ADBasicOps_enableSaturationHigh },
}

AD_BasicOpsCmds

naiapp_cmdtbl_params_t AD_BasicOpsCmds[]

Initial value:

=
{
   {"PR",      "Set AD Polarity and Range",                   AD_BASICOPS_CMD_SET_POL_RNG,                              ADBasicOps_setRangePolarity },
   {"BRKFRQ",  "Set AD Filter Break Frequency",               AD_BASICOPS_CMD_SET_BREAK_FREQ,                           ADBasicOps_setBreakFreq     },
   {"M",       "Set AD Voltage/Current Mode (AD4 ONLY)",      AD_BASICOPS_CMD_SET_MODE,                                 ADBasicOps_setMode          },
   {"L",       "Set AD Latch/Unlatch Status",                 AD_BASICOPS_CMD_SET_LATCH,                                ADBasicOps_setLatch         },
   {"AC",      "Set AD Channel Active/Inactive (AD4 ONLY)",   AD_BASICOPS_CMD_SET_CHANNEL_ACTIVE,                       ADBasicOps_setActiveChannel },
   {"SAT",     "Saturation Menu",                             AD_BASICOPS_CMD_SATURATION_MENU,                          ADBasicOps_saturationMenu   },
   {"D0",      "Enable/Configure/Disable D0 Test",            AD_BASICOPS_CMD_SET_D0_TEST_ENABLE,                       ADBasicOps_setD0TestEnable  },
   {"FP_MODE", "Enable/Disable Hardware Floating-Point Conversion Mode",   AD_BASICOPS_CMD_FLOATING_POINT_MODE,         ADBasicOps_FloatingPointMode},
   {"OFFSET",  "Set Hardware Floating-Point Conversion Mode Offset",       AD_BASICOPS_CMD_FLOATING_POINT_OFFSET,       ADBasicOps_FloatingPointOffset},
   {"SCALE",   "Set Hardware Floating-Point Conversion Mode Scale Factor", AD_BASICOPS_CMD_FLOATING_POINT_SCALE_FACTOR, ADBasicOps_FloatingPointScaleFactor},
   {"CHANSTAT","Channel Status Enable/Disable",                            AD_BASICOPS_CMD_CHANNEL_STATUS_ENABLE,       ADBasicOps_ChannelStatusEnable},
   {"PBIT",    "Check Power-On BIT",                          AD_BASICOPS_CMD_PBIT,                                     ADBasicOps_CheckPowerOnBIT  },
   {"THRESH",  "Set BIT Error Threshold",                     AD_BASICOPS_CMD_BIT_THRESHOLD,                            ADBasicOps_BITThresholds    },
   {"PWRRESET","Show Module Power Reset Menu Options",        AD_BASICOPS_CMD_MODULE_POWER_RESET_MENU,                  ADBasicOps_ModulePowerResetMenu},
   {"TND",     "Toggle Numeric Display",                      AD_BASICOPS_CMD_TOGGLE_NUMERIC_DISPLAY,                   ADBasicOps_toggleNumDisplay }}

CONFIG_FILE

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

static

SAMPLE_PGM_NAME

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

static

SATURATION_MENU

const int8_t* SATURATION_MENU = (const int8_t *)"AD Module Saturation Menu"

static