`digitalio` – Basic digital pin support¶

The digitalio module contains classes to provide access to basic digital IO.

All classes change hardware state and should be deinitialized when they are no longer needed if the program continues after use. To do so, either call deinit() or use a context manager. See Lifetime and ContextManagers for more info.

For example:

import digitalio
import board

pin = digitalio.DigitalInOut(board.LED)
print(pin.value)

This example will initialize the the device, read value and then deinit() the hardware.

Here is blinky:

import time
import digitalio
import board

led = digitalio.DigitalInOut(board.LED)
led.direction = digitalio.Direction.OUTPUT
while True:
    led.value = True
    time.sleep(0.1)
    led.value = False
    time.sleep(0.1)

For the essentials of digitalio, see the CircuitPython Essentials Learn guide

For more information on using digitalio, see this additional Learn guide

Available on these boards

8086 Commander
@sarfata shIRtty
AITHinker ESP32-C3S_Kit
AITHinker ESP32-C3S_Kit_2M
ARAMCON Badge 2019
ARAMCON2 Badge
ATMegaZero ESP32-S2
Adafruit BLM Badge
Adafruit CLUE nRF52840 Express
Adafruit Camera
Adafruit Circuit Playground Bluefruit
Adafruit Circuit Playground Express 4-H
Adafruit CircuitPlayground Express
Adafruit CircuitPlayground Express with Crickit libraries
Adafruit CircuitPlayground Express with displayio
Adafruit EdgeBadge
Adafruit Feather Bluefruit Sense
Adafruit Feather ESP32-S2 TFT
Adafruit Feather ESP32S2
Adafruit Feather ESP32S3 No PSRAM
Adafruit Feather M0 Adalogger
Adafruit Feather M0 Basic
Adafruit Feather M0 Express
Adafruit Feather M0 Express with Crickit libraries
Adafruit Feather M0 RFM69
Adafruit Feather M0 RFM9x
Adafruit Feather M4 CAN
Adafruit Feather M4 Express
Adafruit Feather MIMXRT1011
Adafruit Feather RP2040
Adafruit Feather STM32F405 Express
Adafruit Feather nRF52840 Express
Adafruit FunHouse
Adafruit Gemma M0
Adafruit Gemma M0 PyCon 2018
Adafruit Grand Central M4 Express
Adafruit Hallowing M4 Express
Adafruit ItsyBitsy M0 Express
Adafruit ItsyBitsy M4 Express
Adafruit ItsyBitsy RP2040
Adafruit ItsyBitsy nRF52840 Express
Adafruit KB2040
Adafruit LED Glasses Driver nRF52840
Adafruit Macropad RP2040
Adafruit MagTag
Adafruit Matrix Portal M4
Adafruit Metro ESP32S2
Adafruit Metro M0 Express
Adafruit Metro M4 Airlift Lite
Adafruit Metro M4 Express
Adafruit Metro nRF52840 Express
Adafruit Monster M4SK
Adafruit NeoKey Trinkey M0
Adafruit NeoPixel Trinkey M0
Adafruit ProxLight Trinkey M0
Adafruit PyGamer
Adafruit PyPortal
Adafruit PyPortal Pynt
Adafruit PyPortal Titano
Adafruit PyRuler
Adafruit Pybadge
Adafruit QT Py ESP32-S3 no psram
Adafruit QT Py ESP32C3
Adafruit QT Py ESP32S2
Adafruit QT Py M0
Adafruit QT Py M0 Haxpress
Adafruit QT Py RP2040
Adafruit QT2040 Trinkey
Adafruit Rotary Trinkey M0
Adafruit Slide Trinkey M0
Adafruit Trellis M4 Express
Adafruit Trinket M0
AloriumTech Evo M51
Arduino MKR Zero
Arduino MKR1300
Arduino Nano 33 BLE
Arduino Nano 33 IoT
Arduino Nano RP2040 Connect
Arduino Zero
Artisense Reference Design RD00
AtelierDuMaker nRF52840 Breakout
BDMICRO VINA-D21
BDMICRO VINA-D51
BLE-SS dev board Multi Sensor
BastBLE
BastWiFi
BlueMicro833
BlueMicro840
CP Sapling M0
CP Sapling M0 w/ SPI Flash
CP32-M4
Capable Robot Programmable USB Hub
Cedar Grove StringCar M0 Express
Challenger NB RP2040 WiFi
Challenger RP2040 LTE
Challenger RP2040 WiFi
Circuit Playground Express Digi-Key PyCon 2019
CircuitBrains Basic
CircuitBrains Deluxe
CrumpS2
Cytron Maker Feather AIoT S3
Cytron Maker Nano RP2040
Cytron Maker Pi RP2040
Diodes Delight Piunora
DynOSSAT-EDU-EPS
DynOSSAT-EDU-OBC
DynaLoRa_USB
ELECFREAKS PICO:ED
ESP 12k NodeMCU
ESP32-C3-DevKitM-1
ESP32-S2-DevKitC-1-N4
ESP32-S2-DevKitC-1-N4R2
ESP32-S3-Box-2.5
ESP32-S3-DevKitC-1-N8
ESP32-S3-DevKitC-1-N8R2
ESP32-S3-DevKitC-1-N8R8
ESP32-S3-DevKitM-1-N8
ESP32-S3-USB-OTG-N8
Electronic Cats Bast Pro Mini M0
Electronic Cats CatWAN USBStick
Electronic Cats Hunter Cat NFC
Electronic Cats NFC Copy Cat
Electronut Labs Blip
Electronut Labs Papyr
EncoderPad RP2040
Escornabot Makech
Espruino Pico
Espruino Wifi
Feather ESP32S2 without PSRAM
Feather MIMXRT1011
Feather MIMXRT1062
FeatherS2
FeatherS2 Neo
FeatherS2 PreRelease
FeatherS3
Fluff M0
Fomu
Franzininho WIFI w/Wroom
Franzininho WIFI w/Wrover
Gravitech Cucumber M
Gravitech Cucumber MS
Gravitech Cucumber R
Gravitech Cucumber RS
HMI-DevKit-1.1
Hacked Feather M0 Express with 8Mbyte SPI flash
HalloWing M0 Express
HexKyS2
HiiBot BlueFi
IMXRT1010-EVK
IkigaiSense Vita nRF52840
IoTs2
J&J Studios datum-Distance
J&J Studios datum-IMU
J&J Studios datum-Light
J&J Studios datum-Weather
Kaluga 1
LILYGO TTGO T-01C3
LILYGO TTGO T-OI PLUS
LILYGO TTGO T8 ESP32-S2
LILYGO TTGO T8 ESP32-S2 w/Display
LoC BeR M4 base board
MDBT50Q-DB-40
MDBT50Q-RX Dongle
MEOWBIT
MORPHEANS MorphESP-240
MakerDiary nRF52840 MDK
MakerDiary nRF52840 MDK USB Dongle
Makerdiary M60 Keyboard
Makerdiary Pitaya Go
Makerdiary nRF52840 M.2 Developer Kit
Melopero Shake RP2040
Meow Meow
Metro MIMXRT1011
MicroDev microC3
MicroDev microS2
Mini SAM M4
NUCLEO STM32F746
NUCLEO STM32F767
NUCLEO STM32H743
OPENMV-H7 R1
Oak Dev Tech BREAD2040
Oak Dev Tech Cast-Away RP2040
Oak Dev Tech PixelWing ESP32S2
Open Hardware Summit 2020 Badge
PCA10056 nRF52840-DK
PCA10059 nRF52840 Dongle
PCA10100 nRF52833 DK
PYB LR Nano V2
Particle Argon
Particle Boron
Particle Xenon
PewPew 10.2
PewPew LCD
PewPew M4
PicoPlanet
Pimoroni Badger 2040
Pimoroni Interstate 75
Pimoroni Keybow 2040
Pimoroni Motor 2040
Pimoroni PGA2040
Pimoroni Pico LiPo (16MB)
Pimoroni Pico LiPo (4MB)
Pimoroni PicoSystem
Pimoroni Plasma 2040
Pimoroni Servo 2040
Pimoroni Tiny 2040 (2MB)
Pimoroni Tiny 2040 (8MB)
ProS3
PyCubedv04
PyCubedv04-MRAM
PyCubedv05
PyCubedv05-MRAM
PyKey 18 Numpad
PyKey 44 Ergo
PyKey 60
PyKey 87 TKL
PyboardV1_1
RP2.65-F
RP2040 Stamp
Raspberry Pi 4B
Raspberry Pi Compute Module 4
Raspberry Pi Compute Module 4 IO Board
Raspberry Pi Pico
Raspberry Pi Zero
Raspberry Pi Zero 2W
Raspberry Pi Zero W
Robo HAT MM1 M4
S2Mini
S2Pico
SAM E54 Xplained Pro
SAM32v26
SPRESENSE
SSCI ISP1807 Dev Board
SSCI ISP1807 Micro Board
ST STM32F746G Discovery
STM32F411E_DISCO
STM32F412G_DISCO
STM32F4_DISCO
Saola 1 w/Wroom
Saola 1 w/Wrover
Seeed XIAO nRF52840 Sense
Seeeduino Wio Terminal
Seeeduino XIAO
Seeeduino XIAO KB
Seeeduino XIAO RP2040
Serpente
Silicognition LLC M4-Shim
Simmel
SparkFun LUMIDrive
SparkFun MicroMod RP2040 Processor
SparkFun MicroMod SAMD51 Processor
SparkFun MicroMod nRF52840 Processor
SparkFun Pro Micro RP2040
SparkFun Pro nRF52840 Mini
SparkFun Qwiic Micro
SparkFun RedBoard Turbo
SparkFun SAMD21 Dev Breakout
SparkFun SAMD21 Mini Breakout
SparkFun STM32 MicroMod Processor
SparkFun Teensy MicroMod Processor
SparkFun Thing Plus - RP2040
SparkFun Thing Plus - SAMD51
SparkFun Thing Plus - STM32
Sprite_v2b
StackRduino M0 PRO
Swan R5
TG-Boards' Datalore IP M4
TG-Watch
THUNDERPACK_v11
THUNDERPACK_v12
TTGO T8 ESP32-S2-WROOM
Targett Module Clip w/Wroom
Targett Module Clip w/Wrover
Teensy 4.0
Teensy 4.1
Teknikio Bluebird
The Open Book Feather
TinkeringTech ScoutMakes Azul
TinyS2
TinyS3
Trinket M0 Haxpress
UARTLogger II
W5100S-EVB-Pico
WarmBit BluePixel nRF52840
Waveshare RP2040-Zero
Winterbloom Big Honking Button
Winterbloom Sol
XinaBox CC03
XinaBox CS11
iLabs Challenger 840
iMX RT 1020 EVK
iMX RT 1060 EVK
keithp.com snekboard
micro:bit v2
nanoESP32-S2 w/Wrover
nanoESP32-S2 w/Wroom
ndGarage[n°] Bit6: FeatherSnow-v2
ndGarage[n°]Bit6:FeatherSnow
nice!nano
senseBox MCU
stm32f411ce-blackpill
stm32f411ce-blackpill-with-flash
uChip
uGame10

