Adafruit_CircuitPython_Boar.../adafruit_boardtest/boardtest_sd_cd.py
2020-03-20 12:03:00 -04:00

129 lines
3.7 KiB
Python

# The MIT License (MIT)
#
# Copyright (c) 2018 Shawn Hymel for Adafruit Industries
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""
`adafruit_boardtest.boardtest_sd_cd`
====================================================
Reports the output of an SD card's chip detect (CD) pin.
Run this script as its own main.py to individually run the test, or compile
with mpy-cross and call from separate test script.
* Author(s): Shawn Hymel for Adafruit Industries
Implementation Notes
--------------------
**Hardware:**
* `SD Card <https://www.adafruit.com/product/1294>`_
**Software and Dependencies:**
* Adafruit CircuitPython firmware for the supported boards:
https://github.com/adafruit/circuitpython/releases
"""
import board
import digitalio
__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BoardTest.git"
# Constants
SD_CD_PIN_NAME = "SD_CD"
# Test result strings
PASS = "PASS"
FAIL = "FAIL"
NA = "N/A"
def run_test(pins, cd_pin=SD_CD_PIN_NAME):
"""
Checks status of CD pin as user inserts and removes SD card.
:param list[str] pins: list of pins to run the test on
:param str cd_pin: pin name of chip detect (CD) line
:return: tuple(str, list[str]): test result followed by list of pins tested
"""
# Ask user to insert and remove SD card
if list(set(pins).intersection(set([cd_pin]))):
# Configure CD pin as input with pullup
cdt = digitalio.DigitalInOut(getattr(board, cd_pin))
cdt.direction = digitalio.Direction.INPUT
cdt.pull = digitalio.Pull.UP
# Tell user to insert SD card
print("Connect " + cd_pin + " to CD pin on SD card holder.")
print("Insert SD card into holder.")
print("Press enter to continue.")
input()
# Make sure we see that the pin is low
if cdt.value:
print("Error: Card not detected")
return FAIL, [cd_pin]
# Tell user to remove SD card
print("Card detected. Remove card and press enter to continue.")
input()
# Make sure we see that the pin is high
if not cdt.value:
print("Error: Card detected")
return FAIL, [cd_pin]
# Test passed
print("Card removed")
return PASS, [cd_pin]
# Else (no pins found)
print("No CD pin found")
return NA, []
def _main():
# List out all the pins available to us
pins = list(dir(board))
print()
print("All pins found:", end=" ")
# Print pins
for pin in pins:
print(pin, end=" ")
print("\n")
# Run test
result = run_test(pins)
print()
print(result[0])
print("Pins tested: " + str(result[1]))
# Execute only if run as main.py or code.py
if __name__ == "__main__":
_main()