Struct vex_rt::adi::AdiEncoder

pub struct AdiEncoder { /* private fields */ }

A struct which represents a V5 ADI port configured as an ADI encoder.

Implementations

impl AdiEncoder

pub unsafe fn new(
    top_port: u8,
    bottom_port: u8,
    reverse: bool,
    extender_port: u8
) -> Result<AdiEncoder, AdiEncoderError>

Initializes and enables a quadrature encoder on two ADI ports.

Safety

This function is unsafe because it allows the user to create multiple mutable references to the same ADI encoder. You likely want to implement Robot::new() instead.

pub fn reset(&mut self) -> Result<(), AdiEncoderError>

Resets the encoder to zero. It is safe to use this method while an encoder is enabled. It is not necessary to call this method before stopping or starting an encoder.

pub fn get(&self) -> Result<i32, AdiEncoderError>

Gets the number of ticks recorded by the encoder. There are 360 ticks in one revolution.

Trait Implementations

impl Drop for AdiEncoder

fn drop(&mut self)

Executes the destructor for this type.

impl TryFrom<(AdiPort, AdiPort)> for AdiEncoder

fn try_from(ports: (AdiPort, AdiPort)) -> Result<Self, Self::Error>

Converts an (AdiPort, AdiPort) into an AdiEncoder.

type Error = AdiEncoderError

The type returned in the event of a conversion error.