hil_set_analog_input_ranges :: Quanser C Functions

navigation bar

hil_set_analog_input_ranges

Sets the ranges of the analog inputs.

Description

The hil_set_analog_input_ranges function sets the ranges of the analog inputs. Not all cards support programmable input ranges. Some cards only allow the ranges of all inputs to be set to the same value, rather than allowing each analog input to have a separate input range. Refer to the documentation for your card for details on the features supported by the card.

The units for the minimum and maximum values are typically Volts, but may be Amps or a unit appropriate to the specific card.

Prototype

t_error
hil_set_analog_input_ranges(t_card card, const t_uint32 analog_channels[], t_uint32 num_channels,
                            const t_double minimums[], const t_double maximums[]);

Parameters

t_card card

A handle to the board, as returned by hil_open.

const t_uint32 * analog_channels

An array containing the numbers of the analog input channels whose ranges will be configured. Channel numbers are zero-based. Thus, channel 0 is the first channel, channel 1 the second channel, etc.

Select a board type from the list for board-specific details: .

t_uint32 num_channels

The number of channels specified in the analog_channels, minimums and maximums arrays.

const t_double * minimums

An array of doubles (t_double) containing the minimum value of the input range for the corresponding channel in the analog_channels array. This array must be the same size as the analog_channels array.

const t_double * maximums

An array of doubles (t_double) containing the maximum value of the input range for the corresponding channel in the analog_channels array. This array must be the same size as the analog_channels array.

Return value

The return value is 0 if the analog input ranges are configured successfully. Otherwise a negative error code is returned. Error codes are defined in quanser_errors.h. A suitable error message may be retrieved using msg_get_error_message.

Error codes

QERR_HIL_SET_ANALOG_INPUT_RANGES_NOT_SUPPORTED

This function is not supported by the board-specific HIL driver for this board type.

QERR_INVALID_CARD_HANDLE

An invalid card handle was passed as an argument. Once a card has been closed using hil_close the card handle is invalid.

QERR_TOO_MANY_ANALOG_INPUT_CHANNELS

Too many analog input channels were specified.

QERR_INVALID_ANALOG_INPUT_CHANNEL

One of the analog input channels that was specified is not a valid channel number. Channel numbers range from 0 to one less than the number of channels.

QERR_MISSING_ANALOG_INPUTS

The array of analog input channels is NULL even though the number of analog inputs specified is non-zero.

QERR_MISSING_ANALOG_MINIMUMS

The array of minimum values is NULL even though the number of channels specified is non-zero.

QERR_MISSING_ANALOG_MAXIMUMS

The array of maximum values is NULL even though the number of channels specified is non-zero.

Requirements

Include Files	Libraries
hil.h	hil.lib;quanser_runtime.lib;quanser_common.lib

Examples

/*
* Set the range of analog input #0 to ±10V, the range of analog input #3 to 0..5V
* and the range of input #5 to ±5V.
*/
t_uint32 channels[] = {  0,  3,  5 };
t_double minimums[] = { -10, 0, -5 };
t_double maximums[] = { +10, 5, +5 };
t_error  result = hil_set_analog_input_ranges(card, channels, ARRAY_LENGTH(channels), minimums, maximums);