Struct Diagnostics 

pub struct Diagnostics { /* private fields */ }

Diagnostics flags from the DIAG_AGC register (0x3FFD)

Implementations

impl Diagnostics

pub const fn new(raw: u16) -> Self

Create diagnostics from raw register value

pub const fn raw(&self) -> u16

Get the raw register value

pub const fn comp_high(&self) -> bool

COMP_HIGH: Magnetic field too strong

Set when the magnetic field is above the recommended range The sensor may still work but accuracy could be affected

pub const fn comp_low(&self) -> bool

COMP_LOW: Magnetic field too weak

Set when the magnetic field is below the recommended range The sensor may still work but accuracy could be affected

pub const fn cordic_overflow(&self) -> bool

COF: CORDIC overflow

Set when an overflow occurred in the CORDIC calculation When this bit is set, angle and magnitude data is invalid

pub const fn offset_comp_finished(&self) -> bool

OCF: Offset compensation finished

This flag is set to 1 after power-up when the offset compensation algorithm has finished. After power-up, the flag remains at 1

pub const fn agc_value(&self) -> u8

Get the Automatic Gain Control (AGC) value

Returns an 8-bit value where:

• 0 = high magnetic field (close to sensor)
• 255 = low magnetic field (far from sensor)

Typical values are between 60-200. Values outside this range may indicate the magnet is too close or too far

pub const fn magnetic_field_ok(&self) -> bool

Check if the magnetic field strength is within acceptable range

Returns true if neither COMP_HIGH nor COMP_LOW is set

pub const fn is_valid(&self) -> bool

Check if data is valid

Returns true if there’s no CORDIC overflow and the magnetic field is within acceptable range

Trait Implementations

impl Clone for Diagnostics

fn clone(&self) -> Diagnostics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostics

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

Formats the value using the given formatter.

impl From<u16> for Diagnostics

fn from(raw: u16) -> Self

Converts to this type from the input type.

impl PartialEq for Diagnostics

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

impl Eq for Diagnostics

impl StructuralPartialEq for Diagnostics