Functions
HAL_DigitalHandle	HAL_InitializeDIOPort (HAL_PortHandle portHandle, HAL_Bool input, const char allocationLocation, int32_t status)
	Creates a new instance of a digital port.

HAL_Bool	HAL_CheckDIOChannel (int32_t channel)
	Checks if a DIO channel is valid.

void	HAL_FreeDIOPort (HAL_DigitalHandle dioPortHandle)
	Frees a DIO port.

void	HAL_SetDIOSimDevice (HAL_DigitalHandle handle, HAL_SimDeviceHandle device)
	Indicates the DIO channel is used by a simulated device.

HAL_DigitalPWMHandle	HAL_AllocateDigitalPWM (int32_t *status)
	Allocates a DO PWM Generator.

void	HAL_FreeDigitalPWM (HAL_DigitalPWMHandle pwmGenerator)
	Frees the resource associated with a DO PWM generator.

void	HAL_SetDigitalPWMRate (double rate, int32_t *status)
	Changes the frequency of the DO PWM generator.

void	HAL_SetDigitalPWMDutyCycle (HAL_DigitalPWMHandle pwmGenerator, double dutyCycle, int32_t *status)
	Configures the duty-cycle of the PWM generator.

void	HAL_SetDigitalPWMPPS (HAL_DigitalPWMHandle pwmGenerator, double dutyCycle, int32_t *status)
	Configures the digital PWM to be a PPS signal with specified duty cycle.

void	HAL_SetDigitalPWMOutputChannel (HAL_DigitalPWMHandle pwmGenerator, int32_t channel, int32_t *status)
	Configures which DO channel the PWM signal is output on.

void	HAL_SetDIO (HAL_DigitalHandle dioPortHandle, HAL_Bool value, int32_t *status)
	Writes a digital value to a DIO channel.

void	HAL_SetDIODirection (HAL_DigitalHandle dioPortHandle, HAL_Bool input, int32_t *status)
	Sets the direction of a DIO channel.

HAL_Bool	HAL_GetDIO (HAL_DigitalHandle dioPortHandle, int32_t *status)
	Reads a digital value from a DIO channel.

HAL_Bool	HAL_GetDIODirection (HAL_DigitalHandle dioPortHandle, int32_t *status)
	Reads the direction of a DIO channel.

void	HAL_Pulse (HAL_DigitalHandle dioPortHandle, double pulseLengthSeconds, int32_t *status)
	Generates a single digital pulse.

void	HAL_PulseMultiple (uint32_t channelMask, double pulseLengthSeconds, int32_t *status)
	Generates a single digital pulse on multiple channels.

HAL_Bool	HAL_IsPulsing (HAL_DigitalHandle dioPortHandle, int32_t *status)
	Checks a DIO line to see if it is currently generating a pulse.

HAL_Bool	HAL_IsAnyPulsing (int32_t *status)
	Checks if any DIO line is currently generating a pulse.

void	HAL_SetFilterSelect (HAL_DigitalHandle dioPortHandle, int32_t filterIndex, int32_t *status)
	Writes the filter index from the FPGA.

int32_t	HAL_GetFilterSelect (HAL_DigitalHandle dioPortHandle, int32_t *status)
	Reads the filter index from the FPGA.

void	HAL_SetFilterPeriod (int32_t filterIndex, int64_t value, int32_t *status)
	Sets the filter period for the specified filter index.

int64_t	HAL_GetFilterPeriod (int32_t filterIndex, int32_t *status)
	Gets the filter period for the specified filter index.

Detailed Description

Function Documentation

◆ HAL_AllocateDigitalPWM()

HAL_DigitalPWMHandle HAL_AllocateDigitalPWM ( int32_t * status )

Allocates a DO PWM Generator.

Parameters

[out] status Error status variable. 0 on success.

Returns: the allocated digital PWM handle

◆ HAL_CheckDIOChannel()

HAL_Bool HAL_CheckDIOChannel ( int32_t channel )

Checks if a DIO channel is valid.

Parameters

channel the channel number to check

Returns: true if the channel is valid, otherwise false

◆ HAL_FreeDigitalPWM()

void HAL_FreeDigitalPWM ( HAL_DigitalPWMHandle pwmGenerator )

Frees the resource associated with a DO PWM generator.

Parameters

[in] pwmGenerator the digital PWM handle

◆ HAL_FreeDIOPort()

void HAL_FreeDIOPort ( HAL_DigitalHandle dioPortHandle )

