hil_task_read_analog :: QUARC MATLAB Functions

navigation bar

hil_task_read_analog

Deprecated

The HIL API MATLAB functions have been deprecated in favour of the new quanser.hardware.hil class, which has support for code generation for Quanser targets. Hence, with the new hil class it is possible to run MATLAB scripts in real-time on Quanser targets, while making use of the Quanser hardware.

Reads the specified number of analog samples from the task's internal buffer.

Syntax

[voltages, samples_read, err] = hil_task_read_analog(task, samples)

Description

Reads the specified number of analog samples from the task's internal buffer. This function will block until the requested number of samples has been read or the task is stopped.

If no err output is provided then it throws an exception if an error occurs. In generated code it prints the error message. Use hil_get_error_message to get the message associated with an error code.

Parameters

task

Task handle returned by hil_task_create_analog_reader or hil_task_create_analog_reader_analog_writer.

samples

The number of samples to read. This number must be less than or equal to the internal buffer size assigned to the task in the hil_task_create_analog_reader or hil_task_create_analog_reader_analog_writer call.

Outputs

voltages

A matrix of analog voltages, as doubles. There is one row for each channel and one column for each sample.

samples_read

The number of samples read. This number will be equal to the number of samples specified unless the total number of samples specified in hil_task_start has expired or the task has been stopped.

err

A negative error code or zero on success.

Examples

% Creates a task to read analog channels 0 and 3, with an internal buffer of 1000 samples.
task = hil_task_create_analog_reader(board, 1000, [0 3]);

% Start the task using SYSTEM_CLOCK_1 at 1 kHz. Collect up to 5000 samples.
hil_task_start(task, -1, 1000, 5000);

% Reads 500 samples of analog channels 0 and 3. Takes 0.5 seconds to complete read.
for i=1:10
[volts, n] = hil_task_read_analog(task, 500);
...
end;

hil_task_stop(task);
hil_task_delete(task);