class digitalio.DriveMode¶

Defines the drive mode of a digital pin

Enum-like class to define the drive mode used when outputting digital values.

PUSH_PULL :DriveMode¶: Output both high and low digital values

OPEN_DRAIN :DriveMode¶: Output low digital values but go into high z for digital high. This is useful for i2c and other protocols that share a digital line.

class digitalio.DigitalInOut(pin: microcontroller.Pin)¶

Digital input and output

A DigitalInOut is used to digitally control I/O pins. For analog control of a pin, see the analogio.AnalogIn and analogio.AnalogOut classes.

Create a new DigitalInOut object associated with the pin. Defaults to input with no pull. Use switch_to_input() and switch_to_output() to change the direction.

Parameters: pin (Pin) – The pin to control

direction :Direction¶

The direction of the pin.

Setting this will use the defaults from the corresponding switch_to_input() or switch_to_output() method. If you want to set pull, value or drive mode prior to switching, then use those methods instead.

value :bool¶: The digital logic level of the pin.

drive_mode :DriveMode¶

The pin drive mode. One of:

digitalio.DriveMode.PUSH_PULL
digitalio.DriveMode.OPEN_DRAIN

pull :Optional[Pull]¶

The pin pull direction. One of:

digitalio.Pull.UP
digitalio.Pull.DOWN
None

