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..4c0ccb6 --- /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_io/*.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-adafruit_io --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..8ee6e44 --- /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 helpers. 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.rst b/README.rst new file mode 100644 index 0000000..92f12bc --- /dev/null +++ b/README.rst @@ -0,0 +1,108 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-adafruit_io/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/adafruit_io/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_Adafruit_IO.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Adafruit_IO + :alt: Build Status + +CircuitPython wrapper library for communicating with `Adafruit IO `_. + + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ +* `Adafruit CircuitPython ESP32SPI `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Usage Example +============= + +Create an Adafruit IO Client object +.. code-block:: python +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +Sending data to an Adafruit IO feed +.. code-block:: python +io.send_data(feed, data) + +Receiving data from an Adafruit IO feed +.. code-block:: python +data = io.receive_data(feed) + +Creating a new feed named circuitpython with a description +.. code-block:: python +feed = io.create_new_feed('circuitpython', 'an Adafruit IO CircuitPython feed') + +Listing the record of a specified feed: +.. code-block:: python +feed = io.get_feed('circuitpython') + +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-adafruit_io --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_io/__init__.py b/adafruit_io/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/adafruit_io/adafruit_io.py b/adafruit_io/adafruit_io.py new file mode 100755 index 0000000..524b3dd --- /dev/null +++ b/adafruit_io/adafruit_io.py @@ -0,0 +1,257 @@ +# 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_io` +================================================================================ + +A CircuitPython/Python library for communicating with Adafruit IO over WiFi + +* Author(s): Brent Rubell for Adafruit Industries + +Implementation Notes +-------------------- + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +* Adafruit's ESP32SPI library: + https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI +""" +from adafruit_io.adafruit_io_errors import AdafruitIO_RequestError, AdafruitIO_ThrottleError + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Adafruit_IO.git" + +class RESTClient(): + """ + REST Client for interacting with the Adafruit IO API. + """ + def __init__(self, adafruit_io_username, adafruit_io_key, wifi_manager): + """ + Creates an instance of the Adafruit IO REST Client. + :param str adafruit_io_username: Adafruit IO Username + :param str adafruit_io_key: Adafruit IO Key + :param wifi_manager: WiFiManager object from adafruit_esp32spi_wifimanager + """ + self.username = adafruit_io_username + self.key = adafruit_io_key + if wifi_manager: + self.wifi = wifi_manager + else: + raise TypeError("This library requires a WiFiManager object.") + self.http_headers = [{bytes("X-AIO-KEY", "utf-8"):bytes(self.key, "utf-8"), + bytes("Content-Type", "utf-8"):bytes('application/json', "utf-8")}, + {bytes("X-AIO-KEY", "utf-8"):bytes(self.key, "utf-8")}] + + @staticmethod + def _create_data(data, metadata): + """Creates JSON data payload + """ + if metadata is not None: + return {'value':data, 'lat':metadata['lat'], 'lon':metadata['lon'], + 'ele':metadata['ele'], 'created_at':metadata['created_at']} + return {'value':data} + + @staticmethod + def _handle_error(response): + """Checks HTTP status codes + and raises errors. + """ + if response.status_code == 429: + raise AdafruitIO_ThrottleError + elif response.status_code == 400: + raise AdafruitIO_RequestError(response) + elif response.status_code >= 400: + raise AdafruitIO_RequestError(response) + + def _compose_path(self, path): + """Composes a valid API request path. + :param str path: Adafruit IO API URL path. + """ + return "{0}/{1}/{2}/{3}".format('https://io.adafruit.com/api', 'v2', self.username, path) + + # HTTP Requests + def _post(self, path, payload): + """ + POST data to Adafruit IO + :param str path: Formatted Adafruit IO URL from _compose_path + :param json payload: JSON data to send to Adafruit IO + """ + response = self.wifi.post( + path, + json=payload, + headers=self.http_headers[0]) + self._handle_error(response) + return response.json() + + def _get(self, path, return_text=False): + """ + GET data from Adafruit IO + :param str path: Formatted Adafruit IO URL from _compose_path + :param bool return_text: Returns text instead of json + """ + response = self.wifi.get( + path, + headers=self.http_headers[1]) + self._handle_error(response) + if return_text: + return response.text + return response.json() + + def _delete(self, path): + """ + DELETE data from Adafruit IO. + :param str path: Formatted Adafruit IO URL from _compose_path + """ + response = self.wifi.delete( + path, + headers=self.http_headers[0]) + self._handle_error(response) + return response.json() + + # Data + def send_data(self, feed_key, data, metadata=None): + """ + Sends value data to a specified Adafruit IO feed. + :param str feed_key: Adafruit IO feed key + :param str data: Data to send to the Adafruit IO feed + :param dict metadata: Optional metadata associated with the data + """ + path = self._compose_path("feeds/{0}/data".format(feed_key)) + payload = self._create_data(data, metadata) + self._post(path, payload) + + def receive_data(self, feed_key): + """ + Return the most recent value for the specified feed. + :param string feed_key: Adafruit IO feed key + """ + path = self._compose_path("feeds/{0}/data/last".format(feed_key)) + return self._get(path) + + def delete_data(self, feed_key, data_id): + """ + Deletes an existing Data point from a feed. + :param string feed: Adafruit IO feed key + :param string data_id: Data point to delete from the feed + """ + path = self._compose_path("feeds/{0}/data/{1}".format(feed_key, data_id)) + return self._delete(path) + + # Groups + def add_feed_to_group(self, group_key, feed_key): + """ + Adds an existing feed to a group + :param str group_key: Group + :param str feed_key: Feed to add to the group + """ + path = self._compose_path("groups/{0}/add".format(group_key)) + payload = {'feed_key':feed_key} + return self._post(path, payload) + + def create_new_group(self, group_key, group_description): + """ + Creates a new Adafruit IO Group. + :param str group_key: Adafruit IO Group Key + :param str group_description: Brief summary about the group + """ + path = self._compose_path("groups") + payload = {'name':group_key, 'description':group_description} + return self._post(path, payload) + + def delete_group(self, group_key): + """ + Deletes an existing group. + :param str group_key: Adafruit IO Group Key + """ + path = self._compose_path("groups/{0}".format(group_key)) + return self._delete(path) + + def get_group(self, group_key): + """ + Returns Group based on Group Key + :param str group_key: Adafruit IO Group Key + """ + path = self._compose_path("groups/{0}".format(group_key)) + return self._get(path) + + # Feeds + def get_feed(self, feed_key, detailed=False): + """ + Returns an Adafruit IO feed based on the feed key + :param str feed_key: Adafruit IO Feed Key + :param bool detailed: Returns a more verbose feed record + """ + if detailed: + path = self._compose_path("feeds/{0}/details".format(feed_key)) + else: + path = self._compose_path("feeds/{0}".format(feed_key)) + return self._get(path) + + def create_new_feed(self, feed_key, feed_desc=None, feed_license=None): + """ + Creates a new Adafruit IO feed. + :param str feed_key: Adafruit IO Feed Key + :param str feed_desc: Optional description of feed + :param str feed_license: Optional feed license + """ + path = self._compose_path("feeds") + payload = {'name':feed_key, + 'description':feed_desc, + 'license':feed_license} + return self._post(path, payload) + + def delete_feed(self, feed_key): + """ + Deletes an existing feed. + :param str feed_key: Valid feed key + """ + path = self._compose_path("feeds/{0}".format(feed_key)) + return self._delete(path) + + # Adafruit IO Connected Services + def receive_weather(self, weather_id): + """ + Get data from the Adafruit IO Weather Forecast Service + NOTE: This service is avaliable to Adafruit IO Plus subscribers only. + :param int weather_id: ID for retrieving a specified weather record. + """ + path = self._compose_path("integrations/weather/{0}".format(weather_id)) + return self._get(path) + + def receive_random_data(self, generator_id): + """ + Get data from the Adafruit IO Random Data Stream Service + :param int generator_id: Specified randomizer record + """ + path = self._compose_path("integrations/words/{0}".format(generator_id)) + return self._get(path) + + def receive_time(self, time_type): + """ + Returns the current time from the Adafruit IO Server + :param string time_type: Type of time to be returned: millis, seconds, or ISO-8601 + """ + path = 'https://io.adafruit.com/api/v2/time/{0}'.format(time_type) + return self._get(path, return_text=True) diff --git a/adafruit_io/adafruit_io_errors.py b/adafruit_io/adafruit_io_errors.py new file mode 100755 index 0000000..9e9ecea --- /dev/null +++ b/adafruit_io/adafruit_io_errors.py @@ -0,0 +1,41 @@ +# The MIT License (MIT) +# +# Copyright (c) 2019 Brent Rubell for Adafruit +# +# 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_io_errors.py` +====================================================== +CircuitPython Adafruit IO Error Classes +* Author(s): Brent Rubell +""" + +class AdafruitIO_ThrottleError(Exception): + """Adafruit IO request error class for rate-limiting""" + def __init__(self): + super(AdafruitIO_ThrottleError, self).__init__("Number of Adafruit IO Requests exceeded! \ + Please try again in 30 seconds..") + +class AdafruitIO_RequestError(Exception): + """Adafruit IO request error class""" + def __init__(self, response): + response_content = response.json() + error = response_content['error'] + super(AdafruitIO_RequestError, self).__init__("Adafruit IO Error {0}: {1}" + .format(response.status_code, error)) diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..4705ac0 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,9 @@ +API +------------ +.. If you created a package, create one automodule per module in the package. + +.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) +.. use this format as the module name: "adafruit_foo.foo" + +.. automodule:: adafruit_io + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..e3d0d23 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,153 @@ +# -*- coding: utf-8 -*- + +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration ------------------------------------------------ + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', +] + +intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Adafruit Adafruit_IO Library' +copyright = u'2019 Brent Rubell' +author = u'Brent Rubell' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'1.0' +# The full version, including alpha/beta/rc tags. +release = u'1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +default_role = "any" + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +add_function_parentheses = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# If this is True, todo emits a warning for each TODO entries. The default is False. +todo_emit_warnings = True + +napoleon_numpy_docstring = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + try: + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.'] + except: + html_theme = 'default' + html_theme_path = ['.'] +else: + html_theme_path = ['.'] + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +html_favicon = '_static/favicon.ico' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'AdafruitAdafruit_ioLibrarydoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'AdafruitAdafruit_IOLibrary.tex', u'AdafruitAdafruit_IO Library Documentation', + author, 'manual'), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'AdafruitAdafruit_IOlibrary', u'Adafruit Adafruit_IO Library Documentation', + [author], 1) +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'AdafruitAdafruit_IOLibrary', u'Adafruit Adafruit_IO Library Documentation', + author, 'AdafruitAdafruit_IOLibrary', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..db69245 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/adafruit_io_simpletest_data.py + :caption: examples/adafruit_io_simpletest_data.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..cac5a94 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,46 @@ +.. include:: ../README.rst + +Table of Contents +================= + +.. toctree:: + :maxdepth: 4 + :hidden: + + self + +.. toctree:: + :caption: Examples + + examples + +.. toctree:: + :caption: API Reference + :maxdepth: 3 + + api + +.. toctree:: + :caption: Tutorials + + +.. toctree:: + :caption: Related Products + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/adafruit_io_simpletest_data.py b/examples/adafruit_io_simpletest_data.py new file mode 100644 index 0000000..bb84cc0 --- /dev/null +++ b/examples/adafruit_io_simpletest_data.py @@ -0,0 +1,66 @@ +""" +Sending data to Adafruit IO and receiving it. +""" +from random import randint +import board +import busio +from digitalio import DigitalInOut + +# ESP32 SPI +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + +# Import Adafruit IO REST Client +from adafruit_io.adafruit_io import RESTClient, AdafruitIO_RequestError + +# Get wifi details and more from a wifi_settings.py.py file +try: + from wifi_settings import settings +except ImportError: + print("WiFi settings are kept in wifi_settings.py.py, please add them there!") + raise + +# ESP32 Setup +esp32_cs = DigitalInOut(board.D9) +esp32_ready = DigitalInOut(board.D10) +esp32_reset = DigitalInOut(board.D5) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) + +""" +# PyPortal ESP32 Setup +import microcontroller +esp32_cs = DigitalInOut(microcontroller.pin.PB14) +esp32_ready = DigitalInOut(microcontroller.pin.PB16) +esp32_reset = DigitalInOut(microcontroller.pin.PB17) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) +""" + +# Set your Adafruit IO Username and Key in wifi_settings.py +# (visit io.adafruit.com if you need to create an account, +# or if you need your Adafruit IO key.) +ADAFRUIT_IO_USER = settings['adafruit_io_user'] +ADAFRUIT_IO_KEY = settings['adafruit_io_key'] + +# Create an instance of the Adafruit IO REST client +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +try: + # Get the 'temperature' feed from Adafruit IO + temperature_feed = io.get_feed('temperature') +except AdafruitIO_RequestError: + # If no 'temperature' feed exists, create one + temperature_feed = io.create_new_feed('temperature') + +# Send random integer values to the feed +random_value = randint(0, 50) +print('Sending {0} to temperature feed...'.format(random_value)) +io.send_data(temperature_feed['key'], random_value) +print('Data sent!') + +# Retrieve data value from the feed +print('Retrieving data from temperature feed...') +received_data = io.receive_data(temperature_feed['key']) +print('Data from temperature feed: ', received_data['value']) diff --git a/examples/adafruit_io_simpletest_digital_out.py b/examples/adafruit_io_simpletest_digital_out.py new file mode 100644 index 0000000..8e0350c --- /dev/null +++ b/examples/adafruit_io_simpletest_digital_out.py @@ -0,0 +1,76 @@ +""" +Example of turning on and off a LED +from an Adafruit IO Dashboard. +""" +import time +import board +import busio +from digitalio import DigitalInOut, Direction + +# ESP32 SPI +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + +# Import Adafruit IO REST Client +from adafruit_io.adafruit_io import RESTClient, AdafruitIO_RequestError + +# Get wifi details and more from a wifi_settings.py.py file +try: + from wifi_settings import settings +except ImportError: + print("WiFi settings are kept in wifi_settings.py.py, please add them there!") + raise + +# ESP32 Setup +esp32_cs = DigitalInOut(board.D9) +esp32_ready = DigitalInOut(board.D10) +esp32_reset = DigitalInOut(board.D5) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) + +""" +# PyPortal ESP32 Setup +import microcontroller +esp32_cs = DigitalInOut(microcontroller.pin.PB14) +esp32_ready = DigitalInOut(microcontroller.pin.PB16) +esp32_reset = DigitalInOut(microcontroller.pin.PB17) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) +""" + +# Set your Adafruit IO Username and Key in wifi_settings.py +# (visit io.adafruit.com if you need to create an account, +# or if you need your Adafruit IO key.) +ADAFRUIT_IO_USER = settings['adafruit_io_user'] +ADAFRUIT_IO_KEY = settings['adafruit_io_key'] + +# Create an instance of the Adafruit IO REST client +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +try: + # Get the 'digital' feed from Adafruit IO + digital_feed = io.get_feed('digital') +except AdafruitIO_RequestError: + # If no 'digital' feed exists, create one + digital_feed = io.create_new_feed('digital') + +# Set up LED +LED = DigitalInOut(board.D13) +LED.direction = Direction.OUTPUT + +while True: + # Get data from 'digital' feed + print('getting data from IO...') + feed_data = io.receive_data(digital_feed['key']) + + # Check if data is ON or OFF + if int(feed_data['value']) == 1: + print('received <- ON\n') + elif int(feed_data['value']) == 0: + print('received <= OFF\n') + + # Set the LED to the feed value + LED.value = int(feed_data['value']) + + time.sleep(5) diff --git a/examples/adafruit_io_simpletest_feeds.py b/examples/adafruit_io_simpletest_feeds.py new file mode 100644 index 0000000..1f997f7 --- /dev/null +++ b/examples/adafruit_io_simpletest_feeds.py @@ -0,0 +1,61 @@ +""" +Example of interacting with Adafruit IO feeds +""" +import board +import busio +from digitalio import DigitalInOut + +# ESP32 SPI +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + +# Import Adafruit IO REST Client +from adafruit_io.adafruit_io import RESTClient + +# Get wifi details and more from a wifi_settings.py.py file +try: + from wifi_settings import settings +except ImportError: + print("WiFi settings are kept in wifi_settings.py.py, please add them there!") + raise + +# ESP32 Setup +esp32_cs = DigitalInOut(board.D9) +esp32_ready = DigitalInOut(board.D10) +esp32_reset = DigitalInOut(board.D5) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) + +""" +# PyPortal ESP32 Setup +import microcontroller +esp32_cs = DigitalInOut(microcontroller.pin.PB14) +esp32_ready = DigitalInOut(microcontroller.pin.PB16) +esp32_reset = DigitalInOut(microcontroller.pin.PB17) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) +""" + +# Set your Adafruit IO Username and Key in wifi_settings.py +# (visit io.adafruit.com if you need to create an account, +# or if you need your Adafruit IO key.) +ADAFRUIT_IO_USER = settings['adafruit_io_user'] +ADAFRUIT_IO_KEY = settings['adafruit_io_key'] + +# Create an instance of the Adafruit IO REST client +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +# Create a new 'circuitpython' feed with a description +print('Creating new Adafruit IO feed...') +feed = io.create_new_feed('circuitpython', 'a Adafruit IO CircuitPython feed') + +# List a specified feed +print('Retrieving new Adafruit IO feed...') +specified_feed = io.get_feed('circuitpython') +print(specified_feed) + +# Delete a specified feed by feed key +print('Deleting feed...') +io.delete_feed(specified_feed['key']) +print('Feed deleted!') diff --git a/examples/adafruit_io_simpletest_groups.py b/examples/adafruit_io_simpletest_groups.py new file mode 100644 index 0000000..f6b3752 --- /dev/null +++ b/examples/adafruit_io_simpletest_groups.py @@ -0,0 +1,63 @@ +""" +Example of performing group operations +""" +import board +import busio +from digitalio import DigitalInOut + +# ESP32 SPI +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + +# Import Adafruit IO REST Client +from adafruit_io.adafruit_io import RESTClient + +# Get wifi details and more from a wifi_settings.py.py file +try: + from wifi_settings import settings +except ImportError: + print("WiFi settings are kept in wifi_settings.py.py, please add them there!") + raise + + +# ESP32 Setup +esp32_cs = DigitalInOut(board.D9) +esp32_ready = DigitalInOut(board.D10) +esp32_reset = DigitalInOut(board.D5) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) + +""" +# PyPortal ESP32 Setup +import microcontroller +esp32_cs = DigitalInOut(microcontroller.pin.PB14) +esp32_ready = DigitalInOut(microcontroller.pin.PB16) +esp32_reset = DigitalInOut(microcontroller.pin.PB17) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) +""" + +# Set your Adafruit IO Username and Key in wifi_settings.py +# (visit io.adafruit.com if you need to create an account, +# or if you need your Adafruit IO key.) +ADAFRUIT_IO_USER = settings['adafruit_io_user'] +ADAFRUIT_IO_KEY = settings['adafruit_io_key'] + +# Create an instance of the Adafruit IO REST client +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +# Create a new group +print('Creating a new Adafruit IO Group...') +sensor_group = io.create_new_group('envsensors', 'a group of environmental sensors') + +# Add the 'temperature' feed to the group +print('Adding feed temperature to group...') +io.add_feed_to_group(sensor_group['key'], 'temperature') + +# Get info from the group +print(sensor_group) + +# Delete the group +print('Deleting group...') +io.delete_group('envsensors') diff --git a/examples/adafruit_io_simpletest_metadata.py b/examples/adafruit_io_simpletest_metadata.py new file mode 100644 index 0000000..746684a --- /dev/null +++ b/examples/adafruit_io_simpletest_metadata.py @@ -0,0 +1,69 @@ +""" +Example of attaching metadata +to data sent to Adafruit IO. +""" +import board +import busio +from digitalio import DigitalInOut + +# ESP32 SPI +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + +# Import Adafruit IO REST Client +from adafruit_io.adafruit_io import RESTClient, AdafruitIO_RequestError + +# Get wifi details and more from a wifi_settings.py.py file +try: + from wifi_settings import settings +except ImportError: + print("WiFi settings are kept in wifi_settings.py.py, please add them there!") + raise + +# ESP32 Setup +esp32_cs = DigitalInOut(board.D9) +esp32_ready = DigitalInOut(board.D10) +esp32_reset = DigitalInOut(board.D5) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) + +""" +# PyPortal ESP32 Setup +import microcontroller +esp32_cs = DigitalInOut(microcontroller.pin.PB14) +esp32_ready = DigitalInOut(microcontroller.pin.PB16) +esp32_reset = DigitalInOut(microcontroller.pin.PB17) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) +""" + +# Set your Adafruit IO Username and Key in wifi_settings.py +# (visit io.adafruit.com if you need to create an account, +# or if you need your Adafruit IO key.) +ADAFRUIT_IO_USER = settings['adafruit_io_user'] +ADAFRUIT_IO_KEY = settings['adafruit_io_key'] + +# Create an instance of the Adafruit IO REST client +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +try: + # Get the 'location' feed from Adafruit IO + location_feed = io.get_feed('location') +except AdafruitIO_RequestError: + # If no 'location' feed exists, create one + location_feed = io.create_new_feed('location') + +# Set data +data_value = 42 + +# Set up metadata associated with data_value +metadata = {'lat': 40.726190, + 'lon': -74.005334, + 'ele': -6, + 'created_at': None} + +# Send data and location metadata to the 'location' feed +print('Sending data and location metadata to IO...') +io.send_data(location_feed['key'], data_value, metadata) +print('Data sent!') diff --git a/examples/adafruit_io_simpletest_randomizer.py b/examples/adafruit_io_simpletest_randomizer.py new file mode 100644 index 0000000..6da5741 --- /dev/null +++ b/examples/adafruit_io_simpletest_randomizer.py @@ -0,0 +1,63 @@ +""" +Example of using Adafruit IO's +random data service. +""" +import time +import board +import busio +from digitalio import DigitalInOut + +# ESP32 SPI +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + +# Import Adafruit IO REST Client +from adafruit_io.adafruit_io import RESTClient + +# Get wifi details and more from a wifi_settings.py.py file +try: + from wifi_settings import settings +except ImportError: + print("WiFi settings are kept in wifi_settings.py.py, please add them there!") + raise + +# ESP32 Setup +esp32_cs = DigitalInOut(board.D9) +esp32_ready = DigitalInOut(board.D10) +esp32_reset = DigitalInOut(board.D5) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) + +""" +# PyPortal ESP32 Setup +import microcontroller +esp32_cs = DigitalInOut(microcontroller.pin.PB14) +esp32_ready = DigitalInOut(microcontroller.pin.PB16) +esp32_reset = DigitalInOut(microcontroller.pin.PB17) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) +""" + +# Set your Adafruit IO Username and Key in wifi_settings.py +# (visit io.adafruit.com if you need to create an account, +# or if you need your Adafruit IO key.) +ADAFRUIT_IO_USER = settings['adafruit_io_user'] +ADAFRUIT_IO_KEY = settings['adafruit_io_key'] + +# Create an instance of the Adafruit IO REST client +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +# Random Data ID +# (to obtain this value, visit +# https://io.adafruit.com/services/words +# and copy over the location ID) +random_data_id = 1234 + +while True: + print('Fetching random data from Adafruit IO...') + random_data = io.receive_random_data(random_data_id) + print('Random Data: ', random_data['value']) + print('Data Seed: ', random_data['seed']) + print('Waiting 1 minute to fetch new randomized data...') + time.sleep(60) diff --git a/examples/adafruit_io_simpletest_temperature.py b/examples/adafruit_io_simpletest_temperature.py new file mode 100644 index 0000000..91d4dc8 --- /dev/null +++ b/examples/adafruit_io_simpletest_temperature.py @@ -0,0 +1,79 @@ +""" +Example of sending temperature +values to an Adafruit IO feed. + +Dependencies: + * CircuitPython_ADT7410 + https://github.com/adafruit/Adafruit_CircuitPython_ADT7410 +""" +import time +import board +import busio +from digitalio import DigitalInOut + +# ESP32 SPI +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + +# Import Adafruit IO REST Client +from adafruit_io.adafruit_io import RESTClient, AdafruitIO_RequestError + +# Import ADT7410 Library +import adafruit_adt7410 + +# Get wifi details and more from a wifi_settings.py.py file +try: + from wifi_settings import settings +except ImportError: + print("WiFi settings are kept in wifi_settings.py.py, please add them there!") + raise + +# ESP32 Setup +esp32_cs = DigitalInOut(board.D9) +esp32_ready = DigitalInOut(board.D10) +esp32_reset = DigitalInOut(board.D5) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) + +""" +# PyPortal ESP32 Setup +import microcontroller +esp32_cs = DigitalInOut(microcontroller.pin.PB14) +esp32_ready = DigitalInOut(microcontroller.pin.PB16) +esp32_reset = DigitalInOut(microcontroller.pin.PB17) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) +""" + +# Set your Adafruit IO Username and Key in wifi_settings.py +# (visit io.adafruit.com if you need to create an account, +# or if you need your Adafruit IO key.) +ADAFRUIT_IO_USER = settings['adafruit_io_user'] +ADAFRUIT_IO_KEY = settings['adafruit_io_key'] + +# Create an instance of the Adafruit IO REST client +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +try: + # Get the 'temperature' feed from Adafruit IO + temperature_feed = io.get_feed('temperature') +except AdafruitIO_RequestError: + # If no 'temperature' feed exists, create one + temperature_feed = io.create_new_feed('temperature') + +# Set up ADT7410 sensor +i2c_bus = busio.I2C(board.SCL, board.SDA) +adt = adafruit_adt7410.ADT7410(i2c_bus, address=0x48) +adt.high_resolution = True + +while True: + temperature = adt.temperature + # set temperature value to two precision points + temperature = '%0.2f'%(temperature) + + print('Current Temperature: {0}*C'.format(temperature)) + print('Sending to Adafruit IO...') + io.send_data(temperature_feed['key'], temperature) + print('Data sent!') + time.sleep(0.5) diff --git a/examples/adafruit_io_simpletest_weather.py b/examples/adafruit_io_simpletest_weather.py new file mode 100644 index 0000000..ff091bb --- /dev/null +++ b/examples/adafruit_io_simpletest_weather.py @@ -0,0 +1,73 @@ +""" +Example of getting weather +from the Adafruit IO Weather Service +NOTE: This example is for Adafruit IO +Plus subscribers only. +""" +import board +import busio +from digitalio import DigitalInOut + +# ESP32 SPI +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager + +# Import Adafruit IO REST Client +from adafruit_io.adafruit_io import RESTClient + +# Get wifi details and more from a wifi_settings.py.py file +try: + from wifi_settings import settings +except ImportError: + print("WiFi settings are kept in wifi_settings.py.py, please add them there!") + raise + + +# ESP32 Setup +esp32_cs = DigitalInOut(board.D9) +esp32_ready = DigitalInOut(board.D10) +esp32_reset = DigitalInOut(board.D5) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) + +""" +# PyPortal ESP32 Setup +import microcontroller +esp32_cs = DigitalInOut(microcontroller.pin.PB14) +esp32_ready = DigitalInOut(microcontroller.pin.PB16) +esp32_reset = DigitalInOut(microcontroller.pin.PB17) +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, settings, board.NEOPIXEL) +""" + +# Set your Adafruit IO Username and Key in wifi_settings.py +# (visit io.adafruit.com if you need to create an account, +# or if you need your Adafruit IO key.) +ADAFRUIT_IO_USER = settings['adafruit_io_user'] +ADAFRUIT_IO_KEY = settings['adafruit_io_key'] + +# Create an instance of the Adafruit IO REST client +io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi) + +# Weather Location ID +# (to obtain this value, visit +# https://io.adafruit.com/services/weather +# and copy over the location ID) +location_id = 1234 + +print('Getting weather record from IO...') +# Get the specified weather record with current weather +# and all available forecast information. +forecast = io.receive_weather(location_id) + +# Get today's forecast +current_forecast = forecast['current'] +print('It is {0} and {1}*F.'.format(current_forecast['summary'], current_forecast['temperature'])) +print('with a humidity of {0}%'.format(current_forecast['humidity'])) + +# Get tomorrow's forecast +tom_forecast = forecast['forecast_days_1'] +print('\nTomorrow has a low of {0}*F and a high of {1}*F.'.format( + tom_forecast['temperatureLow'], tom_forecast['temperatureHigh'])) +print('with a humidity of {0}%'.format(tom_forecast['humidity'])) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..377afe7 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +Adafruit-Blinka +Adafruit_CircuitPython_ESP32SPI diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..88e6d11 --- /dev/null +++ b/setup.py @@ -0,0 +1,63 @@ +"""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-adafruitio', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='Adafruit IO for CircuitPython', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka', + 'Adafruit_CircuitPython_ESP32SPI' + ], + + # 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 adafruit_io adafruit-io rest api iot ' + 'wifi', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + py_modules=['adafruit_adafruit_io'], +)