├── .gitattributes ├── .github ├── PULL_REQUEST_TEMPLATE │ └── adafruit_circuitpython_pr.md └── workflows │ ├── build.yml │ ├── failure-help-text.yml │ ├── release_gh.yml │ └── release_pypi.yml ├── .gitignore ├── .pre-commit-config.yaml ├── .readthedocs.yaml ├── CODE_OF_CONDUCT.md ├── LICENSE ├── LICENSES ├── CC-BY-4.0.txt ├── MIT.txt └── Unlicense.txt ├── README.rst ├── README.rst.license ├── adafruit_sdcard.py ├── docs ├── _static │ ├── favicon.ico │ └── favicon.ico.license ├── api.rst ├── api.rst.license ├── conf.py ├── examples.rst ├── examples.rst.license ├── index.rst ├── index.rst.license └── requirements.txt ├── examples └── sd_read_simpletest.py ├── optional_requirements.txt ├── pyproject.toml ├── requirements.txt └── ruff.toml /.gitattributes: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | .py text eol=lf 6 | .rst text eol=lf 7 | .txt text eol=lf 8 | .yaml text eol=lf 9 | .toml text eol=lf 10 | .license text eol=lf 11 | .md text eol=lf 12 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | Thank you for contributing! Before you submit a pull request, please read the following. 6 | 7 | Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html 8 | 9 | If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs 10 | 11 | Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code 12 | 13 | Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. 14 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | name: Build CI 6 | 7 | on: [pull_request, push] 8 | 9 | jobs: 10 | test: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Run Build CI workflow 14 | uses: adafruit/workflows-circuitpython-libs/build@main 15 | -------------------------------------------------------------------------------- /.github/workflows/failure-help-text.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | name: Failure help text 6 | 7 | on: 8 | workflow_run: 9 | workflows: ["Build CI"] 10 | types: 11 | - completed 12 | 13 | jobs: 14 | post-help: 15 | runs-on: ubuntu-latest 16 | if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} 17 | steps: 18 | - name: Post comment to help 19 | uses: adafruit/circuitpython-action-library-ci-failed@v1 20 | -------------------------------------------------------------------------------- /.github/workflows/release_gh.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | name: GitHub Release Actions 6 | 7 | on: 8 | release: 9 | types: [published] 10 | 11 | jobs: 12 | upload-release-assets: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Run GitHub Release CI workflow 16 | uses: adafruit/workflows-circuitpython-libs/release-gh@main 17 | with: 18 | github-token: ${{ secrets.GITHUB_TOKEN }} 19 | upload-url: ${{ github.event.release.upload_url }} 20 | -------------------------------------------------------------------------------- /.github/workflows/release_pypi.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | name: PyPI Release Actions 6 | 7 | on: 8 | release: 9 | types: [published] 10 | 11 | jobs: 12 | upload-release-assets: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Run PyPI Release CI workflow 16 | uses: adafruit/workflows-circuitpython-libs/release-pypi@main 17 | with: 18 | pypi-username: ${{ secrets.pypi_username }} 19 | pypi-password: ${{ secrets.pypi_password }} 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | # Do not include files and directories created by your personal work environment, such as the IDE 6 | # you use, except for those already listed here. Pull requests including changes to this file will 7 | # not be accepted. 8 | 9 | # This .gitignore file contains rules for files generated by working with CircuitPython libraries, 10 | # including building Sphinx, testing with pip, and creating a virual environment, as well as the 11 | # MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. 12 | 13 | # If you find that there are files being generated on your machine that should not be included in 14 | # your git commit, you should create a .gitignore_global file on your computer to include the 15 | # files created by your personal setup. To do so, follow the two steps below. 16 | 17 | # First, create a file called .gitignore_global somewhere convenient for you, and add rules for 18 | # the files you want to exclude from git commits. 19 | 20 | # Second, configure Git to use the exclude file for all Git repositories by running the 21 | # following via commandline, replacing "path/to/your/" with the actual path to your newly created 22 | # .gitignore_global file: 23 | # git config --global core.excludesfile path/to/your/.gitignore_global 24 | 25 | # CircuitPython-specific files 26 | *.mpy 27 | 28 | # Python-specific files 29 | __pycache__ 30 | *.pyc 31 | 32 | # Sphinx build-specific files 33 | _build 34 | 35 | # This file results from running `pip -e install .` in a local repository 36 | *.egg-info 37 | 38 | # Virtual environment-specific files 39 | .env 40 | .venv 41 | 42 | # MacOS-specific files 43 | *.DS_Store 44 | 45 | # IDE-specific files 46 | .idea 47 | .vscode 48 | *~ 49 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | repos: 6 | - repo: https://github.com/pre-commit/pre-commit-hooks 7 | rev: v4.5.0 8 | hooks: 9 | - id: check-yaml 10 | - id: end-of-file-fixer 11 | - id: trailing-whitespace 12 | - repo: https://github.com/astral-sh/ruff-pre-commit 13 | rev: v0.3.4 14 | hooks: 15 | - id: ruff-format 16 | - id: ruff 17 | args: ["--fix"] 18 | - repo: https://github.com/fsfe/reuse-tool 19 | rev: v3.0.1 20 | hooks: 21 | - id: reuse 22 | -------------------------------------------------------------------------------- /.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | # Read the Docs configuration file 6 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details 7 | 8 | # Required 9 | version: 2 10 | 11 | sphinx: 12 | configuration: docs/conf.py 13 | 14 | build: 15 | os: ubuntu-20.04 16 | tools: 17 | python: "3" 18 | 19 | python: 20 | install: 21 | - requirements: docs/requirements.txt 22 | - requirements: requirements.txt 23 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | # Adafruit Community Code of Conduct 8 | 9 | ## Our Pledge 10 | 11 | In the interest of fostering an open and welcoming environment, we as 12 | contributors and leaders pledge to making participation in our project and 13 | our community a harassment-free experience for everyone, regardless of age, body 14 | size, disability, ethnicity, gender identity and expression, level or type of 15 | experience, education, socio-economic status, nationality, personal appearance, 16 | race, religion, or sexual identity and orientation. 17 | 18 | ## Our Standards 19 | 20 | We are committed to providing a friendly, safe and welcoming environment for 21 | all. 22 | 23 | Examples of behavior that contributes to creating a positive environment 24 | include: 25 | 26 | * Be kind and courteous to others 27 | * Using welcoming and inclusive language 28 | * Being respectful of differing viewpoints and experiences 29 | * Collaborating with other community members 30 | * Gracefully accepting constructive criticism 31 | * Focusing on what is best for the community 32 | * Showing empathy towards other community members 33 | 34 | Examples of unacceptable behavior by participants include: 35 | 36 | * The use of sexualized language or imagery and sexual attention or advances 37 | * The use of inappropriate images, including in a community member's avatar 38 | * The use of inappropriate language, including in a community member's nickname 39 | * Any spamming, flaming, baiting or other attention-stealing behavior 40 | * Excessive or unwelcome helping; answering outside the scope of the question 41 | asked 42 | * Trolling, insulting/derogatory comments, and personal or political attacks 43 | * Promoting or spreading disinformation, lies, or conspiracy theories against 44 | a person, group, organisation, project, or community 45 | * Public or private harassment 46 | * Publishing others' private information, such as a physical or electronic 47 | address, without explicit permission 48 | * Other conduct which could reasonably be considered inappropriate 49 | 50 | The goal of the standards and moderation guidelines outlined here is to build 51 | and maintain a respectful community. We ask that you don’t just aim to be 52 | "technically unimpeachable", but rather try to be your best self. 53 | 54 | We value many things beyond technical expertise, including collaboration and 55 | supporting others within our community. Providing a positive experience for 56 | other community members can have a much more significant impact than simply 57 | providing the correct answer. 58 | 59 | ## Our Responsibilities 60 | 61 | Project leaders are responsible for clarifying the standards of acceptable 62 | behavior and are expected to take appropriate and fair corrective action in 63 | response to any instances of unacceptable behavior. 64 | 65 | Project leaders have the right and responsibility to remove, edit, or 66 | reject messages, comments, commits, code, issues, and other contributions 67 | that are not aligned to this Code of Conduct, or to ban temporarily or 68 | permanently any community member for other behaviors that they deem 69 | inappropriate, threatening, offensive, or harmful. 70 | 71 | ## Moderation 72 | 73 | Instances of behaviors that violate the Adafruit Community Code of Conduct 74 | may be reported by any member of the community. Community members are 75 | encouraged to report these situations, including situations they witness 76 | involving other community members. 77 | 78 | You may report in the following ways: 79 | 80 | In any situation, you may send an email to . 81 | 82 | On the Adafruit Discord, you may send an open message from any channel 83 | to all Community Moderators by tagging @community moderators. You may 84 | also send an open message from any channel, or a direct message to 85 | @kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, 86 | @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. 87 | 88 | Email and direct message reports will be kept confidential. 89 | 90 | In situations on Discord where the issue is particularly egregious, possibly 91 | illegal, requires immediate action, or violates the Discord terms of service, 92 | you should also report the message directly to Discord. 93 | 94 | These are the steps for upholding our community’s standards of conduct. 95 | 96 | 1. Any member of the community may report any situation that violates the 97 | Adafruit Community Code of Conduct. All reports will be reviewed and 98 | investigated. 99 | 2. If the behavior is an egregious violation, the community member who 100 | committed the violation may be banned immediately, without warning. 101 | 3. Otherwise, moderators will first respond to such behavior with a warning. 102 | 4. Moderators follow a soft "three strikes" policy - the community member may 103 | be given another chance, if they are receptive to the warning and change their 104 | behavior. 105 | 5. If the community member is unreceptive or unreasonable when warned by a 106 | moderator, or the warning goes unheeded, they may be banned for a first or 107 | second offense. Repeated offenses will result in the community member being 108 | banned. 109 | 110 | ## Scope 111 | 112 | This Code of Conduct and the enforcement policies listed above apply to all 113 | Adafruit Community venues. This includes but is not limited to any community 114 | spaces (both public and private), the entire Adafruit Discord server, and 115 | Adafruit GitHub repositories. Examples of Adafruit Community spaces include 116 | but are not limited to meet-ups, audio chats on the Adafruit Discord, or 117 | interaction at a conference. 118 | 119 | This Code of Conduct applies both within project spaces and in public spaces 120 | when an individual is representing the project or its community. As a community 121 | member, you are representing our community, and are expected to behave 122 | accordingly. 123 | 124 | ## Attribution 125 | 126 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 127 | version 1.4, available at 128 | , 129 | and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). 130 | 131 | For other projects adopting the Adafruit Community Code of 132 | Conduct, please contact the maintainers of those projects for enforcement. 133 | If you wish to use this code of conduct for your own project, consider 134 | explicitly mentioning your moderation policy or making a copy with your 135 | own moderation policy so as to avoid confusion. 136 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2014-2016 Damien George, Peter Hinch and Radomir Dopieralski 4 | Copyright (c) 2017 Scott Shawcroft for Adafruit Industries 5 | 6 | Permission is hereby granted, free of charge, to any person obtaining a copy 7 | of this software and associated documentation files (the "Software"), to deal 8 | in the Software without restriction, including without limitation the rights 9 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | copies of the Software, and to permit persons to whom the Software is 11 | furnished to do so, subject to the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be included in all 14 | copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 | SOFTWARE. 23 | -------------------------------------------------------------------------------- /LICENSES/CC-BY-4.0.txt: -------------------------------------------------------------------------------- 1 | Creative Commons Attribution 4.0 International Creative Commons Corporation 2 | ("Creative Commons") is not a law firm and does not provide legal services 3 | or legal advice. Distribution of Creative Commons public licenses does not 4 | create a lawyer-client or other relationship. Creative Commons makes its licenses 5 | and related information available on an "as-is" basis. Creative Commons gives 6 | no warranties regarding its licenses, any material licensed under their terms 7 | and conditions, or any related information. Creative Commons disclaims all 8 | liability for damages resulting from their use to the fullest extent possible. 9 | 10 | Using Creative Commons Public Licenses 11 | 12 | Creative Commons public licenses provide a standard set of terms and conditions 13 | that creators and other rights holders may use to share original works of 14 | authorship and other material subject to copyright and certain other rights 15 | specified in the public license below. The following considerations are for 16 | informational purposes only, are not exhaustive, and do not form part of our 17 | licenses. 18 | 19 | Considerations for licensors: Our public licenses are intended for use by 20 | those authorized to give the public permission to use material in ways otherwise 21 | restricted by copyright and certain other rights. Our licenses are irrevocable. 22 | Licensors should read and understand the terms and conditions of the license 23 | they choose before applying it. Licensors should also secure all rights necessary 24 | before applying our licenses so that the public can reuse the material as 25 | expected. Licensors should clearly mark any material not subject to the license. 26 | This includes other CC-licensed material, or material used under an exception 27 | or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors 28 | 29 | Considerations for the public: By using one of our public licenses, a licensor 30 | grants the public permission to use the licensed material under specified 31 | terms and conditions. If the licensor's permission is not necessary for any 32 | reason–for example, because of any applicable exception or limitation to copyright–then 33 | that use is not regulated by the license. Our licenses grant only permissions 34 | under copyright and certain other rights that a licensor has authority to 35 | grant. Use of the licensed material may still be restricted for other reasons, 36 | including because others have copyright or other rights in the material. A 37 | licensor may make special requests, such as asking that all changes be marked 38 | or described. Although not required by our licenses, you are encouraged to 39 | respect those requests where reasonable. More considerations for the public 40 | : wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution 41 | 4.0 International Public License 42 | 43 | By exercising the Licensed Rights (defined below), You accept and agree to 44 | be bound by the terms and conditions of this Creative Commons Attribution 45 | 4.0 International Public License ("Public License"). To the extent this Public 46 | License may be interpreted as a contract, You are granted the Licensed Rights 47 | in consideration of Your acceptance of these terms and conditions, and the 48 | Licensor grants You such rights in consideration of benefits the Licensor 49 | receives from making the Licensed Material available under these terms and 50 | conditions. 51 | 52 | Section 1 – Definitions. 53 | 54 | a. Adapted Material means material subject to Copyright and Similar Rights 55 | that is derived from or based upon the Licensed Material and in which the 56 | Licensed Material is translated, altered, arranged, transformed, or otherwise 57 | modified in a manner requiring permission under the Copyright and Similar 58 | Rights held by the Licensor. For purposes of this Public License, where the 59 | Licensed Material is a musical work, performance, or sound recording, Adapted 60 | Material is always produced where the Licensed Material is synched in timed 61 | relation with a moving image. 62 | 63 | b. Adapter's License means the license You apply to Your Copyright and Similar 64 | Rights in Your contributions to Adapted Material in accordance with the terms 65 | and conditions of this Public License. 66 | 67 | c. Copyright and Similar Rights means copyright and/or similar rights closely 68 | related to copyright including, without limitation, performance, broadcast, 69 | sound recording, and Sui Generis Database Rights, without regard to how the 70 | rights are labeled or categorized. For purposes of this Public License, the 71 | rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. 72 | 73 | d. Effective Technological Measures means those measures that, in the absence 74 | of proper authority, may not be circumvented under laws fulfilling obligations 75 | under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, 76 | and/or similar international agreements. 77 | 78 | e. Exceptions and Limitations means fair use, fair dealing, and/or any other 79 | exception or limitation to Copyright and Similar Rights that applies to Your 80 | use of the Licensed Material. 81 | 82 | f. Licensed Material means the artistic or literary work, database, or other 83 | material to which the Licensor applied this Public License. 84 | 85 | g. Licensed Rights means the rights granted to You subject to the terms and 86 | conditions of this Public License, which are limited to all Copyright and 87 | Similar Rights that apply to Your use of the Licensed Material and that the 88 | Licensor has authority to license. 89 | 90 | h. Licensor means the individual(s) or entity(ies) granting rights under this 91 | Public License. 92 | 93 | i. Share means to provide material to the public by any means or process that 94 | requires permission under the Licensed Rights, such as reproduction, public 95 | display, public performance, distribution, dissemination, communication, or 96 | importation, and to make material available to the public including in ways 97 | that members of the public may access the material from a place and at a time 98 | individually chosen by them. 99 | 100 | j. Sui Generis Database Rights means rights other than copyright resulting 101 | from Directive 96/9/EC of the European Parliament and of the Council of 11 102 | March 1996 on the legal protection of databases, as amended and/or succeeded, 103 | as well as other essentially equivalent rights anywhere in the world. 104 | 105 | k. You means the individual or entity exercising the Licensed Rights under 106 | this Public License. Your has a corresponding meaning. 107 | 108 | Section 2 – Scope. 109 | 110 | a. License grant. 111 | 112 | 1. Subject to the terms and conditions of this Public License, the Licensor 113 | hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, 114 | irrevocable license to exercise the Licensed Rights in the Licensed Material 115 | to: 116 | 117 | A. reproduce and Share the Licensed Material, in whole or in part; and 118 | 119 | B. produce, reproduce, and Share Adapted Material. 120 | 121 | 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions 122 | and Limitations apply to Your use, this Public License does not apply, and 123 | You do not need to comply with its terms and conditions. 124 | 125 | 3. Term. The term of this Public License is specified in Section 6(a). 126 | 127 | 4. Media and formats; technical modifications allowed. The Licensor authorizes 128 | You to exercise the Licensed Rights in all media and formats whether now known 129 | or hereafter created, and to make technical modifications necessary to do 130 | so. The Licensor waives and/or agrees not to assert any right or authority 131 | to forbid You from making technical modifications necessary to exercise the 132 | Licensed Rights, including technical modifications necessary to circumvent 133 | Effective Technological Measures. For purposes of this Public License, simply 134 | making modifications authorized by this Section 2(a)(4) never produces Adapted 135 | Material. 136 | 137 | 5. Downstream recipients. 138 | 139 | A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed 140 | Material automatically receives an offer from the Licensor to exercise the 141 | Licensed Rights under the terms and conditions of this Public License. 142 | 143 | B. No downstream restrictions. You may not offer or impose any additional 144 | or different terms or conditions on, or apply any Effective Technological 145 | Measures to, the Licensed Material if doing so restricts exercise of the Licensed 146 | Rights by any recipient of the Licensed Material. 147 | 148 | 6. No endorsement. Nothing in this Public License constitutes or may be construed 149 | as permission to assert or imply that You are, or that Your use of the Licensed 150 | Material is, connected with, or sponsored, endorsed, or granted official status 151 | by, the Licensor or others designated to receive attribution as provided in 152 | Section 3(a)(1)(A)(i). 153 | 154 | b. Other rights. 155 | 156 | 1. Moral rights, such as the right of integrity, are not licensed under this 157 | Public License, nor are publicity, privacy, and/or other similar personality 158 | rights; however, to the extent possible, the Licensor waives and/or agrees 159 | not to assert any such rights held by the Licensor to the limited extent necessary 160 | to allow You to exercise the Licensed Rights, but not otherwise. 161 | 162 | 2. Patent and trademark rights are not licensed under this Public License. 163 | 164 | 3. To the extent possible, the Licensor waives any right to collect royalties 165 | from You for the exercise of the Licensed Rights, whether directly or through 166 | a collecting society under any voluntary or waivable statutory or compulsory 167 | licensing scheme. In all other cases the Licensor expressly reserves any right 168 | to collect such royalties. 169 | 170 | Section 3 – License Conditions. 171 | 172 | Your exercise of the Licensed Rights is expressly made subject to the following 173 | conditions. 174 | 175 | a. Attribution. 176 | 177 | 1. If You Share the Licensed Material (including in modified form), You must: 178 | 179 | A. retain the following if it is supplied by the Licensor with the Licensed 180 | Material: 181 | 182 | i. identification of the creator(s) of the Licensed Material and any others 183 | designated to receive attribution, in any reasonable manner requested by the 184 | Licensor (including by pseudonym if designated); 185 | 186 | ii. a copyright notice; 187 | 188 | iii. a notice that refers to this Public License; 189 | 190 | iv. a notice that refers to the disclaimer of warranties; 191 | 192 | v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; 193 | 194 | B. indicate if You modified the Licensed Material and retain an indication 195 | of any previous modifications; and 196 | 197 | C. indicate the Licensed Material is licensed under this Public License, and 198 | include the text of, or the URI or hyperlink to, this Public License. 199 | 200 | 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner 201 | based on the medium, means, and context in which You Share the Licensed Material. 202 | For example, it may be reasonable to satisfy the conditions by providing a 203 | URI or hyperlink to a resource that includes the required information. 204 | 205 | 3. If requested by the Licensor, You must remove any of the information required 206 | by Section 3(a)(1)(A) to the extent reasonably practicable. 207 | 208 | 4. If You Share Adapted Material You produce, the Adapter's License You apply 209 | must not prevent recipients of the Adapted Material from complying with this 210 | Public License. 211 | 212 | Section 4 – Sui Generis Database Rights. 213 | 214 | Where the Licensed Rights include Sui Generis Database Rights that apply to 215 | Your use of the Licensed Material: 216 | 217 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, 218 | reuse, reproduce, and Share all or a substantial portion of the contents of 219 | the database; 220 | 221 | b. if You include all or a substantial portion of the database contents in 222 | a database in which You have Sui Generis Database Rights, then the database 223 | in which You have Sui Generis Database Rights (but not its individual contents) 224 | is Adapted Material; and 225 | 226 | c. You must comply with the conditions in Section 3(a) if You Share all or 227 | a substantial portion of the contents of the database. 228 | 229 | For the avoidance of doubt, this Section 4 supplements and does not replace 230 | Your obligations under this Public License where the Licensed Rights include 231 | other Copyright and Similar Rights. 232 | 233 | Section 5 – Disclaimer of Warranties and Limitation of Liability. 234 | 235 | a. Unless otherwise separately undertaken by the Licensor, to the extent possible, 236 | the Licensor offers the Licensed Material as-is and as-available, and makes 237 | no representations or warranties of any kind concerning the Licensed Material, 238 | whether express, implied, statutory, or other. This includes, without limitation, 239 | warranties of title, merchantability, fitness for a particular purpose, non-infringement, 240 | absence of latent or other defects, accuracy, or the presence or absence of 241 | errors, whether or not known or discoverable. Where disclaimers of warranties 242 | are not allowed in full or in part, this disclaimer may not apply to You. 243 | 244 | b. To the extent possible, in no event will the Licensor be liable to You 245 | on any legal theory (including, without limitation, negligence) or otherwise 246 | for any direct, special, indirect, incidental, consequential, punitive, exemplary, 247 | or other losses, costs, expenses, or damages arising out of this Public License 248 | or use of the Licensed Material, even if the Licensor has been advised of 249 | the possibility of such losses, costs, expenses, or damages. Where a limitation 250 | of liability is not allowed in full or in part, this limitation may not apply 251 | to You. 252 | 253 | c. The disclaimer of warranties and limitation of liability provided above 254 | shall be interpreted in a manner that, to the extent possible, most closely 255 | approximates an absolute disclaimer and waiver of all liability. 256 | 257 | Section 6 – Term and Termination. 258 | 259 | a. This Public License applies for the term of the Copyright and Similar Rights 260 | licensed here. However, if You fail to comply with this Public License, then 261 | Your rights under this Public License terminate automatically. 262 | 263 | b. Where Your right to use the Licensed Material has terminated under Section 264 | 6(a), it reinstates: 265 | 266 | 1. automatically as of the date the violation is cured, provided it is cured 267 | within 30 days of Your discovery of the violation; or 268 | 269 | 2. upon express reinstatement by the Licensor. 270 | 271 | c. For the avoidance of doubt, this Section 6(b) does not affect any right 272 | the Licensor may have to seek remedies for Your violations of this Public 273 | License. 274 | 275 | d. For the avoidance of doubt, the Licensor may also offer the Licensed Material 276 | under separate terms or conditions or stop distributing the Licensed Material 277 | at any time; however, doing so will not terminate this Public License. 278 | 279 | e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. 280 | 281 | Section 7 – Other Terms and Conditions. 282 | 283 | a. The Licensor shall not be bound by any additional or different terms or 284 | conditions communicated by You unless expressly agreed. 285 | 286 | b. Any arrangements, understandings, or agreements regarding the Licensed 287 | Material not stated herein are separate from and independent of the terms 288 | and conditions of this Public License. 289 | 290 | Section 8 – Interpretation. 291 | 292 | a. For the avoidance of doubt, this Public License does not, and shall not 293 | be interpreted to, reduce, limit, restrict, or impose conditions on any use 294 | of the Licensed Material that could lawfully be made without permission under 295 | this Public License. 296 | 297 | b. To the extent possible, if any provision of this Public License is deemed 298 | unenforceable, it shall be automatically reformed to the minimum extent necessary 299 | to make it enforceable. If the provision cannot be reformed, it shall be severed 300 | from this Public License without affecting the enforceability of the remaining 301 | terms and conditions. 302 | 303 | c. No term or condition of this Public License will be waived and no failure 304 | to comply consented to unless expressly agreed to by the Licensor. 305 | 306 | d. Nothing in this Public License constitutes or may be interpreted as a limitation 307 | upon, or waiver of, any privileges and immunities that apply to the Licensor 308 | or You, including from the legal processes of any jurisdiction or authority. 309 | 310 | Creative Commons is not a party to its public licenses. Notwithstanding, Creative 311 | Commons may elect to apply one of its public licenses to material it publishes 312 | and in those instances will be considered the "Licensor." The text of the 313 | Creative Commons public licenses is dedicated to the public domain under the 314 | CC0 Public Domain Dedication. Except for the limited purpose of indicating 315 | that material is shared under a Creative Commons public license or as otherwise 316 | permitted by the Creative Commons policies published at creativecommons.org/policies, 317 | Creative Commons does not authorize the use of the trademark "Creative Commons" 318 | or any other trademark or logo of Creative Commons without its prior written 319 | consent including, without limitation, in connection with any unauthorized 320 | modifications to any of its public licenses or any other arrangements, understandings, 321 | or agreements concerning use of licensed material. For the avoidance of doubt, 322 | this paragraph does not form part of the public licenses. 323 | 324 | Creative Commons may be contacted at creativecommons.org. 325 | -------------------------------------------------------------------------------- /LICENSES/MIT.txt: -------------------------------------------------------------------------------- 1 | MIT License Copyright (c) 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is furnished 8 | to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice (including the next 11 | paragraph) shall be included in all copies or substantial portions of the 12 | Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 16 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 17 | OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 18 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF 19 | OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 20 | -------------------------------------------------------------------------------- /LICENSES/Unlicense.txt: -------------------------------------------------------------------------------- 1 | This is free and unencumbered software released into the public domain. 2 | 3 | Anyone is free to copy, modify, publish, use, compile, sell, or distribute 4 | this software, either in source code form or as a compiled binary, for any 5 | purpose, commercial or non-commercial, and by any means. 6 | 7 | In jurisdictions that recognize copyright laws, the author or authors of this 8 | software dedicate any and all copyright interest in the software to the public 9 | domain. We make this dedication for the benefit of the public at large and 10 | to the detriment of our heirs and successors. We intend this dedication to 11 | be an overt act of relinquishment in perpetuity of all present and future 12 | rights to this software under copyright law. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 16 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 17 | BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 18 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH 19 | THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, 20 | please refer to 21 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | 2 | Introduction 3 | ============ 4 | 5 | .. image:: https://readthedocs.org/projects/adafruit-circuitpython-sd/badge/?version=latest 6 | :target: https://docs.circuitpython.org/projects/sd/en/latest/ 7 | :alt: Documentation Status 8 | 9 | .. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg 10 | :target: https://adafru.it/discord 11 | :alt: Discord 12 | 13 | .. image:: https://github.com/adafruit/Adafruit_CircuitPython_SD/workflows/Build%20CI/badge.svg 14 | :target: https://github.com/adafruit/Adafruit_CircuitPython_SD/actions/ 15 | :alt: Build Status 16 | 17 | .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json 18 | :target: https://github.com/astral-sh/ruff 19 | :alt: Code Style: Ruff 20 | 21 | CircuitPython driver for SD cards. This implements the basic reading and writing 22 | block functionality needed to mount an SD card using `storage.VfsFat`. 23 | 24 | Dependencies 25 | ============= 26 | This driver depends on: 27 | 28 | * `Adafruit CircuitPython 2.0.0+ `_ 29 | * `Bus Device `_ 30 | 31 | Please ensure all dependencies are available on the CircuitPython filesystem. 32 | This is easily achieved by downloading 33 | `the Adafruit library and driver bundle `_. 34 | 35 | Usage Example 36 | ============= 37 | 38 | Mounting a filesystem on an SD card so that its available through the normal Python 39 | ways is easy. 40 | 41 | Below is an example for the Feather M0 Adalogger. Most of this will stay the same 42 | across different boards with the exception of the pins for the SPI and chip 43 | select (cs) connections. 44 | 45 | .. code-block:: python 46 | 47 | import adafruit_sdcard 48 | import busio 49 | import digitalio 50 | import board 51 | import storage 52 | 53 | # Connect to the card and mount the filesystem. 54 | spi = busio.SPI(board.SCK, board.MOSI, board.MISO) 55 | cs = digitalio.DigitalInOut(board.SD_CS) 56 | sdcard = adafruit_sdcard.SDCard(spi, cs) 57 | vfs = storage.VfsFat(sdcard) 58 | storage.mount(vfs, "/sd") 59 | 60 | # Use the filesystem as normal. 61 | with open("/sd/test.txt", "w") as f: 62 | f.write("Hello world\n") 63 | 64 | Sharing the SPI bus with other devices 65 | ====================================== 66 | 67 | .. important:: 68 | If the same SPI bus is shared with other peripherals, it is important that 69 | the SD card be initialized before accessing any other peripheral on the bus. 70 | Failure to do so can prevent the SD card from being recognized until it is 71 | powered off or re-inserted. 72 | 73 | 74 | Documentation 75 | ============= 76 | 77 | API documentation for this library can be found on `Read the Docs `_. 78 | 79 | For information on building library documentation, please check out `this guide `_. 80 | 81 | Contributing 82 | ============ 83 | 84 | Contributions are welcome! Please read our `Code of Conduct 85 | `_ 86 | before contributing to help this project stay welcoming. 87 | -------------------------------------------------------------------------------- /README.rst.license: -------------------------------------------------------------------------------- 1 | SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | 3 | SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /adafruit_sdcard.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2014-2016 Damien George 2 | # SPDX-FileCopyrightText: 2014-2016 Peter Hinch 3 | # SPDX-FileCopyrightText: 2014-2016 Radomir Dopieralski 4 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft for Adafruit Industries 5 | # 6 | # SPDX-License-Identifier: MIT 7 | 8 | """ 9 | `adafruit_sdcard` - SD card over SPI driver 10 | ==================================================== 11 | 12 | CircuitPython driver for SD cards using SPI bus. 13 | 14 | Requires an SPI bus and a CS pin. Provides readblocks and writeblocks 15 | methods so the device can be mounted as a filesystem. 16 | 17 | * Author(s): Scott Shawcroft 18 | 19 | Implementation Notes 20 | -------------------- 21 | 22 | **Hardware:** 23 | 24 | * Adafruit `MicroSD card breakout board+ 25 | `_ (Product ID: 254) 26 | 27 | * Adafruit `Assembled Data Logging shield for Arduino 28 | `_ (Product ID: 1141) 29 | 30 | * Adafruit `Feather M0 Adalogger 31 | `_ (Product ID: 2796) 32 | 33 | * Adalogger `FeatherWing - RTC + SD Add-on For All Feather Boards 34 | `_ (Product ID: 2922) 35 | 36 | **Software and Dependencies:** 37 | 38 | * Adafruit CircuitPython firmware for the ESP8622 and M0-based boards: 39 | https://github.com/adafruit/circuitpython/releases 40 | * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice 41 | """ 42 | 43 | import time 44 | 45 | from adafruit_bus_device import spi_device 46 | from micropython import const 47 | 48 | try: 49 | from typing import Optional, Union 50 | 51 | from busio import SPI 52 | from circuitpython_typing import ReadableBuffer, WriteableBuffer 53 | from digitalio import DigitalInOut 54 | except ImportError: 55 | pass 56 | 57 | __version__ = "0.0.0+auto.0" 58 | __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_SD.git" 59 | 60 | _CMD_TIMEOUT = const(200) 61 | 62 | _R1_IDLE_STATE = const(1 << 0) 63 | # R1_ERASE_RESET = const(1 << 1) 64 | _R1_ILLEGAL_COMMAND = const(1 << 2) 65 | # R1_COM_CRC_ERROR = const(1 << 3) 66 | # R1_ERASE_SEQUENCE_ERROR = const(1 << 4) 67 | # R1_ADDRESS_ERROR = const(1 << 5) 68 | # R1_PARAMETER_ERROR = const(1 << 6) 69 | _TOKEN_CMD25 = const(0xFC) 70 | _TOKEN_STOP_TRAN = const(0xFD) 71 | _TOKEN_DATA = const(0xFE) 72 | 73 | 74 | class SDCard: 75 | """Controls an SD card over SPI. 76 | 77 | :param ~busio.SPI spi: The SPI bus 78 | :param ~digitalio.DigitalInOut cs: The chip select connected to the card 79 | :param int baudrate: The SPI data rate to use after card setup 80 | 81 | Example usage: 82 | 83 | .. code-block:: python 84 | 85 | import busio 86 | import storage 87 | import adafruit_sdcard 88 | import digitalio 89 | import os 90 | import board 91 | 92 | spi = busio.SPI(SCK, MOSI, MISO) 93 | cs = digitalio.DigitalInOut(board.SD_CS) 94 | sdcard = adafruit_sdcard.SDCard(spi, cs) 95 | vfs = storage.VfsFat(sdcard) 96 | storage.mount(vfs, '/sd') 97 | os.listdir('/sd') 98 | 99 | """ 100 | 101 | def __init__(self, spi: SPI, cs: DigitalInOut, baudrate: int = 1320000) -> None: 102 | # Create an SPIDevice running at a lower initialization baudrate first. 103 | self._spi = spi_device.SPIDevice(spi, cs, baudrate=250000, extra_clocks=8) 104 | 105 | self._cmdbuf = bytearray(6) 106 | self._single_byte = bytearray(1) 107 | 108 | # Card is byte addressing, set to 1 if addresses are per block 109 | self._cdv = 512 110 | 111 | # initialise the card 112 | self._init_card(cs) 113 | 114 | # Create a new SPIDevice with the (probably) higher operating baudrate. 115 | self._spi = spi_device.SPIDevice(spi, cs, baudrate=baudrate, extra_clocks=8) 116 | 117 | def _init_card(self, chip_select: DigitalInOut) -> None: 118 | """Initialize the card in SPI mode.""" 119 | # clock card at least 80 cycles with cs high 120 | with self._spi as card: 121 | # Force CS high. 122 | chip_select.value = True 123 | self._single_byte[0] = 0xFF 124 | for _ in range(80 // 8 + 1): 125 | card.write(self._single_byte) 126 | 127 | with self._spi as card: 128 | # CMD0: init card; should return _R1_IDLE_STATE (allow 5 attempts) 129 | for _ in range(5): 130 | if self._cmd(card, 0, 0, 0x95) == _R1_IDLE_STATE: 131 | break 132 | else: 133 | raise OSError("no SD card") 134 | 135 | # CMD8: determine card version 136 | rb7 = bytearray(4) 137 | r = self._cmd(card, 8, 0x01AA, 0x87, rb7, data_block=False) 138 | if r == _R1_IDLE_STATE: 139 | self._init_card_v2(card) 140 | elif r == (_R1_IDLE_STATE | _R1_ILLEGAL_COMMAND): 141 | self._init_card_v1(card) 142 | else: 143 | raise OSError("couldn't determine SD card version") 144 | 145 | # get the number of sectors 146 | # CMD9: response R2 (R1 byte + 16-byte block read) 147 | csd = bytearray(16) 148 | if self._cmd(card, 9, 0, 0xAF, response_buf=csd) != 0: 149 | raise OSError("no response from SD card") 150 | # self.readinto(csd) 151 | csd_version = (csd[0] & 0xC0) >> 6 152 | if csd_version >= 2: 153 | raise OSError("SD card CSD format not supported") 154 | 155 | if csd_version == 1: 156 | self._sectors = ((csd[8] << 8 | csd[9]) + 1) * 1024 157 | else: 158 | block_length = 2 ** (csd[5] & 0xF) 159 | c_size = ((csd[6] & 0x3) << 10) | (csd[7] << 2) | ((csd[8] & 0xC) >> 6) 160 | mult = 2 ** (((csd[9] & 0x3) << 1 | (csd[10] & 0x80) >> 7) + 2) 161 | self._sectors = block_length // 512 * mult * (c_size + 1) 162 | 163 | # CMD16: set block length to 512 bytes 164 | if self._cmd(card, 16, 512, 0x15) != 0: 165 | raise OSError("can't set 512 block size") 166 | 167 | def _init_card_v1(self, card: SPI) -> None: 168 | """Initialize v1 SDCards which use byte addressing.""" 169 | for _ in range(_CMD_TIMEOUT): 170 | self._cmd(card, 55, 0, 0) 171 | if self._cmd(card, 41, 0, 0) == 0: 172 | # print("[SDCard] v1 card") 173 | return 174 | raise OSError("timeout waiting for v1 card") 175 | 176 | def _init_card_v2(self, card: SPI) -> None: 177 | """Initialize v2 SDCards which use 512-byte block addressing.""" 178 | ocr = bytearray(4) 179 | for _ in range(_CMD_TIMEOUT): 180 | time.sleep(0.050) 181 | self._cmd(card, 58, 0, 0xFD, response_buf=ocr, data_block=False) 182 | self._cmd(card, 55, 0, 0x65) 183 | # On non-longint builds, we cannot use 0x40000000 directly as the arg 184 | # so break it into bytes, which are interpreted by self._cmd(). 185 | if self._cmd(card, 41, b"\x40\x00\x00\x00", 0x77) == 0: 186 | self._cmd(card, 58, 0, 0xFD, response_buf=ocr, data_block=False) 187 | 188 | # Check for block addressing 189 | if (ocr[0] & 0x40) != 0: 190 | self._cdv = 1 191 | # print("[SDCard] v2 card") 192 | return 193 | raise OSError("timeout waiting for v2 card") 194 | 195 | def _wait_for_ready(self, card: SPI, timeout: float = 0.3) -> None: 196 | """ 197 | Wait for the card to clock out 0xff to indicate its ready. 198 | 199 | :param busio.SPI card: The locked SPI bus. 200 | :param float timeout: Maximum time to wait in seconds. 201 | """ 202 | start_time = time.monotonic() 203 | self._single_byte[0] = 0x00 204 | while time.monotonic() - start_time < timeout and self._single_byte[0] != 0xFF: 205 | card.readinto(self._single_byte, write_value=0xFF) 206 | 207 | # no-member disable should be reconsidered when it can be tested 208 | def _cmd( 209 | self, 210 | card: SPI, 211 | cmd: int, 212 | arg: Union[int, ReadableBuffer] = 0, 213 | crc: int = 0, 214 | response_buf: Optional[WriteableBuffer] = None, 215 | data_block: bool = True, 216 | wait: bool = True, 217 | ) -> int: 218 | """ 219 | Issue a command to the card and read an optional data response. 220 | 221 | :param busio.SPI card: The locked SPI bus. 222 | :param int cmd: The command number. 223 | :param int|buf(4) arg: The command argument 224 | :param int crc: The crc to allow the card to verify the command and argument. 225 | :param WriteableBuffer response_buf: Buffer to read a data block response into. 226 | :param bool data_block: True if the response data is in a data block. 227 | :param bool wait: True if the command should wait until the card is ready 228 | """ 229 | # create and send the command 230 | buf = self._cmdbuf 231 | buf[0] = 0x40 | cmd 232 | if isinstance(arg, int): 233 | buf[1] = (arg >> 24) & 0xFF 234 | buf[2] = (arg >> 16) & 0xFF 235 | buf[3] = (arg >> 8) & 0xFF 236 | buf[4] = arg & 0xFF 237 | elif len(arg) == 4: 238 | # arg can be a 4-byte buf 239 | buf[1:5] = arg 240 | else: 241 | raise ValueError() 242 | 243 | if crc == 0: 244 | buf[5] = calculate_crc(buf[:-1]) 245 | else: 246 | buf[5] = crc 247 | 248 | if wait: 249 | self._wait_for_ready(card) 250 | 251 | card.write(buf) 252 | 253 | # wait for the response (response[7] == 0) 254 | for _ in range(_CMD_TIMEOUT): 255 | card.readinto(buf, end=1, write_value=0xFF) 256 | if not (buf[0] & 0x80): 257 | if response_buf: 258 | if data_block: 259 | # Wait for the start block byte 260 | buf[1] = 0xFF 261 | for _ in range(_CMD_TIMEOUT): 262 | card.readinto(buf, start=1, end=2, write_value=0xFF) 263 | if buf[1] == 0xFE: 264 | break 265 | if buf[1] != 0xFE: 266 | return -1 267 | card.readinto(response_buf, write_value=0xFF) 268 | if data_block: 269 | # Read the checksum 270 | card.readinto(buf, start=1, end=3, write_value=0xFF) 271 | return buf[0] 272 | return -1 273 | 274 | def _block_cmd( 275 | self, 276 | card: SPI, 277 | cmd: int, 278 | block: int, 279 | crc: int, 280 | response_buf: Optional[WriteableBuffer] = None, 281 | ) -> int: 282 | """ 283 | Issue a command to the card with a block argument. 284 | 285 | :param busio.SPI card: The locked SPI bus. 286 | :param int cmd: The command number. 287 | :param int block: The relevant block. 288 | :param int crc: The crc to allow the card to verify the command and argument. 289 | :param WriteableBuffer response_buf: Buffer to read a data block response into. 290 | """ 291 | if self._cdv == 1: 292 | return self._cmd(card, cmd, block, crc, response_buf=response_buf) 293 | 294 | # create and send the command 295 | buf = self._cmdbuf 296 | buf[0] = 0x40 | cmd 297 | # We address by byte because cdv is 512. Instead of multiplying, shift 298 | # the data to the correct spot so that we don't risk creating a long 299 | # int. 300 | buf[1] = (block >> 15) & 0xFF 301 | buf[2] = (block >> 7) & 0xFF 302 | buf[3] = (block << 1) & 0xFF 303 | buf[4] = 0 304 | 305 | if crc == 0: 306 | buf[5] = calculate_crc(buf[:-1]) 307 | else: 308 | buf[5] = crc 309 | 310 | result = -1 311 | self._wait_for_ready(card) 312 | 313 | card.write(buf) 314 | 315 | # wait for the response (response[7] == 0) 316 | for _ in range(_CMD_TIMEOUT): 317 | card.readinto(buf, end=1, write_value=0xFF) 318 | if not (buf[0] & 0x80): 319 | result = buf[0] 320 | break 321 | 322 | # Disable should be removed when refactor can be tested. 323 | if response_buf != None and result == 0: 324 | self._readinto(card, response_buf) 325 | 326 | return result 327 | 328 | def _cmd_nodata(self, card: SPI, cmd: int, response: int = 0xFF) -> int: 329 | """ 330 | Issue a command to the card with no argument. 331 | 332 | :param busio.SPI card: The locked SPI bus. 333 | :param int cmd: The command number. 334 | :param int response: The expected response, default is ``0xFF`` 335 | """ 336 | buf = self._cmdbuf 337 | buf[0] = cmd 338 | buf[1] = 0xFF 339 | 340 | card.write(buf, end=2) 341 | for _ in range(_CMD_TIMEOUT): 342 | card.readinto(buf, end=1, write_value=0xFF) 343 | if buf[0] == response: 344 | return 0 # OK 345 | return 1 # timeout 346 | 347 | def _readinto( 348 | self, card: SPI, buf: WriteableBuffer, start: int = 0, end: Optional[int] = None 349 | ) -> None: 350 | """ 351 | Read a data block into buf. 352 | 353 | :param busio.SPI card: The locked SPI bus. 354 | :param WriteableBuffer buf: The buffer to write into 355 | :param int start: The first index to write data at 356 | :param int end: The index after the last byte to write to. 357 | """ 358 | if end is None: 359 | end = len(buf) 360 | 361 | # read until start byte (0xfe) 362 | buf[start] = 0xFF # busy 363 | while buf[start] != 0xFE: 364 | card.readinto(buf, start=start, end=start + 1, write_value=0xFF) 365 | 366 | card.readinto(buf, start=start, end=end, write_value=0xFF) 367 | 368 | # read checksum and throw it away 369 | card.readinto(self._cmdbuf, end=2, write_value=0xFF) 370 | 371 | def _write( 372 | self, 373 | card: SPI, 374 | token: int, 375 | buf: ReadableBuffer, 376 | start: int = 0, 377 | end: Optional[int] = None, 378 | ) -> int: 379 | """ 380 | Write a data block to the card. 381 | 382 | :param busio.SPI card: The locked SPI bus. 383 | :param int token: The start token 384 | :param ReadableBuffer buf: The buffer to write from 385 | :param int start: The first index to read data from 386 | :param int end: The index after the last byte to read from. 387 | """ 388 | cmd = self._cmdbuf 389 | if end is None: 390 | end = len(buf) 391 | 392 | self._wait_for_ready(card) 393 | 394 | # send: start of block, data, checksum 395 | cmd[0] = token 396 | card.write(cmd, end=1) 397 | card.write(buf, start=start, end=end) 398 | cmd[0] = 0xFF 399 | cmd[1] = 0xFF 400 | card.write(cmd, end=2) 401 | 402 | # check the response 403 | 404 | # Disable should be removed when refactor can be tested 405 | for _ in range(_CMD_TIMEOUT): 406 | card.readinto(cmd, end=1, write_value=0xFF) 407 | if not (cmd[0] & 0x80): 408 | if (cmd[0] & 0x1F) != 0x05: 409 | return -1 410 | else: 411 | break 412 | 413 | # wait for write to finish 414 | card.readinto(cmd, end=1, write_value=0xFF) 415 | while cmd[0] == 0: 416 | card.readinto(cmd, end=1, write_value=0xFF) 417 | 418 | return 0 # worked 419 | 420 | def count(self) -> int: 421 | """ 422 | Returns the total number of sectors. 423 | 424 | :return: The number of 512-byte blocks 425 | :rtype: int 426 | """ 427 | return self._sectors 428 | 429 | def readblocks(self, start_block: int, buf: WriteableBuffer) -> int: 430 | """ 431 | Read one or more blocks from the card 432 | 433 | :param int start_block: The block to start reading from 434 | :param WriteableBuffer buf: The buffer to write into. Length must be multiple of 512. 435 | """ 436 | nblocks, err = divmod(len(buf), 512) 437 | assert nblocks and not err, "Buffer length is invalid" 438 | with self._spi as card: 439 | if nblocks == 1: 440 | # CMD17: set read address for single block 441 | # We use _block_cmd to read our data so that the chip select line 442 | # isn't toggled between the command, response and data. 443 | if self._block_cmd(card, 17, start_block, 0, response_buf=buf) != 0: 444 | return 1 445 | else: 446 | # CMD18: set read address for multiple blocks 447 | if self._block_cmd(card, 18, start_block, 0) != 0: 448 | return 1 449 | offset = 0 450 | while nblocks: 451 | self._readinto(card, buf, start=offset, end=(offset + 512)) 452 | offset += 512 453 | nblocks -= 1 454 | ret = self._cmd(card, 12, 0, 0x61, wait=False) 455 | # return first status 0 or last before card ready (0xff) 456 | while ret != 0: 457 | card.readinto(self._single_byte, write_value=0xFF) 458 | if self._single_byte[0] & 0x80: 459 | return ret 460 | ret = self._single_byte[0] 461 | return 0 462 | 463 | def writeblocks(self, start_block: int, buf: ReadableBuffer) -> int: 464 | """ 465 | Write one or more blocks to the card 466 | 467 | :param int start_block: The block to start writing to 468 | :param ReadableBuffer buf: The buffer to write into. Length must be multiple of 512. 469 | """ 470 | nblocks, err = divmod(len(buf), 512) 471 | assert nblocks and not err, "Buffer length is invalid" 472 | with self._spi as card: 473 | if nblocks == 1: 474 | # CMD24: set write address for single block 475 | if self._block_cmd(card, 24, start_block, 0) != 0: 476 | return 1 477 | 478 | # send the data 479 | self._write(card, _TOKEN_DATA, buf) 480 | else: 481 | # CMD25: set write address for first block 482 | if self._block_cmd(card, 25, start_block, 0) != 0: 483 | return 1 484 | # send the data 485 | offset = 0 486 | while nblocks: 487 | self._write(card, _TOKEN_CMD25, buf, start=offset, end=(offset + 512)) 488 | offset += 512 489 | nblocks -= 1 490 | self._wait_for_ready(card) 491 | self._cmd_nodata(card, _TOKEN_STOP_TRAN, 0x0) 492 | return 0 493 | 494 | 495 | def _calculate_crc_table() -> bytearray: 496 | """Precompute the table used in calculate_crc.""" 497 | # Code converted from https://github.com/hazelnusse/crc7/blob/master/crc7.cc by devoh747 498 | # With permission from Dale Lukas Peterson 499 | # 8/6/2019 500 | 501 | crc_table = bytearray(256) 502 | crc_poly = const(0x89) # the value of our CRC-7 polynomial 503 | 504 | # generate a table value for all 256 possible byte values 505 | for i in range(256): 506 | if i & 0x80: 507 | crc_table[i] = i ^ crc_poly 508 | else: 509 | crc_table[i] = i 510 | for _ in range(1, 8): 511 | crc_table[i] = crc_table[i] << 1 512 | if crc_table[i] & 0x80: 513 | crc_table[i] = crc_table[i] ^ crc_poly 514 | return crc_table 515 | 516 | 517 | CRC_TABLE = _calculate_crc_table() 518 | 519 | 520 | def calculate_crc(message: ReadableBuffer) -> int: 521 | """ 522 | Calculate the CRC of message[0:5], using a precomputed table in CRC_TABLE. 523 | 524 | :param bytearray message: Where each index is a byte 525 | """ 526 | 527 | crc = 0 528 | # All messages in _cmd are 5 bytes including the cmd.. The 6th byte is the crc value. 529 | for i in range(0, 5): 530 | crc = CRC_TABLE[(crc << 1) ^ message[i]] 531 | 532 | return (crc << 1) | 1 533 | -------------------------------------------------------------------------------- /docs/_static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_SD/4014be22e13e5e55f2b9d904c7bb1c58c11adc1a/docs/_static/favicon.ico -------------------------------------------------------------------------------- /docs/_static/favicon.ico.license: -------------------------------------------------------------------------------- 1 | SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries 2 | 3 | SPDX-License-Identifier: CC-BY-4.0 4 | -------------------------------------------------------------------------------- /docs/api.rst: -------------------------------------------------------------------------------- 1 | 2 | .. If you created a package, create one automodule per module in the package. 3 | 4 | API Reference 5 | ############# 6 | 7 | .. automodule:: adafruit_sdcard 8 | :members: 9 | -------------------------------------------------------------------------------- /docs/api.rst.license: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | import datetime 6 | import os 7 | import sys 8 | 9 | sys.path.insert(0, os.path.abspath("..")) 10 | 11 | # -- General configuration ------------------------------------------------ 12 | 13 | # Add any Sphinx extension module names here, as strings. They can be 14 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 15 | # ones. 16 | extensions = [ 17 | "sphinx.ext.autodoc", 18 | "sphinxcontrib.jquery", 19 | "sphinx.ext.intersphinx", 20 | "sphinx.ext.viewcode", 21 | ] 22 | 23 | 24 | # autodoc_mock_imports = ["adafruit_bus_device", "micropython"] 25 | 26 | intersphinx_mapping = { 27 | "python": ("https://docs.python.org/3", None), 28 | "BusDevice": ( 29 | "https://docs.circuitpython.org/projects/busdevice/en/latest/", 30 | None, 31 | ), 32 | "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), 33 | } 34 | 35 | # Add any paths that contain templates here, relative to this directory. 36 | templates_path = ["_templates"] 37 | 38 | source_suffix = ".rst" 39 | 40 | # The master toctree document. 41 | master_doc = "index" 42 | 43 | # General information about the project. 44 | project = "Adafruit SD Card Library" 45 | creation_year = "2017" 46 | current_year = str(datetime.datetime.now().year) 47 | year_duration = ( 48 | current_year if current_year == creation_year else creation_year + " - " + current_year 49 | ) 50 | copyright = year_duration + " Scott Shawcroft" 51 | author = "Scott Shawcroft" 52 | 53 | # The version info for the project you're documenting, acts as replacement for 54 | # |version| and |release|, also used in various other places throughout the 55 | # built documents. 56 | # 57 | # The short X.Y version. 58 | version = "1.0" 59 | # The full version, including alpha/beta/rc tags. 60 | release = "1.0" 61 | 62 | # The language for content autogenerated by Sphinx. Refer to documentation 63 | # for a list of supported languages. 64 | # 65 | # This is also used if you do content translation via gettext catalogs. 66 | # Usually you set "language" from the command line for these cases. 67 | language = "en" 68 | 69 | # List of patterns, relative to source directory, that match files and 70 | # directories to ignore when looking for source files. 71 | # This patterns also effect to html_static_path and html_extra_path 72 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] 73 | 74 | # The reST default role (used for this markup: `text`) to use for all 75 | # documents. 76 | # 77 | default_role = "any" 78 | 79 | # If true, '()' will be appended to :func: etc. cross-reference text. 80 | # 81 | add_function_parentheses = True 82 | 83 | # The name of the Pygments (syntax highlighting) style to use. 84 | pygments_style = "sphinx" 85 | 86 | # If true, `todo` and `todoList` produce output, else they produce nothing. 87 | todo_include_todos = False 88 | 89 | # If this is True, todo emits a warning for each TODO entries. The default is False. 90 | todo_emit_warnings = True 91 | 92 | 93 | # -- Options for HTML output ---------------------------------------------- 94 | 95 | # The theme to use for HTML and HTML Help pages. See the documentation for 96 | # a list of builtin themes. 97 | # 98 | import sphinx_rtd_theme 99 | 100 | html_theme = "sphinx_rtd_theme" 101 | 102 | # Add any paths that contain custom static files (such as style sheets) here, 103 | # relative to this directory. They are copied after the builtin static files, 104 | # so a file named "default.css" will overwrite the builtin "default.css". 105 | html_static_path = ["_static"] 106 | 107 | # The name of an image file (relative to this directory) to use as a favicon of 108 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 109 | # pixels large. 110 | # 111 | html_favicon = "_static/favicon.ico" 112 | 113 | # Output file base name for HTML help builder. 114 | htmlhelp_basename = "AdafruitSD CardLibrarydoc" 115 | 116 | # -- Options for LaTeX output --------------------------------------------- 117 | 118 | latex_elements = { 119 | # The paper size ('letterpaper' or 'a4paper'). 120 | # 121 | # 'papersize': 'letterpaper', 122 | # The font size ('10pt', '11pt' or '12pt'). 123 | # 124 | # 'pointsize': '10pt', 125 | # Additional stuff for the LaTeX preamble. 126 | # 127 | # 'preamble': '', 128 | # Latex figure (float) alignment 129 | # 130 | # 'figure_align': 'htbp', 131 | } 132 | 133 | # Grouping the document tree into LaTeX files. List of tuples 134 | # (source start file, target name, title, 135 | # author, documentclass [howto, manual, or own class]). 136 | latex_documents = [ 137 | ( 138 | master_doc, 139 | "AdafruitSD CardLibrary.tex", 140 | "Adafruit SD Card Library Documentation", 141 | "Phiilip Moyer", 142 | "manual", 143 | ), 144 | ] 145 | 146 | # -- Options for manual page output --------------------------------------- 147 | 148 | # One entry per manual page. List of tuples 149 | # (source start file, name, description, authors, manual section). 150 | man_pages = [ 151 | ( 152 | master_doc, 153 | "adafruitSD Cardlibrary", 154 | "Adafruit SD Card Library Documentation", 155 | [author], 156 | 1, 157 | ) 158 | ] 159 | 160 | # -- Options for Texinfo output ------------------------------------------- 161 | 162 | # Grouping the document tree into Texinfo files. List of tuples 163 | # (source start file, target name, title, author, 164 | # dir menu entry, description, category) 165 | texinfo_documents = [ 166 | ( 167 | master_doc, 168 | "AdafruitSD CardLibrary", 169 | "Adafruit SD Card Library Documentation", 170 | author, 171 | "AdafruitSD CardLibrary", 172 | "One line description of project.", 173 | "Miscellaneous", 174 | ), 175 | ] 176 | -------------------------------------------------------------------------------- /docs/examples.rst: -------------------------------------------------------------------------------- 1 | Simple test 2 | ------------ 3 | 4 | Ensure your device works with this simple test. 5 | 6 | .. literalinclude:: ../examples/sd_read_simpletest.py 7 | :caption: examples/sd_read_simpletest.py 8 | :linenos: 9 | -------------------------------------------------------------------------------- /docs/examples.rst.license: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: ../README.rst 2 | 3 | Table of Contents 4 | ================= 5 | 6 | .. toctree:: 7 | :maxdepth: 4 8 | :hidden: 9 | 10 | self 11 | 12 | .. toctree:: 13 | :caption: Examples 14 | 15 | examples 16 | 17 | .. toctree:: 18 | :caption: API Reference 19 | :maxdepth: 3 20 | 21 | api 22 | 23 | .. toctree:: 24 | :caption: Tutorials 25 | 26 | .. toctree:: 27 | :caption: Related Products 28 | 29 | Adafruit MicroSD card breakout board+ 30 | 31 | Adafruit Assembled Data Logging shield for Arduino 32 | 33 | Adafruit Feather M0 Adalogger 34 | 35 | Adalogger FeatherWing - RTC + SD Add-on For All Feather Boards 36 | 37 | .. toctree:: 38 | :caption: Other Links 39 | 40 | Download from GitHub 41 | Download Library Bundle 42 | CircuitPython Reference Documentation 43 | CircuitPython Support Forum 44 | Discord Chat 45 | Adafruit Learning System 46 | Adafruit Blog 47 | Adafruit Store 48 | 49 | Indices and tables 50 | ================== 51 | 52 | * :ref:`genindex` 53 | * :ref:`modindex` 54 | * :ref:`search` 55 | -------------------------------------------------------------------------------- /docs/index.rst.license: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | sphinx 6 | sphinxcontrib-jquery 7 | sphinx-rtd-theme 8 | -------------------------------------------------------------------------------- /examples/sd_read_simpletest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # SPDX-License-Identifier: MIT 3 | 4 | import os 5 | 6 | import board 7 | import busio 8 | import digitalio 9 | import storage 10 | 11 | import adafruit_sdcard 12 | 13 | # The SD_CS pin is the chip select line. 14 | # 15 | # The Adalogger Featherwing with ESP8266 Feather, the SD CS pin is on board.D15 16 | # The Adalogger Featherwing with Atmel M0 Feather, it's on board.D10 17 | # The Adafruit Feather M0 Adalogger use board.SD_CS 18 | # For the breakout boards use any pin that is not taken by SPI 19 | 20 | SD_CS = board.SD_CS # setup for M0 Adalogger; change as needed 21 | 22 | # Connect to the card and mount the filesystem. 23 | spi = busio.SPI(board.SCK, board.MOSI, board.MISO) 24 | cs = digitalio.DigitalInOut(SD_CS) 25 | sdcard = adafruit_sdcard.SDCard(spi, cs) 26 | vfs = storage.VfsFat(sdcard) 27 | storage.mount(vfs, "/sd") 28 | 29 | # Use the filesystem as normal! Our files are under /sd 30 | 31 | 32 | # This helper function will print the contents of the SD 33 | def print_directory(path, tabs=0): 34 | for file in os.listdir(path): 35 | stats = os.stat(path + "/" + file) 36 | filesize = stats[6] 37 | isdir = stats[0] & 0x4000 38 | 39 | if filesize < 1000: 40 | sizestr = str(filesize) + " bytes" 41 | elif filesize < 1000000: 42 | sizestr = "%0.1f KB" % (filesize / 1000) 43 | else: 44 | sizestr = "%0.1f MB" % (filesize / 1000000) 45 | 46 | prettyprintname = "" 47 | for _ in range(tabs): 48 | prettyprintname += " " 49 | prettyprintname += file 50 | if isdir: 51 | prettyprintname += "/" 52 | print(f"{prettyprintname:<40} Size: {sizestr:>10}") 53 | 54 | # recursively print directory contents 55 | if isdir: 56 | print_directory(path + "/" + file, tabs + 1) 57 | 58 | 59 | print("Files on filesystem:") 60 | print("====================") 61 | print_directory("/sd") 62 | -------------------------------------------------------------------------------- /optional_requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | [build-system] 6 | requires = [ 7 | "setuptools", 8 | "wheel", 9 | "setuptools-scm", 10 | ] 11 | 12 | [project] 13 | name = "adafruit-circuitpython-sd" 14 | description = "CircuitPython library for SD cards." 15 | version = "0.0.0+auto.0" 16 | readme = "README.rst" 17 | authors = [ 18 | {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} 19 | ] 20 | urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_SD"} 21 | keywords = [ 22 | "adafruit", 23 | "sdcard", 24 | "sd", 25 | "card", 26 | "mount", 27 | "storage", 28 | "featherwing", 29 | "adaloggerbreakout", 30 | "hardware", 31 | "micropython", 32 | "circuitpython", 33 | ] 34 | license = {text = "MIT"} 35 | classifiers = [ 36 | "Intended Audience :: Developers", 37 | "Topic :: Software Development :: Libraries", 38 | "Topic :: Software Development :: Embedded Systems", 39 | "Topic :: System :: Hardware", 40 | "License :: OSI Approved :: MIT License", 41 | "Programming Language :: Python :: 3", 42 | ] 43 | dynamic = ["dependencies", "optional-dependencies"] 44 | 45 | [tool.setuptools] 46 | py-modules = ["adafruit_sdcard"] 47 | 48 | [tool.setuptools.dynamic] 49 | dependencies = {file = ["requirements.txt"]} 50 | optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} 51 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | Adafruit-Blinka>=7.0.0 6 | adafruit-circuitpython-busdevice 7 | adafruit-circuitpython-typing 8 | -------------------------------------------------------------------------------- /ruff.toml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | target-version = "py38" 6 | line-length = 100 7 | 8 | [lint] 9 | preview = true 10 | select = ["I", "PL", "UP"] 11 | 12 | extend-select = [ 13 | "D419", # empty-docstring 14 | "E501", # line-too-long 15 | "W291", # trailing-whitespace 16 | "PLC0414", # useless-import-alias 17 | "PLC2401", # non-ascii-name 18 | "PLC2801", # unnecessary-dunder-call 19 | "PLC3002", # unnecessary-direct-lambda-call 20 | "E999", # syntax-error 21 | "PLE0101", # return-in-init 22 | "F706", # return-outside-function 23 | "F704", # yield-outside-function 24 | "PLE0116", # continue-in-finally 25 | "PLE0117", # nonlocal-without-binding 26 | "PLE0241", # duplicate-bases 27 | "PLE0302", # unexpected-special-method-signature 28 | "PLE0604", # invalid-all-object 29 | "PLE0605", # invalid-all-format 30 | "PLE0643", # potential-index-error 31 | "PLE0704", # misplaced-bare-raise 32 | "PLE1141", # dict-iter-missing-items 33 | "PLE1142", # await-outside-async 34 | "PLE1205", # logging-too-many-args 35 | "PLE1206", # logging-too-few-args 36 | "PLE1307", # bad-string-format-type 37 | "PLE1310", # bad-str-strip-call 38 | "PLE1507", # invalid-envvar-value 39 | "PLE2502", # bidirectional-unicode 40 | "PLE2510", # invalid-character-backspace 41 | "PLE2512", # invalid-character-sub 42 | "PLE2513", # invalid-character-esc 43 | "PLE2514", # invalid-character-nul 44 | "PLE2515", # invalid-character-zero-width-space 45 | "PLR0124", # comparison-with-itself 46 | "PLR0202", # no-classmethod-decorator 47 | "PLR0203", # no-staticmethod-decorator 48 | "UP004", # useless-object-inheritance 49 | "PLR0206", # property-with-parameters 50 | "PLR0904", # too-many-public-methods 51 | "PLR0911", # too-many-return-statements 52 | "PLR0912", # too-many-branches 53 | "PLR0913", # too-many-arguments 54 | "PLR0914", # too-many-locals 55 | "PLR0915", # too-many-statements 56 | "PLR0916", # too-many-boolean-expressions 57 | "PLR1702", # too-many-nested-blocks 58 | "PLR1704", # redefined-argument-from-local 59 | "PLR1711", # useless-return 60 | "C416", # unnecessary-comprehension 61 | "PLR1733", # unnecessary-dict-index-lookup 62 | "PLR1736", # unnecessary-list-index-lookup 63 | 64 | # ruff reports this rule is unstable 65 | #"PLR6301", # no-self-use 66 | 67 | "PLW0108", # unnecessary-lambda 68 | "PLW0120", # useless-else-on-loop 69 | "PLW0127", # self-assigning-variable 70 | "PLW0129", # assert-on-string-literal 71 | "B033", # duplicate-value 72 | "PLW0131", # named-expr-without-context 73 | "PLW0245", # super-without-brackets 74 | "PLW0406", # import-self 75 | "PLW0602", # global-variable-not-assigned 76 | "PLW0603", # global-statement 77 | "PLW0604", # global-at-module-level 78 | 79 | # fails on the try: import typing used by libraries 80 | #"F401", # unused-import 81 | 82 | "F841", # unused-variable 83 | "E722", # bare-except 84 | "PLW0711", # binary-op-exception 85 | "PLW1501", # bad-open-mode 86 | "PLW1508", # invalid-envvar-default 87 | "PLW1509", # subprocess-popen-preexec-fn 88 | "PLW2101", # useless-with-lock 89 | "PLW3301", # nested-min-max 90 | ] 91 | 92 | ignore = [ 93 | "PLR2004", # magic-value-comparison 94 | "UP030", # format literals 95 | "PLW1514", # unspecified-encoding 96 | "PLR0913", # too-many-arguments 97 | "PLR0915", # too-many-statements 98 | "PLR0917", # too-many-positional-arguments 99 | "PLR0904", # too-many-public-methods 100 | "PLR0912", # too-many-branches 101 | "PLR0916", # too-many-boolean-expressions 102 | "PLR1702", # too-many-nested-blocks 103 | ] 104 | 105 | [format] 106 | line-ending = "lf" 107 | --------------------------------------------------------------------------------