Struct AnalogInput

Source

pub struct AnalogInput { /* private fields */ }

Expand description

Represents an analog sensor of unspecified type: an Input Device that reads analog values from an ANALOG compatible pin. https://docs.arduino.cc/built-in-examples/analog/AnalogInput

Implementations§

Source §

impl AnalogInput

Source

pub fn new<T: Into<PinIdOrName>>( board: &dyn Hardware, analog_pin: T, ) -> Result<Self, Error>

Creates an instance of an AnalogInput attached to a given board: https://docs.arduino.cc/built-in-examples/analog/AnalogInput/

§Errors

UnknownPin: this function will bail an error if the AnalogInput pin does not exist for this board.
IncompatiblePin: this function will bail an error if the AnalogInput pin does not support ANALOG mode.

Source

pub fn get_pin(&self) -> u8

Returns the pin (id) used by the device.

Source

pub fn attach(&self)

Manually attaches the AnalogInput with the value change events. This should never be needed unless you manually detach() the AnalogInput first for some reason and want it to start being reactive to events again.

Source

pub fn detach(&self)

Detaches the interval associated with the AnalogInput. This means the AnalogInput won’t react anymore to value changes.

Source

pub fn on<S, F, T, Fut>(&self, event: S, callback: F) -> EventHandler
where S: Into<String>, T: 'static + Send + Sync + Clone, F: FnMut(T) -> Fut + Send + 'static, Fut: Future<Output = Result<(), Error>> + Send + 'static,

Registers a callback to be executed on a given event.

Available events for an analog input are:

InputEvent::OnChange | change: Triggered when the AnalogInput value changes.
The callback must receive the following parameter: |value: u16| { ... }

§Example

use hermes_five::hardware::{Board, BoardEvent};
use hermes_five::devices::{AnalogInput, InputEvent};

#[hermes_five::runtime]
async fn main() {
    let board = Board::run();
    board.on(BoardEvent::OnReady, |board: Board| async move {

        // Register a Sensor on pin 14 (A0).
        let potentiometer = AnalogInput::new(&board, "A0")?;
        // Triggered function when the sensor state changes.
        potentiometer.on(InputEvent::OnChange, |value: u16| async move {
            println!("Sensor value changed: {}", value);
            Ok(())
        });

        // The above code will run forever.
        // <do something useful>

        // The above code will run forever runs a listener on the pin state under-the-hood.
        // It means the program will run forever listening to the InputEvent,
        // until we detach the device and close the board.
        potentiometer.detach();
        board.close();

        Ok(())
    });
}