Raises: AttributeError – if direction is OUTPUT.

deinit() → None¶: Turn off the DigitalInOut and release the pin for other use.

__enter__() → DigitalInOut¶: No-op used by Context Managers.

__exit__() → None¶: Automatically deinitializes the hardware when exiting a context. See Lifetime and ContextManagers for more info.

switch_to_output(value: bool = False, drive_mode: DriveMode = DriveMode.PUSH_PULL) → None¶

Set the drive mode and value and then switch to writing out digital values.

Parameters

value (bool) – default value to set upon switching
drive_mode (DriveMode) – drive mode for the output

switch_to_input(pull: Optional[Pull] = None) → None¶

Set the pull and then switch to read in digital values.

Parameters: pull (Pull) – pull configuration for the input

Example usage:

import digitalio
import board

switch = digitalio.DigitalInOut(board.SLIDE_SWITCH)
switch.switch_to_input(pull=digitalio.Pull.UP)
# Or, after switch_to_input
switch.pull = digitalio.Pull.UP
print(switch.value)

class digitalio.Direction¶

Defines the direction of a digital pin

Enum-like class to define which direction the digital values are going.

INPUT :Direction¶: Read digital data in

OUTPUT :Direction¶: Write digital data out

class digitalio.Pull¶

Defines the pull of a digital input pin

Enum-like class to define the pull value, if any, used while reading digital values in.

UP :Pull¶: When the input line isn’t being driven the pull up can pull the state of the line high so it reads as true.

DOWN :Pull¶: When the input line isn’t being driven the pull down can pull the state of the line low so it reads as false.

digitalio – Basic digital pin support¶

`digitalio` – Basic digital pin support¶