quanser.hardware.hil.set_encoder_filter_frequency

navigation bar

Sets the filter frequencies of the specified encoder channels.

Syntax

err = board.set_encoder_filter_frequency(channels, frequencies)

Description

Configures the filter frequencies of the specified encoder channels. Not all boards support configuration of the encoder filter frequencies. The driver for the board will round the given filter 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.

channels

A vector of channel numbers. Channel numbers are zero-based.

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

frequencies

A vector specifying the filter frequencies. There must be one element for each channel in the channels vector.

Outputs

err

A negative error code or zero on success.

Examples

% Sets filter frequencies of encoder channels 0, 3 and 5 to 10 kHz, 1 MHz and 100 kHz respectively.
board.set_encoder_filter_frequency([0 3 5], [10e3 1e6 100e3]);