`analogbufio` – Analog Buffered IO Hardware Support¶

The analogbufio module contains classes to provide access to analog-to-digital conversion and digital-to-analog (DAC) for multiple value transfer.

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.

TODO: For the essentials of analogbufio, see the CircuitPython Essentials Learn guide

TODO: For more information on using analogbufio, see this additional Learn guide

Available on these boards

01Space 0.42 OLED ESP32C3
0xCB Helios
42. Keebs Frood
AITHinker ESP32-C3S_Kit
AITHinker ESP32-C3S_Kit_2M
ATMegaZero ESP32-S2
Adafruit Camera
Adafruit Feather ESP32 V2
Adafruit Feather ESP32-S2 Reverse TFT
Adafruit Feather ESP32-S2 TFT
Adafruit Feather ESP32-S3 Reverse TFT
Adafruit Feather ESP32-S3 TFT
Adafruit Feather ESP32S2
Adafruit Feather ESP32S3 4MB Flash 2MB PSRAM
Adafruit Feather ESP32S3 No PSRAM
Adafruit Feather HUZZAH32
Adafruit Feather RP2040
Adafruit Feather RP2040 CAN
Adafruit Feather RP2040 DVI
Adafruit Feather RP2040 Prop-Maker
Adafruit Feather RP2040 RFM
Adafruit Feather RP2040 Scorpio
Adafruit Feather RP2040 ThinkInk
Adafruit Feather RP2040 USB Host
Adafruit FunHouse
Adafruit HUZZAH32 Breakout
Adafruit ItsyBitsy RP2040
Adafruit KB2040
Adafruit Macropad RP2040
Adafruit MagTag
Adafruit MatrixPortal S3
Adafruit Metro ESP32S2
Adafruit Metro ESP32S3
Adafruit Metro RP2040
Adafruit QT Py ESP32 PICO
Adafruit QT Py ESP32-S3 4MB Flash 2MB PSRAM
Adafruit QT Py ESP32-S3 no psram
Adafruit QT Py ESP32C3
Adafruit QT Py ESP32S2
Adafruit QT Py RP2040
Adafruit QT2040 Trinkey
Adafruit-Qualia-S3-RGB666
Arduino Nano ESP32
Arduino Nano RP2040 Connect
Artisense Reference Design RD00
BBQ20KBD
BLING!
BLOK
BPI-Bit-S2
BPI-Leaf-S3
BPI-PicoW-S3
BastWiFi
Bee-Data-Logger
Bee-Motion-S3
Bee-S3
BlizzardS3
COSMO-Pico
CRCibernetica IdeaBoard
Challenger NB RP2040 WiFi
Challenger RP2040 LTE
Challenger RP2040 LoRa
Challenger RP2040 SD/RTC
Challenger RP2040 SubGHz
Challenger RP2040 WiFi
Challenger RP2040 WiFi/BLE
CrumpS2
Cytron Maker Feather AIoT S3
Cytron Maker Nano RP2040
Cytron Maker Pi RP2040
Cytron Maker UNO RP2040
DFRobot Beetle ESP32-C3
DFRobot FireBeetle 2 ESP32-S3
Datanoise PicoADK
Deneyap Kart
Deneyap Kart 1A
Deneyap Kart 1A v2
Deneyap Kart G
Deneyap Mini
Deneyap Mini v2
E-Fidget
ELECFREAKS PICO:ED
ES3ink
ESP 12k NodeMCU
ESP32 Devkit V1
ESP32-C3-DevKitM-1
ESP32-C6-DevKitC-1-N8
ESP32-C6-DevKitM-1
ESP32-H2-DevKitM-1
ESP32-S2-DevKitC-1-N4
ESP32-S2-DevKitC-1-N4R2
ESP32-S2-DevKitC-1-N8R2
ESP32-S3-Box-2.5
ESP32-S3-Box-Lite
ESP32-S3-DevKitC-1-N32R8
ESP32-S3-DevKitC-1-N8
ESP32-S3-DevKitC-1-N8R2
ESP32-S3-DevKitC-1-N8R8
ESP32-S3-DevKitC-1-N8R8-with-HACKTABLET
ESP32-S3-DevKitM-1-N8
ESP32-S3-EYE
ESP32-S3-USB-OTG-N8
Electrolama minik
EncoderPad RP2040
Espressif ESP32-EYE
Espressif ESP32-LyraT
Espressif-ESP32-S3-LCD-EV-Board
FeatherS2
FeatherS2 Neo
FeatherS2 PreRelease
FeatherS3
Fig Pi
Flipper Zero Wi-Fi Dev
Franzininho WIFI w/Wroom
Franzininho WIFI w/Wrover
Gravitech Cucumber M
Gravitech Cucumber MS
Gravitech Cucumber R
Gravitech Cucumber RS
HMI-DevKit-1.1
Hack Club Sprig
Hardkernel Odroid Go
Heltec ESP32-S3-WIFI-LoRa-V3
HexKyS2
IoTs2
Kaluga 1
LILYGO T-DECK
LILYGO T-DISPLAY
LILYGO TEMBED ESP32S3
LILYGO TTGO T-01C3
LILYGO TTGO T-DISPLAY v1.1
LILYGO TTGO T-OI PLUS
LILYGO TTGO T8 ESP32-S2
LILYGO TTGO T8 ESP32-S2 w/Display
LOLIN S3 16MB Flash 8MB PSRAM
LOLIN S3 MINI 4MB Flash 2MB PSRAM
Lilygo T-watch 2020 V3
Luatos Core-ESP32C3
M5STACK STAMP-C3
M5Stack Atom Echo
M5Stack Atom Lite
M5Stack Atom Matrix
M5Stack Atom U
M5Stack AtomS3
M5Stack AtomS3 Lite
M5Stack AtomS3U
M5Stack Core Basic
M5Stack Core Fire
M5Stack Core2
M5Stack M5Paper
M5Stack Stick C
M5Stack Stick C Plus
M5Stack Timer Camera X
MORPHEANS MorphESP-240
MagiClick S3 N4R2
Maker badge by Czech maker
MakerFabs-ESP32-S3-Parallel-TFT-With-Touch-7inch
Maple Computing Elite-Pi
Melopero Shake RP2040
MicroDev microC3
MicroDev microS2
MixGo CE
NanoS3
Neuron
Oak Dev Tech BREAD2040
Oak Dev Tech Cast-Away RP2040
Oak Dev Tech PixelWing ESP32S2
Oxocard Artwork
Oxocard Connect
Oxocard Galaxy
Oxocard Science
Pajenicko PicoPad
Pimoroni Badger 2040
Pimoroni Badger 2040 W
Pimoroni Inky Frame 5.7
Pimoroni Interstate 75
Pimoroni Keybow 2040
Pimoroni Motor 2040
Pimoroni PGA2040
Pimoroni Pico DV Base W
Pimoroni Pico LiPo (16MB)
Pimoroni Pico LiPo (4MB)
Pimoroni Pico dv Base
Pimoroni PicoSystem
Pimoroni Plasma 2040
Pimoroni Plasma 2040W
Pimoroni Servo 2040
Pimoroni Tiny 2040 (2MB)
Pimoroni Tiny 2040 (8MB)
ProS3
PyKey 18 Numpad
PyKey 44 Ergo
PyKey 60
PyKey 87 TKL
RP2.65-F
RP2040 Stamp
Raspberry Breadstick
Raspberry Pi Pico
Raspberry Pi Pico W
S2Mini
S2Pico
Saola 1 w/Wroom
Saola 1 w/Wrover
Seeed Studio XIAO ESP32C3
Seeeduino XIAO RP2040
Silicognition LLC RP2040-Shim
SparkFun MicroMod RP2040 Processor
SparkFun Pro Micro RP2040
SparkFun Thing Plus - RP2040
TTGO T8 ESP32-S2-WROOM
Targett Module Clip w/Wroom
Targett Module Clip w/Wrover
TinyC6
TinyPICO
TinyPICO Nano
TinyS2
TinyS3
TinyWATCH S3
VCC-GND Studio YD RP2040
VCC-GND YD-ESP32-S3 (N16R8)
VCC-GND YD-ESP32-S3 (N8R8)
W5100S-EVB-Pico
W5500-EVB-Pico
Waveshare ESP32-S2-Pico
Waveshare ESP32-S2-Pico-LCD
Waveshare ESP32-S3-Pico
Waveshare ESP32-S3-Zero
Waveshare RP2040-LCD-0.96
Waveshare RP2040-LCD-1.28
Waveshare RP2040-Plus (16MB)
Waveshare RP2040-Plus (4MB)
Waveshare RP2040-TOUCH-LCD-1.28
Waveshare RP2040-Zero
WeAct ESP32-C6 (4MB)
WeAct ESP32-C6 (8MB)
WeAct Studio Pico
WeAct Studio Pico 16MB
Wemos Lolin C3 Mini" // from Wemos MP
Wemos Lolin C3 Pico" // from Wemos MP
WisdPi Ardu2040M
WisdPi Tiny RP2040
nanoESP32-S2 w/Wrover
nanoESP32-S2 w/Wroom
nullbits Bit-C PRO
splitkb.com Liatris
takayoshiotake Octave RP2040
uGame22

