Introduction

Documentation Status Discord Build Status

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]))

Contributing

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

Documentation

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

Indices and tables