Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-boardtest/badge/?version=latest
:target: https://docs.circuitpython.org/projects/boardtest/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: 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:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `SD Card <https://github.com/adafruit/Adafruit_CircuitPython_SD>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Usage Example
=============
You will need the following components:
* `Multimeter <https://www.adafruit.com/product/2034>`_
* 1x `LED <https://www.adafruit.com/product/299>`_
* 1x 330 Ohm resistor or `220 Ohm resistor <https://www.adafruit.com/product/2780>`_
* 2x `4.7k Ohm resistor <https://www.adafruit.com/product/2783>`_
* `Microchip 25AA040A SPI EEPROM <https://www.digikey.com/product-detail/en/microchip-technology/25AA040A-I-P/25AA040A-I-P-ND/1212469>`_
* `Microchip AT24HC04B I2C EEPROM <https://www.digikey.com/product-detail/en/microchip-technology/AT24HC04B-PU/AT24HC04B-PU-ND/1886137>`_
* Breadboard
* Wires
Connect the components as shown to your board. Note that you can use a 220 Ohm or 330 Ohm resistor for the LED.
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/blob/main/docs/test_jig.png
:alt: 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:
.. code:: python
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 <https://docs.circuitpython.org/projects/boardtest/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-boardtest",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,boardtest,board,test,testing,hardware,micropythoncircuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/e6/0f/58766f147b6701c0869874648d9bdc1592ff0ebd759e6febf128321dea3e/adafruit-circuitpython-boardtest-1.2.20.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-boardtest/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/boardtest/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nBoard 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.\n\nTests can be run individually. Copy code found in each *boardtest_<name>.py* module to your CIRCUITPYTHON device drive, and rename the file *code.py*.\n\nAlternatively, 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.\n\nThe *boardtest_simpletest.py* (in *examples/*) shows how to call tests from within a script. *boardtest_simpletest.py* runs the following tests:\n\n * LED Test\n * GPIO Test\n * Voltage Monitor Test\n * UART Test\n * SPI Test\n * I2C Test\n\nDependencies\n=============\nThis test suite depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `SD Card <https://github.com/adafruit/Adafruit_CircuitPython_SD>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nUsage Example\n=============\n\nYou will need the following components:\n\n* `Multimeter <https://www.adafruit.com/product/2034>`_\n* 1x `LED <https://www.adafruit.com/product/299>`_\n* 1x 330 Ohm resistor or `220 Ohm resistor <https://www.adafruit.com/product/2780>`_\n* 2x `4.7k Ohm resistor <https://www.adafruit.com/product/2783>`_\n* `Microchip 25AA040A SPI EEPROM <https://www.digikey.com/product-detail/en/microchip-technology/25AA040A-I-P/25AA040A-I-P-ND/1212469>`_\n* `Microchip AT24HC04B I2C EEPROM <https://www.digikey.com/product-detail/en/microchip-technology/AT24HC04B-PU/AT24HC04B-PU-ND/1886137>`_\n* Breadboard\n* Wires\n\nConnect the components as shown to your board. Note that you can use a 220 Ohm or 330 Ohm resistor for the LED.\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/blob/main/docs/test_jig.png\n :alt: Test jig Fritzing diagram\n\nTo 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:\n\n.. code:: python\n\n import board\n from adafruit_boardtest import boardtest_gpio\n\n # List out all the pins available to us\n pins = [p for p in dir(board)]\n print()\n print(\"All pins found:\", end=' ')\n\n # Print pins\n for p in pins:\n print(p, end=' ')\n print('\\n')\n\n # Run test\n result = run_test(pins)\n print()\n print(result[0])\n print(\"Pins tested: \" + str(result[1]))\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/boardtest/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Helper for verifying a board definition works as expected",
"version": "1.2.20",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_BoardTest"
},
"split_keywords": [
"adafruit",
"boardtest",
"board",
"test",
"testing",
"hardware",
"micropythoncircuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4ffd5606baa3ab2509b7f3a9419a33f773459b10b9f362c3dde396a2e6c0299",
"md5": "690e5c8794f43d907d3510aae332165e",
"sha256": "50cc4acf99860a14fdb87c82ade22290ef7aa9d16a4c13f220a734ec24893cd6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_boardtest-1.2.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "690e5c8794f43d907d3510aae332165e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18016,
"upload_time": "2023-12-09T17:43:34",
"upload_time_iso_8601": "2023-12-09T17:43:34.976021Z",
"url": "https://files.pythonhosted.org/packages/d4/ff/d5606baa3ab2509b7f3a9419a33f773459b10b9f362c3dde396a2e6c0299/adafruit_circuitpython_boardtest-1.2.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e60f58766f147b6701c0869874648d9bdc1592ff0ebd759e6febf128321dea3e",
"md5": "3986d3484804cdbfb341a6b5e0707a57",
"sha256": "9eee4d80e550de2252a48a296f76b0ffb39484c2d6c782a6c13a9405605a665e"
},
"downloads": -1,
"filename": "adafruit-circuitpython-boardtest-1.2.20.tar.gz",
"has_sig": false,
"md5_digest": "3986d3484804cdbfb341a6b5e0707a57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 351996,
"upload_time": "2023-12-09T17:43:36",
"upload_time_iso_8601": "2023-12-09T17:43:36.496978Z",
"url": "https://files.pythonhosted.org/packages/e6/0f/58766f147b6701c0869874648d9bdc1592ff0ebd759e6febf128321dea3e/adafruit-circuitpython-boardtest-1.2.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:43:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_BoardTest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-boardtest"
}
JSON
