quanser.hardware.hil.set_clock_frequency

navigation bar

Sets the frequencies of the specified hardware clocks.

Syntax

err = board.set_clock_frequency(clocks, frequencies)

Description

Configures the frequencies of the specified hardware clocks. Not all boards support configuration of the hardware clock frequencies. The driver for the board will round the given frequencies to the nearest achievable values.

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

board

The board instance returned by the quanser.hardware.hil.open function.

clocks

A vector of clock numbers. Clock numbers are zero-based.

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

frequencies

A vector specifying the clock frequencies. There must be one element for each clock in the clocks vector. If a value of zero is specified then the corresponding clock is disabled.

Outputs

err

A negative error code or zero on success.

Examples

% Sets frequencies of hardware clocks 0, 3 and 5 to 10 kHz, 1 MHz and 100 kHz respectively.
board.set_clock_frequency([0 3 5], [10e3 1e6 100e3]);