Frees a DIO port.

Parameters

dioPortHandle the DIO channel handle

◆ HAL_GetDIO()

HAL_Bool HAL_GetDIO	(	HAL_DigitalHandle	dioPortHandle,
		int32_t *	status )

Reads a digital value from a DIO channel.

Parameters

[in]	dioPortHandle	the digital port handle
[out]	status	Error status variable. 0 on success.

Returns: the state of the specified channel

◆ HAL_GetDIODirection()

HAL_Bool HAL_GetDIODirection	(	HAL_DigitalHandle	dioPortHandle,
		int32_t *	status )

Reads the direction of a DIO channel.

Parameters

[in]	dioPortHandle	the digital port handle
[out]	status	Error status variable. 0 on success.

Returns: true for input, false for output

◆ HAL_GetFilterPeriod()

int64_t HAL_GetFilterPeriod	(	int32_t	filterIndex,
		int32_t *	status )

Gets the filter period for the specified filter index.

Gets the filter period in FPGA cycles. Even though there are 2 different filter index domains (MXP vs HDR), ignore that distinction for now since it complicates the interface. Set status to NiFpga_Status_SoftwareFault if the filter values mismatch.

Parameters

[in]	filterIndex	the filter index, 0 - 2
[out]	status	Error status variable. 0 on success.

Returns: The number of FPGA cycles of the filter period.

◆ HAL_GetFilterSelect()

int32_t HAL_GetFilterSelect	(	HAL_DigitalHandle	dioPortHandle,
		int32_t *	status )

Reads the filter index from the FPGA.

Gets the filter index used to filter out short pulses.

Parameters

[in]	dioPortHandle	the digital port handle
[out]	status	Error status variable. 0 on success.

