adafruit / adafruit/Adafruit_CircuitPython_PIO_UART

Implement receiver_buffer_size kwarg

Open
#5 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
11
Forks
4
PR merge metrics
No merged PRs in 30d

Description

Implement `receiver_buffer_size` kwarg to match `busio`:
https://docs.circuitpython.org/en/latest/shared-bindings/busio/index.html#busio.UART

Ideally using background read so the library doesn't block when awaiting (larger) chunks of data.

Motivation: PIO FIFOs are very limited in size. Lower baudrates and / or hardware flow control can help in some use cases.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the repository's existing UART API and compare it with the linked busio.UART documentation, especially receiver_buffer_size behavior. Determine how reads currently interact with the PIO FIFO before deciding how background reads should work. Done means the kwarg matches busio and awaiting larger chunks does not block, with behavior suitable for the limited PIO FIFO.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
embedded-iot
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.