Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

Board test suite for CircuitPython. Run these tests to ensure that a CircuitPython port was created correctly, individual pin mappings are correct, and buses (e.g. SPI) work.

Tests can be run individually. Copy code found in each boardtest_<name>.py module to your CIRCUITPYTHON device drive, and rename the file code.py.

Alternatively, tests can be imported as modules. Copy the desired test file to CIRCUITPYTHON device drive and import the test in your own code. Each test can be run with the run_test(pins) function.

The boardtest_simpletest.py (in examples/) shows how to call tests from within a script. boardtest_simpletest.py runs the following tests:

  • LED Test

  • GPIO Test

  • Voltage Monitor Test

  • UART Test

  • SPI Test

  • I2C Test

Dependencies

This test suite depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

You will need the following components:

Connect the components as shown to your board. Note that you can use a 220 Ohm or 330 Ohm resistor for the LED.

Test jig Fritzing diagram

To use each test, copy the individual .py or .mpy test(s) into a folder named adafruit_boardtest in the CIRCUITPY drive, import the library, find the pins available on your board, and call boardtest_<test name>.run_test(pins). To run the GPIO test, for example:

import board
from adafruit_boardtest import boardtest_gpio

# List out all the pins available to us
pins = [p for p in dir(board)]
print()
print("All pins found:", end=' ')

# Print pins
for p in pins:
    print(p, end=' ')
print('\n')

# Run test
result = run_test(pins)
print()
print(result[0])
print("Pins tested: " + str(result[1]))

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Metadata

Release files for adafruit-circuitpython-boardtest 1.2.27

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-boardtest 1.2.27
File Size Uploaded
adafruit_circuitpython_boardtest-1.2.27.tar.gz 349.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-boardtest 1.2.27
File Interpreter ABI Platform
adafruit_circuitpython_boardtest-1.2.27-py3-none-any.whl Python 3 none any Details

Total release size: 366.9 kB

Release files / adafruit_circuitpython_boardtest-1.2.27.tar.gz

Download URL adafruit_circuitpython_boardtest-1.2.27.tar.gz
Size 349.0 kB
Tags Source
SHA-256 checksum
How to use checksums
52f93029e357a3663f937d523b4f617e6bf58447c33c5723322607e3727cc1f1
BLAKE2b-256 checksum
How to use checksums
a0231d4c73bd8324bb84f02bfd3f3c5b30ed34e6e745362d3b5033e92c095bdd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_boardtest-1.2.27-py3-none-any.whl

Download URL adafruit_circuitpython_boardtest-1.2.27-py3-none-any.whl
Size 18.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
febaf436d98bfd2225b5fefcdb304a96bedbccf761bf2248d508b236d1e9173f
BLAKE2b-256 checksum
How to use checksums
28ba115015be6b5f050b46b146da46b28f2b9738190851b5e02b3fb4adfa3084
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.2.27 This release

2 release files

1.2.26

2 release files

1.2.25

2 release files

1.2.24

2 release files

1.2.23

2 release files

1.2.22

2 release files

1.2.19

2 release files

1.2.18

2 release files

1.2.17

2 release files

1.2.16

2 release files

1.2.15

2 release files

1.2.13

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page