From 3e063e1ec02ead6259f4064c7f895033787d4229 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 10:54:59 -0400 Subject: [PATCH 01/36] initial working library commit. BMP cursor, boundingbox, movement, speed tested --- .gitignore | 12 + .pylintrc | 433 ++++++++++++++++++++++++++++++++++ .readthedocs.yml | 3 + .travis.yml | 48 ++++ CODE_OF_CONDUCT.md | 127 ++++++++++ LICENSE | 4 +- README.md | 2 - README.rst | 119 ++++++++++ adafruit_cursor.py | 137 +++++++++++ docs/_static/favicon.ico | Bin 0 -> 4414 bytes docs/api.rst | 8 + docs/conf.py | 160 +++++++++++++ docs/examples.rst | 8 + docs/index.rst | 51 ++++ examples/cursor_simpletest.py | 0 requirements.txt | 2 + setup.py | 64 +++++ 17 files changed, 1174 insertions(+), 4 deletions(-) create mode 100644 .gitignore create mode 100644 .pylintrc create mode 100644 .readthedocs.yml create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md delete mode 100644 README.md create mode 100644 README.rst create mode 100755 adafruit_cursor.py create mode 100644 docs/_static/favicon.ico create mode 100644 docs/api.rst create mode 100644 docs/conf.py create mode 100644 docs/examples.rst create mode 100644 docs/index.rst create mode 100644 examples/cursor_simpletest.py create mode 100644 requirements.txt create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..55f127b --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +*.mpy +.idea +__pycache__ +_build +*.pyc +.env +build* +bundles +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..039eaec --- /dev/null +++ b/.pylintrc @@ -0,0 +1,433 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +# jobs=1 +jobs=2 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +# notes=FIXME,XXX,TODO +notes=FIXME,XXX + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules=board + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# expected-line-ending-format= +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +# good-names=i,j,k,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +# max-attributes=7 +max-attributes=11 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..0bc7e6d --- /dev/null +++ b/.travis.yml @@ -0,0 +1,48 @@ +# This is a common .travis.yml for generating library release zip files for +# CircuitPython library releases using circuitpython-build-tools. +# See https://github.com/adafruit/circuitpython-build-tools for detailed setup +# instructions. + +dist: xenial +language: python +python: + - "3.6" + +cache: + pip: true + +# TODO: if deployment to PyPi is desired, change 'DEPLOY_PYPI' to "true", +# or remove the env block entirely and remove the condition in the +# deploy block. +env: + - DEPLOY_PYPI="false" + +deploy: + - provider: releases + api_key: "$GITHUB_TOKEN" + file_glob: true + file: "$TRAVIS_BUILD_DIR/bundles/*" + skip_cleanup: true + overwrite: true + on: + tags: true + # TODO: Use 'travis encrypt --com -r adafruit/' to generate + # the encrypted password for adafruit-travis. Paste result below. + - provider: pypi + user: adafruit-travis + password: + secure: #-- PASTE ENCRYPTED PASSWORD HERE --# + on: + tags: true + condition: $DEPLOY_PYPI = "true" + +install: + - pip install -r requirements.txt + - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme + - pip install --force-reinstall pylint==1.9.2 + +script: + - pylint adafruit_cursor.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursor --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7ca3a1d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# 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 +* 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 Helpers 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, 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][homepage], +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. diff --git a/LICENSE b/LICENSE index 5739aaa..d4fbf1d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ -MIT License +The MIT License (MIT) -Copyright (c) 2019 Adafruit Industries +Copyright (c) 2019 Brent Rubell 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 diff --git a/README.md b/README.md deleted file mode 100644 index 0f47dc0..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_Cursor -Simulated mouse cursor for display interaction diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..7e0ac14 --- /dev/null +++ b/README.rst @@ -0,0 +1,119 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-cursor/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/cursor/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Cursor.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Cursor + :alt: Build Status + +Simulated mouse cursor for display interaction + + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Installing from PyPI +===================== +.. note:: This library is not available on PyPI yet. Install documentation is included + as a standard element. Stay tuned for PyPI availability! + +.. todo:: Remove the above note if PyPI version is/will be available at time of release. + If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. + +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-cursor + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-cursor + +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-cursor + +Usage Example +============= + +.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +Zip release files +----------------- + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursor --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell + + cd docs + sphinx-build -E -W -b html . _build/html + +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. diff --git a/adafruit_cursor.py b/adafruit_cursor.py new file mode 100755 index 0000000..827b098 --- /dev/null +++ b/adafruit_cursor.py @@ -0,0 +1,137 @@ +# The MIT License (MIT) +# +# Copyright (c) 2019 Brent Rubell 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. +""" +`adafruit_cursor` +================================================================================ + +Simulated mouse cursor for display interaction + + +* Author(s): Brent Rubell + +Implementation Notes +-------------------- + +**Hardware:** + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +* Adafruit's ImageLoad Library: https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/ +""" +from micropython import const +import adafruit_imageload +import displayio +import board + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cursor.git" + +class Cursor: + """Mouse cursor-like interaction for CircuitPython. + + :param displayio.Display: CircuitPython display object. + :param int cursor_speed: Mouse cursor speed. + :param int cursor width: Width of cursor, in pixels. + :param int cursor height: Height of cursor, in pixels. + :param str custom_cursor: filepath to custom cursor image spritesheet, defaults + to None. + """ + def __init__(self, display, cursor_width, cursor_height, cursor_speed = 1, custom_cursor = None,): + self._display = display + self._display_width = display.width + self._display_height = display.height + self._speed = cursor_speed + if custom_cursor: + print('loading custom cursor') + self.load_custom_cursor(custom_cursor, cursor_width, cursor_height) + self._display.show(self._cursor_grp) + else: + print('TODO: Implement a display_shapes native cursor image') + self.x = int(self._display_width/2) + self.y = int(self._display_height/2) + + @property + def speed(self): + """Returns the cursor's speed.""" + return self._speed + + @speed.setter + def speed(self, speed): + """Sets the speed of the cursor. + :param int speed: Cursor movement speed. + """ + self._speed = speed + + @property + def x(self): + """Returns the cursor's x-coordinate.""" + return self._cursor_grp.x + + @x.setter + def x(self, x_val): + """Sets the x-value of the cursor. + :param int x_val: x position, in pixels. + """ + if (self._cursor_grp.x - self._speed < 0): + self._cursor_grp.x = self._cursor_grp.x + 1 + elif self._cursor_grp.x + self._speed > self._display_width - 45: + self._cursor_grp.x = self._cursor_grp.x - 1 + else: + self._cursor_grp.x = x_val + + @property + def y(self): + """Returns the cursor's y-coordinate.""" + return self._cursor_grp.y + + @y.setter + def y(self, y_val): + """Sets the y-value of the cursor. + :param int y_val: y position, in pixels. + """ + if (self._cursor_grp.y - self._speed < 0): + self._cursor_grp.y = self._cursor_grp.y + 1 + elif self._cursor_grp.y + self._speed > self._display_height - 45: + self._cursor_grp.y = self._cursor_grp.y - 1 + else: + self._cursor_grp.y = y_val + + + def load_custom_cursor(self, filepath, grid_width, grid_height): + """ Loads and creates a custom cursor image from a defined spritesheet. + :param str filepath: File path to a 50x50px cursor bitmap sprite sheet. + :param int grid_width: Width of the cursor image, in pixels. + :param int grid_height: Height of the cursor image, in pixels. + """ + self._sprite_sheet, self._palette = adafruit_imageload.load("/cursor.bmp", + bitmap=displayio.Bitmap, + palette=displayio.Palette) + self._sprite = displayio.TileGrid(self._sprite_sheet, pixel_shader=self._palette, + width = grid_width, + height = grid_height, + tile_width = 23, + tile_height = 26) + self._cursor_grp = displayio.Group(scale=2) + self._cursor_grp.append(self._sprite) diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635 GIT binary patch literal 4414 zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@Kt!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8 z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3 z%+myoFis_lTlCrGx2z$0BQdh+7?!JK#9K9@Z!VrG zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^># z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pRqiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$ zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo?^s4jqK=Lfg*9&geMGVQ z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4 zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%% z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI zn9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2 z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv) zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+2#5Cj5pp?FEK750S3BgeSDtaE^ zXUM@xoV6yBFKfzvY20V&Lr0yC + 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/examples/cursor_simpletest.py b/examples/cursor_simpletest.py new file mode 100644 index 0000000..e69de29 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..de861d4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +Adafruit-Blinka +adafruit-imageload diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..38c442c --- /dev/null +++ b/setup.py @@ -0,0 +1,64 @@ +"""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-cursor', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='Simulated mouse cursor for display interaction', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_Cursor', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka', + 'adafruit-imageload' + ], + + # 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 cursor cursor, mouse, input', + + # 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_cursor'], +) From 69632781e540f71f80c98e3f01a164848ab38db7 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 11:12:40 -0400 Subject: [PATCH 02/36] allow for dynamic scaling of the cursor bitmap using Group --- adafruit_cursor.py | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 827b098..2bee88a 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -55,20 +55,19 @@ class Cursor: :param int cursor_speed: Mouse cursor speed. :param int cursor width: Width of cursor, in pixels. :param int cursor height: Height of cursor, in pixels. - :param str custom_cursor: filepath to custom cursor image spritesheet, defaults + :param str cursor_path: filepath to custom cursor image spritesheet, defaults to None. + :param int cursor_scale: Size of cursor, scales pixels in both x and y directions. """ - def __init__(self, display, cursor_width, cursor_height, cursor_speed = 1, custom_cursor = None,): + def __init__(self, display, cursor_width, cursor_height, cursor_speed = 1, cursor_path = None, + cursor_scale = 1): self._display = display self._display_width = display.width self._display_height = display.height self._speed = cursor_speed - if custom_cursor: - print('loading custom cursor') - self.load_custom_cursor(custom_cursor, cursor_width, cursor_height) - self._display.show(self._cursor_grp) - else: - print('TODO: Implement a display_shapes native cursor image') + self._cursor_scale = cursor_scale + if cursor_path: + self.load_custom_cursor(cursor_path, cursor_width, cursor_height, self._cursor_scale) self.x = int(self._display_width/2) self.y = int(self._display_height/2) @@ -119,19 +118,21 @@ def y(self, y_val): self._cursor_grp.y = y_val - def load_custom_cursor(self, filepath, grid_width, grid_height): + def load_custom_cursor(self, filepath, grid_width, grid_height, cursor_scale): """ Loads and creates a custom cursor image from a defined spritesheet. :param str filepath: File path to a 50x50px cursor bitmap sprite sheet. :param int grid_width: Width of the cursor image, in pixels. :param int grid_height: Height of the cursor image, in pixels. + :param int cursor_scale: Scales each pixel in the cursor in both directions. """ - self._sprite_sheet, self._palette = adafruit_imageload.load("/cursor.bmp", + self._sprite_sheet, self._palette = adafruit_imageload.load(filepath, bitmap=displayio.Bitmap, palette=displayio.Palette) self._sprite = displayio.TileGrid(self._sprite_sheet, pixel_shader=self._palette, - width = grid_width, - height = grid_height, - tile_width = 23, - tile_height = 26) - self._cursor_grp = displayio.Group(scale=2) + width = 1, + height = 1, + tile_width = 16, + tile_height = 16) + self._cursor_grp = displayio.Group(max_size = 1, scale=cursor_scale) self._cursor_grp.append(self._sprite) + self._display.show(self._cursor_grp) From 0143154a6f222b75224548ef82c96a673586b132 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 11:22:50 -0400 Subject: [PATCH 03/36] cursor has a lot of related display data, pass in as a dictionaryso someone could define different properties dynamcially --- adafruit_cursor.py | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 2bee88a..a8cca95 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -52,22 +52,14 @@ class Cursor: """Mouse cursor-like interaction for CircuitPython. :param displayio.Display: CircuitPython display object. - :param int cursor_speed: Mouse cursor speed. - :param int cursor width: Width of cursor, in pixels. - :param int cursor height: Height of cursor, in pixels. - :param str cursor_path: filepath to custom cursor image spritesheet, defaults - to None. - :param int cursor_scale: Size of cursor, scales pixels in both x and y directions. """ - def __init__(self, display, cursor_width, cursor_height, cursor_speed = 1, cursor_path = None, - cursor_scale = 1): + def __init__(self, display=None, cursor_speed = 1, cursor=None): self._display = display self._display_width = display.width self._display_height = display.height self._speed = cursor_speed - self._cursor_scale = cursor_scale - if cursor_path: - self.load_custom_cursor(cursor_path, cursor_width, cursor_height, self._cursor_scale) + if cursor: + self.load_custom_cursor(cursor) self.x = int(self._display_width/2) self.y = int(self._display_height/2) @@ -118,21 +110,17 @@ def y(self, y_val): self._cursor_grp.y = y_val - def load_custom_cursor(self, filepath, grid_width, grid_height, cursor_scale): + def load_custom_cursor(self, cursor_info): """ Loads and creates a custom cursor image from a defined spritesheet. - :param str filepath: File path to a 50x50px cursor bitmap sprite sheet. - :param int grid_width: Width of the cursor image, in pixels. - :param int grid_height: Height of the cursor image, in pixels. - :param int cursor_scale: Scales each pixel in the cursor in both directions. """ - self._sprite_sheet, self._palette = adafruit_imageload.load(filepath, + self._sprite_sheet, self._palette = adafruit_imageload.load(cursor_info['cursor_path'], bitmap=displayio.Bitmap, palette=displayio.Palette) self._sprite = displayio.TileGrid(self._sprite_sheet, pixel_shader=self._palette, - width = 1, - height = 1, - tile_width = 16, - tile_height = 16) - self._cursor_grp = displayio.Group(max_size = 1, scale=cursor_scale) + width = cursor_info['cursor_width'], + height = cursor_info['cursor_height'], + tile_width = cursor_info['cursor_tile_width'], + tile_height = cursor_info['cursor_tile_height']) + self._cursor_grp = displayio.Group(max_size = 1, scale=cursor_info['cursor_scale']) self._cursor_grp.append(self._sprite) self._display.show(self._cursor_grp) From 08126f4b924d7a3df6f30572d6410dc24fac746f Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 11:57:57 -0400 Subject: [PATCH 04/36] sub-group cursor group within the code's primary group --- adafruit_cursor.py | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index a8cca95..5750faf 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -43,7 +43,6 @@ from micropython import const import adafruit_imageload import displayio -import board __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cursor.git" @@ -52,9 +51,12 @@ class Cursor: """Mouse cursor-like interaction for CircuitPython. :param displayio.Display: CircuitPython display object. + :param dict cursor: Information about the cursor including its cursor_path, + cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. """ - def __init__(self, display=None, cursor_speed = 1, cursor=None): + def __init__(self, display=None, display_group=None, cursor=None, cursor_speed = 1): self._display = display + self._display_grp = display_group self._display_width = display.width self._display_height = display.height self._speed = cursor_speed @@ -87,7 +89,7 @@ def x(self, x_val): """ if (self._cursor_grp.x - self._speed < 0): self._cursor_grp.x = self._cursor_grp.x + 1 - elif self._cursor_grp.x + self._speed > self._display_width - 45: + elif self._cursor_grp.x + self._speed > self._display_width - 25: self._cursor_grp.x = self._cursor_grp.x - 1 else: self._cursor_grp.x = x_val @@ -104,7 +106,7 @@ def y(self, y_val): """ if (self._cursor_grp.y - self._speed < 0): self._cursor_grp.y = self._cursor_grp.y + 1 - elif self._cursor_grp.y + self._speed > self._display_height - 45: + elif self._cursor_grp.y + self._speed > self._display_height - 25: self._cursor_grp.y = self._cursor_grp.y - 1 else: self._cursor_grp.y = y_val @@ -112,6 +114,8 @@ def y(self, y_val): def load_custom_cursor(self, cursor_info): """ Loads and creates a custom cursor image from a defined spritesheet. + :param dict cursor: Information about the cursor including its cursor_path, + cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. """ self._sprite_sheet, self._palette = adafruit_imageload.load(cursor_info['cursor_path'], bitmap=displayio.Bitmap, @@ -122,5 +126,7 @@ def load_custom_cursor(self, cursor_info): tile_width = cursor_info['cursor_tile_width'], tile_height = cursor_info['cursor_tile_height']) self._cursor_grp = displayio.Group(max_size = 1, scale=cursor_info['cursor_scale']) + # add sprite to cursor subgroup self._cursor_grp.append(self._sprite) - self._display.show(self._cursor_grp) + # append cursor subgroup to display group + self._display_grp.append(self._cursor_grp) From c55efc8c08e82b565b1cc5fcb44c19f32bdddc50 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 12:40:23 -0400 Subject: [PATCH 05/36] add hide/show cursor methods, ishidden property --- adafruit_cursor.py | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 5750faf..d146eff 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -53,15 +53,19 @@ class Cursor: :param displayio.Display: CircuitPython display object. :param dict cursor: Information about the cursor including its cursor_path, cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. + :param bool is_hidden: Cursor hidden by default. """ - def __init__(self, display=None, display_group=None, cursor=None, cursor_speed = 1): + def __init__(self, display=None, display_group=None, cursor=None, cursor_speed = 1, is_hidden=False): self._display = display self._display_grp = display_group self._display_width = display.width self._display_height = display.height self._speed = cursor_speed - if cursor: - self.load_custom_cursor(cursor) + self._is_hidden = is_hidden + try: + self.load_cursor_image(cursor) + except: + raise TypeError('Cursor info not found!') self.x = int(self._display_width/2) self.y = int(self._display_height/2) @@ -111,9 +115,25 @@ def y(self, y_val): else: self._cursor_grp.y = y_val + @property + def is_hidden(self): + """Returns if the cursor is hidden or visible on the display.""" + return self._is_hidden + + def hide(self): + """Hides the cursor by removing the cursor subgroup from the display group. + """ + self._is_hidden = True + self._display_grp.remove(self._cursor_grp) + + def show(self): + """Shows the cursor by inserting the cursor subgroup into the display group. + """ + self._is_hidden = False + self._display_grp.insert(0, self._cursor_grp) - def load_custom_cursor(self, cursor_info): - """ Loads and creates a custom cursor image from a defined spritesheet. + def load_cursor_image(self, cursor_info): + """Loads and creates a custom cursor image from a defined spritesheet. :param dict cursor: Information about the cursor including its cursor_path, cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. """ @@ -126,7 +146,6 @@ def load_custom_cursor(self, cursor_info): tile_width = cursor_info['cursor_tile_width'], tile_height = cursor_info['cursor_tile_height']) self._cursor_grp = displayio.Group(max_size = 1, scale=cursor_info['cursor_scale']) - # add sprite to cursor subgroup self._cursor_grp.append(self._sprite) - # append cursor subgroup to display group - self._display_grp.append(self._cursor_grp) + if not self._is_hidden: + self._display_grp.append(self._cursor_grp) From 9b600ea3932a1069cdcd818ba5697e44753afdda Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 13:54:20 -0400 Subject: [PATCH 06/36] append the group instead of inserting it at a fixed location, could cause layer issues --- adafruit_cursor.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index d146eff..3ecd1bc 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -66,7 +66,7 @@ def __init__(self, display=None, display_group=None, cursor=None, cursor_speed = self.load_cursor_image(cursor) except: raise TypeError('Cursor info not found!') - self.x = int(self._display_width/2) + x = 50 self.y = int(self._display_height/2) @property @@ -127,10 +127,10 @@ def hide(self): self._display_grp.remove(self._cursor_grp) def show(self): - """Shows the cursor by inserting the cursor subgroup into the display group. + """Shows the cursor by appending the cursor subgroup into the display group. """ self._is_hidden = False - self._display_grp.insert(0, self._cursor_grp) + self._display_grp.append(self._cursor_grp) def load_cursor_image(self, cursor_info): """Loads and creates a custom cursor image from a defined spritesheet. From b41213f233ed0fe1ee45a19d32faff3fb8606b7b Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 13:58:09 -0400 Subject: [PATCH 07/36] dont move the cursor on x/y grid if its property is set to hidden --- adafruit_cursor.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 3ecd1bc..7a9b948 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -66,8 +66,6 @@ def __init__(self, display=None, display_group=None, cursor=None, cursor_speed = self.load_cursor_image(cursor) except: raise TypeError('Cursor info not found!') - x = 50 - self.y = int(self._display_height/2) @property def speed(self): @@ -93,9 +91,9 @@ def x(self, x_val): """ if (self._cursor_grp.x - self._speed < 0): self._cursor_grp.x = self._cursor_grp.x + 1 - elif self._cursor_grp.x + self._speed > self._display_width - 25: + elif (self._cursor_grp.x + self._speed > self._display_width - 25): self._cursor_grp.x = self._cursor_grp.x - 1 - else: + elif not self._is_hidden: self._cursor_grp.x = x_val @property @@ -112,7 +110,7 @@ def y(self, y_val): self._cursor_grp.y = self._cursor_grp.y + 1 elif self._cursor_grp.y + self._speed > self._display_height - 25: self._cursor_grp.y = self._cursor_grp.y - 1 - else: + elif not self._is_hidden: self._cursor_grp.y = y_val @property From 5f261097ebf799dbc8730f961654b221e8a8fb48 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 14:07:42 -0400 Subject: [PATCH 08/36] pylinting --- adafruit_cursor.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 7a9b948..78e96fe 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -40,7 +40,6 @@ * Adafruit's ImageLoad Library: https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/ """ -from micropython import const import adafruit_imageload import displayio @@ -55,7 +54,8 @@ class Cursor: cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. :param bool is_hidden: Cursor hidden by default. """ - def __init__(self, display=None, display_group=None, cursor=None, cursor_speed = 1, is_hidden=False): + def __init__(self, display=None, display_group=None, cursor=None, + cursor_speed=1, is_hidden=False): self._display = display self._display_grp = display_group self._display_width = display.width @@ -71,7 +71,7 @@ def __init__(self, display=None, display_group=None, cursor=None, cursor_speed = def speed(self): """Returns the cursor's speed.""" return self._speed - + @speed.setter def speed(self, speed): """Sets the speed of the cursor. @@ -89,9 +89,9 @@ def x(self, x_val): """Sets the x-value of the cursor. :param int x_val: x position, in pixels. """ - if (self._cursor_grp.x - self._speed < 0): + if self._cursor_grp.x - self._speed < 0: self._cursor_grp.x = self._cursor_grp.x + 1 - elif (self._cursor_grp.x + self._speed > self._display_width - 25): + elif self._cursor_grp.x + self._speed > self._display_width - 25: self._cursor_grp.x = self._cursor_grp.x - 1 elif not self._is_hidden: self._cursor_grp.x = x_val @@ -106,12 +106,12 @@ def y(self, y_val): """Sets the y-value of the cursor. :param int y_val: y position, in pixels. """ - if (self._cursor_grp.y - self._speed < 0): + if self._cursor_grp.y - self._speed < 0: self._cursor_grp.y = self._cursor_grp.y + 1 elif self._cursor_grp.y + self._speed > self._display_height - 25: self._cursor_grp.y = self._cursor_grp.y - 1 elif not self._is_hidden: - self._cursor_grp.y = y_val + self._cursor_grp.y = y_val @property def is_hidden(self): @@ -125,7 +125,7 @@ def hide(self): self._display_grp.remove(self._cursor_grp) def show(self): - """Shows the cursor by appending the cursor subgroup into the display group. + """Shows the cursor by appending the cursor subgroup into the display group. """ self._is_hidden = False self._display_grp.append(self._cursor_grp) @@ -136,14 +136,14 @@ def load_cursor_image(self, cursor_info): cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. """ self._sprite_sheet, self._palette = adafruit_imageload.load(cursor_info['cursor_path'], - bitmap=displayio.Bitmap, - palette=displayio.Palette) + bitmap=displayio.Bitmap, + palette=displayio.Palette) self._sprite = displayio.TileGrid(self._sprite_sheet, pixel_shader=self._palette, - width = cursor_info['cursor_width'], - height = cursor_info['cursor_height'], - tile_width = cursor_info['cursor_tile_width'], - tile_height = cursor_info['cursor_tile_height']) - self._cursor_grp = displayio.Group(max_size = 1, scale=cursor_info['cursor_scale']) + width=cursor_info['cursor_width'], + height=cursor_info['cursor_height'], + tile_width=cursor_info['cursor_tile_width'], + tile_height=cursor_info['cursor_tile_height']) + self._cursor_grp = displayio.Group(max_size=1, scale=cursor_info['cursor_scale']) self._cursor_grp.append(self._sprite) if not self._is_hidden: self._display_grp.append(self._cursor_grp) From 06cf33620f5c40f33b6ac4c841e25368d4944d41 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 17:49:21 -0400 Subject: [PATCH 09/36] autogenerate a cursor using bitmaps, make load_cursor_bitmap an optional, user-defined method, add a property for setting the group's scale, add a getter for scale --- adafruit_cursor.py | 105 +++++++++++++++++++++++++++++++++++---------- 1 file changed, 82 insertions(+), 23 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 78e96fe..863e259 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -25,7 +25,6 @@ Simulated mouse cursor for display interaction - * Author(s): Brent Rubell Implementation Notes @@ -37,10 +36,7 @@ * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases - -* Adafruit's ImageLoad Library: https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/ """ -import adafruit_imageload import displayio __version__ = "0.0.0-auto.0" @@ -50,22 +46,35 @@ class Cursor: """Mouse cursor-like interaction for CircuitPython. :param displayio.Display: CircuitPython display object. - :param dict cursor: Information about the cursor including its cursor_path, + :param dict custom_cursor: Information about the cursor including its cursor_path, cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. :param bool is_hidden: Cursor hidden by default. """ - def __init__(self, display=None, display_group=None, cursor=None, - cursor_speed=1, is_hidden=False): + def __init__(self, display=None, display_group=None, cursor_speed=1, is_hidden=False, + cursor_style="cursor", scale=1): self._display = display + self._scale = scale self._display_grp = display_group self._display_width = display.width self._display_height = display.height self._speed = cursor_speed self._is_hidden = is_hidden - try: - self.load_cursor_image(cursor) - except: - raise TypeError('Cursor info not found!') + self._cursor_style = cursor_style + self.generate_cursor() + + + @property + def scale(self): + """Returns the cursor's bitmap scale""" + return self._scale + + @scale.setter + def scale(self, scale_value): + """Scales the cursor by scale_value in x and y directions + :param int scale_value: Amount to scale the cursor by. + """ + self._scale = scale_value + self._cursor_grp.scale = scale_value @property def speed(self): @@ -130,20 +139,70 @@ def show(self): self._is_hidden = False self._display_grp.append(self._cursor_grp) - def load_cursor_image(self, cursor_info): - """Loads and creates a custom cursor image from a defined spritesheet. - :param dict cursor: Information about the cursor including its cursor_path, - cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. + def generate_cursor(self): + """Generates a cursor bitmap""" + self._cursor_grp = displayio.Group(max_size=1, scale=self._scale) + self._pointer_bitmap = displayio.Bitmap(20, 20, 3) + self._pointer_palette = displayio.Palette(3) + self._pointer_palette.make_transparent(0) + self._pointer_palette[1] = 0xFFFFFF + self._pointer_palette[2] = 0x0000 + # cursor bitmap generation + if self._cursor_style is "plus": + for i in range(0, self._pointer_bitmap.width, 2): + self._pointer_bitmap[i, 10] = 1 + for j in range(0, self._pointer_bitmap.height, 2): + self._pointer_bitmap[10, j] = 1 + elif self._cursor_style is "rectangle": + for i in range(0, self._pointer_bitmap.height-1): + for j in range(0, self._pointer_bitmap.width-1): + self._pointer_bitmap[i, j] = 1 + else: # cursor_style defaults to default cursor + # left edge + for i in range(0, self._pointer_bitmap.height): + self._pointer_bitmap[0, i] = 2 + #for i in range(1, self._pointer_bitmap.height - 1): + # self._pointer_bitmap[1, i] = 1 + + for j in range(1, 15): + for i in range(j+1, self._pointer_bitmap.height - j): + self._pointer_bitmap[j, i] = 1 + # right diag. + for i in range(1, 15): + self._pointer_bitmap[i, i] = 2 + #self._pointer_bitmap[i, i-1] = 1 + # bottom diag + for i in range(1, 5): + self._pointer_bitmap[i, self._pointer_bitmap.height-i] = 2 + #self._pointer_bitmap[i, self._pointer_bitmap.height-i-1] = 1 + # bottom flat line + for i in range(5, 15): + self._pointer_bitmap[i, 15] = 2 + #self._pointer_bitmap[i-1, 14] = 1 + # create a tilegrid out of the bitmap and palette + self._pointer_sprite = displayio.TileGrid(self._pointer_bitmap, pixel_shader=self._pointer_palette) + self._cursor_grp.append(self._pointer_sprite) + self._display_grp.append(self._cursor_grp) + + def load_cursor_bitmap(self, cursor_path, sheet_width, sheet_height, tile_width, tile_height): + """Loads and creates a custom cursor bitmap from a sprite sheet bitmap image. + :param str cursor_path: Path to cursor bitmap on the CIRCUITPY file system. + :param int sheet_width: Width of sprite sheet bitmap, in pixels . + :param int sheet_height: Height of sprite sheet bitmap, in pixels. + :param int tile_width: Width of cursor image, in pixels. + :param int tile_height: Height of cursor, in pixels """ - self._sprite_sheet, self._palette = adafruit_imageload.load(cursor_info['cursor_path'], + import adafruit_imageload + # remove a pre-generated cursor image + self._cursor_grp.remove(self._pointer_sprite) + self._sprite_sheet, self._palette = adafruit_imageload.load(cursor_path, bitmap=displayio.Bitmap, palette=displayio.Palette) self._sprite = displayio.TileGrid(self._sprite_sheet, pixel_shader=self._palette, - width=cursor_info['cursor_width'], - height=cursor_info['cursor_height'], - tile_width=cursor_info['cursor_tile_width'], - tile_height=cursor_info['cursor_tile_height']) - self._cursor_grp = displayio.Group(max_size=1, scale=cursor_info['cursor_scale']) + width=sheet_width, + height=sheet_height, + tile_width=tile_width, + tile_height=tile_height) + self._cursor_grp = displayio.Group(max_size=1, scale=self._scale) self._cursor_grp.append(self._sprite) - if not self._is_hidden: - self._display_grp.append(self._cursor_grp) + self._display_grp.append(self._cursor_grp) From 64a228953aa2d8c7d7b707844a8c31e787f11165 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 18 Jun 2019 18:17:08 -0400 Subject: [PATCH 10/36] refactor is_hidden into hide as a setter/getter --- adafruit_cursor.py | 96 +++++++++++++++----------------- examples/code.py | 135 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 178 insertions(+), 53 deletions(-) create mode 100755 examples/code.py diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 863e259..5f78917 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -46,12 +46,12 @@ class Cursor: """Mouse cursor-like interaction for CircuitPython. :param displayio.Display: CircuitPython display object. - :param dict custom_cursor: Information about the cursor including its cursor_path, - cursor_scale, cursor_width, cursor_height, cursor_tile_width, and cursor_tile_height. - :param bool is_hidden: Cursor hidden by default. + :param displayio.Group: CircuitPython group object to append the cursor to. + :param int cursor_speed: Speed of the cursor, in pixels. + ;param int scale: Scale amount for the cursor in both directions. + :param bool is_hidden: Cursor is hidden on init. """ - def __init__(self, display=None, display_group=None, cursor_speed=1, is_hidden=False, - cursor_style="cursor", scale=1): + def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=1, scale=1): self._display = display self._scale = scale self._display_grp = display_group @@ -59,18 +59,16 @@ def __init__(self, display=None, display_group=None, cursor_speed=1, is_hidden=F self._display_height = display.height self._speed = cursor_speed self._is_hidden = is_hidden - self._cursor_style = cursor_style self.generate_cursor() - @property def scale(self): - """Returns the cursor's bitmap scale""" + """Returns the cursor's scale amount as an integer.""" return self._scale @scale.setter def scale(self, scale_value): - """Scales the cursor by scale_value in x and y directions + """Scales the cursor by scale_value in both directions. :param int scale_value: Amount to scale the cursor by. """ self._scale = scale_value @@ -78,13 +76,13 @@ def scale(self, scale_value): @property def speed(self): - """Returns the cursor's speed.""" + """Returns the cursor's speed, in pixels.""" return self._speed @speed.setter def speed(self, speed): """Sets the speed of the cursor. - :param int speed: Cursor movement speed. + :param int speed: Cursor movement speed, in pixels. """ self._speed = speed @@ -127,17 +125,19 @@ def is_hidden(self): """Returns if the cursor is hidden or visible on the display.""" return self._is_hidden + @property def hide(self): - """Hides the cursor by removing the cursor subgroup from the display group. - """ - self._is_hidden = True - self._display_grp.remove(self._cursor_grp) - - def show(self): - """Shows the cursor by appending the cursor subgroup into the display group. - """ - self._is_hidden = False - self._display_grp.append(self._cursor_grp) + """Returns if the cursor is hidden or visible on the display.""" + return self._is_hidden + + @hide.setter + def hide(self, is_hidden): + if is_hidden: + self._is_hidden = True + self._display_grp.remove(self._cursor_grp) + else: + self._is_hidden = False + self._display_grp.append(self._cursor_grp) def generate_cursor(self): """Generates a cursor bitmap""" @@ -147,38 +147,28 @@ def generate_cursor(self): self._pointer_palette.make_transparent(0) self._pointer_palette[1] = 0xFFFFFF self._pointer_palette[2] = 0x0000 - # cursor bitmap generation - if self._cursor_style is "plus": - for i in range(0, self._pointer_bitmap.width, 2): - self._pointer_bitmap[i, 10] = 1 - for j in range(0, self._pointer_bitmap.height, 2): - self._pointer_bitmap[10, j] = 1 - elif self._cursor_style is "rectangle": - for i in range(0, self._pointer_bitmap.height-1): - for j in range(0, self._pointer_bitmap.width-1): - self._pointer_bitmap[i, j] = 1 - else: # cursor_style defaults to default cursor - # left edge - for i in range(0, self._pointer_bitmap.height): - self._pointer_bitmap[0, i] = 2 - #for i in range(1, self._pointer_bitmap.height - 1): - # self._pointer_bitmap[1, i] = 1 - - for j in range(1, 15): - for i in range(j+1, self._pointer_bitmap.height - j): - self._pointer_bitmap[j, i] = 1 - # right diag. - for i in range(1, 15): - self._pointer_bitmap[i, i] = 2 - #self._pointer_bitmap[i, i-1] = 1 - # bottom diag - for i in range(1, 5): - self._pointer_bitmap[i, self._pointer_bitmap.height-i] = 2 - #self._pointer_bitmap[i, self._pointer_bitmap.height-i-1] = 1 - # bottom flat line - for i in range(5, 15): - self._pointer_bitmap[i, 15] = 2 - #self._pointer_bitmap[i-1, 14] = 1 + # left edge, outline + for i in range(0, self._pointer_bitmap.height): + self._pointer_bitmap[0, i] = 2 + # inside fill + for j in range(1, 15): + for i in range(j+1, self._pointer_bitmap.height - j): + self._pointer_bitmap[j, i] = 1 + # right diag., outline + for i in range(1, 15): + self._pointer_bitmap[i, i] = 2 + # bottom diag., outline + for i in range(1, 5): + self._pointer_bitmap[i, self._pointer_bitmap.height-i] = 2 + # bottom flat line, outline + for i in range(5, 15): + self._pointer_bitmap[i, 15] = 2 + # right side fill + for i in range(5, 15): + self._pointer_bitmap[i-1, 14] = 1 + self._pointer_bitmap[i-2, 13] = 1 + self._pointer_bitmap[i-3, 12] = 1 + self._pointer_bitmap[i-4, 11] = 1 # create a tilegrid out of the bitmap and palette self._pointer_sprite = displayio.TileGrid(self._pointer_bitmap, pixel_shader=self._pointer_palette) self._cursor_grp.append(self._pointer_sprite) diff --git a/examples/code.py b/examples/code.py new file mode 100755 index 0000000..8a7ebd0 --- /dev/null +++ b/examples/code.py @@ -0,0 +1,135 @@ +# using adafruit_cursor with adafruit_button +import time +import board +from micropython import const +import digitalio +from gamepadshift import GamePadShift +from adafruit_bitmap_font import bitmap_font +from adafruit_button import Button +import displayio +import adafruit_cursor + +import busio +import adafruit_lis3dh + +# PyBadge Button Masks +BUTTON_LEFT = const(128) +BUTTON_UP = const(64) +BUTTON_DOWN = const(32) +BUTTON_RIGHT = const(16) +BUTTON_A = const(2) +BUTTON_B = const(1) + +# Initialize PyBadge Gamepad +pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), + digitalio.DigitalInOut(board.BUTTON_OUT), + digitalio.DigitalInOut(board.BUTTON_LATCH)) + +# Hardware I2C setup. Use the CircuitPlayground built-in accelerometer if available; +# otherwise check I2C pins. +if hasattr(board, 'ACCELEROMETER_SCL'): + i2c = busio.I2C(board.ACCELEROMETER_SCL, board.ACCELEROMETER_SDA) + int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) + lis3dh = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1) +else: + i2c = busio.I2C(board.SCL, board.SDA) + int1 = digitalio.DigitalInOut(board.D9) # Set this to the correct pin for the interrupt! + lis3dh = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) +lis3dh.range = adafruit_lis3dh.RANGE_8_G +lis3dh.set_tap(1, 60) + +# Create the display +display = board.DISPLAY +splash_grp = displayio.Group(max_size=20) + +# Make the display context +BUTTON_WIDTH = 80 +BUTTON_HEIGHT = 40 +BUTTON_MARGIN = 20 + +########################################################################## +# Make a background color fill +color_bitmap = displayio.Bitmap(320, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x404040 +bg_sprite = displayio.TileGrid(color_bitmap, + pixel_shader=color_palette, + x=0, y=0) +splash_grp.append(bg_sprite) +########################################################################## + +# Load the font +THE_FONT = "/fonts/Arial-12.bdf" +font = bitmap_font.load_font(THE_FONT) + +buttons = [] +button_0 = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="click me!", label_font=font) +buttons.append(button_0) + +button_2 = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="or me!", label_font=font, label_color=0x0000FF, + fill_color=0x00FF00, outline_color=0xFF0000) +buttons.append(button_2) + +for b in buttons: + splash_grp.append(b.group) + +# create the display object +display = board.DISPLAY + +# initialize the mouse cursor object +# cursor style (plus, triangle, pointer, rectangle) +mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash_grp) + +# show displayio group +display.show(splash_grp) + +def check_dpad(pad_btns): + """Checks the d-pad presses""" + if (pad_btns & BUTTON_RIGHT) > 0: + mouse_cursor.x += mouse_cursor.speed + elif (pad_btns & BUTTON_LEFT) > 0: + mouse_cursor.x -= mouse_cursor.speed + elif (pad_btns & BUTTON_UP) > 0: + mouse_cursor.y -= mouse_cursor.speed + elif (pad_btns & BUTTON_DOWN) > 0: + mouse_cursor.y += mouse_cursor.speed + +def check_btns(pad_btns): + """Checks a/b button presses""" + global is_a_clicked + if (pad_btns & BUTTON_B) > 0: + if mouse_cursor.hide: + mouse_cursor.hide = False + else: + mouse_cursor.hide = True + elif ((pad_btns & BUTTON_A) > 0) and not mouse_cursor.hide: + is_a_clicked = True + +is_a_clicked = False +current_btns = pad.get_pressed() +while True: + if lis3dh.tapped: + print('tapped!') + mouse_cursor.scale = 2 + time.sleep(0.5) + mouse_cursor.scale = 1 + btns = pad.get_pressed() + check_dpad(btns) + if current_btns != btns: + check_btns(btns) + current_btns = btns + # check the coordinates of the cursor + p = mouse_cursor.x, mouse_cursor.y + if p: + for i, b in enumerate(buttons): + if b.contains(p) and is_a_clicked: + print("Button %d pressed"%i) + b.selected = True + is_a_clicked = False + else: + b.selected = False + time.sleep(0.01) \ No newline at end of file From 62518facbac132648ad9d5e6f3aba7cc874340da Mon Sep 17 00:00:00 2001 From: brentru Date: Wed, 19 Jun 2019 17:56:32 -0400 Subject: [PATCH 11/36] only scale if positive, bump cursor default speed, update example --- adafruit_cursor.py | 7 +- examples/code.py | 168 ++++++++++++++++++++++++--------------------- 2 files changed, 94 insertions(+), 81 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 5f78917..b1cc40b 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -51,7 +51,7 @@ class Cursor: ;param int scale: Scale amount for the cursor in both directions. :param bool is_hidden: Cursor is hidden on init. """ - def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=1, scale=1): + def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=5, scale=1): self._display = display self._scale = scale self._display_grp = display_group @@ -71,8 +71,9 @@ def scale(self, scale_value): """Scales the cursor by scale_value in both directions. :param int scale_value: Amount to scale the cursor by. """ - self._scale = scale_value - self._cursor_grp.scale = scale_value + if scale_value > 0: + self._scale = scale_value + self._cursor_grp.scale = scale_value @property def speed(self): diff --git a/examples/code.py b/examples/code.py index 8a7ebd0..4d83f61 100755 --- a/examples/code.py +++ b/examples/code.py @@ -1,16 +1,16 @@ # using adafruit_cursor with adafruit_button import time + import board -from micropython import const import digitalio -from gamepadshift import GamePadShift +from micropython import const + +import adafruit_cursor +import displayio from adafruit_bitmap_font import bitmap_font from adafruit_button import Button -import displayio -import adafruit_cursor - -import busio -import adafruit_lis3dh +from adafruit_display_text import label +from gamepadshift import GamePadShift # PyBadge Button Masks BUTTON_LEFT = const(128) @@ -25,111 +25,123 @@ digitalio.DigitalInOut(board.BUTTON_OUT), digitalio.DigitalInOut(board.BUTTON_LATCH)) -# Hardware I2C setup. Use the CircuitPlayground built-in accelerometer if available; -# otherwise check I2C pins. -if hasattr(board, 'ACCELEROMETER_SCL'): - i2c = busio.I2C(board.ACCELEROMETER_SCL, board.ACCELEROMETER_SDA) - int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) - lis3dh = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1) -else: - i2c = busio.I2C(board.SCL, board.SDA) - int1 = digitalio.DigitalInOut(board.D9) # Set this to the correct pin for the interrupt! - lis3dh = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) -lis3dh.range = adafruit_lis3dh.RANGE_8_G -lis3dh.set_tap(1, 60) +# Load the font +THE_FONT = "/fonts/Arial-12.bdf" +font = bitmap_font.load_font(THE_FONT) # Create the display display = board.DISPLAY -splash_grp = displayio.Group(max_size=20) -# Make the display context -BUTTON_WIDTH = 80 -BUTTON_HEIGHT = 40 -BUTTON_MARGIN = 20 +# Create the display context +splash = displayio.Group(max_size=22) ########################################################################## # Make a background color fill + color_bitmap = displayio.Bitmap(320, 240, 1) color_palette = displayio.Palette(1) color_palette[0] = 0x404040 bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) -splash_grp.append(bg_sprite) +splash.append(bg_sprite) + ########################################################################## -# Load the font -THE_FONT = "/fonts/Arial-12.bdf" -font = bitmap_font.load_font(THE_FONT) +# Set up button size info +BUTTON_WIDTH = 80 +BUTTON_HEIGHT = 40 +BUTTON_MARGIN = 20 +# Create the buttons buttons = [] -button_0 = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN, + +button_speed_inc = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN+BUTTON_HEIGHT, width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="click me!", label_font=font) -buttons.append(button_0) + label="+ Speed", label_font=font) +buttons.append(button_speed_inc) -button_2 = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN, +button_speed_dec = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="or me!", label_font=font, label_color=0x0000FF, - fill_color=0x00FF00, outline_color=0xFF0000) -buttons.append(button_2) + label="- Speed", label_font=font) +buttons.append(button_speed_dec) +button_scale_pos = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="+ Scale", label_font=font, style=Button.SHADOWRECT) +buttons.append(button_scale_pos) + +button_scale_neg = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="- Scale", label_font=font, style=Button.SHADOWRECT) +buttons.append(button_scale_neg) + +# Show the button for b in buttons: - splash_grp.append(b.group) + splash.append(b.group) -# create the display object -display = board.DISPLAY +# Create a text label +text_label = label.Label(font, text="CircuitPython Cursor!", color=0x00FF00, + x = 100, y = 20) +splash.append(text_label) + +text_speed = label.Label(font, max_glyphs = 11, color=0x00FF00, + x = 120, y = 40) +splash.append(text_speed) + +text_scale = label.Label(font, max_glyphs = 11, color=0x00FF00, + x = 120, y = 60) +splash.append(text_scale) # initialize the mouse cursor object -# cursor style (plus, triangle, pointer, rectangle) -mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash_grp) +mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) # show displayio group -display.show(splash_grp) +display.show(splash) -def check_dpad(pad_btns): - """Checks the d-pad presses""" - if (pad_btns & BUTTON_RIGHT) > 0: +def check_dpad(d_pad_buttons): + """Checks the directional pad for button presses.""" + if pressed & BUTTON_RIGHT: mouse_cursor.x += mouse_cursor.speed - elif (pad_btns & BUTTON_LEFT) > 0: + elif pressed & BUTTON_LEFT: mouse_cursor.x -= mouse_cursor.speed - elif (pad_btns & BUTTON_UP) > 0: - mouse_cursor.y -= mouse_cursor.speed - elif (pad_btns & BUTTON_DOWN) > 0: + if pressed & BUTTON_DOWN: mouse_cursor.y += mouse_cursor.speed + elif pressed & BUTTON_UP: + mouse_cursor.y -= mouse_cursor.speed -def check_btns(pad_btns): - """Checks a/b button presses""" - global is_a_clicked - if (pad_btns & BUTTON_B) > 0: +is_pressed = False +while True: + display.wait_for_frame() + text_speed.text = 'Speed: {0}'.format(mouse_cursor.speed) + text_scale.text = 'Scale: {0}'.format(mouse_cursor.scale) + pressed = pad.get_pressed() + check_dpad(pressed) + if is_pressed: + if not pressed & (BUTTON_A | BUTTON_B): + # buttons de-pressed + is_pressed = False + for i, b in enumerate(buttons): + b.selected=False + # otherwise, continue holding + continue + if pressed & BUTTON_B: + is_pressed = True if mouse_cursor.hide: - mouse_cursor.hide = False + mouse_cursor.hide = False else: mouse_cursor.hide = True - elif ((pad_btns & BUTTON_A) > 0) and not mouse_cursor.hide: - is_a_clicked = True - -is_a_clicked = False -current_btns = pad.get_pressed() -while True: - if lis3dh.tapped: - print('tapped!') - mouse_cursor.scale = 2 - time.sleep(0.5) - mouse_cursor.scale = 1 - btns = pad.get_pressed() - check_dpad(btns) - if current_btns != btns: - check_btns(btns) - current_btns = btns - # check the coordinates of the cursor - p = mouse_cursor.x, mouse_cursor.y - if p: + if pressed & BUTTON_A: + is_pressed = True for i, b in enumerate(buttons): - if b.contains(p) and is_a_clicked: + if b.contains((mouse_cursor.x, mouse_cursor.y)): print("Button %d pressed"%i) - b.selected = True - is_a_clicked = False - else: - b.selected = False - time.sleep(0.01) \ No newline at end of file + if i == 0: # Increase the cursor speed + mouse_cursor.speed += 1 + elif i == 1: # Decrease the cursor speed + mouse_cursor.speed -= 1 + if i == 2: # Increase the cursor scale + mouse_cursor.scale += 1 + elif i == 3: # Decrease the cursor scale + mouse_cursor.scale -= 1 + b.selected=True From 41fc40457a0425f4dd30bcb7f154880415c3b92d Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 12:47:25 -0400 Subject: [PATCH 12/36] add dynamic boundingbox from display, remove loading a cursor bitmap --- adafruit_cursor.py | 46 ++++++++++++---------------------------------- 1 file changed, 12 insertions(+), 34 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index b1cc40b..73b6320 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -55,8 +55,9 @@ def __init__(self, display=None, display_group=None, is_hidden=False, cursor_spe self._display = display self._scale = scale self._display_grp = display_group - self._display_width = display.width - self._display_height = display.height + self._disp_x = display.height + self._disp_y = display.width + self._disp_sz = self._disp_x - 1, self._disp_y - 1 self._speed = cursor_speed self._is_hidden = is_hidden self.generate_cursor() @@ -97,10 +98,10 @@ def x(self, x_val): """Sets the x-value of the cursor. :param int x_val: x position, in pixels. """ - if self._cursor_grp.x - self._speed < 0: - self._cursor_grp.x = self._cursor_grp.x + 1 - elif self._cursor_grp.x + self._speed > self._display_width - 25: - self._cursor_grp.x = self._cursor_grp.x - 1 + if x_val < 0 and not self._is_hidden: + self._cursor_grp.x = self._cursor_grp.x + elif x_val > self._disp_sz[1] and not self._is_hidden: + self._cursor_grp.x = self._cursor_grp.x elif not self._is_hidden: self._cursor_grp.x = x_val @@ -114,10 +115,10 @@ def y(self, y_val): """Sets the y-value of the cursor. :param int y_val: y position, in pixels. """ - if self._cursor_grp.y - self._speed < 0: - self._cursor_grp.y = self._cursor_grp.y + 1 - elif self._cursor_grp.y + self._speed > self._display_height - 25: - self._cursor_grp.y = self._cursor_grp.y - 1 + if y_val < 0 and not self._is_hidden: + self._cursor_grp.y = self._cursor_grp.y + elif y_val > self._disp_sz[0] and not self._is_hidden: + self._cursor_grp.y = self._cursor_grp.y elif not self._is_hidden: self._cursor_grp.y = y_val @@ -141,7 +142,7 @@ def hide(self, is_hidden): self._display_grp.append(self._cursor_grp) def generate_cursor(self): - """Generates a cursor bitmap""" + """Generates a cursor icon bitmap""" self._cursor_grp = displayio.Group(max_size=1, scale=self._scale) self._pointer_bitmap = displayio.Bitmap(20, 20, 3) self._pointer_palette = displayio.Palette(3) @@ -174,26 +175,3 @@ def generate_cursor(self): self._pointer_sprite = displayio.TileGrid(self._pointer_bitmap, pixel_shader=self._pointer_palette) self._cursor_grp.append(self._pointer_sprite) self._display_grp.append(self._cursor_grp) - - def load_cursor_bitmap(self, cursor_path, sheet_width, sheet_height, tile_width, tile_height): - """Loads and creates a custom cursor bitmap from a sprite sheet bitmap image. - :param str cursor_path: Path to cursor bitmap on the CIRCUITPY file system. - :param int sheet_width: Width of sprite sheet bitmap, in pixels . - :param int sheet_height: Height of sprite sheet bitmap, in pixels. - :param int tile_width: Width of cursor image, in pixels. - :param int tile_height: Height of cursor, in pixels - """ - import adafruit_imageload - # remove a pre-generated cursor image - self._cursor_grp.remove(self._pointer_sprite) - self._sprite_sheet, self._palette = adafruit_imageload.load(cursor_path, - bitmap=displayio.Bitmap, - palette=displayio.Palette) - self._sprite = displayio.TileGrid(self._sprite_sheet, pixel_shader=self._palette, - width=sheet_width, - height=sheet_height, - tile_width=tile_width, - tile_height=tile_height) - self._cursor_grp = displayio.Group(max_size=1, scale=self._scale) - self._cursor_grp.append(self._sprite) - self._display_grp.append(self._cursor_grp) From ad31b572ce61444ed127fd1944455ccab8185837 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 14:46:13 -0400 Subject: [PATCH 13/36] pylint! --- adafruit_cursor.py | 70 ++++++++++++++++++++-------------------------- 1 file changed, 30 insertions(+), 40 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 73b6320..7d8ad10 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -23,7 +23,7 @@ `adafruit_cursor` ================================================================================ -Simulated mouse cursor for display interaction +Simulated mouse cursor for interaction using displayio Groups. * Author(s): Brent Rubell @@ -51,15 +51,14 @@ class Cursor: ;param int scale: Scale amount for the cursor in both directions. :param bool is_hidden: Cursor is hidden on init. """ + # pylint: disable=too-many-arguments def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=5, scale=1): self._display = display self._scale = scale - self._display_grp = display_group - self._disp_x = display.height - self._disp_y = display.width - self._disp_sz = self._disp_x - 1, self._disp_y - 1 self._speed = cursor_speed self._is_hidden = is_hidden + self._display_grp = display_group + self._disp_sz = display.height - 1, display.width - 1 self.generate_cursor() @property @@ -96,7 +95,7 @@ def x(self): @x.setter def x(self, x_val): """Sets the x-value of the cursor. - :param int x_val: x position, in pixels. + :param int x_val: cursor x-position, in pixels. """ if x_val < 0 and not self._is_hidden: self._cursor_grp.x = self._cursor_grp.x @@ -113,7 +112,7 @@ def y(self): @y.setter def y(self, y_val): """Sets the y-value of the cursor. - :param int y_val: y position, in pixels. + :param int y_val: cursor y-position, in pixels. """ if y_val < 0 and not self._is_hidden: self._cursor_grp.y = self._cursor_grp.y @@ -122,16 +121,11 @@ def y(self, y_val): elif not self._is_hidden: self._cursor_grp.y = y_val - @property - def is_hidden(self): - """Returns if the cursor is hidden or visible on the display.""" - return self._is_hidden - @property def hide(self): - """Returns if the cursor is hidden or visible on the display.""" + """Returns True if the cursor is hidden or visible on the display.""" return self._is_hidden - + @hide.setter def hide(self, is_hidden): if is_hidden: @@ -142,36 +136,32 @@ def hide(self, is_hidden): self._display_grp.append(self._cursor_grp) def generate_cursor(self): - """Generates a cursor icon bitmap""" + """Generates a cursor icon""" self._cursor_grp = displayio.Group(max_size=1, scale=self._scale) - self._pointer_bitmap = displayio.Bitmap(20, 20, 3) - self._pointer_palette = displayio.Palette(3) - self._pointer_palette.make_transparent(0) - self._pointer_palette[1] = 0xFFFFFF - self._pointer_palette[2] = 0x0000 + self._cur_bmp = displayio.Bitmap(20, 20, 3) + self._cur_palette = displayio.Palette(3) + self._cur_palette.make_transparent(0) + self._cur_palette[1] = 0xFFFFFF + self._cur_palette[2] = 0x0000 # left edge, outline - for i in range(0, self._pointer_bitmap.height): - self._pointer_bitmap[0, i] = 2 - # inside fill + for i in range(0, self._cur_bmp.height): + self._cur_bmp[0, i] = 2 + # right diag outline, inside fill for j in range(1, 15): - for i in range(j+1, self._pointer_bitmap.height - j): - self._pointer_bitmap[j, i] = 1 - # right diag., outline - for i in range(1, 15): - self._pointer_bitmap[i, i] = 2 + self._cur_bmp[j, j] = 2 + for i in range(j+1, self._cur_bmp.height - j): + self._cur_bmp[j, i] = 1 # bottom diag., outline for i in range(1, 5): - self._pointer_bitmap[i, self._pointer_bitmap.height-i] = 2 - # bottom flat line, outline - for i in range(5, 15): - self._pointer_bitmap[i, 15] = 2 - # right side fill + self._cur_bmp[i, self._cur_bmp.height-i] = 2 + # bottom flat line, right side fill for i in range(5, 15): - self._pointer_bitmap[i-1, 14] = 1 - self._pointer_bitmap[i-2, 13] = 1 - self._pointer_bitmap[i-3, 12] = 1 - self._pointer_bitmap[i-4, 11] = 1 - # create a tilegrid out of the bitmap and palette - self._pointer_sprite = displayio.TileGrid(self._pointer_bitmap, pixel_shader=self._pointer_palette) - self._cursor_grp.append(self._pointer_sprite) + self._cur_bmp[i, 15] = 2 + self._cur_bmp[i-1, 14] = 1 + self._cur_bmp[i-2, 13] = 1 + self._cur_bmp[i-3, 12] = 1 + self._cur_bmp[i-4, 11] = 1 + self._cur_sprite = displayio.TileGrid(self._cur_bmp, + pixel_shader=self._cur_palette) + self._cursor_grp.append(self._cur_sprite) self._display_grp.append(self._cursor_grp) From cfb1c6f1ebaf28e8beab91fa7ab71660a2515f04 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 15:15:59 -0400 Subject: [PATCH 14/36] add simpletest, remove buttontest --- examples/code.py | 147 ---------------------------------- examples/cursor_simpletest.py | 58 ++++++++++++++ 2 files changed, 58 insertions(+), 147 deletions(-) delete mode 100755 examples/code.py diff --git a/examples/code.py b/examples/code.py deleted file mode 100755 index 4d83f61..0000000 --- a/examples/code.py +++ /dev/null @@ -1,147 +0,0 @@ -# using adafruit_cursor with adafruit_button -import time - -import board -import digitalio -from micropython import const - -import adafruit_cursor -import displayio -from adafruit_bitmap_font import bitmap_font -from adafruit_button import Button -from adafruit_display_text import label -from gamepadshift import GamePadShift - -# PyBadge Button Masks -BUTTON_LEFT = const(128) -BUTTON_UP = const(64) -BUTTON_DOWN = const(32) -BUTTON_RIGHT = const(16) -BUTTON_A = const(2) -BUTTON_B = const(1) - -# Initialize PyBadge Gamepad -pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH)) - -# Load the font -THE_FONT = "/fonts/Arial-12.bdf" -font = bitmap_font.load_font(THE_FONT) - -# Create the display -display = board.DISPLAY - -# Create the display context -splash = displayio.Group(max_size=22) - -########################################################################## -# Make a background color fill - -color_bitmap = displayio.Bitmap(320, 240, 1) -color_palette = displayio.Palette(1) -color_palette[0] = 0x404040 -bg_sprite = displayio.TileGrid(color_bitmap, - pixel_shader=color_palette, - x=0, y=0) -splash.append(bg_sprite) - -########################################################################## - -# Set up button size info -BUTTON_WIDTH = 80 -BUTTON_HEIGHT = 40 -BUTTON_MARGIN = 20 - -# Create the buttons -buttons = [] - -button_speed_inc = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN+BUTTON_HEIGHT, - width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="+ Speed", label_font=font) -buttons.append(button_speed_inc) - -button_speed_dec = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, - width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="- Speed", label_font=font) -buttons.append(button_speed_dec) - -button_scale_pos = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN+BUTTON_HEIGHT, - width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="+ Scale", label_font=font, style=Button.SHADOWRECT) -buttons.append(button_scale_pos) - -button_scale_neg = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, - width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="- Scale", label_font=font, style=Button.SHADOWRECT) -buttons.append(button_scale_neg) - -# Show the button -for b in buttons: - splash.append(b.group) - -# Create a text label -text_label = label.Label(font, text="CircuitPython Cursor!", color=0x00FF00, - x = 100, y = 20) -splash.append(text_label) - -text_speed = label.Label(font, max_glyphs = 11, color=0x00FF00, - x = 120, y = 40) -splash.append(text_speed) - -text_scale = label.Label(font, max_glyphs = 11, color=0x00FF00, - x = 120, y = 60) -splash.append(text_scale) - -# initialize the mouse cursor object -mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) - -# show displayio group -display.show(splash) - -def check_dpad(d_pad_buttons): - """Checks the directional pad for button presses.""" - if pressed & BUTTON_RIGHT: - mouse_cursor.x += mouse_cursor.speed - elif pressed & BUTTON_LEFT: - mouse_cursor.x -= mouse_cursor.speed - if pressed & BUTTON_DOWN: - mouse_cursor.y += mouse_cursor.speed - elif pressed & BUTTON_UP: - mouse_cursor.y -= mouse_cursor.speed - -is_pressed = False -while True: - display.wait_for_frame() - text_speed.text = 'Speed: {0}'.format(mouse_cursor.speed) - text_scale.text = 'Scale: {0}'.format(mouse_cursor.scale) - pressed = pad.get_pressed() - check_dpad(pressed) - if is_pressed: - if not pressed & (BUTTON_A | BUTTON_B): - # buttons de-pressed - is_pressed = False - for i, b in enumerate(buttons): - b.selected=False - # otherwise, continue holding - continue - if pressed & BUTTON_B: - is_pressed = True - if mouse_cursor.hide: - mouse_cursor.hide = False - else: - mouse_cursor.hide = True - if pressed & BUTTON_A: - is_pressed = True - for i, b in enumerate(buttons): - if b.contains((mouse_cursor.x, mouse_cursor.y)): - print("Button %d pressed"%i) - if i == 0: # Increase the cursor speed - mouse_cursor.speed += 1 - elif i == 1: # Decrease the cursor speed - mouse_cursor.speed -= 1 - if i == 2: # Increase the cursor scale - mouse_cursor.scale += 1 - elif i == 3: # Decrease the cursor scale - mouse_cursor.scale -= 1 - b.selected=True diff --git a/examples/cursor_simpletest.py b/examples/cursor_simpletest.py index e69de29..bd02834 100644 --- a/examples/cursor_simpletest.py +++ b/examples/cursor_simpletest.py @@ -0,0 +1,58 @@ +import adafruit_cursor +import board +import digitalio +import displayio +from gamepadshift import GamePadShift +from micropython import const + +# PyBadge Button Masks +BUTTON_LEFT = const(128) +BUTTON_UP = const(64) +BUTTON_DOWN = const(32) +BUTTON_RIGHT = const(16) +BUTTON_A = const(2) +BUTTON_B = const(1) + +# Initialize PyBadge Gamepad +pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), + digitalio.DigitalInOut(board.BUTTON_OUT), + digitalio.DigitalInOut(board.BUTTON_LATCH)) + +# Create the display +display = board.DISPLAY + +# Create the display context +splash = displayio.Group(max_size=22) + +# initialize the mouse cursor object +mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) + +# show displayio group +display.show(splash) + +def check_dpad(d_pad_buttons): + """Checks the directional pad for button presses.""" + if d_pad_buttons & BUTTON_RIGHT: + mouse_cursor.x += mouse_cursor.speed + elif d_pad_buttons & BUTTON_LEFT: + mouse_cursor.x -= mouse_cursor.speed + if d_pad_buttons & BUTTON_DOWN: + mouse_cursor.y += mouse_cursor.speed + elif d_pad_buttons & BUTTON_UP: + mouse_cursor.y -= mouse_cursor.speed + +is_pressed = False +while True: + display.wait_for_frame() + pressed = pad.get_pressed() + check_dpad(pressed) + if is_pressed: + if not pressed & (BUTTON_A | BUTTON_B): + is_pressed = False + continue + if pressed & BUTTON_A: + is_pressed = True + if mouse_cursor.hide: + mouse_cursor.hide = False + else: + mouse_cursor.hide = True From 753946404bed301f021a8b96cbb2f83c7ae4dbe8 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 15:19:57 -0400 Subject: [PATCH 15/36] add advanced cursor+btns+txt demo example --- examples/cursor_buttons_text.py | 143 ++++++++++++++++++++++++++++++++ 1 file changed, 143 insertions(+) create mode 100755 examples/cursor_buttons_text.py diff --git a/examples/cursor_buttons_text.py b/examples/cursor_buttons_text.py new file mode 100755 index 0000000..f60c87a --- /dev/null +++ b/examples/cursor_buttons_text.py @@ -0,0 +1,143 @@ +import adafruit_cursor +import board +import digitalio +import displayio +from adafruit_bitmap_font import bitmap_font +from adafruit_button import Button +from adafruit_display_text import label +from gamepadshift import GamePadShift +from micropython import const + +# PyBadge Button Masks +BUTTON_LEFT = const(128) +BUTTON_UP = const(64) +BUTTON_DOWN = const(32) +BUTTON_RIGHT = const(16) +BUTTON_A = const(2) +BUTTON_B = const(1) + +# Initialize PyBadge Gamepad +pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), + digitalio.DigitalInOut(board.BUTTON_OUT), + digitalio.DigitalInOut(board.BUTTON_LATCH)) + +# Load the font +THE_FONT = "/fonts/Arial-12.bdf" +font = bitmap_font.load_font(THE_FONT) + +# Create the display +display = board.DISPLAY + +# Create the display context +splash = displayio.Group(max_size=22) + +########################################################################## +# Make a background color fill + +color_bitmap = displayio.Bitmap(320, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x404040 +bg_sprite = displayio.TileGrid(color_bitmap, + pixel_shader=color_palette, + x=0, y=0) +splash.append(bg_sprite) + +########################################################################## + +# Set up button size info +BUTTON_WIDTH = 80 +BUTTON_HEIGHT = 40 +BUTTON_MARGIN = 20 + +# Create the buttons +buttons = [] + +button_speed_inc = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="+ Speed", label_font=font) +buttons.append(button_speed_inc) + +button_speed_dec = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="- Speed", label_font=font) +buttons.append(button_speed_dec) + +button_scale_pos = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="+ Scale", label_font=font, style=Button.SHADOWRECT) +buttons.append(button_scale_pos) + +button_scale_neg = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="- Scale", label_font=font, style=Button.SHADOWRECT) +buttons.append(button_scale_neg) + +# Show the button +for b in buttons: + splash.append(b.group) + +# Create a text label +text_label = label.Label(font, text="CircuitPython Cursor!", color=0x00FF00, + x = 100, y = 20) +splash.append(text_label) + +text_speed = label.Label(font, max_glyphs = 15, color=0x00FF00, + x = 120, y = 40) +splash.append(text_speed) + +text_scale = label.Label(font, max_glyphs = 15, color=0x00FF00, + x = 120, y = 60) +splash.append(text_scale) + +# initialize the mouse cursor object +mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) + +# show displayio group +display.show(splash) + +def check_dpad(d_pad_buttons): + """Checks the directional pad for button presses.""" + if d_pad_buttons & BUTTON_RIGHT: + mouse_cursor.x += mouse_cursor.speed + elif d_pad_buttons & BUTTON_LEFT: + mouse_cursor.x -= mouse_cursor.speed + if d_pad_buttons & BUTTON_DOWN: + mouse_cursor.y += mouse_cursor.speed + elif d_pad_buttons & BUTTON_UP: + mouse_cursor.y -= mouse_cursor.speed + +is_pressed = False +while True: + display.wait_for_frame() + text_speed.text = 'Speed: {0}px'.format(mouse_cursor.speed) + text_scale.text = 'Scale: {0}px'.format(mouse_cursor.scale) + pressed = pad.get_pressed() + check_dpad(pressed) + if is_pressed: + if not pressed & (BUTTON_A | BUTTON_B): + # buttons de-pressed + is_pressed = False + for i, b in enumerate(buttons): + b.selected=False + # otherwise, continue holding + continue + if pressed & BUTTON_B: + is_pressed = True + if mouse_cursor.hide: + mouse_cursor.hide = False + else: + mouse_cursor.hide = True + if pressed & BUTTON_A: + is_pressed = True + for i, b in enumerate(buttons): + if b.contains((mouse_cursor.x, mouse_cursor.y)): + print("Button %d pressed"%i) + if i == 0: # Increase the cursor speed + mouse_cursor.speed += 1 + elif i == 1: # Decrease the cursor speed + mouse_cursor.speed -= 1 + if i == 2: # Increase the cursor scale + mouse_cursor.scale += 1 + elif i == 3: # Decrease the cursor scale + mouse_cursor.scale -= 1 + b.selected=True From 034026e985d57bf8d3cad9831b0be6a71a104c2d Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 15:42:57 -0400 Subject: [PATCH 16/36] remove dispio dep, display object is passed in, add code example --- adafruit_cursor.py | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 7d8ad10..6abb023 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -23,7 +23,7 @@ `adafruit_cursor` ================================================================================ -Simulated mouse cursor for interaction using displayio Groups. +Mouse cursor for interaction with displayio Groups. * Author(s): Brent Rubell @@ -37,19 +37,31 @@ * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases """ -import displayio __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cursor.git" class Cursor: - """Mouse cursor-like interaction for CircuitPython. + """Mouse cursor interaction for CircuitPython. :param displayio.Display: CircuitPython display object. :param displayio.Group: CircuitPython group object to append the cursor to. :param int cursor_speed: Speed of the cursor, in pixels. ;param int scale: Scale amount for the cursor in both directions. :param bool is_hidden: Cursor is hidden on init. + + Example for creating a cursor layer: + .. code-block:: python + import adafruit_cursor + # Create the display + display = board.DISPLAY + + # Create the display context + splash = displayio.Group(max_size=22) + + # initialize the mouse cursor object + mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) + """ # pylint: disable=too-many-arguments def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=5, scale=1): From 3b50809c4325615b1e4484745b7c49be21831ad8 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 16:13:42 -0400 Subject: [PATCH 17/36] update readme, update library, sphinx builds --- README.rst | 9 +++------ adafruit_cursor.py | 26 +++++++++++++------------- docs/conf.py | 2 +- docs/index.rst | 4 ---- 4 files changed, 17 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index 7e0ac14..5dbaa37 100644 --- a/README.rst +++ b/README.rst @@ -13,8 +13,8 @@ Introduction :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Cursor :alt: Build Status -Simulated mouse cursor for display interaction - +Mouse cursor for interaction with CircuitPython UI elements such as +`buttons `_. Dependencies ============= @@ -31,9 +31,6 @@ Installing from PyPI .. note:: This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability! -.. todo:: Remove the above note if PyPI version is/will be available at time of release. - If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. - On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI `_. To install for current user: @@ -59,7 +56,7 @@ To install in a virtual environment in your current project: Usage Example ============= -.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. +See examples in examples/ folder. Contributing ============ diff --git a/adafruit_cursor.py b/adafruit_cursor.py index 6abb023..f2e0552 100755 --- a/adafruit_cursor.py +++ b/adafruit_cursor.py @@ -30,13 +30,12 @@ Implementation Notes -------------------- -**Hardware:** - **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases """ +import displayio __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cursor.git" @@ -44,24 +43,25 @@ class Cursor: """Mouse cursor interaction for CircuitPython. - :param displayio.Display: CircuitPython display object. - :param displayio.Group: CircuitPython group object to append the cursor to. + :param ~displayio.Display display: CircuitPython display object. + :param ~displayio.Group display_group: CircuitPython group object to append the cursor to. :param int cursor_speed: Speed of the cursor, in pixels. - ;param int scale: Scale amount for the cursor in both directions. + :param int scale: Scale amount for the cursor in both directions. :param bool is_hidden: Cursor is hidden on init. - Example for creating a cursor layer: + Example for creating a cursor layer + .. code-block:: python - import adafruit_cursor - # Create the display - display = board.DISPLAY - # Create the display context - splash = displayio.Group(max_size=22) + import adafruit_cursor + # Create the display + display = board.DISPLAY - # initialize the mouse cursor object - mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) + # Create the display context + splash = displayio.Group(max_size=22) + # initialize the mouse cursor object + mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) """ # pylint: disable=too-many-arguments def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=5, scale=1): diff --git a/docs/conf.py b/docs/conf.py index 163f827..4d8c3f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # 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 = ["digitalio", "busio"] +autodoc_mock_imports = ["displayio"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} diff --git a/docs/index.rst b/docs/index.rst index c36c124..339cfa0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,14 +23,10 @@ Table of Contents .. toctree:: :caption: Tutorials -.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave - the toctree above for use later. .. toctree:: :caption: Related Products -.. todo:: Add any product links here. If there are none, then simply delete this todo and leave - the toctree above for use later. .. toctree:: :caption: Other Links From 08fce52fb4006d12d099348ae44847db9abceb7d Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 17:43:24 -0400 Subject: [PATCH 18/36] fresh cookiecutter --- .travis.yml | 4 +- README.rst | 29 +++-- adafruit_cursor.py | 179 --------------------------- adafruit_cursorcontrol.py | 53 ++++++++ docs/api.rst | 2 +- docs/conf.py | 14 +-- docs/examples.rst | 4 +- docs/index.rst | 6 +- examples/cursor_buttons_text.py | 143 --------------------- examples/cursor_simpletest.py | 58 --------- examples/cursorcontrol_simpletest.py | 0 requirements.txt | 2 +- setup.py | 12 +- 13 files changed, 93 insertions(+), 413 deletions(-) delete mode 100755 adafruit_cursor.py create mode 100644 adafruit_cursorcontrol.py delete mode 100755 examples/cursor_buttons_text.py delete mode 100644 examples/cursor_simpletest.py create mode 100644 examples/cursorcontrol_simpletest.py diff --git a/.travis.yml b/.travis.yml index 0bc7e6d..4a51621 100644 --- a/.travis.yml +++ b/.travis.yml @@ -42,7 +42,7 @@ install: - pip install --force-reinstall pylint==1.9.2 script: - - pylint adafruit_cursor.py + - pylint adafruit_cursorcontrol.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursor --library_location . + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursorcontrol --library_location . - cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/README.rst b/README.rst index 5dbaa37..0f35d61 100644 --- a/README.rst +++ b/README.rst @@ -1,20 +1,20 @@ Introduction ============ -.. image:: https://readthedocs.org/projects/adafruit-circuitpython-cursor/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/cursor/en/latest/ +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-cursorcontrol/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/cursorcontrol/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg :target: https://discord.gg/nBQh6qu :alt: Discord -.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Cursor.svg?branch=master - :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Cursor +.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_CursorControl.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_CursorControl :alt: Build Status -Mouse cursor for interaction with CircuitPython UI elements such as -`buttons `_. +Mouse cursor for interaction with CircuitPython UI elements. + Dependencies ============= @@ -31,18 +31,21 @@ Installing from PyPI .. note:: This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability! +.. todo:: Remove the above note if PyPI version is/will be available at time of release. + If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. + On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from -PyPI `_. To install for current user: +PyPI `_. To install for current user: .. code-block:: shell - pip3 install adafruit-circuitpython-cursor + pip3 install adafruit-circuitpython-cursorcontrol To install system-wide (this may be required in some cases): .. code-block:: shell - sudo pip3 install adafruit-circuitpython-cursor + sudo pip3 install adafruit-circuitpython-cursorcontrol To install in a virtual environment in your current project: @@ -51,18 +54,18 @@ To install in a virtual environment in your current project: mkdir project-name && cd project-name python3 -m venv .env source .env/bin/activate - pip3 install adafruit-circuitpython-cursor + pip3 install adafruit-circuitpython-cursorcontrol Usage Example ============= -See examples in examples/ folder. +.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. Building locally @@ -90,7 +93,7 @@ Then run the build: .. code-block:: shell - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursor --library_location . + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursorcontrol --library_location . Sphinx documentation ----------------------- diff --git a/adafruit_cursor.py b/adafruit_cursor.py deleted file mode 100755 index f2e0552..0000000 --- a/adafruit_cursor.py +++ /dev/null @@ -1,179 +0,0 @@ -# The MIT License (MIT) -# -# Copyright (c) 2019 Brent Rubell 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. -""" -`adafruit_cursor` -================================================================================ - -Mouse cursor for interaction with displayio Groups. - -* Author(s): Brent Rubell - -Implementation Notes --------------------- - -**Software and Dependencies:** - -* Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases -""" -import displayio - -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cursor.git" - -class Cursor: - """Mouse cursor interaction for CircuitPython. - - :param ~displayio.Display display: CircuitPython display object. - :param ~displayio.Group display_group: CircuitPython group object to append the cursor to. - :param int cursor_speed: Speed of the cursor, in pixels. - :param int scale: Scale amount for the cursor in both directions. - :param bool is_hidden: Cursor is hidden on init. - - Example for creating a cursor layer - - .. code-block:: python - - import adafruit_cursor - # Create the display - display = board.DISPLAY - - # Create the display context - splash = displayio.Group(max_size=22) - - # initialize the mouse cursor object - mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) - """ - # pylint: disable=too-many-arguments - def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=5, scale=1): - self._display = display - self._scale = scale - self._speed = cursor_speed - self._is_hidden = is_hidden - self._display_grp = display_group - self._disp_sz = display.height - 1, display.width - 1 - self.generate_cursor() - - @property - def scale(self): - """Returns the cursor's scale amount as an integer.""" - return self._scale - - @scale.setter - def scale(self, scale_value): - """Scales the cursor by scale_value in both directions. - :param int scale_value: Amount to scale the cursor by. - """ - if scale_value > 0: - self._scale = scale_value - self._cursor_grp.scale = scale_value - - @property - def speed(self): - """Returns the cursor's speed, in pixels.""" - return self._speed - - @speed.setter - def speed(self, speed): - """Sets the speed of the cursor. - :param int speed: Cursor movement speed, in pixels. - """ - self._speed = speed - - @property - def x(self): - """Returns the cursor's x-coordinate.""" - return self._cursor_grp.x - - @x.setter - def x(self, x_val): - """Sets the x-value of the cursor. - :param int x_val: cursor x-position, in pixels. - """ - if x_val < 0 and not self._is_hidden: - self._cursor_grp.x = self._cursor_grp.x - elif x_val > self._disp_sz[1] and not self._is_hidden: - self._cursor_grp.x = self._cursor_grp.x - elif not self._is_hidden: - self._cursor_grp.x = x_val - - @property - def y(self): - """Returns the cursor's y-coordinate.""" - return self._cursor_grp.y - - @y.setter - def y(self, y_val): - """Sets the y-value of the cursor. - :param int y_val: cursor y-position, in pixels. - """ - if y_val < 0 and not self._is_hidden: - self._cursor_grp.y = self._cursor_grp.y - elif y_val > self._disp_sz[0] and not self._is_hidden: - self._cursor_grp.y = self._cursor_grp.y - elif not self._is_hidden: - self._cursor_grp.y = y_val - - @property - def hide(self): - """Returns True if the cursor is hidden or visible on the display.""" - return self._is_hidden - - @hide.setter - def hide(self, is_hidden): - if is_hidden: - self._is_hidden = True - self._display_grp.remove(self._cursor_grp) - else: - self._is_hidden = False - self._display_grp.append(self._cursor_grp) - - def generate_cursor(self): - """Generates a cursor icon""" - self._cursor_grp = displayio.Group(max_size=1, scale=self._scale) - self._cur_bmp = displayio.Bitmap(20, 20, 3) - self._cur_palette = displayio.Palette(3) - self._cur_palette.make_transparent(0) - self._cur_palette[1] = 0xFFFFFF - self._cur_palette[2] = 0x0000 - # left edge, outline - for i in range(0, self._cur_bmp.height): - self._cur_bmp[0, i] = 2 - # right diag outline, inside fill - for j in range(1, 15): - self._cur_bmp[j, j] = 2 - for i in range(j+1, self._cur_bmp.height - j): - self._cur_bmp[j, i] = 1 - # bottom diag., outline - for i in range(1, 5): - self._cur_bmp[i, self._cur_bmp.height-i] = 2 - # bottom flat line, right side fill - for i in range(5, 15): - self._cur_bmp[i, 15] = 2 - self._cur_bmp[i-1, 14] = 1 - self._cur_bmp[i-2, 13] = 1 - self._cur_bmp[i-3, 12] = 1 - self._cur_bmp[i-4, 11] = 1 - self._cur_sprite = displayio.TileGrid(self._cur_bmp, - pixel_shader=self._cur_palette) - self._cursor_grp.append(self._cur_sprite) - self._display_grp.append(self._cursor_grp) diff --git a/adafruit_cursorcontrol.py b/adafruit_cursorcontrol.py new file mode 100644 index 0000000..ccb3e43 --- /dev/null +++ b/adafruit_cursorcontrol.py @@ -0,0 +1,53 @@ +# The MIT License (MIT) +# +# Copyright (c) 2019 Brent Rubell 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. +""" +`adafruit_cursorcontrol` +================================================================================ + +Mouse cursor for interaction with CircuitPython UI elements. + + +* Author(s): Brent Rubell + +Implementation Notes +-------------------- + +**Hardware:** + +.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST + inline format: "* `Link Text `_" + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the library's use of either. + +# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice +# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register +""" + +# imports + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CursorControl.git" diff --git a/docs/api.rst b/docs/api.rst index 54054bc..852bb94 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,5 @@ .. 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_cursor +.. automodule:: adafruit_cursorcontrol :members: diff --git a/docs/conf.py b/docs/conf.py index 4d8c3f3..4470a5b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # 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"] +# autodoc_mock_imports = ["digitalio", "busio"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} @@ -34,7 +34,7 @@ master_doc = 'index' # General information about the project. -project = u'Adafruit Cursor Library' +project = u'Adafruit CursorControl Library' copyright = u'2019 Brent Rubell' author = u'Brent Rubell' @@ -109,7 +109,7 @@ html_favicon = '_static/favicon.ico' # Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitCursorLibrarydoc' +htmlhelp_basename = 'AdafruitCursorcontrolLibrarydoc' # -- Options for LaTeX output --------------------------------------------- @@ -135,7 +135,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'AdafruitCursorLibrary.tex', u'AdafruitCursor Library Documentation', + (master_doc, 'AdafruitCursorControlLibrary.tex', u'AdafruitCursorControl Library Documentation', author, 'manual'), ] @@ -144,7 +144,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitCursorlibrary', u'Adafruit Cursor Library Documentation', + (master_doc, 'AdafruitCursorControllibrary', u'Adafruit CursorControl Library Documentation', [author], 1) ] @@ -154,7 +154,7 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitCursorLibrary', u'Adafruit Cursor Library Documentation', - author, 'AdafruitCursorLibrary', 'One line description of project.', + (master_doc, 'AdafruitCursorControlLibrary', u'Adafruit CursorControl Library Documentation', + author, 'AdafruitCursorControlLibrary', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/examples.rst b/docs/examples.rst index c677285..23b7958 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -3,6 +3,6 @@ Simple test Ensure your device works with this simple test. -.. literalinclude:: ../examples/cursor_simpletest.py - :caption: examples/cursor_simpletest.py +.. literalinclude:: ../examples/cursorcontrol_simpletest.py + :caption: examples/cursorcontrol_simpletest.py :linenos: diff --git a/docs/index.rst b/docs/index.rst index 339cfa0..394b6c5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,15 +23,19 @@ Table of Contents .. toctree:: :caption: Tutorials +.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave + the toctree above for use later. .. toctree:: :caption: Related Products +.. todo:: Add any product links here. If there are none, then simply delete this todo and leave + the toctree above for use later. .. toctree:: :caption: Other Links - Download + Download CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat diff --git a/examples/cursor_buttons_text.py b/examples/cursor_buttons_text.py deleted file mode 100755 index f60c87a..0000000 --- a/examples/cursor_buttons_text.py +++ /dev/null @@ -1,143 +0,0 @@ -import adafruit_cursor -import board -import digitalio -import displayio -from adafruit_bitmap_font import bitmap_font -from adafruit_button import Button -from adafruit_display_text import label -from gamepadshift import GamePadShift -from micropython import const - -# PyBadge Button Masks -BUTTON_LEFT = const(128) -BUTTON_UP = const(64) -BUTTON_DOWN = const(32) -BUTTON_RIGHT = const(16) -BUTTON_A = const(2) -BUTTON_B = const(1) - -# Initialize PyBadge Gamepad -pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH)) - -# Load the font -THE_FONT = "/fonts/Arial-12.bdf" -font = bitmap_font.load_font(THE_FONT) - -# Create the display -display = board.DISPLAY - -# Create the display context -splash = displayio.Group(max_size=22) - -########################################################################## -# Make a background color fill - -color_bitmap = displayio.Bitmap(320, 240, 1) -color_palette = displayio.Palette(1) -color_palette[0] = 0x404040 -bg_sprite = displayio.TileGrid(color_bitmap, - pixel_shader=color_palette, - x=0, y=0) -splash.append(bg_sprite) - -########################################################################## - -# Set up button size info -BUTTON_WIDTH = 80 -BUTTON_HEIGHT = 40 -BUTTON_MARGIN = 20 - -# Create the buttons -buttons = [] - -button_speed_inc = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN+BUTTON_HEIGHT, - width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="+ Speed", label_font=font) -buttons.append(button_speed_inc) - -button_speed_dec = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, - width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="- Speed", label_font=font) -buttons.append(button_speed_dec) - -button_scale_pos = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN+BUTTON_HEIGHT, - width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="+ Scale", label_font=font, style=Button.SHADOWRECT) -buttons.append(button_scale_pos) - -button_scale_neg = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, - width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="- Scale", label_font=font, style=Button.SHADOWRECT) -buttons.append(button_scale_neg) - -# Show the button -for b in buttons: - splash.append(b.group) - -# Create a text label -text_label = label.Label(font, text="CircuitPython Cursor!", color=0x00FF00, - x = 100, y = 20) -splash.append(text_label) - -text_speed = label.Label(font, max_glyphs = 15, color=0x00FF00, - x = 120, y = 40) -splash.append(text_speed) - -text_scale = label.Label(font, max_glyphs = 15, color=0x00FF00, - x = 120, y = 60) -splash.append(text_scale) - -# initialize the mouse cursor object -mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) - -# show displayio group -display.show(splash) - -def check_dpad(d_pad_buttons): - """Checks the directional pad for button presses.""" - if d_pad_buttons & BUTTON_RIGHT: - mouse_cursor.x += mouse_cursor.speed - elif d_pad_buttons & BUTTON_LEFT: - mouse_cursor.x -= mouse_cursor.speed - if d_pad_buttons & BUTTON_DOWN: - mouse_cursor.y += mouse_cursor.speed - elif d_pad_buttons & BUTTON_UP: - mouse_cursor.y -= mouse_cursor.speed - -is_pressed = False -while True: - display.wait_for_frame() - text_speed.text = 'Speed: {0}px'.format(mouse_cursor.speed) - text_scale.text = 'Scale: {0}px'.format(mouse_cursor.scale) - pressed = pad.get_pressed() - check_dpad(pressed) - if is_pressed: - if not pressed & (BUTTON_A | BUTTON_B): - # buttons de-pressed - is_pressed = False - for i, b in enumerate(buttons): - b.selected=False - # otherwise, continue holding - continue - if pressed & BUTTON_B: - is_pressed = True - if mouse_cursor.hide: - mouse_cursor.hide = False - else: - mouse_cursor.hide = True - if pressed & BUTTON_A: - is_pressed = True - for i, b in enumerate(buttons): - if b.contains((mouse_cursor.x, mouse_cursor.y)): - print("Button %d pressed"%i) - if i == 0: # Increase the cursor speed - mouse_cursor.speed += 1 - elif i == 1: # Decrease the cursor speed - mouse_cursor.speed -= 1 - if i == 2: # Increase the cursor scale - mouse_cursor.scale += 1 - elif i == 3: # Decrease the cursor scale - mouse_cursor.scale -= 1 - b.selected=True diff --git a/examples/cursor_simpletest.py b/examples/cursor_simpletest.py deleted file mode 100644 index bd02834..0000000 --- a/examples/cursor_simpletest.py +++ /dev/null @@ -1,58 +0,0 @@ -import adafruit_cursor -import board -import digitalio -import displayio -from gamepadshift import GamePadShift -from micropython import const - -# PyBadge Button Masks -BUTTON_LEFT = const(128) -BUTTON_UP = const(64) -BUTTON_DOWN = const(32) -BUTTON_RIGHT = const(16) -BUTTON_A = const(2) -BUTTON_B = const(1) - -# Initialize PyBadge Gamepad -pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH)) - -# Create the display -display = board.DISPLAY - -# Create the display context -splash = displayio.Group(max_size=22) - -# initialize the mouse cursor object -mouse_cursor = adafruit_cursor.Cursor(display, display_group=splash) - -# show displayio group -display.show(splash) - -def check_dpad(d_pad_buttons): - """Checks the directional pad for button presses.""" - if d_pad_buttons & BUTTON_RIGHT: - mouse_cursor.x += mouse_cursor.speed - elif d_pad_buttons & BUTTON_LEFT: - mouse_cursor.x -= mouse_cursor.speed - if d_pad_buttons & BUTTON_DOWN: - mouse_cursor.y += mouse_cursor.speed - elif d_pad_buttons & BUTTON_UP: - mouse_cursor.y -= mouse_cursor.speed - -is_pressed = False -while True: - display.wait_for_frame() - pressed = pad.get_pressed() - check_dpad(pressed) - if is_pressed: - if not pressed & (BUTTON_A | BUTTON_B): - is_pressed = False - continue - if pressed & BUTTON_A: - is_pressed = True - if mouse_cursor.hide: - mouse_cursor.hide = False - else: - mouse_cursor.hide = True diff --git a/examples/cursorcontrol_simpletest.py b/examples/cursorcontrol_simpletest.py new file mode 100644 index 0000000..e69de29 diff --git a/requirements.txt b/requirements.txt index de861d4..2401920 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ Adafruit-Blinka -adafruit-imageload +no diff --git a/setup.py b/setup.py index 38c442c..d013aeb 100644 --- a/setup.py +++ b/setup.py @@ -17,17 +17,17 @@ long_description = f.read() setup( - name='adafruit-circuitpython-cursor', + name='adafruit-circuitpython-cursorcontrol', use_scm_version=True, setup_requires=['setuptools_scm'], - description='Simulated mouse cursor for display interaction', + description='Mouse cursor for interaction with CircuitPython UI elements.', long_description=long_description, long_description_content_type='text/x-rst', # The project's main homepage. - url='https://github.com/adafruit/Adafruit_CircuitPython_Cursor', + url='https://github.com/adafruit/Adafruit_CircuitPython_CursorControl', # Author details author='Adafruit Industries', @@ -35,7 +35,7 @@ install_requires=[ 'Adafruit-Blinka', - 'adafruit-imageload' + 'no' ], # Choose your license @@ -54,11 +54,11 @@ ], # What does your project relate to? - keywords='adafruit blinka circuitpython micropython cursor cursor, mouse, input', + keywords='adafruit blinka circuitpython micropython cursorcontrol mouse, cursor, ui', # 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_cursor'], + py_modules=['adafruit_cursorcontrol'], ) From ba90767cc94f09ee0f00133cf85b110edd293465 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 17:46:08 -0400 Subject: [PATCH 19/36] add code with correct header --- adafruit_cursorcontrol.py | 152 +++++++++++++++++++++++++++++++++++--- 1 file changed, 140 insertions(+), 12 deletions(-) diff --git a/adafruit_cursorcontrol.py b/adafruit_cursorcontrol.py index ccb3e43..41055b8 100644 --- a/adafruit_cursorcontrol.py +++ b/adafruit_cursorcontrol.py @@ -31,23 +31,151 @@ Implementation Notes -------------------- -**Hardware:** - -.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST - inline format: "* `Link Text `_" - **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases -.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the library's use of either. - -# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice -# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register """ - -# imports +import displayio __version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CursorControl.git" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cursor.git" + +class Cursor: + """Mouse cursor interaction for CircuitPython. + + :param ~displayio.Display display: CircuitPython display object. + :param ~displayio.Group display_group: CircuitPython group object to append the cursor to. + :param int cursor_speed: Speed of the cursor, in pixels. + :param int scale: Scale amount for the cursor in both directions. + :param bool is_hidden: Cursor is hidden on init. + + Example for creating a cursor layer + + .. code-block:: python + + from adafruit_cursorcontrol import Cursor + # Create the display + display = board.DISPLAY + + # Create the display context + splash = displayio.Group(max_size=22) + + # initialize the mouse cursor object + mouse_cursor = Cursor(display, display_group=splash) + """ + # pylint: disable=too-many-arguments + def __init__(self, display=None, display_group=None, is_hidden=False, cursor_speed=5, scale=1): + self._display = display + self._scale = scale + self._speed = cursor_speed + self._is_hidden = is_hidden + self._display_grp = display_group + self._disp_sz = display.height - 1, display.width - 1 + self.generate_cursor() + + @property + def scale(self): + """Returns the cursor's scale amount as an integer.""" + return self._scale + + @scale.setter + def scale(self, scale_value): + """Scales the cursor by scale_value in both directions. + :param int scale_value: Amount to scale the cursor by. + """ + if scale_value > 0: + self._scale = scale_value + self._cursor_grp.scale = scale_value + + @property + def speed(self): + """Returns the cursor's speed, in pixels.""" + return self._speed + + @speed.setter + def speed(self, speed): + """Sets the speed of the cursor. + :param int speed: Cursor movement speed, in pixels. + """ + self._speed = speed + + @property + def x(self): + """Returns the cursor's x-coordinate.""" + return self._cursor_grp.x + + @x.setter + def x(self, x_val): + """Sets the x-value of the cursor. + :param int x_val: cursor x-position, in pixels. + """ + if x_val < 0 and not self._is_hidden: + self._cursor_grp.x = self._cursor_grp.x + elif x_val > self._disp_sz[1] and not self._is_hidden: + self._cursor_grp.x = self._cursor_grp.x + elif not self._is_hidden: + self._cursor_grp.x = x_val + + @property + def y(self): + """Returns the cursor's y-coordinate.""" + return self._cursor_grp.y + + @y.setter + def y(self, y_val): + """Sets the y-value of the cursor. + :param int y_val: cursor y-position, in pixels. + """ + if y_val < 0 and not self._is_hidden: + self._cursor_grp.y = self._cursor_grp.y + elif y_val > self._disp_sz[0] and not self._is_hidden: + self._cursor_grp.y = self._cursor_grp.y + elif not self._is_hidden: + self._cursor_grp.y = y_val + + @property + def hide(self): + """Returns True if the cursor is hidden or visible on the display.""" + return self._is_hidden + + @hide.setter + def hide(self, is_hidden): + if is_hidden: + self._is_hidden = True + self._display_grp.remove(self._cursor_grp) + else: + self._is_hidden = False + self._display_grp.append(self._cursor_grp) + + def generate_cursor(self): + """Generates a cursor icon""" + self._cursor_grp = displayio.Group(max_size=1, scale=self._scale) + self._cur_bmp = displayio.Bitmap(20, 20, 3) + self._cur_palette = displayio.Palette(3) + self._cur_palette.make_transparent(0) + self._cur_palette[1] = 0xFFFFFF + self._cur_palette[2] = 0x0000 + # left edge, outline + for i in range(0, self._cur_bmp.height): + self._cur_bmp[0, i] = 2 + # right diag outline, inside fill + for j in range(1, 15): + self._cur_bmp[j, j] = 2 + for i in range(j+1, self._cur_bmp.height - j): + self._cur_bmp[j, i] = 1 + # bottom diag., outline + for i in range(1, 5): + self._cur_bmp[i, self._cur_bmp.height-i] = 2 + # bottom flat line, right side fill + for i in range(5, 15): + self._cur_bmp[i, 15] = 2 + self._cur_bmp[i-1, 14] = 1 + self._cur_bmp[i-2, 13] = 1 + self._cur_bmp[i-3, 12] = 1 + self._cur_bmp[i-4, 11] = 1 + self._cur_sprite = displayio.TileGrid(self._cur_bmp, + pixel_shader=self._cur_palette) + self._cursor_grp.append(self._cur_sprite) + self._display_grp.append(self._cursor_grp) \ No newline at end of file From 75486f5cca02a07ea657e954da3edd7c58c3adc9 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 17:50:50 -0400 Subject: [PATCH 20/36] pylint and sphinx pass --- README.rst | 9 +- adafruit_cursorcontrol.py | 2 +- docs/conf.py | 2 +- docs/index.rst | 6 -- examples/cursorcontrol_buttons_text.py | 143 +++++++++++++++++++++++++ examples/cursorcontrol_simpletest.py | 58 ++++++++++ 6 files changed, 206 insertions(+), 14 deletions(-) create mode 100644 examples/cursorcontrol_buttons_text.py diff --git a/README.rst b/README.rst index 0f35d61..9fc2b8a 100644 --- a/README.rst +++ b/README.rst @@ -13,8 +13,8 @@ Introduction :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_CursorControl :alt: Build Status -Mouse cursor for interaction with CircuitPython UI elements. - +Mouse cursor for interaction with CircuitPython UI elements such as +`buttons `_. Dependencies ============= @@ -31,9 +31,6 @@ Installing from PyPI .. note:: This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability! -.. todo:: Remove the above note if PyPI version is/will be available at time of release. - If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. - On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI `_. To install for current user: @@ -59,7 +56,7 @@ To install in a virtual environment in your current project: Usage Example ============= -.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. +See examples in examples/ folder. Contributing ============ diff --git a/adafruit_cursorcontrol.py b/adafruit_cursorcontrol.py index 41055b8..8af9538 100644 --- a/adafruit_cursorcontrol.py +++ b/adafruit_cursorcontrol.py @@ -178,4 +178,4 @@ def generate_cursor(self): self._cur_sprite = displayio.TileGrid(self._cur_bmp, pixel_shader=self._cur_palette) self._cursor_grp.append(self._cur_sprite) - self._display_grp.append(self._cursor_grp) \ No newline at end of file + self._display_grp.append(self._cursor_grp) diff --git a/docs/conf.py b/docs/conf.py index 4470a5b..18b11b8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # 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 = ["digitalio", "busio"] +autodoc_mock_imports = ["displayio"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} diff --git a/docs/index.rst b/docs/index.rst index 394b6c5..fd29c85 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,15 +23,9 @@ Table of Contents .. toctree:: :caption: Tutorials -.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave - the toctree above for use later. - .. toctree:: :caption: Related Products -.. todo:: Add any product links here. If there are none, then simply delete this todo and leave - the toctree above for use later. - .. toctree:: :caption: Other Links diff --git a/examples/cursorcontrol_buttons_text.py b/examples/cursorcontrol_buttons_text.py new file mode 100644 index 0000000..b9f7bd4 --- /dev/null +++ b/examples/cursorcontrol_buttons_text.py @@ -0,0 +1,143 @@ +import board +import digitalio +import displayio +from adafruit_bitmap_font import bitmap_font +from adafruit_button import Button +from adafruit_cursorcontrol import Cursor +from adafruit_display_text import label +from gamepadshift import GamePadShift +from micropython import const + +# PyBadge Button Masks +BUTTON_LEFT = const(128) +BUTTON_UP = const(64) +BUTTON_DOWN = const(32) +BUTTON_RIGHT = const(16) +BUTTON_A = const(2) +BUTTON_B = const(1) + +# Initialize PyBadge Gamepad +pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), + digitalio.DigitalInOut(board.BUTTON_OUT), + digitalio.DigitalInOut(board.BUTTON_LATCH)) + +# Load the font +THE_FONT = "/fonts/Arial-12.bdf" +font = bitmap_font.load_font(THE_FONT) + +# Create the display +display = board.DISPLAY + +# Create the display context +splash = displayio.Group(max_size=22) + +########################################################################## +# Make a background color fill + +color_bitmap = displayio.Bitmap(320, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x404040 +bg_sprite = displayio.TileGrid(color_bitmap, + pixel_shader=color_palette, + x=0, y=0) +splash.append(bg_sprite) + +########################################################################## + +# Set up button size info +BUTTON_WIDTH = 80 +BUTTON_HEIGHT = 40 +BUTTON_MARGIN = 20 + +# Create the buttons +buttons = [] + +button_speed_inc = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="+ Speed", label_font=font) +buttons.append(button_speed_inc) + +button_speed_dec = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="- Speed", label_font=font) +buttons.append(button_speed_dec) + +button_scale_pos = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="+ Scale", label_font=font, style=Button.SHADOWRECT) +buttons.append(button_scale_pos) + +button_scale_neg = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, + width=BUTTON_WIDTH, height=BUTTON_HEIGHT, + label="- Scale", label_font=font, style=Button.SHADOWRECT) +buttons.append(button_scale_neg) + +# Show the button +for b in buttons: + splash.append(b.group) + +# Create a text label +text_label = label.Label(font, text="CircuitPython Cursor!", color=0x00FF00, + x = 100, y = 20) +splash.append(text_label) + +text_speed = label.Label(font, max_glyphs = 15, color=0x00FF00, + x = 120, y = 40) +splash.append(text_speed) + +text_scale = label.Label(font, max_glyphs = 15, color=0x00FF00, + x = 120, y = 60) +splash.append(text_scale) + +# initialize the mouse cursor object +mouse_cursor = Cursor(display, display_group=splash) + +# show displayio group +display.show(splash) + +def check_dpad(d_pad_buttons): + """Checks the directional pad for button presses.""" + if d_pad_buttons & BUTTON_RIGHT: + mouse_cursor.x += mouse_cursor.speed + elif d_pad_buttons & BUTTON_LEFT: + mouse_cursor.x -= mouse_cursor.speed + if d_pad_buttons & BUTTON_DOWN: + mouse_cursor.y += mouse_cursor.speed + elif d_pad_buttons & BUTTON_UP: + mouse_cursor.y -= mouse_cursor.speed + +is_pressed = False +while True: + display.wait_for_frame() + text_speed.text = 'Speed: {0}px'.format(mouse_cursor.speed) + text_scale.text = 'Scale: {0}px'.format(mouse_cursor.scale) + pressed = pad.get_pressed() + check_dpad(pressed) + if is_pressed: + if not pressed & (BUTTON_A | BUTTON_B): + # buttons de-pressed + is_pressed = False + for i, b in enumerate(buttons): + b.selected=False + # otherwise, continue holding + continue + if pressed & BUTTON_B: + is_pressed = True + if mouse_cursor.hide: + mouse_cursor.hide = False + else: + mouse_cursor.hide = True + if pressed & BUTTON_A: + is_pressed = True + for i, b in enumerate(buttons): + if b.contains((mouse_cursor.x, mouse_cursor.y)): + print("Button %d pressed"%i) + if i == 0: # Increase the cursor speed + mouse_cursor.speed += 1 + elif i == 1: # Decrease the cursor speed + mouse_cursor.speed -= 1 + if i == 2: # Increase the cursor scale + mouse_cursor.scale += 1 + elif i == 3: # Decrease the cursor scale + mouse_cursor.scale -= 1 + b.selected=True diff --git a/examples/cursorcontrol_simpletest.py b/examples/cursorcontrol_simpletest.py index e69de29..270023a 100644 --- a/examples/cursorcontrol_simpletest.py +++ b/examples/cursorcontrol_simpletest.py @@ -0,0 +1,58 @@ +import board +import digitalio +import displayio +from adafruit_cursorcontrol import Cursor +from gamepadshift import GamePadShift +from micropython import const + +# PyBadge Button Masks +BUTTON_LEFT = const(128) +BUTTON_UP = const(64) +BUTTON_DOWN = const(32) +BUTTON_RIGHT = const(16) +BUTTON_A = const(2) +BUTTON_B = const(1) + +# Initialize PyBadge Gamepad +pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), + digitalio.DigitalInOut(board.BUTTON_OUT), + digitalio.DigitalInOut(board.BUTTON_LATCH)) + +# Create the display +display = board.DISPLAY + +# Create the display context +splash = displayio.Group(max_size=22) + +# initialize the mouse cursor object +mouse_cursor = Cursor(display, display_group=splash) + +# show displayio group +display.show(splash) + +def check_dpad(d_pad_buttons): + """Checks the directional pad for button presses.""" + if d_pad_buttons & BUTTON_RIGHT: + mouse_cursor.x += mouse_cursor.speed + elif d_pad_buttons & BUTTON_LEFT: + mouse_cursor.x -= mouse_cursor.speed + if d_pad_buttons & BUTTON_DOWN: + mouse_cursor.y += mouse_cursor.speed + elif d_pad_buttons & BUTTON_UP: + mouse_cursor.y -= mouse_cursor.speed + +is_pressed = False +while True: + display.wait_for_frame() + pressed = pad.get_pressed() + check_dpad(pressed) + if is_pressed: + if not pressed & (BUTTON_A | BUTTON_B): + is_pressed = False + continue + if pressed & BUTTON_A: + is_pressed = True + if mouse_cursor.hide: + mouse_cursor.hide = False + else: + mouse_cursor.hide = True From 9032419da43b817b1592c9d8729220cb5bcc9373 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 17:54:51 -0400 Subject: [PATCH 21/36] fixing requirements.txt --- requirements.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 2401920..6b4e64a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1 @@ -Adafruit-Blinka -no +Adafruit-Blinka \ No newline at end of file From eb0cc44e322041a138d919c142ebafe7eacf791e Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 20 Jun 2019 18:00:08 -0400 Subject: [PATCH 22/36] fix wrong import order --- examples/cursorcontrol_buttons_text.py | 2 +- examples/cursorcontrol_simpletest.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/cursorcontrol_buttons_text.py b/examples/cursorcontrol_buttons_text.py index b9f7bd4..abd52cf 100644 --- a/examples/cursorcontrol_buttons_text.py +++ b/examples/cursorcontrol_buttons_text.py @@ -1,4 +1,5 @@ import board +from micropython import const import digitalio import displayio from adafruit_bitmap_font import bitmap_font @@ -6,7 +7,6 @@ from adafruit_cursorcontrol import Cursor from adafruit_display_text import label from gamepadshift import GamePadShift -from micropython import const # PyBadge Button Masks BUTTON_LEFT = const(128) diff --git a/examples/cursorcontrol_simpletest.py b/examples/cursorcontrol_simpletest.py index 270023a..6f4b0e3 100644 --- a/examples/cursorcontrol_simpletest.py +++ b/examples/cursorcontrol_simpletest.py @@ -1,9 +1,9 @@ import board import digitalio +from micropython import const import displayio from adafruit_cursorcontrol import Cursor from gamepadshift import GamePadShift -from micropython import const # PyBadge Button Masks BUTTON_LEFT = const(128) From f35ef16a8c78dbe114f27098f21ae4404a3078f1 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 11:08:53 -0400 Subject: [PATCH 23/36] add methods for ContextManager, cursor deinitialization and check --- .../adafruit_cursorcontrol.py | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) rename adafruit_cursorcontrol.py => adafruit_cursorcontrol/adafruit_cursorcontrol.py (89%) diff --git a/adafruit_cursorcontrol.py b/adafruit_cursorcontrol/adafruit_cursorcontrol.py similarity index 89% rename from adafruit_cursorcontrol.py rename to adafruit_cursorcontrol/adafruit_cursorcontrol.py index 8af9538..5f1d786 100644 --- a/adafruit_cursorcontrol.py +++ b/adafruit_cursorcontrol/adafruit_cursorcontrol.py @@ -75,6 +75,24 @@ def __init__(self, display=None, display_group=None, is_hidden=False, cursor_spe self._disp_sz = display.height - 1, display.width - 1 self.generate_cursor() + def __enter__(self): + return self + + def __exit__(self, exception_type, exception_value, traceback): + self.deinit() + + def deinit(self): + """deinitializes the cursor object.""" + self._is_deinited() + self._scale = None + self._display_grp.remove(self._cursor_grp) + + def _is_deinited(self): + """checks cursor deinitialization""" + if self._scale is None: + raise ValueError("Cursor object has been deinitialized and can no longer " + "be used. Create a new cursor object.") + @property def scale(self): """Returns the cursor's scale amount as an integer.""" @@ -85,6 +103,7 @@ def scale(self, scale_value): """Scales the cursor by scale_value in both directions. :param int scale_value: Amount to scale the cursor by. """ + self._is_deinited() if scale_value > 0: self._scale = scale_value self._cursor_grp.scale = scale_value @@ -99,6 +118,7 @@ def speed(self, speed): """Sets the speed of the cursor. :param int speed: Cursor movement speed, in pixels. """ + self._is_deinited() self._speed = speed @property @@ -111,6 +131,7 @@ def x(self, x_val): """Sets the x-value of the cursor. :param int x_val: cursor x-position, in pixels. """ + self._is_deinited() if x_val < 0 and not self._is_hidden: self._cursor_grp.x = self._cursor_grp.x elif x_val > self._disp_sz[1] and not self._is_hidden: @@ -128,6 +149,7 @@ def y(self, y_val): """Sets the y-value of the cursor. :param int y_val: cursor y-position, in pixels. """ + self._is_deinited() if y_val < 0 and not self._is_hidden: self._cursor_grp.y = self._cursor_grp.y elif y_val > self._disp_sz[0] and not self._is_hidden: @@ -142,6 +164,7 @@ def hide(self): @hide.setter def hide(self, is_hidden): + self._is_deinited() if is_hidden: self._is_hidden = True self._display_grp.remove(self._cursor_grp) @@ -151,6 +174,7 @@ def hide(self, is_hidden): def generate_cursor(self): """Generates a cursor icon""" + self._is_deinited() self._cursor_grp = displayio.Group(max_size=1, scale=self._scale) self._cur_bmp = displayio.Bitmap(20, 20, 3) self._cur_palette = displayio.Palette(3) From 6bdcb60a60063d16e1a45bd899d60617a3dd926b Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 12:07:59 -0400 Subject: [PATCH 24/36] adding a high-level cursor control management class --- .../adafruit_cursorcontrol_cursormanager.py | 121 ++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100755 adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py diff --git a/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py b/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py new file mode 100755 index 0000000..a28302b --- /dev/null +++ b/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py @@ -0,0 +1,121 @@ +# The MIT License (MIT) +# +# Copyright (c) 2019 Brent Rubell 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. + +""" +`adafruit_cursorcontrol_cursormanager` +================================================================================ +Simple interaction user interface interaction for Adafruit_CursorControl. +* Author(s): Brent Rubell +""" +import board +import digitalio +from micropython import const +from gamepadshift import GamePadShift + +# PyBadge +PYBADGE_BUTTON_LEFT = const(128) +PYBADGE_BUTTON_UP = const(64) +PYBADGE_BUTTON_DOWN = const(32) +PYBADGE_BUTTON_RIGHT = const(16) +PYBADGE_BUTTON_A = const(2) +PYBADGE_BUTTON_B = const(1) +PYBADGE_BUTTON_SEL = const(8) +PYBADGE_BUTTON_START = const(4) + +class CursorManager: + """Simple interaction user interface interaction for Adafruit_CursorControl. + + :param adafruit_cursorcontrol cursor: The cursor object we are using. + TODO: Example here + """ + def __init__(self, cursor): + self._cursor = cursor + self._is_held = False + #self._display_grp = cursor._display_grp # master display group + if hasattr(board, 'SD_CS'): # PyGamer + self._init_pygamer() + elif hasattr(board, 'BUTTON_CLOCK'): # PyBadge + self._init_pybadge() + else: + raise ValueError('CursorManager must be used with a PyBadge or PyGamer.') + + def __enter__(self): + return self + + def __exit__(self, exception_type, exception_value, traceback): + self.deinit() + + def deinit(self): + """Deinitializes a CursorManager object.""" + self._is_deinited() + self._pad.deinit() + self._cursor_deinit() + self._cursor = None + + def _is_deinited(self): + """Checks if CursorManager object has been deinitd.""" + if self._cursor is None: + raise ValueError("CursorManager object has been deinitialized and can no longer " + "be used. Create a new CursorManager object.") + + def _init_pygamer(self): + """Initializes PyGamer hardware.""" + self._is_pybadge = False + + def _init_pybadge(self): + """Initializes PyBadge hardware.""" + self._is_pybadge = True + self._pad_btns = {'btn_left' : PYBADGE_BUTTON_LEFT, + 'btn_right' : PYBADGE_BUTTON_RIGHT, + 'btn_up' : PYBADGE_BUTTON_UP, + 'btn_down' : PYBADGE_BUTTON_DOWN, + 'btn_a' : PYBADGE_BUTTON_SEL, + 'btn_b' : PYBADGE_BUTTON_START} + # Initialize pybadge gamepad hardware + self._pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), + digitalio.DigitalInOut(board.BUTTON_OUT), + digitalio.DigitalInOut(board.BUTTON_LATCH)) + + def update(self): + """Handles physical interaction, cursor movement, and cursor interaction""" + pressed = self._pad.get_pressed() + self._check_cursor_movement(pressed) # check pad movement + self._check_cursor_click(pressed) + + def _check_cursor_click(self, pressed): + """Checks if A button was clicked.""" + # if pressed & self._pad_btns['btn_a']: + + def _check_cursor_movement(self, pressed): + """Checks the PyBadge D-Pad or the PyGamer's Joystick for movement. + :param int pressed: 8-bit number with bits that correspond to buttons + which have been pressed down since the last call to get_pressed(). + """ + if self._is_pybadge: + if pressed & self._pad_btns['btn_right']: + self._cursor.x += self._cursor.speed + elif pressed & self._pad_btns['btn_left']: + self._cursor.x -= self._cursor.speed + if pressed & self._pad_btns['btn_up']: + self._cursor.y -= self._cursor.speed + elif pressed & self._pad_btns['btn_down']: + self._cursor.y += self._cursor.speed From 1bb7041f27faed2e7be125055321df5f3b0e8449 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 12:48:50 -0400 Subject: [PATCH 25/36] unify the init code for pybadge OR pygamer --- .../adafruit_cursorcontrol_cursormanager.py | 64 ++++++++++--------- 1 file changed, 35 insertions(+), 29 deletions(-) diff --git a/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py b/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py index a28302b..848d907 100755 --- a/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py +++ b/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py @@ -28,6 +28,7 @@ """ import board import digitalio +import analogio from micropython import const from gamepadshift import GamePadShift @@ -45,18 +46,13 @@ class CursorManager: """Simple interaction user interface interaction for Adafruit_CursorControl. :param adafruit_cursorcontrol cursor: The cursor object we are using. - TODO: Example here + :param adafruit_button.Button buttons: Optional array of button elements. """ - def __init__(self, cursor): + def __init__(self, cursor, buttons=None): self._cursor = cursor + self._btns = buttons self._is_held = False - #self._display_grp = cursor._display_grp # master display group - if hasattr(board, 'SD_CS'): # PyGamer - self._init_pygamer() - elif hasattr(board, 'BUTTON_CLOCK'): # PyBadge - self._init_pybadge() - else: - raise ValueError('CursorManager must be used with a PyBadge or PyGamer.') + self._init_hardware() def __enter__(self): return self @@ -77,20 +73,22 @@ def _is_deinited(self): raise ValueError("CursorManager object has been deinitialized and can no longer " "be used. Create a new CursorManager object.") - def _init_pygamer(self): - """Initializes PyGamer hardware.""" - self._is_pybadge = False - - def _init_pybadge(self): - """Initializes PyBadge hardware.""" - self._is_pybadge = True - self._pad_btns = {'btn_left' : PYBADGE_BUTTON_LEFT, - 'btn_right' : PYBADGE_BUTTON_RIGHT, - 'btn_up' : PYBADGE_BUTTON_UP, - 'btn_down' : PYBADGE_BUTTON_DOWN, - 'btn_a' : PYBADGE_BUTTON_SEL, - 'btn_b' : PYBADGE_BUTTON_START} - # Initialize pybadge gamepad hardware + def _init_hardware(self): + """Initializes PyBadge or PyGamer hardware.""" + if hasattr(board, 'BUTTON_CLOCK') and not hasattr(board, 'SD_CS'): + self._pad_btns = {'btn_left' : PYBADGE_BUTTON_LEFT, + 'btn_right' : PYBADGE_BUTTON_RIGHT, + 'btn_up' : PYBADGE_BUTTON_UP, + 'btn_down' : PYBADGE_BUTTON_DOWN, + 'btn_a' : PYBADGE_BUTTON_SEL, + 'btn_b' : PYBADGE_BUTTON_START} + elif hasattr(board, 'JOYSTICK_X'): + self._joystick_x = analogio.AnalogIn(board.JOYSTICK_X) + self._joystick_y = analogio.AnalogIn(board.JOYSTICK_Y) + self._pad_btns = {'btn_a' : PYBADGE_BUTTON_SEL, + 'btn_b' : PYBADGE_BUTTON_START} + else: + raise AttributeError('Board must have a D-Pad or Joystick for use with CursorManager!') self._pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), digitalio.DigitalInOut(board.BUTTON_OUT), digitalio.DigitalInOut(board.BUTTON_LATCH)) @@ -98,19 +96,24 @@ def _init_pybadge(self): def update(self): """Handles physical interaction, cursor movement, and cursor interaction""" pressed = self._pad.get_pressed() - self._check_cursor_movement(pressed) # check pad movement - self._check_cursor_click(pressed) + self._check_cursor_movement(pressed) + if self._btns: # button elements exist in user-code + btn_clicked = self._check_cursor_click(pressed) + def _check_cursor_click(self, pressed): - """Checks if A button was clicked.""" - # if pressed & self._pad_btns['btn_a']: + """Returns which display button element has been clicked as an integer.""" + if pressed & self._pad_btns['btn_a']: + for i, b in enumerate(self._btns): + if b.contains((self._cursor.x, self._cursor.y)): + return b - def _check_cursor_movement(self, pressed): + def _check_cursor_movement(self, pressed=None): """Checks the PyBadge D-Pad or the PyGamer's Joystick for movement. :param int pressed: 8-bit number with bits that correspond to buttons which have been pressed down since the last call to get_pressed(). """ - if self._is_pybadge: + if self._pad_btns['btn_up']: if pressed & self._pad_btns['btn_right']: self._cursor.x += self._cursor.speed elif pressed & self._pad_btns['btn_left']: @@ -119,3 +122,6 @@ def _check_cursor_movement(self, pressed): self._cursor.y -= self._cursor.speed elif pressed & self._pad_btns['btn_down']: self._cursor.y += self._cursor.speed + else: + self._cursor.x = self._joystick_x + self._cursor.y = self._joystick_y From 9b4ca436a652077e67965d0183bcdceca687a02b Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 18:01:04 -0400 Subject: [PATCH 26/36] pylinted! --- .../adafruit_cursorcontrol_cursormanager.py | 59 ++++++++++++------- 1 file changed, 38 insertions(+), 21 deletions(-) diff --git a/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py b/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py index 848d907..a5b4c09 100755 --- a/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py +++ b/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py @@ -28,8 +28,8 @@ """ import board import digitalio -import analogio from micropython import const +import analogio from gamepadshift import GamePadShift # PyBadge @@ -37,10 +37,9 @@ PYBADGE_BUTTON_UP = const(64) PYBADGE_BUTTON_DOWN = const(32) PYBADGE_BUTTON_RIGHT = const(16) +# PyBadge & PyGamer PYBADGE_BUTTON_A = const(2) PYBADGE_BUTTON_B = const(1) -PYBADGE_BUTTON_SEL = const(8) -PYBADGE_BUTTON_START = const(4) class CursorManager: """Simple interaction user interface interaction for Adafruit_CursorControl. @@ -51,6 +50,7 @@ class CursorManager: def __init__(self, cursor, buttons=None): self._cursor = cursor self._btns = buttons + self._btn_clicked = None self._is_held = False self._init_hardware() @@ -64,7 +64,7 @@ def deinit(self): """Deinitializes a CursorManager object.""" self._is_deinited() self._pad.deinit() - self._cursor_deinit() + self._cursor.deinit() self._cursor = None def _is_deinited(self): @@ -75,38 +75,55 @@ def _is_deinited(self): def _init_hardware(self): """Initializes PyBadge or PyGamer hardware.""" - if hasattr(board, 'BUTTON_CLOCK') and not hasattr(board, 'SD_CS'): + if hasattr(board, 'BUTTON_CLOCK') and not hasattr(board, 'JOYSTICK_X'): self._pad_btns = {'btn_left' : PYBADGE_BUTTON_LEFT, - 'btn_right' : PYBADGE_BUTTON_RIGHT, - 'btn_up' : PYBADGE_BUTTON_UP, - 'btn_down' : PYBADGE_BUTTON_DOWN, - 'btn_a' : PYBADGE_BUTTON_SEL, - 'btn_b' : PYBADGE_BUTTON_START} + 'btn_right' : PYBADGE_BUTTON_RIGHT, + 'btn_up' : PYBADGE_BUTTON_UP, + 'btn_down' : PYBADGE_BUTTON_DOWN, + 'btn_a' : PYBADGE_BUTTON_A, + 'btn_b' : PYBADGE_BUTTON_B} elif hasattr(board, 'JOYSTICK_X'): self._joystick_x = analogio.AnalogIn(board.JOYSTICK_X) self._joystick_y = analogio.AnalogIn(board.JOYSTICK_Y) - self._pad_btns = {'btn_a' : PYBADGE_BUTTON_SEL, - 'btn_b' : PYBADGE_BUTTON_START} + self._pad_btns = {'btn_a' : PYBADGE_BUTTON_A, + 'btn_b' : PYBADGE_BUTTON_B} else: raise AttributeError('Board must have a D-Pad or Joystick for use with CursorManager!') self._pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH)) + digitalio.DigitalInOut(board.BUTTON_OUT), + digitalio.DigitalInOut(board.BUTTON_LATCH)) def update(self): - """Handles physical interaction, cursor movement, and cursor interaction""" + """Updates the cursor object. + + Returns: + int: Optionally returns the number of the display button clicked. + None: If no display buton object was clicked. + """ pressed = self._pad.get_pressed() self._check_cursor_movement(pressed) - if self._btns: # button elements exist in user-code - btn_clicked = self._check_cursor_click(pressed) - + if self._is_held: + if not pressed & (self._pad_btns['btn_a'] | self._pad_btns['btn_b']): + self._is_held = False + for i, self._btn_clicked in enumerate(self._btns): # pylint: disable=unused-variable + self._btn_clicked.selected = False + if self._btns: # user-defined buttons provided to cursormanager + button_num = self._check_cursor_click(pressed) + if self._btn_clicked is not None: + return button_num + return None def _check_cursor_click(self, pressed): - """Returns which display button element has been clicked as an integer.""" + """Returns which display button element has been clicked as an integer. + """ if pressed & self._pad_btns['btn_a']: - for i, b in enumerate(self._btns): + self._is_held = True + for i, b in enumerate(self._btns): # pylint: disable=unused-variable if b.contains((self._cursor.x, self._cursor.y)): - return b + self._btn_clicked = b + self._btn_clicked.selected = True + return i + return None def _check_cursor_movement(self, pressed=None): """Checks the PyBadge D-Pad or the PyGamer's Joystick for movement. From 90c702ac500d927ef47ec943b4f1beb57e195c94 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 18:03:25 -0400 Subject: [PATCH 27/36] add empty __init__.py file --- adafruit_cursorcontrol/__init__.py | 1 + 1 file changed, 1 insertion(+) create mode 100644 adafruit_cursorcontrol/__init__.py diff --git a/adafruit_cursorcontrol/__init__.py b/adafruit_cursorcontrol/__init__.py new file mode 100644 index 0000000..597a6db --- /dev/null +++ b/adafruit_cursorcontrol/__init__.py @@ -0,0 +1 @@ +i \ No newline at end of file From b4f7c81645504a5b7e0225e0ffff56a03ad04b46 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 18:05:03 -0400 Subject: [PATCH 28/36] fixup docs --- docs/api.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 852bb94..c655cfd 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,8 +1,4 @@ - -.. 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" - +API +==== .. automodule:: adafruit_cursorcontrol :members: From b81edf138e30ed1c93e9d38b11fae892cb7a4e8e Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 18:06:46 -0400 Subject: [PATCH 29/36] fix init --- adafruit_cursorcontrol/__init__.py | 1 - 1 file changed, 1 deletion(-) diff --git a/adafruit_cursorcontrol/__init__.py b/adafruit_cursorcontrol/__init__.py index 597a6db..e69de29 100644 --- a/adafruit_cursorcontrol/__init__.py +++ b/adafruit_cursorcontrol/__init__.py @@ -1 +0,0 @@ -i \ No newline at end of file From a671d9f879b78cd94c119481aaee3b75739128fc Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 18:16:24 -0400 Subject: [PATCH 30/36] fix travis script --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 4a51621..6b81d64 100644 --- a/.travis.yml +++ b/.travis.yml @@ -42,7 +42,7 @@ install: - pip install --force-reinstall pylint==1.9.2 script: - - pylint adafruit_cursorcontrol.py + - pylint adafruit_cursorcontrol/*.py - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursorcontrol --library_location . - cd docs && sphinx-build -E -W -b html . _build/html && cd .. From 11af20e67d163fcbc47e50366fdbfb097f225228 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 18:20:30 -0400 Subject: [PATCH 31/36] fix import statement order --- examples/cursorcontrol_buttons_text.py | 2 +- examples/cursorcontrol_simpletest.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/cursorcontrol_buttons_text.py b/examples/cursorcontrol_buttons_text.py index abd52cf..1b7d959 100644 --- a/examples/cursorcontrol_buttons_text.py +++ b/examples/cursorcontrol_buttons_text.py @@ -4,7 +4,7 @@ import displayio from adafruit_bitmap_font import bitmap_font from adafruit_button import Button -from adafruit_cursorcontrol import Cursor +from adafruit_cursorcontrol.adafruit_cursorcontrol import Cursor from adafruit_display_text import label from gamepadshift import GamePadShift diff --git a/examples/cursorcontrol_simpletest.py b/examples/cursorcontrol_simpletest.py index 6f4b0e3..19e2833 100644 --- a/examples/cursorcontrol_simpletest.py +++ b/examples/cursorcontrol_simpletest.py @@ -2,7 +2,7 @@ import digitalio from micropython import const import displayio -from adafruit_cursorcontrol import Cursor +from adafruit_cursorcontrol.adafruit_cursorcontrol import Cursor from gamepadshift import GamePadShift # PyBadge Button Masks From 20225e7e9dfc1b56774784a61be291c0345a8727 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 21 Jun 2019 18:22:02 -0400 Subject: [PATCH 32/36] drop adafruit_ from file name, already in an adafruit_ folder --- .../{adafruit_cursorcontrol.py => cursorcontrol.py} | 0 ...sorcontrol_cursormanager.py => cursorcontrol_cursormanager.py} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename adafruit_cursorcontrol/{adafruit_cursorcontrol.py => cursorcontrol.py} (100%) rename adafruit_cursorcontrol/{adafruit_cursorcontrol_cursormanager.py => cursorcontrol_cursormanager.py} (100%) diff --git a/adafruit_cursorcontrol/adafruit_cursorcontrol.py b/adafruit_cursorcontrol/cursorcontrol.py similarity index 100% rename from adafruit_cursorcontrol/adafruit_cursorcontrol.py rename to adafruit_cursorcontrol/cursorcontrol.py diff --git a/adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py similarity index 100% rename from adafruit_cursorcontrol/adafruit_cursorcontrol_cursormanager.py rename to adafruit_cursorcontrol/cursorcontrol_cursormanager.py From 2724b957cd5d012535584e18abe5e4c44bab4e28 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 25 Jun 2019 11:08:39 -0400 Subject: [PATCH 33/36] cursormanager has no knowledge of buttons, add property to return if update() yielded a click. both examples use cursormanager. negative speed can not be set. --- adafruit_cursorcontrol/cursorcontrol.py | 3 +- .../cursorcontrol_cursormanager.py | 53 +++++---------- examples/cursorcontrol_buttons_text.py | 67 +++++-------------- examples/cursorcontrol_simpletest.py | 49 +++----------- 4 files changed, 44 insertions(+), 128 deletions(-) diff --git a/adafruit_cursorcontrol/cursorcontrol.py b/adafruit_cursorcontrol/cursorcontrol.py index 5f1d786..d82528b 100644 --- a/adafruit_cursorcontrol/cursorcontrol.py +++ b/adafruit_cursorcontrol/cursorcontrol.py @@ -119,7 +119,8 @@ def speed(self, speed): :param int speed: Cursor movement speed, in pixels. """ self._is_deinited() - self._speed = speed + if speed > 0: + self._speed = speed @property def x(self): diff --git a/adafruit_cursorcontrol/cursorcontrol_cursormanager.py b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py index a5b4c09..fd1c7c1 100755 --- a/adafruit_cursorcontrol/cursorcontrol_cursormanager.py +++ b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py @@ -39,19 +39,15 @@ PYBADGE_BUTTON_RIGHT = const(16) # PyBadge & PyGamer PYBADGE_BUTTON_A = const(2) -PYBADGE_BUTTON_B = const(1) class CursorManager: """Simple interaction user interface interaction for Adafruit_CursorControl. :param adafruit_cursorcontrol cursor: The cursor object we are using. - :param adafruit_button.Button buttons: Optional array of button elements. """ - def __init__(self, cursor, buttons=None): + def __init__(self, cursor): self._cursor = cursor - self._btns = buttons - self._btn_clicked = None - self._is_held = False + self._is_clicked = False self._init_hardware() def __enter__(self): @@ -80,50 +76,33 @@ def _init_hardware(self): 'btn_right' : PYBADGE_BUTTON_RIGHT, 'btn_up' : PYBADGE_BUTTON_UP, 'btn_down' : PYBADGE_BUTTON_DOWN, - 'btn_a' : PYBADGE_BUTTON_A, - 'btn_b' : PYBADGE_BUTTON_B} + 'btn_a' : PYBADGE_BUTTON_A} elif hasattr(board, 'JOYSTICK_X'): self._joystick_x = analogio.AnalogIn(board.JOYSTICK_X) self._joystick_y = analogio.AnalogIn(board.JOYSTICK_Y) - self._pad_btns = {'btn_a' : PYBADGE_BUTTON_A, - 'btn_b' : PYBADGE_BUTTON_B} + self._pad_btns = {'btn_a' : PYBADGE_BUTTON_A} else: raise AttributeError('Board must have a D-Pad or Joystick for use with CursorManager!') self._pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), digitalio.DigitalInOut(board.BUTTON_OUT), digitalio.DigitalInOut(board.BUTTON_LATCH)) - def update(self): - """Updates the cursor object. - - Returns: - int: Optionally returns the number of the display button clicked. - None: If no display buton object was clicked. + @property + def is_clicked(self): + """Returns True if the cursor button was pressed + during previous call to update() """ + return self._is_clicked + + def update(self): + """Updates the cursor object.""" pressed = self._pad.get_pressed() self._check_cursor_movement(pressed) - if self._is_held: - if not pressed & (self._pad_btns['btn_a'] | self._pad_btns['btn_b']): - self._is_held = False - for i, self._btn_clicked in enumerate(self._btns): # pylint: disable=unused-variable - self._btn_clicked.selected = False - if self._btns: # user-defined buttons provided to cursormanager - button_num = self._check_cursor_click(pressed) - if self._btn_clicked is not None: - return button_num - return None - - def _check_cursor_click(self, pressed): - """Returns which display button element has been clicked as an integer. - """ + if self._is_clicked: + if not pressed & (self._pad_btns['btn_a']): + self._is_clicked = False if pressed & self._pad_btns['btn_a']: - self._is_held = True - for i, b in enumerate(self._btns): # pylint: disable=unused-variable - if b.contains((self._cursor.x, self._cursor.y)): - self._btn_clicked = b - self._btn_clicked.selected = True - return i - return None + self._is_clicked = True def _check_cursor_movement(self, pressed=None): """Checks the PyBadge D-Pad or the PyGamer's Joystick for movement. diff --git a/examples/cursorcontrol_buttons_text.py b/examples/cursorcontrol_buttons_text.py index 1b7d959..09cce05 100644 --- a/examples/cursorcontrol_buttons_text.py +++ b/examples/cursorcontrol_buttons_text.py @@ -1,25 +1,11 @@ +import time import board -from micropython import const -import digitalio import displayio from adafruit_bitmap_font import bitmap_font from adafruit_button import Button -from adafruit_cursorcontrol.adafruit_cursorcontrol import Cursor +from adafruit_cursorcontrol.cursorcontrol import Cursor +from adafruit_cursorcontrol.cursorcontrol_cursormanager import CursorManager from adafruit_display_text import label -from gamepadshift import GamePadShift - -# PyBadge Button Masks -BUTTON_LEFT = const(128) -BUTTON_UP = const(64) -BUTTON_DOWN = const(32) -BUTTON_RIGHT = const(16) -BUTTON_A = const(2) -BUTTON_B = const(1) - -# Initialize PyBadge Gamepad -pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH)) # Load the font THE_FONT = "/fonts/Arial-12.bdf" @@ -92,45 +78,19 @@ # initialize the mouse cursor object mouse_cursor = Cursor(display, display_group=splash) +# initialize the cursormanager +cursor = CursorManager(mouse_cursor) + # show displayio group display.show(splash) -def check_dpad(d_pad_buttons): - """Checks the directional pad for button presses.""" - if d_pad_buttons & BUTTON_RIGHT: - mouse_cursor.x += mouse_cursor.speed - elif d_pad_buttons & BUTTON_LEFT: - mouse_cursor.x -= mouse_cursor.speed - if d_pad_buttons & BUTTON_DOWN: - mouse_cursor.y += mouse_cursor.speed - elif d_pad_buttons & BUTTON_UP: - mouse_cursor.y -= mouse_cursor.speed - -is_pressed = False +prev_btn = None while True: - display.wait_for_frame() - text_speed.text = 'Speed: {0}px'.format(mouse_cursor.speed) - text_scale.text = 'Scale: {0}px'.format(mouse_cursor.scale) - pressed = pad.get_pressed() - check_dpad(pressed) - if is_pressed: - if not pressed & (BUTTON_A | BUTTON_B): - # buttons de-pressed - is_pressed = False - for i, b in enumerate(buttons): - b.selected=False - # otherwise, continue holding - continue - if pressed & BUTTON_B: - is_pressed = True - if mouse_cursor.hide: - mouse_cursor.hide = False - else: - mouse_cursor.hide = True - if pressed & BUTTON_A: - is_pressed = True + cursor.update() + if cursor.is_clicked is True: for i, b in enumerate(buttons): if b.contains((mouse_cursor.x, mouse_cursor.y)): + b.selected=True print("Button %d pressed"%i) if i == 0: # Increase the cursor speed mouse_cursor.speed += 1 @@ -140,4 +100,9 @@ def check_dpad(d_pad_buttons): mouse_cursor.scale += 1 elif i == 3: # Decrease the cursor scale mouse_cursor.scale -= 1 - b.selected=True + prev_btn = b + elif prev_btn is not None: + prev_btn.selected = False + text_speed.text = 'Speed: {0}px'.format(mouse_cursor.speed) + text_scale.text = 'Scale: {0}px'.format(mouse_cursor.scale) + time.sleep(0.01) diff --git a/examples/cursorcontrol_simpletest.py b/examples/cursorcontrol_simpletest.py index 19e2833..2fe67f8 100644 --- a/examples/cursorcontrol_simpletest.py +++ b/examples/cursorcontrol_simpletest.py @@ -1,58 +1,29 @@ +import time import board -import digitalio -from micropython import const import displayio -from adafruit_cursorcontrol.adafruit_cursorcontrol import Cursor -from gamepadshift import GamePadShift - -# PyBadge Button Masks -BUTTON_LEFT = const(128) -BUTTON_UP = const(64) -BUTTON_DOWN = const(32) -BUTTON_RIGHT = const(16) -BUTTON_A = const(2) -BUTTON_B = const(1) - -# Initialize PyBadge Gamepad -pad = GamePadShift(digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH)) +from adafruit_cursorcontrol.cursorcontrol import Cursor +from adafruit_cursorcontrol.cursorcontrol_cursormanager import CursorManager # Create the display display = board.DISPLAY # Create the display context -splash = displayio.Group(max_size=22) +splash = displayio.Group(max_size=5) # initialize the mouse cursor object mouse_cursor = Cursor(display, display_group=splash) +# initialize the cursormanager +cursor = CursorManager(mouse_cursor) + # show displayio group display.show(splash) -def check_dpad(d_pad_buttons): - """Checks the directional pad for button presses.""" - if d_pad_buttons & BUTTON_RIGHT: - mouse_cursor.x += mouse_cursor.speed - elif d_pad_buttons & BUTTON_LEFT: - mouse_cursor.x -= mouse_cursor.speed - if d_pad_buttons & BUTTON_DOWN: - mouse_cursor.y += mouse_cursor.speed - elif d_pad_buttons & BUTTON_UP: - mouse_cursor.y -= mouse_cursor.speed - -is_pressed = False while True: - display.wait_for_frame() - pressed = pad.get_pressed() - check_dpad(pressed) - if is_pressed: - if not pressed & (BUTTON_A | BUTTON_B): - is_pressed = False - continue - if pressed & BUTTON_A: - is_pressed = True + cursor.update() + if cursor.is_clicked: if mouse_cursor.hide: mouse_cursor.hide = False else: mouse_cursor.hide = True + time.sleep(0.01) From 6aafca1bf4b034877cc8f78e67c9256a0f4377fd Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 25 Jun 2019 13:46:28 -0400 Subject: [PATCH 34/36] add joystick handling for the pygamer --- .../cursorcontrol_cursormanager.py | 46 +++++++++++++++++-- 1 file changed, 43 insertions(+), 3 deletions(-) diff --git a/adafruit_cursorcontrol/cursorcontrol_cursormanager.py b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py index fd1c7c1..c8a242c 100755 --- a/adafruit_cursorcontrol/cursorcontrol_cursormanager.py +++ b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py @@ -40,6 +40,9 @@ # PyBadge & PyGamer PYBADGE_BUTTON_A = const(2) +JOY_X_CTR = 32767.5 +JOY_Y_CTR = 32767.5 + class CursorManager: """Simple interaction user interface interaction for Adafruit_CursorControl. @@ -104,12 +107,39 @@ def update(self): if pressed & self._pad_btns['btn_a']: self._is_clicked = True + + def _read_joystick_x(self, samples=3): + """Read the X analog joystick on the PyGamer. + :param int samples: How many samples to read and average. + """ + reading = 0 + # pylint: disable=unused-variable + if hasattr(board, 'JOYSTICK_X'): + for sample in range(0, samples): + reading += self._joystick_x.value + reading /= samples + reading -= JOY_X_CTR + return reading + + def _read_joystick_y(self, samples=3): + """Read the Y analog joystick on the PyGamer. + :param int samples: How many samples to read and average. + """ + reading = 0 + # pylint: disable=unused-variable + if hasattr(board, 'JOYSTICK_Y'): + for sample in range(0, samples): + reading += self._joystick_y.value + reading /= samples + reading -= JOY_Y_CTR + return reading + def _check_cursor_movement(self, pressed=None): """Checks the PyBadge D-Pad or the PyGamer's Joystick for movement. :param int pressed: 8-bit number with bits that correspond to buttons which have been pressed down since the last call to get_pressed(). """ - if self._pad_btns['btn_up']: + if hasattr(board, 'BUTTON_CLOCK') and not hasattr(board, 'JOYSTICK_X'): if pressed & self._pad_btns['btn_right']: self._cursor.x += self._cursor.speed elif pressed & self._pad_btns['btn_left']: @@ -118,6 +148,16 @@ def _check_cursor_movement(self, pressed=None): self._cursor.y -= self._cursor.speed elif pressed & self._pad_btns['btn_down']: self._cursor.y += self._cursor.speed + elif hasattr(board, 'JOYSTICK_X'): + joy_x = self._read_joystick_x() + joy_y = self._read_joystick_y() + if joy_x > 700: + self._cursor.x += self._cursor.speed + elif joy_x < -700: + self._cursor.x -= self._cursor.speed + if joy_y > 700: + self._cursor.y += self._cursor.speed + elif joy_y < -700: + self._cursor.y -= self._cursor.speed else: - self._cursor.x = self._joystick_x - self._cursor.y = self._joystick_y + raise AttributeError('Board must have a D-Pad or Joystick for use with CursorManager!') From 979199710e7efd147b33e790fb51c1630fb97ea3 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 25 Jun 2019 13:47:40 -0400 Subject: [PATCH 35/36] update cursorcontrol_btns_txt to dynamically resize btns/ui elements for pygamer's smaller display --- examples/cursorcontrol_buttons_text.py | 41 ++++++++++++++++---------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/examples/cursorcontrol_buttons_text.py b/examples/cursorcontrol_buttons_text.py index 09cce05..95d8314 100644 --- a/examples/cursorcontrol_buttons_text.py +++ b/examples/cursorcontrol_buttons_text.py @@ -1,15 +1,11 @@ import time import board import displayio -from adafruit_bitmap_font import bitmap_font from adafruit_button import Button from adafruit_cursorcontrol.cursorcontrol import Cursor from adafruit_cursorcontrol.cursorcontrol_cursormanager import CursorManager from adafruit_display_text import label - -# Load the font -THE_FONT = "/fonts/Arial-12.bdf" -font = bitmap_font.load_font(THE_FONT) +import terminalio # Create the display display = board.DISPLAY @@ -17,10 +13,13 @@ # Create the display context splash = displayio.Group(max_size=22) +# Use the built-in system font +font = terminalio.FONT + ########################################################################## # Make a background color fill -color_bitmap = displayio.Bitmap(320, 240, 1) +color_bitmap = displayio.Bitmap(display.width, display.height, 1) color_palette = displayio.Palette(1) color_palette[0] = 0x404040 bg_sprite = displayio.TileGrid(color_bitmap, @@ -30,32 +29,44 @@ ########################################################################## -# Set up button size info +# Set up button/label properties BUTTON_WIDTH = 80 BUTTON_HEIGHT = 40 BUTTON_MARGIN = 20 +LBL_HEADER = [100, 20] +LBL_TEXT = [120, 40] + +# Resize buttons for small display (PyGamer) +if display.width < 240: + BUTTON_WIDTH = int(BUTTON_WIDTH / 2) + BUTTON_HEIGHT = int(BUTTON_HEIGHT / 2) + BUTTON_MARGIN = int(BUTTON_MARGIN / 2) + LBL_HEADER[0] -= 75 + LBL_HEADER[1] -= 10 + LBL_TEXT[0] -= 70 + LBL_TEXT[1] += 55 # Create the buttons buttons = [] button_speed_inc = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN+BUTTON_HEIGHT, width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="+ Speed", label_font=font) + label="Speed+", label_font=font) buttons.append(button_speed_inc) button_speed_dec = Button(x=BUTTON_MARGIN, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="- Speed", label_font=font) + label="Speed-", label_font=font) buttons.append(button_speed_dec) button_scale_pos = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN+BUTTON_HEIGHT, width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="+ Scale", label_font=font, style=Button.SHADOWRECT) + label="Scale+", label_font=font, style=Button.SHADOWRECT) buttons.append(button_scale_pos) button_scale_neg = Button(x=BUTTON_MARGIN*3+2*BUTTON_WIDTH, y=BUTTON_MARGIN*4+BUTTON_HEIGHT, width=BUTTON_WIDTH, height=BUTTON_HEIGHT, - label="- Scale", label_font=font, style=Button.SHADOWRECT) + label="Scale-", label_font=font, style=Button.SHADOWRECT) buttons.append(button_scale_neg) # Show the button @@ -64,15 +75,15 @@ # Create a text label text_label = label.Label(font, text="CircuitPython Cursor!", color=0x00FF00, - x = 100, y = 20) + x = LBL_HEADER[0], y = LBL_HEADER[1]) splash.append(text_label) text_speed = label.Label(font, max_glyphs = 15, color=0x00FF00, - x = 120, y = 40) + x = LBL_TEXT[0], y = LBL_TEXT[1]) splash.append(text_speed) text_scale = label.Label(font, max_glyphs = 15, color=0x00FF00, - x = 120, y = 60) + x = LBL_TEXT[0], y = LBL_TEXT[1]+20) splash.append(text_scale) # initialize the mouse cursor object @@ -105,4 +116,4 @@ prev_btn.selected = False text_speed.text = 'Speed: {0}px'.format(mouse_cursor.speed) text_scale.text = 'Scale: {0}px'.format(mouse_cursor.scale) - time.sleep(0.01) + time.sleep(0.1) From 28a34db3111dbc5a5818b2510d18b3841308438a Mon Sep 17 00:00:00 2001 From: brentru Date: Wed, 26 Jun 2019 12:25:39 -0400 Subject: [PATCH 36/36] update update() logic --- adafruit_cursorcontrol/cursorcontrol_cursormanager.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/adafruit_cursorcontrol/cursorcontrol_cursormanager.py b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py index c8a242c..280d7f9 100755 --- a/adafruit_cursorcontrol/cursorcontrol_cursormanager.py +++ b/adafruit_cursorcontrol/cursorcontrol_cursormanager.py @@ -102,12 +102,10 @@ def update(self): pressed = self._pad.get_pressed() self._check_cursor_movement(pressed) if self._is_clicked: - if not pressed & (self._pad_btns['btn_a']): - self._is_clicked = False - if pressed & self._pad_btns['btn_a']: + self._is_clicked = False + elif pressed & self._pad_btns['btn_a']: self._is_clicked = True - def _read_joystick_x(self, samples=3): """Read the X analog joystick on the PyGamer. :param int samples: How many samples to read and average.