Struct microbit::hal::comp::Comp

pub struct Comp { /* private fields */ }

A safe wrapper around the COMP peripheral.

Implementations

impl Comp

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

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

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

Sets the speed and power mode of the comparator.

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

Sets Vref of the comparator in single ended mode.

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

Sets analog reference pin.

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

Sets comparator mode to differential with external Vref pin.

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

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

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

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

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

Enables/disables differential comparator hysteresis (50mV).

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

Enables COMP_LPCOMP interrupt triggering on the specified event.

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

Disables COMP_LPCOMP interrupt triggering on the specified event.

pub fn enable(&self)

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

pub fn disable(&self)

Disables the comparator.

pub fn is_up(&self) -> bool

Checks if the Up transition event has been triggered.

pub fn is_down(&self) -> bool

Checks if the Down transition event has been triggered.

pub fn is_cross(&self) -> bool

Checks if the Cross transition event has been triggered.

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

Returns reference to Up transition event endpoint for PPI.

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

Returns reference to Down transition event endpoint for PPI.

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

Returns reference to Cross transition event endpoint for PPI.

pub fn reset_event(&self, event: Transition)

Marks event as handled.

pub fn reset_events(&self)

Marks all events as handled.

pub fn read(&self) -> CompResult

Returns the output state of the comparator.

pub fn free(self) -> COMP

Consumes self and returns back the raw COMP peripheral.