Skip to main content

Helper for verifying a board definition works as expected

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-boardtest-1.2.14.tar.gz (353.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-boardtest-1.2.14.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-boardtest-1.2.14.tar.gz
Algorithm Hash digest
SHA256 ba4f1c5877a3f64333a49f8dd241947018925d729ff7b1c7c952d849023eb61d
MD5 54416045fffa825d86c3be097f42013f
BLAKE2b-256 6a7810f735fdd9bb0082d371b86305312e3045f9a295ef1004d98f801e03d3c8

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_boardtest-1.2.14-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_boardtest-1.2.14-py3-none-any.whl
Algorithm Hash digest
SHA256 68dfb02abc82348d22fabb57b7d76b47570804138b344ceab190c9735c9ecfea
MD5 b193d62a5ee62f2e3b292ee02aad0bf2
BLAKE2b-256 5ed0a576d2b0c5d6566f9dcddca283c5d7da2658ecded2a7be2049e309e4851a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page