diff --git a/.gitignore b/.gitignore index 84b5fba..55873c0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + .eggs/ *.egg-info/ dist diff --git a/.pylintrc b/.pylintrc index 8e9553a..4574fad 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + [MASTER] # A comma-separated list of package or module names from where C extensions may diff --git a/.readthedocs.yml b/.readthedocs.yml index f4243ad..ffa84c4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + python: version: 3 requirements_file: requirements.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 134d510..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge @@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -74,9 +80,9 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Moderators by tagging @community moderators. You may -also send an open message from any channel, or a direct message to -@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..24a8f90 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,20 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and successors. We intend this dedication to +be an overt act of relinquishment in perpetuity of all present and future +rights to this software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, +please refer to diff --git a/README.rst.license b/README.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/README.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/adafruit_circuitplayground/__init__.py b/adafruit_circuitplayground/__init__.py index b6b1112..23f1300 100755 --- a/adafruit_circuitplayground/__init__.py +++ b/adafruit_circuitplayground/__init__.py @@ -1,24 +1,6 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Kattni Rembor for Adafruit Industries # -# Copyright (c) 2019 Kattni Rembor for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT """Verifies which board is being used and imports the appropriate module.""" diff --git a/adafruit_circuitplayground/bluefruit.py b/adafruit_circuitplayground/bluefruit.py index b48feb4..93b13e2 100755 --- a/adafruit_circuitplayground/bluefruit.py +++ b/adafruit_circuitplayground/bluefruit.py @@ -1,24 +1,6 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Kattni Rembor for Adafruit Industries # -# Copyright (c) 2019 Kattni Rembor for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, bluefruit OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT """ `adafruit_circuitplayground.bluefruit` @@ -153,7 +135,7 @@ def loud_sound(self, sound_threshold=200): return self.sound_level > sound_threshold def play_mp3(self, file_name): - """ Play a .mp3 file using the onboard speaker. + """Play a .mp3 file using the onboard speaker. :param file_name: The name of your .mp3 file in quotation marks including .mp3 diff --git a/adafruit_circuitplayground/circuit_playground_base.py b/adafruit_circuitplayground/circuit_playground_base.py index febc396..b639473 100755 --- a/adafruit_circuitplayground/circuit_playground_base.py +++ b/adafruit_circuitplayground/circuit_playground_base.py @@ -1,25 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2016 Scott Shawcroft for Adafruit Industries +# SPDX-FileCopyrightText: 2017-2019 Kattni Rembor for Adafruit Industries # -# Copyright (c) 2016 Scott Shawcroft for Adafruit Industries -# Copyright (c) 2017-2019 Kattni Rembor for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT # We have a lot of attributes for this complex library, as well as a lot of documentation. # pylint: disable=too-many-instance-attributes, too-many-lines @@ -661,7 +643,7 @@ def _generate_sample(self, length=100): self._sine_wave_sample = audiocore.RawSample(self._sine_wave) def play_tone(self, frequency, duration): - """ Produce a tone using the speaker. Try changing frequency to change + """Produce a tone using the speaker. Try changing frequency to change the pitch of the tone. :param int frequency: The frequency of the tone in Hz @@ -684,7 +666,7 @@ def play_tone(self, frequency, duration): self.stop_tone() def start_tone(self, frequency): - """ Produce a tone using the speaker. Try changing frequency to change + """Produce a tone using the speaker. Try changing frequency to change the pitch of the tone. :param int frequency: The frequency of the tone in Hz @@ -717,7 +699,7 @@ def start_tone(self, frequency): self._sample.play(self._sine_wave_sample, loop=True) def stop_tone(self): - """ Use with start_tone to stop the tone produced. + """Use with start_tone to stop the tone produced. .. image :: ../docs/_static/speaker.jpg :alt: Onboard speaker @@ -744,7 +726,7 @@ def stop_tone(self): self._speaker_enable.value = False def play_file(self, file_name): - """ Play a .wav file using the onboard speaker. + """Play a .wav file using the onboard speaker. :param file_name: The name of your .wav file in quotation marks including .wav diff --git a/adafruit_circuitplayground/express.py b/adafruit_circuitplayground/express.py index 73d0f9a..1b16c22 100755 --- a/adafruit_circuitplayground/express.py +++ b/adafruit_circuitplayground/express.py @@ -1,25 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2016 Scott Shawcroft for Adafruit Industries +# SPDX-FileCopyrightText: 2017-2019 Kattni Rembor for Adafruit Industries # -# Copyright (c) 2016 Scott Shawcroft for Adafruit Industries -# Copyright (c) 2017-2019 Kattni Rembor for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT """ `adafruit_circuitplayground.express` @@ -57,7 +39,7 @@ class Express(CircuitPlaygroundBase): """Represents a single CircuitPlayground Express. Do not use more than one at - a time.""" + a time.""" # Touch pad A7 is labeled both A7/TX on Circuit Playground Express and only TX on # the Circuit Playground Bluefruit. It is therefore referred to as TX in the diff --git a/docs/_static/accelerometer.jpg.license b/docs/_static/accelerometer.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/accelerometer.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/button_a.jpg.license b/docs/_static/button_a.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/button_a.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/button_b.jpg.license b/docs/_static/button_b.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/button_b.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/capacitive_touch_pad_A1.jpg.license b/docs/_static/capacitive_touch_pad_A1.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/capacitive_touch_pad_A1.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/capacitive_touch_pad_A2.jpg.license b/docs/_static/capacitive_touch_pad_A2.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/capacitive_touch_pad_A2.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/capacitive_touch_pad_A3.jpg.license b/docs/_static/capacitive_touch_pad_A3.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/capacitive_touch_pad_A3.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/capacitive_touch_pad_A4.jpg.license b/docs/_static/capacitive_touch_pad_A4.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/capacitive_touch_pad_A4.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/capacitive_touch_pad_A5.jpg.license b/docs/_static/capacitive_touch_pad_A5.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/capacitive_touch_pad_A5.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/capacitive_touch_pad_A6.jpg.license b/docs/_static/capacitive_touch_pad_A6.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/capacitive_touch_pad_A6.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/capacitive_touch_pad_A7.jpg.license b/docs/_static/capacitive_touch_pad_A7.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/capacitive_touch_pad_A7.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/capacitive_touch_pads.jpg.license b/docs/_static/capacitive_touch_pads.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/capacitive_touch_pads.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/circuit_playground_bluefruit.jpg.license b/docs/_static/circuit_playground_bluefruit.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/circuit_playground_bluefruit.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/circuit_playground_bluefruit_small.jpg.license b/docs/_static/circuit_playground_bluefruit_small.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/circuit_playground_bluefruit_small.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/circuit_playground_express_small.jpg.license b/docs/_static/circuit_playground_express_small.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/circuit_playground_express_small.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/circuitplayground_express.jpg.license b/docs/_static/circuitplayground_express.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/circuitplayground_express.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/favicon.ico.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/light_sensor.jpg.license b/docs/_static/light_sensor.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/light_sensor.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/microphone.jpg.license b/docs/_static/microphone.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/microphone.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/neopixel_numbering.jpg.license b/docs/_static/neopixel_numbering.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/neopixel_numbering.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/red_led.jpg.license b/docs/_static/red_led.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/red_led.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/slide_switch.jpg.license b/docs/_static/slide_switch.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/slide_switch.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/speaker.jpg.license b/docs/_static/speaker.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/speaker.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/_static/thermistor.jpg.license b/docs/_static/thermistor.jpg.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/thermistor.jpg.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py index 5f84980..f1c70d4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + import os import sys diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/index.rst.license b/docs/index.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/examples/advanced_examples/circuitplayground_acceleration_mapping_neopixels.py b/examples/advanced_examples/circuitplayground_acceleration_mapping_neopixels.py index db47087..bb32bf6 100644 --- a/examples/advanced_examples/circuitplayground_acceleration_mapping_neopixels.py +++ b/examples/advanced_examples/circuitplayground_acceleration_mapping_neopixels.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """Maps acceleration (tilt) to Neopixel colors. x, y, and z acceleration components map to red, green and blue, diff --git a/examples/advanced_examples/circuitplayground_gravity_pulls_pixel.py b/examples/advanced_examples/circuitplayground_gravity_pulls_pixel.py index 6a07598..357dda9 100644 --- a/examples/advanced_examples/circuitplayground_gravity_pulls_pixel.py +++ b/examples/advanced_examples/circuitplayground_gravity_pulls_pixel.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """Gravity Pulls Pixel This program uses the Circuit Playground's accelerometer to position diff --git a/examples/advanced_examples/circuitplayground_tilting_arpeggios.py b/examples/advanced_examples/circuitplayground_tilting_arpeggios.py index 178b82c..71fbfd8 100644 --- a/examples/advanced_examples/circuitplayground_tilting_arpeggios.py +++ b/examples/advanced_examples/circuitplayground_tilting_arpeggios.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """Tilting Arpeggios This program plays notes from arpeggios in a circle of fourths. Y-axis tilt chooses the note. diff --git a/examples/circuitplayground_acceleration.py b/examples/circuitplayground_acceleration.py index 6b3d618..839d945 100644 --- a/examples/circuitplayground_acceleration.py +++ b/examples/circuitplayground_acceleration.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example uses the accelerometer on the Circuit Playground. It prints the values. Try moving the board to see the values change. If you're using Mu, open the plotter to see the values plotted. diff --git a/examples/circuitplayground_acceleration_neopixels.py b/examples/circuitplayground_acceleration_neopixels.py index ddcb071..d0efcf8 100644 --- a/examples/circuitplayground_acceleration_neopixels.py +++ b/examples/circuitplayground_acceleration_neopixels.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """If the switch is to the right, it will appear that nothing is happening. Move the switch to the left to see the NeoPixels light up in colors related to the accelerometer! The Circuit Playground has an accelerometer in the center that returns (x, y, z) acceleration values. This program uses diff --git a/examples/circuitplayground_bluefruit_loud_sound.py b/examples/circuitplayground_bluefruit_loud_sound.py index 198f3be..20ea3b7 100644 --- a/examples/circuitplayground_bluefruit_loud_sound.py +++ b/examples/circuitplayground_bluefruit_loud_sound.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example lights up the NeoPixels on a Circuit Playground Bluefruit in response to a loud sound. Try snapping or clapping near the board to trigger the LEDs. diff --git a/examples/circuitplayground_bluefruit_loud_sound_threshold.py b/examples/circuitplayground_bluefruit_loud_sound_threshold.py index e982f87..81e882a 100644 --- a/examples/circuitplayground_bluefruit_loud_sound_threshold.py +++ b/examples/circuitplayground_bluefruit_loud_sound_threshold.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example lights up the NeoPixels on a Circuit Playground Bluefruit in response to a loud sound. Try snapping or clapping near the board to trigger the LEDs. diff --git a/examples/circuitplayground_bluefruit_play_mp3.py b/examples/circuitplayground_bluefruit_play_mp3.py index eccfb94..369fa69 100644 --- a/examples/circuitplayground_bluefruit_play_mp3.py +++ b/examples/circuitplayground_bluefruit_play_mp3.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example plays mp3 audio files from the built-in speaker when the A or B buttons are pressed. diff --git a/examples/circuitplayground_bluefruit_sound_level.py b/examples/circuitplayground_bluefruit_sound_level.py index d12d992..280487a 100644 --- a/examples/circuitplayground_bluefruit_sound_level.py +++ b/examples/circuitplayground_bluefruit_sound_level.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example prints out sound levels using the sound sensor on a Circuit Playground Bluefruit. Try making sounds towards the board to see the values change. diff --git a/examples/circuitplayground_bluefruit_sound_level_plotter.py b/examples/circuitplayground_bluefruit_sound_level_plotter.py index d3d1e08..eb21ec7 100644 --- a/examples/circuitplayground_bluefruit_sound_level_plotter.py +++ b/examples/circuitplayground_bluefruit_sound_level_plotter.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example prints out sound levels using the sound sensor on a Circuit Playground Bluefruit. If you are using Mu, open the plotter to see the sound level plotted. Try making sounds towards the diff --git a/examples/circuitplayground_button_a.py b/examples/circuitplayground_button_a.py index 6e7e703..f12cf25 100644 --- a/examples/circuitplayground_button_a.py +++ b/examples/circuitplayground_button_a.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example turns on the little red LED when button A is pressed.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_button_b.py b/examples/circuitplayground_button_b.py index d70cabe..2efab1c 100644 --- a/examples/circuitplayground_button_b.py +++ b/examples/circuitplayground_button_b.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example turns the little red LED on only while button B is currently being pressed.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_buttons_1_neopixel.py b/examples/circuitplayground_buttons_1_neopixel.py index 957e538..26a6108 100644 --- a/examples/circuitplayground_buttons_1_neopixel.py +++ b/examples/circuitplayground_buttons_1_neopixel.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example lights up the third NeoPixel while button A is being pressed, and lights up the eighth NeoPixel while button B is being pressed.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_buttons_neopixels.py b/examples/circuitplayground_buttons_neopixels.py index b50e4c9..d633186 100644 --- a/examples/circuitplayground_buttons_neopixels.py +++ b/examples/circuitplayground_buttons_neopixels.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example lights up half the NeoPixels red while button A is being pressed, and half the NeoPixels green while button B is being pressed.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_ir_receive.py b/examples/circuitplayground_ir_receive.py index bcac5dd..eb75d0f 100644 --- a/examples/circuitplayground_ir_receive.py +++ b/examples/circuitplayground_ir_receive.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """THIS EXAMPLE REQUIRES A SEPARATE LIBRARY BE LOADED ONTO YOUR CIRCUITPY DRIVE. This example requires the adafruit_irremote.mpy library. @@ -14,10 +17,10 @@ # Create a 'pulseio' input, to listen to infrared signals on the IR receiver try: pulsein = pulseio.PulseIn(board.IR_RX, maxlen=120, idle_state=True) -except AttributeError: +except AttributeError as err: raise NotImplementedError( "This example does not work with Circuit Playground Bluefruti!" - ) + ) from err # Create a decoder that will take pulses and turn them into numbers decoder = adafruit_irremote.GenericDecode() diff --git a/examples/circuitplayground_ir_transmit.py b/examples/circuitplayground_ir_transmit.py index cc9fa02..161c751 100644 --- a/examples/circuitplayground_ir_transmit.py +++ b/examples/circuitplayground_ir_transmit.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """THIS EXAMPLE REQUIRES A SEPARATE LIBRARY BE LOADED ONTO YOUR CIRCUITPY DRIVE. This example requires the adafruit_irremote.mpy library. @@ -15,10 +18,10 @@ # Create a 'pulseio' output, to send infrared signals from the IR transmitter try: pwm = pulseio.PWMOut(board.IR_TX, frequency=38000, duty_cycle=2 ** 15) -except AttributeError: +except AttributeError as err: raise NotImplementedError( "This example does not work with Circuit Playground Bluefruit!" - ) + ) from err pulseout = pulseio.PulseOut(pwm) # pylint: disable=no-member # Create an encoder that will take numbers and turn them into NEC IR pulses encoder = adafruit_irremote.GenericTransmit( diff --git a/examples/circuitplayground_light.py b/examples/circuitplayground_light.py index 35787d7..e626b35 100644 --- a/examples/circuitplayground_light.py +++ b/examples/circuitplayground_light.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example uses the light sensor on your Circuit Playground, located next to the picture of the eye. Try shining a flashlight on your Circuit Playground, or covering the light sensor with your finger to see the values increase and decrease.""" diff --git a/examples/circuitplayground_light_neopixels.py b/examples/circuitplayground_light_neopixels.py index 68b9edf..d2f9f7f 100644 --- a/examples/circuitplayground_light_neopixels.py +++ b/examples/circuitplayground_light_neopixels.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example uses the light sensor on the Circuit Playground, located next to the picture of the eye on the board. Once you have the library loaded, try shining a flashlight on your Circuit diff --git a/examples/circuitplayground_light_plotter.py b/examples/circuitplayground_light_plotter.py index 3178928..920d95a 100644 --- a/examples/circuitplayground_light_plotter.py +++ b/examples/circuitplayground_light_plotter.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """If you're using Mu, this example will plot the light levels from the light sensor (located next to the eye) on your Circuit Playground. Try shining a flashlight on your Circuit Playground, or covering the light sensor to see the plot increase and decrease.""" diff --git a/examples/circuitplayground_neopixel_0.py b/examples/circuitplayground_neopixel_0.py index 2b2e8f1..ae16b93 100644 --- a/examples/circuitplayground_neopixel_0.py +++ b/examples/circuitplayground_neopixel_0.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example lights up the first NeoPixel red.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_neopixel_0_1.py b/examples/circuitplayground_neopixel_0_1.py index cc01d7b..77ed331 100644 --- a/examples/circuitplayground_neopixel_0_1.py +++ b/examples/circuitplayground_neopixel_0_1.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example lights up the first and second NeoPixel, red and blue respectively.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_neopixels_fill.py b/examples/circuitplayground_neopixels_fill.py index 640cf94..fce738d 100644 --- a/examples/circuitplayground_neopixels_fill.py +++ b/examples/circuitplayground_neopixels_fill.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example lights up all the NeoPixel LEDs red.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_pixels_simpletest.py b/examples/circuitplayground_pixels_simpletest.py index db11678..f3c8f69 100644 --- a/examples/circuitplayground_pixels_simpletest.py +++ b/examples/circuitplayground_pixels_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example lights up the NeoPixels with a rainbow swirl.""" import time from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_play_file.py b/examples/circuitplayground_play_file.py index dacced5..2ffe480 100644 --- a/examples/circuitplayground_play_file.py +++ b/examples/circuitplayground_play_file.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """THIS EXAMPLE REQUIRES A WAV FILE FROM THE examples FOLDER IN THE Adafruit_CircuitPython_CircuitPlayground REPO found at: https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/tree/master/examples diff --git a/examples/circuitplayground_play_file_buttons.py b/examples/circuitplayground_play_file_buttons.py index 2283b21..f5efae0 100644 --- a/examples/circuitplayground_play_file_buttons.py +++ b/examples/circuitplayground_play_file_buttons.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """THIS EXAMPLE REQUIRES A WAV FILE FROM THE examples FOLDER IN THE Adafruit_CircuitPython_CircuitPlayground REPO found at: https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/tree/master/examples diff --git a/examples/circuitplayground_play_tone.py b/examples/circuitplayground_play_tone.py index e72ccdf..855ebe1 100644 --- a/examples/circuitplayground_play_tone.py +++ b/examples/circuitplayground_play_tone.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example plays two tones for 1 second each. Note that the tones are not in a loop - this is to prevent them from playing indefinitely!""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_play_tone_buttons.py b/examples/circuitplayground_play_tone_buttons.py index 5e0d571..3b29037 100644 --- a/examples/circuitplayground_play_tone_buttons.py +++ b/examples/circuitplayground_play_tone_buttons.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example plays a different tone for a duration of 1 second for each button pressed.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_red_led.py b/examples/circuitplayground_red_led.py index e703511..d0594dd 100644 --- a/examples/circuitplayground_red_led.py +++ b/examples/circuitplayground_red_led.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example turns on the little red LED.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_red_led_blinky.py b/examples/circuitplayground_red_led_blinky.py index b8cdc40..114a59f 100644 --- a/examples/circuitplayground_red_led_blinky.py +++ b/examples/circuitplayground_red_led_blinky.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This is the "Hello, world!" of CircuitPython: Blinky! This example blinks the little red LED on and off!""" import time diff --git a/examples/circuitplayground_red_led_blnky_short.py b/examples/circuitplayground_red_led_blnky_short.py index f996536..d8af7bf 100644 --- a/examples/circuitplayground_red_led_blnky_short.py +++ b/examples/circuitplayground_red_led_blnky_short.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This is the "Hello, world!" of CircuitPython: Blinky! This example blinks the little red LED on and off! It's a shorter version of the other Blinky example.""" import time diff --git a/examples/circuitplayground_shake.py b/examples/circuitplayground_shake.py index 984f441..e2971e1 100644 --- a/examples/circuitplayground_shake.py +++ b/examples/circuitplayground_shake.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example prints to the serial console when the Circuit Playground is shaken.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_shake_red_led.py b/examples/circuitplayground_shake_red_led.py index 7399680..d82818a 100644 --- a/examples/circuitplayground_shake_red_led.py +++ b/examples/circuitplayground_shake_red_led.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example flashes the little red LED when the Circuit Playground is shaken.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_slide_switch.py b/examples/circuitplayground_slide_switch.py index a2de767..3531a1c 100644 --- a/examples/circuitplayground_slide_switch.py +++ b/examples/circuitplayground_slide_switch.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example prints the status of the slide switch. Try moving the switch back and forth to see what's printed to the serial console!""" import time diff --git a/examples/circuitplayground_slide_switch_red_led.py b/examples/circuitplayground_slide_switch_red_led.py index 03f5892..8e50a04 100644 --- a/examples/circuitplayground_slide_switch_red_led.py +++ b/examples/circuitplayground_slide_switch_red_led.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example uses the slide switch to control the little red LED.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_slide_switch_red_led_short.py b/examples/circuitplayground_slide_switch_red_led_short.py index 9c06cbc..52666dd 100644 --- a/examples/circuitplayground_slide_switch_red_led_short.py +++ b/examples/circuitplayground_slide_switch_red_led_short.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example uses the slide switch to control the little red LED. When the switch is to the right it returns False, and when it's to the left, it returns True.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_sound_meter.py b/examples/circuitplayground_sound_meter.py index e2736b5..2567d8d 100644 --- a/examples/circuitplayground_sound_meter.py +++ b/examples/circuitplayground_sound_meter.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example uses the sound sensor, located next to the picture of the ear on your board, to light up the NeoPixels as a sound meter. Try talking to your Circuit Playground or clapping, etc, to see the NeoPixels light up!""" diff --git a/examples/circuitplayground_tap_red_led.py b/examples/circuitplayground_tap_red_led.py index 04d129e..d51185d 100644 --- a/examples/circuitplayground_tap_red_led.py +++ b/examples/circuitplayground_tap_red_led.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example turns on the little red LED and prints to the serial console when you double-tap the Circuit Playground!""" import time diff --git a/examples/circuitplayground_tapdetect.py b/examples/circuitplayground_tapdetect.py index e32aa39..bc03909 100644 --- a/examples/circuitplayground_tapdetect.py +++ b/examples/circuitplayground_tapdetect.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example prints to the serial console when the board is double-tapped.""" import time from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_tapdetect_single_double.py b/examples/circuitplayground_tapdetect_single_double.py index c1da0bd..63e6994 100644 --- a/examples/circuitplayground_tapdetect_single_double.py +++ b/examples/circuitplayground_tapdetect_single_double.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example shows how you can use single-tap and double-tap together with a delay between. Single-tap the board twice and then double-tap the board twice to complete the program.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_temperature.py b/examples/circuitplayground_temperature.py index e9b083a..ec5c945 100644 --- a/examples/circuitplayground_temperature.py +++ b/examples/circuitplayground_temperature.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example uses the temperature sensor on the Circuit Playground, located next to the image of a thermometer on the board. It prints the temperature in both C and F to the serial console. Try putting your finger over the sensor to see the numbers change!""" diff --git a/examples/circuitplayground_temperature_neopixels.py b/examples/circuitplayground_temperature_neopixels.py index aa8a9c7..6f219ae 100644 --- a/examples/circuitplayground_temperature_neopixels.py +++ b/examples/circuitplayground_temperature_neopixels.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example use the temperature sensor on the Circuit Playground, located next to the picture of the thermometer on the board. Try warming up the board to watch the number of NeoPixels lit up diff --git a/examples/circuitplayground_temperature_plotter.py b/examples/circuitplayground_temperature_plotter.py index 3d52c01..edb1627 100644 --- a/examples/circuitplayground_temperature_plotter.py +++ b/examples/circuitplayground_temperature_plotter.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """If you're using Mu, this example will plot the temperature in C and F on the plotter! Click "Plotter" to open it, and place your finger over the sensor to see the numbers change. The sensor is located next to the picture of the thermometer on the CPX.""" diff --git a/examples/circuitplayground_tone.py b/examples/circuitplayground_tone.py index 7390e04..97b6030 100644 --- a/examples/circuitplayground_tone.py +++ b/examples/circuitplayground_tone.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example plays a different tone for each button, while the button is pressed.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_touch_a1.py b/examples/circuitplayground_touch_a1.py index 73535ab..b026e04 100644 --- a/examples/circuitplayground_touch_a1.py +++ b/examples/circuitplayground_touch_a1.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example prints to the serial console when you touch capacitive touch pad A1.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_touch_all.py b/examples/circuitplayground_touch_all.py index 7963151..a8a3b3f 100644 --- a/examples/circuitplayground_touch_all.py +++ b/examples/circuitplayground_touch_all.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example prints to the serial console when you touch the capacitive touch pads.""" from adafruit_circuitplayground import cp diff --git a/examples/circuitplayground_touch_pixel_fill_rainbow.py b/examples/circuitplayground_touch_pixel_fill_rainbow.py index 667a688..cef84ce 100644 --- a/examples/circuitplayground_touch_pixel_fill_rainbow.py +++ b/examples/circuitplayground_touch_pixel_fill_rainbow.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example uses the capacitive touch pads on the Circuit Playground. They are located around the outer edge of the board and are labeled A1-A6 and TX. (A0 is not a touch pad.) This example lights up all the NeoPixels a different color of the rainbow for each pad touched!""" diff --git a/examples/circuitplayground_touch_pixel_rainbow.py b/examples/circuitplayground_touch_pixel_rainbow.py index 276a5f7..daeb003 100644 --- a/examples/circuitplayground_touch_pixel_rainbow.py +++ b/examples/circuitplayground_touch_pixel_rainbow.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example uses the capacitive touch pads on the Circuit Playground. They are located around the outer edge of the board and are labeled A1-A6 and TX. (A0 is not a touch pad.) This example lights up the nearest NeoPixel to that pad a different color of the rainbow!""" diff --git a/examples/dip.mp3.license b/examples/dip.mp3.license new file mode 100644 index 0000000..a784acf --- /dev/null +++ b/examples/dip.mp3.license @@ -0,0 +1,2 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT diff --git a/examples/dip.wav.license b/examples/dip.wav.license new file mode 100644 index 0000000..a784acf --- /dev/null +++ b/examples/dip.wav.license @@ -0,0 +1,2 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT diff --git a/examples/rise.mp3.license b/examples/rise.mp3.license new file mode 100644 index 0000000..a784acf --- /dev/null +++ b/examples/rise.mp3.license @@ -0,0 +1,2 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT diff --git a/examples/rise.wav.license b/examples/rise.wav.license new file mode 100644 index 0000000..a784acf --- /dev/null +++ b/examples/rise.wav.license @@ -0,0 +1,2 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT diff --git a/requirements.txt b/requirements.txt index 8b13789..e69de29 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +0,0 @@ - diff --git a/setup.py.disabled b/setup.py.disabled index a80b9bf..78b5cc4 100644 --- a/setup.py.disabled +++ b/setup.py.disabled @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """ This library is not deployed to PyPI. It is either a board-specific helper library, or does not make sense for use on or is incompatible with single board computers and Linux.