From d83ec3733d0fa36ddc1608b79dfc731aa268950e Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 14 Jan 2021 13:40:36 -0500 Subject: [PATCH] Ran pre-commit, added licenses --- .gitignore | 6 +- .pylintrc | 4 + .readthedocs.yml | 4 + CODE_OF_CONDUCT.md | 14 +- LICENSES/CC-BY-4.0.txt | 324 ++++++++++++++++++ LICENSES/CC-BY-SA-4.0.txt | 108 ++++++ LICENSES/MIT.txt | 19 + LICENSES/Unlicense.txt | 20 ++ README.rst.license | 3 + adafruit_featherwing/alphanum_featherwing.py | 27 +- adafruit_featherwing/dotstar_featherwing.py | 33 +- adafruit_featherwing/gps_featherwing.py | 27 +- adafruit_featherwing/ina219_featherwing.py | 107 +++--- adafruit_featherwing/joy_featherwing.py | 171 +++++---- adafruit_featherwing/keyboard_featherwing.py | 27 +- adafruit_featherwing/led_segments.py | 27 +- adafruit_featherwing/matrix_featherwing.py | 27 +- adafruit_featherwing/minitft_featherwing.py | 27 +- adafruit_featherwing/neopixel_featherwing.py | 31 +- adafruit_featherwing/pixelmatrix.py | 25 +- adafruit_featherwing/rtc_featherwing.py | 27 +- .../sevensegment_featherwing.py | 27 +- .../tempmotion_featherwing.py | 27 +- adafruit_featherwing/tft_featherwing_24.py | 28 +- docs/_static/favicon.ico.license | 3 + .../ina219_featherwing.jpg.license | 3 + .../joy_featherwing_a.jpg.license | 3 + .../joy_featherwing_b.jpg.license | 3 + .../joy_featherwing_joystick.jpg.license | 3 + .../joy_featherwing_select.jpg.license | 3 + .../joy_featherwing_x.jpg.license | 3 + .../joy_featherwing_y.jpg.license | 3 + docs/api.rst.license | 3 + docs/conf.py | 4 + docs/examples.rst.license | 3 + docs/index.rst.license | 3 + examples/featherwing_alphanum_simpletest.py | 3 + .../featherwing_dotstar_palette_example.py | 3 + examples/featherwing_dotstar_simpletest.py | 3 + examples/featherwing_gps_simpletest.py | 3 + examples/featherwing_ina219_simpletest.py | 3 + examples/featherwing_joy_simpletest.py | 3 + examples/featherwing_keyboard_featherwing.py | 3 + examples/featherwing_matrix_simpletest.py | 3 + examples/featherwing_minitft_simpletest.py | 3 + .../featherwing_neopixel_palette_example.py | 3 + examples/featherwing_neopixel_simpletest.py | 3 + examples/featherwing_rtc_simpletest.py | 3 + .../featherwing_sevensegment_simpletest.py | 3 + examples/featherwing_tempmotion_simpletest.py | 3 + examples/featherwing_tft24_simpletest.py | 3 + requirements.txt | 4 + setup.py | 4 + 53 files changed, 779 insertions(+), 451 deletions(-) create mode 100644 LICENSES/CC-BY-4.0.txt create mode 100644 LICENSES/CC-BY-SA-4.0.txt create mode 100644 LICENSES/MIT.txt create mode 100644 LICENSES/Unlicense.txt create mode 100644 README.rst.license create mode 100644 docs/_static/favicon.ico.license create mode 100644 docs/_static/ina219_featherwing/ina219_featherwing.jpg.license create mode 100644 docs/_static/joy_featherwing/joy_featherwing_a.jpg.license create mode 100644 docs/_static/joy_featherwing/joy_featherwing_b.jpg.license create mode 100644 docs/_static/joy_featherwing/joy_featherwing_joystick.jpg.license create mode 100644 docs/_static/joy_featherwing/joy_featherwing_select.jpg.license create mode 100644 docs/_static/joy_featherwing/joy_featherwing_x.jpg.license create mode 100644 docs/_static/joy_featherwing/joy_featherwing_y.jpg.license create mode 100644 docs/api.rst.license create mode 100644 docs/examples.rst.license create mode 100644 docs/index.rst.license diff --git a/.gitignore b/.gitignore index c83f8b7..9647e71 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + *.mpy .idea __pycache__ @@ -8,4 +12,4 @@ bundles *.DS_Store .eggs dist -**/*.egg-info \ No newline at end of file +**/*.egg-info diff --git a/.pylintrc b/.pylintrc index d8f0ee8..5c31f66 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + [MASTER] # A comma-separated list of package or module names from where C extensions may diff --git a/.readthedocs.yml b/.readthedocs.yml index f4243ad..ffa84c4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + python: version: 3 requirements_file: requirements.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 134d510..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge @@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -74,9 +80,9 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Moderators by tagging @community moderators. You may -also send an open message from any channel, or a direct message to -@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/CC-BY-SA-4.0.txt b/LICENSES/CC-BY-SA-4.0.txt new file mode 100644 index 0000000..8a0f891 --- /dev/null +++ b/LICENSES/CC-BY-SA-4.0.txt @@ -0,0 +1,108 @@ +Text +Creative Commons Attribution-ShareAlike 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-ShareAlike 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-ShareAlike 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. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License. +d. 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. +e. 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. +f. 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. +g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike. +h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. +i. 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. +j. Licensor means the individual(s) or entity(ies) granting rights under this Public License. +k. 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. +l. 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. +m. 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. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter's License You apply. +C. 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. +b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. +1. The Adapter's License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. +2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. +3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply. +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, including for purposes of Section 3(b); 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_featherwing/alphanum_featherwing.py b/adafruit_featherwing/alphanum_featherwing.py index 19a1928..c458641 100755 --- a/adafruit_featherwing/alphanum_featherwing.py +++ b/adafruit_featherwing/alphanum_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.alphanum_featherwing` ==================================================== @@ -38,9 +21,9 @@ class AlphaNumFeatherWing(Segments): """Class representing an `Adafruit 14-segment AlphaNumeric FeatherWing - `_. + `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" def __init__(self, address=0x70, i2c=None): super().__init__() diff --git a/adafruit_featherwing/dotstar_featherwing.py b/adafruit_featherwing/dotstar_featherwing.py index b9cd15b..d161f47 100755 --- a/adafruit_featherwing/dotstar_featherwing.py +++ b/adafruit_featherwing/dotstar_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.dotstar_featherwing` ==================================================== @@ -38,15 +21,15 @@ class DotStarFeatherWing(PixelMatrix): """Class representing a `DotStar FeatherWing - `_. + `_. - The feather uses pins D13 and D11""" + The feather uses pins D13 and D11""" def __init__(self, clock=board.D13, data=board.D11, brightness=0.2): """ - :param pin clock: The clock pin for the featherwing - :param pin data: The data pin for the featherwing - :param float brightness: Optional brightness (0.0-1.0) that defaults to 1.0 + :param pin clock: The clock pin for the featherwing + :param pin data: The data pin for the featherwing + :param float brightness: Optional brightness (0.0-1.0) that defaults to 1.0 """ super().__init__() self.rows = 6 diff --git a/adafruit_featherwing/gps_featherwing.py b/adafruit_featherwing/gps_featherwing.py index 84ae974..1b43153 100644 --- a/adafruit_featherwing/gps_featherwing.py +++ b/adafruit_featherwing/gps_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.gps_featherwing` ==================================================== @@ -38,9 +21,9 @@ class GPSFeatherWing: """Class representing an `Ultimate GPS FeatherWing - `_. + `_. - Automatically uses the feather's UART bus.""" + Automatically uses the feather's UART bus.""" def __init__(self, update_period=1000, baudrate=9600): """ diff --git a/adafruit_featherwing/ina219_featherwing.py b/adafruit_featherwing/ina219_featherwing.py index 517f724..b43414d 100644 --- a/adafruit_featherwing/ina219_featherwing.py +++ b/adafruit_featherwing/ina219_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2018 Kattni Rembor for Adafruit Industries # -# Copyright (c) 2018 Kattni Rembor for Adafruit Industries LLC -# -# 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_featherwing.ina219_featherwing` ==================================================== @@ -37,9 +20,9 @@ class INA219FeatherWing: """Class representing an `Adafruit INA219 FeatherWing - `_. + `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" def __init__(self, i2c=None): if i2c is None: @@ -50,21 +33,21 @@ def __init__(self, i2c=None): def bus_voltage(self): """Bus voltage returns volts. - .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg - :alt: INA219 Featherwing + .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg + :alt: INA219 Featherwing - This example prints the bus voltage with the appropriate units. + This example prints the bus voltage with the appropriate units. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import ina219_featherwing - import time + from adafruit_featherwing import ina219_featherwing + import time - ina219 = ina219_featherwing.INA219FeatherWing() + ina219 = ina219_featherwing.INA219FeatherWing() - while True: - print("Bus Voltage: {} V".format(ina219.bus_voltage)) - time.sleep(0.5) + while True: + print("Bus Voltage: {} V".format(ina219.bus_voltage)) + time.sleep(0.5) """ return self._ina219.bus_voltage @@ -73,21 +56,21 @@ def bus_voltage(self): def shunt_voltage(self): """Shunt voltage returns volts. - .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg - :alt: INA219 Featherwing + .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg + :alt: INA219 Featherwing - This example prints the shunt voltage with the appropriate units. + This example prints the shunt voltage with the appropriate units. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import ina219_featherwing - import time + from adafruit_featherwing import ina219_featherwing + import time - ina219 = ina219_featherwing.INA219FeatherWing() + ina219 = ina219_featherwing.INA219FeatherWing() - while True: - print("Shunt Voltage: {} V".format(ina219.shunt_voltage)) - time.sleep(0.5) + while True: + print("Shunt Voltage: {} V".format(ina219.shunt_voltage)) + time.sleep(0.5) """ return self._ina219.shunt_voltage @@ -96,21 +79,21 @@ def shunt_voltage(self): def voltage(self): """Voltage, known as load voltage, is bus voltage plus shunt voltage. Returns volts. - .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg - :alt: INA219 Featherwing + .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg + :alt: INA219 Featherwing - This example prints the voltage with the appropriate units. + This example prints the voltage with the appropriate units. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import ina219_featherwing - import time + from adafruit_featherwing import ina219_featherwing + import time - ina219 = ina219_featherwing.INA219FeatherWing() + ina219 = ina219_featherwing.INA219FeatherWing() - while True: - print("Voltage: {} V".format(ina219.voltage)) - time.sleep(0.5) + while True: + print("Voltage: {} V".format(ina219.voltage)) + time.sleep(0.5) """ voltage = self._ina219.bus_voltage + self._ina219.shunt_voltage @@ -120,21 +103,21 @@ def voltage(self): def current(self): """Current returns mA. - .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg - :alt: INA219 Featherwing + .. image :: ../docs/_static/ina219_featherwing/ina219_featherwing.jpg + :alt: INA219 Featherwing - This example prints the current with the appropriate units. + This example prints the current with the appropriate units. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import ina219_featherwing - import time + from adafruit_featherwing import ina219_featherwing + import time - ina219 = ina219_featherwing.INA219FeatherWing() + ina219 = ina219_featherwing.INA219FeatherWing() - while True: - print("Current: {} mA".format(ina219.current)) - time.sleep(0.5) + while True: + print("Current: {} mA".format(ina219.current)) + time.sleep(0.5) """ return self._ina219.current diff --git a/adafruit_featherwing/joy_featherwing.py b/adafruit_featherwing/joy_featherwing.py index 5faba66..faf9cb8 100644 --- a/adafruit_featherwing/joy_featherwing.py +++ b/adafruit_featherwing/joy_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2018 Kattni Rembor for Adafruit Industries # -# Copyright (c) 2018 Kattni Rembor for Adafruit Industries LLC -# -# 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_featherwing.joy_featherwing` ==================================================== @@ -45,7 +28,7 @@ class JoyFeatherWing: """Class representing an `Adafruit Joy FeatherWing `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" def __init__(self, i2c=None): if i2c is None: @@ -63,21 +46,21 @@ def __init__(self, i2c=None): def button_a(self): """Joy featherwing button A. - .. image :: ../docs/_static/joy_featherwing/joy_featherwing_a.jpg - :alt: Joy FeatherWing Button A + .. image :: ../docs/_static/joy_featherwing/joy_featherwing_a.jpg + :alt: Joy FeatherWing Button A - This example prints when button A is pressed. + This example prints when button A is pressed. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import joy_featherwing - import time + from adafruit_featherwing import joy_featherwing + import time - wing = joy_featherwing.JoyFeatherWing() + wing = joy_featherwing.JoyFeatherWing() - while True: - if wing.button_a: - print("Button A pressed!") + while True: + if wing.button_a: + print("Button A pressed!") """ return self._check_button(BUTTON_A) @@ -86,21 +69,21 @@ def button_a(self): def button_b(self): """Joy featherwing button B. - .. image :: ../docs/_static/joy_featherwing/joy_featherwing_b.jpg - :alt: Joy FeatherWing Button B + .. image :: ../docs/_static/joy_featherwing/joy_featherwing_b.jpg + :alt: Joy FeatherWing Button B - This example prints when button B is pressed. + This example prints when button B is pressed. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import joy_featherwing - import time + from adafruit_featherwing import joy_featherwing + import time - wing = joy_featherwing.JoyFeatherWing() + wing = joy_featherwing.JoyFeatherWing() - while True: - if wing.button_b: - print("Button B pressed!") + while True: + if wing.button_b: + print("Button B pressed!") """ return self._check_button(BUTTON_B) @@ -109,21 +92,21 @@ def button_b(self): def button_x(self): """Joy featherwing button X. - .. image :: ../docs/_static/joy_featherwing/joy_featherwing_x.jpg - :alt: Joy FeatherWing Button X + .. image :: ../docs/_static/joy_featherwing/joy_featherwing_x.jpg + :alt: Joy FeatherWing Button X - This example prints when button X is pressed. + This example prints when button X is pressed. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import joy_featherwing - import time + from adafruit_featherwing import joy_featherwing + import time - wing = joy_featherwing.JoyFeatherWing() + wing = joy_featherwing.JoyFeatherWing() - while True: - if wing.button_x: - print("Button X pressed!") + while True: + if wing.button_x: + print("Button X pressed!") """ return self._check_button(BUTTON_X) @@ -132,21 +115,21 @@ def button_x(self): def button_y(self): """Joy featherwing button Y. - .. image :: ../docs/_static/joy_featherwing/joy_featherwing_y.jpg - :alt: Joy FeatherWing Button Y + .. image :: ../docs/_static/joy_featherwing/joy_featherwing_y.jpg + :alt: Joy FeatherWing Button Y - This example prints when button Y is pressed. + This example prints when button Y is pressed. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import joy_featherwing - import time + from adafruit_featherwing import joy_featherwing + import time - wing = joy_featherwing.JoyFeatherWing() + wing = joy_featherwing.JoyFeatherWing() - while True: - if wing.button_y: - print("Button Y pressed!") + while True: + if wing.button_y: + print("Button Y pressed!") """ return self._check_button(BUTTON_Y) @@ -155,21 +138,21 @@ def button_y(self): def button_select(self): """Joy featherwing button SELECT. - .. image :: ../docs/_static/joy_featherwing/joy_featherwing_select.jpg - :alt: Joy FeatherWing Button SELECT + .. image :: ../docs/_static/joy_featherwing/joy_featherwing_select.jpg + :alt: Joy FeatherWing Button SELECT - This example prints when button SELECT is pressed. + This example prints when button SELECT is pressed. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import joy_featherwing - import time + from adafruit_featherwing import joy_featherwing + import time - wing = joy_featherwing.JoyFeatherWing() + wing = joy_featherwing.JoyFeatherWing() - while True: - if wing.button_select: - print("Button SELECT pressed!") + while True: + if wing.button_select: + print("Button SELECT pressed!") """ return self._check_button(BUTTON_SELECT) @@ -183,35 +166,35 @@ def _check_button(self, button): def joystick_offset(self): """Offset used to correctly report (0, 0) when the joystick is centered. - .. image :: ../docs/_static/joy_featherwing/joy_featherwing_joystick.jpg - :alt: Joy FeatherWing Joystick + .. image :: ../docs/_static/joy_featherwing/joy_featherwing_joystick.jpg + :alt: Joy FeatherWing Joystick - Provide a tuple of (x, y) to set your joystick center to (0, 0). - The offset you provide is subtracted from the current reading. - For example, if your joystick reads as (-4, 0), you would enter - (-4, 0) as the offset. The code will subtract -4 from -4, and 0 - from 0, returning (0, 0). + Provide a tuple of (x, y) to set your joystick center to (0, 0). + The offset you provide is subtracted from the current reading. + For example, if your joystick reads as (-4, 0), you would enter + (-4, 0) as the offset. The code will subtract -4 from -4, and 0 + from 0, returning (0, 0). - This example supplies an offset for zeroing, and prints the - coordinates of the joystick when it is moved. + This example supplies an offset for zeroing, and prints the + coordinates of the joystick when it is moved. - .. code-block:: python + .. code-block:: python - from adafruit_featherwing import joy_featherwing - import time + from adafruit_featherwing import joy_featherwing + import time - wing = joy_featherwing.JoyFeatherWing() - last_x = 0 - last_y = 0 + wing = joy_featherwing.JoyFeatherWing() + last_x = 0 + last_y = 0 - while True: - wing.joystick_offset = (-4, 0) - x, y = wing.joystick - if (abs(x - last_x) > 3) or (abs(y - last_y) > 3): - last_x = x - last_y = y - print(x, y) - time.sleep(0.01) + while True: + wing.joystick_offset = (-4, 0) + x, y = wing.joystick + if (abs(x - last_x) > 3) or (abs(y - last_y) > 3): + last_x = x + last_y = y + print(x, y) + time.sleep(0.01) """ return self._joystick_offset diff --git a/adafruit_featherwing/keyboard_featherwing.py b/adafruit_featherwing/keyboard_featherwing.py index 5832aed..d083163 100644 --- a/adafruit_featherwing/keyboard_featherwing.py +++ b/adafruit_featherwing/keyboard_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2020 Foamyguy for Adafruit Industries # -# Copyright (c) 2020 Foamyguy for Adafruit Industries LLC -# -# 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_featherwing.keyboard_featherwing` ==================================================== @@ -51,9 +34,9 @@ # pylint: disable-msg=too-many-arguments class KeyboardFeatherwing: """Class representing a `Keyboard Featherwing` - `_. + `_. - """ + """ def __init__( self, diff --git a/adafruit_featherwing/led_segments.py b/adafruit_featherwing/led_segments.py index 2d11ca7..2ab6bac 100755 --- a/adafruit_featherwing/led_segments.py +++ b/adafruit_featherwing/led_segments.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.led_segments` ==================================================== @@ -36,9 +19,9 @@ class Segments: """Class representing an `Adafruit 14-segment AlphaNumeric FeatherWing - `_. + `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" def __init__(self): self._segments = None diff --git a/adafruit_featherwing/matrix_featherwing.py b/adafruit_featherwing/matrix_featherwing.py index 1c96440..1af1fe6 100755 --- a/adafruit_featherwing/matrix_featherwing.py +++ b/adafruit_featherwing/matrix_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.matrix_featherwing` ==================================================== @@ -38,9 +21,9 @@ class MatrixFeatherWing: """Class representing an `Adafruit 8x16 LED Matrix FeatherWing - `_. + `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" def __init__(self, address=0x70, i2c=None): if i2c is None: diff --git a/adafruit_featherwing/minitft_featherwing.py b/adafruit_featherwing/minitft_featherwing.py index 6ed44c6..68a495e 100755 --- a/adafruit_featherwing/minitft_featherwing.py +++ b/adafruit_featherwing/minitft_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.minitft_featherwing` ==================================================== @@ -53,9 +36,9 @@ class MiniTFTFeatherWing: """Class representing an `Mini Color TFT with Joystick FeatherWing - `_. + `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" _button_mask = ( (1 << BUTTON_RIGHT) diff --git a/adafruit_featherwing/neopixel_featherwing.py b/adafruit_featherwing/neopixel_featherwing.py index b30fb32..d28e2aa 100755 --- a/adafruit_featherwing/neopixel_featherwing.py +++ b/adafruit_featherwing/neopixel_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.neopixel_featherwing` ==================================================== @@ -38,14 +21,14 @@ class NeoPixelFeatherWing(PixelMatrix): """Class representing a `NeoPixel FeatherWing - `_. + `_. - The feather uses pins D6 by default""" + The feather uses pins D6 by default""" def __init__(self, pixel_pin=board.D6, brightness=0.1): """ - :param pin pixel_pin: The pin for the featherwing - :param float brightness: Optional brightness (0.0-1.0) that defaults to 1.0 + :param pin pixel_pin: The pin for the featherwing + :param float brightness: Optional brightness (0.0-1.0) that defaults to 1.0 """ super().__init__() self.rows = 4 diff --git a/adafruit_featherwing/pixelmatrix.py b/adafruit_featherwing/pixelmatrix.py index 20379f1..285dc56 100755 --- a/adafruit_featherwing/pixelmatrix.py +++ b/adafruit_featherwing/pixelmatrix.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.pixelmatrix` ==================================================== @@ -38,7 +21,7 @@ class PixelMatrix: """Base Class for DotStar and NeoPixel FeatherWings - The feather uses pins D13 and D11""" + The feather uses pins D13 and D11""" def __init__(self): self.rows = 0 diff --git a/adafruit_featherwing/rtc_featherwing.py b/adafruit_featherwing/rtc_featherwing.py index f7fa187..32ccfcd 100755 --- a/adafruit_featherwing/rtc_featherwing.py +++ b/adafruit_featherwing/rtc_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.rtc_featherwing` ==================================================== @@ -40,9 +23,9 @@ class RTCFeatherWing: """Class representing an `DS3231 Precision RTC FeatherWing - `_. + `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" def __init__(self, i2c=None): if i2c is None: diff --git a/adafruit_featherwing/sevensegment_featherwing.py b/adafruit_featherwing/sevensegment_featherwing.py index a5cc9d9..c685e8d 100755 --- a/adafruit_featherwing/sevensegment_featherwing.py +++ b/adafruit_featherwing/sevensegment_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.sevensegment_featherwing` ==================================================== @@ -38,9 +21,9 @@ class SevenSegmentFeatherWing(Segments): """Class representing an `Adafruit 7-Segment LED HT16K33 FeatherWing - `_. + `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" def __init__(self, address=0x70, i2c=None): super().__init__() diff --git a/adafruit_featherwing/tempmotion_featherwing.py b/adafruit_featherwing/tempmotion_featherwing.py index 9273fff..f369df2 100755 --- a/adafruit_featherwing/tempmotion_featherwing.py +++ b/adafruit_featherwing/tempmotion_featherwing.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# 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_featherwing.tempmotion_featherwing` ==================================================== @@ -39,9 +22,9 @@ class TempMotionFeatherWing: """Class helper representing an `Adafruit ADXL343 + ADT7410 Sensor FeatherWing - `_. + `_. - Automatically uses the feather's I2C bus.""" + Automatically uses the feather's I2C bus.""" def __init__(self, adxl343_address=0x53, adt7410_address=0x48, i2c=None): if i2c is None: diff --git a/adafruit_featherwing/tft_featherwing_24.py b/adafruit_featherwing/tft_featherwing_24.py index 934da04..84eb8d3 100644 --- a/adafruit_featherwing/tft_featherwing_24.py +++ b/adafruit_featherwing/tft_featherwing_24.py @@ -1,24 +1,8 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2020 Melissa LeBlanc-Williams for Adafruit Industries +# SPDX-FileCopyrightText: 2020 Foamyguy for Adafruit Industries # -# Copyright (c) 2020 Melissa LeBlanc-Williams, Foamyguy for Adafruit Industries LLC -# -# 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_featherwing.tft_featherwing_24` ==================================================== @@ -47,9 +31,9 @@ # pylint: disable-msg=too-few-public-methods class TFTFeatherWing24: """Class representing an `TFT FeatherWing 2.4 - `_. + `_. - """ + """ def __init__(self, spi=None, cs=None, dc=None): displayio.release_displays() 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/ina219_featherwing/ina219_featherwing.jpg.license b/docs/_static/ina219_featherwing/ina219_featherwing.jpg.license new file mode 100644 index 0000000..1a8072c --- /dev/null +++ b/docs/_static/ina219_featherwing/ina219_featherwing.jpg.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/docs/_static/joy_featherwing/joy_featherwing_a.jpg.license b/docs/_static/joy_featherwing/joy_featherwing_a.jpg.license new file mode 100644 index 0000000..1a8072c --- /dev/null +++ b/docs/_static/joy_featherwing/joy_featherwing_a.jpg.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/docs/_static/joy_featherwing/joy_featherwing_b.jpg.license b/docs/_static/joy_featherwing/joy_featherwing_b.jpg.license new file mode 100644 index 0000000..1a8072c --- /dev/null +++ b/docs/_static/joy_featherwing/joy_featherwing_b.jpg.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/docs/_static/joy_featherwing/joy_featherwing_joystick.jpg.license b/docs/_static/joy_featherwing/joy_featherwing_joystick.jpg.license new file mode 100644 index 0000000..1a8072c --- /dev/null +++ b/docs/_static/joy_featherwing/joy_featherwing_joystick.jpg.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/docs/_static/joy_featherwing/joy_featherwing_select.jpg.license b/docs/_static/joy_featherwing/joy_featherwing_select.jpg.license new file mode 100644 index 0000000..1a8072c --- /dev/null +++ b/docs/_static/joy_featherwing/joy_featherwing_select.jpg.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/docs/_static/joy_featherwing/joy_featherwing_x.jpg.license b/docs/_static/joy_featherwing/joy_featherwing_x.jpg.license new file mode 100644 index 0000000..1a8072c --- /dev/null +++ b/docs/_static/joy_featherwing/joy_featherwing_x.jpg.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/docs/_static/joy_featherwing/joy_featherwing_y.jpg.license b/docs/_static/joy_featherwing/joy_featherwing_y.jpg.license new file mode 100644 index 0000000..1a8072c --- /dev/null +++ b/docs/_static/joy_featherwing/joy_featherwing_y.jpg.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: CC-BY-SA-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 b3aa95a..db8c974 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/featherwing_alphanum_simpletest.py b/examples/featherwing_alphanum_simpletest.py index 96db159..4f8268e 100755 --- a/examples/featherwing_alphanum_simpletest.py +++ b/examples/featherwing_alphanum_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example changes the fill, brightness, blink rates, shows number and text printing, displays a counter and then shows off the new marquee features.""" diff --git a/examples/featherwing_dotstar_palette_example.py b/examples/featherwing_dotstar_palette_example.py index c16a33c..eba2bf8 100644 --- a/examples/featherwing_dotstar_palette_example.py +++ b/examples/featherwing_dotstar_palette_example.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This creates a palette of colors, draws a pattern and rotates through the palette creating a moving rainbow. diff --git a/examples/featherwing_dotstar_simpletest.py b/examples/featherwing_dotstar_simpletest.py index f323ace..597cb95 100755 --- a/examples/featherwing_dotstar_simpletest.py +++ b/examples/featherwing_dotstar_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This plays various animations and then draws random pixels at random locations diff --git a/examples/featherwing_gps_simpletest.py b/examples/featherwing_gps_simpletest.py index b305237..5ac9c22 100644 --- a/examples/featherwing_gps_simpletest.py +++ b/examples/featherwing_gps_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example will connect to the GPS at the default 9600 baudrate and update once per second. Initialization is automatically handled and there diff --git a/examples/featherwing_ina219_simpletest.py b/examples/featherwing_ina219_simpletest.py index 72a6132..f427b66 100755 --- a/examples/featherwing_ina219_simpletest.py +++ b/examples/featherwing_ina219_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ Example to print out the voltage and current using the INA219 """ import time from adafruit_featherwing import ina219_featherwing diff --git a/examples/featherwing_joy_simpletest.py b/examples/featherwing_joy_simpletest.py index 01396ab..c6b9940 100644 --- a/examples/featherwing_joy_simpletest.py +++ b/examples/featherwing_joy_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example zeros the joystick, and prints when the joystick moves or the buttons are pressed.""" import time diff --git a/examples/featherwing_keyboard_featherwing.py b/examples/featherwing_keyboard_featherwing.py index 9443ef7..643f443 100644 --- a/examples/featherwing_keyboard_featherwing.py +++ b/examples/featherwing_keyboard_featherwing.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example will display a CircuitPython console and print the coordinates of touchscreen presses, as well diff --git a/examples/featherwing_matrix_simpletest.py b/examples/featherwing_matrix_simpletest.py index f2fffb5..0d6dd26 100644 --- a/examples/featherwing_matrix_simpletest.py +++ b/examples/featherwing_matrix_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example will demonstrate some graphic effects and then draw a smiley face and shift it around the display diff --git a/examples/featherwing_minitft_simpletest.py b/examples/featherwing_minitft_simpletest.py index 3b627dd..359792c 100755 --- a/examples/featherwing_minitft_simpletest.py +++ b/examples/featherwing_minitft_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example display a CircuitPython console and print which button that is being pressed if any diff --git a/examples/featherwing_neopixel_palette_example.py b/examples/featherwing_neopixel_palette_example.py index 66ea0dc..1b87475 100644 --- a/examples/featherwing_neopixel_palette_example.py +++ b/examples/featherwing_neopixel_palette_example.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This creates a palette of colors, draws a pattern and rotates through the palette creating a moving rainbow. diff --git a/examples/featherwing_neopixel_simpletest.py b/examples/featherwing_neopixel_simpletest.py index ad0e48c..3be0935 100644 --- a/examples/featherwing_neopixel_simpletest.py +++ b/examples/featherwing_neopixel_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example plays various animations and then draws random pixels at random locations diff --git a/examples/featherwing_rtc_simpletest.py b/examples/featherwing_rtc_simpletest.py index 33a1bee..bf1b3c0 100755 --- a/examples/featherwing_rtc_simpletest.py +++ b/examples/featherwing_rtc_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example will allow you to set the date and time and then loop through and display the current time diff --git a/examples/featherwing_sevensegment_simpletest.py b/examples/featherwing_sevensegment_simpletest.py index 5eaeb10..924b817 100644 --- a/examples/featherwing_sevensegment_simpletest.py +++ b/examples/featherwing_sevensegment_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """This example changes the fill, brightness, blink rates, shows number and text printing, displays a counter and then shows off the new marquee features.""" diff --git a/examples/featherwing_tempmotion_simpletest.py b/examples/featherwing_tempmotion_simpletest.py index b90f1e0..622ea01 100644 --- a/examples/featherwing_tempmotion_simpletest.py +++ b/examples/featherwing_tempmotion_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example will show the current temperature in the Serial Console whenever the FeatherWing senses that it has been tapped diff --git a/examples/featherwing_tft24_simpletest.py b/examples/featherwing_tft24_simpletest.py index 7e8f896..7f11eac 100644 --- a/examples/featherwing_tft24_simpletest.py +++ b/examples/featherwing_tft24_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This example will display a CircuitPython console and print the coordinates of touchscreen presses. diff --git a/requirements.txt b/requirements.txt index ce7aa7c..1b34c50 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-register diff --git a/setup.py b/setup.py index 6d64621..abe891c 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """A setuptools based setup module. See: