Struct nrf52840_hal::comp::Comp

source ·
pub struct Comp { /* private fields */ }
Expand description

A safe wrapper around the COMP peripheral.

Implementations§

source§

impl Comp

source

pub fn new<P>(comp: COMP, input_pin: &P) -> Comp
where P: CompInputPin,

Takes ownership of the COMP peripheral, returning a safe wrapper.

source

pub fn power_mode(&self, mode: PowerMode) -> &Comp

Sets the speed and power mode of the comparator.

source

pub fn vref(&self, vref: VRef) -> &Comp

Sets Vref of the comparator in single ended mode.

source

pub fn aref_pin<P>(&self, ref_pin: &P) -> &Comp
where P: CompRefPin,

Sets analog reference pin.

source

pub fn differential<P>(&self, ref_pin: &P) -> &Comp
where P: CompRefPin,

Sets comparator mode to differential with external Vref pin.

source

pub fn hysteresis_threshold_up(&self, value: u8) -> &Comp

Upward hysteresis threshold in single ended mode Vup = (value+1)/64*Vref.

source

pub fn hysteresis_threshold_down(&self, value: u8) -> &Comp

Downward hysteresis threshold in single ended mode Vdown = (value+1)/64*Vref.

source

pub fn hysteresis(&self, enabled: bool) -> &Comp

Enables/disables differential comparator hysteresis (50mV).

source

pub fn enable_interrupt(&self, event: Transition) -> &Comp

Enables COMP_LPCOMP interrupt triggering on the specified event.

source

pub fn disable_interrupt(&self, event: Transition) -> &Comp

Disables COMP_LPCOMP interrupt triggering on the specified event.

source

pub fn enable(&self)

Enables the comparator and waits until it’s ready to use.

source

pub fn disable(&self)

Disables the comparator.

source

pub fn is_up(&self) -> bool

Checks if the Up transition event has been triggered.

source

pub fn is_down(&self) -> bool

Checks if the Down transition event has been triggered.

source

pub fn is_cross(&self) -> bool

Checks if the Cross transition event has been triggered.

source

pub fn event_up(&self) -> &Reg<EVENTS_UP_SPEC>

Returns reference to Up transition event endpoint for PPI.

source

pub fn event_down(&self) -> &Reg<EVENTS_DOWN_SPEC>

Returns reference to Down transition event endpoint for PPI.

source

pub fn event_cross(&self) -> &Reg<EVENTS_CROSS_SPEC>

Returns reference to Cross transition event endpoint for PPI.

source

pub fn reset_event(&self, event: Transition)

Marks event as handled.

source

pub fn reset_events(&self)

Marks all events as handled.

source

pub fn read(&self) -> CompResult

Returns the output state of the comparator.

source

pub fn free(self) -> COMP

Consumes self and returns back the raw COMP peripheral.

Auto Trait Implementations§

§

impl Freeze for Comp

§

impl RefUnwindSafe for Comp

§

impl Send for Comp

§

impl !Sync for Comp

§

impl Unpin for Comp

§

impl UnwindSafe for Comp

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

source§

fn lossy_into(self) -> Dst

Performs the conversion.
source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.