From 6b1a81199a2cc3774eb7f9286c0751ef5785af6c Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 15:06:44 -0500 Subject: [PATCH 01/67] Added pre-commit and SPDX copyright Signed-off-by: dherrada --- .github/workflows/build.yml | 28 ++++++++++++++++++++++++---- .github/workflows/release.yml | 4 ++++ 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b6977a9..59baa53 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Build CI on: [pull_request, push] @@ -38,20 +42,36 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, black, & Sphinx + - name: Pip install pylint, Sphinx, pre-commit run: | - pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme + pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - - name: Check formatting + - name: Pre-commit hooks run: | - black --check --target-version=py35 . + pre-commit run --all-files - name: PyLint run: | pylint $( find . -path './adafruit*.py' ) ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - name: Build assets run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . + - name: Archive bundles + uses: actions/upload-artifact@v2 + with: + name: bundles + path: ${{ github.workspace }}/bundles/ - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html + - name: Check For setup.py + id: need-pypi + run: | + echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + - name: Build Python package + if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + run: | + pip install --upgrade setuptools wheel twine readme_renderer testresources + python setup.py sdist + python setup.py bdist_wheel --universal + twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 18efb9c..6d0015a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Release Actions on: From 10905f40bdb945d3d60a8738789b0ddee8f55797 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 16:06:47 -0500 Subject: [PATCH 02/67] Added pre-commit-config file Signed-off-by: dherrada --- .pre-commit-config.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..aab5f1c --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# +# SPDX-License-Identifier: Unlicense + +repos: +- repo: https://github.com/python/black + rev: stable + hooks: + - id: black +- repo: https://github.com/fsfe/reuse-tool + rev: latest + hooks: + - id: reuse +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.3.0 + hooks: + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace From cddaa8fa0a912e256ebc436afaf145acded74c73 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 12 Jan 2021 12:08:12 -0500 Subject: [PATCH 03/67] Ran pre-commit, added licenses --- .gitignore | 6 +- .pylintrc | 4 + .readthedocs.yml | 4 + CODE_OF_CONDUCT.md | 14 +- LICENSES/CC-BY-4.0.txt | 324 +++++++++++++++++++++++++++++++ LICENSES/MIT.txt | 19 ++ LICENSES/Unlicense.txt | 20 ++ README.rst.license | 3 + adafruit_adt7410.py | 23 +-- docs/_static/favicon.ico.license | 3 + docs/api.rst.license | 3 + docs/conf.py | 4 + docs/examples.rst.license | 3 + docs/index.rst.license | 3 + examples/adt7410_simpletest.py | 3 + requirements.txt | 4 + setup.py | 4 + 17 files changed, 419 insertions(+), 25 deletions(-) create mode 100644 LICENSES/CC-BY-4.0.txt create mode 100644 LICENSES/MIT.txt create mode 100644 LICENSES/Unlicense.txt create mode 100644 README.rst.license create mode 100644 docs/_static/favicon.ico.license create mode 100644 docs/api.rst.license create mode 100644 docs/examples.rst.license create mode 100644 docs/index.rst.license diff --git a/.gitignore b/.gitignore index c83f8b7..9647e71 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + *.mpy .idea __pycache__ @@ -8,4 +12,4 @@ bundles *.DS_Store .eggs dist -**/*.egg-info \ No newline at end of file +**/*.egg-info diff --git a/.pylintrc b/.pylintrc index d8f0ee8..5c31f66 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + [MASTER] # A comma-separated list of package or module names from where C extensions may diff --git a/.readthedocs.yml b/.readthedocs.yml index f4243ad..ffa84c4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + python: version: 3 requirements_file: requirements.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 134d510..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge @@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -74,9 +80,9 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Moderators by tagging @community moderators. You may -also send an open message from any channel, or a direct message to -@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..24a8f90 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,20 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and successors. We intend this dedication to +be an overt act of relinquishment in perpetuity of all present and future +rights to this software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, +please refer to diff --git a/README.rst.license b/README.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/README.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index 1acd1d0..b6a33b1 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 ladyada for Adafruit Industries # -# Copyright (c) 2019 ladyada for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT + """ `adafruit_adt7410` ==================================================== diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/favicon.ico.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py index 91ee611..e0bcd97 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + import os import sys diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/index.rst.license b/docs/index.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/examples/adt7410_simpletest.py b/examples/adt7410_simpletest.py index 05ecb46..702b7e5 100644 --- a/examples/adt7410_simpletest.py +++ b/examples/adt7410_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + import time import board import busio diff --git a/requirements.txt b/requirements.txt index d5d88a1..f162505 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-register diff --git a/setup.py b/setup.py index c746069..253b8d2 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """A setuptools based setup module. See: From f6852699020dc5356455e46036145c82c7b23e8b Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Feb 2021 16:38:51 -0500 Subject: [PATCH 04/67] Hardcoded Black and REUSE versions Signed-off-by: dherrada --- .pre-commit-config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index aab5f1c..07f886c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,11 +4,11 @@ repos: - repo: https://github.com/python/black - rev: stable + rev: 20.8b1 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: latest + rev: v0.12.1 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks From d5d50f2147e490c2e6524080898c9aa811b40b95 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 16:46:17 -0500 Subject: [PATCH 05/67] Removed pylint process from github workflow Signed-off-by: dherrada --- .github/workflows/build.yml | 8 ++------ .pre-commit-config.yaml | 15 +++++++++++++++ .pylintrc | 2 +- 3 files changed, 18 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 59baa53..621d5ef 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,18 +42,14 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit + - name: Pip install Sphinx, pre-commit run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks run: | pre-commit run --all-files - - name: PyLint - run: | - pylint $( find . -path './adafruit*.py' ) - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - name: Build assets run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - name: Archive bundles diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 07f886c..354c761 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -17,3 +17,18 @@ repos: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace +- repo: https://github.com/pycqa/pylint + rev: pylint-2.7.1 + hooks: + - id: pylint + name: pylint (library code) + types: [python] + exclude: "^(docs/|examples/|setup.py$)" +- repo: local + hooks: + - id: pylint_examples + name: pylint (examples code) + description: Run pylint rules on "examples/*.py" files + entry: /usr/bin/env bash -c + args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] + language: system diff --git a/.pylintrc b/.pylintrc index 5c31f66..9ed669e 100644 --- a/.pylintrc +++ b/.pylintrc @@ -250,7 +250,7 @@ ignore-comments=yes ignore-docstrings=yes # Ignore imports when computing similarities. -ignore-imports=no +ignore-imports=yes # Minimum lines number of a similarity. min-similarity-lines=4 From c99e1131fce8aba67c73fdecafb3ae5a8a8b144d Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 17:17:50 -0500 Subject: [PATCH 06/67] Re-added pylint install to build.yml Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 621d5ef..3baf502 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,9 +42,9 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit + - name: Pip install pylint, Sphinx, pre-commit run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks From fe680ac325975871f7e94b142ed238a31861ff3d Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 19 Mar 2021 13:44:53 -0400 Subject: [PATCH 07/67] "Increase duplicate code check threshold " --- .pylintrc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.pylintrc b/.pylintrc index 9ed669e..0238b90 100644 --- a/.pylintrc +++ b/.pylintrc @@ -22,8 +22,7 @@ ignore-patterns= #init-hook= # Use multiple processes to speed up Pylint. -# jobs=1 -jobs=2 +jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. @@ -253,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From 906d03d6bb8054ce331ed9334782d3b4ce81d3ac Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sat, 17 Apr 2021 19:50:56 -0400 Subject: [PATCH 08/67] Improving docs and adding product and learning guide to the API --- adafruit_adt7410.py | 36 ++++++++++++++++++++++++++++++++++-- docs/index.rst | 4 ++++ 2 files changed, 38 insertions(+), 2 deletions(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index b6a33b1..c2160f5 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -16,6 +16,9 @@ **Hardware:** +* `Adafruit's ADT7410 analog temperature Sensor Breakout: + `_ (Product ID: 4089) + **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: @@ -46,7 +49,36 @@ class ADT7410: - """Interface to the Analog Devices ADT7410 temperature sensor.""" + """Interface to the Analog Devices ADT7410 temperature sensor. + + :param ~busio.I2C i2c_bus: The I2C bus the ADT7410 is connected to. + :param int address: The I2C device address for the sensor. Default is :const:`0x48` + + **Quickstart: Importing and using the ADT7410 temperature sensor** + + Here is one way of importing the `ADT7410` class so you can use it with the name ``adt``. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import busio + import board + import adafruit_adt7410 + + Once this is done you can define your `busio.I2C` object and define your sensor object + + .. code-block:: python + + i2c = busio.I2C(board.SCL, board.SDA) + adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) + + Now you have access to the temperature using :attr:`temperature`. + + .. code-block:: python + + temperature = adt.temperature + + """ # many modes can be set with register objects for simplicity ready = ROBit(_ADT7410_STATUS, 7) @@ -69,7 +101,7 @@ def __init__(self, i2c_bus, address=0x48): @property def temperature(self): - """The temperature in celsius""" + """The temperature in Celsius""" temp = self._read_register(_ADT7410_TEMPMSB, 2) return struct.unpack(">h", temp)[0] / 128 diff --git a/docs/index.rst b/docs/index.rst index e3b2e78..b7baacd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,9 +23,13 @@ Table of Contents .. toctree:: :caption: Tutorials + ADT7410 High Accuracy I2C Temperature Sensor Learning Guide + .. toctree:: :caption: Related Products + ADT7410 High Accuracy I2C Temperature Sensor Breakout Board + .. toctree:: :caption: Other Links From fe0207077ba84c367befaec995045c25ab67e2e7 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Fri, 23 Apr 2021 21:12:27 -0400 Subject: [PATCH 09/67] Adding board.I2C reference --- README.rst | 3 +-- adafruit_adt7410.py | 9 ++++----- examples/adt7410_simpletest.py | 3 +-- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 7c73902..035ecdc 100644 --- a/README.rst +++ b/README.rst @@ -59,10 +59,9 @@ Usage Example import time import board - import busio import adafruit_adt7410 - i2c_bus = busio.I2C(board.SCL, board.SDA) + i2c_bus = board.I2C() adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) adt.high_resolution = True diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index c2160f5..f3a644f 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -52,24 +52,23 @@ class ADT7410: """Interface to the Analog Devices ADT7410 temperature sensor. :param ~busio.I2C i2c_bus: The I2C bus the ADT7410 is connected to. - :param int address: The I2C device address for the sensor. Default is :const:`0x48` + :param int address: The I2C device address. Default is :const:`0x48` **Quickstart: Importing and using the ADT7410 temperature sensor** - Here is one way of importing the `ADT7410` class so you can use it with the name ``adt``. + Here is an example of using the :class:`ADT7410` class. First you will need to import the libraries to use the sensor .. code-block:: python - import busio import board import adafruit_adt7410 - Once this is done you can define your `busio.I2C` object and define your sensor object + Once this is done you can define your `board.I2C` object and define your sensor object .. code-block:: python - i2c = busio.I2C(board.SCL, board.SDA) + i2c = board.I2C() # uses board.SCL and board.SDA adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) Now you have access to the temperature using :attr:`temperature`. diff --git a/examples/adt7410_simpletest.py b/examples/adt7410_simpletest.py index 702b7e5..29c87e7 100644 --- a/examples/adt7410_simpletest.py +++ b/examples/adt7410_simpletest.py @@ -3,10 +3,9 @@ import time import board -import busio import adafruit_adt7410 -i2c_bus = busio.I2C(board.SCL, board.SDA) +i2c_bus = board.I2C() adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) adt.high_resolution = True From b9684b6f67db5d158407e3d92f437530d8f2ebc5 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 4 May 2021 09:34:18 -0400 Subject: [PATCH 10/67] verifying_references --- README.rst | 20 ++++++++++---------- adafruit_adt7410.py | 12 ++++++++---- examples/adt7410_simpletest.py | 4 ++-- 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 035ecdc..fca8f75 100644 --- a/README.rst +++ b/README.rst @@ -55,19 +55,19 @@ To install in a virtual environment in your current project: Usage Example ============= -.. code-block:: python +.. code-block:: python3 - import time - import board - import adafruit_adt7410 + import time + import board + import adafruit_adt7410 - i2c_bus = board.I2C() - adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) - adt.high_resolution = True + i2c = board.I2C() # uses board.SCL and board.SDA + adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) + adt.high_resolution = True - while True: - print(adt.temperature) - time.sleep(0.5) + while True: + print(adt.temperature) + time.sleep(0.5) Contributing diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index f3a644f..dcf54a2 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -16,17 +16,21 @@ **Hardware:** -* `Adafruit's ADT7410 analog temperature Sensor Breakout: +* `Adafruit ADT7410 analog temperature Sensor Breakout `_ (Product ID: 4089) + **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases + https://circuitpython.org/downloads + +* Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice -* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice +* Adafruit's Register library: + https://github.com/adafruit/Adafruit_CircuitPython_Register -* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register """ diff --git a/examples/adt7410_simpletest.py b/examples/adt7410_simpletest.py index 29c87e7..a44a764 100644 --- a/examples/adt7410_simpletest.py +++ b/examples/adt7410_simpletest.py @@ -5,8 +5,8 @@ import board import adafruit_adt7410 -i2c_bus = board.I2C() -adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) +i2c = board.I2C() # uses board.SCL and board.SDA +adt = adafruit_adt7410.ADT7410(i2c, address=0x48) adt.high_resolution = True while True: From 15e28611610909b50b2bc6efc2d0057dca0607b3 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sun, 16 May 2021 21:00:31 -0400 Subject: [PATCH 11/67] adding_temp_crit --- adafruit_adt7410.py | 73 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 71 insertions(+), 2 deletions(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index dcf54a2..22156aa 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -9,7 +9,7 @@ CircuitPython driver for reading temperature from the Analog Devices ADT7410 precision temperature sensor -* Author(s): ladyada +* Author(s): ladyada, Jose David M. Implementation Notes -------------------- @@ -48,6 +48,13 @@ _ADT7410_TEMPLSB = const(0x1) _ADT7410_STATUS = const(0x2) _ADT7410_CONFIG = const(0x3) +_ADT7410_THIGHMSB = const(0x4) +_ADT7410_THIGHLSB = const(0x5) +_ADT7410_TLOWMSB = const(0x6) +_ADT7410_TLOWLSB = const(0x7) +_ADT7410_TCRITMSB = const(0x8) +_ADT7410_TCRITLSB = const(0x9) +_ADT7410_THYST = const(0x0A) _ADT7410_ID = const(0xB) _ADT7410_SWRST = const(0x2F) @@ -89,6 +96,10 @@ class ADT7410: intpin_polarity = RWBit(_ADT7410_CONFIG, 3) comparator_mode = RWBit(_ADT7410_CONFIG, 4) high_resolution = RWBit(_ADT7410_CONFIG, 7) + # Status Information configuration + temp_over_critiq = ROBit(_ADT7410_STATUS, 6) + temp_over_high = ROBit(_ADT7410_STATUS, 5) + temp_under_low = ROBit(_ADT7410_STATUS, 4) def __init__(self, i2c_bus, address=0x48): self.i2c_device = I2CDevice(i2c_bus, address) @@ -120,7 +131,7 @@ def configuration(self): @configuration.setter def configuration(self, val): - return self._write_register(_ADT7410_CONFIG, val) + self._write_register(_ADT7410_CONFIG, val) def reset(self): """Perform a software reset""" @@ -143,3 +154,61 @@ def _write_register(self, addr, data=None): end = 2 with self.i2c_device as i2c: i2c.write(self._buf, end=end) + + @property + def high_temperature(self): + """The over temperature limit value in Celsius""" + temp = self._read_register(_ADT7410_THIGHMSB, 2) + return struct.unpack(">h", temp)[0] / 128 + + @high_temperature.setter + def high_temperature(self, value): + value = struct.pack(">h", int(value * 128)) + self._write_register(_ADT7410_THIGHMSB, value[0]) + self._write_register(_ADT7410_THIGHLSB, value[1]) + + @property + def low_temperature(self): + """The over temperature limit value in Celsius. Only works when + comparator mode is selected""" + temp = self._read_register(_ADT7410_TLOWMSB, 2) + return struct.unpack(">h", temp)[0] / 128 + + @low_temperature.setter + def low_temperature(self, value): + value = struct.pack(">h", int(value * 128)) + self._write_register(_ADT7410_TLOWMSB, value[0]) + self._write_register(_ADT7410_TLOWLSB, value[1]) + + @property + def critical_temperature(self): + """The critical temperature limit value in Celsius. Only works when + comparator mode is selected""" + temp = self._read_register(_ADT7410_TCRITMSB, 2) + return struct.unpack(">h", temp)[0] / 128 + + @critical_temperature.setter + def critical_temperature(self, value): + """The over temperature limit value in Celsius + There is a bug in the sensor, so the address 0x09 could no be written to 0x00 + for this reason only odd numbers could be given. We could make the 0x09 with + a value of 0x01, however make the logic more complex. Only works when + comparator mode is selected + """ + value = struct.pack(">h", int(value * 128)) + self._write_register(_ADT7410_TCRITMSB, value[0]) + self._write_register(_ADT7410_TCRITLSB, value[1]) + + @property + def hysteresis(self): + """The hysteresis temperature limit value in Celsius. Only works when + comparator mode is selected. From 0 to 15 Celsius""" + temp = self._read_register(_ADT7410_THYST)[0] + return temp + + @hysteresis.setter + def hysteresis(self, value): + if value > 15 or isinstance(value, float): + raise Exception("Hysteresis value must be an integer lower than 15 Celsius") + + self._write_register(_ADT7410_THYST, value) From 07161e70312ecd67580c40e606436945d3511c52 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:32:42 -0400 Subject: [PATCH 12/67] Added pull request template Signed-off-by: dherrada --- .../adafruit_circuitpython_pr.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md new file mode 100644 index 0000000..71ef8f8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -0,0 +1,13 @@ +# SPDX-FileCopyrightText: 2021 Adafruit Industries +# +# SPDX-License-Identifier: MIT + +Thank you for contributing! Before you submit a pull request, please read the following. + +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html + +If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs + +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 + +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. From 615c0e86698282c961a53d83dd4765fb834ad40f Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:35:18 -0400 Subject: [PATCH 13/67] Added help text and problem matcher Signed-off-by: dherrada --- .github/workflows/build.yml | 2 ++ .github/workflows/failure-help-text.yml | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 .github/workflows/failure-help-text.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3baf502..0ab7182 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,3 +71,5 @@ jobs: python setup.py sdist python setup.py bdist_wheel --universal twine check dist/* + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/failure-help-text.yml b/.github/workflows/failure-help-text.yml new file mode 100644 index 0000000..0b1194f --- /dev/null +++ b/.github/workflows/failure-help-text.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Failure help text + +on: + workflow_run: + workflows: ["Build CI"] + types: + - completed + +jobs: + post-help: + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} + steps: + - name: Post comment to help + uses: adafruit/circuitpython-action-library-ci-failed@v1 From d34d9b1dc78fa190ed50823c4169d9db5963eee4 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 May 2021 09:54:31 -0400 Subject: [PATCH 14/67] Moved CI to Python 3.7 Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0ab7182..c4c975d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 + - name: Set up Python 3.7 uses: actions/setup-python@v1 with: - python-version: 3.6 + python-version: 3.7 - name: Versions run: | python3 --version From b6516bb1e6621ceba1d3b1d64526f67418e6460b Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 7 Jun 2021 13:11:45 -0400 Subject: [PATCH 15/67] Moved default branch to main --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 035ecdc..8a8e11d 100644 --- a/README.rst +++ b/README.rst @@ -74,7 +74,7 @@ Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. Documentation From f866b740612388272cd26f7e796299089669c7af Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 23 Sep 2021 17:52:55 -0400 Subject: [PATCH 16/67] Globally disabled consider-using-f-string pylint check Signed-off-by: dherrada --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 354c761..8810708 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -30,5 +30,5 @@ repos: name: pylint (examples code) description: Run pylint rules on "examples/*.py" files entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] + args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] language: system From 4351babeb9f34f2e2539789a05125da1e8d71295 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 25 Oct 2021 11:12:56 -0500 Subject: [PATCH 17/67] add docs link to readme --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 8a8e11d..87bd18f 100644 --- a/README.rst +++ b/README.rst @@ -70,6 +70,11 @@ Usage Example time.sleep(0.5) +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + Contributing ============ From 6de2270f3185f3960a4930fd6c418ebea6428c6e Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Nov 2021 14:40:16 -0400 Subject: [PATCH 18/67] PATCH Pylint and readthedocs patch test Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- .pre-commit-config.yaml | 26 +++++++++++++++++--------- .pylintrc | 2 +- .readthedocs.yml | 2 +- docs/requirements.txt | 5 +++++ 5 files changed, 26 insertions(+), 13 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c4c975d..ca35544 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,9 +42,9 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit + - name: Pip install Sphinx, pre-commit run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8810708..1b9fadc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,17 +18,25 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: pylint-2.7.1 + rev: v2.11.1 hooks: - id: pylint name: pylint (library code) types: [python] - exclude: "^(docs/|examples/|setup.py$)" -- repo: local - hooks: - - id: pylint_examples - name: pylint (examples code) + args: + - --disable=consider-using-f-string + exclude: "^(docs/|examples/|tests/|setup.py$)" + - id: pylint + name: pylint (example code) description: Run pylint rules on "examples/*.py" files - entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] - language: system + types: [python] + files: "^examples/" + args: + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint + name: pylint (test code) + description: Run pylint rules on "tests/*.py" files + types: [python] + files: "^tests/" + args: + - --disable=missing-docstring,consider-using-f-string,duplicate-code diff --git a/.pylintrc b/.pylintrc index 0238b90..e78bad2 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=12 +min-similarity-lines=4 [BASIC] diff --git a/.readthedocs.yml b/.readthedocs.yml index ffa84c4..49dcab3 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -4,4 +4,4 @@ python: version: 3 -requirements_file: requirements.txt +requirements_file: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..88e6733 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +sphinx>=4.0.0 From 6156c17154b506a7dabf00c949b0750a8d841b8c Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 5 Nov 2021 14:49:30 -0400 Subject: [PATCH 19/67] Disabled unspecified-encoding pylint check Signed-off-by: dherrada --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index e78bad2..cfd1c41 100644 --- a/.pylintrc +++ b/.pylintrc @@ -55,7 +55,7 @@ confidence= # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option From 6cd8044458b06edf1e1eb74877ad6f7db46e10dc Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 20/67] Updated readthedocs file Signed-off-by: dherrada --- .readthedocs.yaml | 15 +++++++++++++++ .readthedocs.yml | 7 ------- 2 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 .readthedocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..95ec218 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +python: + version: "3.6" + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From e08a56f73e9cb40109eb869cff1f0d29ff81d95c Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 12:58:41 -0600 Subject: [PATCH 21/67] update rtd py version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 95ec218..1335112 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.6" + version: "3.7" install: - requirements: docs/requirements.txt - requirements: requirements.txt From afbc3c36ebfe06202b9ad19adbe032b300d54658 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 22/67] First part of patch Signed-off-by: dherrada --- .../PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md | 2 +- .github/workflows/build.yml | 6 +++--- .github/workflows/release.yml | 8 ++++---- .readthedocs.yaml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +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 If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca35544..474520d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: "3.x" - name: Versions run: | python3 --version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6d0015a..a65e5de 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,10 +24,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.6 + python-version: "3.x" - name: Versions run: | python3 --version @@ -67,7 +67,7 @@ jobs: echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - name: Set up Python if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 + uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1335112..f8b2891 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.7" + version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From bb5e1cdb32e1f73086fb9f5b53fb535ac56df268 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:15:28 -0500 Subject: [PATCH 23/67] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 8 ++++---- docs/index.rst | 2 +- setup.py | 2 -- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index cfa16e1..1b449eb 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-adt7410/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/adt7410/en/latest/ + :target: https://docs.circuitpython.org/projects/adt7410/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg @@ -73,7 +73,7 @@ Usage Example Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. Contributing ============ diff --git a/docs/conf.py b/docs/conf.py index e0bcd97..c1da010 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,16 +29,16 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), + "python": ("https://docs.python.org/3", None), "BusDevice": ( - "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", + "https://docs.circuitpython.org/projects/busdevice/en/latest/", None, ), "Register": ( - "https://circuitpython.readthedocs.io/projects/register/en/latest/", + "https://docs.circuitpython.org/projects/register/en/latest/", None, ), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index b7baacd..73be464 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,7 @@ Table of Contents :caption: Other Links Download - CircuitPython Reference Documentation + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/setup.py b/setup.py index 253b8d2..24b5749 100644 --- a/setup.py +++ b/setup.py @@ -50,8 +50,6 @@ "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", ], # What does your project relate to? keywords="adafruit analog precision temperature sensor hardware adt7410 " From a29a7908fb92890e28d4e9958123c3086cbc65da Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Wed, 9 Feb 2022 12:32:31 -0500 Subject: [PATCH 24/67] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 1b449eb..20dfa63 100644 --- a/README.rst +++ b/README.rst @@ -75,14 +75,11 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. From 4ac081ec02516cf1232b6ade34ee7b076f7e5942 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 10:40:37 -0700 Subject: [PATCH 25/67] Added type annotations --- adafruit_adt7410.py | 51 ++++++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index 22156aa..907fa10 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -36,10 +36,12 @@ import time import struct +import busio from adafruit_bus_device.i2c_device import I2CDevice from adafruit_register.i2c_bit import RWBit, ROBit from micropython import const + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410.git" @@ -91,17 +93,18 @@ class ADT7410: """ # many modes can be set with register objects for simplicity - ready = ROBit(_ADT7410_STATUS, 7) - ctpin_polarity = RWBit(_ADT7410_CONFIG, 2) - intpin_polarity = RWBit(_ADT7410_CONFIG, 3) - comparator_mode = RWBit(_ADT7410_CONFIG, 4) - high_resolution = RWBit(_ADT7410_CONFIG, 7) + ready: ROBit = ROBit(_ADT7410_STATUS, 7) + ctpin_polarity: RWBit = RWBit(_ADT7410_CONFIG, 2) + intpin_polarity: RWBit = RWBit(_ADT7410_CONFIG, 3) + comparator_mode: RWBit = RWBit(_ADT7410_CONFIG, 4) + high_resolution: RWBit = RWBit(_ADT7410_CONFIG, 7) + # Status Information configuration - temp_over_critiq = ROBit(_ADT7410_STATUS, 6) - temp_over_high = ROBit(_ADT7410_STATUS, 5) - temp_under_low = ROBit(_ADT7410_STATUS, 4) + temp_over_critiq: ROBit = ROBit(_ADT7410_STATUS, 6) + temp_over_high: ROBit = ROBit(_ADT7410_STATUS, 5) + temp_under_low: ROBit = ROBit(_ADT7410_STATUS, 4) - def __init__(self, i2c_bus, address=0x48): + def __init__(self, i2c_bus: busio.I2C, address: int = 0x48): self.i2c_device = I2CDevice(i2c_bus, address) self._buf = bytearray(3) # Verify the manufacturer and device ids to ensure we are talking to @@ -114,31 +117,31 @@ def __init__(self, i2c_bus, address=0x48): self.reset() @property - def temperature(self): + def temperature(self) -> float: """The temperature in Celsius""" temp = self._read_register(_ADT7410_TEMPMSB, 2) return struct.unpack(">h", temp)[0] / 128 @property - def status(self): + def status(self) -> int: """The ADT7410 status registers current value""" return self._read_register(_ADT7410_STATUS)[0] @property - def configuration(self): + def configuration(self) -> int: """The ADT7410 configuration register""" return self._read_register(_ADT7410_CONFIG)[0] @configuration.setter - def configuration(self, val): + def configuration(self, val: int) -> None: self._write_register(_ADT7410_CONFIG, val) - def reset(self): + def reset(self) -> None: """Perform a software reset""" self._write_register(_ADT7410_SWRST) time.sleep(0.5) - def _read_register(self, addr, num=1): + def _read_register(self, addr: int, num: int = 1) -> int: self._buf[0] = addr with self.i2c_device as i2c: i2c.write_then_readinto( @@ -146,7 +149,7 @@ def _read_register(self, addr, num=1): ) return self._buf[1 : num + 1] - def _write_register(self, addr, data=None): + def _write_register(self, addr: int, data: int = None) -> None: self._buf[0] = addr end = 1 if data: @@ -156,39 +159,39 @@ def _write_register(self, addr, data=None): i2c.write(self._buf, end=end) @property - def high_temperature(self): + def high_temperature(self) -> int: """The over temperature limit value in Celsius""" temp = self._read_register(_ADT7410_THIGHMSB, 2) return struct.unpack(">h", temp)[0] / 128 @high_temperature.setter - def high_temperature(self, value): + def high_temperature(self, value: int) -> None: value = struct.pack(">h", int(value * 128)) self._write_register(_ADT7410_THIGHMSB, value[0]) self._write_register(_ADT7410_THIGHLSB, value[1]) @property - def low_temperature(self): + def low_temperature(self) -> int: """The over temperature limit value in Celsius. Only works when comparator mode is selected""" temp = self._read_register(_ADT7410_TLOWMSB, 2) return struct.unpack(">h", temp)[0] / 128 @low_temperature.setter - def low_temperature(self, value): + def low_temperature(self, value: int) -> None: value = struct.pack(">h", int(value * 128)) self._write_register(_ADT7410_TLOWMSB, value[0]) self._write_register(_ADT7410_TLOWLSB, value[1]) @property - def critical_temperature(self): + def critical_temperature(self) -> int: """The critical temperature limit value in Celsius. Only works when comparator mode is selected""" temp = self._read_register(_ADT7410_TCRITMSB, 2) return struct.unpack(">h", temp)[0] / 128 @critical_temperature.setter - def critical_temperature(self, value): + def critical_temperature(self, value: int) -> None: """The over temperature limit value in Celsius There is a bug in the sensor, so the address 0x09 could no be written to 0x00 for this reason only odd numbers could be given. We could make the 0x09 with @@ -200,14 +203,14 @@ def critical_temperature(self, value): self._write_register(_ADT7410_TCRITLSB, value[1]) @property - def hysteresis(self): + def hysteresis(self) -> int: """The hysteresis temperature limit value in Celsius. Only works when comparator mode is selected. From 0 to 15 Celsius""" temp = self._read_register(_ADT7410_THYST)[0] return temp @hysteresis.setter - def hysteresis(self, value): + def hysteresis(self, value: int) -> None: if value > 15 or isinstance(value, float): raise Exception("Hysteresis value must be an integer lower than 15 Celsius") From 413c89bc997414cf84fc01e5533daeb710b62bc4 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 10:41:19 -0700 Subject: [PATCH 26/67] Changed Exception raised by `hysteresis` setter to more specific ValueError --- adafruit_adt7410.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index 907fa10..fbeb4b3 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -212,6 +212,8 @@ def hysteresis(self) -> int: @hysteresis.setter def hysteresis(self, value: int) -> None: if value > 15 or isinstance(value, float): - raise Exception("Hysteresis value must be an integer lower than 15 Celsius") + raise ValueError( + "Hysteresis value must be an integer lower than 15 Celsius" + ) self._write_register(_ADT7410_THYST, value) From 20e8e4c72827bcee23cdc32efc2bd1c72c13bb54 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 14:43:06 -0700 Subject: [PATCH 27/67] Moved busio import inside a try block to save memory --- adafruit_adt7410.py | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index fbeb4b3..af21230 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -36,29 +36,33 @@ import time import struct -import busio from adafruit_bus_device.i2c_device import I2CDevice from adafruit_register.i2c_bit import RWBit, ROBit from micropython import const - -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410.git" - - -_ADT7410_TEMPMSB = const(0x0) -_ADT7410_TEMPLSB = const(0x1) -_ADT7410_STATUS = const(0x2) -_ADT7410_CONFIG = const(0x3) -_ADT7410_THIGHMSB = const(0x4) -_ADT7410_THIGHLSB = const(0x5) -_ADT7410_TLOWMSB = const(0x6) -_ADT7410_TLOWLSB = const(0x7) -_ADT7410_TCRITMSB = const(0x8) -_ADT7410_TCRITLSB = const(0x9) -_ADT7410_THYST = const(0x0A) -_ADT7410_ID = const(0xB) -_ADT7410_SWRST = const(0x2F) +try: + # Used only for typing + import busio # pylint: disable=unused-import +except ImportError: + pass + +__version__: str = "0.0.0-auto.0" +__repo__: str = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410.git" + + +_ADT7410_TEMPMSB: int = const(0x0) +_ADT7410_TEMPLSB: int = const(0x1) +_ADT7410_STATUS: int = const(0x2) +_ADT7410_CONFIG: int = const(0x3) +_ADT7410_THIGHMSB: int = const(0x4) +_ADT7410_THIGHLSB: int = const(0x5) +_ADT7410_TLOWMSB: int = const(0x6) +_ADT7410_TLOWLSB: int = const(0x7) +_ADT7410_TCRITMSB: int = const(0x8) +_ADT7410_TCRITLSB: int = const(0x9) +_ADT7410_THYST: int = const(0x0A) +_ADT7410_ID: int = const(0xB) +_ADT7410_SWRST: int = const(0x2F) class ADT7410: From 8f94ef9189668c5e4beda66cde86c7be671a67f7 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 14:44:06 -0700 Subject: [PATCH 28/67] Reformatting added by black --- adafruit_adt7410.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index af21230..b1a1be4 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -42,7 +42,7 @@ try: # Used only for typing - import busio # pylint: disable=unused-import + import busio # pylint: disable=unused-import except ImportError: pass From 75c0742b15ef789511bb74ec1c9262fe50c3cd4b Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 17:05:02 -0700 Subject: [PATCH 29/67] Removed type hints from __ constants --- adafruit_adt7410.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index b1a1be4..2e78b2f 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -46,8 +46,8 @@ except ImportError: pass -__version__: str = "0.0.0-auto.0" -__repo__: str = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410.git" +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410.git" _ADT7410_TEMPMSB: int = const(0x0) From d50c1c2217dfb42f26be785a87e097231bac1e14 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 30/67] Fixed readthedocs build Signed-off-by: dherrada --- .readthedocs.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..33c2a61 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,12 @@ # Required version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From e478584346aeea45b9b628c7b587fd755a7ab7ed Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 31/67] Update Black to latest. Signed-off-by: Kattni Rembor --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..7467c1d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ repos: - repo: https://github.com/python/black - rev: 20.8b1 + rev: 22.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool From 44b1c16a7f3d6f5dfd2f41e642731f83fb264f06 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:00:27 -0400 Subject: [PATCH 32/67] Updated gitignore Signed-off-by: evaherrada --- .gitignore | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 9647e71..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,47 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ From 6b39ad6ab3626c33ab22183cd26880e003c9ec4d Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:58:17 -0400 Subject: [PATCH 33/67] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 20dfa63..8b53bbc 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/adt7410/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 0acb272c03fe48fdf276694ae63ebff8e68c23b7 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 13:48:38 -0500 Subject: [PATCH 34/67] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 8b53bbc..293b545 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/adt7410/en/latest/ :alt: Documentation Status -.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 3239fc38ab72b61539e68486e0afee7a2329b10f Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:25:38 -0400 Subject: [PATCH 35/67] Patch .pre-commit-config.yaml --- .pre-commit-config.yaml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7467c1d..3343606 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,40 +3,40 @@ # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black + - repo: https://github.com/python/black rev: 22.3.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: black + - repo: https://github.com/fsfe/reuse-tool + rev: v0.14.0 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: reuse + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/pycqa/pylint rev: v2.11.1 hooks: - - id: pylint + - id: pylint name: pylint (library code) types: [python] args: - --disable=consider-using-f-string exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint + - id: pylint name: pylint (example code) description: Run pylint rules on "examples/*.py" files types: [python] files: "^examples/" args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint name: pylint (test code) description: Run pylint rules on "tests/*.py" files types: [python] files: "^tests/" args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - --disable=missing-docstring,consider-using-f-string,duplicate-code From 25d660607e8c7c1f3f3b22ca7584d38fa5643b8f Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 36/67] Increase min lines similarity Signed-off-by: Alec Delaney --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index cfd1c41..f006a4a 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From 92577fc95f6a7b1cf31d2be8710bd5c38f129693 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 37/67] Switch to inclusive terminology Signed-off-by: Alec Delaney --- .pylintrc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pylintrc b/.pylintrc index f006a4a..f772971 100644 --- a/.pylintrc +++ b/.pylintrc @@ -9,11 +9,11 @@ # run arbitrary code extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# Add files or directories to the ignore-list. They should be base names, not # paths. ignore=CVS -# Add files or directories matching the regex patterns to the blacklist. The +# Add files or directories matching the regex patterns to the ignore-list. The # regex matches against base names, not paths. ignore-patterns= From 53cec00496c61a36e526b577b974beaa8dff50b7 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 38/67] Set language to "en" for documentation Signed-off-by: Alec Delaney --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index c1da010..71c6015 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -68,7 +68,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From e5fe50c116fe35bad76e9273badc2898063ebf5d Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:33:58 -0400 Subject: [PATCH 39/67] Added cp.org link to index.rst --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 73be464..13456a8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From ee89c2b229a0e942eacc01670dd0e3b7fc07f235 Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Wed, 6 Jul 2022 13:53:09 -0400 Subject: [PATCH 40/67] annotated __init__ by adding -> None: --- adafruit_adt7410.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index 2e78b2f..dd2f924 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -108,7 +108,7 @@ class ADT7410: temp_over_high: ROBit = ROBit(_ADT7410_STATUS, 5) temp_under_low: ROBit = ROBit(_ADT7410_STATUS, 4) - def __init__(self, i2c_bus: busio.I2C, address: int = 0x48): + def __init__(self, i2c_bus: busio.I2C, address: int = 0x48) -> None: self.i2c_device = I2CDevice(i2c_bus, address) self._buf = bytearray(3) # Verify the manufacturer and device ids to ensure we are talking to From 8d88d04d5847b21eabe9f6a92e0540ae5134cc8e Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:58:26 -0400 Subject: [PATCH 41/67] Changed .env to .venv in README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 293b545..e9d34a9 100644 --- a/README.rst +++ b/README.rst @@ -48,8 +48,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-adt7410 Usage Example From 5770a799b12776e345599cf658aac3fe2eb73d8e Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:00:18 -0400 Subject: [PATCH 42/67] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index e9d34a9..32af832 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_ADT7410/actions/ :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + CircuitPython driver for reading temperature from the Analog Devices ADT7410 precision temperature sensor Dependencies From 4ab98f0727e2409cd95051e5258ebdf9c6c9b4f0 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:52 -0400 Subject: [PATCH 43/67] Switched to pyproject.toml --- .github/workflows/build.yml | 18 ++++++----- .github/workflows/release.yml | 17 ++++++---- optional_requirements.txt | 3 ++ pyproject.toml | 47 +++++++++++++++++++++++++++ requirements.txt | 4 +-- setup.py | 60 ----------------------------------- 6 files changed, 72 insertions(+), 77 deletions(-) create mode 100644 optional_requirements.txt create mode 100644 pyproject.toml delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474520d..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,6 +47,8 @@ jobs: pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - name: Pre-commit hooks run: | pre-commit run --all-files @@ -60,16 +62,16 @@ jobs: - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal + pip install --upgrade build twine + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + done; + python -m build twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a65e5de..d1b4f8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,25 +61,28 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | python -m pip install --upgrade pip - pip install setuptools wheel twine + pip install --upgrade build twine - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | - python setup.py sdist + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + done; + python -m build twine upload dist/* diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..376a041 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-adt7410" +description = "CircuitPython driver for reading temperature from the Analog Devices ADT7410 precision temperature sensor." +version = "0.0.0-auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410"} +keywords = [ + "adafruit", + "analog", + "precision", + "temperature", + "sensor", + "hardware", + "adt7410", + "micropython", + "circuitpython", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +py-modules = ["adafruit_adt7410"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index f162505..fcef575 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka -adafruit-circuitpython-busdevice adafruit-circuitpython-register +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py deleted file mode 100644 index 24b5749..0000000 --- a/setup.py +++ /dev/null @@ -1,60 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-adt7410", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython driver for reading temperature from the Analog Devices ADT7410 " - "precision temperature sensor.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_ADT7410", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - "adafruit-circuitpython-busdevice", - "adafruit-circuitpython-register", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit analog precision temperature sensor hardware adt7410 " - "micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - py_modules=["adafruit_adt7410"], -) From 4f5e0794ca895ee31000dfec843d2fe51b52b20e Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 44/67] Add setuptools-scm to build system requirements Signed-off-by: Alec Delaney --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 376a041..335e68e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From ef941f877fc748f6bb82f6d24ff397b2b331bc39 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:12 -0400 Subject: [PATCH 45/67] Update version string --- adafruit_adt7410.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index dd2f924..d048fa5 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -46,7 +46,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410.git" diff --git a/pyproject.toml b/pyproject.toml index 335e68e..2451bdf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-adt7410" description = "CircuitPython driver for reading temperature from the Analog Devices ADT7410 precision temperature sensor." -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From 1ccfeaafadddb472d6d9b9beca886c4ac11d868d Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:12 -0400 Subject: [PATCH 46/67] Fix version strings in workflow files --- .github/workflows/build.yml | 2 +- .github/workflows/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 22f6582..cb2f60e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,7 +71,7 @@ jobs: run: | pip install --upgrade build twine for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; done; python -m build twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d1b4f8d..f3a0325 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -82,7 +82,7 @@ jobs: TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; done; python -m build twine upload dist/* From 41f00f2c8cb169566ee31ab77e33a8ca7a10b001 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:29 -0400 Subject: [PATCH 47/67] Keep copyright up to date in documentation --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 71c6015..1932efd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import os import sys +import datetime sys.path.insert(0, os.path.abspath("..")) @@ -51,7 +52,8 @@ # General information about the project. project = "Adafruit ADT7410 Library" -copyright = "2019 ladyada" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for From ac2c4eeddc15b8a8a2502ab4c726dd973ef13c15 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:19 -0400 Subject: [PATCH 48/67] Use year duration range for copyright attribution --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 1932efd..16710ce 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,8 +52,14 @@ # General information about the project. project = "Adafruit ADT7410 Library" +creation_year = "2019" current_year = str(datetime.datetime.now().year) -copyright = current_year + " ladyada" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for From b15b3f76ba92c079ea2b3af589f514635cd66100 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:49 -0400 Subject: [PATCH 49/67] Switching to composite actions --- .github/workflows/build.yml | 67 +---------------------- .github/workflows/release.yml | 88 ------------------------------ .github/workflows/release_gh.yml | 14 +++++ .github/workflows/release_pypi.yml | 14 +++++ 4 files changed, 30 insertions(+), 153 deletions(-) delete mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/release_gh.yml create mode 100644 .github/workflows/release_pypi.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cb2f60e..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,68 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - pip install --upgrade build twine - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; - done; - python -m build - twine check dist/* + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f3a0325..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,88 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - python -m pip install --upgrade pip - pip install --upgrade build twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; - done; - python -m build - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main From 675af7b3bd6df2af3a687885e03628562a9e1774 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:46:59 -0400 Subject: [PATCH 50/67] Updated pylint version to 2.13.0 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3343606..4c43710 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.13.0 hooks: - id: pylint name: pylint (library code) From 22ab2e3f788c6d1308bd7eb0fcaed6e3a43da238 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:18 -0400 Subject: [PATCH 51/67] Update pylint to 2.15.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4c43710..0e5fccc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.13.0 + rev: v2.15.5 hooks: - id: pylint name: pylint (library code) From 05b33532cdbe75d72d8c547ff5c03c4f3a26e721 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:43 -0400 Subject: [PATCH 52/67] Fix release CI files --- .github/workflows/release_gh.yml | 14 +++++++++----- .github/workflows/release_pypi.yml | 15 ++++++++++----- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index 041a337..b8aa8d6 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -2,13 +2,17 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: GitHub Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index 041a337..65775b7 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -2,13 +2,18 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: PyPI Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} From ac17e0d407161a47cfcd4bd956da0107ce46d8c4 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:32 -0400 Subject: [PATCH 53/67] Update .pylintrc for v2.15.5 --- .pylintrc | 45 ++++----------------------------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/.pylintrc b/.pylintrc index f772971..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: Unlicense @@ -26,7 +26,7 @@ jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. -load-plugins= +load-plugins=pylint.extensions.no_self_use # Pickle collected data for later comparisons. persistent=yes @@ -54,8 +54,8 @@ confidence= # --enable=similarities". If you want to run only the classes checker, but have # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding +# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call +disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -225,12 +225,6 @@ max-line-length=100 # Maximum number of lines in a module max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no @@ -257,38 +251,22 @@ min-similarity-lines=12 [BASIC] -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct argument names argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct attribute names attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Bad variable names which should always be refused, separated by a comma bad-names=foo,bar,baz,toto,tutu,tata -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - # Regular expression matching correct class attribute names class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - # Regular expression matching correct class names # class-rgx=[A-Z_][a-zA-Z0-9]+$ class-rgx=[A-Z_][a-zA-Z0-9_]+$ -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - # Regular expression matching correct constant names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ @@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # ones are exempt. docstring-min-length=-1 -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct function names function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ @@ -309,21 +284,12 @@ good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ # Include a hint for the correct naming format with invalid-name include-naming-hint=no -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - # Regular expression matching correct inline iteration names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct method names method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - # Regular expression matching correct module names module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ @@ -339,9 +305,6 @@ no-docstring-rgx=^_ # to this list to register other decorators that produce valid properties. property-classes=abc.abstractproperty -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct variable names variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ From 492c8c4929848195391f8cf26cd39177da32e0c6 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 18 Nov 2022 13:05:20 -0500 Subject: [PATCH 54/67] Added commented out board.STEMMA_I2C with explanation --- examples/adt7410_simpletest.py | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/adt7410_simpletest.py b/examples/adt7410_simpletest.py index a44a764..544ada5 100644 --- a/examples/adt7410_simpletest.py +++ b/examples/adt7410_simpletest.py @@ -6,6 +6,7 @@ import adafruit_adt7410 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller adt = adafruit_adt7410.ADT7410(i2c, address=0x48) adt.high_resolution = True From c5cf7b0150889942be81e377424ac9c98a06cace Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 1 Sep 2022 20:16:31 -0400 Subject: [PATCH 55/67] Add .venv to .gitignore Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 544ec4a..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ _build # Virtual environment-specific files .env +.venv # MacOS-specific files *.DS_Store From 398b59615fd7895388a656dc7037490bb99d0a59 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 19 Jan 2023 23:39:55 -0500 Subject: [PATCH 56/67] Add upload url to release action Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .github/workflows/release_gh.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index b8aa8d6..9acec60 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -16,3 +16,4 @@ jobs: uses: adafruit/workflows-circuitpython-libs/release-gh@main with: github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} From bc7a2f94be67c01ff825a53d2d5533d9ab5c6f71 Mon Sep 17 00:00:00 2001 From: MATSUOKA Takashi Date: Wed, 15 Feb 2023 21:00:11 +0900 Subject: [PATCH 57/67] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 32af832..f0eb2bb 100644 --- a/README.rst +++ b/README.rst @@ -66,7 +66,7 @@ Usage Example import adafruit_adt7410 i2c = board.I2C() # uses board.SCL and board.SDA - adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) + adt = adafruit_adt7410.ADT7410(i2c, address=0x48) adt.high_resolution = True while True: From ebee3d87d6e973f197cea966c3d3e92f504cfe18 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 58/67] Update pre-commit hooks Signed-off-by: Tekktrik --- .pre-commit-config.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0e5fccc..70ade69 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,21 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: v0.14.0 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.15.5 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) From 5c01223f54157103592e5b49514eb64e981f2d19 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Sun, 14 May 2023 13:00:32 -0400 Subject: [PATCH 59/67] Update .pylintrc, fix jQuery for docs Signed-off-by: Tekktrik --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index 16710ce..6355d41 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 37f7e0d2f544a09d89700d65db3c81238c05a065 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Mon, 12 Jun 2023 14:08:09 -0400 Subject: [PATCH 60/67] updating lib --- adafruit_adt7410.py | 403 ++++++++++++++++++++-------- docs/examples.rst | 29 +- examples/adt7410_operation_mode.py | 20 ++ examples/adt7410_resolution_mode.py | 21 ++ examples/adt7410_temp_limits.py | 31 +++ 5 files changed, 384 insertions(+), 120 deletions(-) create mode 100644 examples/adt7410_operation_mode.py create mode 100644 examples/adt7410_resolution_mode.py create mode 100644 examples/adt7410_temp_limits.py diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index d048fa5..7073dd9 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -1,4 +1,5 @@ # SPDX-FileCopyrightText: 2019 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2023 Jose D. Montoya # # SPDX-License-Identifier: MIT @@ -35,14 +36,14 @@ import time -import struct -from adafruit_bus_device.i2c_device import I2CDevice -from adafruit_register.i2c_bit import RWBit, ROBit +from collections import namedtuple from micropython import const +from adafruit_bus_device import i2c_device +from adafruit_register.i2c_struct import UnaryStruct +from adafruit_register.i2c_bits import RWBits try: - # Used only for typing - import busio # pylint: disable=unused-import + from busio import I2C except ImportError: pass @@ -50,19 +51,30 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410.git" -_ADT7410_TEMPMSB: int = const(0x0) -_ADT7410_TEMPLSB: int = const(0x1) -_ADT7410_STATUS: int = const(0x2) -_ADT7410_CONFIG: int = const(0x3) -_ADT7410_THIGHMSB: int = const(0x4) -_ADT7410_THIGHLSB: int = const(0x5) -_ADT7410_TLOWMSB: int = const(0x6) -_ADT7410_TLOWLSB: int = const(0x7) -_ADT7410_TCRITMSB: int = const(0x8) -_ADT7410_TCRITLSB: int = const(0x9) -_ADT7410_THYST: int = const(0x0A) -_ADT7410_ID: int = const(0xB) -_ADT7410_SWRST: int = const(0x2F) +_REG_WHOAMI = const(0xB) +_TEMP = const(0x00) +_STATUS = const(0x02) +_CONFIGURATION = const(0x03) +_TEMP_HIGH = const(0x04) +_TEMP_LOW = const(0x06) +_TEMP_CRITICAL = const(0x08) +_TEMP_HYSTERESIS = const(0x0A) + +CONTINUOUS = const(0b00) +ONE_SHOT = const(0b01) +SPS = const(0b10) +SHUTDOWN = const(0b11) +operation_mode_values = (CONTINUOUS, ONE_SHOT, SPS, SHUTDOWN) + +LOW_RESOLUTION = const(0b0) +HIGH_RESOLUTION = const(0b1) +resolution_mode_values = (LOW_RESOLUTION, HIGH_RESOLUTION) + +COMP_DISABLED = const(0b0) +COMP_ENABLED = const(0b1) +comparator_mode_values = (COMP_DISABLED, COMP_ENABLED) + +AlertStatus = namedtuple("AlertStatus", ["high_alert", "low_alert", "critical_alert"]) class ADT7410: @@ -96,128 +108,281 @@ class ADT7410: """ - # many modes can be set with register objects for simplicity - ready: ROBit = ROBit(_ADT7410_STATUS, 7) - ctpin_polarity: RWBit = RWBit(_ADT7410_CONFIG, 2) - intpin_polarity: RWBit = RWBit(_ADT7410_CONFIG, 3) - comparator_mode: RWBit = RWBit(_ADT7410_CONFIG, 4) - high_resolution: RWBit = RWBit(_ADT7410_CONFIG, 7) - - # Status Information configuration - temp_over_critiq: ROBit = ROBit(_ADT7410_STATUS, 6) - temp_over_high: ROBit = ROBit(_ADT7410_STATUS, 5) - temp_under_low: ROBit = ROBit(_ADT7410_STATUS, 4) - - def __init__(self, i2c_bus: busio.I2C, address: int = 0x48) -> None: - self.i2c_device = I2CDevice(i2c_bus, address) - self._buf = bytearray(3) - # Verify the manufacturer and device ids to ensure we are talking to - # what we expect. - _id = (self._read_register(_ADT7410_ID)[0]) & 0xF8 - if _id != 0xC8: - raise ValueError( - "Unable to find ADT7410 at i2c address " + str(hex(address)) - ) - self.reset() + _device_id = UnaryStruct(_REG_WHOAMI, "B") + _temperature = UnaryStruct(_TEMP, ">h") + _temperature_high = UnaryStruct(_TEMP_HIGH, ">h") + _temperature_low = UnaryStruct(_TEMP_LOW, ">h") + _temperature_critical = UnaryStruct(_TEMP_CRITICAL, ">h") + _temperature_hysteresis = UnaryStruct(_TEMP_HYSTERESIS, "B") + _status = UnaryStruct(_STATUS, "B") + + # Configuration register + _resolution_mode = RWBits(1, _CONFIGURATION, 7) + _operation_mode = RWBits(2, _CONFIGURATION, 5) + _comparator_mode = RWBits(1, _CONFIGURATION, 4) + + # Status Register + _critical_alert = RWBits(1, _STATUS, 6) + _high_alert = RWBits(1, _STATUS, 5) + _low_alert = RWBits(1, _STATUS, 4) + + def __init__(self, i2c_bus: I2C, address: int = 0x48) -> None: + self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) + + if self._device_id != 0xCB: + raise RuntimeError("Failed to find ADT7410") + + @property + def operation_mode(self) -> str: + """ + Sensor operation_mode + + Continuous Mode + --------------- + + In continuous conversion mode, the read operation provides the most recent + converted result. + + One Shot Mode + -------------- + + When one-shot mode is enabled, the ADT7410 immediately + completes a conversion and then goes into shutdown mode. The + one-shot mode is useful when one of the circuit design priorities is + to reduce power consumption. + + SPS Mode + ---------- + + In this mode, the part performs one measurement per second. + A conversion takes only 60 ms, and it remains in the idle state + for the remaining 940 ms period + + Shutdown Mode + --------------- + The ADT7410 can be placed in shutdown mode, the entire IC is + shut down and no further conversions are initiated until the + ADT7410 is taken out of shutdown mode. The conversion result from the + last conversion prior to shutdown can still be read from the + ADT7410 even when it is in shutdown mode. When the part is + taken out of shutdown mode, the internal clock is started and a + conversion is initiated + + +--------------------------------+------------------+ + | Mode | Value | + +================================+==================+ + | :py:const:`adt7410.CONTINUOUS` | :py:const:`0b00` | + +--------------------------------+------------------+ + | :py:const:`adt7410.ONE_SHOT` | :py:const:`0b01` | + +--------------------------------+------------------+ + | :py:const:`adt7410.SPS` | :py:const:`0b10` | + +--------------------------------+------------------+ + | :py:const:`adt7410.SHUTDOWN` | :py:const:`0b11` | + +--------------------------------+------------------+ + """ + values = ( + "CONTINUOUS", + "ONE_SHOT", + "SPS", + "SHUTDOWN", + ) + return values[self._operation_mode] + + @operation_mode.setter + def operation_mode(self, value: int) -> None: + if value not in operation_mode_values: + raise ValueError("Value must be a valid operation_mode setting") + self._operation_mode = value + time.sleep(0.24) @property def temperature(self) -> float: - """The temperature in Celsius""" - temp = self._read_register(_ADT7410_TEMPMSB, 2) - return struct.unpack(">h", temp)[0] / 128 + """ + Temperature in Celsius + In normal mode, the ADT7410 runs an automatic conversion + sequence. During this automatic conversion sequence, a conversion + takes 240 ms to complete and the ADT7410 is continuously + converting. This means that as soon as one temperature conversion + is completed, another temperature conversion begins. + On power-up, the first conversion is a fast conversion, taking + typically 6 ms. Fast conversion temperature accuracy is typically + within ±5°C. + The measured temperature value is compared with a critical + temperature limit, a high temperature limit, and a low temperature + limit. If the measured value + exceeds these limits, the INT pin is activated; and if it exceeds the + :attr:`critical_temp` limit, the CT pin is activated. + """ + return self._temperature / 128 @property - def status(self) -> int: - """The ADT7410 status registers current value""" - return self._read_register(_ADT7410_STATUS)[0] + def resolution_mode(self) -> str: + """ + Sensor resolution_mode + + +-------------------------------------+-----------------+ + | Mode | Value | + +=====================================+=================+ + | :py:const:`adt7410.LOW_RESOLUTION` | :py:const:`0b0` | + +-------------------------------------+-----------------+ + | :py:const:`adt7410.HIGH_RESOLUTION` | :py:const:`0b1` | + +-------------------------------------+-----------------+ + """ + values = ( + "LOW_RESOLUTION", + "HIGH_RESOLUTION", + ) + return values[self._resolution_mode] + + @resolution_mode.setter + def resolution_mode(self, value: int) -> None: + if value not in resolution_mode_values: + raise ValueError("Value must be a valid resolution_mode setting") + self._resolution_mode = value + + @property + def alert_status(self): + """The current triggered status of the high and low temperature alerts as a AlertStatus + named tuple with attributes for the triggered status of each alert. + + .. code-block :: python + + import time + import board + import adt7410 + + i2c = board.I2C() # uses board.SCL and board.SDA + adt = adt7410.ADT7410(i2c) + + tmp.low_temperature = 20 + tmp.high_temperature = 23 + tmp.critical_temperature = 30 + + print("High limit: {}".format(tmp.high_temperature)) + print("Low limit: {}".format(tmp.low_temperature)) + print("Critical limit: {}".format(tmp.critical_temperature)) + + adt.comparator_mode = adt7410.COMP_ENABLED + + while True: + print("Temperature: {:.2f}C".format(adt.temperature)) + alert_status = tmp.alert_status + if alert_status.high_alert: + print("Temperature above high set limit!") + if alert_status.low_alert: + print("Temperature below low set limit!") + if alert_status.critical_alert: + print("Temperature above critical set limit!") + time.sleep(1) + + """ + + return AlertStatus( + high_alert=self._high_alert, + low_alert=self._low_alert, + critical_alert=self._critical_alert, + ) @property - def configuration(self) -> int: - """The ADT7410 configuration register""" - return self._read_register(_ADT7410_CONFIG)[0] - - @configuration.setter - def configuration(self, val: int) -> None: - self._write_register(_ADT7410_CONFIG, val) - - def reset(self) -> None: - """Perform a software reset""" - self._write_register(_ADT7410_SWRST) - time.sleep(0.5) - - def _read_register(self, addr: int, num: int = 1) -> int: - self._buf[0] = addr - with self.i2c_device as i2c: - i2c.write_then_readinto( - self._buf, self._buf, out_end=1, in_start=1, in_end=num + 1 - ) - return self._buf[1 : num + 1] - - def _write_register(self, addr: int, data: int = None) -> None: - self._buf[0] = addr - end = 1 - if data: - self._buf[1] = data - end = 2 - with self.i2c_device as i2c: - i2c.write(self._buf, end=end) + def comparator_mode(self) -> str: + """ + Sensor comparator_mode + + +-----------------------------------+-----------------+ + | Mode | Value | + +===================================+=================+ + | :py:const:`adt7410.COMP_DISABLED` | :py:const:`0b0` | + +-----------------------------------+-----------------+ + | :py:const:`adt7410.COMP_ENABLED` | :py:const:`0b1` | + +-----------------------------------+-----------------+ + """ + values = ( + "COMP_DISABLED", + "COMP_ENABLED", + ) + return values[self._comparator_mode] + + @comparator_mode.setter + def comparator_mode(self, value: int) -> None: + if value not in comparator_mode_values: + raise ValueError("Value must be a valid comparator_mode setting") + self._comparator_mode = value @property - def high_temperature(self) -> int: - """The over temperature limit value in Celsius""" - temp = self._read_register(_ADT7410_THIGHMSB, 2) - return struct.unpack(">h", temp)[0] / 128 + def high_temperature(self) -> float: + """ + High temperature limit value in Celsius + When the temperature goes above the :attr:`high_temperature`, + and if :attr:`comparator_mode` is selected. The :attr:`alert_status` + high_alert clears to 0 when the status register is read and/or when + the temperature measured goes back below the limit set in the setpoint + :attr:`high_temperature` + :attr:`hysteresis_temperature` + + The INT pin is activated if an over temperature event occur + The default setting is 64°C + + """ + return self._temperature_high // 128 @high_temperature.setter def high_temperature(self, value: int) -> None: - value = struct.pack(">h", int(value * 128)) - self._write_register(_ADT7410_THIGHMSB, value[0]) - self._write_register(_ADT7410_THIGHLSB, value[1]) + if value not in range(-55, 151, 1): + raise ValueError("Temperature should be between -55C and 150C") + self._temperature_high = value * 128 @property - def low_temperature(self) -> int: - """The over temperature limit value in Celsius. Only works when - comparator mode is selected""" - temp = self._read_register(_ADT7410_TLOWMSB, 2) - return struct.unpack(">h", temp)[0] / 128 + def low_temperature(self) -> float: + """ + Low temperature limit value in Celsius. + When the temperature goes below the :attr:`low_temperature`, + and if :attr:`comparator_mode` is selected. The :attr:`alert_status` + low_alert clears to 0 when the status register is read and/or when + the temperature measured goes back above the limit set in the setpoint + :attr:`low_temperature` + :attr:`hysteresis_temperature` + + The INT pin is activated if an under temperature event occur + The default setting is 10°C + """ + return self._temperature_low // 128 @low_temperature.setter def low_temperature(self, value: int) -> None: - value = struct.pack(">h", int(value * 128)) - self._write_register(_ADT7410_TLOWMSB, value[0]) - self._write_register(_ADT7410_TLOWLSB, value[1]) + if value not in range(-55, 151, 1): + raise ValueError("Temperature should be between -55C and 150C") + self._temperature_low = value * 128 @property - def critical_temperature(self) -> int: - """The critical temperature limit value in Celsius. Only works when - comparator mode is selected""" - temp = self._read_register(_ADT7410_TCRITMSB, 2) - return struct.unpack(">h", temp)[0] / 128 + def critical_temperature(self) -> float: + """ + Critical temperature limit value in Celsius + When the temperature goes above the :attr:`critical_temperature`, + and if :attr:`comparator_mode` is selected. The :attr:`alert_status` + critical_alert clears to 0 when the status register is read and/or when + the temperature measured goes back below the limit set in + :attr:`critical_temperature` + :attr:`hysteresis_temperature` + + The INT pin is activated if a critical over temperature event occur + The default setting is 147°C + """ + return self._temperature_critical // 128 @critical_temperature.setter def critical_temperature(self, value: int) -> None: - """The over temperature limit value in Celsius - There is a bug in the sensor, so the address 0x09 could no be written to 0x00 - for this reason only odd numbers could be given. We could make the 0x09 with - a value of 0x01, however make the logic more complex. Only works when - comparator mode is selected - """ - value = struct.pack(">h", int(value * 128)) - self._write_register(_ADT7410_TCRITMSB, value[0]) - self._write_register(_ADT7410_TCRITLSB, value[1]) + if value not in range(-55, 151, 1): + raise ValueError("Temperature should be between -55C and 15C") + self._temperature_critical = value * 128 @property - def hysteresis(self) -> int: - """The hysteresis temperature limit value in Celsius. Only works when - comparator mode is selected. From 0 to 15 Celsius""" - temp = self._read_register(_ADT7410_THYST)[0] - return temp - - @hysteresis.setter - def hysteresis(self, value: int) -> None: - if value > 15 or isinstance(value, float): - raise ValueError( - "Hysteresis value must be an integer lower than 15 Celsius" - ) - - self._write_register(_ADT7410_THYST, value) + def hysteresis_temperature(self) -> float: + """ + Hysteresis temperature limit value in Celsius for the + :attr:`critical_temperature`, :attr:`high_temperature` and + :attr:`low_temperature` limits + """ + return self._temperature_hysteresis + + @hysteresis_temperature.setter + def hysteresis_temperature(self, value: int) -> None: + if value not in range(0, 16, 1): + raise ValueError("Temperature should be between 0C and 15C") + self._temperature_hysteresis = value diff --git a/docs/examples.rst b/docs/examples.rst index 03fae23..4b45281 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -5,4 +5,31 @@ Ensure your device works with this simple test. .. literalinclude:: ../examples/adt7410_simpletest.py :caption: examples/adt7410_simpletest.py - :linenos: + :lines: 5- + +Resolution mode settings +------------------------- + +Example showing the Resolution mode setting + +.. literalinclude:: ../examples/adt7410_resolution_mode.py + :caption: examples/adt7410_resolution_mode.py + :lines: 5- + +Temperature Limits +------------------------- + +Temperature Limits example + +.. literalinclude:: ../examples/adt7410_temp_limits.py + :caption: examples/adt7410_temp_limits.py + :lines: 5- + +Operation mode settings +------------------------ + +Example showing the Operation mode setting + +.. literalinclude:: ../examples/adt7410_operation_mode.py + :caption: examples/adt7410_operation_mode.py + :lines: 5- diff --git a/examples/adt7410_operation_mode.py b/examples/adt7410_operation_mode.py new file mode 100644 index 0000000..ed1e840 --- /dev/null +++ b/examples/adt7410_operation_mode.py @@ -0,0 +1,20 @@ +# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya +# +# SPDX-License-Identifier: MIT + +import time +import board +import adt7410 + +i2c = board.I2C() +adt = adt7410.ADT7410(i2c) + +adt.operation_mode = adt7410.SPS + +while True: + for operation_mode in adt7410.operation_mode_values: + print("Current Operation mode setting: ", adt.operation_mode) + for _ in range(10): + print("Temperature: {:.2f}C".format(adt.temperature)) + time.sleep(0.5) + adt.operation_mode = operation_mode diff --git a/examples/adt7410_resolution_mode.py b/examples/adt7410_resolution_mode.py new file mode 100644 index 0000000..e3319cb --- /dev/null +++ b/examples/adt7410_resolution_mode.py @@ -0,0 +1,21 @@ +# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya +# +# SPDX-License-Identifier: MIT + +import time +import board +import adt7410 + +i2c = board.I2C() +adt = adt7410.ADT7410(i2c) + +adt.resolution_mode = adt7410.HIGH_RESOLUTION + +while True: + for resolution_mode in adt7410.resolution_mode_values: + print("Current Resolution mode setting: ", adt.resolution_mode) + for _ in range(10): + temp = adt.temperature + print("Temperature :{:.2f}C".format(temp)) + time.sleep(0.5) + adt.resolution_mode = resolution_mode diff --git a/examples/adt7410_temp_limits.py b/examples/adt7410_temp_limits.py new file mode 100644 index 0000000..2524563 --- /dev/null +++ b/examples/adt7410_temp_limits.py @@ -0,0 +1,31 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +import time +import board +import adt7410 + +i2c = board.I2C() # uses board.SCL and board.SDA +adt = adt7410.ADT7410(i2c) + +adt.low_temperature = 18 +adt.high_temperature = 29 +adt.critical_temperature = 35 +adt.hysteresis_temperature = 2 + +print("High limit: {}C".format(adt.high_temperature)) +print("Low limit: {}C".format(adt.low_temperature)) +print("Critical limit: {}C".format(adt.critical_temperature)) + +adt.comparator_mode = adt7410.COMP_ENABLED + +while True: + print("Temperature: {:.2f}C".format(adt.temperature)) + alert_status = adt.alert_status + if alert_status.high_alert: + print("Temperature above high set limit!") + if alert_status.low_alert: + print("Temperature below low set limit!") + if alert_status.critical_alert: + print("Temperature above critical set limit!") + time.sleep(1) From 53aa6a9690f407783fabd1d19b28e455945ce1a8 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:17:07 -0500 Subject: [PATCH 61/67] "fix rtd theme " --- docs/conf.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 6355d41..aa9c240 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -109,19 +109,10 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 3eb9080c72cf0e6174e68c66b32d71f12a51f3ca Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 62/67] unpin sphinx and add sphinx-rtd-theme to docs reqs Signed-off-by: foamyguy --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 797aa04..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx sphinxcontrib-jquery +sphinx-rtd-theme From 6fa5d57251df00c9f2d1a6a077c60d1c8ad03314 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 8 Jan 2024 11:18:47 -0600 Subject: [PATCH 63/67] high_resolution convenience property. Allow getter values to be fed back into setters --- adafruit_adt7410.py | 66 ++++++++++++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 25 deletions(-) diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index 7073dd9..19e1cdd 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -34,7 +34,6 @@ """ - import time from collections import namedtuple from micropython import const @@ -47,10 +46,14 @@ except ImportError: pass +try: + from typing import Union +except ImportError: + pass + __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ADT7410.git" - _REG_WHOAMI = const(0xB) _TEMP = const(0x00) _STATUS = const(0x02) @@ -65,14 +68,22 @@ SPS = const(0b10) SHUTDOWN = const(0b11) operation_mode_values = (CONTINUOUS, ONE_SHOT, SPS, SHUTDOWN) +operation_mode_strings = ( + "CONTINUOUS", + "ONE_SHOT", + "SPS", + "SHUTDOWN", +) LOW_RESOLUTION = const(0b0) HIGH_RESOLUTION = const(0b1) resolution_mode_values = (LOW_RESOLUTION, HIGH_RESOLUTION) +resolution_mode_strings = ("LOW_RESOLUTION", "HIGH_RESOLUTION") COMP_DISABLED = const(0b0) COMP_ENABLED = const(0b1) comparator_mode_values = (COMP_DISABLED, COMP_ENABLED) +comparator_mode_strings = ("COMP_DISABLED", "COMP_ENABLED") AlertStatus = namedtuple("AlertStatus", ["high_alert", "low_alert", "critical_alert"]) @@ -180,18 +191,15 @@ def operation_mode(self) -> str: | :py:const:`adt7410.SHUTDOWN` | :py:const:`0b11` | +--------------------------------+------------------+ """ - values = ( - "CONTINUOUS", - "ONE_SHOT", - "SPS", - "SHUTDOWN", - ) - return values[self._operation_mode] + return operation_mode_strings[self._operation_mode] @operation_mode.setter - def operation_mode(self, value: int) -> None: + def operation_mode(self, value: Union[int, str]) -> None: if value not in operation_mode_values: - raise ValueError("Value must be a valid operation_mode setting") + if value not in operation_mode_strings: + raise ValueError("Value must be a valid operation_mode setting") + + value = operation_mode_strings.index(value) self._operation_mode = value time.sleep(0.24) @@ -228,18 +236,27 @@ def resolution_mode(self) -> str: | :py:const:`adt7410.HIGH_RESOLUTION` | :py:const:`0b1` | +-------------------------------------+-----------------+ """ - values = ( - "LOW_RESOLUTION", - "HIGH_RESOLUTION", - ) - return values[self._resolution_mode] + + return resolution_mode_strings[self._resolution_mode] @resolution_mode.setter - def resolution_mode(self, value: int) -> None: + def resolution_mode(self, value: Union[int, str]) -> None: if value not in resolution_mode_values: - raise ValueError("Value must be a valid resolution_mode setting") + if value not in resolution_mode_strings: + raise ValueError("Value must be a valid resolution_mode setting") + + value = resolution_mode_strings.index(value) self._resolution_mode = value + @property + def high_resolution(self) -> bool: + """Whether the device is currently configured for high resolution mode.""" + return self.resolution_mode == HIGH_RESOLUTION + + @high_resolution.setter + def high_resolution(self, value: bool) -> None: + self.resolution_mode = HIGH_RESOLUTION if value else LOW_RESOLUTION + @property def alert_status(self): """The current triggered status of the high and low temperature alerts as a AlertStatus @@ -296,16 +313,15 @@ def comparator_mode(self) -> str: | :py:const:`adt7410.COMP_ENABLED` | :py:const:`0b1` | +-----------------------------------+-----------------+ """ - values = ( - "COMP_DISABLED", - "COMP_ENABLED", - ) - return values[self._comparator_mode] + return comparator_mode_strings[self._comparator_mode] @comparator_mode.setter - def comparator_mode(self, value: int) -> None: + def comparator_mode(self, value: Union[int, str]) -> None: if value not in comparator_mode_values: - raise ValueError("Value must be a valid comparator_mode setting") + if value not in comparator_mode_strings: + raise ValueError("Value must be a valid comparator_mode setting") + + value = comparator_mode_strings.index(value) self._comparator_mode = value @property From 9d23af4379571099deb29d40ce57838d40f36671 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 64/67] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index aa9c240..d00cd57 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -112,7 +112,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 2187748aed1447e827b9669f1535feca042a6290 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 65/67] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: From 2be280326b11ff0db5a19479d0239fd3924e16b2 Mon Sep 17 00:00:00 2001 From: jposada2020 Date: Fri, 31 Jan 2025 11:20:55 -0500 Subject: [PATCH 66/67] adding_displayio_example --- docs/examples.rst | 9 +++++ examples/adt7410_displayio_simpletest.py | 43 ++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 examples/adt7410_displayio_simpletest.py diff --git a/docs/examples.rst b/docs/examples.rst index 4b45281..02f625d 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -33,3 +33,12 @@ Example showing the Operation mode setting .. literalinclude:: ../examples/adt7410_operation_mode.py :caption: examples/adt7410_operation_mode.py :lines: 5- + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/adt7410_displayio_simpletest.py + :caption: examples/adt7410_displayio_simpletest.py + :lines: 5- diff --git a/examples/adt7410_displayio_simpletest.py b/examples/adt7410_displayio_simpletest.py new file mode 100644 index 0000000..b8355fa --- /dev/null +++ b/examples/adt7410_displayio_simpletest.py @@ -0,0 +1,43 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# SPDX-FileCopyrightText: 2024 Jose D. Montoya +# +# SPDX-License-Identifier: MIT + +import time +import board +from adafruit_display_text.bitmap_label import Label +from terminalio import FONT +from displayio import Group +import adafruit_adt7410 + +# Simple demo of using the built-in display. +# create a main_group to hold anything we want to show on the display. +main_group = Group() +# Initialize I2C bus and sensor. +i2c = board.I2C() # uses board.SCL and board.SDA +adt = adafruit_adt7410.ADT7410(i2c, address=0x48) +adt.high_resolution = True + +# Create Label(s) to show the readings. If you have a very small +# display you may need to change to scale=1. +display_output_label = Label(FONT, text="", scale=2) + +# place the label(s) in the middle of the screen with anchored positioning +display_output_label.anchor_point = (0, 0) +display_output_label.anchored_position = ( + 4, + board.DISPLAY.height // 2 - 60, +) + +# add the label(s) to the main_group +main_group.append(display_output_label) + +# set the main_group as the root_group of the built-in DISPLAY +board.DISPLAY.root_group = main_group + +# begin main loop +while True: + # update the text of the label(s) to show the sensor readings + display_output_label.text = f"Temperature: {adt.temperature:.1f} C" + # wait for a bit + time.sleep(0.5) From bb16966e8dbf6e7b994cac41c35ed7f64b857a15 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 13 May 2025 17:32:40 +0000 Subject: [PATCH 67/67] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +-- .pylintrc | 399 ----------------------- README.rst | 6 +- adafruit_adt7410.py | 5 +- docs/api.rst | 3 + docs/conf.py | 8 +- examples/adt7410_displayio_simpletest.py | 4 +- examples/adt7410_operation_mode.py | 5 +- examples/adt7410_resolution_mode.py | 5 +- examples/adt7410_simpletest.py | 2 + examples/adt7410_temp_limits.py | 11 +- ruff.toml | 105 ++++++ 13 files changed, 155 insertions(+), 452 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/README.rst b/README.rst index f0eb2bb..9887f95 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_ADT7410/actions/ :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff CircuitPython driver for reading temperature from the Analog Devices ADT7410 precision temperature sensor diff --git a/adafruit_adt7410.py b/adafruit_adt7410.py index 19e1cdd..418a7ca 100644 --- a/adafruit_adt7410.py +++ b/adafruit_adt7410.py @@ -36,10 +36,11 @@ import time from collections import namedtuple -from micropython import const + from adafruit_bus_device import i2c_device -from adafruit_register.i2c_struct import UnaryStruct from adafruit_register.i2c_bits import RWBits +from adafruit_register.i2c_struct import UnaryStruct +from micropython import const try: from busio import I2C diff --git a/docs/api.rst b/docs/api.rst index 4cf6e41..91de11a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_adt7410 :members: diff --git a/docs/conf.py b/docs/conf.py index d00cd57..20b916b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -56,9 +54,7 @@ creation_year = "2019" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " ladyada" author = "ladyada" diff --git a/examples/adt7410_displayio_simpletest.py b/examples/adt7410_displayio_simpletest.py index b8355fa..7e1ee14 100644 --- a/examples/adt7410_displayio_simpletest.py +++ b/examples/adt7410_displayio_simpletest.py @@ -4,10 +4,12 @@ # SPDX-License-Identifier: MIT import time + import board from adafruit_display_text.bitmap_label import Label -from terminalio import FONT from displayio import Group +from terminalio import FONT + import adafruit_adt7410 # Simple demo of using the built-in display. diff --git a/examples/adt7410_operation_mode.py b/examples/adt7410_operation_mode.py index ed1e840..53c98d4 100644 --- a/examples/adt7410_operation_mode.py +++ b/examples/adt7410_operation_mode.py @@ -3,8 +3,9 @@ # SPDX-License-Identifier: MIT import time -import board + import adt7410 +import board i2c = board.I2C() adt = adt7410.ADT7410(i2c) @@ -15,6 +16,6 @@ for operation_mode in adt7410.operation_mode_values: print("Current Operation mode setting: ", adt.operation_mode) for _ in range(10): - print("Temperature: {:.2f}C".format(adt.temperature)) + print(f"Temperature: {adt.temperature:.2f}C") time.sleep(0.5) adt.operation_mode = operation_mode diff --git a/examples/adt7410_resolution_mode.py b/examples/adt7410_resolution_mode.py index e3319cb..0d89f5c 100644 --- a/examples/adt7410_resolution_mode.py +++ b/examples/adt7410_resolution_mode.py @@ -3,8 +3,9 @@ # SPDX-License-Identifier: MIT import time -import board + import adt7410 +import board i2c = board.I2C() adt = adt7410.ADT7410(i2c) @@ -16,6 +17,6 @@ print("Current Resolution mode setting: ", adt.resolution_mode) for _ in range(10): temp = adt.temperature - print("Temperature :{:.2f}C".format(temp)) + print(f"Temperature :{temp:.2f}C") time.sleep(0.5) adt.resolution_mode = resolution_mode diff --git a/examples/adt7410_simpletest.py b/examples/adt7410_simpletest.py index 544ada5..f7acd22 100644 --- a/examples/adt7410_simpletest.py +++ b/examples/adt7410_simpletest.py @@ -2,7 +2,9 @@ # SPDX-License-Identifier: MIT import time + import board + import adafruit_adt7410 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/adt7410_temp_limits.py b/examples/adt7410_temp_limits.py index 2524563..004d819 100644 --- a/examples/adt7410_temp_limits.py +++ b/examples/adt7410_temp_limits.py @@ -2,8 +2,9 @@ # SPDX-License-Identifier: MIT import time -import board + import adt7410 +import board i2c = board.I2C() # uses board.SCL and board.SDA adt = adt7410.ADT7410(i2c) @@ -13,14 +14,14 @@ adt.critical_temperature = 35 adt.hysteresis_temperature = 2 -print("High limit: {}C".format(adt.high_temperature)) -print("Low limit: {}C".format(adt.low_temperature)) -print("Critical limit: {}C".format(adt.critical_temperature)) +print(f"High limit: {adt.high_temperature}C") +print(f"Low limit: {adt.low_temperature}C") +print(f"Critical limit: {adt.critical_temperature}C") adt.comparator_mode = adt7410.COMP_ENABLED while True: - print("Temperature: {:.2f}C".format(adt.temperature)) + print(f"Temperature: {adt.temperature:.2f}C") alert_status = adt.alert_status if alert_status.high_alert: print("Temperature above high set limit!") diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..36332ff --- /dev/null +++ b/ruff.toml @@ -0,0 +1,105 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions +] + +[format] +line-ending = "lf"