quanser.hardware.task.write_pwm :: QUARC MATLAB Functions

navigation bar

quanser.hardware.task.write_pwm

Writes the specified PWM samples to the task's internal buffer.

Syntax

[samples_written, err] = task.write_pwm(duty_cycles)

Description

Writes the specified PWM samples to the task's internal buffer. The number of samples is determined by the number of columns in the duty_cycles matrix and must be less than or equal to the internal buffer size assigned to the task in the quanser.hardware.hil.task_create_pwm_writer or quanser.hardware.hil.task_create_encoder_reader_pwm_writer call. This function will block until the requested number of samples can be written or the task is stopped. Note that the samples are only transferred to the internal buffer. The samples may not appear at the outputs until later. Use task.flush to wait for all samples to be written to the outputs.

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 instance returned by quanser.hardware.hil.task_create_pwm_writer or quanser.hardware.hil.task_create_encoder_reader_pwm_writer.

duty_cycles

A matrix of PWM duty cycles. There must be one row for each channel and one column for each sample.

Outputs

samples_written

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

err

A negative error code or zero on success.

Examples

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

% Uniformly distributed random duty_cycles between -5V and +5V.
cycles = 5*(rand(2,500)-0.5)*2;

% Writes 500 samples to PWM channels 0 and 3. Won't block until internal buffer full.
task.write_pwm(cycles);

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

for i=1:10
    % Uniformly distributed random duty_cycles between -5V and +5V.
    cycles = 5*(rand(2,500)-0.5)*2;

    % Writes 500 samples to PWM channels 0 and 3. Won't block until internal buffer full.
    n = task.write_pwm(cycles);
    ...
end;

% Make sure any samples remaining in the internal buffer have been written to the outputs.
task.flush;
task.stop;
task.close;