├── .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_neopxl8.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 ├── neopxl8_animations.py ├── neopxl8_multiple_animations.py └── neopxl8_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 Melissa LeBlanc-Williams 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 | 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 | * Discussion or promotion of activities or projects that intend or pose a risk of 43 | significant harm 44 | * Trolling, insulting/derogatory comments, and personal or political attacks 45 | * Promoting or spreading disinformation, lies, or conspiracy theories against 46 | a person, group, organisation, project, or community 47 | * Public or private harassment 48 | * Publishing others' private information, such as a physical or electronic 49 | address, without explicit permission 50 | * Other conduct which could reasonably be considered inappropriate 51 | 52 | The goal of the standards and moderation guidelines outlined here is to build 53 | and maintain a respectful community. We ask that you don’t just aim to be 54 | "technically unimpeachable", but rather try to be your best self. 55 | 56 | We value many things beyond technical expertise, including collaboration and 57 | supporting others within our community. Providing a positive experience for 58 | other community members can have a much more significant impact than simply 59 | providing the correct answer. 60 | 61 | ## Our Responsibilities 62 | 63 | Project leaders are responsible for clarifying the standards of acceptable 64 | behavior and are expected to take appropriate and fair corrective action in 65 | response to any instances of unacceptable behavior. 66 | 67 | Project leaders have the right and responsibility to remove, edit, or 68 | reject messages, comments, commits, code, issues, and other contributions 69 | that are not aligned to this Code of Conduct, or to ban temporarily or 70 | permanently any community member for other behaviors that they deem 71 | inappropriate, threatening, offensive, or harmful. 72 | 73 | ## Moderation 74 | 75 | Instances of behaviors that violate the Adafruit Community Code of Conduct 76 | may be reported by any member of the community. Community members are 77 | encouraged to report these situations, including situations they witness 78 | involving other community members. 79 | 80 | You may report in the following ways: 81 | 82 | In any situation, you may email . 83 | 84 | On the Adafruit Discord, you may send an open message from any channel 85 | to all Community Moderators by tagging @community moderators. You may 86 | also send an open message from any channel, or a direct message to 87 | any Community Moderator. 88 | 89 | Email and direct message reports will be kept confidential. 90 | 91 | In situations on Discord where the issue is particularly offensive, possibly 92 | illegal, requires immediate action, or violates the Discord terms of service, 93 | you should also report the message directly to [Discord](https://discord.com/safety). 94 | 95 | These are the steps for upholding our community’s standards of conduct. 96 | 97 | 1. Any member of the community may report any situation that violates the 98 | CircuitPython Community Code of Conduct. All reports will be reviewed and 99 | investigated. 100 | 2. If the behavior is a severe violation, the community member who 101 | committed the violation may be banned immediately, without warning. 102 | 3. Otherwise, moderators will first respond to such behavior with a warning. 103 | 4. Moderators follow a soft "three strikes" policy - the community member may 104 | be given another chance, if they are receptive to the warning and change their 105 | behavior. 106 | 5. If the community member is unreceptive or unreasonable when warned by a 107 | moderator, or the warning goes unheeded, they may be banned for a first or 108 | second offense. Repeated offenses will result in the community member being 109 | banned. 110 | 6. Disciplinary actions (warnings, bans, etc) for Code of Conduct violations apply 111 | to the platform where the violation occurred. However, depending on the severity 112 | of the violation, the disciplinary action may be applied across Adafruit's other 113 | community platforms. For example, a severe violation on the Adafruit Discord 114 | server may result in a ban on not only the Adafruit Discord server, but also on 115 | the Adafruit GitHub organisation, Adafruit Forums, Adafruit Twitter, etc. 116 | 117 | ## Scope 118 | 119 | This Code of Conduct and the enforcement policies listed above apply to all 120 | Adafruit Community venues. This includes but is not limited to any community 121 | spaces (both public and private), the entire Adafruit Discord server, and 122 | Adafruit GitHub repositories. Examples of Adafruit Community spaces include 123 | but are not limited to meet-ups, audio chats on the Adafruit Discord, or 124 | interaction at a conference. 125 | 126 | This Code of Conduct applies both within project spaces and in public spaces 127 | when an individual is representing the project or its community. As a community 128 | member, you are representing our community, and are expected to behave 129 | accordingly. 130 | 131 | ## Attribution 132 | 133 | This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), 134 | version 1.4, available on [contributor-covenant.org](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html), 135 | and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). 136 | 137 | For other projects adopting the Adafruit Community Code of 138 | Conduct, please contact the maintainers of those projects for enforcement. 139 | If you wish to use this code of conduct for your own project, consider 140 | explicitly mentioning your moderation policy or making a copy with your 141 | own moderation policy so as to avoid confusion. 142 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2022 Jeff Epler for Adafruit Industries 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /LICENSES/CC-BY-4.0.txt: -------------------------------------------------------------------------------- 1 | Creative Commons Attribution 4.0 International Creative Commons Corporation 2 | ("Creative Commons") is not a law firm and does not provide legal services 3 | or legal advice. Distribution of Creative Commons public licenses does not 4 | create a lawyer-client or other relationship. Creative Commons makes its licenses 5 | and related information available on an "as-is" basis. Creative Commons gives 6 | no warranties regarding its licenses, any material licensed under their terms 7 | and conditions, or any related information. Creative Commons disclaims all 8 | liability for damages resulting from their use to the fullest extent possible. 9 | 10 | Using Creative Commons Public Licenses 11 | 12 | Creative Commons public licenses provide a standard set of terms and conditions 13 | that creators and other rights holders may use to share original works of 14 | authorship and other material subject to copyright and certain other rights 15 | specified in the public license below. The following considerations are for 16 | informational purposes only, are not exhaustive, and do not form part of our 17 | licenses. 18 | 19 | Considerations for licensors: Our public licenses are intended for use by 20 | those authorized to give the public permission to use material in ways otherwise 21 | restricted by copyright and certain other rights. Our licenses are irrevocable. 22 | Licensors should read and understand the terms and conditions of the license 23 | they choose before applying it. Licensors should also secure all rights necessary 24 | before applying our licenses so that the public can reuse the material as 25 | expected. Licensors should clearly mark any material not subject to the license. 26 | This includes other CC-licensed material, or material used under an exception 27 | or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors 28 | 29 | Considerations for the public: By using one of our public licenses, a licensor 30 | grants the public permission to use the licensed material under specified 31 | terms and conditions. If the licensor's permission is not necessary for any 32 | reason–for example, because of any applicable exception or limitation to copyright–then 33 | that use is not regulated by the license. Our licenses grant only permissions 34 | under copyright and certain other rights that a licensor has authority to 35 | grant. Use of the licensed material may still be restricted for other reasons, 36 | including because others have copyright or other rights in the material. A 37 | licensor may make special requests, such as asking that all changes be marked 38 | or described. Although not required by our licenses, you are encouraged to 39 | respect those requests where reasonable. More considerations for the public 40 | : wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution 41 | 4.0 International Public License 42 | 43 | By exercising the Licensed Rights (defined below), You accept and agree to 44 | be bound by the terms and conditions of this Creative Commons Attribution 45 | 4.0 International Public License ("Public License"). To the extent this Public 46 | License may be interpreted as a contract, You are granted the Licensed Rights 47 | in consideration of Your acceptance of these terms and conditions, and the 48 | Licensor grants You such rights in consideration of benefits the Licensor 49 | receives from making the Licensed Material available under these terms and 50 | conditions. 51 | 52 | Section 1 – Definitions. 53 | 54 | a. Adapted Material means material subject to Copyright and Similar Rights 55 | that is derived from or based upon the Licensed Material and in which the 56 | Licensed Material is translated, altered, arranged, transformed, or otherwise 57 | modified in a manner requiring permission under the Copyright and Similar 58 | Rights held by the Licensor. For purposes of this Public License, where the 59 | Licensed Material is a musical work, performance, or sound recording, Adapted 60 | Material is always produced where the Licensed Material is synched in timed 61 | relation with a moving image. 62 | 63 | b. Adapter's License means the license You apply to Your Copyright and Similar 64 | Rights in Your contributions to Adapted Material in accordance with the terms 65 | and conditions of this Public License. 66 | 67 | c. Copyright and Similar Rights means copyright and/or similar rights closely 68 | related to copyright including, without limitation, performance, broadcast, 69 | sound recording, and Sui Generis Database Rights, without regard to how the 70 | rights are labeled or categorized. For purposes of this Public License, the 71 | rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. 72 | 73 | d. Effective Technological Measures means those measures that, in the absence 74 | of proper authority, may not be circumvented under laws fulfilling obligations 75 | under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, 76 | and/or similar international agreements. 77 | 78 | e. Exceptions and Limitations means fair use, fair dealing, and/or any other 79 | exception or limitation to Copyright and Similar Rights that applies to Your 80 | use of the Licensed Material. 81 | 82 | f. Licensed Material means the artistic or literary work, database, or other 83 | material to which the Licensor applied this Public License. 84 | 85 | g. Licensed Rights means the rights granted to You subject to the terms and 86 | conditions of this Public License, which are limited to all Copyright and 87 | Similar Rights that apply to Your use of the Licensed Material and that the 88 | Licensor has authority to license. 89 | 90 | h. Licensor means the individual(s) or entity(ies) granting rights under this 91 | Public License. 92 | 93 | i. Share means to provide material to the public by any means or process that 94 | requires permission under the Licensed Rights, such as reproduction, public 95 | display, public performance, distribution, dissemination, communication, or 96 | importation, and to make material available to the public including in ways 97 | that members of the public may access the material from a place and at a time 98 | individually chosen by them. 99 | 100 | j. Sui Generis Database Rights means rights other than copyright resulting 101 | from Directive 96/9/EC of the European Parliament and of the Council of 11 102 | March 1996 on the legal protection of databases, as amended and/or succeeded, 103 | as well as other essentially equivalent rights anywhere in the world. 104 | 105 | k. You means the individual or entity exercising the Licensed Rights under 106 | this Public License. Your has a corresponding meaning. 107 | 108 | Section 2 – Scope. 109 | 110 | a. License grant. 111 | 112 | 1. Subject to the terms and conditions of this Public License, the Licensor 113 | hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, 114 | irrevocable license to exercise the Licensed Rights in the Licensed Material 115 | to: 116 | 117 | A. reproduce and Share the Licensed Material, in whole or in part; and 118 | 119 | B. produce, reproduce, and Share Adapted Material. 120 | 121 | 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions 122 | and Limitations apply to Your use, this Public License does not apply, and 123 | You do not need to comply with its terms and conditions. 124 | 125 | 3. Term. The term of this Public License is specified in Section 6(a). 126 | 127 | 4. Media and formats; technical modifications allowed. The Licensor authorizes 128 | You to exercise the Licensed Rights in all media and formats whether now known 129 | or hereafter created, and to make technical modifications necessary to do 130 | so. The Licensor waives and/or agrees not to assert any right or authority 131 | to forbid You from making technical modifications necessary to exercise the 132 | Licensed Rights, including technical modifications necessary to circumvent 133 | Effective Technological Measures. For purposes of this Public License, simply 134 | making modifications authorized by this Section 2(a)(4) never produces Adapted 135 | Material. 136 | 137 | 5. Downstream recipients. 138 | 139 | A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed 140 | Material automatically receives an offer from the Licensor to exercise the 141 | Licensed Rights under the terms and conditions of this Public License. 142 | 143 | B. No downstream restrictions. You may not offer or impose any additional 144 | or different terms or conditions on, or apply any Effective Technological 145 | Measures to, the Licensed Material if doing so restricts exercise of the Licensed 146 | Rights by any recipient of the Licensed Material. 147 | 148 | 6. No endorsement. Nothing in this Public License constitutes or may be construed 149 | as permission to assert or imply that You are, or that Your use of the Licensed 150 | Material is, connected with, or sponsored, endorsed, or granted official status 151 | by, the Licensor or others designated to receive attribution as provided in 152 | Section 3(a)(1)(A)(i). 153 | 154 | b. Other rights. 155 | 156 | 1. Moral rights, such as the right of integrity, are not licensed under this 157 | Public License, nor are publicity, privacy, and/or other similar personality 158 | rights; however, to the extent possible, the Licensor waives and/or agrees 159 | not to assert any such rights held by the Licensor to the limited extent necessary 160 | to allow You to exercise the Licensed Rights, but not otherwise. 161 | 162 | 2. Patent and trademark rights are not licensed under this Public License. 163 | 164 | 3. To the extent possible, the Licensor waives any right to collect royalties 165 | from You for the exercise of the Licensed Rights, whether directly or through 166 | a collecting society under any voluntary or waivable statutory or compulsory 167 | licensing scheme. In all other cases the Licensor expressly reserves any right 168 | to collect such royalties. 169 | 170 | Section 3 – License Conditions. 171 | 172 | Your exercise of the Licensed Rights is expressly made subject to the following 173 | conditions. 174 | 175 | a. Attribution. 176 | 177 | 1. If You Share the Licensed Material (including in modified form), You must: 178 | 179 | A. retain the following if it is supplied by the Licensor with the Licensed 180 | Material: 181 | 182 | i. identification of the creator(s) of the Licensed Material and any others 183 | designated to receive attribution, in any reasonable manner requested by the 184 | Licensor (including by pseudonym if designated); 185 | 186 | ii. a copyright notice; 187 | 188 | iii. a notice that refers to this Public License; 189 | 190 | iv. a notice that refers to the disclaimer of warranties; 191 | 192 | v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; 193 | 194 | B. indicate if You modified the Licensed Material and retain an indication 195 | of any previous modifications; and 196 | 197 | C. indicate the Licensed Material is licensed under this Public License, and 198 | include the text of, or the URI or hyperlink to, this Public License. 199 | 200 | 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner 201 | based on the medium, means, and context in which You Share the Licensed Material. 202 | For example, it may be reasonable to satisfy the conditions by providing a 203 | URI or hyperlink to a resource that includes the required information. 204 | 205 | 3. If requested by the Licensor, You must remove any of the information required 206 | by Section 3(a)(1)(A) to the extent reasonably practicable. 207 | 208 | 4. If You Share Adapted Material You produce, the Adapter's License You apply 209 | must not prevent recipients of the Adapted Material from complying with this 210 | Public License. 211 | 212 | Section 4 – Sui Generis Database Rights. 213 | 214 | Where the Licensed Rights include Sui Generis Database Rights that apply to 215 | Your use of the Licensed Material: 216 | 217 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, 218 | reuse, reproduce, and Share all or a substantial portion of the contents of 219 | the database; 220 | 221 | b. if You include all or a substantial portion of the database contents in 222 | a database in which You have Sui Generis Database Rights, then the database 223 | in which You have Sui Generis Database Rights (but not its individual contents) 224 | is Adapted Material; and 225 | 226 | c. You must comply with the conditions in Section 3(a) if You Share all or 227 | a substantial portion of the contents of the database. 228 | 229 | For the avoidance of doubt, this Section 4 supplements and does not replace 230 | Your obligations under this Public License where the Licensed Rights include 231 | other Copyright and Similar Rights. 232 | 233 | Section 5 – Disclaimer of Warranties and Limitation of Liability. 234 | 235 | a. Unless otherwise separately undertaken by the Licensor, to the extent possible, 236 | the Licensor offers the Licensed Material as-is and as-available, and makes 237 | no representations or warranties of any kind concerning the Licensed Material, 238 | whether express, implied, statutory, or other. This includes, without limitation, 239 | warranties of title, merchantability, fitness for a particular purpose, non-infringement, 240 | absence of latent or other defects, accuracy, or the presence or absence of 241 | errors, whether or not known or discoverable. Where disclaimers of warranties 242 | are not allowed in full or in part, this disclaimer may not apply to You. 243 | 244 | b. To the extent possible, in no event will the Licensor be liable to You 245 | on any legal theory (including, without limitation, negligence) or otherwise 246 | for any direct, special, indirect, incidental, consequential, punitive, exemplary, 247 | or other losses, costs, expenses, or damages arising out of this Public License 248 | or use of the Licensed Material, even if the Licensor has been advised of 249 | the possibility of such losses, costs, expenses, or damages. Where a limitation 250 | of liability is not allowed in full or in part, this limitation may not apply 251 | to You. 252 | 253 | c. The disclaimer of warranties and limitation of liability provided above 254 | shall be interpreted in a manner that, to the extent possible, most closely 255 | approximates an absolute disclaimer and waiver of all liability. 256 | 257 | Section 6 – Term and Termination. 258 | 259 | a. This Public License applies for the term of the Copyright and Similar Rights 260 | licensed here. However, if You fail to comply with this Public License, then 261 | Your rights under this Public License terminate automatically. 262 | 263 | b. Where Your right to use the Licensed Material has terminated under Section 264 | 6(a), it reinstates: 265 | 266 | 1. automatically as of the date the violation is cured, provided it is cured 267 | within 30 days of Your discovery of the violation; or 268 | 269 | 2. upon express reinstatement by the Licensor. 270 | 271 | c. For the avoidance of doubt, this Section 6(b) does not affect any right 272 | the Licensor may have to seek remedies for Your violations of this Public 273 | License. 274 | 275 | d. For the avoidance of doubt, the Licensor may also offer the Licensed Material 276 | under separate terms or conditions or stop distributing the Licensed Material 277 | at any time; however, doing so will not terminate this Public License. 278 | 279 | e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. 280 | 281 | Section 7 – Other Terms and Conditions. 282 | 283 | a. The Licensor shall not be bound by any additional or different terms or 284 | conditions communicated by You unless expressly agreed. 285 | 286 | b. Any arrangements, understandings, or agreements regarding the Licensed 287 | Material not stated herein are separate from and independent of the terms 288 | and conditions of this Public License. 289 | 290 | Section 8 – Interpretation. 291 | 292 | a. For the avoidance of doubt, this Public License does not, and shall not 293 | be interpreted to, reduce, limit, restrict, or impose conditions on any use 294 | of the Licensed Material that could lawfully be made without permission under 295 | this Public License. 296 | 297 | b. To the extent possible, if any provision of this Public License is deemed 298 | unenforceable, it shall be automatically reformed to the minimum extent necessary 299 | to make it enforceable. If the provision cannot be reformed, it shall be severed 300 | from this Public License without affecting the enforceability of the remaining 301 | terms and conditions. 302 | 303 | c. No term or condition of this Public License will be waived and no failure 304 | to comply consented to unless expressly agreed to by the Licensor. 305 | 306 | d. Nothing in this Public License constitutes or may be interpreted as a limitation 307 | upon, or waiver of, any privileges and immunities that apply to the Licensor 308 | or You, including from the legal processes of any jurisdiction or authority. 309 | 310 | Creative Commons is not a party to its public licenses. Notwithstanding, Creative 311 | Commons may elect to apply one of its public licenses to material it publishes 312 | and in those instances will be considered the "Licensor." The text of the 313 | Creative Commons public licenses is dedicated to the public domain under the 314 | CC0 Public Domain Dedication. Except for the limited purpose of indicating 315 | that material is shared under a Creative Commons public license or as otherwise 316 | permitted by the Creative Commons policies published at creativecommons.org/policies, 317 | Creative Commons does not authorize the use of the trademark "Creative Commons" 318 | or any other trademark or logo of Creative Commons without its prior written 319 | consent including, without limitation, in connection with any unauthorized 320 | modifications to any of its public licenses or any other arrangements, understandings, 321 | or agreements concerning use of licensed material. For the avoidance of doubt, 322 | this paragraph does not form part of the public licenses. 323 | 324 | Creative Commons may be contacted at creativecommons.org. 325 | -------------------------------------------------------------------------------- /LICENSES/MIT.txt: -------------------------------------------------------------------------------- 1 | MIT License Copyright (c) 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is furnished 8 | to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice (including the next 11 | paragraph) shall be included in all copies or substantial portions of the 12 | Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 16 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 17 | OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 18 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF 19 | OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 20 | -------------------------------------------------------------------------------- /LICENSES/Unlicense.txt: -------------------------------------------------------------------------------- 1 | This is free and unencumbered software released into the public domain. 2 | 3 | Anyone is free to copy, modify, publish, use, compile, sell, or distribute 4 | this software, either in source code form or as a compiled binary, for any 5 | purpose, commercial or non-commercial, and by any means. 6 | 7 | In jurisdictions that recognize copyright laws, the author or authors of this 8 | software dedicate any and all copyright interest in the software to the public 9 | domain. We make this dedication for the benefit of the public at large and 10 | to the detriment of our heirs and successors. We intend this dedication to 11 | be an overt act of relinquishment in perpetuity of all present and future 12 | rights to this software under copyright law. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 16 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 17 | BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 18 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH 19 | THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, 20 | please refer to 21 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Introduction 2 | ============ 3 | 4 | 5 | .. image:: https://readthedocs.org/projects/neopxl8/badge/?version=latest 6 | :target: https://docs.circuitpython.org/projects/neopxl8/en/latest/ 7 | :alt: Documentation Status 8 | 9 | 10 | .. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg 11 | :target: https://adafru.it/discord 12 | :alt: Discord 13 | 14 | 15 | .. image:: https://github.com/adafruit/Adafruit_CircuitPython_neopxl8/workflows/Build%20CI/badge.svg 16 | :target: https://github.com/adafruit/Adafruit_CircuitPython_neopxl8/actions 17 | :alt: Build Status 18 | 19 | 20 | .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json 21 | :target: https://github.com/astral-sh/ruff 22 | :alt: Code Style: Ruff 23 | 24 | PIO-driven 8-way concurrent NeoPixel driver for RP2040 25 | 26 | 27 | Dependencies 28 | ============= 29 | This driver depends on: 30 | 31 | * `Adafruit CircuitPython `_ 32 | * `pioasm `_ 33 | 34 | Please ensure all dependencies are available on the CircuitPython filesystem. 35 | This is easily achieved by downloading 36 | `the Adafruit library and driver bundle `_ 37 | or individual libraries can be installed using 38 | `circup `_. 39 | 40 | Installing to a Connected CircuitPython Device with Circup 41 | ========================================================== 42 | 43 | Make sure that you have ``circup`` installed in your Python environment. 44 | Install it with the following command if necessary: 45 | 46 | .. code-block:: shell 47 | 48 | pip3 install circup 49 | 50 | With ``circup`` installed and your CircuitPython device connected use the 51 | following command to install: 52 | 53 | .. code-block:: shell 54 | 55 | circup install adafruit_neopxl8 56 | 57 | Or the following command to update an existing version: 58 | 59 | .. code-block:: shell 60 | 61 | circup update 62 | 63 | Usage Example 64 | ============= 65 | 66 | See the `Examples page `_ for a full example. This example shows how to set up 8 30-pixel LED strands on an Adafruit Feather Scorpio RP2040 and set them all to dim red: 67 | 68 | .. code-block:: python 69 | 70 | import time 71 | import board 72 | from adafruit_neopxl8 import NeoPxl8 73 | 74 | # Customize for your strands here 75 | num_strands = 8 76 | strand_length = 30 77 | first_led_pin = board.NEOPIXEL0 78 | 79 | num_pixels = num_strands * strand_length 80 | 81 | # Make the object to control the pixels 82 | pixels = NeoPxl8( 83 | first_led_pin, 84 | num_pixels, 85 | num_strands=num_strands, 86 | ) 87 | 88 | pixels.fill(0x01_00_00) 89 | 90 | while True: 91 | time.sleep(1) 92 | 93 | 94 | Documentation 95 | ============= 96 | API documentation for this library can be found on `Read the Docs `_. 97 | 98 | For information on building library documentation, please check out 99 | `this guide `_. 100 | 101 | Contributing 102 | ============ 103 | 104 | Contributions are welcome! Please read our `Code of Conduct 105 | `_ 106 | before contributing to help this project stay welcoming. 107 | -------------------------------------------------------------------------------- /README.rst.license: -------------------------------------------------------------------------------- 1 | SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | SPDX-FileCopyrightText: Copyright (c) 2022 Jeff Epler for Adafruit Industries 3 | SPDX-License-Identifier: MIT 4 | -------------------------------------------------------------------------------- /adafruit_neopxl8.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2016 Damien P. George 2 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft for Adafruit Industries 3 | # SPDX-FileCopyrightText: 2019 Carter Nelson 4 | # SPDX-FileCopyrightText: 2019 Roy Hooper 5 | # SPDX-FileCopyrightText: 2022 Jeff Epler 6 | # 7 | # SPDX-License-Identifier: MIT 8 | 9 | """ 10 | `adafruit_neopxl8` - Neopixel strip driver using RP2040's PIO 11 | ============================================================= 12 | 13 | * Author(s): Damien P. George, Scott Shawcroft, Carter Nelson, Roy Hooper, Jeff Epler 14 | """ 15 | 16 | import struct 17 | 18 | import adafruit_pioasm 19 | import adafruit_pixelbuf 20 | import bitops 21 | import rp2pio 22 | 23 | __version__ = "0.0.0+auto.0" 24 | __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_NeoPxl8.git" 25 | 26 | 27 | _PROGRAM = """ 28 | .program piopixl8 29 | top: 30 | mov pins, null ; always-low part (last cycle is the 'pull ifempty' after wrap) 31 | pull block ; wait for fresh data 32 | out y, 32 ; get count of NeoPixel bits 33 | 34 | ; NeoPixels are 800khz bit streams and we run at 16*800kHz. 35 | ; We are choosing zeros as [4,12] ~= <312ns hi, 938 lo> 36 | ; and ones as [9,7] ~= <700ns hi, 546ns lo> and a clock of 16*800kHz, so the always-high 37 | ; time is 4 cycles, the variable time is 5 cycles, and the always-low time is 7 cycles 38 | bitloop: 39 | pull ifempty [4] ; don't start outputting HIGH unless data is available (always-low part) ; low 7 40 | mov pins, ~ null [3] ; always-high part ; high 4 41 | {} ; variable part 42 | mov pins, null ; always-low part (last cycle is the 'pull ifempty' after wrap) ; low: 1 43 | 44 | jmp y--, bitloop ; always-low part ; low: 2 45 | 46 | ; A minimum delay is required so that the next pixel starts refreshing the front of the strands 47 | pull block 48 | out y, 32 49 | 50 | wait_reset: 51 | jmp y--, wait_reset 52 | jmp top 53 | """ 54 | 55 | 56 | # Pixel color order constants 57 | RGB = "RGB" 58 | """Red Green Blue""" 59 | GRB = "GRB" 60 | """Green Red Blue""" 61 | RGBW = "RGBW" 62 | """Red Green Blue White""" 63 | GRBW = "GRBW" 64 | """Green Red Blue White""" 65 | 66 | 67 | class NeoPxl8(adafruit_pixelbuf.PixelBuf): 68 | """ 69 | A sequence of neopixels. 70 | 71 | :param ~microcontroller.Pin data0: The first of 8 data registers, in GPIO order 72 | :param int n: The total number of neopixels. Must be a multiple of the number of strands. 73 | :param int num_strands: The number of strands of neopixels. 74 | :param int bpp: Bytes per pixel. 3 for RGB and 4 for RGBW pixels. 75 | :param float brightness: Brightness of the pixels between 0.0 and 1.0 where 1.0 is full 76 | brightness 77 | :param bool auto_write: True if the neopixels should immediately change when set. If False, 78 | `show` must be called explicitly. 79 | :param str pixel_order: Set the pixel color channel order. GRB or GRBW is 80 | set by default, depending on bpp. 81 | 82 | Example for Adafruit Feather RP2040 Scorpio, sets 240 LEDs in 8 strands to faint red: 83 | 84 | .. code-block:: python 85 | 86 | pixels = adafruit_neopxl8.NeoPxl8(board.NEOPIXEL0, 8*30, num_strands=8, auto_write=False) 87 | pixels.fill(0x010000) 88 | pixels.show() 89 | 90 | .. py:method:: NeoPxl8.show() 91 | 92 | Shows the new colors on the pixels themselves if they haven't already 93 | been autowritten. Note that with NeoPxl8 the show operation takes place 94 | in the background; when this routine returns, the new pixel data has just 95 | started to be written but your Python code can continue operating in the 96 | foreground, updating pixel values or performing other computations. 97 | 98 | .. py:method:: NeoPxl8.fill(color) 99 | 100 | Colors all pixels the given ***color***. 101 | 102 | .. py:attribute:: brightness 103 | 104 | Overall brightness of the pixel (0 to 1.0) 105 | 106 | """ 107 | 108 | def __init__( 109 | self, 110 | data0, 111 | n, 112 | *, 113 | num_strands=8, 114 | bpp=3, 115 | brightness=1.0, 116 | auto_write=True, 117 | pixel_order=None, 118 | ): 119 | if n % num_strands: 120 | raise ValueError("Length must be a multiple of num_strands") 121 | if not pixel_order: 122 | pixel_order = GRB if bpp == 3 else GRBW 123 | elif isinstance(pixel_order, tuple): 124 | order_list = [RGBW[order] for order in pixel_order] 125 | pixel_order = "".join(order_list) 126 | 127 | super().__init__(n, brightness=brightness, byteorder=pixel_order, auto_write=auto_write) 128 | 129 | if num_strands == 1: 130 | data_len = bpp * n 131 | pack = ">L" 132 | osr = False 133 | loop_count = 8 * data_len 134 | else: 135 | data_len = bpp * n * 8 // num_strands 136 | pack = " 28 | 29 | .. toctree:: 30 | :caption: Related Products 31 | 32 | All NeoPixels in the adafruit shop 33 | 34 | .. toctree:: 35 | :caption: Other Links 36 | 37 | Download from GitHub 38 | Download Library Bundle 39 | CircuitPython Reference Documentation 40 | CircuitPython Support Forum 41 | Discord Chat 42 | Adafruit Learning System 43 | Adafruit Blog 44 | Adafruit Store 45 | 46 | Indices and tables 47 | ================== 48 | 49 | * :ref:`genindex` 50 | * :ref:`modindex` 51 | * :ref:`search` 52 | -------------------------------------------------------------------------------- /docs/index.rst.license: -------------------------------------------------------------------------------- 1 | SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | SPDX-FileCopyrightText: Copyright (c) 2022 Jeff Epler for Adafruit Industries 3 | 4 | SPDX-License-Identifier: MIT 5 | -------------------------------------------------------------------------------- /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/neopxl8_animations.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Jeff Epler 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | import adafruit_ticks 6 | import board 7 | import rainbowio 8 | from adafruit_led_animation.animation.comet import Comet 9 | from adafruit_led_animation.group import AnimationGroup 10 | from adafruit_led_animation.helper import PixelMap 11 | 12 | from adafruit_neopxl8 import NeoPxl8 13 | 14 | # Customize for your strands here 15 | num_strands = 8 16 | strand_length = 30 17 | first_led_pin = board.NEOPIXEL0 18 | 19 | num_pixels = num_strands * strand_length 20 | 21 | # Make the object to control the pixels 22 | pixels = NeoPxl8( 23 | first_led_pin, 24 | num_pixels, 25 | num_strands=num_strands, 26 | auto_write=False, 27 | brightness=0.50, 28 | ) 29 | 30 | 31 | def strand(n): 32 | return PixelMap( 33 | pixels, 34 | range(n * strand_length, (n + 1) * strand_length), 35 | individual_pixels=True, 36 | ) 37 | 38 | 39 | # Create the 8 virtual strands 40 | strands = [strand(i) for i in range(num_strands)] 41 | 42 | # For each strand, create a comet animation of a different color 43 | animations = [ 44 | Comet(strand, 0.02, rainbowio.colorwheel(3 * 32 * i), ring=True) 45 | for i, strand in enumerate(strands) 46 | ] 47 | 48 | # Advance the animations by varying amounts so that they become staggered 49 | for i, animation in enumerate(animations): 50 | animation._tail_start = 30 * 5 * i // 8 51 | 52 | # Group them so we can run them all at once 53 | animations = AnimationGroup(*animations) 54 | 55 | # Run the animations and report on the speed in frame per secodn 56 | t0 = adafruit_ticks.ticks_ms() 57 | frame_count = 0 58 | while True: 59 | animations.animate() 60 | frame_count += 1 61 | t1 = adafruit_ticks.ticks_ms() 62 | dt = adafruit_ticks.ticks_diff(t1, t0) 63 | if dt > 1000: 64 | print(f"{frame_count * 1000/dt:.1f}fps") 65 | t0 = t1 66 | frame_count = 0 67 | -------------------------------------------------------------------------------- /examples/neopxl8_multiple_animations.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Tim Cocks 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | import adafruit_ticks 6 | import board 7 | from adafruit_led_animation.animation.chase import Chase 8 | from adafruit_led_animation.animation.comet import Comet 9 | from adafruit_led_animation.animation.pulse import Pulse 10 | from adafruit_led_animation.animation.rainbowchase import RainbowChase 11 | from adafruit_led_animation.animation.rainbowcomet import RainbowComet 12 | from adafruit_led_animation.animation.rainbowsparkle import RainbowSparkle 13 | from adafruit_led_animation.animation.sparkle import Sparkle 14 | from adafruit_led_animation.animation.sparklepulse import SparklePulse 15 | from adafruit_led_animation.color import AMBER, JADE, PURPLE, WHITE 16 | from adafruit_led_animation.group import AnimationGroup 17 | from adafruit_led_animation.helper import PixelMap 18 | 19 | from adafruit_neopxl8 import NeoPxl8 20 | 21 | # Customize for your strands here 22 | num_strands = 8 23 | strand_length = 30 24 | first_led_pin = board.NEOPIXEL0 25 | 26 | num_pixels = num_strands * strand_length 27 | 28 | # Make the object to control the pixels 29 | pixels = NeoPxl8( 30 | first_led_pin, 31 | num_pixels, 32 | num_strands=num_strands, 33 | auto_write=False, 34 | brightness=0.1, 35 | ) 36 | 37 | 38 | def strand(n): 39 | return PixelMap( 40 | pixels, 41 | range(n * strand_length, (n + 1) * strand_length), 42 | individual_pixels=True, 43 | ) 44 | 45 | 46 | # Create the 8 virtual strands 47 | strands = [strand(i) for i in range(num_strands)] 48 | 49 | # For each strand, create a comet animation of a different color 50 | animations = [ 51 | Comet(strands[0], speed=0.01, color=PURPLE, tail_length=10, bounce=True), 52 | Chase(strands[1], speed=0.1, size=3, spacing=6, color=WHITE), 53 | Pulse(strands[2], speed=0.1, period=3, color=AMBER), 54 | Sparkle(strands[3], speed=0.1, color=PURPLE, num_sparkles=10), 55 | SparklePulse(strands[4], speed=0.1, period=3, color=JADE), 56 | RainbowComet(strands[5], speed=0.1, tail_length=7, bounce=True), 57 | RainbowChase(strands[6], speed=0.1, size=3, spacing=2, step=8), 58 | RainbowSparkle(strands[7], speed=0.1, num_sparkles=15), 59 | ] 60 | 61 | # Group them so we can run them all at once 62 | animations = AnimationGroup(*animations) 63 | 64 | # Run the animations and report on the speed in frame per second 65 | t0 = adafruit_ticks.ticks_ms() 66 | frame_count = 0 67 | while True: 68 | animations.animate() 69 | frame_count += 1 70 | t1 = adafruit_ticks.ticks_ms() 71 | dt = adafruit_ticks.ticks_diff(t1, t0) 72 | if dt > 1000: 73 | print(f"{frame_count * 1000/dt:.1f}fps") 74 | t0 = t1 75 | frame_count = 0 76 | -------------------------------------------------------------------------------- /examples/neopxl8_simpletest.py: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2022 Jeff Epler 2 | # 3 | # SPDX-License-Identifier: Unlicense 4 | 5 | import time 6 | 7 | import board 8 | 9 | from adafruit_neopxl8 import NeoPxl8 10 | 11 | # Customize for your strands here 12 | num_strands = 8 13 | strand_length = 30 14 | first_led_pin = board.NEOPIXEL0 15 | 16 | num_pixels = num_strands * strand_length 17 | 18 | # Make the object to control the pixels 19 | pixels = NeoPxl8( 20 | first_led_pin, 21 | num_pixels, 22 | num_strands=num_strands, 23 | auto_write=False, 24 | brightness=1.00, 25 | ) 26 | 27 | while True: 28 | for i in range(num_pixels): 29 | pixels[i] = 0x00_01_00 30 | pixels[i - 8] = 0x00_00_00 31 | pixels.show() 32 | time.sleep(1e-3) 33 | -------------------------------------------------------------------------------- /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, written for Adafruit Industries 2 | # SPDX-FileCopyrightText: Copyright (c) 2022 Jeff Epler for Adafruit Industries 3 | # 4 | # SPDX-License-Identifier: MIT 5 | 6 | [build-system] 7 | requires = [ 8 | "setuptools", 9 | "wheel", 10 | "setuptools-scm", 11 | ] 12 | 13 | [project] 14 | name = "adafruit-circuitpython-neopxl8" 15 | description = "PIO-driven 8-way concurrent NeoPixel driver for RP2040" 16 | version = "0.0.0+auto.0" 17 | readme = "README.rst" 18 | authors = [ 19 | {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} 20 | ] 21 | urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_neopxl8"} 22 | keywords = [ 23 | "adafruit", 24 | "blinka", 25 | "circuitpython", 26 | "micropython", 27 | "neopxl8", 28 | "neopixel", 29 | "rp2040", 30 | "rgb", 31 | "rgbw", 32 | "led", 33 | "animation", 34 | ] 35 | license = {text = "MIT"} 36 | classifiers = [ 37 | "Intended Audience :: Developers", 38 | "Topic :: Software Development :: Libraries", 39 | "Topic :: Software Development :: Embedded Systems", 40 | "Topic :: System :: Hardware", 41 | "License :: OSI Approved :: MIT License", 42 | "Programming Language :: Python :: 3", 43 | ] 44 | dynamic = ["dependencies", "optional-dependencies"] 45 | 46 | [tool.setuptools] 47 | # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, 48 | # CHANGE `py_modules = ['...']` TO `packages = ['...']` 49 | py-modules = ["adafruit_neopxl8"] 50 | 51 | [tool.setuptools.dynamic] 52 | dependencies = {file = ["requirements.txt"]} 53 | optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} 54 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries 2 | # SPDX-FileCopyrightText: Copyright (c) 2022 Jeff Epler for Adafruit Industries 3 | # 4 | # SPDX-License-Identifier: MIT 5 | 6 | Adafruit-Blinka 7 | Adafruit-CircuitPython-pioasm 8 | Adafruit-CircuitPython-PixelBuf 9 | -------------------------------------------------------------------------------- /ruff.toml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries 2 | # 3 | # SPDX-License-Identifier: MIT 4 | 5 | target-version = "py38" 6 | line-length = 100 7 | 8 | [lint] 9 | preview = true 10 | select = ["I", "PL", "UP"] 11 | 12 | extend-select = [ 13 | "D419", # empty-docstring 14 | "E501", # line-too-long 15 | "W291", # trailing-whitespace 16 | "PLC0414", # useless-import-alias 17 | "PLC2401", # non-ascii-name 18 | "PLC2801", # unnecessary-dunder-call 19 | "PLC3002", # unnecessary-direct-lambda-call 20 | "E999", # syntax-error 21 | "PLE0101", # return-in-init 22 | "F706", # return-outside-function 23 | "F704", # yield-outside-function 24 | "PLE0116", # continue-in-finally 25 | "PLE0117", # nonlocal-without-binding 26 | "PLE0241", # duplicate-bases 27 | "PLE0302", # unexpected-special-method-signature 28 | "PLE0604", # invalid-all-object 29 | "PLE0605", # invalid-all-format 30 | "PLE0643", # potential-index-error 31 | "PLE0704", # misplaced-bare-raise 32 | "PLE1141", # dict-iter-missing-items 33 | "PLE1142", # await-outside-async 34 | "PLE1205", # logging-too-many-args 35 | "PLE1206", # logging-too-few-args 36 | "PLE1307", # bad-string-format-type 37 | "PLE1310", # bad-str-strip-call 38 | "PLE1507", # invalid-envvar-value 39 | "PLE2502", # bidirectional-unicode 40 | "PLE2510", # invalid-character-backspace 41 | "PLE2512", # invalid-character-sub 42 | "PLE2513", # invalid-character-esc 43 | "PLE2514", # invalid-character-nul 44 | "PLE2515", # invalid-character-zero-width-space 45 | "PLR0124", # comparison-with-itself 46 | "PLR0202", # no-classmethod-decorator 47 | "PLR0203", # no-staticmethod-decorator 48 | "UP004", # useless-object-inheritance 49 | "PLR0206", # property-with-parameters 50 | "PLR0904", # too-many-public-methods 51 | "PLR0911", # too-many-return-statements 52 | "PLR0912", # too-many-branches 53 | "PLR0913", # too-many-arguments 54 | "PLR0914", # too-many-locals 55 | "PLR0915", # too-many-statements 56 | "PLR0916", # too-many-boolean-expressions 57 | "PLR1702", # too-many-nested-blocks 58 | "PLR1704", # redefined-argument-from-local 59 | "PLR1711", # useless-return 60 | "C416", # unnecessary-comprehension 61 | "PLR1733", # unnecessary-dict-index-lookup 62 | "PLR1736", # unnecessary-list-index-lookup 63 | 64 | # ruff reports this rule is unstable 65 | #"PLR6301", # no-self-use 66 | 67 | "PLW0108", # unnecessary-lambda 68 | "PLW0120", # useless-else-on-loop 69 | "PLW0127", # self-assigning-variable 70 | "PLW0129", # assert-on-string-literal 71 | "B033", # duplicate-value 72 | "PLW0131", # named-expr-without-context 73 | "PLW0245", # super-without-brackets 74 | "PLW0406", # import-self 75 | "PLW0602", # global-variable-not-assigned 76 | "PLW0603", # global-statement 77 | "PLW0604", # global-at-module-level 78 | 79 | # fails on the try: import typing used by libraries 80 | #"F401", # unused-import 81 | 82 | "F841", # unused-variable 83 | "E722", # bare-except 84 | "PLW0711", # binary-op-exception 85 | "PLW1501", # bad-open-mode 86 | "PLW1508", # invalid-envvar-default 87 | "PLW1509", # subprocess-popen-preexec-fn 88 | "PLW2101", # useless-with-lock 89 | "PLW3301", # nested-min-max 90 | ] 91 | 92 | ignore = [ 93 | "PLR2004", # magic-value-comparison 94 | "UP030", # format literals 95 | "PLW1514", # unspecified-encoding 96 | "PLR0913", # too-many-arguments 97 | "PLR0915", # too-many-statements 98 | "PLR0917", # too-many-positional-arguments 99 | "PLR0904", # too-many-public-methods 100 | "PLR0912", # too-many-branches 101 | "PLR0916", # too-many-boolean-expressions 102 | "E501", # line-too-long 103 | ] 104 | 105 | [format] 106 | line-ending = "lf" 107 | --------------------------------------------------------------------------------