diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e59866c --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +_build +*.pyc +*.mpy +.env +build* +bundles diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..946d694 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,432 @@ +[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 + + +[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= + +# 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/.travis.yml b/.travis.yml index df84248..918bc47 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,53 +1,30 @@ -# Travis CI configuration for automated .mpy file generation. -# Author: Tony DiCola -# License: Public Domain -# This configuration will work with Travis CI (travis-ci.org) to automacially -# build .mpy files for CircuitPython when a new tagged release is created. This -# file is relatively generic and can be shared across multiple repositories by -# following these steps: -# 1. Copy this file into a .travis.yml file in the root of the repository. -# 2. Change the deploy > file section below to list each of the .mpy files -# that should be generated. The config will automatically look for -# .py files with the same name as the source for generating the .mpy files. -# Note that the .mpy extension should be lower case! -# 3. Commit the .travis.yml file and push it to GitHub. -# 4. Go to travis-ci.org and find the repository (it needs to be setup to access -# your github account, and your github account needs access to write to the -# repo). Flip the 'ON' switch on for Travis and the repo, see the Travis -# docs for more details: https://docs.travis-ci.com/user/getting-started/ -# 5. Get a GitHub 'personal access token' which has at least 'public_repo' or -# 'repo' scope: https://help.github.com/articles/creating-an-access-token-for-command-line-use/ -# Keep this token safe and secure! Anyone with the token will be able to -# access and write to your GitHub repositories. Travis will use the token -# to attach the .mpy files to the release. -# 6. In the Travis CI settings for the repository that was enabled find the -# environment variable editing page: https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings -# Add an environment variable named GITHUB_TOKEN and set it to the value -# of the GitHub personal access token above. Keep 'Display value in build -# log' flipped off. -# 7. That's it! Tag a release and Travis should go to work to add .mpy files -# to the release. It takes about a 2-3 minutes for a worker to spin up, -# build mpy-cross, and add the binaries to the release. -language: generic +# 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. -sudo: true +dist: trusty +sudo: false +language: python +python: + - "3.6" + +cache: + pip: true deploy: provider: releases api_key: $GITHUB_TOKEN - file: - - "adafruit_vc0706.mpy" + file_glob: true + file: bundles/* skip_cleanup: true on: tags: true -before_install: -- sudo apt-get -yqq update -- sudo apt-get install -y build-essential git python python-pip -- git clone https://github.com/adafruit/circuitpython.git -b 2.x -- make -C circuitpython/mpy-cross -- export PATH=$PATH:$PWD/circuitpython/mpy-cross/ -- sudo pip install shyaml +install: + - pip install pylint circuitpython-build-tools -before_deploy: -- shyaml get-values deploy.file < .travis.yml | sed 's/.mpy/.py/' | xargs -L1 mpy-cross +script: + - pylint adafruit_vc0706.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-vc0706 --library_location . diff --git a/adafruit_vc0706.py b/adafruit_vc0706.py index 0dc9a96..f1d1622 100644 --- a/adafruit_vc0706.py +++ b/adafruit_vc0706.py @@ -30,90 +30,105 @@ * Author(s): Tony DiCola """ import busio - - -_VC0706_SERIAL = const(0x00) -_VC0706_RESET = const(0x26) -_VC0706_GEN_VERSION = const(0x11) -_VC0706_SET_PORT = const(0x24) -_VC0706_READ_FBUF = const(0x32) -_VC0706_GET_FBUF_LEN = const(0x34) -_VC0706_FBUF_CTRL = const(0x36) -_VC0706_DOWNSIZE_CTRL = const(0x54) -_VC0706_DOWNSIZE_STATUS = const(0x55) -_VC0706_READ_DATA = const(0x30) -_VC0706_WRITE_DATA = const(0x31) -_VC0706_COMM_MOTION_CTRL = const(0x37) -_VC0706_COMM_MOTION_STATUS = const(0x38) -_VC0706_COMM_MOTION_DETECTED = const(0x39) -_VC0706_MOTION_CTRL = const(0x42) -_VC0706_MOTION_STATUS = const(0x43) -_VC0706_TVOUT_CTRL = const(0x44) -_VC0706_OSD_ADD_CHAR = const(0x45) - -_VC0706_STOPCURRENTFRAME = const(0x0) -_VC0706_STOPNEXTFRAME = const(0x1) -_VC0706_RESUMEFRAME = const(0x3) -_VC0706_STEPFRAME = const(0x2) - -VC0706_640x480 = const(0x00) -VC0706_320x240 = const(0x11) -VC0706_160x120 = const(0x22) - -VC0706_MOTIONCONTROL = const(0x0) -VC0706_UARTMOTION = const(0x01) -VC0706_ACTIVATEMOTION = const(0x01) - -VC0706_SET_ZOOM = const(0x52) -VC0706_GET_ZOOM = const(0x53) +from micropython import const + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VC0706.git" + +# pylint: disable=bad-whitespace +_SERIAL = const(0x00) +_RESET = const(0x26) +_GEN_VERSION = const(0x11) +_SET_PORT = const(0x24) +_READ_FBUF = const(0x32) +_GET_FBUF_LEN = const(0x34) +_FBUF_CTRL = const(0x36) +_DOWNSIZE_CTRL = const(0x54) +_DOWNSIZE_STATUS = const(0x55) +_READ_DATA = const(0x30) +_WRITE_DATA = const(0x31) +_COMM_MOTION_CTRL = const(0x37) +_COMM_MOTION_STATUS = const(0x38) +_COMM_MOTION_DETECTED = const(0x39) +_MOTION_CTRL = const(0x42) +_MOTION_STATUS = const(0x43) +_TVOUT_CTRL = const(0x44) +_OSD_ADD_CHAR = const(0x45) + +_STOPCURRENTFRAME = const(0x0) +_STOPNEXTFRAME = const(0x1) +_RESUMEFRAME = const(0x3) +_STEPFRAME = const(0x2) + +# pylint doesn't like the lowercase x but it makes it more readable. +# pylint: disable=invalid-name +IMAGE_SIZE_640x480 = const(0x00) +IMAGE_SIZE_320x240 = const(0x11) +IMAGE_SIZE_160x120 = const(0x22) +# pylint: enable=invalid-name + +_MOTIONCONTROL = const(0x0) +_UARTMOTION = const(0x01) +_ACTIVATEMOTION = const(0x01) + +__SET_ZOOM = const(0x52) +__GET_ZOOM = const(0x53) _CAMERA_DELAY = const(10) +# pylint: enable=bad-whitespace class VC0706: - - _COMMAND_HEADER = bytearray(3) - - def __init__(self, rx, tx, baudrate=38400, timeout=250, buffer_size=100): + """Driver for VC0706 serial TTL camera module. + + :param ~microcontroller.Pin rx: Receive pin + :param ~microcontroller.Pin tx: Transmit pin + :param int baudrate: Serial connection speed + :param int timeout: Read timeout in seconds + :param int buffer_size: Receive buffer size + """ + def __init__(self, rx, tx, *, baudrate=38400, timeout=250, buffer_size=100): self._uart = busio.UART(tx, rx, baudrate=baudrate, timeout=timeout) self._buffer = bytearray(buffer_size) self._frame_ptr = 0 - if not self._run_command(_VC0706_RESET, bytes([0x00]), 5): + self._command_header = bytearray(3) + if not self._run_command(_RESET, bytes([0x00]), 5): raise RuntimeError('Failed to get response from VC0706, check wiring!') @property def version(self): """Return camera version byte string.""" # Clear buffer to ensure the end of a string can be found. - self._send_command(_VC0706_GEN_VERSION, bytes([0x01])) + self._send_command(_GEN_VERSION, bytes([0x01])) readlen = self._read_response(self._buffer, len(self._buffer)) return str(self._buffer[:readlen], 'ascii') @property def image_size(self): - """Get the current image size, will return a value of VC0706_640x480, - VC0706_320x240, or VC0706_160x120. + """Get the current image size, will return a value of IMAGE_SIZE_640x480, + IMAGE_SIZE_320x240, or IMAGE_SIZE_160x120. """ - if not self._run_command(_VC0706_READ_DATA, bytes([0x4, 0x4, 0x1, 0x00, - 0x19]), 6): + if not self._run_command(_READ_DATA, + bytes([0x4, 0x4, 0x1, 0x00, 0x19]), + 6): raise RuntimeError('Failed to read image size!') return self._buffer[5] @image_size.setter def image_size(self, size): - """Set the image size to a value of VC0706_640x480, VC0706_320x240, or - VC0706_160x120. + """Set the image size to a value of IMAGE_SIZE_640x480, IMAGE_SIZE_320x240, or + IMAGE_SIZE_160x120. """ - if size not in (VC0706_640x480, VC0706_320x240, VC0706_160x120): - raise ValueError('Size must be one of VC0706_640x480, VC0706_320x240, or VC0706_160x120!') - return self._run_command(_VC0706_WRITE_DATA, bytes([0x05, 0x04, 0x01, - 0x00, 0x19, size & 0xFF]), 5) + if size not in (IMAGE_SIZE_640x480, IMAGE_SIZE_320x240, IMAGE_SIZE_160x120): + raise ValueError("Size must be one of IMAGE_SIZE_640x480, IMAGE_SIZE_320x240, or " + "IMAGE_SIZE_160x120!") + return self._run_command(_WRITE_DATA, bytes([0x05, 0x04, 0x01, 0x00, 0x19, size & 0xFF]), 5) @property def frame_length(self): """Return the length in bytes of the currently capture frame/picture. """ - if not self._run_command(_VC0706_GET_FBUF_LEN, bytes([0x01, 0x00]), 9): + if not self._run_command(_GET_FBUF_LEN, bytes([0x01, 0x00]), 9): return 0 frame_length = self._buffer[5] frame_length <<= 8 @@ -128,8 +143,7 @@ def take_picture(self): """Tell the camera to take a picture. Returns True if successful. """ self._frame_ptr = 0 - return self._run_command(_VC0706_FBUF_CTRL, bytes([0x1, - _VC0706_STOPCURRENTFRAME]), 5) + return self._run_command(_FBUF_CTRL, bytes([0x1, _STOPCURRENTFRAME]), 5) def read_picture_into(self, buf): """Read the next bytes of frame/picture data into the provided buffer. @@ -145,7 +159,7 @@ def read_picture_into(self, buf): args = bytes([0x0C, 0x0, 0x0A, 0, 0, (self._frame_ptr >> 8) & 0xFF, self._frame_ptr & 0xFF, 0, 0, 0, n & 0xFF, (_CAMERA_DELAY >> 8) & 0xFF, _CAMERA_DELAY & 0xFF]) - if not self._run_command(_VC0706_READ_FBUF, args, 5): + if not self._run_command(_READ_FBUF, args, 5): return 0 if self._read_response(self._buffer, n+5) == 0: return 0 @@ -168,13 +182,13 @@ def _read_response(self, result, numbytes): return self._uart.readinto(result, numbytes) def _verify_response(self, cmd): - return self._buffer[0] == 0x76 and self._buffer[1] == _VC0706_SERIAL \ - and self._buffer[2] == cmd & 0xFF and self._buffer[3] == 0x00 + return (self._buffer[0] == 0x76 and self._buffer[1] == _SERIAL and + self._buffer[2] == cmd & 0xFF and self._buffer[3] == 0x00) def _send_command(self, cmd, args=None): - self._COMMAND_HEADER[0] = 0x56 - self._COMMAND_HEADER[1] = _VC0706_SERIAL - self._COMMAND_HEADER[2] = cmd & 0xFF - self._uart.write(self._COMMAND_HEADER) - if args is not None and len(args) > 0: + self._command_header[0] = 0x56 + self._command_header[1] = _SERIAL + self._command_header[2] = cmd & 0xFF + self._uart.write(self._command_header) + if args: self._uart.write(args) diff --git a/examples/snapshot.py b/examples/snapshot.py index b40952f..0dec182 100644 --- a/examples/snapshot.py +++ b/examples/snapshot.py @@ -6,20 +6,21 @@ # https://github.com/adafruit/Adafruit_CircuitPython_SD # See the guide here for more details on using SD cards with CircuitPython: # https://learn.adafruit.com/micropython-hardware-sd-cards +import time + import board import busio import digitalio import storage -import time import adafruit_sdcard import adafruit_vc0706 # Configuration: -SD_CS_PIN = board.SD_CS # CS for SD card (SD_CS is for Feather Adalogger) -RX_PIN = board.RX # RX pin of board, connected to VC0706 TX -TX_PIN = board.TX # TX pin of board, connected to VC0706 RX +SD_CS_PIN = board.SD_CS # CS for SD card (SD_CS is for Feather Adalogger) +RX_PIN = board.RX # RX pin of board, connected to VC0706 TX +TX_PIN = board.TX # TX pin of board, connected to VC0706 RX IMAGE_FILE = '/sd/image.jpg' # Full path to file name to save captured image. # Will overwrite! @@ -40,16 +41,16 @@ print(vc0706.version) # Set the image size. -vc0706.image_size = adafruit_vc0706.VC0706_640x480 # Or set VC0706_320x240 or - # VC0706_160x120 +vc0706.image_size = adafruit_vc0706.IMAGE_SIZE_640x480 # Or set IMAGE_SIZE_320x240 or + # IMAGE_SIZE_160x120 # Note you can also read the property and compare against those values to # see the current size: size = vc0706.image_size -if size == adafruit_vc0706.VC0706_640x480: +if size == adafruit_vc0706.IMAGE_SIZE_640x480: print('Using 640x480 size image.') -elif size == adafruit_vc0706.VC0706_320x240: +elif size == adafruit_vc0706.IMAGE_SIZE_320x240: print('Using 320x240 size image.') -elif size == adafruit_vc0706.VC0706_160x120: +elif size == adafruit_vc0706.IMAGE_SIZE_160x120: print('Using 160x120 size image.') # Take a picture. diff --git a/examples/snapshot_internal.py b/examples/snapshot_internal.py index f4195cd..b51fb11 100644 --- a/examples/snapshot_internal.py +++ b/examples/snapshot_internal.py @@ -2,17 +2,16 @@ # You must wire up the VC0706 to the board's serial port, and enable writes # to the internal filesystem by following this page to edit boot.py: # https://learn.adafruit.com/cpu-temperature-logging-with-circuit-python/writing-to-the-filesystem +import time + import board import busio -import digitalio -import time import adafruit_vc0706 - # Configuration: -RX_PIN = board.RX # RX pin of board, connected to VC0706 TX -TX_PIN = board.TX # TX pin of board, connected to VC0706 RX +RX_PIN = board.RX # RX pin of board, connected to VC0706 TX +TX_PIN = board.TX # TX pin of board, connected to VC0706 RX IMAGE_FILE = '/image.jpg' # Full path to file name to save captured image. # Will overwrite! @@ -27,16 +26,16 @@ print(vc0706.version) # Set the image size. -vc0706.image_size = adafruit_vc0706.VC0706_640x480 # Or set VC0706_320x240 or +vc0706.image_size = adafruit_vc0706.IMAGE_SIZE_640x480 # Or set VC0706_320x240 or # VC0706_160x120 # Note you can also read the property and compare against those values to # see the current size: size = vc0706.image_size -if size == adafruit_vc0706.VC0706_640x480: +if size == adafruit_vc0706.IMAGE_SIZE_640x480: print('Using 640x480 size image.') -elif size == adafruit_vc0706.VC0706_320x240: +elif size == adafruit_vc0706.IMAGE_SIZE_320x240: print('Using 320x240 size image.') -elif size == adafruit_vc0706.VC0706_160x120: +elif size == adafruit_vc0706.IMAGE_SIZE_160x120: print('Using 160x120 size image.') # Take a picture. diff --git a/readthedocs.yml b/readthedocs.yml index a3a16c1..f4243ad 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,2 +1,3 @@ +python: + version: 3 requirements_file: requirements.txt -