Repository navigation
Fix port-support lists and other documentation - #11926
Merged
Merged
Conversation
Fix Limitations docstrings that left out ports or chips or named the wrong ones, and list where a feature is available where practical. Change RP2040-only notes that also apply to RP2350 to say RP2xxx. Warn against holding busio I2C and SPI locks for a long time, which can starve WiFi and USB on Espressif. Document which errno codes are available on which builds, with code comments next to the errno lists pointing to errno.rst. Fixes adafruit#11877. Fixes adafruit#10561. Fixes adafruit#9737. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
On Zephyr-based nRF boards, a NACKed zero-length write can end the next transfer early when the bus runs at 400 kHz, so probe() and scan() can give wrong results. The cause is in nrfx; see adafruit#11604. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
rtc.calibrationsupported-port list documentation #11877 (@dhalbert)errnonames are available on which builds #9737 (@dhalbert)I had Claude take a survey of port-support docstrings and doc-only issues, and fix them. Edits by Claude, reviewed by @dhalbert.
Port-support lists
Several
**Limitations:**docstrings were incomplete, or listed the wrong ports or chips. Each list was checked against the ports'common-halcode andCIRCUITPY_*settings. Generally, the docs now list where a feature is available rather than where it is not, unless the list would be too long.Corrected:
rtc.RTC.calibrationalarm.touch.TouchAlarmanalogio.AnalogOutbusio.UARTRS485microcontroller.Processor.temperaturewifi.Radio.mac_addressandmac_address_apbusio.I2Candbusio.SPIlocksAdded a warning to
try_lock(): release the lock promptly, and preferadafruit_bus_device'sI2CDeviceandSPIDevice. On Espressif, holding a lock for a long time while using WiFi can starve the WiFi and USB tasks, so the board may hang or restart in safe mode (#10561).errnoThe
errnopage now lists theerrnocodes in most builds and the smaller set in SAMD21 builds. It also says that most SAMD21 boards, including all SAMD21 boards without external flash, do not includeerrno, and points to the Module Support Matrix. Code comments next to both lists inpy/moderrno.candports/atmel-samd/mpconfigport.hsay to updateerrno.rstwhen the lists change.busio.I2C.probe()andscan()on Zephyr nRF boardsAdded a limitation note to both: on Zephyr-based nRF boards, they do not work reliably at 400 kHz, so use 100 kHz. See #11604.