Returns: filterIndex the filter index (Must be in the range 0 - 3, where 0 means "none" and 1 - 3 means filter # filterIndex - 1)

◆ HAL_InitializeDIOPort()

HAL_DigitalHandle HAL_InitializeDIOPort	(	HAL_PortHandle	portHandle,
		HAL_Bool	input,
		const char *	allocationLocation,
		int32_t *	status )

Creates a new instance of a digital port.

Parameters

[in]	portHandle	the port handle to create from
[in]	input	true for input, false for output
[in]	allocationLocation	the location where the allocation is occurring (can be null)
[out]	status	Error status variable. 0 on success.

Returns: the created digital handle

◆ HAL_IsAnyPulsing()

HAL_Bool HAL_IsAnyPulsing ( int32_t * status )

Checks if any DIO line is currently generating a pulse.

Parameters

[out] status Error status variable. 0 on success.

Returns: true if a pulse on some line is in progress

◆ HAL_IsPulsing()

HAL_Bool HAL_IsPulsing	(	HAL_DigitalHandle	dioPortHandle,
		int32_t *	status )

Checks a DIO line to see if it is currently generating a pulse.

Parameters

[in]	dioPortHandle	the digital port handle
[out]	status	Error status variable. 0 on success.

Returns: true if a pulse is in progress, otherwise false

◆ HAL_Pulse()

void HAL_Pulse	(	HAL_DigitalHandle	dioPortHandle,
		double	pulseLengthSeconds,
		int32_t *	status )

Generates a single digital pulse.

Write a pulse to the specified digital output channel. There can only be a single pulse going at any time.

Parameters

[in]	dioPortHandle	the digital port handle
[in]	pulseLengthSeconds	the active length of the pulse (in seconds)
[out]	status	Error status variable. 0 on success.

◆ HAL_PulseMultiple()

void HAL_PulseMultiple	(	uint32_t	channelMask,
		double	pulseLengthSeconds,
		int32_t *	status )

Generates a single digital pulse on multiple channels.

Write a pulse to the channels enabled by the mask. There can only be a single pulse going at any time.

Parameters

[in]	channelMask	the channel mask
[in]	pulseLengthSeconds	the active length of the pulse (in seconds)
[out]	status	Error status variable. 0 on success.

◆ HAL_SetDigitalPWMDutyCycle()

void HAL_SetDigitalPWMDutyCycle	(	HAL_DigitalPWMHandle	pwmGenerator,
		double	dutyCycle,
		int32_t *	status )

Configures the duty-cycle of the PWM generator.

Parameters

[in]	pwmGenerator	the digital PWM handle
[in]	dutyCycle	the percent duty cycle to output [0..1]
[out]	status	Error status variable. 0 on success.

◆ HAL_SetDigitalPWMOutputChannel()

void HAL_SetDigitalPWMOutputChannel	(	HAL_DigitalPWMHandle	pwmGenerator,
		int32_t	channel,
		int32_t *	status )

Configures which DO channel the PWM signal is output on.

Parameters

[in]	pwmGenerator	the digital PWM handle
[in]	channel	the channel to output on
[out]	status	Error status variable. 0 on success.

◆ HAL_SetDigitalPWMPPS()

void HAL_SetDigitalPWMPPS	(	HAL_DigitalPWMHandle	pwmGenerator,
		double	dutyCycle,
		int32_t *	status )

Configures the digital PWM to be a PPS signal with specified duty cycle.

Parameters

[in]	pwmGenerator	the digital PWM handle
[in]	dutyCycle	the percent duty cycle to output [0..1]
[out]	status	Error status variable. 0 on success.

◆ HAL_SetDigitalPWMRate()

void HAL_SetDigitalPWMRate	(	double	rate,
		int32_t *	status )

Changes the frequency of the DO PWM generator.

The valid range is from 0.6 Hz to 19 kHz.

The frequency resolution is logarithmic.

Parameters

[in]	rate	the frequency to output all digital output PWM signals
[out]	status	Error status variable. 0 on success.

◆ HAL_SetDIO()

void HAL_SetDIO	(	HAL_DigitalHandle	dioPortHandle,
		HAL_Bool	value,
		int32_t *	status )

Writes a digital value to a DIO channel.

Parameters

[in]	dioPortHandle	the digital port handle
[in]	value	the state to set the digital channel (if it is configured as an output)
[out]	status	Error status variable. 0 on success.

◆ HAL_SetDIODirection()

void HAL_SetDIODirection	(	HAL_DigitalHandle	dioPortHandle,
		HAL_Bool	input,
		int32_t *	status )

Sets the direction of a DIO channel.

Parameters

[in]	dioPortHandle	the digital port handle
[in]	input	true to set input, false for output
[out]	status	Error status variable. 0 on success.

◆ HAL_SetDIOSimDevice()

void HAL_SetDIOSimDevice	(	HAL_DigitalHandle	handle,
		HAL_SimDeviceHandle	device )

Indicates the DIO channel is used by a simulated device.

Parameters

handle	the DIO channel handle
device	simulated device handle

◆ HAL_SetFilterPeriod()

void HAL_SetFilterPeriod	(	int32_t	filterIndex,
		int64_t	value,
		int32_t *	status )

Sets the filter period for the specified filter index.

Sets the filter period in FPGA cycles. Even though there are 2 different filter index domains (MXP vs HDR), ignore that distinction for now since it complicates the interface. That can be changed later.

Parameters

[in]	filterIndex	the filter index, 0 - 2
[in]	value	the number of cycles that the signal must not transition to be counted as a transition.
[out]	status	Error status variable. 0 on success.

◆ HAL_SetFilterSelect()

void HAL_SetFilterSelect	(	HAL_DigitalHandle	dioPortHandle,
		int32_t	filterIndex,
		int32_t *	status )

Writes the filter index from the FPGA.

Set the filter index used to filter out short pulses.

Parameters

[in]	dioPortHandle	the digital port handle
[in]	filterIndex	the filter index (Must be in the range 0 - 3, where 0 means "none" and 1 - 3 means filter # filterIndex 1)
[out]	status	Error status variable. 0 on success.

Functions

Detailed Description

Function Documentation

◆ HAL_AllocateDigitalPWM()

◆ HAL_CheckDIOChannel()

◆ HAL_FreeDigitalPWM()

◆ HAL_FreeDIOPort()

◆ HAL_GetDIO()

◆ HAL_GetDIODirection()

◆ HAL_GetFilterPeriod()

◆ HAL_GetFilterSelect()

◆ HAL_InitializeDIOPort()

◆ HAL_IsAnyPulsing()

◆ HAL_IsPulsing()

◆ HAL_Pulse()

◆ HAL_PulseMultiple()

◆ HAL_SetDigitalPWMDutyCycle()

◆ HAL_SetDigitalPWMOutputChannel()

◆ HAL_SetDigitalPWMPPS()

◆ HAL_SetDigitalPWMRate()

◆ HAL_SetDIO()

◆ HAL_SetDIODirection()

◆ HAL_SetDIOSimDevice()

◆ HAL_SetFilterPeriod()

◆ HAL_SetFilterSelect()