Struct riot_wrappers::adc::ADCLine

pub struct ADCLine(/* private fields */);

Available on riot_module_periph_adc only.

Implementations

impl ADCLine

pub unsafe fn init(line: adc_t) -> Result<Self, i32>

Initialize an ADC line and get it as a handle. This is declared as unsafe as it may only be called once. (A safe abstraction would need to check which RIOT devices have been initialized already).

This being unsafe is inconsistent with other subsystem wrappers that chose to not declare this unsafe; that inconsistency is tracked in https://github.com/RIOT-OS/rust-riot-wrappers/issues/59 and so far unresolved.

pub unsafe fn from_number(line: u32) -> Result<Self, i32>

Initialize an ADC line identified by the line number it is assigned on the board

Safety: See [init]

Trait Implementations

impl Channel<ADC> for ADCLine

type ID = u8

Channel ID type

fn channel() -> Self::ID

Get the specific ID that identifies this channel, for example 0_u8 for the first ADC channel, if Self::ID is u8.

impl OneShot<ADC, i32, ADCLine> for ADC

type Error = !

Error type returned by ADC methods

fn read(&mut self, pin: &mut ADCLine) -> Result<i32, !>

Request that the ADC begin a conversion on the specified pin