├── .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_ina260.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 ├── ina260_averaging.py ├── ina260_latch.py ├── ina260_modes.py └── ina260_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) 2019 Bryan Siepert for Adafruit Industries 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 | Introduction 2 | ============ 3 | 4 | .. image:: https://readthedocs.org/projects/adafruit-circuitpython-ina260/badge/?version=latest 5 | :target: https://docs.circuitpython.org/projects/ina260/en/latest/ 6 | :alt: Documentation Status 7 | 8 | .. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg 9 | :target: https://adafru.it/discord 10 | :alt: Discord 11 | 12 | .. image:: https://github.com/adafruit/Adafruit_CircuitPython_INA260/workflows/Build%20CI/badge.svg 13 | :target: https://github.com/adafruit/Adafruit_CircuitPython_INA260/actions/ 14 | :alt: Build Status 15 | 16 | .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json 17 | :target: https://github.com/astral-sh/ruff 18 | :alt: Code Style: Ruff 19 | 20 | CircuitPython driver for the TI INA260 current and power sensor 21 | 22 | 23 | Dependencies 24 | ============= 25 | This driver depends on: 26 | 27 | * `Adafruit CircuitPython `_ 28 | * `Bus Device `_ 29 | * `Register `_ 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 | .. note:: This library is not available on PyPI yet. Install documentation is included 38 | as a standard element. Stay tuned for PyPI availability! 39 | If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. 40 | On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from 41 | PyPI `_. To install for current user: 42 | 43 | .. code-block:: shell 44 | 45 | pip3 install adafruit-circuitpython-ina260 46 | 47 | To install system-wide (this may be required in some cases): 48 | 49 | .. code-block:: shell 50 | 51 | sudo pip3 install adafruit-circuitpython-ina260 52 | 53 | To install in a virtual environment in your current project: 54 | 55 | .. code-block:: shell 56 | 57 | mkdir project-name && cd project-name 58 | python3 -m venv .venv 59 | source .venv/bin/activate 60 | pip3 install adafruit-circuitpython-ina260 61 | 62 | Usage Example 63 | ============= 64 | :: 65 | 66 | import time 67 | import board 68 | import adafruit_ina260 69 | 70 | i2c = board.I2C() 71 | ina260 = adafruit_ina260.INA260(i2c) 72 | while True: 73 | print("Current: %.2f Voltage: %.2f Power:%.2f" 74 | %(ina260.current, ina260.voltage, ina260.power)) 75 | time.sleep(1) 76 | 77 | Documentation 78 | ============= 79 | 80 | API documentation for this library can be found on `Read the Docs `_. 81 | 82 | For information on building library documentation, please check out `this guide `_. 83 | 84 | Contributing 85 | ============ 86 | 87 | Contributions are welcome! Please read our `Code of Conduct 88 | `_ 89 | before contributing to help this project stay welcoming. 90 | -------------------------------------------------------------------------------- /README.rst.license: -------------------------------------------------------------------------------- 1 | SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | 3 | SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /adafruit_ina260.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: Bryan Siepert 2019 for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | """ 6 | `adafruit_ina260` 7 | ================================================================================ 8 | CircuitPython driver for the TI INA260 current and power sensor 9 | * Author(s): Bryan Siepert 10 | Implementation Notes 11 | -------------------- 12 | **Hardware:** 13 | * `INA260 Breakout `_ 14 | **Software and Dependencies:** 15 | * Adafruit CircuitPython firmware for the supported boards: 16 | * https://github.com/adafruit/circuitpython/releases 17 | * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice 18 | * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register 19 | """ 20 | 21 | # imports 22 | 23 | try: 24 | import typing 25 | 26 | from busio import I2C 27 | except ImportError: 28 | pass 29 | 30 | __version__ = "0.0.0+auto.0" 31 | __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_INA260.git" 32 | 33 | import adafruit_bus_device.i2c_device as i2cdevice 34 | from adafruit_register.i2c_bit import ROBit, RWBit 35 | from adafruit_register.i2c_bits import ROBits, RWBits 36 | from adafruit_register.i2c_struct import ROUnaryStruct 37 | from micropython import const 38 | 39 | _REG_CONFIG = const(0x00) # CONFIGURATION REGISTER (R/W) 40 | _REG_CURRENT = const(0x01) # SHUNT VOLTAGE REGISTER (R) 41 | _REG_BUSVOLTAGE = const(0x02) # BUS VOLTAGE REGISTER (R) 42 | _REG_POWER = const(0x03) # POWER REGISTER (R) 43 | _REG_MASK_ENABLE = const(0x06) # MASK ENABLE REGISTER (R/W) 44 | _REG_ALERT_LIMIT = const(0x07) # ALERT LIMIT REGISTER (R/W) 45 | _REG_MFG_UID = const(0xFE) # MANUFACTURER UNIQUE ID REGISTER (R) 46 | _REG_DIE_UID = const(0xFF) # DIE UNIQUE ID REGISTER (R) 47 | 48 | 49 | class Mode: 50 | """Modes avaible to be set 51 | 52 | +--------------------+---------------------------------------------------------------------+ 53 | | Mode | Description | 54 | +====================+=====================================================================+ 55 | | ``Mode.CONTINUOUS``| Default: The sensor will continuously measure the bus voltage and | 56 | | | shunt voltage across the shunt resistor to calculate ``power`` and | 57 | | | ``current`` | 58 | +--------------------+---------------------------------------------------------------------+ 59 | | ``Mode.TRIGGERED`` | The sensor will immediately begin measuring and calculating current,| 60 | | | bus voltage, and power. Re-set this mode to initiate another | 61 | | | measurement | 62 | +--------------------+---------------------------------------------------------------------+ 63 | | ``Mode.SHUTDOWN`` | Shutdown the sensor, reducing the quiescent current and turning off| 64 | | | current into the device inputs. Set another mode to re-enable | 65 | +--------------------+---------------------------------------------------------------------+ 66 | 67 | """ 68 | 69 | SHUTDOWN = const(0x0) 70 | TRIGGERED = const(0x3) 71 | CONTINUOUS = const(0x7) 72 | 73 | 74 | class ConversionTime: 75 | """Options for ``current_conversion_time`` or ``voltage_conversion_time`` 76 | 77 | +----------------------------------+------------------+ 78 | | ``ConversionTime`` | Time | 79 | +==================================+==================+ 80 | | ``ConversionTime.TIME_140_us`` | 140 us | 81 | +----------------------------------+------------------+ 82 | | ``ConversionTime.TIME_204_us`` | 204 us | 83 | +----------------------------------+------------------+ 84 | | ``ConversionTime.TIME_332_us`` | 332 us | 85 | +----------------------------------+------------------+ 86 | | ``ConversionTime.TIME_588_us`` | 588 us | 87 | +----------------------------------+------------------+ 88 | | ``ConversionTime.TIME_1_1_ms`` | 1.1 ms (Default) | 89 | +----------------------------------+------------------+ 90 | | ``ConversionTime.TIME_2_116_ms`` | 2.116 ms | 91 | +----------------------------------+------------------+ 92 | | ``ConversionTime.TIME_4_156_ms`` | 4.156 ms | 93 | +----------------------------------+------------------+ 94 | | ``ConversionTime.TIME_8_244_ms`` | 8.244 ms | 95 | +----------------------------------+------------------+ 96 | 97 | """ 98 | 99 | TIME_140_us = const(0x0) 100 | TIME_204_us = const(0x1) 101 | TIME_332_us = const(0x2) 102 | TIME_588_us = const(0x3) 103 | TIME_1_1_ms = const(0x4) 104 | TIME_2_116_ms = const(0x5) 105 | TIME_4_156_ms = const(0x6) 106 | TIME_8_244_ms = const(0x7) 107 | 108 | @staticmethod 109 | def get_seconds(time_enum: int) -> float: 110 | """Retrieve the time in seconds giving value read from register""" 111 | conv_dict = { 112 | 0: 140e-6, 113 | 1: 204e-6, 114 | 2: 332e-6, 115 | 3: 588e-6, 116 | 4: 1.1e-3, 117 | 5: 2.116e-3, 118 | 6: 4.156e-3, 119 | 7: 8.244e-3, 120 | } 121 | return conv_dict[time_enum] 122 | 123 | 124 | class AveragingCount: 125 | """Options for ``averaging_count`` 126 | 127 | +-------------------------------+------------------------------------+ 128 | | ``AveragingCount`` | Number of measurements to average | 129 | +===============================+====================================+ 130 | | ``AveragingCount.COUNT_1`` | 1 (Default) | 131 | +-------------------------------+------------------------------------+ 132 | | ``AveragingCount.COUNT_4`` | 4 | 133 | +-------------------------------+------------------------------------+ 134 | | ``AveragingCount.COUNT_16`` | 16 | 135 | +-------------------------------+------------------------------------+ 136 | | ``AveragingCount.COUNT_64`` | 64 | 137 | +-------------------------------+------------------------------------+ 138 | | ``AveragingCount.COUNT_128`` | 128 | 139 | +-------------------------------+------------------------------------+ 140 | | ``AveragingCount.COUNT_256`` | 256 | 141 | +-------------------------------+------------------------------------+ 142 | | ``AveragingCount.COUNT_512`` | 512 | 143 | +-------------------------------+------------------------------------+ 144 | | ``AveragingCount.COUNT_1024`` | 1024 | 145 | +-------------------------------+------------------------------------+ 146 | 147 | """ 148 | 149 | COUNT_1 = const(0x0) 150 | COUNT_4 = const(0x1) 151 | COUNT_16 = const(0x2) 152 | COUNT_64 = const(0x3) 153 | COUNT_128 = const(0x4) 154 | COUNT_256 = const(0x5) 155 | COUNT_512 = const(0x6) 156 | COUNT_1024 = const(0x7) 157 | 158 | @staticmethod 159 | def get_averaging_count(avg_count: int) -> float: 160 | """Retrieve the number of measurements giving value read from register""" 161 | conv_dict = {0: 1, 1: 4, 2: 16, 3: 64, 4: 128, 5: 256, 6: 512, 7: 1024} 162 | return conv_dict[avg_count] 163 | 164 | 165 | class INA260: 166 | """Driver for the INA260 power and current sensor. 167 | 168 | :param ~busio.I2C i2c_bus: The I2C bus the INA260 is connected to. 169 | :param int address: The I2C device address for the sensor. Default is ``0x40``. 170 | 171 | """ 172 | 173 | def __init__(self, i2c_bus: I2C, address: int = 0x40) -> None: 174 | self.i2c_device = i2cdevice.I2CDevice(i2c_bus, address) 175 | 176 | if self._manufacturer_id != self.TEXAS_INSTRUMENT_ID: 177 | raise RuntimeError( 178 | "Failed to find Texas Instrument ID, read " 179 | + f"{self._manufacturer_id} while expected {self.TEXAS_INSTRUMENT_ID}" 180 | " - check your wiring!" 181 | ) 182 | 183 | if self._device_id != self.INA260_ID: 184 | raise RuntimeError( 185 | f"Failed to find INA260 ID, read {self._device_id} while expected {self.INA260_ID}" 186 | " - check your wiring!" 187 | ) 188 | 189 | _raw_current = ROUnaryStruct(_REG_CURRENT, ">h") 190 | _raw_voltage = ROUnaryStruct(_REG_BUSVOLTAGE, ">H") 191 | _raw_power = ROUnaryStruct(_REG_POWER, ">H") 192 | 193 | # MASK_ENABLE fields 194 | overcurrent_limit = RWBit(_REG_MASK_ENABLE, 15, 2, False) 195 | """Setting this bit high configures the ALERT pin to be asserted if the current measurement 196 | following a conversion exceeds the value programmed in the Alert Limit Register. 197 | """ 198 | under_current_limit = RWBit(_REG_MASK_ENABLE, 14, 2, False) 199 | """Setting this bit high configures the ALERT pin to be asserted if the current measurement 200 | following a conversion drops below the value programmed in the Alert Limit Register. 201 | """ 202 | bus_voltage_over_voltage = RWBit(_REG_MASK_ENABLE, 13, 2, False) 203 | """Setting this bit high configures the ALERT pin to be asserted if the bus voltage measurement 204 | following a conversion exceeds the value programmed in the Alert Limit Register. 205 | """ 206 | bus_voltage_under_voltage = RWBit(_REG_MASK_ENABLE, 12, 2, False) 207 | """Setting this bit high configures the ALERT pin to be asserted if the bus voltage measurement 208 | following a conversion drops below the value programmed in the Alert Limit Register. 209 | """ 210 | power_over_limit = RWBit(_REG_MASK_ENABLE, 11, 2, False) 211 | """Setting this bit high configures the ALERT pin to be asserted if the Power calculation 212 | made following a bus voltage measurement exceeds the value programmed in the 213 | Alert Limit Register. 214 | """ 215 | conversion_ready = RWBit(_REG_MASK_ENABLE, 10, 2, False) 216 | """Setting this bit high configures the ALERT pin to be asserted when the Conversion Ready Flag, 217 | Bit 3, is asserted indicating that the device is ready for the next conversion. 218 | """ 219 | # from 5 to 9 are not used 220 | alert_function_flag = ROBit(_REG_MASK_ENABLE, 4, 2, False) 221 | """While only one Alert Function can be monitored at the ALERT pin at time, the 222 | Conversion Ready can also be enabled to assert the ALERT pin. 223 | Reading the Alert Function Flag following an alert allows the user to determine if the Alert 224 | Function was the source of the Alert. 225 | 226 | When the Alert Latch Enable bit is set to Latch mode, the Alert Function Flag bit 227 | clears only when the Mask/Enable Register is read. 228 | When the Alert Latch Enable bit is set to Transparent mode, the Alert Function Flag bit 229 | is cleared following the next conversion that does not result in an Alert condition. 230 | """ 231 | _conversion_ready_flag = ROBit(_REG_MASK_ENABLE, 3, 2, False) 232 | """Bit to help coordinate one-shot or triggered conversion. This bit is set after all 233 | conversion, averaging, and multiplication are complete. 234 | Conversion Ready flag bit clears when writing the configuration register or 235 | reading the Mask/Enable register. 236 | """ 237 | math_overflow_flag = ROBit(_REG_MASK_ENABLE, 2, 2, False) 238 | """This bit is set to 1 if an arithmetic operation resulted in an overflow error. 239 | """ 240 | alert_polarity_bit = RWBit(_REG_MASK_ENABLE, 1, 2, False) 241 | """Active-high open collector when True, Active-low open collector when false (default). 242 | """ 243 | alert_latch_enable = RWBit(_REG_MASK_ENABLE, 0, 2, False) 244 | """Configures the latching feature of the ALERT pin and Alert Flag Bits. 245 | """ 246 | 247 | reset_bit = RWBit(_REG_CONFIG, 15, 2, False) 248 | """Setting this bit t 1 generates a system reset. Reset all registers to default values.""" 249 | averaging_count = RWBits(3, _REG_CONFIG, 9, 2, False) 250 | """The window size of the rolling average used in continuous mode""" 251 | voltage_conversion_time = RWBits(3, _REG_CONFIG, 6, 2, False) 252 | """The conversion time taken for the bus voltage measurement""" 253 | current_conversion_time = RWBits(3, _REG_CONFIG, 3, 2, False) 254 | """The conversion time taken for the current measurement""" 255 | 256 | mode = RWBits(3, _REG_CONFIG, 0, 2, False) 257 | """The mode that the INA260 is operating in. Must be one of 258 | ``Mode.CONTINUOUS``, ``Mode.TRIGGERED``, or ``Mode.SHUTDOWN`` 259 | """ 260 | 261 | mask_enable = RWBits(16, _REG_MASK_ENABLE, 0, 2, False) 262 | """The Mask/Enable Register selects the function that is enabled to control the ALERT pin as 263 | well as how that pin functions. 264 | If multiple functions are enabled, the highest significant bit 265 | position Alert Function (D15-D11) takes priority and responds to the Alert Limit Register. 266 | """ 267 | alert_limit = RWBits(16, _REG_ALERT_LIMIT, 0, 2, False) 268 | """The Alert Limit Register contains the value used to compare to the register selected in the 269 | Mask/Enable Register to determine if a limit has been exceeded. 270 | The format for this register will match the format of the register that is selected for 271 | comparison. 272 | """ 273 | 274 | TEXAS_INSTRUMENT_ID = const(0x5449) 275 | INA260_ID = const(0x227) 276 | _manufacturer_id = ROUnaryStruct(_REG_MFG_UID, ">H") 277 | """Manufacturer identification bits""" 278 | _device_id = ROBits(12, _REG_DIE_UID, 4, 2, False) 279 | """Device identification bits""" 280 | revision_id = ROBits(4, _REG_DIE_UID, 0, 2, False) 281 | """Device revision identification bits""" 282 | 283 | @property 284 | def current(self) -> float: 285 | """The current (between V+ and V-) in mA""" 286 | if self.mode == Mode.TRIGGERED: 287 | while self._conversion_ready_flag == 0: 288 | pass 289 | return self._raw_current * 1.25 290 | 291 | @property 292 | def voltage(self) -> float: 293 | """The bus voltage in V""" 294 | if self.mode == Mode.TRIGGERED: 295 | while self._conversion_ready_flag == 0: 296 | pass 297 | return self._raw_voltage * 0.00125 298 | 299 | @property 300 | def power(self) -> int: 301 | """The power being delivered to the load in mW""" 302 | if self.mode == Mode.TRIGGERED: 303 | while self._conversion_ready_flag == 0: 304 | pass 305 | return self._raw_power * 10 306 | -------------------------------------------------------------------------------- /docs/_static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_INA260/3ef1e3feb9bf815bc956ee581113f0eaf4e0f749/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 | .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) 5 | .. use this format as the module name: "adafruit_foo.foo" 6 | 7 | API Reference 8 | ############# 9 | 10 | .. automodule:: adafruit_ina260 11 | :members: 12 | -------------------------------------------------------------------------------- /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.napoleon", 21 | "sphinx.ext.todo", 22 | ] 23 | 24 | # TODO: Please Read! 25 | # Uncomment the below if you use native CircuitPython modules such as 26 | # digitalio, micropython and busio. List the modules you use. Without it, the 27 | # autodoc module docs will fail to generate with a warning. 28 | autodoc_mock_imports = [ 29 | "micropython", 30 | "busio", 31 | "adafruit_bus_device", 32 | "adafruit_register", 33 | ] 34 | 35 | 36 | intersphinx_mapping = { 37 | "python": ("https://docs.python.org/3", None), 38 | "BusDevice": ( 39 | "https://docs.circuitpython.org/projects/busdevice/en/latest/", 40 | None, 41 | ), 42 | "Register": ( 43 | "https://docs.circuitpython.org/projects/register/en/latest/", 44 | None, 45 | ), 46 | "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), 47 | } 48 | 49 | # Add any paths that contain templates here, relative to this directory. 50 | templates_path = ["_templates"] 51 | 52 | source_suffix = ".rst" 53 | 54 | # The master toctree document. 55 | master_doc = "index" 56 | 57 | # General information about the project. 58 | project = "Adafruit INA260 Library" 59 | creation_year = "2019" 60 | current_year = str(datetime.datetime.now().year) 61 | year_duration = ( 62 | current_year if current_year == creation_year else creation_year + " - " + current_year 63 | ) 64 | copyright = year_duration + " Bryan Siepert" 65 | author = "Bryan Siepert" 66 | 67 | # The version info for the project you're documenting, acts as replacement for 68 | # |version| and |release|, also used in various other places throughout the 69 | # built documents. 70 | # 71 | # The short X.Y version. 72 | version = "1.0" 73 | # The full version, including alpha/beta/rc tags. 74 | release = "1.0" 75 | 76 | # The language for content autogenerated by Sphinx. Refer to documentation 77 | # for a list of supported languages. 78 | # 79 | # This is also used if you do content translation via gettext catalogs. 80 | # Usually you set "language" from the command line for these cases. 81 | language = "en" 82 | 83 | # List of patterns, relative to source directory, that match files and 84 | # directories to ignore when looking for source files. 85 | # This patterns also effect to html_static_path and html_extra_path 86 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] 87 | 88 | # The reST default role (used for this markup: `text`) to use for all 89 | # documents. 90 | # 91 | default_role = "any" 92 | 93 | # If true, '()' will be appended to :func: etc. cross-reference text. 94 | # 95 | add_function_parentheses = True 96 | 97 | # The name of the Pygments (syntax highlighting) style to use. 98 | pygments_style = "sphinx" 99 | 100 | # If true, `todo` and `todoList` produce output, else they produce nothing. 101 | todo_include_todos = False 102 | 103 | # If this is True, todo emits a warning for each TODO entries. The default is False. 104 | todo_emit_warnings = True 105 | 106 | napoleon_numpy_docstring = False 107 | 108 | # -- Options for HTML output ---------------------------------------------- 109 | 110 | # The theme to use for HTML and HTML Help pages. See the documentation for 111 | # a list of builtin themes. 112 | # 113 | import sphinx_rtd_theme 114 | 115 | html_theme = "sphinx_rtd_theme" 116 | 117 | # Add any paths that contain custom static files (such as style sheets) here, 118 | # relative to this directory. They are copied after the builtin static files, 119 | # so a file named "default.css" will overwrite the builtin "default.css". 120 | html_static_path = ["_static"] 121 | 122 | # The name of an image file (relative to this directory) to use as a favicon of 123 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 124 | # pixels large. 125 | # 126 | html_favicon = "_static/favicon.ico" 127 | 128 | # Output file base name for HTML help builder. 129 | htmlhelp_basename = "AdafruitIna260Librarydoc" 130 | 131 | # -- Options for LaTeX output --------------------------------------------- 132 | 133 | latex_elements = { 134 | # The paper size ('letterpaper' or 'a4paper'). 135 | # 136 | # 'papersize': 'letterpaper', 137 | # The font size ('10pt', '11pt' or '12pt'). 138 | # 139 | # 'pointsize': '10pt', 140 | # Additional stuff for the LaTeX preamble. 141 | # 142 | # 'preamble': '', 143 | # Latex figure (float) alignment 144 | # 145 | # 'figure_align': 'htbp', 146 | } 147 | 148 | # Grouping the document tree into LaTeX files. List of tuples 149 | # (source start file, target name, title, 150 | # author, documentclass [howto, manual, or own class]). 151 | latex_documents = [ 152 | ( 153 | master_doc, 154 | "AdafruitINA260Library.tex", 155 | "AdafruitINA260 Library Documentation", 156 | author, 157 | "manual", 158 | ), 159 | ] 160 | 161 | # -- Options for manual page output --------------------------------------- 162 | 163 | # One entry per manual page. List of tuples 164 | # (source start file, name, description, authors, manual section). 165 | man_pages = [ 166 | ( 167 | master_doc, 168 | "AdafruitINA260library", 169 | "Adafruit INA260 Library Documentation", 170 | [author], 171 | 1, 172 | ) 173 | ] 174 | 175 | # -- Options for Texinfo output ------------------------------------------- 176 | 177 | # Grouping the document tree into Texinfo files. List of tuples 178 | # (source start file, target name, title, author, 179 | # dir menu entry, description, category) 180 | texinfo_documents = [ 181 | ( 182 | master_doc, 183 | "AdafruitINA260Library", 184 | "Adafruit INA260 Library Documentation", 185 | author, 186 | "AdafruitINA260Library", 187 | "One line description of project.", 188 | "Miscellaneous", 189 | ), 190 | ] 191 | -------------------------------------------------------------------------------- /docs/examples.rst: -------------------------------------------------------------------------------- 1 | Simple test 2 | ------------ 3 | 4 | Ensure your device works with this simple test. 5 | 6 | .. literalinclude:: ../examples/ina260_simpletest.py 7 | :caption: examples/ina260_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 | .. toctree:: 30 | :caption: Other Links 31 | 32 | Download from GitHub 33 | Download Library Bundle 34 | CircuitPython Reference Documentation 35 | CircuitPython Support Forum 36 | Discord Chat 37 | Adafruit Learning System 38 | Adafruit Blog 39 | Adafruit Store 40 | 41 | Indices and tables 42 | ================== 43 | 44 | * :ref:`genindex` 45 | * :ref:`modindex` 46 | * :ref:`search` 47 | -------------------------------------------------------------------------------- /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/ina260_averaging.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # SPDX-License-Identifier: MIT 3 | 4 | import time 5 | 6 | import board 7 | 8 | from adafruit_ina260 import INA260, AveragingCount 9 | 10 | i2c = board.I2C() # uses board.SCL and board.SDA 11 | # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller 12 | ina260 = INA260(i2c) 13 | 14 | # Raise the averaging count to a larger number to smooth out the results 15 | ina260.averaging_count = AveragingCount.COUNT_4 16 | while True: 17 | print("Current (average count 4): %.2f" % (ina260.current)) 18 | print("Voltage (average count 4): %.2f" % (ina260.voltage)) 19 | print("Power (average count 4): %.2f" % (ina260.power)) 20 | 21 | time.sleep(1) 22 | 23 | # The can be seen most clearly using a serial plotter. Comment out the above 24 | # and then switch between uncommenting *one* of the two below to compare 25 | 26 | # ina260.averaging_count = AveragingCount.COUNT_1 27 | # while True: 28 | # print("%.2f, %.2f, %.2f"%(ina260.current, ina260.voltage, ina260.power)) 29 | # time.sleep(.5) 30 | 31 | # ina260.averaging_count = AveragingCount.COUNT_4 32 | # while True: 33 | # print("%.2f, %.2f, %.2f"%(ina260.current, ina260.voltage, ina260.power)) 34 | # time.sleep(.5) 35 | -------------------------------------------------------------------------------- /examples/ina260_latch.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: Gabriele Pongelli 2021 for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | import time 6 | 7 | import board 8 | 9 | from adafruit_ina260 import INA260, ConversionTime, Mode 10 | 11 | if __name__ == "__main__": 12 | try: 13 | i2c = board.I2C() # uses board.SCL and board.SDA 14 | # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector 15 | ina260 = INA260(i2c) 16 | except RuntimeError as r_e: 17 | # catch exception on init, no INA260 chip found 18 | print(r_e) 19 | raise r_e 20 | 21 | # set overcurrent limit flag and threshold value 22 | # 0x0008 x 1,25 mA = 10 mA as alert limit 23 | ina260.alert_limit = 0x0008 24 | 25 | # alert pin is asserted, can be check with gpiozero 26 | ina260.overcurrent_limit = True 27 | 28 | # keep the flag high until MASK_ENABLE register will be read 29 | ina260.alert_latch_enable = True 30 | 31 | ina260.mode = Mode.CONTINUOUS 32 | 33 | # set higher conversion time and wait its value before each read 34 | ina260.current_conversion_time = ConversionTime.TIME_8_244_ms 35 | for _ in enumerate(range(5)): 36 | time.sleep(ConversionTime.get_seconds(ina260.current_conversion_time)) 37 | print( 38 | f"Current: {ina260.current:.2f} mA, " 39 | f"Voltage: {ina260.voltage:.2f} V, " 40 | f"Power: {ina260.power:.2f} mW" 41 | ) 42 | 43 | # supposing meanwhile the alert limit was exceeded, setting an higher limit 44 | # and clear the ALERT 45 | # 0x0100 x 1,25 mA = 320 mA as alert limit 46 | ina260.alert_limit = 0x0100 47 | 48 | # alert function flag bit should be true if alert threshold was exceeded 49 | print("Alert function flag: ", ina260.alert_function_flag) 50 | 51 | # in latch mode, reading the register clears the ALERT & alert function flag 52 | print("MASK register:", ina260.mask_enable) 53 | 54 | # reset the whole chip and wait 2 sec 55 | ina260.reset_bit = True 56 | time.sleep(2) 57 | print("MASK_REGISTER check, must be 0x0000 after reset:", ina260.mask_enable) 58 | -------------------------------------------------------------------------------- /examples/ina260_modes.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # SPDX-License-Identifier: MIT 3 | 4 | import time 5 | 6 | import board 7 | 8 | from adafruit_ina260 import INA260, Mode 9 | 10 | i2c = board.I2C() # uses board.SCL and board.SDA 11 | # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller 12 | ina260 = INA260(i2c) 13 | 14 | # trigger a sample 15 | ina260.mode = Mode.TRIGGERED 16 | print("Current (one shot #1): %.2f" % (ina260.current)) 17 | print("Voltage (one shot #1): %.2f" % (ina260.voltage)) 18 | print("Power (one shot #1): %.2f" % (ina260.power)) 19 | 20 | # print it again to show it will return the same value 21 | # until triggered again 22 | print("Current (one shot #1 redux): %.2f" % (ina260.current)) 23 | print("Voltage (one shot #1 redux): %.2f" % (ina260.voltage)) 24 | print("Power (one shot #1 redux): %.2f" % (ina260.power)) 25 | 26 | # trigger a second sample 27 | ina260.mode = Mode.TRIGGERED 28 | print("Current (one shot #2): %.2f" % (ina260.current)) 29 | print("Voltage (one shot #2): %.2f" % (ina260.voltage)) 30 | print("Power (one shot #2): %.2f" % (ina260.power)) 31 | 32 | # put the sensor in power-down mode. It will return 33 | # the previous value until a new mode is chosen 34 | ina260.mode = Mode.SHUTDOWN 35 | print("Current (shutdown): %.2f" % (ina260.current)) 36 | print("Voltage (shutdown): %.2f" % (ina260.voltage)) 37 | print("Power (shutdown): %.2f" % (ina260.power)) 38 | 39 | # return the sensor to the default continuous mode 40 | ina260.mode = Mode.CONTINUOUS 41 | while True: 42 | print("Current (continuous): %.2f" % (ina260.current)) 43 | print("Voltage (continuous): %.2f" % (ina260.voltage)) 44 | print("Power (continuous): %.2f" % (ina260.power)) 45 | time.sleep(1) 46 | -------------------------------------------------------------------------------- /examples/ina260_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_ina260 9 | 10 | i2c = board.I2C() # uses board.SCL and board.SDA 11 | # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller 12 | ina260 = adafruit_ina260.INA260(i2c) 13 | while True: 14 | print( 15 | f"Current: {ina260.current:.2f} mA Voltage: {ina260.voltage:.2f} V Power:{ina260.power:.2f} mW" # noqa: E501 16 | ) 17 | time.sleep(1) 18 | -------------------------------------------------------------------------------- /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-ina260" 14 | description = "CircuitPython driver for the TI INA260 current and power 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_INA260"} 21 | keywords = [ 22 | "adafruit", 23 | "blinka", 24 | "circuitpython", 25 | "micropython", 26 | "ina260", 27 | "power", 28 | "current", 29 | "voltage", 30 | ] 31 | license = {text = "MIT"} 32 | classifiers = [ 33 | "Intended Audience :: Developers", 34 | "Topic :: Software Development :: Libraries", 35 | "Topic :: Software Development :: Embedded Systems", 36 | "Topic :: System :: Hardware", 37 | "License :: OSI Approved :: MIT License", 38 | "Programming Language :: Python :: 3", 39 | ] 40 | dynamic = ["dependencies", "optional-dependencies"] 41 | 42 | [tool.setuptools] 43 | py-modules = ["adafruit_ina260"] 44 | 45 | [tool.setuptools.dynamic] 46 | dependencies = {file = ["requirements.txt"]} 47 | optional-dependencies = {optional = {file = ["optional_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-register 7 | adafruit-circuitpython-busdevice 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 | ] 103 | 104 | [format] 105 | line-ending = "lf" 106 | --------------------------------------------------------------------------------