Struct AdiEncoder 

pub struct AdiEncoder { /* private fields */ }

ADI encoder device. Requires two adi ports.

Implementations

impl AdiEncoder

pub fn new(ports: (AdiPort, AdiPort), reverse: bool) -> Result<Self, AdiError>

Create a new encoder from a top and bottom AdiPort.

If using an [AdiExpander], both ports must be on the same expander module.

pub fn zero(&mut self) -> Result<(), AdiError>

Resets the encoder to zero.

pub fn position(&self) -> Result<Position, AdiError>

Gets the number of ticks recorded by the encoder.

Trait Implementations

impl AdiDevice for AdiEncoder

type PortIndexOutput = (u8, u8)

The type that port_index should return. This is usually u8, but occasionally (u8, u8).

fn port_index(&self) -> Self::PortIndexOutput

Get the index of the AdiPort this device is registered on.

fn expander_port_index(&self) -> Option<u8>

Get the index of the AdiPort this device is registered on.

fn device_type(&self) -> AdiDeviceType

Get the variant of AdiDeviceType that this device is associated with.

impl Debug for AdiEncoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AdiEncoder

fn eq(&self, other: &AdiEncoder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for AdiEncoder

impl StructuralPartialEq for AdiEncoder