Struct FullDeviceStatus

pub struct FullDeviceStatus {

    pub cnt0_overflow: OverflowStatus,
    pub cnt0_aberr: DecodificationStatus,
    pub cnt0_zero: ZeroStatus,
    pub cnt1_overflow: OverflowStatus,
    pub cnt1_aberr: DecodificationStatus,
    pub cnt1_zero: ZeroStatus,
    pub cnt2_overflow: OverflowStatus,
    pub cnt2_aberr: DecodificationStatus,
    pub cnt2_zero: ZeroStatus,
    pub power_status: UndervoltageStatus,
    pub ref_reg_status: RegisterStatus,
    pub upd_reg_status: RegisterStatus,
    pub ref_cnt_status: OverflowStatus,
    pub ext_err_status: ErrorStatus,
    pub ext_warn_status: WarningStatus,
    pub comm_status: CommunicationStatus,
    pub tp_status: TouchProbeStatus,
    pub tpi_status: PinStatus,
    pub ssi_enabled: InterfaceStatus,
}

Full Device Status

This struct contains the full status of the device that is returned when reading the status registers. For most registers, reading the status will reset the status bits to Ok or the equivalent for the specific status.

Note: Even if you have only one counter configured, the full device status will still be reported, i.t., other counters (which don’t exist in your setup) will also be reported.

Fields

cnt0_overflow: OverflowStatus

Overflow of counter 0

cnt0_aberr: DecodificationStatus

Decodification error of AB inputs in counter 0

cnt0_zero: ZeroStatus

Zero status of counter 0

cnt1_overflow: OverflowStatus

Overflow of counter 1

cnt1_aberr: DecodificationStatus

Decodification error of AB inputs in counter 1

cnt1_zero: ZeroStatus

Zero status of counter 1

cnt2_overflow: OverflowStatus

Overflow of counter 2

cnt2_aberr: DecodificationStatus

Decodification error of AB inputs in counter 2

cnt2_zero: ZeroStatus

Zero status of counter 2

power_status: UndervoltageStatus

Power status: Has an undervoltage reset occured?

ref_reg_status: RegisterStatus

Reference register status: Is the reference register valid?

upd_reg_status: RegisterStatus

UPD register status: Is the UPD register valid?

ref_cnt_status: OverflowStatus

Reference counter status.

ext_err_status: ErrorStatus

External error status: Has an external error occured?

ext_warn_status: WarningStatus

External warning status: Has an external warning occured?

comm_status: CommunicationStatus

Communication status: Has a communication collision occured?

tp_status: TouchProbeStatus

Touch probe status: Are the TPx registers updated?

tpi_status: PinStatus

TPI pin status

ssi_enabled: InterfaceStatus

SSI enabled status: Is the SSI interface enabled?

Trait Implementations

impl Clone for FullDeviceStatus

fn clone(&self) -> FullDeviceStatus

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FullDeviceStatus

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

Formats the value using the given formatter.

impl Default for FullDeviceStatus

fn default() -> FullDeviceStatus

Returns the “default value” for a type.

impl PartialEq for FullDeviceStatus

fn eq(&self, other: &FullDeviceStatus) -> 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 Copy for FullDeviceStatus

impl Eq for FullDeviceStatus

impl StructuralPartialEq for FullDeviceStatus