├── .gitattributes ├── .github ├── PULL_REQUEST_TEMPLATE │ └── adafruit_circuitpython_pr.md └── workflows │ ├── build.yml │ ├── failure-help-text.yml │ ├── release_gh.yml │ └── release_pypi.yml ├── .gitignore ├── .pre-commit-config.yaml ├── .readthedocs.yaml ├── CODE_OF_CONDUCT.md ├── LICENSE ├── LICENSES ├── CC-BY-4.0.txt ├── MIT.txt └── Unlicense.txt ├── README.rst ├── README.rst.license ├── adafruit_vl6180x.py ├── docs ├── _static │ ├── favicon.ico │ └── favicon.ico.license ├── api.rst ├── api.rst.license ├── conf.py ├── examples.rst ├── examples.rst.license ├── index.rst ├── index.rst.license └── requirements.txt ├── examples ├── vl6180x_calibrationtest.py ├── vl6180x_continuoustest.py ├── vl6180x_displayio_simpletest.py ├── vl6180x_historytest.py ├── vl6180x_performancetest.py └── vl6180x_simpletest.py ├── optional_requirements.txt ├── pyproject.toml ├── requirements.txt └── ruff.toml /.gitattributes: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | .py text eol=lf 6 | .rst text eol=lf 7 | .txt text eol=lf 8 | .yaml text eol=lf 9 | .toml text eol=lf 10 | .license text eol=lf 11 | .md text eol=lf 12 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | Thank you for contributing! Before you submit a pull request, please read the following. 6 | 7 | Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html 8 | 9 | If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs 10 | 11 | Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code 12 | 13 | Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. 14 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | name: Build CI 6 | 7 | on: [pull_request, push] 8 | 9 | jobs: 10 | test: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Run Build CI workflow 14 | uses: adafruit/workflows-circuitpython-libs/build@main 15 | -------------------------------------------------------------------------------- /.github/workflows/failure-help-text.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | name: Failure help text 6 | 7 | on: 8 | workflow_run: 9 | workflows: ["Build CI"] 10 | types: 11 | - completed 12 | 13 | jobs: 14 | post-help: 15 | runs-on: ubuntu-latest 16 | if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} 17 | steps: 18 | - name: Post comment to help 19 | uses: adafruit/circuitpython-action-library-ci-failed@v1 20 | -------------------------------------------------------------------------------- /.github/workflows/release_gh.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | name: GitHub Release Actions 6 | 7 | on: 8 | release: 9 | types: [published] 10 | 11 | jobs: 12 | upload-release-assets: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Run GitHub Release CI workflow 16 | uses: adafruit/workflows-circuitpython-libs/release-gh@main 17 | with: 18 | github-token: ${{ secrets.GITHUB_TOKEN }} 19 | upload-url: ${{ github.event.release.upload_url }} 20 | -------------------------------------------------------------------------------- /.github/workflows/release_pypi.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | name: PyPI Release Actions 6 | 7 | on: 8 | release: 9 | types: [published] 10 | 11 | jobs: 12 | upload-release-assets: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Run PyPI Release CI workflow 16 | uses: adafruit/workflows-circuitpython-libs/release-pypi@main 17 | with: 18 | pypi-username: ${{ secrets.pypi_username }} 19 | pypi-password: ${{ secrets.pypi_password }} 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | # Do not include files and directories created by your personal work environment, such as the IDE 6 | # you use, except for those already listed here. Pull requests including changes to this file will 7 | # not be accepted. 8 | 9 | # This .gitignore file contains rules for files generated by working with CircuitPython libraries, 10 | # including building Sphinx, testing with pip, and creating a virual environment, as well as the 11 | # MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. 12 | 13 | # If you find that there are files being generated on your machine that should not be included in 14 | # your git commit, you should create a .gitignore_global file on your computer to include the 15 | # files created by your personal setup. To do so, follow the two steps below. 16 | 17 | # First, create a file called .gitignore_global somewhere convenient for you, and add rules for 18 | # the files you want to exclude from git commits. 19 | 20 | # Second, configure Git to use the exclude file for all Git repositories by running the 21 | # following via commandline, replacing "path/to/your/" with the actual path to your newly created 22 | # .gitignore_global file: 23 | # git config --global core.excludesfile path/to/your/.gitignore_global 24 | 25 | # CircuitPython-specific files 26 | *.mpy 27 | 28 | # Python-specific files 29 | __pycache__ 30 | *.pyc 31 | 32 | # Sphinx build-specific files 33 | _build 34 | 35 | # This file results from running `pip -e install .` in a local repository 36 | *.egg-info 37 | 38 | # Virtual environment-specific files 39 | .env 40 | .venv 41 | 42 | # MacOS-specific files 43 | *.DS_Store 44 | 45 | # IDE-specific files 46 | .idea 47 | .vscode 48 | *~ 49 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | repos: 6 | - repo: https://github.com/pre-commit/pre-commit-hooks 7 | rev: v4.5.0 8 | hooks: 9 | - id: check-yaml 10 | - id: end-of-file-fixer 11 | - id: trailing-whitespace 12 | - repo: https://github.com/astral-sh/ruff-pre-commit 13 | rev: v0.3.4 14 | hooks: 15 | - id: ruff-format 16 | - id: ruff 17 | args: ["--fix"] 18 | - repo: https://github.com/fsfe/reuse-tool 19 | rev: v3.0.1 20 | hooks: 21 | - id: reuse 22 | -------------------------------------------------------------------------------- /.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | # Read the Docs configuration file 6 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details 7 | 8 | # Required 9 | version: 2 10 | 11 | sphinx: 12 | configuration: docs/conf.py 13 | 14 | build: 15 | os: ubuntu-20.04 16 | tools: 17 | python: "3" 18 | 19 | python: 20 | install: 21 | - requirements: docs/requirements.txt 22 | - requirements: requirements.txt 23 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | 6 | 7 | # Adafruit Community Code of Conduct 8 | 9 | ## Our Pledge 10 | 11 | In the interest of fostering an open and welcoming environment, we as 12 | contributors and leaders pledge to making participation in our project and 13 | our community a harassment-free experience for everyone, regardless of age, body 14 | size, disability, ethnicity, gender identity and expression, level or type of 15 | experience, education, socio-economic status, nationality, personal appearance, 16 | race, religion, or sexual identity and orientation. 17 | 18 | ## Our Standards 19 | 20 | We are committed to providing a friendly, safe and welcoming environment for 21 | all. 22 | 23 | Examples of behavior that contributes to creating a positive environment 24 | include: 25 | 26 | * Be kind and courteous to others 27 | * Using welcoming and inclusive language 28 | * Being respectful of differing viewpoints and experiences 29 | * Collaborating with other community members 30 | * Gracefully accepting constructive criticism 31 | * Focusing on what is best for the community 32 | * Showing empathy towards other community members 33 | 34 | Examples of unacceptable behavior by participants include: 35 | 36 | * The use of sexualized language or imagery and sexual attention or advances 37 | * The use of inappropriate images, including in a community member's avatar 38 | * The use of inappropriate language, including in a community member's nickname 39 | * Any spamming, flaming, baiting or other attention-stealing behavior 40 | * Excessive or unwelcome helping; answering outside the scope of the question 41 | asked 42 | * Trolling, insulting/derogatory comments, and personal or political attacks 43 | * Promoting or spreading disinformation, lies, or conspiracy theories against 44 | a person, group, organisation, project, or community 45 | * Public or private harassment 46 | * Publishing others' private information, such as a physical or electronic 47 | address, without explicit permission 48 | * Other conduct which could reasonably be considered inappropriate 49 | 50 | The goal of the standards and moderation guidelines outlined here is to build 51 | and maintain a respectful community. We ask that you don’t just aim to be 52 | "technically unimpeachable", but rather try to be your best self. 53 | 54 | We value many things beyond technical expertise, including collaboration and 55 | supporting others within our community. Providing a positive experience for 56 | other community members can have a much more significant impact than simply 57 | providing the correct answer. 58 | 59 | ## Our Responsibilities 60 | 61 | Project leaders are responsible for clarifying the standards of acceptable 62 | behavior and are expected to take appropriate and fair corrective action in 63 | response to any instances of unacceptable behavior. 64 | 65 | Project leaders have the right and responsibility to remove, edit, or 66 | reject messages, comments, commits, code, issues, and other contributions 67 | that are not aligned to this Code of Conduct, or to ban temporarily or 68 | permanently any community member for other behaviors that they deem 69 | inappropriate, threatening, offensive, or harmful. 70 | 71 | ## Moderation 72 | 73 | Instances of behaviors that violate the Adafruit Community Code of Conduct 74 | may be reported by any member of the community. Community members are 75 | encouraged to report these situations, including situations they witness 76 | involving other community members. 77 | 78 | You may report in the following ways: 79 | 80 | In any situation, you may send an email to . 81 | 82 | On the Adafruit Discord, you may send an open message from any channel 83 | to all Community Moderators by tagging @community moderators. You may 84 | also send an open message from any channel, or a direct message to 85 | @kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, 86 | @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. 87 | 88 | Email and direct message reports will be kept confidential. 89 | 90 | In situations on Discord where the issue is particularly egregious, possibly 91 | illegal, requires immediate action, or violates the Discord terms of service, 92 | you should also report the message directly to Discord. 93 | 94 | These are the steps for upholding our community’s standards of conduct. 95 | 96 | 1. Any member of the community may report any situation that violates the 97 | Adafruit Community Code of Conduct. All reports will be reviewed and 98 | investigated. 99 | 2. If the behavior is an egregious violation, the community member who 100 | committed the violation may be banned immediately, without warning. 101 | 3. Otherwise, moderators will first respond to such behavior with a warning. 102 | 4. Moderators follow a soft "three strikes" policy - the community member may 103 | be given another chance, if they are receptive to the warning and change their 104 | behavior. 105 | 5. If the community member is unreceptive or unreasonable when warned by a 106 | moderator, or the warning goes unheeded, they may be banned for a first or 107 | second offense. Repeated offenses will result in the community member being 108 | banned. 109 | 110 | ## Scope 111 | 112 | This Code of Conduct and the enforcement policies listed above apply to all 113 | Adafruit Community venues. This includes but is not limited to any community 114 | spaces (both public and private), the entire Adafruit Discord server, and 115 | Adafruit GitHub repositories. Examples of Adafruit Community spaces include 116 | but are not limited to meet-ups, audio chats on the Adafruit Discord, or 117 | interaction at a conference. 118 | 119 | This Code of Conduct applies both within project spaces and in public spaces 120 | when an individual is representing the project or its community. As a community 121 | member, you are representing our community, and are expected to behave 122 | accordingly. 123 | 124 | ## Attribution 125 | 126 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 127 | version 1.4, available at 128 | , 129 | and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). 130 | 131 | For other projects adopting the Adafruit Community Code of 132 | Conduct, please contact the maintainers of those projects for enforcement. 133 | If you wish to use this code of conduct for your own project, consider 134 | explicitly mentioning your moderation policy or making a copy with your 135 | own moderation policy so as to avoid confusion. 136 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2017 Tony DiCola for Adafruit Industries 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /LICENSES/CC-BY-4.0.txt: -------------------------------------------------------------------------------- 1 | Creative Commons Attribution 4.0 International Creative Commons Corporation 2 | ("Creative Commons") is not a law firm and does not provide legal services 3 | or legal advice. Distribution of Creative Commons public licenses does not 4 | create a lawyer-client or other relationship. Creative Commons makes its licenses 5 | and related information available on an "as-is" basis. Creative Commons gives 6 | no warranties regarding its licenses, any material licensed under their terms 7 | and conditions, or any related information. Creative Commons disclaims all 8 | liability for damages resulting from their use to the fullest extent possible. 9 | 10 | Using Creative Commons Public Licenses 11 | 12 | Creative Commons public licenses provide a standard set of terms and conditions 13 | that creators and other rights holders may use to share original works of 14 | authorship and other material subject to copyright and certain other rights 15 | specified in the public license below. The following considerations are for 16 | informational purposes only, are not exhaustive, and do not form part of our 17 | licenses. 18 | 19 | Considerations for licensors: Our public licenses are intended for use by 20 | those authorized to give the public permission to use material in ways otherwise 21 | restricted by copyright and certain other rights. Our licenses are irrevocable. 22 | Licensors should read and understand the terms and conditions of the license 23 | they choose before applying it. Licensors should also secure all rights necessary 24 | before applying our licenses so that the public can reuse the material as 25 | expected. Licensors should clearly mark any material not subject to the license. 26 | This includes other CC-licensed material, or material used under an exception 27 | or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors 28 | 29 | Considerations for the public: By using one of our public licenses, a licensor 30 | grants the public permission to use the licensed material under specified 31 | terms and conditions. If the licensor's permission is not necessary for any 32 | reason–for example, because of any applicable exception or limitation to copyright–then 33 | that use is not regulated by the license. Our licenses grant only permissions 34 | under copyright and certain other rights that a licensor has authority to 35 | grant. Use of the licensed material may still be restricted for other reasons, 36 | including because others have copyright or other rights in the material. A 37 | licensor may make special requests, such as asking that all changes be marked 38 | or described. Although not required by our licenses, you are encouraged to 39 | respect those requests where reasonable. More considerations for the public 40 | : wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution 41 | 4.0 International Public License 42 | 43 | By exercising the Licensed Rights (defined below), You accept and agree to 44 | be bound by the terms and conditions of this Creative Commons Attribution 45 | 4.0 International Public License ("Public License"). To the extent this Public 46 | License may be interpreted as a contract, You are granted the Licensed Rights 47 | in consideration of Your acceptance of these terms and conditions, and the 48 | Licensor grants You such rights in consideration of benefits the Licensor 49 | receives from making the Licensed Material available under these terms and 50 | conditions. 51 | 52 | Section 1 – Definitions. 53 | 54 | a. Adapted Material means material subject to Copyright and Similar Rights 55 | that is derived from or based upon the Licensed Material and in which the 56 | Licensed Material is translated, altered, arranged, transformed, or otherwise 57 | modified in a manner requiring permission under the Copyright and Similar 58 | Rights held by the Licensor. For purposes of this Public License, where the 59 | Licensed Material is a musical work, performance, or sound recording, Adapted 60 | Material is always produced where the Licensed Material is synched in timed 61 | relation with a moving image. 62 | 63 | b. Adapter's License means the license You apply to Your Copyright and Similar 64 | Rights in Your contributions to Adapted Material in accordance with the terms 65 | and conditions of this Public License. 66 | 67 | c. Copyright and Similar Rights means copyright and/or similar rights closely 68 | related to copyright including, without limitation, performance, broadcast, 69 | sound recording, and Sui Generis Database Rights, without regard to how the 70 | rights are labeled or categorized. For purposes of this Public License, the 71 | rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. 72 | 73 | d. Effective Technological Measures means those measures that, in the absence 74 | of proper authority, may not be circumvented under laws fulfilling obligations 75 | under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, 76 | and/or similar international agreements. 77 | 78 | e. Exceptions and Limitations means fair use, fair dealing, and/or any other 79 | exception or limitation to Copyright and Similar Rights that applies to Your 80 | use of the Licensed Material. 81 | 82 | f. Licensed Material means the artistic or literary work, database, or other 83 | material to which the Licensor applied this Public License. 84 | 85 | g. Licensed Rights means the rights granted to You subject to the terms and 86 | conditions of this Public License, which are limited to all Copyright and 87 | Similar Rights that apply to Your use of the Licensed Material and that the 88 | Licensor has authority to license. 89 | 90 | h. Licensor means the individual(s) or entity(ies) granting rights under this 91 | Public License. 92 | 93 | i. Share means to provide material to the public by any means or process that 94 | requires permission under the Licensed Rights, such as reproduction, public 95 | display, public performance, distribution, dissemination, communication, or 96 | importation, and to make material available to the public including in ways 97 | that members of the public may access the material from a place and at a time 98 | individually chosen by them. 99 | 100 | j. Sui Generis Database Rights means rights other than copyright resulting 101 | from Directive 96/9/EC of the European Parliament and of the Council of 11 102 | March 1996 on the legal protection of databases, as amended and/or succeeded, 103 | as well as other essentially equivalent rights anywhere in the world. 104 | 105 | k. You means the individual or entity exercising the Licensed Rights under 106 | this Public License. Your has a corresponding meaning. 107 | 108 | Section 2 – Scope. 109 | 110 | a. License grant. 111 | 112 | 1. Subject to the terms and conditions of this Public License, the Licensor 113 | hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, 114 | irrevocable license to exercise the Licensed Rights in the Licensed Material 115 | to: 116 | 117 | A. reproduce and Share the Licensed Material, in whole or in part; and 118 | 119 | B. produce, reproduce, and Share Adapted Material. 120 | 121 | 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions 122 | and Limitations apply to Your use, this Public License does not apply, and 123 | You do not need to comply with its terms and conditions. 124 | 125 | 3. Term. The term of this Public License is specified in Section 6(a). 126 | 127 | 4. Media and formats; technical modifications allowed. The Licensor authorizes 128 | You to exercise the Licensed Rights in all media and formats whether now known 129 | or hereafter created, and to make technical modifications necessary to do 130 | so. The Licensor waives and/or agrees not to assert any right or authority 131 | to forbid You from making technical modifications necessary to exercise the 132 | Licensed Rights, including technical modifications necessary to circumvent 133 | Effective Technological Measures. For purposes of this Public License, simply 134 | making modifications authorized by this Section 2(a)(4) never produces Adapted 135 | Material. 136 | 137 | 5. Downstream recipients. 138 | 139 | A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed 140 | Material automatically receives an offer from the Licensor to exercise the 141 | Licensed Rights under the terms and conditions of this Public License. 142 | 143 | B. No downstream restrictions. You may not offer or impose any additional 144 | or different terms or conditions on, or apply any Effective Technological 145 | Measures to, the Licensed Material if doing so restricts exercise of the Licensed 146 | Rights by any recipient of the Licensed Material. 147 | 148 | 6. No endorsement. Nothing in this Public License constitutes or may be construed 149 | as permission to assert or imply that You are, or that Your use of the Licensed 150 | Material is, connected with, or sponsored, endorsed, or granted official status 151 | by, the Licensor or others designated to receive attribution as provided in 152 | Section 3(a)(1)(A)(i). 153 | 154 | b. Other rights. 155 | 156 | 1. Moral rights, such as the right of integrity, are not licensed under this 157 | Public License, nor are publicity, privacy, and/or other similar personality 158 | rights; however, to the extent possible, the Licensor waives and/or agrees 159 | not to assert any such rights held by the Licensor to the limited extent necessary 160 | to allow You to exercise the Licensed Rights, but not otherwise. 161 | 162 | 2. Patent and trademark rights are not licensed under this Public License. 163 | 164 | 3. To the extent possible, the Licensor waives any right to collect royalties 165 | from You for the exercise of the Licensed Rights, whether directly or through 166 | a collecting society under any voluntary or waivable statutory or compulsory 167 | licensing scheme. In all other cases the Licensor expressly reserves any right 168 | to collect such royalties. 169 | 170 | Section 3 – License Conditions. 171 | 172 | Your exercise of the Licensed Rights is expressly made subject to the following 173 | conditions. 174 | 175 | a. Attribution. 176 | 177 | 1. If You Share the Licensed Material (including in modified form), You must: 178 | 179 | A. retain the following if it is supplied by the Licensor with the Licensed 180 | Material: 181 | 182 | i. identification of the creator(s) of the Licensed Material and any others 183 | designated to receive attribution, in any reasonable manner requested by the 184 | Licensor (including by pseudonym if designated); 185 | 186 | ii. a copyright notice; 187 | 188 | iii. a notice that refers to this Public License; 189 | 190 | iv. a notice that refers to the disclaimer of warranties; 191 | 192 | v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; 193 | 194 | B. indicate if You modified the Licensed Material and retain an indication 195 | of any previous modifications; and 196 | 197 | C. indicate the Licensed Material is licensed under this Public License, and 198 | include the text of, or the URI or hyperlink to, this Public License. 199 | 200 | 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner 201 | based on the medium, means, and context in which You Share the Licensed Material. 202 | For example, it may be reasonable to satisfy the conditions by providing a 203 | URI or hyperlink to a resource that includes the required information. 204 | 205 | 3. If requested by the Licensor, You must remove any of the information required 206 | by Section 3(a)(1)(A) to the extent reasonably practicable. 207 | 208 | 4. If You Share Adapted Material You produce, the Adapter's License You apply 209 | must not prevent recipients of the Adapted Material from complying with this 210 | Public License. 211 | 212 | Section 4 – Sui Generis Database Rights. 213 | 214 | Where the Licensed Rights include Sui Generis Database Rights that apply to 215 | Your use of the Licensed Material: 216 | 217 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, 218 | reuse, reproduce, and Share all or a substantial portion of the contents of 219 | the database; 220 | 221 | b. if You include all or a substantial portion of the database contents in 222 | a database in which You have Sui Generis Database Rights, then the database 223 | in which You have Sui Generis Database Rights (but not its individual contents) 224 | is Adapted Material; and 225 | 226 | c. You must comply with the conditions in Section 3(a) if You Share all or 227 | a substantial portion of the contents of the database. 228 | 229 | For the avoidance of doubt, this Section 4 supplements and does not replace 230 | Your obligations under this Public License where the Licensed Rights include 231 | other Copyright and Similar Rights. 232 | 233 | Section 5 – Disclaimer of Warranties and Limitation of Liability. 234 | 235 | a. Unless otherwise separately undertaken by the Licensor, to the extent possible, 236 | the Licensor offers the Licensed Material as-is and as-available, and makes 237 | no representations or warranties of any kind concerning the Licensed Material, 238 | whether express, implied, statutory, or other. This includes, without limitation, 239 | warranties of title, merchantability, fitness for a particular purpose, non-infringement, 240 | absence of latent or other defects, accuracy, or the presence or absence of 241 | errors, whether or not known or discoverable. Where disclaimers of warranties 242 | are not allowed in full or in part, this disclaimer may not apply to You. 243 | 244 | b. To the extent possible, in no event will the Licensor be liable to You 245 | on any legal theory (including, without limitation, negligence) or otherwise 246 | for any direct, special, indirect, incidental, consequential, punitive, exemplary, 247 | or other losses, costs, expenses, or damages arising out of this Public License 248 | or use of the Licensed Material, even if the Licensor has been advised of 249 | the possibility of such losses, costs, expenses, or damages. Where a limitation 250 | of liability is not allowed in full or in part, this limitation may not apply 251 | to You. 252 | 253 | c. The disclaimer of warranties and limitation of liability provided above 254 | shall be interpreted in a manner that, to the extent possible, most closely 255 | approximates an absolute disclaimer and waiver of all liability. 256 | 257 | Section 6 – Term and Termination. 258 | 259 | a. This Public License applies for the term of the Copyright and Similar Rights 260 | licensed here. However, if You fail to comply with this Public License, then 261 | Your rights under this Public License terminate automatically. 262 | 263 | b. Where Your right to use the Licensed Material has terminated under Section 264 | 6(a), it reinstates: 265 | 266 | 1. automatically as of the date the violation is cured, provided it is cured 267 | within 30 days of Your discovery of the violation; or 268 | 269 | 2. upon express reinstatement by the Licensor. 270 | 271 | c. For the avoidance of doubt, this Section 6(b) does not affect any right 272 | the Licensor may have to seek remedies for Your violations of this Public 273 | License. 274 | 275 | d. For the avoidance of doubt, the Licensor may also offer the Licensed Material 276 | under separate terms or conditions or stop distributing the Licensed Material 277 | at any time; however, doing so will not terminate this Public License. 278 | 279 | e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. 280 | 281 | Section 7 – Other Terms and Conditions. 282 | 283 | a. The Licensor shall not be bound by any additional or different terms or 284 | conditions communicated by You unless expressly agreed. 285 | 286 | b. Any arrangements, understandings, or agreements regarding the Licensed 287 | Material not stated herein are separate from and independent of the terms 288 | and conditions of this Public License. 289 | 290 | Section 8 – Interpretation. 291 | 292 | a. For the avoidance of doubt, this Public License does not, and shall not 293 | be interpreted to, reduce, limit, restrict, or impose conditions on any use 294 | of the Licensed Material that could lawfully be made without permission under 295 | this Public License. 296 | 297 | b. To the extent possible, if any provision of this Public License is deemed 298 | unenforceable, it shall be automatically reformed to the minimum extent necessary 299 | to make it enforceable. If the provision cannot be reformed, it shall be severed 300 | from this Public License without affecting the enforceability of the remaining 301 | terms and conditions. 302 | 303 | c. No term or condition of this Public License will be waived and no failure 304 | to comply consented to unless expressly agreed to by the Licensor. 305 | 306 | d. Nothing in this Public License constitutes or may be interpreted as a limitation 307 | upon, or waiver of, any privileges and immunities that apply to the Licensor 308 | or You, including from the legal processes of any jurisdiction or authority. 309 | 310 | Creative Commons is not a party to its public licenses. Notwithstanding, Creative 311 | Commons may elect to apply one of its public licenses to material it publishes 312 | and in those instances will be considered the "Licensor." The text of the 313 | Creative Commons public licenses is dedicated to the public domain under the 314 | CC0 Public Domain Dedication. Except for the limited purpose of indicating 315 | that material is shared under a Creative Commons public license or as otherwise 316 | permitted by the Creative Commons policies published at creativecommons.org/policies, 317 | Creative Commons does not authorize the use of the trademark "Creative Commons" 318 | or any other trademark or logo of Creative Commons without its prior written 319 | consent including, without limitation, in connection with any unauthorized 320 | modifications to any of its public licenses or any other arrangements, understandings, 321 | or agreements concerning use of licensed material. For the avoidance of doubt, 322 | this paragraph does not form part of the public licenses. 323 | 324 | Creative Commons may be contacted at creativecommons.org. 325 | -------------------------------------------------------------------------------- /LICENSES/MIT.txt: -------------------------------------------------------------------------------- 1 | MIT License Copyright (c) 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is furnished 8 | to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice (including the next 11 | paragraph) shall be included in all copies or substantial portions of the 12 | Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 16 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 17 | OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 18 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF 19 | OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 20 | -------------------------------------------------------------------------------- /LICENSES/Unlicense.txt: -------------------------------------------------------------------------------- 1 | This is free and unencumbered software released into the public domain. 2 | 3 | Anyone is free to copy, modify, publish, use, compile, sell, or distribute 4 | this software, either in source code form or as a compiled binary, for any 5 | purpose, commercial or non-commercial, and by any means. 6 | 7 | In jurisdictions that recognize copyright laws, the author or authors of this 8 | software dedicate any and all copyright interest in the software to the public 9 | domain. We make this dedication for the benefit of the public at large and 10 | to the detriment of our heirs and successors. We intend this dedication to 11 | be an overt act of relinquishment in perpetuity of all present and future 12 | rights to this software under copyright law. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 16 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 17 | BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 18 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH 19 | THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, 20 | please refer to 21 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | 2 | Introduction 3 | ============ 4 | 5 | .. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl6180x/badge/?version=latest 6 | :target: https://docs.circuitpython.org/projects/vl6180x/en/latest/ 7 | :alt: Documentation Status 8 | 9 | .. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg 10 | :target: https://adafru.it/discord 11 | :alt: Discord 12 | 13 | .. image:: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/workflows/Build%20CI/badge.svg 14 | :target: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/actions/ 15 | :alt: Build Status 16 | 17 | .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json 18 | :target: https://github.com/astral-sh/ruff 19 | :alt: Code Style: Ruff 20 | 21 | CircuitPython module for the VL6180X distance sensor. See 22 | examples/vl6180x_simpletest.py for a demo of the usage. 23 | 24 | Dependencies 25 | ============= 26 | This driver depends on: 27 | 28 | * `Adafruit CircuitPython `_ 29 | * `Bus Device `_ 30 | 31 | Please ensure all dependencies are available on the CircuitPython filesystem. 32 | This is easily achieved by downloading 33 | `the Adafruit library and driver bundle `_. 34 | 35 | Installing from PyPI 36 | ==================== 37 | 38 | On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from 39 | PyPI `_. To install for current user: 40 | 41 | .. code-block:: shell 42 | 43 | pip3 install adafruit-circuitpython-vl6180x 44 | 45 | To install system-wide (this may be required in some cases): 46 | 47 | .. code-block:: shell 48 | 49 | sudo pip3 install adafruit-circuitpython-vl6180x 50 | 51 | To install in a virtual environment in your current project: 52 | 53 | .. code-block:: shell 54 | 55 | mkdir project-name && cd project-name 56 | python3 -m venv .venv 57 | source .venv/bin/activate 58 | pip3 install adafruit-circuitpython-vl6180x 59 | 60 | Usage Example 61 | ============= 62 | 63 | See examples/vl6180x_simpletest.py for a demo of the usage. 64 | 65 | Documentation 66 | ============= 67 | 68 | API documentation for this library can be found on `Read the Docs `_. 69 | 70 | For information on building library documentation, please check out `this guide `_. 71 | 72 | Contributing 73 | ============ 74 | 75 | Contributions are welcome! Please read our `Code of Conduct 76 | `_ 77 | before contributing to help this project stay welcoming. 78 | -------------------------------------------------------------------------------- /README.rst.license: -------------------------------------------------------------------------------- 1 | SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | 3 | SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /adafruit_vl6180x.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Tony DiCola for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | """ 6 | `adafruit_vl6180x` 7 | ==================================================== 8 | 9 | CircuitPython module for the VL6180X distance sensor. See 10 | examples/simpletest.py for a demo of the usage. 11 | 12 | * Author(s): Tony DiCola, Jonas Schatz 13 | 14 | Implementation Notes 15 | -------------------- 16 | 17 | **Hardware:** 18 | 19 | * Adafruit `VL6180X Time of Flight Distance Ranging Sensor (VL6180) 20 | `_ (Product ID: 3316) 21 | 22 | **Software and Dependencies:** 23 | 24 | * Adafruit CircuitPython firmware for the ESP8622 and M0-based boards: 25 | https://github.com/adafruit/circuitpython/releases 26 | * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice 27 | """ 28 | 29 | import struct 30 | import time 31 | 32 | from adafruit_bus_device import i2c_device 33 | from micropython import const 34 | 35 | try: 36 | from typing import List, Optional 37 | 38 | from busio import I2C 39 | except ImportError: 40 | pass 41 | 42 | 43 | __version__ = "0.0.0+auto.0" 44 | __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X.git" 45 | 46 | # Registers 47 | _VL6180X_REG_IDENTIFICATION_MODEL_ID = const(0x000) 48 | 49 | _VL6180X_REG_SYSTEM_HISTORY_CTRL = const(0x012) 50 | _VL6180X_REG_SYSTEM_INTERRUPT_CONFIG = const(0x014) 51 | _VL6180X_REG_SYSTEM_INTERRUPT_CLEAR = const(0x015) 52 | _VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET = const(0x016) 53 | 54 | _VL6180X_REG_SYSRANGE_START = const(0x018) 55 | _VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD = const(0x01B) 56 | _VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET = const(0x024) 57 | 58 | _VL6180X_REG_SYSALS_START = const(0x038) 59 | _VL6180X_REG_SYSALS_ANALOGUE_GAIN = const(0x03F) 60 | _VL6180X_REG_SYSALS_INTEGRATION_PERIOD_HI = const(0x040) 61 | _VL6180X_REG_SYSALS_INTEGRATION_PERIOD_LO = const(0x041) 62 | 63 | _VL6180X_REG_RESULT_RANGE_STATUS = const(0x04D) 64 | _VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO = const(0x04F) 65 | _VL6180X_REG_RESULT_ALS_VAL = const(0x050) 66 | _VL6180X_REG_RESULT_HISTORY_BUFFER_0 = const(0x052) 67 | _VL6180X_REG_RESULT_RANGE_VAL = const(0x062) 68 | 69 | # Internal constants: 70 | _VL6180X_DEFAULT_I2C_ADDR = const(0x29) 71 | 72 | # User-facing constants: 73 | ALS_GAIN_1 = const(0x06) 74 | ALS_GAIN_1_25 = const(0x05) 75 | ALS_GAIN_1_67 = const(0x04) 76 | ALS_GAIN_2_5 = const(0x03) 77 | ALS_GAIN_5 = const(0x02) 78 | ALS_GAIN_10 = const(0x01) 79 | ALS_GAIN_20 = const(0x00) 80 | ALS_GAIN_40 = const(0x07) 81 | 82 | ERROR_NONE = const(0) 83 | ERROR_SYSERR_1 = const(1) 84 | ERROR_SYSERR_5 = const(5) 85 | ERROR_ECEFAIL = const(6) 86 | ERROR_NOCONVERGE = const(7) 87 | ERROR_RANGEIGNORE = const(8) 88 | ERROR_SNR = const(11) 89 | ERROR_RAWUFLOW = const(12) 90 | ERROR_RAWOFLOW = const(13) 91 | ERROR_RANGEUFLOW = const(14) 92 | ERROR_RANGEOFLOW = const(15) 93 | 94 | 95 | class VL6180X: 96 | """Create an instance of the VL6180X distance sensor. You must pass in 97 | the following parameters: 98 | 99 | :param ~I2C i2c: An instance of the I2C bus connected to the sensor. 100 | 101 | Optionally you can specify: 102 | 103 | :param int address: The I2C address of the sensor. If not specified the sensor's 104 | default value will be assumed. 105 | :param int offset: The offset to be applied to measurements, in mm 106 | """ 107 | 108 | def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR, offset: int = 0) -> None: 109 | self._device = i2c_device.I2CDevice(i2c, address) 110 | if self._read_8(_VL6180X_REG_IDENTIFICATION_MODEL_ID) != 0xB4: 111 | raise RuntimeError("Could not find VL6180X, is it connected and powered?") 112 | self._load_settings() 113 | self._write_8(_VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET, 0x00) 114 | self.offset = offset 115 | 116 | # Reset a sensor that crashed while in continuous mode 117 | if self.continuous_mode_enabled: 118 | self.stop_range_continuous() 119 | time.sleep(0.1) 120 | 121 | # Activate history buffer for range measurement 122 | self._write_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL, 0x01) 123 | 124 | @property 125 | def range(self) -> int: 126 | """Read the range of an object in front of sensor and return it in mm.""" 127 | if self.continuous_mode_enabled: 128 | return self._read_range_continuous() 129 | return self._read_range_single() 130 | 131 | @property 132 | def range_from_history(self) -> Optional[int]: 133 | """Read the latest range data from history 134 | To do so, you don't have to wait for a complete measurement.""" 135 | 136 | if not self.range_history_enabled: 137 | return None 138 | 139 | return self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0) 140 | 141 | @property 142 | def ranges_from_history(self) -> Optional[List[int]]: 143 | """Read the last 16 range measurements from history""" 144 | 145 | if not self.range_history_enabled: 146 | return None 147 | 148 | return [self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0 + age) for age in range(16)] 149 | 150 | @property 151 | def range_history_enabled(self) -> bool: 152 | """Checks if history buffer stores range data""" 153 | 154 | history_ctrl: int = self._read_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL) 155 | 156 | if history_ctrl & 0x0: 157 | print("History buffering not enabled") 158 | return False 159 | 160 | if (history_ctrl > 1) & 0x1: 161 | print("History buffer stores ALS data, not range") 162 | return False 163 | 164 | return True 165 | 166 | def start_range_continuous(self, period: int = 100) -> None: 167 | """Start continuous range mode 168 | 169 | :param int period: Time delay between measurements, in milliseconds; the value you 170 | will be floored to the nearest 10 milliseconds (setting to 157 ms sets it to 150 171 | ms). Range is 20 - 2550 ms. 172 | """ 173 | # Set range between measurements 174 | if not 20 <= period <= 2550: 175 | raise ValueError( 176 | "Delay must be in 10 millisecond increments between 20 and 2550 milliseconds" 177 | ) 178 | 179 | period_reg = (period // 10) - 1 180 | self._write_8(_VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD, period_reg) 181 | 182 | # Start continuous range measurement 183 | self._write_8(_VL6180X_REG_SYSRANGE_START, 0x03) 184 | 185 | def stop_range_continuous(self) -> None: 186 | """Stop continuous range mode. It is advised to wait for about 0.3s 187 | afterwards to avoid issues with the interrupt flags""" 188 | if self.continuous_mode_enabled: 189 | self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) 190 | 191 | @property 192 | def continuous_mode_enabled(self) -> bool: 193 | """Checks if continuous mode is enabled""" 194 | return self._read_8(_VL6180X_REG_SYSRANGE_START) > 1 & 0x1 195 | 196 | @property 197 | def offset(self) -> int: 198 | """Read and sets the manual offset for the sensor, in millimeters""" 199 | return self._offset 200 | 201 | @offset.setter 202 | def offset(self, offset: int) -> None: 203 | self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, struct.pack("b", offset)[0]) 204 | self._offset = offset 205 | 206 | def _read_range_single(self) -> int: 207 | """Read the range when in single-shot mode""" 208 | while not self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) & 0x01: 209 | pass 210 | self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) 211 | return self._read_range_continuous() 212 | 213 | def _read_range_continuous(self) -> int: 214 | """Read the range when in continuous mode""" 215 | 216 | # Poll until bit 2 is set 217 | while not self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) & 0x04: 218 | pass 219 | 220 | # read range in mm 221 | range_ = self._read_8(_VL6180X_REG_RESULT_RANGE_VAL) 222 | 223 | # clear interrupt 224 | self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) 225 | 226 | return range_ 227 | 228 | def read_lux(self, gain: int) -> float: 229 | """Read the lux (light value) from the sensor and return it. Must 230 | specify the gain value to use for the lux reading: 231 | 232 | ================= ===== 233 | Setting Value 234 | ================= ===== 235 | ``ALS_GAIN_1`` 1x 236 | ``ALS_GAIN_1_25`` 1.25x 237 | ``ALS_GAIN_1_67`` 1.67x 238 | ``ALS_GAIN_2_5`` 2.5x 239 | ``ALS_GAIN_5`` 5x 240 | ``ALS_GAIN_10`` 10x 241 | ``ALS_GAIN_20`` 20x 242 | ``ALS_GAIN_40`` 40x 243 | ================= ===== 244 | 245 | :param int gain: The gain value to use 246 | 247 | """ 248 | reg = self._read_8(_VL6180X_REG_SYSTEM_INTERRUPT_CONFIG) 249 | reg &= ~0x38 250 | reg |= 0x4 << 3 # IRQ on ALS ready 251 | self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CONFIG, reg) 252 | # 100 ms integration period 253 | self._write_8(_VL6180X_REG_SYSALS_INTEGRATION_PERIOD_HI, 0) 254 | self._write_8(_VL6180X_REG_SYSALS_INTEGRATION_PERIOD_LO, 100) 255 | # analog gain 256 | gain = min(gain, ALS_GAIN_40) 257 | self._write_8(_VL6180X_REG_SYSALS_ANALOGUE_GAIN, 0x40 | gain) 258 | # start ALS 259 | self._write_8(_VL6180X_REG_SYSALS_START, 0x1) 260 | # Poll until "New Sample Ready threshold event" is set 261 | while ((self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) >> 3) & 0x7) != 4: 262 | pass 263 | # read lux! 264 | lux = self._read_16(_VL6180X_REG_RESULT_ALS_VAL) 265 | # clear interrupt 266 | self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) 267 | lux *= 0.32 # calibrated count/lux 268 | if gain == ALS_GAIN_1: 269 | pass 270 | elif gain == ALS_GAIN_1_25: 271 | lux /= 1.25 272 | elif gain == ALS_GAIN_1_67: 273 | lux /= 1.67 274 | elif gain == ALS_GAIN_2_5: 275 | lux /= 2.5 276 | elif gain == ALS_GAIN_5: 277 | lux /= 5 278 | elif gain == ALS_GAIN_10: 279 | lux /= 10 280 | elif gain == ALS_GAIN_20: 281 | lux /= 20 282 | elif gain == ALS_GAIN_40: 283 | lux /= 40 284 | lux *= 100 285 | lux /= 100 # integration time in ms 286 | return lux 287 | 288 | @property 289 | def range_status(self) -> int: 290 | """Retrieve the status/error from a previous range read. This will 291 | return a constant value such as: 292 | 293 | ===================== ============================== 294 | Error Description 295 | ===================== ============================== 296 | ``ERROR_NONE`` No error 297 | ``ERROR_SYSERR_1`` System error 1 (see datasheet) 298 | ``ERROR_SYSERR_5`` System error 5 (see datasheet) 299 | ``ERROR_ECEFAIL`` ECE failure 300 | ``ERROR_NOCONVERGE`` No convergence 301 | ``ERROR_RANGEIGNORE`` Outside range ignored 302 | ``ERROR_SNR`` Too much noise 303 | ``ERROR_RAWUFLOW`` Raw value underflow 304 | ``ERROR_RAWOFLOW`` Raw value overflow 305 | ``ERROR_RANGEUFLOW`` Range underflow 306 | ``ERROR_RANGEOFLOW`` Range overflow 307 | ===================== ============================== 308 | 309 | """ 310 | return self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) >> 4 311 | 312 | def _load_settings(self) -> None: 313 | # private settings from page 24 of app note 314 | self._write_8(0x0207, 0x01) 315 | self._write_8(0x0208, 0x01) 316 | self._write_8(0x0096, 0x00) 317 | self._write_8(0x0097, 0xFD) 318 | self._write_8(0x00E3, 0x00) 319 | self._write_8(0x00E4, 0x04) 320 | self._write_8(0x00E5, 0x02) 321 | self._write_8(0x00E6, 0x01) 322 | self._write_8(0x00E7, 0x03) 323 | self._write_8(0x00F5, 0x02) 324 | self._write_8(0x00D9, 0x05) 325 | self._write_8(0x00DB, 0xCE) 326 | self._write_8(0x00DC, 0x03) 327 | self._write_8(0x00DD, 0xF8) 328 | self._write_8(0x009F, 0x00) 329 | self._write_8(0x00A3, 0x3C) 330 | self._write_8(0x00B7, 0x00) 331 | self._write_8(0x00BB, 0x3C) 332 | self._write_8(0x00B2, 0x09) 333 | self._write_8(0x00CA, 0x09) 334 | self._write_8(0x0198, 0x01) 335 | self._write_8(0x01B0, 0x17) 336 | self._write_8(0x01AD, 0x00) 337 | self._write_8(0x00FF, 0x05) 338 | self._write_8(0x0100, 0x05) 339 | self._write_8(0x0199, 0x05) 340 | self._write_8(0x01A6, 0x1B) 341 | self._write_8(0x01AC, 0x3E) 342 | self._write_8(0x01A7, 0x1F) 343 | self._write_8(0x0030, 0x00) 344 | # Recommended : Public registers - See data sheet for more detail 345 | self._write_8(0x0011, 0x10) # Enables polling for 'New Sample ready' 346 | # when measurement completes 347 | self._write_8(0x010A, 0x30) # Set the averaging sample period 348 | # (compromise between lower noise and 349 | # increased execution time) 350 | self._write_8(0x003F, 0x46) # Sets the light and dark gain (upper 351 | # nibble). Dark gain should not be 352 | # changed. 353 | self._write_8(0x0031, 0xFF) # sets the # of range measurements after 354 | # which auto calibration of system is 355 | # performed 356 | self._write_8(0x0040, 0x63) # Set ALS integration time to 100ms 357 | self._write_8(0x002E, 0x01) # perform a single temperature calibration 358 | # of the ranging sensor 359 | 360 | # Optional: Public registers - See data sheet for more detail 361 | self._write_8(0x001B, 0x09) # Set default ranging inter-measurement 362 | # period to 100ms 363 | self._write_8(0x003E, 0x31) # Set default ALS inter-measurement period 364 | # to 500ms 365 | self._write_8(0x0014, 0x24) # Configures interrupt on 'New Sample 366 | # Ready threshold event' 367 | 368 | def _write_8(self, address: int, data: int) -> None: 369 | # Write 1 byte of data from the specified 16-bit register address. 370 | with self._device: 371 | self._device.write(bytes([(address >> 8) & 0xFF, address & 0xFF, data])) 372 | 373 | def _write_16(self, address: int, data: int) -> None: 374 | # Write a 16-bit big endian value to the specified 16-bit register 375 | # address. 376 | with self._device as i2c: 377 | i2c.write( 378 | bytes( 379 | [ 380 | (address >> 8) & 0xFF, 381 | address & 0xFF, 382 | (data >> 8) & 0xFF, 383 | data & 0xFF, 384 | ] 385 | ) 386 | ) 387 | 388 | def _read_8(self, address: int) -> int: 389 | # Read and return a byte from the specified 16-bit register address. 390 | with self._device as i2c: 391 | result = bytearray(1) 392 | i2c.write(bytes([(address >> 8) & 0xFF, address & 0xFF])) 393 | i2c.readinto(result) 394 | return result[0] 395 | 396 | def _read_16(self, address: int) -> int: 397 | # Read and return a 16-bit unsigned big endian value read from the 398 | # specified 16-bit register address. 399 | with self._device as i2c: 400 | result = bytearray(2) 401 | i2c.write(bytes([(address >> 8) & 0xFF, address & 0xFF])) 402 | i2c.readinto(result) 403 | return (result[0] << 8) | result[1] 404 | -------------------------------------------------------------------------------- /docs/_static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_VL6180X/e064b2713d699d3ee7f0f5905ff7c6e06acc3f6b/docs/_static/favicon.ico -------------------------------------------------------------------------------- /docs/_static/favicon.ico.license: -------------------------------------------------------------------------------- 1 | SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries 2 | 3 | SPDX-License-Identifier: CC-BY-4.0 4 | -------------------------------------------------------------------------------- /docs/api.rst: -------------------------------------------------------------------------------- 1 | 2 | .. If you created a package, create one automodule per module in the package. 3 | 4 | API Reference 5 | ############# 6 | 7 | .. automodule:: adafruit_vl6180x 8 | :members: 9 | -------------------------------------------------------------------------------- /docs/api.rst.license: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | import datetime 6 | import os 7 | import sys 8 | 9 | sys.path.insert(0, os.path.abspath("..")) 10 | 11 | # -- General configuration ------------------------------------------------ 12 | 13 | # Add any Sphinx extension module names here, as strings. They can be 14 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 15 | # ones. 16 | extensions = [ 17 | "sphinx.ext.autodoc", 18 | "sphinxcontrib.jquery", 19 | "sphinx.ext.intersphinx", 20 | "sphinx.ext.viewcode", 21 | ] 22 | 23 | # Uncomment the below if you use native CircuitPython modules such as 24 | # digitalio, micropython and busio. List the modules you use. Without it, the 25 | # autodoc module docs will fail to generate with a warning. 26 | # autodoc_mock_imports = ["micropython", "adafruit_bus_device"] 27 | 28 | intersphinx_mapping = { 29 | "python": ("https://docs.python.org/3", None), 30 | "BusDevice": ( 31 | "https://docs.circuitpython.org/projects/busdevice/en/latest/", 32 | None, 33 | ), 34 | "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), 35 | } 36 | 37 | # Add any paths that contain templates here, relative to this directory. 38 | templates_path = ["_templates"] 39 | 40 | source_suffix = ".rst" 41 | 42 | # The master toctree document. 43 | master_doc = "index" 44 | 45 | # General information about the project. 46 | project = "Adafruit VL6180X Library" 47 | creation_year = "2017" 48 | current_year = str(datetime.datetime.now().year) 49 | year_duration = ( 50 | current_year if current_year == creation_year else creation_year + " - " + current_year 51 | ) 52 | copyright = year_duration + " Tony DiCola" 53 | author = "Tony DiCola" 54 | 55 | # The version info for the project you're documenting, acts as replacement for 56 | # |version| and |release|, also used in various other places throughout the 57 | # built documents. 58 | # 59 | # The short X.Y version. 60 | version = "1.0" 61 | # The full version, including alpha/beta/rc tags. 62 | release = "1.0" 63 | 64 | # The language for content autogenerated by Sphinx. Refer to documentation 65 | # for a list of supported languages. 66 | # 67 | # This is also used if you do content translation via gettext catalogs. 68 | # Usually you set "language" from the command line for these cases. 69 | language = "en" 70 | 71 | # List of patterns, relative to source directory, that match files and 72 | # directories to ignore when looking for source files. 73 | # This patterns also effect to html_static_path and html_extra_path 74 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] 75 | 76 | # The reST default role (used for this markup: `text`) to use for all 77 | # documents. 78 | # 79 | default_role = "any" 80 | 81 | # If true, '()' will be appended to :func: etc. cross-reference text. 82 | # 83 | add_function_parentheses = True 84 | 85 | # The name of the Pygments (syntax highlighting) style to use. 86 | pygments_style = "sphinx" 87 | 88 | # If true, `todo` and `todoList` produce output, else they produce nothing. 89 | todo_include_todos = False 90 | 91 | # If this is True, todo emits a warning for each TODO entries. The default is False. 92 | todo_emit_warnings = True 93 | 94 | 95 | # -- Options for HTML output ---------------------------------------------- 96 | 97 | # The theme to use for HTML and HTML Help pages. See the documentation for 98 | # a list of builtin themes. 99 | # 100 | import sphinx_rtd_theme 101 | 102 | html_theme = "sphinx_rtd_theme" 103 | 104 | # Add any paths that contain custom static files (such as style sheets) here, 105 | # relative to this directory. They are copied after the builtin static files, 106 | # so a file named "default.css" will overwrite the builtin "default.css". 107 | html_static_path = ["_static"] 108 | 109 | # The name of an image file (relative to this directory) to use as a favicon of 110 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 111 | # pixels large. 112 | # 113 | html_favicon = "_static/favicon.ico" 114 | 115 | # Output file base name for HTML help builder. 116 | htmlhelp_basename = "AdafruitVl6180xLibrarydoc" 117 | 118 | # -- Options for LaTeX output --------------------------------------------- 119 | 120 | latex_elements = { 121 | # The paper size ('letterpaper' or 'a4paper'). 122 | # 123 | # 'papersize': 'letterpaper', 124 | # The font size ('10pt', '11pt' or '12pt'). 125 | # 126 | # 'pointsize': '10pt', 127 | # Additional stuff for the LaTeX preamble. 128 | # 129 | # 'preamble': '', 130 | # Latex figure (float) alignment 131 | # 132 | # 'figure_align': 'htbp', 133 | } 134 | 135 | # Grouping the document tree into LaTeX files. List of tuples 136 | # (source start file, target name, title, 137 | # author, documentclass [howto, manual, or own class]). 138 | latex_documents = [ 139 | ( 140 | master_doc, 141 | "AdafruitVL6180XLibrary.tex", 142 | "AdafruitVL6180X Library Documentation", 143 | author, 144 | "manual", 145 | ), 146 | ] 147 | 148 | # -- Options for manual page output --------------------------------------- 149 | 150 | # One entry per manual page. List of tuples 151 | # (source start file, name, description, authors, manual section). 152 | man_pages = [ 153 | ( 154 | master_doc, 155 | "AdafruitVL6180Xlibrary", 156 | "Adafruit VL6180X Library Documentation", 157 | [author], 158 | 1, 159 | ) 160 | ] 161 | 162 | # -- Options for Texinfo output ------------------------------------------- 163 | 164 | # Grouping the document tree into Texinfo files. List of tuples 165 | # (source start file, target name, title, author, 166 | # dir menu entry, description, category) 167 | texinfo_documents = [ 168 | ( 169 | master_doc, 170 | "AdafruitVL6180XLibrary", 171 | "Adafruit VL6180X Library Documentation", 172 | author, 173 | "AdafruitVL6180XLibrary", 174 | "One line description of project.", 175 | "Miscellaneous", 176 | ), 177 | ] 178 | -------------------------------------------------------------------------------- /docs/examples.rst: -------------------------------------------------------------------------------- 1 | Simple Test 2 | ------------ 3 | 4 | Ensure your device works with this simple test. 5 | 6 | .. literalinclude:: ../examples/vl6180x_simpletest.py 7 | :caption: examples/vl6180x_simpletest.py 8 | :linenos: 9 | 10 | 11 | Calibration Test 12 | ----------------- 13 | 14 | Demo of calibrating the part to part range offset per Application Note 4545 for the VL6180X sensor. 15 | 16 | .. literalinclude:: ../examples/vl6180x_calibrationtest.py 17 | :caption: examples/vl6180x_calibrationtest.py 18 | :linenos: 19 | 20 | 21 | Continuous Test 22 | ---------------- 23 | 24 | Demo of reading the range from the VL6180x distance sensor in continuous mode. 25 | 26 | .. literalinclude:: ../examples/vl6180x_continuoustest.py 27 | :caption: examples/vl6180x_continuoustest.py 28 | :linenos: 29 | 30 | 31 | History Test 32 | ------------- 33 | 34 | Demo of reading the range from the history buffer of the VL6180x distance sensor. 35 | 36 | .. literalinclude:: ../examples/vl6180x_historytest.py 37 | :caption: examples/vl6180x_historytest.py 38 | :linenos: 39 | 40 | 41 | Performance Test 42 | ----------------- 43 | 44 | Demo of reading the range from the VL6180x distance sensor in different access modes (single shot, continuous, history). 45 | 46 | .. literalinclude:: ../examples/vl6180x_performancetest.py 47 | :caption: examples/vl6180x_performancetest.py 48 | :linenos: 49 | 50 | DisplayIO Simpletest 51 | --------------------- 52 | 53 | This is a simple test for boards with built-in display. 54 | 55 | .. literalinclude:: ../examples/vl6180x_displayio_simpletest.py 56 | :caption: examples/vl6180x_displayio_simpletest.py 57 | :linenos: 58 | -------------------------------------------------------------------------------- /docs/examples.rst.license: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. include:: ../README.rst 2 | 3 | Table of Contents 4 | ================= 5 | 6 | .. toctree:: 7 | :maxdepth: 4 8 | :hidden: 9 | 10 | self 11 | 12 | .. toctree:: 13 | :caption: Examples 14 | 15 | examples 16 | 17 | .. toctree:: 18 | :caption: API Reference 19 | :maxdepth: 3 20 | 21 | api 22 | 23 | .. toctree:: 24 | :caption: Tutorials 25 | 26 | .. toctree:: 27 | :caption: Related Products 28 | 29 | Adafruit VL6180X Time of Flight Distance Ranging Sensor (VL6180) 30 | 31 | .. toctree:: 32 | :caption: Other Links 33 | 34 | Download from GitHub 35 | Download Library Bundle 36 | CircuitPython Reference Documentation 37 | CircuitPython Support Forum 38 | Discord Chat 39 | Adafruit Learning System 40 | Adafruit Blog 41 | Adafruit Store 42 | 43 | Indices and tables 44 | ================== 45 | 46 | * :ref:`genindex` 47 | * :ref:`modindex` 48 | * :ref:`search` 49 | -------------------------------------------------------------------------------- /docs/index.rst.license: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /docs/requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | sphinx 6 | sphinxcontrib-jquery 7 | sphinx-rtd-theme 8 | -------------------------------------------------------------------------------- /examples/vl6180x_calibrationtest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2018 Tony DiCola for Adafruit Industries 2 | # SPDX-License-Identifier: MIT 3 | 4 | # Demo of calibrating the part to part range offset per Application Note 4545 5 | # for the VL6180X sensor 6 | 7 | import time 8 | 9 | import board 10 | import busio 11 | 12 | import adafruit_vl6180x 13 | 14 | # Create I2C bus. 15 | i2c = busio.I2C(board.SCL, board.SDA) 16 | 17 | # Create sensor instance, with explicit offset of 0 to clear the system offset 18 | sensor = adafruit_vl6180x.VL6180X(i2c, offset=0) 19 | 20 | # Place a target at 50mm away from VL6180X Collect a number of range measurements 21 | # with the target in place and calculate mean of the range results. For a 22 | # reliable measurement, take at least 10 measurements. 23 | measurements = [] 24 | for msmt in range(10): 25 | range_mm = sensor.range 26 | measurements.append(range_mm) 27 | time.sleep(1.0) 28 | average_msmt = sum(measurements) / 10 29 | 30 | # Calculate the offset required: 31 | calibration_offset = 50 - average_msmt 32 | 33 | # Apply offset 34 | sensor.offset = calibration_offset 35 | -------------------------------------------------------------------------------- /examples/vl6180x_continuoustest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2018 Jonas Schatz 2 | # SPDX-License-Identifier: MIT 3 | 4 | # Demo of reading the range from the VL6180x distance sensor in 5 | # continuous mode 6 | 7 | import time 8 | 9 | import board 10 | import busio 11 | 12 | import adafruit_vl6180x 13 | 14 | # Create I2C bus. 15 | i2c = busio.I2C(board.SCL, board.SDA) 16 | 17 | # Create sensor instance. 18 | sensor = adafruit_vl6180x.VL6180X(i2c) 19 | 20 | # Starting continuous mode 21 | print("Starting continuous mode") 22 | sensor.start_range_continuous(20) 23 | 24 | # Main loop prints the range and lux every 0.01 seconds 25 | for _ in range(100): 26 | # Read the range in millimeters and print it. 27 | range_mm = sensor.range 28 | print(f"Range: {range_mm}mm") 29 | 30 | # Delay for 10 ms 31 | time.sleep(0.01) 32 | 33 | # Stop continuous mode. This is advised as the sensor 34 | # wouldn't stop measuring after the program has ended 35 | sensor.stop_range_continuous() 36 | -------------------------------------------------------------------------------- /examples/vl6180x_displayio_simpletest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries 2 | # SPDX-FileCopyrightText: 2024 Jose D. Montoya 3 | # 4 | # SPDX-License-Identifier: MIT 5 | 6 | import time 7 | 8 | import board 9 | from adafruit_display_text.bitmap_label import Label 10 | from displayio import Group 11 | from terminalio import FONT 12 | 13 | import adafruit_vl6180x 14 | 15 | # Simple demo of the vl6180x distance sensor. 16 | # create a main_group to hold anything we want to show on the display. 17 | main_group = Group() 18 | # Initialize I2C bus and sensor. 19 | i2c = board.I2C() # uses board.SCL and board.SDA 20 | sensor = adafruit_vl6180x.VL6180X(i2c) 21 | 22 | # Create two Labels to show the readings. If you have a very small 23 | # display you may need to change to scale=1. 24 | range_output_label = Label(FONT, text="", scale=2) 25 | light_lux_output_label = Label(FONT, text="", scale=2) 26 | 27 | # place the labels in the middle of the screen with anchored positioning 28 | range_output_label.anchor_point = (0, 0) 29 | range_output_label.anchored_position = ( 30 | 4, 31 | board.DISPLAY.height // 2 - 40, 32 | ) 33 | light_lux_output_label.anchor_point = (0, 0) 34 | light_lux_output_label.anchored_position = (4, board.DISPLAY.height // 2) 35 | 36 | 37 | # add the label to the main_group 38 | main_group.append(range_output_label) 39 | main_group.append(light_lux_output_label) 40 | 41 | # set the main_group as the root_group of the built-in DISPLAY 42 | board.DISPLAY.root_group = main_group 43 | 44 | # begin main loop 45 | while True: 46 | # Update the label.text property to change the text on the display 47 | range_output_label.text = f"Range:{sensor.range} mm" 48 | light_lux_output_label.text = f"Lux:{sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1)} lux" 49 | # wait for a bit 50 | time.sleep(1.0) 51 | -------------------------------------------------------------------------------- /examples/vl6180x_historytest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Jonas Schatz 2 | # SPDX-License-Identifier: MIT 3 | 4 | # Demo of reading the range from the history buffer of the VL6180x 5 | # distance sensor 6 | 7 | import time 8 | 9 | import board 10 | import busio 11 | 12 | import adafruit_vl6180x 13 | 14 | # Create I2C bus. 15 | i2c = busio.I2C(board.SCL, board.SDA) 16 | 17 | # Create sensor instance. 18 | sensor = adafruit_vl6180x.VL6180X(i2c) 19 | 20 | # Starting continuous mode 21 | print("Starting continuous mode") 22 | sensor.start_range_continuous() 23 | 24 | # Main loop prints the ranges every 0.01 seconds for about 5 seconds 25 | # You should see changes 'ripple through' the history array 26 | for _ in range(500): 27 | # Read the last 16 ranges from the history buffer as a List[int] 28 | ranges_mm = sensor.ranges_from_history 29 | print(ranges_mm) 30 | 31 | # Delay for 10 ms so that the loop is not too fast 32 | time.sleep(0.01) 33 | 34 | # Stop continuous mode. This is advised as the sensor 35 | # wouldn't stop measuring after the program has ended 36 | sensor.stop_range_continuous() 37 | -------------------------------------------------------------------------------- /examples/vl6180x_performancetest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Jonas Schatz 2 | # SPDX-License-Identifier: MIT 3 | 4 | # Demo of reading the range from the VL6180x distance sensor in 5 | # different access modes (single shot, continuous, history) 6 | 7 | import time 8 | 9 | import board 10 | import busio 11 | 12 | import adafruit_vl6180x 13 | 14 | # Create I2C bus. 15 | i2c = busio.I2C(board.SCL, board.SDA) 16 | 17 | # Create sensor instance. 18 | sensor = adafruit_vl6180x.VL6180X(i2c) 19 | 20 | # Define the number of measurements 21 | # n_measurements = 1000 will run for about 2 minutes 22 | n_measurements: int = 100 23 | 24 | # Single shot 25 | print("Starting single-shot measurement...") 26 | start = time.time() 27 | for i in range(n_measurements): 28 | range_mm = sensor.range 29 | print(f"Performed {n_measurements} measurements in single-shot mode in {time.time() - start}s\n") 30 | 31 | # Sleep is required, otherwise the sensor might freeze when switching to 32 | # continuous mode too quickly after the last single shot 33 | time.sleep(2) 34 | 35 | # Continuous with no delay between measurements 36 | print("Starting continuous measurement...") 37 | sensor.start_range_continuous(20) 38 | start = time.time() 39 | for i in range(n_measurements): 40 | range_mm = sensor.range 41 | print(f"Performed {n_measurements} measurements in continuous mode in {time.time() - start}s\n") 42 | 43 | # Continuous, reading data from history. 44 | # Note: This is fast, since you don't have to wait for the measurement to be 45 | # finished. On the downside, you will read the same value multiple times 46 | print("Starting continuous measurement with history enabled...") 47 | start = time.time() 48 | for i in range(n_measurements): 49 | range_mm = sensor.range_from_history 50 | print( 51 | f"Performed {n_measurements} measurements in continuous mode, reading form history, in {time.time() - start}s\n" # noqa: E501 52 | ) 53 | 54 | sensor.stop_range_continuous() 55 | print("Finished") 56 | -------------------------------------------------------------------------------- /examples/vl6180x_simpletest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2018 Tony DiCola for Adafruit Industries 2 | # SPDX-License-Identifier: MIT 3 | 4 | # Demo of reading the range and lux from the VL6180x distance sensor and 5 | # printing it every second. 6 | 7 | import time 8 | 9 | import board 10 | import busio 11 | 12 | import adafruit_vl6180x 13 | 14 | # Create I2C bus. 15 | i2c = busio.I2C(board.SCL, board.SDA) 16 | 17 | # Create sensor instance. 18 | sensor = adafruit_vl6180x.VL6180X(i2c) 19 | # You can add an offset to distance measurements here (e.g. calibration) 20 | # Swapping for the following would add a +10 millimeter offset to measurements: 21 | # sensor = adafruit_vl6180x.VL6180X(i2c, offset=10) 22 | 23 | # Main loop prints the range and lux every second: 24 | while True: 25 | # Read the range in millimeters and print it. 26 | range_mm = sensor.range 27 | print(f"Range: {range_mm}mm") 28 | # Read the light, note this requires specifying a gain value: 29 | # - adafruit_vl6180x.ALS_GAIN_1 = 1x 30 | # - adafruit_vl6180x.ALS_GAIN_1_25 = 1.25x 31 | # - adafruit_vl6180x.ALS_GAIN_1_67 = 1.67x 32 | # - adafruit_vl6180x.ALS_GAIN_2_5 = 2.5x 33 | # - adafruit_vl6180x.ALS_GAIN_5 = 5x 34 | # - adafruit_vl6180x.ALS_GAIN_10 = 10x 35 | # - adafruit_vl6180x.ALS_GAIN_20 = 20x 36 | # - adafruit_vl6180x.ALS_GAIN_40 = 40x 37 | light_lux = sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1) 38 | print(f"Light (1x gain): {light_lux}lux") 39 | # Delay for a second. 40 | time.sleep(1.0) 41 | -------------------------------------------------------------------------------- /optional_requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | [build-system] 6 | requires = [ 7 | "setuptools", 8 | "wheel", 9 | "setuptools-scm", 10 | ] 11 | 12 | [project] 13 | name = "adafruit-circuitpython-vl6180x" 14 | description = "CircuitPython library for VL6180X time of flight distance sensor." 15 | version = "0.0.0+auto.0" 16 | readme = "README.rst" 17 | authors = [ 18 | {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} 19 | ] 20 | urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X"} 21 | keywords = [ 22 | "adafruit", 23 | "vl6180x", 24 | "time", 25 | "flight", 26 | "distance", 27 | "sensorbreakout", 28 | "hardware", 29 | "micropython", 30 | "circuitpython", 31 | ] 32 | license = {text = "MIT"} 33 | classifiers = [ 34 | "Intended Audience :: Developers", 35 | "Topic :: Software Development :: Libraries", 36 | "Topic :: Software Development :: Embedded Systems", 37 | "Topic :: System :: Hardware", 38 | "License :: OSI Approved :: MIT License", 39 | "Programming Language :: Python :: 3", 40 | ] 41 | dynamic = ["dependencies", "optional-dependencies"] 42 | 43 | [tool.setuptools] 44 | py-modules = ["adafruit_vl6180x"] 45 | 46 | [tool.setuptools.dynamic] 47 | dependencies = {file = ["requirements.txt"]} 48 | optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} 49 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | Adafruit-Blinka 6 | adafruit-circuitpython-busdevice 7 | -------------------------------------------------------------------------------- /ruff.toml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | target-version = "py38" 6 | line-length = 100 7 | 8 | [lint] 9 | preview = true 10 | select = ["I", "PL", "UP"] 11 | 12 | extend-select = [ 13 | "D419", # empty-docstring 14 | "E501", # line-too-long 15 | "W291", # trailing-whitespace 16 | "PLC0414", # useless-import-alias 17 | "PLC2401", # non-ascii-name 18 | "PLC2801", # unnecessary-dunder-call 19 | "PLC3002", # unnecessary-direct-lambda-call 20 | "E999", # syntax-error 21 | "PLE0101", # return-in-init 22 | "F706", # return-outside-function 23 | "F704", # yield-outside-function 24 | "PLE0116", # continue-in-finally 25 | "PLE0117", # nonlocal-without-binding 26 | "PLE0241", # duplicate-bases 27 | "PLE0302", # unexpected-special-method-signature 28 | "PLE0604", # invalid-all-object 29 | "PLE0605", # invalid-all-format 30 | "PLE0643", # potential-index-error 31 | "PLE0704", # misplaced-bare-raise 32 | "PLE1141", # dict-iter-missing-items 33 | "PLE1142", # await-outside-async 34 | "PLE1205", # logging-too-many-args 35 | "PLE1206", # logging-too-few-args 36 | "PLE1307", # bad-string-format-type 37 | "PLE1310", # bad-str-strip-call 38 | "PLE1507", # invalid-envvar-value 39 | "PLE2502", # bidirectional-unicode 40 | "PLE2510", # invalid-character-backspace 41 | "PLE2512", # invalid-character-sub 42 | "PLE2513", # invalid-character-esc 43 | "PLE2514", # invalid-character-nul 44 | "PLE2515", # invalid-character-zero-width-space 45 | "PLR0124", # comparison-with-itself 46 | "PLR0202", # no-classmethod-decorator 47 | "PLR0203", # no-staticmethod-decorator 48 | "UP004", # useless-object-inheritance 49 | "PLR0206", # property-with-parameters 50 | "PLR0904", # too-many-public-methods 51 | "PLR0911", # too-many-return-statements 52 | "PLR0912", # too-many-branches 53 | "PLR0913", # too-many-arguments 54 | "PLR0914", # too-many-locals 55 | "PLR0915", # too-many-statements 56 | "PLR0916", # too-many-boolean-expressions 57 | "PLR1702", # too-many-nested-blocks 58 | "PLR1704", # redefined-argument-from-local 59 | "PLR1711", # useless-return 60 | "C416", # unnecessary-comprehension 61 | "PLR1733", # unnecessary-dict-index-lookup 62 | "PLR1736", # unnecessary-list-index-lookup 63 | 64 | # ruff reports this rule is unstable 65 | #"PLR6301", # no-self-use 66 | 67 | "PLW0108", # unnecessary-lambda 68 | "PLW0120", # useless-else-on-loop 69 | "PLW0127", # self-assigning-variable 70 | "PLW0129", # assert-on-string-literal 71 | "B033", # duplicate-value 72 | "PLW0131", # named-expr-without-context 73 | "PLW0245", # super-without-brackets 74 | "PLW0406", # import-self 75 | "PLW0602", # global-variable-not-assigned 76 | "PLW0603", # global-statement 77 | "PLW0604", # global-at-module-level 78 | 79 | # fails on the try: import typing used by libraries 80 | #"F401", # unused-import 81 | 82 | "F841", # unused-variable 83 | "E722", # bare-except 84 | "PLW0711", # binary-op-exception 85 | "PLW1501", # bad-open-mode 86 | "PLW1508", # invalid-envvar-default 87 | "PLW1509", # subprocess-popen-preexec-fn 88 | "PLW2101", # useless-with-lock 89 | "PLW3301", # nested-min-max 90 | ] 91 | 92 | ignore = [ 93 | "PLR2004", # magic-value-comparison 94 | "UP030", # format literals 95 | "PLW1514", # unspecified-encoding 96 | "PLR0913", # too-many-arguments 97 | "PLR0915", # too-many-statements 98 | "PLR0917", # too-many-positional-arguments 99 | "PLR0904", # too-many-public-methods 100 | "PLR0912", # too-many-branches 101 | "PLR0916", # too-many-boolean-expressions 102 | "PLR6301", # could-be-static no-self-use 103 | "PLC0415", # import outside toplevel 104 | ] 105 | 106 | [format] 107 | line-ending = "lf" 108 | --------------------------------------------------------------------------------