diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..fbda35c --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# +# SPDX-License-Identifier: Unlicense + +repos: +- repo: https://github.com/python/black + rev: latest + hooks: + - id: black +- repo: https://github.com/fsfe/reuse-tool + rev: latest + hooks: + - id: reuse +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.3.0 + hooks: + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..a1e2575 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written 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 new file mode 100644 index 0000000..d885b36 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,137 @@ + +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Promoting or spreading disinformation, lies, or conspiracy theories against + a person, group, organisation, project, or community +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +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. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +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, @danh#1614, @cater#2442, +@sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. + +[Contributor Covenant]: https://www.contributor-covenant.org diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b8a7633 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020 Mark Roberts for Adafruit Industries + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..24a8f90 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,20 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and successors. We intend this dedication to +be an overt act of relinquishment in perpetuity of all present and future +rights to this software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, +please refer to diff --git a/README.rst b/README.rst index 6cbe152..d07433a 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,23 @@ Introduction ============ -DisplayIO driver for SH1107 monochrome displays. DisplayIO drivers enable terminal output. This driver depends on a future (TBD) quirk added to DisplayIO. + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio_sh1107/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/displayio_sh1107/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://adafru.it/discord + :alt: Discord + +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1107/workflows/Build%20CI/badge.svg + :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1107/actions + :alt: Build Status + +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + +DisplayIO driver for SH1107 monochrome displays. DisplayIO drivers enable terminal output. This driver depends on a future (TBD) quirk added to DisplayIO. Dependencies @@ -12,9 +29,33 @@ This driver depends on: Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading -`the Adafruit library and driver bundle `_. +`the Adafruit library and driver bundle `_. + +Installing from PyPI +===================== +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-displayio-sh1107 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell -Usage Example (see example for more) + sudo pip3 install adafruit-circuitpython-displayio-sh1107 + +To install in a virtual environment in your current project: + +.. code-block:: shell + + mkdir project-name && cd project-name + python3 -m venv .env + source .env/bin/activate + pip3 install adafruit-circuitpython-displayio-sh1107 + +Usage Example ============= .. code-block:: python @@ -57,3 +98,14 @@ Usage Example (see example for more) inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER) splash.append(inner_sprite) +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Documentation +============= + +For information on building library documentation, please check out `this guide `_. 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/mdroberts1243_displayio_sh1107.py b/adafruit_displayio_sh1107.py similarity index 50% rename from mdroberts1243_displayio_sh1107.py rename to adafruit_displayio_sh1107.py index eb53978..310f1e0 100644 --- a/mdroberts1243_displayio_sh1107.py +++ b/adafruit_displayio_sh1107.py @@ -1,6 +1,9 @@ - +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# SPDX-FileCopyrightText: Copyright (c) 2020 Mark Roberts for Adafruit Industries +# +# SPDX-License-Identifier: MIT """ -`mdroberts1243_displayio_sh1107` +`adafruit_displayio_sh1107` ================================================================================ DisplayIO driver for SH1107 monochrome displays @@ -19,37 +22,38 @@ * Adafruit CircuitPython (version 5+) firmware for the supported boards: https://github.com/adafruit/circuitpython/releases -* A new quirk is required on DisplayIO -- TBD """ import displayio __version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/mdroberts1243/mdroberts1243_CircuitPython_DisplayIO_SH1107.git" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1107.git" # Sequence from sh1107 framebuf driver formatted for displayio init _INIT_SEQUENCE = ( - b"\xae\x00" # display off, sleep mode - b"\xdc\x01\x00" # display start line = 0 (POR = 0) - b"\x81\x01\x2f" # contrast setting = 0x2f - b"\x21\x00" # vertical (column) addressing mode (POR=0x20) - b"\xa0\x00" # segment remap = 1 (POR=0, down rotation) - b"\xcf\x00" # common output scan direction = 15 (0 to n-1 (POR=0)) - b"\xa8\x01\x7f" # multiplex ratio = 128 (POR) - b"\xd3\x01\x60" # set display offset mode = 0x60 - b"\xd5\x01\x51" # divide ratio/oscillator: divide by 2, fOsc (POR) - b"\xd9\x01\x22" # pre-charge/dis-charge period mode: 2 DCLKs/2 DCLKs (POR) - b"\xdb\x01\x35" # VCOM deselect level = 0.770 (POR) - b"\xb0\x00" # set page address = 0 (POR) - b"\xa4\x00" # entire display off, retain RAM, normal status (POR) - b"\xa6\x00" # normal (not reversed) display - b"\xAF\x00\x00" # DISPLAY_ON + b"\xae\x00" # display off, sleep mode + b"\xdc\x01\x00" # display start line = 0 (POR = 0) + b"\x81\x01\x2f" # contrast setting = 0x2f + b"\x21\x00" # vertical (column) addressing mode (POR=0x20) + b"\xa0\x00" # segment remap = 1 (POR=0, down rotation) + b"\xcf\x00" # common output scan direction = 15 (0 to n-1 (POR=0)) + b"\xa8\x01\x7f" # multiplex ratio = 128 (POR) + b"\xd3\x01\x60" # set display offset mode = 0x60 + b"\xd5\x01\x51" # divide ratio/oscillator: divide by 2, fOsc (POR) + b"\xd9\x01\x22" # pre-charge/dis-charge period mode: 2 DCLKs/2 DCLKs (POR) + b"\xdb\x01\x35" # VCOM deselect level = 0.770 (POR) + b"\xb0\x00" # set page address = 0 (POR) + b"\xa4\x00" # entire display off, retain RAM, normal status (POR) + b"\xa6\x00" # normal (not reversed) display + b"\xAF\x00\x00" # DISPLAY_ON ) + # pylint: disable=too-few-public-methods class SH1107(displayio.Display): """SSD1107 driver""" + def __init__(self, bus, **kwargs): init_sequence = bytearray(_INIT_SEQUENCE) super().__init__( @@ -59,13 +63,13 @@ def __init__(self, bus, **kwargs): color_depth=1, grayscale=True, pixels_in_byte_share_row=True, # in vertical (column) mode - data_as_commands=True, # every byte will have a command byte preceeding - set_vertical_scroll=0xD3, # TBD -- not sure about this one! + data_as_commands=True, # every byte will have a command byte preceeding + set_vertical_scroll=0xD3, # TBD -- not sure about this one! brightness_command=0x81, single_byte_bounds=True, # for sh1107 use column and page addressing. # lower column command = 0x00 - 0x0F # upper column command = 0x10 - 0x17 # set page address = 0xB0 - 0xBF (16 pages) - SH1107_addressing = True - ) \ No newline at end of file + SH1107_addressing=True, + ) diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/favicon.ico.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..296a4f1 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ + +.. If you created a package, create one automodule per module in the package. + +.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) +.. use this format as the module name: "adafruit_foo.foo" + +.. automodule:: adafruit_displayio_sh1107 + :members: diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..827e3ef --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,187 @@ +# -*- coding: utf-8 -*- + +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +import os +import sys + +sys.path.insert(0, os.path.abspath("..")) + +# -- General configuration ------------------------------------------------ + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", +] + +# TODO: Please Read! +# Uncomment the below if you use native CircuitPython modules such as +# digitalio, micropython and busio. List the modules you use. Without it, the +# autodoc module docs will fail to generate with a warning. +autodoc_mock_imports = ["displayio"] + + +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", None), + "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), +} + +# Show the docstring from both the class and its __init__() method. +autoclass_content = "both" + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +source_suffix = ".rst" + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = "Adafruit DisplayIO_SH1107 Library" +copyright = "2020 Mark Roberts" +author = "Mark Roberts" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = "1.0" +# The full version, including alpha/beta/rc tags. +release = "1.0" + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [ + "_build", + "Thumbs.db", + ".DS_Store", + ".env", + "CODE_OF_CONDUCT.md", +] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +default_role = "any" + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +add_function_parentheses = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# If this is True, todo emits a warning for each TODO entries. The default is False. +todo_emit_warnings = True + +napoleon_numpy_docstring = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +on_rtd = os.environ.get("READTHEDOCS", None) == "True" + +if not on_rtd: # only import and set the theme if we're building docs locally + try: + import sphinx_rtd_theme + + html_theme = "sphinx_rtd_theme" + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] + except: + html_theme = "default" + html_theme_path = ["."] +else: + html_theme_path = ["."] + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +html_favicon = "_static/favicon.ico" + +# Output file base name for HTML help builder. +htmlhelp_basename = "AdafruitDisplayio_sh1107Librarydoc" + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, + "AdafruitDisplayIO_SH1107Library.tex", + "AdafruitDisplayIO_SH1107 Library Documentation", + author, + "manual", + ), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + master_doc, + "AdafruitDisplayIO_SH1107library", + "Adafruit DisplayIO_SH1107 Library Documentation", + [author], + 1, + ), +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "AdafruitDisplayIO_SH1107Library", + "Adafruit DisplayIO_SH1107 Library Documentation", + author, + "AdafruitDisplayIO_SH1107Library", + "One line description of project.", + "Miscellaneous", + ), +] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..92ce466 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/displayio_sh1107_simpletest.py + :caption: examples/displayio_sh1107_simpletest.py + :linenos: diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..6bfc7a3 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,48 @@ +.. include:: ../README.rst + +Table of Contents +================= + +.. toctree:: + :maxdepth: 4 + :hidden: + + self + +.. toctree:: + :caption: Examples + + examples + +.. toctree:: + :caption: API Reference + :maxdepth: 3 + + api + +.. toctree:: + :caption: Tutorials + + + +.. toctree:: + :caption: Related Products + + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/index.rst.license b/docs/index.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/examples/displayio_sh1107_game_of_life.py b/examples/displayio_sh1107_game_of_life.py index 9ce74a3..6ba794b 100644 --- a/examples/displayio_sh1107_game_of_life.py +++ b/examples/displayio_sh1107_game_of_life.py @@ -1,73 +1,90 @@ +""" +Author: Mark Roberts (mdroberts1243) from Adafruit code +Conway's game of life. +""" + import random import time import board import displayio -import mdroberts1243_displayio_sh1107 +import adafruit_displayio_sh1107 displayio.release_displays() - # Conway's "Game of Life" is played on a grid with simple rules, based - # on the number of filled neighbors each cell has and whether the cell itself - # is filled. - # * If the cell is filled, and 2 or 3 neighbors are filled, the cell stays - # filled - # * If the cell is empty, and exactly 3 neighbors are filled, a new cell - # becomes filled - # * Otherwise, the cell becomes or remains empty - # - # The complicated way that the "m1" (minus 1) and "p1" (plus one) offsets are - # calculated is due to the way the grid "wraps around", with the left and right - # sides being connected, as well as the top and bottom sides being connected. - # - # This function has been somewhat optimized, so that when it indexes the bitmap - # a single number [x + width * y] is used instead of indexing with [x, y]. - # This makes the animation run faster with some loss of clarity. More - # optimizations are probably possible. def apply_life_rule(old, new): - width = old.width - height = old.height - for y in range(height): - yyy = y * width - ym1 = ((y + height - 1) % height) * width - yp1 = ((y + 1) % height) * width - xm1 = width - 1 - for x in range(width): - xp1 = (x + 1) % width - neighbors = ( - old[xm1 + ym1] + old[xm1 + yyy] + old[xm1 + yp1] + - old[x + ym1] + old[x + yp1] + - old[xp1 + ym1] + old[xp1 + yyy] + old[xp1 + yp1]) - new[x+yyy] = neighbors == 3 or (neighbors == 2 and old[x+yyy]) - xm1 = x - -# Fill 'fraction' out of all the cells. + """ + Conway's "Game of Life" is played on a grid with simple rules, based + on the number of filled neighbors each cell has and whether the cell itself + is filled. + * If the cell is filled, and 2 or 3 neighbors are filled, the cell stays + filled + * If the cell is empty, and exactly 3 neighbors are filled, a new cell + becomes filled + * Otherwise, the cell becomes or remains empty + + The complicated way that the "m1" (minus 1) and "p1" (plus one) offsets are + calculated is due to the way the grid "wraps around", with the left and right + sides being connected, as well as the top and bottom sides being connected. + + This function has been somewhat optimized, so that when it indexes the bitmap + a single number [x + width * y] is used instead of indexing with [x, y]. + This makes the animation run faster with some loss of clarity. More + optimizations are probably possible. + """ + width = old.width + height = old.height + for y in range(height): + yyy = y * width + ym1 = ((y + height - 1) % height) * width + yp1 = ((y + 1) % height) * width + xm1 = width - 1 + for x in range(width): + xp1 = (x + 1) % width + neighbors = ( + old[xm1 + ym1] + + old[xm1 + yyy] + + old[xm1 + yp1] + + old[x + ym1] + + old[x + yp1] + + old[xp1 + ym1] + + old[xp1 + yyy] + + old[xp1 + yp1] + ) + new[x + yyy] = neighbors == 3 or (neighbors == 2 and old[x + yyy]) + xm1 = x + + def randomize(output, fraction=0.33): - for i in range(output.height * output.width): - output[i] = random.random() < fraction + """ Fill 'fraction' out of all the cells. """ + for i in range(output.height * output.width): + output[i] = random.random() < fraction -# Fill the grid with a tribute to John Conway def conway(output): - # based on xkcd's tribute to John Conway (1937-2020) https://xkcd.com/2293/ - conway_data = [ - b' +++ ', - b' + + ', - b' + + ', - b' + ', - b'+ +++ ', - b' + + + ', - b' + + ', - b' + + ', - b' + + ', - ] - for i in range(output.height * output.width): - output[i] = 0 - for i, si in enumerate(conway_data): - y = output.height - len(conway_data) - 2 + i - for j, cj in enumerate(si): - output[(output.width - 8)//2 + j, y] = cj & 1 + """ + Fill the grid with a tribute to John Conway. + + Based on xkcd's tribute to John Conway (1937-2020) https://xkcd.com/2293/ + """ + conway_data = [ + b" +++ ", + b" + + ", + b" + + ", + b" + ", + b"+ +++ ", + b" + + + ", + b" + + ", + b" + + ", + b" + + ", + ] + for i in range(output.height * output.width): + output[i] = 0 + for i, si in enumerate(conway_data): + y = output.height - len(conway_data) - 2 + i + for j, cj in enumerate(si): + output[(output.width - 8) // 2 + j, y] = cj & 1 i2c = board.I2C() @@ -76,12 +93,12 @@ def conway(output): # SH1107 is vertically oriented 64x128 WIDTH = 128 HEIGHT = 64 -display = mdroberts1243_displayio_sh1107.SH1107(display_bus, width=WIDTH, height=HEIGHT) +display = adafruit_displayio_sh1107.SH1107(display_bus, width=WIDTH, height=HEIGHT) -SCALE = 2 # scale up for the small OLED pixels! +SCALE = 2 # scale up for the small OLED pixels! -b1 = displayio.Bitmap(display.width//SCALE, display.height//SCALE, 2) -b2 = displayio.Bitmap(display.width//SCALE, display.height//SCALE, 2) +b1 = displayio.Bitmap(display.width // SCALE, display.height // SCALE, 2) +b2 = displayio.Bitmap(display.width // SCALE, display.height // SCALE, 2) palette = displayio.Palette(2) tg1 = displayio.TileGrid(b1, pixel_shader=palette) tg2 = displayio.TileGrid(b2, pixel_shader=palette) @@ -92,26 +109,26 @@ def conway(output): g2.append(tg2) # First time, show the Conway tribute -palette[1] = 0xffffff +palette[1] = 0xFFFFFF conway(b1) display.auto_refresh = True time.sleep(3) n = 40 while True: - # run 2*n generations. - # For the Conway tribute on 64x32, 80 frames is appropriate. For random - # values, 400 frames seems like a good number. Working in this way, with - # two bitmaps, reduces copying data and makes the animation a bit faster - for _ in range(n): - display.show(g1) - apply_life_rule(b1, b2) - display.show(g2) - apply_life_rule(b2, b1) - - # After 2*n generations, fill the board with random values and - # start over with a new color. - randomize(b1) - # Only white for the OLED display - palette[1] = 0xffffff - n = 100 \ No newline at end of file + # run 2*n generations. + # For the Conway tribute on 64x32, 80 frames is appropriate. For random + # values, 400 frames seems like a good number. Working in this way, with + # two bitmaps, reduces copying data and makes the animation a bit faster + for _ in range(n): + display.show(g1) + apply_life_rule(b1, b2) + display.show(g2) + apply_life_rule(b2, b1) + + # After 2*n generations, fill the board with random values and + # start over with a new color. + randomize(b1) + # Only white for the OLED display + palette[1] = 0xFFFFFF + n = 100 diff --git a/examples/displayio_sh1107_random_motion.py b/examples/displayio_sh1107_random_motion.py index e276d47..db36fa8 100644 --- a/examples/displayio_sh1107_random_motion.py +++ b/examples/displayio_sh1107_random_motion.py @@ -5,17 +5,18 @@ """ +import random +import time import board import displayio import terminalio -import random -import time + # can try import bitmap_label below for alternative -from adafruit_display_text import label as label # -import mdroberts1243_displayio_sh1107 +from adafruit_display_text import label +import adafruit_displayio_sh1107 displayio.release_displays() -#oled_reset = board.D9 +# oled_reset = board.D9 # Use for I2C i2c = board.I2C() @@ -26,7 +27,7 @@ HEIGHT = 64 BORDER = 2 -display = mdroberts1243_displayio_sh1107.SH1107(display_bus, width=WIDTH, height=HEIGHT) +display = adafruit_displayio_sh1107.SH1107(display_bus, width=WIDTH, height=HEIGHT) # Make the display context splash = displayio.Group(max_size=10) @@ -43,46 +44,47 @@ inner_bitmap = displayio.Bitmap(WIDTH - BORDER * 2, HEIGHT - BORDER * 2, 1) inner_palette = displayio.Palette(1) inner_palette[0] = 0x000000 # Black -inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER) +inner_sprite = displayio.TileGrid( + inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER +) splash.append(inner_sprite) # Draw some white squares -sm_bitmap = displayio.Bitmap(8,8,1) +sm_bitmap = displayio.Bitmap(8, 8, 1) sm_square = displayio.TileGrid(sm_bitmap, pixel_shader=color_palette, x=58, y=17) splash.append(sm_square) -med_bitmap = displayio.Bitmap(16,16,1) +med_bitmap = displayio.Bitmap(16, 16, 1) med_square = displayio.TileGrid(med_bitmap, pixel_shader=color_palette, x=71, y=15) splash.append(med_square) -lrg_bitmap = displayio.Bitmap(32,32,1) +lrg_bitmap = displayio.Bitmap(32, 32, 1) lrg_square = displayio.TileGrid(lrg_bitmap, pixel_shader=color_palette, x=91, y=28) splash.append(lrg_square) # Draw some label text -text1 = "0123456789ABCDEF123456789AB" # overly long to see where it clips +text1 = "0123456789ABCDEF123456789AB" # overly long to see where it clips text_area = label.Label(terminalio.FONT, text=text1, color=0xFFFFFF, x=8, y=8) splash.append(text_area) text2 = "SH1107" -x=9 -y=44 +x = 9 +y = 44 text_area2 = label.Label(terminalio.FONT, text=text2, scale=2, color=0xFFFFFF, x=x, y=y) splash.append(text_area2) time.sleep(1) while True: if x >= 128 or x < 0: - x = int(random.random()*128) + x = int(random.random() * 128) if y >= 64 or y < 0: - y = int(random.random()*64) + y = int(random.random() * 64) text_area2.x = x text_area2.y = y - if random.random()>0.5: - x=x+1 + if random.random() > 0.5: + x = x + 1 else: - x=x-1 - if random.random()>0.5: - y=y+1 + x = x - 1 + if random.random() > 0.5: + y = y + 1 else: - y=y-1 + y = y - 1 time.sleep(0.02) - pass \ No newline at end of file diff --git a/examples/displayio_sh1107_simpletest.py b/examples/displayio_sh1107_simpletest.py index cf77ef7..89aa34a 100644 --- a/examples/displayio_sh1107_simpletest.py +++ b/examples/displayio_sh1107_simpletest.py @@ -8,12 +8,13 @@ import board import displayio import terminalio + # can try import bitmap_label below for alternative -import label as label # from adafruit_display_text -import mdroberts1243_displayio_sh1107 +from adafruit_display_text import label +import adafruit_displayio_sh1107 displayio.release_displays() -#oled_reset = board.D9 +# oled_reset = board.D9 # Use for I2C i2c = board.I2C() @@ -24,7 +25,7 @@ HEIGHT = 64 BORDER = 2 -display = mdroberts1243_displayio_sh1107.SH1107(display_bus, width=WIDTH, height=HEIGHT) +display = adafruit_displayio_sh1107.SH1107(display_bus, width=WIDTH, height=HEIGHT) # Make the display context splash = displayio.Group(max_size=10) @@ -41,28 +42,32 @@ inner_bitmap = displayio.Bitmap(WIDTH - BORDER * 2, HEIGHT - BORDER * 2, 1) inner_palette = displayio.Palette(1) inner_palette[0] = 0x000000 # Black -inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER) +inner_sprite = displayio.TileGrid( + inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER +) splash.append(inner_sprite) # Draw some white squares -sm_bitmap = displayio.Bitmap(8,8,1) +sm_bitmap = displayio.Bitmap(8, 8, 1) sm_square = displayio.TileGrid(sm_bitmap, pixel_shader=color_palette, x=58, y=17) splash.append(sm_square) -med_bitmap = displayio.Bitmap(16,16,1) +med_bitmap = displayio.Bitmap(16, 16, 1) med_square = displayio.TileGrid(med_bitmap, pixel_shader=color_palette, x=71, y=15) splash.append(med_square) -lrg_bitmap = displayio.Bitmap(32,32,1) +lrg_bitmap = displayio.Bitmap(32, 32, 1) lrg_square = displayio.TileGrid(lrg_bitmap, pixel_shader=color_palette, x=91, y=28) splash.append(lrg_square) # Draw some label text -text1 = "0123456789ABCDEF123456789AB" # overly long to see where it clips +text1 = "0123456789ABCDEF123456789AB" # overly long to see where it clips text_area = label.Label(terminalio.FONT, text=text1, color=0xFFFFFF, x=8, y=8) splash.append(text_area) text2 = "SH1107" -text_area2 = label.Label(terminalio.FONT, text=text2, scale=2, color=0xFFFFFF, x=9, y=44) +text_area2 = label.Label( + terminalio.FONT, text=text2, scale=2, color=0xFFFFFF, x=9, y=44 +) splash.append(text_area2) while True: diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..f3c35ae --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# +# SPDX-License-Identifier: Unlicense + +[tool.black] +target-version = ['py35'] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..70770ee --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# SPDX-FileCopyrightText: Copyright (c) 2020 Mark Roberts for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +Adafruit-Blinka diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..cd57940 --- /dev/null +++ b/setup.py @@ -0,0 +1,58 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# SPDX-FileCopyrightText: Copyright (c) 2020 Mark Roberts for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +from setuptools import setup, find_packages + +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, "README.rst"), encoding="utf-8") as f: + long_description = f.read() + +setup( + name="adafruit-circuitpython-displayio-sh1107", + use_scm_version=True, + setup_requires=["setuptools_scm"], + description="Support for the SH1107 OLED display driver IC", + long_description=long_description, + long_description_content_type="text/x-rst", + # The project's main homepage. + url="https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1107", + # Author details + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka",], + # Choose your license + license="MIT", + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.4", + "Programming Language :: Python :: 3.5", + ], + # What does your project relate to? + keywords="adafruit blinka circuitpython micropython displayio_sh1107 display oled", + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, + # CHANGE `py_modules=['...']` TO `packages=['...']` + py_modules=["adafruit_displayio_sh1107"], +)