class analogbufio.BufferedIn(pin: microcontroller.Pin, *, sample_rate: int)¶

Capture multiple analog voltage levels to the supplied buffer

Usage:

import board
import analogbufio
import array

length = 1000
mybuffer = array.array("H", [0x0000] * length)
rate = 500000
adcbuf = analogbufio.BufferedIn(board.GP26, sample_rate=rate)
adcbuf.readinto(mybuffer)
adcbuf.deinit()
for i in range(length):
    print(i, mybuffer[i])

(TODO) The reference voltage varies by platform so use
``reference_voltage`` to read the configured setting.
(TODO) Provide mechanism to read CPU Temperature.

Create a BufferedIn on the given pin and given sample rate.

Parameters:

pin (Pin) – the pin to read from
sample_rate (~int) – rate: sampling frequency, in samples per second

deinit() → None¶: Shut down the BufferedIn and release the pin for other use.

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

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

readinto(buffer: circuitpython_typing.WriteableBuffer) → int¶

Fills the provided buffer with ADC voltage values.

ADC values will be read into the given buffer at the supplied sample_rate. Depending on the buffer typecode, ‘B’, ‘H’, samples are 8-bit byte-arrays or 16-bit half-words and are always unsigned. The ADC most significant bits of the ADC are kept. (See https://docs.circuitpython.org/en/latest/docs/library/array.html)

Parameters:: buffer (WriteableBuffer) – buffer: A buffer for samples

analogbufio – Analog Buffered IO Hardware Support¶

`analogbufio` – Analog Buffered IO Hardware Support¶