Enumerations
enum	rg_basicOps_commands { RG_BASICOPS_BASIC_MENU , RG_BASICOPS_INTERRUPT_MENU , RG_BASICOPS_DST_MENU , RG_BASICOPS_COUNT }

enum	rg_basicOps_basic_commands { RG_BASICOPS_CMD_SET_PROTOCOL , RG_BASICOPS_CMD_SET_PROTOCOL_BY_VALUE , RG_BASICOPS_CMD_SET_GAIN , RG_BASICOPS_CMD_SET_DRIFT_THRESHOLD , RG_BASICOPS_CMD_SET_REFERENCE_SOURCE , RG_BASICOPS_CMD_SET_CONTROL_BITS , RG_BASICOPS_CMD_GET_CONTROL_BITS_RECEIVED , RG_BASICOPS_CMD_SET_DIGITAL_INPUT , RG_BASICOPS_CMD_SET_DIGITAL_OUTPUT , RG_BASICOPS_CMD_SET_TIME_ZONE_OFFSET , RG_BASICOPS_CMD_SET_PROP_OFFSET , RG_BASICOPS_CMD_SET_YEAR , RG_BASICOPS_CMD_SET_PULSE_WIDTH , RG_BASICOPS_CMD_SET_PERIOD_INTERRUPT_PERIOD , RG_BASICOPS_CMD_SET_FREE_RUNNING_TIME , RG_BASICOPS_CMD_SET_CAPTURE_EVENT_TIME , RG_BASICOPS_CMD_SET_CAPTURE_EVENT_EDGE , RG_BASICOPS_CMD_SET_SERIAL_SIGNAL_LEVEL , RG_BASICOPS_CMD_SET_RTC_TIME , RG_BASICOPS_CMD_SET_RTC_CONTROL , RG_BASICOPS_CMD_COUNT }

enum	rg_basicOps_Interrupts_commands { RG_BASICOPS_INTERRUPTS_CLEAR , RG_BASICOPS_INTERRUPTS_CLEARSPECIFIC , RG_BASICOPS_INTERRUPTS_ENABLE , RG_BASICOPS_INTERRUPTS_STEERING , RG_BASICOPS_INTERRUPTS_EDGELEVEL , RG_BASICOPS_INTERRUPTS_VECTOR , RG_BASICOPS_INTERRUPTS_CMD_COUNT }

enum	rg_basicOps_DST_commands { RG_BASICOPS_DST_CMD_GET_DST_STATUS , RG_BASICOPS_DST_CMD_SET_DST_OFFSET , RG_BASICOPS_DST_CMD_SET_DST_START , RG_BASICOPS_DST_CMD_SET_DST_END , RG_BASICOPS_DST_CMD_COUNT }

Functions
static bool_t	RGBasicOps_run (int32_t cardIndex, int32_t module, uint32_t modId)
	RGBasicOps_run allows the user to choose to go to either the Basic Menu or the Interrupt Menu. Returns TRUE if the user enters the Quit Command at any point within its scope.

static nai_status_t	RGBasicOps_runBasicMenu (int32_t paramCount, int32_t *p_params)
	RGBasicOps_runBasicMenu illustrates the channel configuration and prepares the menu which will handle user command requests. Returns TRUE if the user enters the Quit Command at any point within its scope.

static nai_status_t	RGBasicOps_runInterruptMenu (int32_t paramCount, int32_t *p_params)
	RGBasicOps_runInterruptMenu allows the user to set Interrupt Enable, Trigger Type, Vector, and Steering for the RG module. Returns TRUE if the user enters the Quit Command at any point within its scope.

static nai_status_t	RGBasicOps_runDSTMenu (int32_t paramCount, int32_t *p_params)
	RGBasicOps_runDSTMenu allows the user to set DST (Daylight Savings Time) settings for the RG module. Returns TRUE if the user enters the Quit Command at any point within its scope.

static void	RGBasicOps_displayConfigurations (int32_t cardIndex, int32_t module, uint32_t modId, int32_t maxChannels, bool_t displayHex)
	RGBasicOps_displayConfigurations illustrates the methods to call in the naibrd library to retrieve the basic operation configuration states and status states for all channels on the module.

static void	RGBasicOps_displayInterrupts (int32_t cardIndex, int32_t module, uint32_t modId, int32_t maxChannels, bool_t displayHex)
	RGBasicOps_displayInterrupts illustrates the methods to call in the naibrd library to retrieve and set interrupt configuration settings for the RG module.

static void	RGBasicOps_displayDSTSettings (int32_t cardIndex, int32_t module, uint32_t modId, int32_t maxChannels, bool_t displayHex)
	RGBasicOps_displayDSTSettings illustrates the methods to call in the naibrd library to retrieve and set DST (Daylight Savings Time) configuration settings for the RG module.

