Struct teensyduino::gpio::Pin

pub struct Pin(_);

A container for a pin number that has been verified to exist This method was chosen to limit the use of unsafe when dealing with pins

See Also

• Digital Pins - Arduino Reference

Implementations

impl Pin

pub const unsafe fn new(pin: u8) -> Pin

Create a new Pin to drive a GPIO

Safety

The caller must verify that the pin provided is a valid pin on the board they are using. Passing an invalid pin number will result in undefined behavior

pub fn mode(&self, mode: PinMode)

Configures the specified pin to behave either as an input or an output. See the Digital Pins page for details on the functionality of the pins.

As of Arduino 1.0.1, it is possible to enable the internal pullup resistors with the mode INPUT_PULLUP. Additionally, the INPUT mode explicitly disables the internal pullups.

Notes and Warnings

The analog input pins can be used as digital pins, referred to as A0, A1, etc.

See Also

• pinMode - Arduino Reference

pub fn set_high(&self)

Set the pins output to high. A proxy for digital_write(true)

pub fn set_low(&self)

Set the pins output to low. A proxy for digital_write(false)

pub fn toggle(&self)

Set the pins output to the opposite of what it currently is

pub fn digital_write(&self, value: bool)

Write a HIGH (true) or a LOW (false) value to a digital pin.

If the pin has been configured as an OUTPUT with pinMode(), its voltage will be set to the corresponding value: 5V (or 3.3V on 3.3V boards) for HIGH, 0V (ground) for LOW.

If the pin is configured as an INPUT, digital_write() will enable (HIGH) or disable (LOW) the internal pullup on the input pin. It is recommended to set the mode() to PinMode::InputPullup to enable the internal pull-up resistor. See the Digital Pins tutorial for more information.

If you do not set the mode() to OUTPUT, and connect an LED to a pin, when calling digital_write(true), the LED may appear dim. Without explicitly setting mode(), digital_write() will have enabled the internal pull-up resistor, which acts like a large current-limiting resistor.

See Also

• digitalWrite() - Arduino Reference

pub fn digital_read(&self) -> bool

Reads the value from a specified digital pin, either HIGH or LOW.

Notes and Warnings

If the pin isn’t connected to anything, digitalRead() can return either HIGH or LOW (and this can change randomly).

The analog input pins can be used as digital pins, referred to as A0, A1, etc. The exception is the Arduino Nano, Pro Mini, and Mini’s A6 and A7 pins, which can only be used as analog inputs.

See Also

• digitalRead() - Arduino Reference

Trait Implementations

impl Into<u8> for Pin

fn into(self) -> u8

Performs the conversion.

impl<'_> Into<u8> for &'_ Pin

fn into(self) -> u8

Performs the conversion.

impl Tone for Pin

fn tone(&self, frequency: u16)

Generates a square wave of the specified frequency (and 50% duty cycle) on a pin. A duration can be specified, otherwise the wave continues until a call to noTone(). The pin can be connected to a piezo buzzer or other speaker to play tones.

fn tone_with_duration(&self, frequency: u16, duration: u64)

Generates a square wave of the specified frequency (and 50% duty cycle) on a pin. A duration can be specified, otherwise the wave continues until a call to noTone(). The pin can be connected to a piezo buzzer or other speaker to play tones.

fn no_tone(&self)

Stops the generation of a square wave triggered by tone(). Has no effect if no tone is being generated.