Struct esp_ward::peripherals::joystick::Joystick

source ·
pub struct Joystick<SELECT: InputPin> {
    pub select: Button<SELECT>,
    pub x_axis: AdcPin<GpioPin<Analog, 1>, ADC1>,
    pub y_axis: AdcPin<GpioPin<Analog, 3>, ADC1>,
}
Expand description

Represents a joystick with two axes and a select button.

Fields§

§select: Button<SELECT>

The select button of the joystick, wrapped in a Button struct for debouncing.

§x_axis: AdcPin<GpioPin<Analog, 1>, ADC1>

The analog input pin for the X-axis.

§y_axis: AdcPin<GpioPin<Analog, 3>, ADC1>

The analog input pin for the Y-axis.

Implementations§

source§

impl<SELECT: InputPin<Error = Infallible>> Joystick<SELECT>

source

pub fn get_axes(&mut self, adc: &mut ADC<'_, ADC1>) -> (u16, u16)

Retrieves the current positions of both axes.

§Arguments
  • adc - The ADC instance to read the values from the analog pins.
§Returns

Returns a tuple (u16, u16) where the first element is the X-axis value and the second is the Y-axis value.

source

pub fn get_x(&mut self, adc: &mut ADC<'_, ADC1>) -> u16

Retrieves the current position of the X-axis.

§Arguments
  • adc - The ADC instance to read the value from the analog pin.
§Returns

Returns a u16 representing the X-axis value.

source

pub fn get_y(&mut self, adc: &mut ADC<'_, ADC1>) -> u16

Retrieves the current position of the Y-axis.

§Arguments
  • adc - The ADC instance to read the value from the analog pin.
§Returns

Returns a u16 representing the Y-axis value.

source

pub fn select_pressed(&mut self, delay: Delay) -> bool

Checks if the select button is currently pressed.

§Arguments
  • delay - A delay provider for debouncing the button press.
§Returns

Returns true if the select button is pressed; otherwise false.

Auto Trait Implementations§

§

impl<SELECT> Freeze for Joystick<SELECT>
where SELECT: Freeze,

§

impl<SELECT> RefUnwindSafe for Joystick<SELECT>
where SELECT: RefUnwindSafe,

§

impl<SELECT> Send for Joystick<SELECT>
where SELECT: Send,

§

impl<SELECT> Sync for Joystick<SELECT>
where SELECT: Sync,

§

impl<SELECT> Unpin for Joystick<SELECT>
where SELECT: Unpin,

§

impl<SELECT> UnwindSafe for Joystick<SELECT>
where SELECT: UnwindSafe,

Blanket Implementations§

§

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

§

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.
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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.
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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<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> 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.
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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.
§

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.