├── .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_sht31d.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 ├── sht31d_periodic_mode.py ├── sht31d_simple_mode.py └── sht31d_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) 2017 Jerry Needell 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /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-sht31d/badge/?version=latest 6 | :target: https://docs.circuitpython.org/projects/sht31d/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_SHT31D/workflows/Build%20CI/badge.svg 14 | :target: https://github.com/adafruit/Adafruit_CircuitPython_SHT31D/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 module for the SHT31-D temperature and humidity sensor. 22 | 23 | Dependencies 24 | ============= 25 | This driver depends on: 26 | 27 | * `Adafruit CircuitPython `_ 28 | * `Bus Device `_ 29 | 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 | Installing from PyPI 36 | ==================== 37 | 38 | On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from 39 | PyPI `_. To install for current user: 40 | 41 | .. code-block:: shell 42 | 43 | pip3 install adafruit-circuitpython-sht31d 44 | 45 | To install system-wide (this may be required in some cases): 46 | 47 | .. code-block:: shell 48 | 49 | sudo pip3 install adafruit-circuitpython-sht31d 50 | 51 | To install in a virtual environment in your current project: 52 | 53 | .. code-block:: shell 54 | 55 | mkdir project-name && cd project-name 56 | python3 -m venv .env 57 | source .env/bin/activate 58 | pip3 install adafruit-circuitpython-sht31d 59 | 60 | Usage Example 61 | ============= 62 | You must import the library to use it: 63 | 64 | .. code:: python 65 | 66 | import adafruit_sht31d 67 | 68 | This driver takes an instantiated and active I2C object (from the `busio` or 69 | the `bitbangio` library) as an argument to its constructor. The way to create 70 | an I2C object depends on the board you are using. 71 | 72 | .. code:: python 73 | 74 | import board 75 | 76 | i2c = board.I2C() 77 | 78 | Once you have created the I2C interface object, you can use it to instantiate 79 | the sensor object: 80 | 81 | .. code:: python 82 | 83 | sensor = adafruit_sht31d.SHT31D(i2c) 84 | 85 | 86 | And then you can start measuring the temperature and humidity: 87 | 88 | .. code:: python 89 | 90 | print(sensor.temperature) 91 | print(sensor.relative_humidity) 92 | 93 | You can instruct the sensor to periodically measure the temperature and 94 | humidity, storing the result in its internal cache: 95 | 96 | .. code:: python 97 | 98 | sensor.mode = adafruit_sht31d.MODE_PERIODIC 99 | 100 | You can adjust the frequency at which the sensor periodically gathers data to: 101 | 0.5, 1, 2, 4 or 10 Hz. The following adjusts the frequency to 2 Hz: 102 | 103 | .. code:: python 104 | 105 | sensor.frequency = adafruit_sht31d.FREQUENCY_2 106 | 107 | The sensor is capable of storing eight results. The sensor stores these 108 | results in an internal FILO cache. Retrieving these results is simlilar to 109 | taking a measurement. The sensor clears its cache once the stored data is read. 110 | The sensor always returns eight data points. The list of results is backfilled 111 | with the maximum output values of 130.0 ºC and 100.01831417975366 % RH: 112 | 113 | .. code:: python 114 | 115 | print(sensor.temperature) 116 | print(sensor.relative_humidity) 117 | 118 | The sensor will continue to collect data at the set interval until it is 119 | returned to single shot data acquisition mode: 120 | 121 | .. code:: python 122 | 123 | sensor.mode = adafruit_sht31d.MODE_SINGLE 124 | 125 | Documentation 126 | ============= 127 | 128 | API documentation for this library can be found on `Read the Docs `_. 129 | 130 | For information on building library documentation, please check out `this guide `_. 131 | 132 | Contributing 133 | ============ 134 | 135 | Contributions are welcome! Please read our `Code of Conduct 136 | `_ 137 | before contributing to help this project stay welcoming. 138 | -------------------------------------------------------------------------------- /README.rst.license: -------------------------------------------------------------------------------- 1 | SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | 3 | SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /adafruit_sht31d.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Jerry Needell for Adafruit Industries 2 | # SPDX-FileCopyrightText: 2019 Llewelyn Trahaearn for Adafruit Industries 3 | # 4 | # SPDX-License-Identifier: MIT 5 | 6 | """ 7 | `adafruit_sht31d` 8 | ==================================================== 9 | 10 | This is a CircuitPython driver for the SHT31-D temperature and humidity sensor. 11 | 12 | * Author(s): Jerry Needell, Llewelyn Trahaearn 13 | 14 | Implementation Notes 15 | -------------------- 16 | 17 | **Hardware:** 18 | 19 | * Adafruit SHT31-D temperature and humidity sensor Breakout: https://www.adafruit.com/product/2857 20 | 21 | **Software and Dependencies:** 22 | 23 | * Adafruit CircuitPython firmware for the supported boards: 24 | https://circuitpython.org/downloads 25 | 26 | * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice 27 | """ 28 | 29 | # imports 30 | import struct 31 | import time 32 | 33 | from adafruit_bus_device.i2c_device import I2CDevice 34 | from micropython import const 35 | 36 | try: 37 | from typing import List, Tuple, Union 38 | 39 | from busio import I2C 40 | from circuitpython_typing import ReadableBuffer 41 | from typing_extensions import Literal 42 | except ImportError: 43 | pass 44 | 45 | 46 | __version__ = "0.0.0+auto.0" 47 | __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_SHT31D.git" 48 | 49 | 50 | _SHT31_DEFAULT_ADDRESS = const(0x44) 51 | _SHT31_SECONDARY_ADDRESS = const(0x45) 52 | 53 | _SHT31_ADDRESSES = (_SHT31_DEFAULT_ADDRESS, _SHT31_SECONDARY_ADDRESS) 54 | 55 | _SHT31_READSERIALNBR = const(0x3780) 56 | _SHT31_READSTATUS = const(0xF32D) 57 | _SHT31_CLEARSTATUS = const(0x3041) 58 | _SHT31_HEATER_ENABLE = const(0x306D) 59 | _SHT31_HEATER_DISABLE = const(0x3066) 60 | _SHT31_SOFTRESET = const(0x30A2) 61 | _SHT31_NOSLEEP = const(0x303E) 62 | _SHT31_PERIODIC_FETCH = const(0xE000) 63 | _SHT31_PERIODIC_BREAK = const(0x3093) 64 | 65 | MODE_SINGLE = "Single" 66 | MODE_PERIODIC = "Periodic" 67 | 68 | _SHT31_MODES = (MODE_SINGLE, MODE_PERIODIC) 69 | 70 | REP_HIGH = "High" 71 | REP_MED = "Medium" 72 | REP_LOW = "Low" 73 | 74 | _SHT31_REP = (REP_HIGH, REP_MED, REP_LOW) 75 | 76 | FREQUENCY_0_5 = 0.5 77 | FREQUENCY_1 = 1 78 | FREQUENCY_2 = 2 79 | FREQUENCY_4 = 4 80 | FREQUENCY_10 = 10 81 | 82 | _SHT31_FREQUENCIES = ( 83 | FREQUENCY_0_5, 84 | FREQUENCY_1, 85 | FREQUENCY_2, 86 | FREQUENCY_4, 87 | FREQUENCY_10, 88 | ) 89 | 90 | _SINGLE_COMMANDS = ( 91 | (REP_LOW, const(False), const(0x2416)), 92 | (REP_MED, const(False), const(0x240B)), 93 | (REP_HIGH, const(False), const(0x2400)), 94 | (REP_LOW, const(True), const(0x2C10)), 95 | (REP_MED, const(True), const(0x2C0D)), 96 | (REP_HIGH, const(True), const(0x2C06)), 97 | ) 98 | 99 | _PERIODIC_COMMANDS = ( 100 | (True, None, const(0x2B32)), 101 | (REP_LOW, FREQUENCY_0_5, const(0x202F)), 102 | (REP_MED, FREQUENCY_0_5, const(0x2024)), 103 | (REP_HIGH, FREQUENCY_0_5, const(0x2032)), 104 | (REP_LOW, FREQUENCY_1, const(0x212D)), 105 | (REP_MED, FREQUENCY_1, const(0x2126)), 106 | (REP_HIGH, FREQUENCY_1, const(0x2130)), 107 | (REP_LOW, FREQUENCY_2, const(0x222B)), 108 | (REP_MED, FREQUENCY_2, const(0x2220)), 109 | (REP_HIGH, FREQUENCY_2, const(0x2236)), 110 | (REP_LOW, FREQUENCY_4, const(0x2329)), 111 | (REP_MED, FREQUENCY_4, const(0x2322)), 112 | (REP_HIGH, FREQUENCY_4, const(0x2334)), 113 | (REP_LOW, FREQUENCY_10, const(0x272A)), 114 | (REP_MED, FREQUENCY_10, const(0x2721)), 115 | (REP_HIGH, FREQUENCY_10, const(0x2737)), 116 | ) 117 | 118 | _DELAY = ((REP_LOW, 0.0045), (REP_MED, 0.0065), (REP_HIGH, 0.0155)) 119 | 120 | 121 | def _crc(data) -> int: 122 | crc = 0xFF 123 | for byte in data: 124 | crc ^= byte 125 | for _ in range(8): 126 | if crc & 0x80: 127 | crc <<= 1 128 | crc ^= 0x31 129 | else: 130 | crc <<= 1 131 | return crc & 0xFF 132 | 133 | 134 | def _unpack(data: ReadableBuffer) -> List[int]: 135 | length = len(data) 136 | crc = [None] * (length // 3) 137 | word = [None] * (length // 3) 138 | for i in range(length // 6): 139 | word[i * 2], crc[i * 2], word[(i * 2) + 1], crc[(i * 2) + 1] = struct.unpack( 140 | ">HBHB", data[i * 6 : (i * 6) + 6] 141 | ) 142 | if crc[i * 2] == _crc(data[i * 6 : (i * 6) + 2]): 143 | length = (i + 1) * 6 144 | for i in range(length // 3): 145 | if crc[i] != _crc(data[i * 3 : (i * 3) + 2]): 146 | raise RuntimeError("CRC mismatch") 147 | return word[: length // 3] 148 | 149 | 150 | class SHT31D: 151 | """ 152 | A driver for the SHT31-D temperature and humidity sensor. 153 | 154 | :param ~busio.I2C i2c_bus: The I2C bus the SHT31-D is connected to 155 | :param int address: (optional) The I2C address of the device. Defaults to :const:`0x44` 156 | 157 | **Quickstart: Importing and using the SHT31-D** 158 | 159 | Here is an example of using the :class:`SHT31D` class. 160 | First you will need to import the libraries to use the sensor 161 | 162 | .. code-block:: python 163 | 164 | import board 165 | import adafruit_sht31d 166 | 167 | Once this is done you can define your `board.I2C` object and define your sensor object 168 | 169 | .. code-block:: python 170 | 171 | i2c = board.I2C() # uses board.SCL and board.SDA 172 | sht = adafruit_sht31d.SHT31D(i2c) 173 | 174 | Now you have access to the temperature and humidity the 175 | the :attr:`temperature` and :attr:`relative_humidity` attributes 176 | 177 | 178 | .. code-block:: python 179 | 180 | temperature = sht.temperature 181 | humidity = sht.relative_humidity 182 | 183 | """ 184 | 185 | def __init__(self, i2c_bus: I2C, address: int = _SHT31_DEFAULT_ADDRESS) -> None: 186 | if address not in _SHT31_ADDRESSES: 187 | raise ValueError(f"Invalid address: {hex(address)}") 188 | self.i2c_device = I2CDevice(i2c_bus, address) 189 | self._mode = MODE_SINGLE 190 | self._repeatability = REP_HIGH 191 | self._frequency = FREQUENCY_4 192 | self._clock_stretching = False 193 | self._art = False 194 | self._last_read = 0 195 | self._cached_temperature = None 196 | self._cached_humidity = None 197 | self._reset() 198 | 199 | def _command(self, command: int) -> None: 200 | with self.i2c_device as i2c: 201 | i2c.write(struct.pack(">H", command)) 202 | 203 | def _reset(self) -> None: 204 | """ 205 | Soft reset the device 206 | The reset command is preceded by a break command as the 207 | device will not respond to a soft reset when in 'Periodic' mode. 208 | """ 209 | self._command(_SHT31_PERIODIC_BREAK) 210 | time.sleep(0.001) 211 | self._command(_SHT31_SOFTRESET) 212 | time.sleep(0.0015) 213 | 214 | def _periodic(self) -> None: 215 | for command in _PERIODIC_COMMANDS: 216 | if self.art == command[0] or ( 217 | self.repeatability == command[0] and self.frequency == command[1] 218 | ): 219 | self._command(command[2]) 220 | time.sleep(0.001) 221 | self._last_read = 0 222 | 223 | def _data(self) -> Union[Tuple[float, float], Tuple[List[float], List[float]]]: 224 | if self.mode == MODE_PERIODIC: 225 | data = bytearray(48) 226 | data[0] = 0xFF 227 | self._command(_SHT31_PERIODIC_FETCH) 228 | time.sleep(0.001) 229 | elif self.mode == MODE_SINGLE: 230 | data = bytearray(6) 231 | data[0] = 0xFF 232 | for command in _SINGLE_COMMANDS: 233 | if self.repeatability == command[0] and self.clock_stretching == command[1]: 234 | self._command(command[2]) 235 | if not self.clock_stretching: 236 | for delay in _DELAY: 237 | if self.repeatability == delay[0]: 238 | time.sleep(delay[1]) 239 | else: 240 | time.sleep(0.001) 241 | with self.i2c_device as i2c: 242 | i2c.readinto(data) 243 | word = _unpack(data) 244 | length = len(word) 245 | temperature = [None] * (length // 2) 246 | humidity = [None] * (length // 2) 247 | for i in range(length // 2): 248 | temperature[i] = -45 + (175 * (word[i * 2] / 65535)) 249 | humidity[i] = 100 * (word[(i * 2) + 1] / 65535) 250 | if (len(temperature) == 1) and (len(humidity) == 1): 251 | return temperature[0], humidity[0] 252 | return temperature, humidity 253 | 254 | def _read(self) -> Union[Tuple[float, float], Tuple[List[float], List[float]]]: 255 | if self.mode == MODE_PERIODIC and time.time() > self._last_read + 1 / self.frequency: 256 | self._cached_temperature, self._cached_humidity = self._data() 257 | self._last_read = time.time() 258 | elif self.mode == MODE_SINGLE: 259 | self._cached_temperature, self._cached_humidity = self._data() 260 | return self._cached_temperature, self._cached_humidity 261 | 262 | @property 263 | def mode(self) -> Literal["Single", "Periodic"]: 264 | """ 265 | Operation mode 266 | Allowed values are the constants MODE_* 267 | Return the device to 'Single' mode to stop periodic data acquisition and allow it to sleep. 268 | """ 269 | return self._mode 270 | 271 | @mode.setter 272 | def mode(self, value: Literal["Single", "Periodic"]) -> None: 273 | if not value in _SHT31_MODES: 274 | raise ValueError(f"Mode '{value}' not supported") 275 | if self._mode == MODE_PERIODIC and value != MODE_PERIODIC: 276 | self._command(_SHT31_PERIODIC_BREAK) 277 | time.sleep(0.001) 278 | if value == MODE_PERIODIC and self._mode != MODE_PERIODIC: 279 | self._periodic() 280 | self._mode = value 281 | 282 | @property 283 | def repeatability(self) -> Literal["High", "Medium", "Low"]: 284 | """ 285 | Repeatability 286 | Allowed values are the constants REP_* 287 | """ 288 | return self._repeatability 289 | 290 | @repeatability.setter 291 | def repeatability(self, value: Literal["High", "Medium", "Low"]) -> None: 292 | if not value in _SHT31_REP: 293 | raise ValueError("Repeatability '{value}' not supported") 294 | if self.mode == MODE_PERIODIC and not self._repeatability == value: 295 | self._repeatability = value 296 | self._periodic() 297 | else: 298 | self._repeatability = value 299 | 300 | @property 301 | def clock_stretching(self) -> bool: 302 | """ 303 | Control clock stretching. 304 | This feature only affects 'Single' mode. 305 | """ 306 | return self._clock_stretching 307 | 308 | @clock_stretching.setter 309 | def clock_stretching(self, value: bool) -> None: 310 | self._clock_stretching = bool(value) 311 | 312 | @property 313 | def art(self) -> bool: 314 | """ 315 | Control accelerated response time 316 | This feature only affects 'Periodic' mode. 317 | """ 318 | return self._art 319 | 320 | @art.setter 321 | def art(self, value: bool) -> None: 322 | if value: 323 | self.frequency = FREQUENCY_4 324 | if self.mode == MODE_PERIODIC and not self._art == value: 325 | self._art = bool(value) 326 | self._periodic() 327 | else: 328 | self._art = bool(value) 329 | 330 | @property 331 | def frequency(self) -> float: 332 | """ 333 | Periodic data acquisition frequency 334 | Allowed values are the constants FREQUENCY_* 335 | Frequency can not be modified when ART is enabled 336 | """ 337 | return self._frequency 338 | 339 | @frequency.setter 340 | def frequency(self, value: float) -> None: 341 | if self.art: 342 | raise RuntimeError("Frequency locked to '4 Hz' when ART enabled") 343 | if not value in _SHT31_FREQUENCIES: 344 | raise ValueError("Data acquisition frequency '{value} Hz' not supported") 345 | if self.mode == MODE_PERIODIC and not self._frequency == value: 346 | self._frequency = value 347 | self._periodic() 348 | else: 349 | self._frequency = value 350 | 351 | @property 352 | def temperature(self) -> Union[float, List[float]]: 353 | """ 354 | The measured temperature in degrees Celsius. 355 | 'Single' mode reads and returns the current temperature as a float. 356 | 'Periodic' mode returns the most recent readings available from the sensor's cache 357 | in a FILO list of eight floats. This list is backfilled with with the 358 | sensor's maximum output of 130.0 when the sensor is read before the 359 | cache is full. 360 | """ 361 | temperature, _ = self._read() 362 | return temperature 363 | 364 | @property 365 | def relative_humidity(self) -> Union[float, List[float]]: 366 | """ 367 | The measured relative humidity in percent. 368 | 'Single' mode reads and returns the current humidity as a float. 369 | 'Periodic' mode returns the most recent readings available from the sensor's cache 370 | in a FILO list of eight floats. This list is backfilled with with the 371 | sensor's maximum output of 100.01831417975366 when the sensor is read 372 | before the cache is full. 373 | """ 374 | _, humidity = self._read() 375 | return humidity 376 | 377 | @property 378 | def heater(self) -> bool: 379 | """Control device's internal heater.""" 380 | return (self.status & 0x2000) != 0 381 | 382 | @heater.setter 383 | def heater(self, value: bool = False) -> None: 384 | if value: 385 | self._command(_SHT31_HEATER_ENABLE) 386 | time.sleep(0.001) 387 | else: 388 | self._command(_SHT31_HEATER_DISABLE) 389 | time.sleep(0.001) 390 | 391 | @property 392 | def status(self) -> int: 393 | """Device status.""" 394 | data = bytearray(2) 395 | self._command(_SHT31_READSTATUS) 396 | time.sleep(0.001) 397 | with self.i2c_device as i2c: 398 | i2c.readinto(data) 399 | status = data[0] << 8 | data[1] 400 | return status 401 | 402 | @property 403 | def serial_number(self) -> int: 404 | """Device serial number.""" 405 | data = bytearray(6) 406 | data[0] = 0xFF 407 | self._command(_SHT31_READSERIALNBR) 408 | time.sleep(0.001) 409 | with self.i2c_device as i2c: 410 | i2c.readinto(data) 411 | word = _unpack(data) 412 | return (word[0] << 16) | word[1] 413 | -------------------------------------------------------------------------------- /docs/_static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_SHT31D/01d9bee05612cf465dcedde1d0449c9355b7232e/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_sht31d 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 | # Uncomment the below if you use native CircuitPython modules such as 24 | # digitalio, micropython and busio. List the modules you use. Without it, the 25 | # autodoc module docs will fail to generate with a warning. 26 | # autodoc_mock_imports = ["micropython", "adafruit_bus_device"] 27 | 28 | intersphinx_mapping = { 29 | "python": ("https://docs.python.org/3", None), 30 | "BusDevice": ( 31 | "https://docs.circuitpython.org/projects/busdevice/en/latest/", 32 | None, 33 | ), 34 | "Register": ( 35 | "https://docs.circuitpython.org/projects/register/en/latest/", 36 | None, 37 | ), 38 | "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), 39 | } 40 | 41 | # Add any paths that contain templates here, relative to this directory. 42 | templates_path = ["_templates"] 43 | 44 | source_suffix = ".rst" 45 | 46 | # The master toctree document. 47 | master_doc = "index" 48 | 49 | # General information about the project. 50 | project = "Adafruit SHT31D Library" 51 | creation_year = "2017" 52 | current_year = str(datetime.datetime.now().year) 53 | year_duration = ( 54 | current_year if current_year == creation_year else creation_year + " - " + current_year 55 | ) 56 | copyright = year_duration + " Jerry Needell" 57 | author = "Jerry Needell" 58 | 59 | # The version info for the project you're documenting, acts as replacement for 60 | # |version| and |release|, also used in various other places throughout the 61 | # built documents. 62 | # 63 | # The short X.Y version. 64 | version = "1.0" 65 | # The full version, including alpha/beta/rc tags. 66 | release = "1.0" 67 | 68 | # The language for content autogenerated by Sphinx. Refer to documentation 69 | # for a list of supported languages. 70 | # 71 | # This is also used if you do content translation via gettext catalogs. 72 | # Usually you set "language" from the command line for these cases. 73 | language = "en" 74 | 75 | # List of patterns, relative to source directory, that match files and 76 | # directories to ignore when looking for source files. 77 | # This patterns also effect to html_static_path and html_extra_path 78 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] 79 | 80 | # The reST default role (used for this markup: `text`) to use for all 81 | # documents. 82 | # 83 | default_role = "any" 84 | 85 | # If true, '()' will be appended to :func: etc. cross-reference text. 86 | # 87 | add_function_parentheses = True 88 | 89 | # The name of the Pygments (syntax highlighting) style to use. 90 | pygments_style = "sphinx" 91 | 92 | # If true, `todo` and `todoList` produce output, else they produce nothing. 93 | todo_include_todos = False 94 | 95 | # If this is True, todo emits a warning for each TODO entries. The default is False. 96 | todo_emit_warnings = True 97 | 98 | 99 | # -- Options for HTML output ---------------------------------------------- 100 | 101 | # The theme to use for HTML and HTML Help pages. See the documentation for 102 | # a list of builtin themes. 103 | # 104 | import sphinx_rtd_theme 105 | 106 | html_theme = "sphinx_rtd_theme" 107 | 108 | # Add any paths that contain custom static files (such as style sheets) here, 109 | # relative to this directory. They are copied after the builtin static files, 110 | # so a file named "default.css" will overwrite the builtin "default.css". 111 | html_static_path = ["_static"] 112 | 113 | # The name of an image file (relative to this directory) to use as a favicon of 114 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 115 | # pixels large. 116 | # 117 | html_favicon = "_static/favicon.ico" 118 | 119 | # Output file base name for HTML help builder. 120 | htmlhelp_basename = "AdafruitSht31Librarydoc" 121 | 122 | # -- Options for LaTeX output --------------------------------------------- 123 | 124 | latex_elements = { 125 | # The paper size ('letterpaper' or 'a4paper'). 126 | # 127 | # 'papersize': 'letterpaper', 128 | # The font size ('10pt', '11pt' or '12pt'). 129 | # 130 | # 'pointsize': '10pt', 131 | # Additional stuff for the LaTeX preamble. 132 | # 133 | # 'preamble': '', 134 | # Latex figure (float) alignment 135 | # 136 | # 'figure_align': 'htbp', 137 | } 138 | 139 | # Grouping the document tree into LaTeX files. List of tuples 140 | # (source start file, target name, title, 141 | # author, documentclass [howto, manual, or own class]). 142 | latex_documents = [ 143 | ( 144 | master_doc, 145 | "Adafruitsht31Library.tex", 146 | "Adafruitsht31 Library Documentation", 147 | author, 148 | "manual", 149 | ), 150 | ] 151 | 152 | # -- Options for manual page output --------------------------------------- 153 | 154 | # One entry per manual page. List of tuples 155 | # (source start file, name, description, authors, manual section). 156 | man_pages = [ 157 | ( 158 | master_doc, 159 | "Adafruitsht31library", 160 | "Adafruit sht31 Library Documentation", 161 | [author], 162 | 1, 163 | ) 164 | ] 165 | 166 | # -- Options for Texinfo output ------------------------------------------- 167 | 168 | # Grouping the document tree into Texinfo files. List of tuples 169 | # (source start file, target name, title, author, 170 | # dir menu entry, description, category) 171 | texinfo_documents = [ 172 | ( 173 | master_doc, 174 | "Adafruitsht31Library", 175 | "Adafruit sht31 Library Documentation", 176 | author, 177 | "Adafruitsht31Library", 178 | "One line description of project.", 179 | "Miscellaneous", 180 | ), 181 | ] 182 | -------------------------------------------------------------------------------- /docs/examples.rst: -------------------------------------------------------------------------------- 1 | Simple test 2 | ------------ 3 | 4 | Ensure your device works with this simple test. 5 | 6 | .. literalinclude:: ../examples/sht31d_simpletest.py 7 | :caption: examples/sht31d_simpletest.py 8 | :linenos: 9 | 10 | Simple Mode 11 | ------------ 12 | 13 | Example in how to use the sensor in simple mode 14 | 15 | .. literalinclude:: ../examples/sht31d_simple_mode.py 16 | :caption: examples/sht31d_simple_mode.py 17 | :linenos: 18 | 19 | Periodic Mode 20 | ------------- 21 | 22 | Example in how to use the sensor in periodic mode 23 | 24 | .. literalinclude:: ../examples/sht31d_periodic_mode.py 25 | :caption: examples/sht31d_periodic_mode.py 26 | :linenos: 27 | -------------------------------------------------------------------------------- /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 | Adafruit Sensirion SHT31-D Temperature & Humidity Sensor Breakout 27 | 28 | .. toctree:: 29 | :caption: Related Products 30 | 31 | Adafruit Sensirion SHT31-D Temperature & Humidity Sensor Breakout 32 | 33 | .. toctree:: 34 | :caption: Other Links 35 | 36 | Download from GitHub 37 | Download Library Bundle 38 | CircuitPython Reference Documentation 39 | CircuitPython Support Forum 40 | Discord Chat 41 | Adafruit Learning System 42 | Adafruit Blog 43 | Adafruit Store 44 | 45 | Indices and tables 46 | ================== 47 | 48 | * :ref:`genindex` 49 | * :ref:`modindex` 50 | * :ref:`search` 51 | -------------------------------------------------------------------------------- /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/sht31d_periodic_mode.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # SPDX-License-Identifier: MIT 3 | 4 | import time 5 | 6 | import board 7 | 8 | import adafruit_sht31d 9 | 10 | # Create sensor object, communicating over the board's default I2C bus 11 | i2c = board.I2C() # uses board.SCL and board.SDA 12 | # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller 13 | sensor = adafruit_sht31d.SHT31D(i2c) 14 | 15 | print("\033[1mSensor\033[0m = SHT31-D") 16 | print("\033[1mSerial Number\033[0m = ", sensor.serial_number, "\n") 17 | sensor.frequency = adafruit_sht31d.FREQUENCY_1 18 | sensor.mode = adafruit_sht31d.MODE_PERIODIC 19 | for i in range(3): 20 | print("Please wait...", end="\r") 21 | if i == 2: 22 | sensor.heater = True 23 | if i == 1: 24 | time.sleep(4) 25 | print("\033[91mCache half full.\033[0m") 26 | else: 27 | time.sleep(8) 28 | if sensor.heater: 29 | print("\033[1mHeater:\033[0m On ") 30 | sensor.heater = False 31 | print("\033[1mTemperature:\033[0m ", sensor.temperature) 32 | if not sensor.heater: 33 | print("\033[1mHeater:\033[0m Off") 34 | print("\033[1mHumidity:\033[0m ", sensor.relative_humidity, "\n") 35 | sensor.mode = adafruit_sht31d.MODE_SINGLE 36 | -------------------------------------------------------------------------------- /examples/sht31d_simple_mode.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # SPDX-License-Identifier: MIT 3 | 4 | import board 5 | 6 | import adafruit_sht31d 7 | 8 | # Create sensor object, communicating over the board's default I2C bus 9 | i2c = board.I2C() # uses board.SCL and board.SDA 10 | # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller 11 | sensor = adafruit_sht31d.SHT31D(i2c) 12 | 13 | print("\033[1mSensor\033[0m = SHT31-D") 14 | print("\033[1mSerial Number\033[0m = ", sensor.serial_number, "\n") 15 | 16 | for i in range(3): 17 | if i == 0: 18 | sensor.repeatability = adafruit_sht31d.REP_LOW 19 | print("\033[1m\033[36mLow Repeatability:\033[0m\n") 20 | if i == 1: 21 | sensor.repeatability = adafruit_sht31d.REP_MED 22 | print("\n\033[1m\033[36mMedium Repeatability:\033[0m\n") 23 | if i == 2: 24 | sensor.repeatability = adafruit_sht31d.REP_HIGH 25 | sensor.clock_stretching = True 26 | print("\n\033[1m\033[36mHigh Repeatability:\033[0m") 27 | print("\033[1m\033[95mClock Stretching:\033[0m \033[92mEnabled\033[0m\n") 28 | for itr in range(3): 29 | print("\033[1mTemperature:\033[0m %0.3f ºC" % sensor.temperature) 30 | print("\033[1mHumidity:\033[0m %0.2f %%" % sensor.relative_humidity, "\n") 31 | -------------------------------------------------------------------------------- /examples/sht31d_simpletest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # SPDX-License-Identifier: MIT 3 | 4 | import time 5 | 6 | import board 7 | 8 | import adafruit_sht31d 9 | 10 | # Create sensor object, communicating over the board's default I2C bus 11 | i2c = board.I2C() # uses board.SCL and board.SDA 12 | # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller 13 | sensor = adafruit_sht31d.SHT31D(i2c) 14 | 15 | loopcount = 0 16 | while True: 17 | print("\nTemperature: %0.1f C" % sensor.temperature) 18 | print("Humidity: %0.1f %%" % sensor.relative_humidity) 19 | loopcount += 1 20 | time.sleep(2) 21 | # every 10 passes turn on the heater for 1 second 22 | if loopcount == 10: 23 | loopcount = 0 24 | sensor.heater = True 25 | print("Sensor Heater status =", sensor.heater) 26 | time.sleep(1) 27 | sensor.heater = False 28 | print("Sensor Heater status =", sensor.heater) 29 | -------------------------------------------------------------------------------- /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-sht31d" 14 | description = "CircuitPython library for SHT31-D temperature and humidity sensor." 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_SHT31D"} 21 | keywords = [ 22 | "adafruit", 23 | "sht31d", 24 | "sht31-d", 25 | "temperature", 26 | "humidity", 27 | "sensor", 28 | "hardware", 29 | "micropython", 30 | "circuitpython", 31 | ] 32 | license = {text = "MIT"} 33 | classifiers = [ 34 | "Intended Audience :: Developers", 35 | "Topic :: Software Development :: Libraries", 36 | "Topic :: Software Development :: Embedded Systems", 37 | "Topic :: System :: Hardware", 38 | "License :: OSI Approved :: MIT License", 39 | "Programming Language :: Python :: 3", 40 | ] 41 | dynamic = ["dependencies"] 42 | 43 | [tool.setuptools] 44 | py-modules = ["adafruit_sht31d"] 45 | 46 | [tool.setuptools.dynamic] 47 | dependencies = {file = ["requirements.txt"]} 48 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | Adafruit-Blinka 6 | adafruit-circuitpython-busdevice 7 | typing-extensions~=4.0 8 | adafruit-circuitpython-typing 9 | -------------------------------------------------------------------------------- /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 | "PLR6301", # could-be-static no-self-use 103 | ] 104 | 105 | [format] 106 | line-ending = "lf" 107 | --------------------------------------------------------------------------------