static nai_status_t	RGBasicOps_setIRIGProtocol (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGProtocol handles the user request to set Protocol by protocol types.

static nai_status_t	RGBasicOps_setIRIGProtocolByValue (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGProtocolByValue handles the user request to set Protocol from the list of accepted Protocols.

static nai_status_t	RGBasicOps_setIRIGAMOutputGain (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGAMOutputGain handles the user request to set the IRIG AM output gain level (0 to 255)

static nai_status_t	RGBasicOps_setIRIGDriftThreshold (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGDriftThreshold handles the user request to set the IRIG drift threshold (16 bits)

static nai_status_t	RGBasicOps_setIRIGReferenceSource (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGReferenceSource handles the user request to set the requested reference source.

static nai_status_t	RGBasicOps_setIRIGCtrlBitsToSend (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGCtrlBitsToSend handles the user request to set the IRIG user bits to send, which are loaded at the beginning of an IRIG Tx frame. (bits 0 to 26)

static nai_status_t	RGBasicOps_getIRIGCtrlBitsReceived (int32_t paramCount, int32_t *p_params)
	RGBasicOps_getIRIGCtrlBitsReceived handles the user request to receive the IRIG user bits sent, which are loaded at the beginning of an IRIG Tx frame. (bits 0 to 26)

static nai_status_t	RGBasicOps_setIRIGDigitalInput (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGDigitalInput handles the user request to set the digital input signal level setting RS232 or RS485.

static nai_status_t	RGBasicOps_setIRIGDigitalOutput (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGDigitalOutput handles the user request to set the digital input signal level setting RS232 or RS485.

static nai_status_t	RGBasicOps_setIRIGTimeZoneOffset (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGTimeZoneOffset handles the user request to set the Number of minutes to be added to or subtracted from received IRIG reference time to accommodate time zone differences. Range : +/-1439.

static nai_status_t	RGBasicOps_setIRIGPropOffset (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGPropOffset handles the user request to set IRIG Prop Offset based on the current format.

static nai_status_t	RGBasicOps_setIRIGYear (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGYear handles the user request to set the calendar Year.

static nai_status_t	RGBasicOps_setIRIGPulseWidth (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGPulseWidth handles the user request to set the 1PPS Pulse Width.

static nai_status_t	RGBasicOps_setIRIGFreeRunningTime (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGFreeRunningTime handles the user request to set the Free Running Time in yy:ddd:hh:mm:ss:th.

static nai_status_t	RGBasicOps_setIRIGRTCTime (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGRTCT handles the user request to set the RTC (real-time clock) in hh:mm:ss and 00yy/mm/dd.

static nai_status_t	RGBasicOps_setIRIGRTCControl (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGRTCT sets the RTC for the specified IRIG channel if the ready bit is set.

static nai_status_t	RGBasicOps_setIRIGCaptureEventTime (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGCaptureEventTime handles the user request to set the Capture Event time in hours, minutes, seconds, tenths, hundredths. (HHMMSSTH)

static nai_status_t	RGBasicOps_setIRIGCaptureEventEdge (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGCaptureEventEdge handles the user request to set the event edge as rising edge or falling edge.

static nai_status_t	RGBasicOps_setIRIGSerialSignalLevel (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGSerialSignalLevel handles the user request to set the serial signal setting RS232 or RS485.

static nai_status_t	RGBasicOps_setIRIGPeriodicInterruptPeriod (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGPeriodicInterruptPeriod handles the user request to set the periodic interrupt period.

static nai_status_t	RGBasicOpsInterrupts_setIRIGInterruptEnable (int32_t paramCount, int32_t *p_params)
	RGBasicOpsInterrupts_setIRIGInterruptEnable handles the user request set Interrupt Enable for the Event status.

static nai_status_t	RGBasicOpsInterrupts_setIRIGInterruptSteering (int32_t paramCount, int32_t *p_params)
	RGBasicOpsInterrupts_setIRIGInterruptSteering handles the user request set Interrupt Steering for the Event status.

static nai_status_t	RGBasicOpsInterrupts_setIRIGInterruptEdgeLevel (int32_t paramCount, int32_t *p_params)
	RGBasicOpsInterrupts_setIRIGInterruptEdgeLevel handles the user request set Interrupt Edge Level for the Event status.

static nai_status_t	RGBasicOpsInterrupts_setIRIGInterruptVector (int32_t paramCount, int32_t *p_params)
	RGBasicOpsInterrupts_setIRIGInterruptVector handles the user request set Interrupt Vector for the Event status.

static nai_status_t	RGBasicOpsInterrupts_clearIRIGEventMappedStatus (int32_t paramCount, int32_t *p_params)
	RGBasicOps_getIRIGEventMappedStatus handles the user request to view BIT status depending on desired event.

static nai_status_t	RGBasicOpsInterrupts_getIRIGEventMappedStatus (int32_t paramCount, int32_t *p_params)

static nai_status_t	RGBasicOpsInterrupts_clearIRIGChannelStatus (int32_t paramCount, int32_t *p_params)

static nai_status_t	RGBasicOpsDST_getIRIGDSTStatus (int32_t paramCount, int32_t *p_params)
	RGBasicOps_getIRIGDSTStatus handles the user request to view DST status.

static nai_status_t	RGBasicOpsDST_setIRIGDSTOffset (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGDSTOffset handles the user request to set IRIG DST offset in HMM. The format of the DST Offset register is 0xXXXXXHMM, where bytes 0 and 1 are minutes and byte 2 is hours.

static nai_status_t	RGBasicOpsDST_setIRIGDSTStart (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGDSTStart handles the user request to set when DST should start, in the structure of Month, Day of Week, Number of Week, Hour, and Minute.

static nai_status_t	RGBasicOpsDST_setIRIGDSTEnd (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGDSTEnd handles the user request to set when DST should end, in the structure of Month, Day of Week, Number of Week, Hour, and Minute.

int32_t	RG_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.

static nai_status_t	RGBasicOps_setIRIGInputAnalogTermEnable (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGInputAnalogTermEnable handles the user request to Enable or disable IRIG input analog termination.

static nai_status_t	RGBasicOps_setIRIGInputDigitalTermEnable (int32_t paramCount, int32_t *p_params)
	RGBasicOps_setIRIGInputDigitalTermEnable handles the user request to Enable or disable IRIG input digital termination.

static nai_status_t	RGBasicOps_getIRIGEventMappedStatus (int32_t paramCount, int32_t *p_params)
	RGBasicOps_getIRIGEventMappedStatus handles the user request to view BIT status depending on desired event.

static nai_status_t	RGBasicOps_setIRIGEventMappedStatus (int32_t paramCount, int32_t *p_params)
	RGBasicOps_getIRIGEventMappedStatus handles the user request to view BIT status depending on desired event.

Variables
static const int8_t *	SAMPLE_PGM_NAME = (const int8_t *)"RG Module Basic Operation Program"

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

naiapp_cmdtbl_params_t	RG_BasicOpsCmds []

naiapp_cmdtbl_params_t	RG_BasicOps_BasicCmds []

naiapp_cmdtbl_params_t	RG_BasicOps_InterruptCmds []

naiapp_cmdtbl_params_t	RG_BasicOps_DSTCmds []

int8_t	interruptTypeStrings [NAIBRD_IRIG_EVTMAP_STATUS_TYPE_ENUM_COUNT][40]

int8_t	enableDisableStrings [2][10]

int8_t	interruptTriggerTypeStrings [2][10]

int8_t	interruptSteeringStrings [6][75]

Enumeration Type Documentation

◆ rg_basicOps_basic_commands

enum rg_basicOps_basic_commands

Enumerator
RG_BASICOPS_CMD_SET_PROTOCOL
RG_BASICOPS_CMD_SET_PROTOCOL_BY_VALUE
RG_BASICOPS_CMD_SET_GAIN
RG_BASICOPS_CMD_SET_DRIFT_THRESHOLD
RG_BASICOPS_CMD_SET_REFERENCE_SOURCE
RG_BASICOPS_CMD_SET_CONTROL_BITS
RG_BASICOPS_CMD_GET_CONTROL_BITS_RECEIVED
RG_BASICOPS_CMD_SET_DIGITAL_INPUT
RG_BASICOPS_CMD_SET_DIGITAL_OUTPUT
RG_BASICOPS_CMD_SET_TIME_ZONE_OFFSET
RG_BASICOPS_CMD_SET_PROP_OFFSET
RG_BASICOPS_CMD_SET_YEAR
RG_BASICOPS_CMD_SET_PULSE_WIDTH
RG_BASICOPS_CMD_SET_PERIOD_INTERRUPT_PERIOD
RG_BASICOPS_CMD_SET_FREE_RUNNING_TIME
RG_BASICOPS_CMD_SET_CAPTURE_EVENT_TIME
RG_BASICOPS_CMD_SET_CAPTURE_EVENT_EDGE
RG_BASICOPS_CMD_SET_SERIAL_SIGNAL_LEVEL
RG_BASICOPS_CMD_SET_RTC_TIME
RG_BASICOPS_CMD_SET_RTC_CONTROL
RG_BASICOPS_CMD_COUNT

◆ rg_basicOps_commands

enum rg_basicOps_commands

Enumerator
RG_BASICOPS_BASIC_MENU
RG_BASICOPS_INTERRUPT_MENU
RG_BASICOPS_DST_MENU
RG_BASICOPS_COUNT

◆ rg_basicOps_DST_commands

enum rg_basicOps_DST_commands

Enumerator
RG_BASICOPS_DST_CMD_GET_DST_STATUS
RG_BASICOPS_DST_CMD_SET_DST_OFFSET
RG_BASICOPS_DST_CMD_SET_DST_START
RG_BASICOPS_DST_CMD_SET_DST_END
RG_BASICOPS_DST_CMD_COUNT

◆ rg_basicOps_Interrupts_commands

enum rg_basicOps_Interrupts_commands

Enumerator
RG_BASICOPS_INTERRUPTS_CLEAR
RG_BASICOPS_INTERRUPTS_CLEARSPECIFIC
RG_BASICOPS_INTERRUPTS_ENABLE
RG_BASICOPS_INTERRUPTS_STEERING
RG_BASICOPS_INTERRUPTS_EDGELEVEL
RG_BASICOPS_INTERRUPTS_VECTOR
RG_BASICOPS_INTERRUPTS_CMD_COUNT

Function Documentation

◆ RG_BasicOps()

int32_t RG_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

◆ RGBasicOps_displayConfigurations()

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

static

RGBasicOps_displayConfigurations illustrates the methods to call in the naibrd library to retrieve the basic operation configuration states and status states for all channels on the module.

◆ RGBasicOps_displayDSTSettings()

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

static

RGBasicOps_displayDSTSettings illustrates the methods to call in the naibrd library to retrieve and set DST (Daylight Savings Time) configuration settings for the RG module.

◆ RGBasicOps_displayInterrupts()

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

static

RGBasicOps_displayInterrupts illustrates the methods to call in the naibrd library to retrieve and set interrupt configuration settings for the RG module.

◆ RGBasicOps_getIRIGCtrlBitsReceived()

static nai_status_t RGBasicOps_getIRIGCtrlBitsReceived	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_getIRIGCtrlBitsReceived handles the user request to receive the IRIG user bits sent, which are loaded at the beginning of an IRIG Tx frame. (bits 0 to 26)

◆ RGBasicOps_getIRIGEventMappedStatus()

static nai_status_t RGBasicOps_getIRIGEventMappedStatus	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_getIRIGEventMappedStatus handles the user request to view BIT status depending on desired event.

◆ RGBasicOps_run()

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

static

RGBasicOps_run allows the user to choose to go to either the Basic Menu or the Interrupt Menu. Returns TRUE if the user enters the Quit Command at any point within its scope.

◆ RGBasicOps_runBasicMenu()

static nai_status_t RGBasicOps_runBasicMenu	(	int32_t	paramCount,
		int32_t *	p_params )

static

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

◆ RGBasicOps_runDSTMenu()

static nai_status_t RGBasicOps_runDSTMenu	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_runDSTMenu allows the user to set DST (Daylight Savings Time) settings for the RG module. Returns TRUE if the user enters the Quit Command at any point within its scope.

◆ RGBasicOps_runInterruptMenu()

static nai_status_t RGBasicOps_runInterruptMenu	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_runInterruptMenu allows the user to set Interrupt Enable, Trigger Type, Vector, and Steering for the RG module. Returns TRUE if the user enters the Quit Command at any point within its scope.

◆ RGBasicOps_setIRIGAMOutputGain()

static nai_status_t RGBasicOps_setIRIGAMOutputGain	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGAMOutputGain handles the user request to set the IRIG AM output gain level (0 to 255)

◆ RGBasicOps_setIRIGCaptureEventEdge()

static nai_status_t RGBasicOps_setIRIGCaptureEventEdge	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGCaptureEventEdge handles the user request to set the event edge as rising edge or falling edge.

◆ RGBasicOps_setIRIGCaptureEventTime()

static nai_status_t RGBasicOps_setIRIGCaptureEventTime	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGCaptureEventTime handles the user request to set the Capture Event time in hours, minutes, seconds, tenths, hundredths. (HHMMSSTH)

◆ RGBasicOps_setIRIGCtrlBitsToSend()

static nai_status_t RGBasicOps_setIRIGCtrlBitsToSend	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGCtrlBitsToSend handles the user request to set the IRIG user bits to send, which are loaded at the beginning of an IRIG Tx frame. (bits 0 to 26)

◆ RGBasicOps_setIRIGDigitalInput()

static nai_status_t RGBasicOps_setIRIGDigitalInput	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGDigitalInput handles the user request to set the digital input signal level setting RS232 or RS485.

◆ RGBasicOps_setIRIGDigitalOutput()

static nai_status_t RGBasicOps_setIRIGDigitalOutput	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGDigitalOutput handles the user request to set the digital input signal level setting RS232 or RS485.

◆ RGBasicOps_setIRIGDriftThreshold()

static nai_status_t RGBasicOps_setIRIGDriftThreshold	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGDriftThreshold handles the user request to set the IRIG drift threshold (16 bits)

◆ RGBasicOps_setIRIGEventMappedStatus()

static nai_status_t RGBasicOps_setIRIGEventMappedStatus	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_getIRIGEventMappedStatus handles the user request to view BIT status depending on desired event.

◆ RGBasicOps_setIRIGFreeRunningTime()

static nai_status_t RGBasicOps_setIRIGFreeRunningTime	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGFreeRunningTime handles the user request to set the Free Running Time in yy:ddd:hh:mm:ss:th.

◆ RGBasicOps_setIRIGInputAnalogTermEnable()

static nai_status_t RGBasicOps_setIRIGInputAnalogTermEnable	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGInputAnalogTermEnable handles the user request to Enable or disable IRIG input analog termination.

◆ RGBasicOps_setIRIGInputDigitalTermEnable()

static nai_status_t RGBasicOps_setIRIGInputDigitalTermEnable	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGInputDigitalTermEnable handles the user request to Enable or disable IRIG input digital termination.

◆ RGBasicOps_setIRIGPeriodicInterruptPeriod()

static nai_status_t RGBasicOps_setIRIGPeriodicInterruptPeriod	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGPeriodicInterruptPeriod handles the user request to set the periodic interrupt period.

◆ RGBasicOps_setIRIGPropOffset()

static nai_status_t RGBasicOps_setIRIGPropOffset	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGPropOffset handles the user request to set IRIG Prop Offset based on the current format.

◆ RGBasicOps_setIRIGProtocol()

static nai_status_t RGBasicOps_setIRIGProtocol	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGProtocol handles the user request to set Protocol by protocol types.

◆ RGBasicOps_setIRIGProtocolByValue()

static nai_status_t RGBasicOps_setIRIGProtocolByValue	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGProtocolByValue handles the user request to set Protocol from the list of accepted Protocols.

◆ RGBasicOps_setIRIGPulseWidth()

static nai_status_t RGBasicOps_setIRIGPulseWidth	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGPulseWidth handles the user request to set the 1PPS Pulse Width.

◆ RGBasicOps_setIRIGReferenceSource()

static nai_status_t RGBasicOps_setIRIGReferenceSource	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGReferenceSource handles the user request to set the requested reference source.

◆ RGBasicOps_setIRIGRTCControl()

static nai_status_t RGBasicOps_setIRIGRTCControl	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGRTCT sets the RTC for the specified IRIG channel if the ready bit is set.

◆ RGBasicOps_setIRIGRTCTime()

static nai_status_t RGBasicOps_setIRIGRTCTime	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGRTCT handles the user request to set the RTC (real-time clock) in hh:mm:ss and 00yy/mm/dd.

◆ RGBasicOps_setIRIGSerialSignalLevel()

static nai_status_t RGBasicOps_setIRIGSerialSignalLevel	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGSerialSignalLevel handles the user request to set the serial signal setting RS232 or RS485.

◆ RGBasicOps_setIRIGTimeZoneOffset()

static nai_status_t RGBasicOps_setIRIGTimeZoneOffset	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGTimeZoneOffset handles the user request to set the Number of minutes to be added to or subtracted from received IRIG reference time to accommodate time zone differences. Range : +/-1439.

◆ RGBasicOps_setIRIGYear()

static nai_status_t RGBasicOps_setIRIGYear	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGYear handles the user request to set the calendar Year.

◆ RGBasicOpsDST_getIRIGDSTStatus()

static nai_status_t RGBasicOpsDST_getIRIGDSTStatus	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_getIRIGDSTStatus handles the user request to view DST status.

◆ RGBasicOpsDST_setIRIGDSTEnd()

static nai_status_t RGBasicOpsDST_setIRIGDSTEnd	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGDSTEnd handles the user request to set when DST should end, in the structure of Month, Day of Week, Number of Week, Hour, and Minute.

◆ RGBasicOpsDST_setIRIGDSTOffset()

static nai_status_t RGBasicOpsDST_setIRIGDSTOffset	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGDSTOffset handles the user request to set IRIG DST offset in HMM. The format of the DST Offset register is 0xXXXXXHMM, where bytes 0 and 1 are minutes and byte 2 is hours.

◆ RGBasicOpsDST_setIRIGDSTStart()

static nai_status_t RGBasicOpsDST_setIRIGDSTStart	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_setIRIGDSTStart handles the user request to set when DST should start, in the structure of Month, Day of Week, Number of Week, Hour, and Minute.

◆ RGBasicOpsInterrupts_clearIRIGChannelStatus()

static nai_status_t RGBasicOpsInterrupts_clearIRIGChannelStatus	(	int32_t	paramCount,
		int32_t *	p_params )

static

◆ RGBasicOpsInterrupts_clearIRIGEventMappedStatus()

static nai_status_t RGBasicOpsInterrupts_clearIRIGEventMappedStatus	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOps_getIRIGEventMappedStatus handles the user request to view BIT status depending on desired event.

◆ RGBasicOpsInterrupts_getIRIGEventMappedStatus()

static nai_status_t RGBasicOpsInterrupts_getIRIGEventMappedStatus	(	int32_t	paramCount,
		int32_t *	p_params )

static

◆ RGBasicOpsInterrupts_setIRIGInterruptEdgeLevel()

static nai_status_t RGBasicOpsInterrupts_setIRIGInterruptEdgeLevel	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOpsInterrupts_setIRIGInterruptEdgeLevel handles the user request set Interrupt Edge Level for the Event status.

◆ RGBasicOpsInterrupts_setIRIGInterruptEnable()

static nai_status_t RGBasicOpsInterrupts_setIRIGInterruptEnable	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOpsInterrupts_setIRIGInterruptEnable handles the user request set Interrupt Enable for the Event status.

◆ RGBasicOpsInterrupts_setIRIGInterruptSteering()

static nai_status_t RGBasicOpsInterrupts_setIRIGInterruptSteering	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOpsInterrupts_setIRIGInterruptSteering handles the user request set Interrupt Steering for the Event status.

◆ RGBasicOpsInterrupts_setIRIGInterruptVector()

static nai_status_t RGBasicOpsInterrupts_setIRIGInterruptVector	(	int32_t	paramCount,
		int32_t *	p_params )

static

RGBasicOpsInterrupts_setIRIGInterruptVector handles the user request set Interrupt Vector for the Event status.

Variable Documentation

◆ CONFIG_FILE

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

static

◆ enableDisableStrings

int8_t enableDisableStrings[2][10]

Initial value:

= 
{
   "DISABLED",
   "ENABLED "
}

◆ interruptSteeringStrings

int8_t interruptSteeringStrings[6][75]

Initial value:

= 
{
   "VME",
   "ARM Custom Application (On Board 0) / NAI Ethernet Listener Application",
   "On Board 1 (Unused)",
   "On Board 2 (Unused)",
   "PCIe Bus",
   "CPCI Bus"
}

◆ interruptTriggerTypeStrings

int8_t interruptTriggerTypeStrings[2][10]

Initial value:

= 
{
   "EDGE ",
   "LEVEL"
}

◆ interruptTypeStrings

int8_t interruptTypeStrings[NAIBRD_IRIG_EVTMAP_STATUS_TYPE_ENUM_COUNT][40]

Initial value:

= 
{
   "BIT Data Loss",
   "BIT Data Loss",
   "BIT Software Fault",
   "BIT Software Fault",
   "IRIG Reference Lost",
   "IRIG Reference Lost",
   "Receiving IRIG Reference",
   "Receiving IRIG Reference",
   "IRIG Reference Pulse Received",
   "IRIG Reference Pulse Received",
   "Interrupt on 1PPS Output Going High",
   "Interrupt on 1PPS Output Going High",
   "Received Control Bits Changed",
   "Received Control Bits Changed",
   "Control Bits Received",
   "Control Bits Received",
   "Change In Reference Source",
   "Change In Reference Source",
   "Event Detected",
   "Event Detected",
   "Programmable-Duration User Interrupt",
   "Programmable-Duration User Interrupt",
   "Did a DST Adjust",
   "Did a DST Adjust",
   "Test Interrupt",
   "Test Interrupt"
}

◆ RG_BasicOps_BasicCmds

naiapp_cmdtbl_params_t RG_BasicOps_BasicCmds[]

Initial value:

=
{
   {"PR",      "Set IRIG Protocol",                   RG_BASICOPS_CMD_SET_PROTOCOL,                                   RGBasicOps_setIRIGProtocol },
   {"PRV",     "Set IRIG Protocol by Value",          RG_BASICOPS_CMD_SET_PROTOCOL_BY_VALUE,                          RGBasicOps_setIRIGProtocolByValue },
   {"G",       "Set IRIG Gain Control",               RG_BASICOPS_CMD_SET_GAIN,                                       RGBasicOps_setIRIGAMOutputGain },
   {"D",       "Set IRIG Drift Threshold",            RG_BASICOPS_CMD_SET_DRIFT_THRESHOLD,                            RGBasicOps_setIRIGDriftThreshold },
   {"RS",      "Set IRIG Reference Source",           RG_BASICOPS_CMD_SET_REFERENCE_SOURCE,                           RGBasicOps_setIRIGReferenceSource },
   {"CB",      "Set IRIG Control Bits to Send",       RG_BASICOPS_CMD_SET_CONTROL_BITS,                               RGBasicOps_setIRIGCtrlBitsToSend },
   {"CBR",     "View IRIG Control Bits Received",     RG_BASICOPS_CMD_GET_CONTROL_BITS_RECEIVED,                      RGBasicOps_getIRIGCtrlBitsReceived },
   {"DI",      "Set IRIG Digital Input",              RG_BASICOPS_CMD_SET_DIGITAL_INPUT,                              RGBasicOps_setIRIGDigitalInput },
   {"DO",      "Set IRIG Digital Output",             RG_BASICOPS_CMD_SET_DIGITAL_OUTPUT,                             RGBasicOps_setIRIGDigitalOutput },
   {"TZO",     "Set IRIG Time Zone Offset",           RG_BASICOPS_CMD_SET_TIME_ZONE_OFFSET,                           RGBasicOps_setIRIGTimeZoneOffset },
   {"O",       "Set Prop Offset",                     RG_BASICOPS_CMD_SET_PROP_OFFSET,                                RGBasicOps_setIRIGPropOffset },
   {"Y",       "Set IRIG Year",                       RG_BASICOPS_CMD_SET_YEAR,                                       RGBasicOps_setIRIGYear },
   {"PW",      "Set 1PPS Pulse Width",                RG_BASICOPS_CMD_SET_PULSE_WIDTH,                                RGBasicOps_setIRIGPulseWidth },
   {"FRT",     "Set Free Running Time",               RG_BASICOPS_CMD_SET_FREE_RUNNING_TIME,                          RGBasicOps_setIRIGFreeRunningTime },
   {"RTCT",    "Set RTC Time",                        RG_BASICOPS_CMD_SET_RTC_TIME,                                   RGBasicOps_setIRIGRTCTime },
   {"RTCC",    "Set RTC Control",                     RG_BASICOPS_CMD_SET_RTC_CONTROL,                                RGBasicOps_setIRIGRTCControl },
   {"CET",     "Set Capture Event Time",              RG_BASICOPS_CMD_SET_CAPTURE_EVENT_TIME,                         RGBasicOps_setIRIGCaptureEventTime },
   {"CEE",     "Set Capture Event Edge",              RG_BASICOPS_CMD_SET_CAPTURE_EVENT_EDGE,                         RGBasicOps_setIRIGCaptureEventEdge },
   {"SSL",     "Set Serial Signal Level",             RG_BASICOPS_CMD_SET_SERIAL_SIGNAL_LEVEL,                        RGBasicOps_setIRIGSerialSignalLevel },
   {"PIP",     "Set Period Interrupt Period",         RG_BASICOPS_CMD_SET_PERIOD_INTERRUPT_PERIOD,                    RGBasicOps_setIRIGPeriodicInterruptPeriod }
}

◆ RG_BasicOps_DSTCmds

naiapp_cmdtbl_params_t RG_BasicOps_DSTCmds[]

Initial value:

=
{
   {"DSTS",    "Get DST Status",         RG_BASICOPS_DST_CMD_GET_DST_STATUS,             RGBasicOpsDST_getIRIGDSTStatus },
   {"OFF",     "Set DST Offset",         RG_BASICOPS_DST_CMD_SET_DST_OFFSET,             RGBasicOpsDST_setIRIGDSTOffset },
   {"START",   "Set DST Start",          RG_BASICOPS_DST_CMD_SET_DST_START,              RGBasicOpsDST_setIRIGDSTStart  },
   {"END",     "Set DST End",            RG_BASICOPS_DST_CMD_SET_DST_END,                RGBasicOpsDST_setIRIGDSTEnd    }
}

◆ RG_BasicOps_InterruptCmds

naiapp_cmdtbl_params_t RG_BasicOps_InterruptCmds[]

Initial value:

=
{
   {"C",     "Clear All Event Mapped Status Bits",   RG_BASICOPS_INTERRUPTS_CLEAR,                                    RGBasicOpsInterrupts_clearIRIGChannelStatus },
   {"CS",    "Clear Specific Event Mapped Status Bit",RG_BASICOPS_INTERRUPTS_CLEARSPECIFIC,                           RGBasicOpsInterrupts_clearIRIGEventMappedStatus },
   {"E",     "Set Event Mapped Interrupt Enable",    RG_BASICOPS_INTERRUPTS_ENABLE,                                   RGBasicOpsInterrupts_setIRIGInterruptEnable },
   {"S",     "Set Event Mapped Interrupt Steering",  RG_BASICOPS_INTERRUPTS_STEERING,                                 RGBasicOpsInterrupts_setIRIGInterruptSteering },
   {"V",     "Set Event Mapped Interrupt Vector",    RG_BASICOPS_INTERRUPTS_VECTOR,                                   RGBasicOpsInterrupts_setIRIGInterruptVector },
   {"EL",    "Set Event Mapped Interrupt Edge Level",RG_BASICOPS_INTERRUPTS_EDGELEVEL,                                RGBasicOpsInterrupts_setIRIGInterruptEdgeLevel }
}

◆ RG_BasicOpsCmds

naiapp_cmdtbl_params_t RG_BasicOpsCmds[]

Initial value:

= 
{
   {"BAS", "IRIG Basic Menu",                       RG_BASICOPS_BASIC_MENU,     RGBasicOps_runBasicMenu},
   {"INT", "IRIG Interrupt Menu",                   RG_BASICOPS_INTERRUPT_MENU, RGBasicOps_runInterruptMenu},
   {"DST", "IRIG DST (Daylight Savings Time) Menu", RG_BASICOPS_DST_MENU,       RGBasicOps_runDSTMenu}
}

◆ SAMPLE_PGM_NAME

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

static

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ rg_basicOps_basic_commands

◆ rg_basicOps_commands

◆ rg_basicOps_DST_commands

◆ rg_basicOps_Interrupts_commands

Function Documentation

◆ RG_BasicOps()

◆ RGBasicOps_displayConfigurations()

◆ RGBasicOps_displayDSTSettings()

◆ RGBasicOps_displayInterrupts()

◆ RGBasicOps_getIRIGCtrlBitsReceived()

◆ RGBasicOps_getIRIGEventMappedStatus()

◆ RGBasicOps_run()

◆ RGBasicOps_runBasicMenu()

◆ RGBasicOps_runDSTMenu()

◆ RGBasicOps_runInterruptMenu()

◆ RGBasicOps_setIRIGAMOutputGain()

◆ RGBasicOps_setIRIGCaptureEventEdge()

◆ RGBasicOps_setIRIGCaptureEventTime()

◆ RGBasicOps_setIRIGCtrlBitsToSend()

◆ RGBasicOps_setIRIGDigitalInput()

◆ RGBasicOps_setIRIGDigitalOutput()

◆ RGBasicOps_setIRIGDriftThreshold()

◆ RGBasicOps_setIRIGEventMappedStatus()

◆ RGBasicOps_setIRIGFreeRunningTime()

◆ RGBasicOps_setIRIGInputAnalogTermEnable()

◆ RGBasicOps_setIRIGInputDigitalTermEnable()

◆ RGBasicOps_setIRIGPeriodicInterruptPeriod()

◆ RGBasicOps_setIRIGPropOffset()

◆ RGBasicOps_setIRIGProtocol()

◆ RGBasicOps_setIRIGProtocolByValue()

◆ RGBasicOps_setIRIGPulseWidth()

◆ RGBasicOps_setIRIGReferenceSource()

◆ RGBasicOps_setIRIGRTCControl()

◆ RGBasicOps_setIRIGRTCTime()

◆ RGBasicOps_setIRIGSerialSignalLevel()

◆ RGBasicOps_setIRIGTimeZoneOffset()

◆ RGBasicOps_setIRIGYear()

◆ RGBasicOpsDST_getIRIGDSTStatus()

◆ RGBasicOpsDST_setIRIGDSTEnd()

◆ RGBasicOpsDST_setIRIGDSTOffset()

◆ RGBasicOpsDST_setIRIGDSTStart()

◆ RGBasicOpsInterrupts_clearIRIGChannelStatus()

◆ RGBasicOpsInterrupts_clearIRIGEventMappedStatus()

◆ RGBasicOpsInterrupts_getIRIGEventMappedStatus()

◆ RGBasicOpsInterrupts_setIRIGInterruptEdgeLevel()

◆ RGBasicOpsInterrupts_setIRIGInterruptEnable()

◆ RGBasicOpsInterrupts_setIRIGInterruptSteering()

◆ RGBasicOpsInterrupts_setIRIGInterruptVector()

Variable Documentation

◆ CONFIG_FILE

◆ enableDisableStrings

◆ interruptSteeringStrings

◆ interruptTriggerTypeStrings

◆ interruptTypeStrings

◆ RG_BasicOps_BasicCmds

◆ RG_BasicOps_DSTCmds

◆ RG_BasicOps_InterruptCmds

◆ RG_BasicOpsCmds

◆ SAMPLE_PGM_NAME