Analog Output Functions

Functions
HAL_AnalogOutputHandle	HAL_InitializeAnalogOutputPort (HAL_PortHandle portHandle, const char *allocationLocation, int32_t *status)
	Initializes the analog output port using the given port object. More...
void	HAL_FreeAnalogOutputPort (HAL_AnalogOutputHandle analogOutputHandle)
	Frees an analog output port. More...
void	HAL_SetAnalogOutput (HAL_AnalogOutputHandle analogOutputHandle, double voltage, int32_t *status)
	Sets an analog output value. More...
double	HAL_GetAnalogOutput (HAL_AnalogOutputHandle analogOutputHandle, int32_t *status)
	Gets the current analog output value. More...
HAL_Bool	HAL_CheckAnalogOutputChannel (int32_t channel)
	Checks that the analog output channel number is valid. More...

Detailed Description

Function Documentation

HAL_CheckAnalogOutputChannel()

HAL_Bool HAL_CheckAnalogOutputChannel

(

int32_t

channel

)

Checks that the analog output channel number is valid.

Verifies that the analog channel number is one of the legal channel numbers. Channel numbers are 0-based.

Returns

Analog channel is valid

HAL_FreeAnalogOutputPort()

void HAL_FreeAnalogOutputPort

(

HAL_AnalogOutputHandle

analogOutputHandle

)

Frees an analog output port.

Parameters

analogOutputHandle

the analog output handle

HAL_GetAnalogOutput()

double HAL_GetAnalogOutput	(	HAL_AnalogOutputHandle	analogOutputHandle,
		int32_t *	status
	)

Gets the current analog output value.

Parameters

[in]	analogOutputHandle	the analog output handle
[out]	status	Error status variable. 0 on success.

Returns

the current output voltage (0-5v)

HAL_InitializeAnalogOutputPort()

HAL_AnalogOutputHandle HAL_InitializeAnalogOutputPort	(	HAL_PortHandle	portHandle,
		const char *	allocationLocation,
		int32_t *	status
	)

Initializes the analog output port using the given port object.

Parameters

[in]	portHandle	handle to the port
[in]	allocationLocation	the location where the allocation is occurring (can be null)
[out]	status	Error status variable. 0 on success.

Returns

the created analog output handle

HAL_SetAnalogOutput()

void HAL_SetAnalogOutput	(	HAL_AnalogOutputHandle	analogOutputHandle,
		double	voltage,
		int32_t *	status
	)

Sets an analog output value.

Parameters

[in]	analogOutputHandle	the analog output handle
[in]	voltage	the voltage (0-5v) to output
[out]	status	Error status variable. 0 on success.