From 285ea9f7ebacc3f481bad6fba5c3d468d7e6e259 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 10 May 2019 15:12:50 -0400 Subject: [PATCH 01/30] init! --- .gitignore | 12 + .pylintrc | 433 ++++++++++++++++++++++++++++++++ .readthedocs.yml | 3 + .travis.yml | 48 ++++ CODE_OF_CONDUCT.md | 127 ++++++++++ LICENSE | 21 ++ README.md | 2 - README.rst | 117 +++++++++ adafruit_azureiot.py | 106 ++++++++ docs/_static/favicon.ico | Bin 0 -> 4414 bytes docs/api.rst | 8 + docs/conf.py | 160 ++++++++++++ docs/examples.rst | 8 + docs/index.rst | 45 ++++ examples/azureiot_simpletest.py | 0 requirements.txt | 3 + setup.py | 64 +++++ 17 files changed, 1155 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 .pylintrc create mode 100644 .readthedocs.yml create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE delete mode 100644 README.md create mode 100644 README.rst create mode 100644 adafruit_azureiot.py create mode 100644 docs/_static/favicon.ico create mode 100644 docs/api.rst create mode 100644 docs/conf.py create mode 100644 docs/examples.rst create mode 100644 docs/index.rst create mode 100644 examples/azureiot_simpletest.py create mode 100644 requirements.txt create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..55f127b --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +*.mpy +.idea +__pycache__ +_build +*.pyc +.env +build* +bundles +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..039eaec --- /dev/null +++ b/.pylintrc @@ -0,0 +1,433 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +# jobs=1 +jobs=2 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +# notes=FIXME,XXX,TODO +notes=FIXME,XXX + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules=board + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# expected-line-ending-format= +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +# good-names=i,j,k,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +# max-attributes=7 +max-attributes=11 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..2c7f46d --- /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_azureiot.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-azureiot --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7ca3a1d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +The goal of the standards and moderation guidelines outlined here is to build +and maintain a respectful community. We ask that you don’t just aim to be +"technically unimpeachable", but rather try to be your best self. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +You may report in the following ways: + +In any situation, you may send an email to . + +On the Adafruit Discord, you may send an open message from any channel +to all Community Helpers by tagging @community moderators. You may also send an +open message from any channel, or a direct message to @kattni#1507, +@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or +@Andon#8175. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d4fbf1d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +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. diff --git a/README.md b/README.md deleted file mode 100644 index 66d9665..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_AzureIoT -Access to Microsoft Azure IoT device, messaging, and job services from CircuitPython! diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a31e03a --- /dev/null +++ b/README.rst @@ -0,0 +1,117 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-azureiot/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/azureiot/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_AzureIoT.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_AzureIoT + :alt: Build Status + +Access to Microsoft Azure IoT from CircuitPython + + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Installing from PyPI +-------------------- +.. note:: This library is not available on PyPI yet. Install documentation is included + as a standard element. Stay tuned for PyPI availability! +.. todo:: Remove the above note if PyPI version is/will be available at time of release. + If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-azureiot + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-azureiot + +To install in a virtual environment in your current project: + +.. code-block:: shell + + mkdir project-name && cd project-name + python3 -m venv .env + source .env/bin/activate + pip3 install adafruit-circuitpython-azureiot + +Usage Example +============= + +.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +Zip release files +----------------- + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-azureiot --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_azureiot.py b/adafruit_azureiot.py new file mode 100644 index 0000000..1506f5d --- /dev/null +++ b/adafruit_azureiot.py @@ -0,0 +1,106 @@ +# 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_AzureIoT` +================================================================================ + +Access to Microsoft Azure IoT from CircuitPython + + +* Author(s): Brent Rubell + +Implementation Notes +-------------------- + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice +* Adafruit's ESP32SPI library: https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI +""" + +# imports + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AzureIoT.git" + +AZURE_API_VERSION = "2018-06-30" # Azure URI API Version Identifier + +class iot_hub: + """ + Provides access to Azure IoT Hub. + https://docs.microsoft.com/en-us/rest/api/iothub/ + """ + def __init__(self, wifi_manager, iot_hub_name, sas_token): + """ Creates an instance of an Azure IoT Hub Client. + :param wifi_manager: WiFiManager object from ESPSPI_WiFiManager + :param str iot_hub_name: Name of your IoT Hub + :param str sas_token: SAS Token Identifier + (https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-security) + """ + wifi_type = str(type(wifi_manager)) + if 'ESPSPI_WiFiManager' in wifi_type: + self.wifi = wifi_manager + else: + raise TypeError("This library requires a WiFiManager object.") + self._iot_hub_url = "https://{0}.azure-devices.net".format(iot_hub_name) + self._sas_token = sas_token + self.azure_header = {"Authorization":'SharedAccessSignature sr=azure-airlift-test-hub.azure-devices.net&sig=4WbbY2AWdwJJzsxKKNliRnQ5mzX87JW8ToEoc%2FezuoU%3D&skn=iothubowner&se=1557550171'} + + # HTTP Request Methods + def _post(self, path, payload): + response = self.wifi.post( + path, + json=payload, + headers=self.azure_header) + return response.json() + + def _get(self, path, payload): + response = self.wifi.get( + path, + json=payload, + headers=self.azure_header) + return response.json() + + # Device Messaging + # D2C: Device-to-Cloud + def send_device_message(self, device_id, message): + """Sends a device-to-cloud message. + :param string device_id: Device Identifier. + :param string message: Message. + """ + path = "{0}/devices/{1}/messages/events?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + self._post(path, message) + + # C2D: Cloud-to-Device + + # IoT Hub Service + def get_devices(self): + """Retrieve devices from the identity registry of your IoT hub. + """ + path = "https://{0}/devices/?api-version={1}".format(self._iot_hub_url, AZURE_API_VERSION) + self._get(path) + + + # IoT Hub Resource Provider \ No newline at end of file diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635 GIT binary patch literal 4414 zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@Kt!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8 z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3 z%+myoFis_lTlCrGx2z$0BQdh+7?!JK#9K9@Z!VrG zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^># z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pRqiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$ zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo?^s4jqK=Lfg*9&geMGVQ z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4 zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%% z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI zn9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2 z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv) zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+2#5Cj5pp?FEK750S3BgeSDtaE^ zXUM@xoV6yBFKfzvY20V&Lr0yC + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/azureiot_simpletest.py b/examples/azureiot_simpletest.py new file mode 100644 index 0000000..e69de29 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7cd378a --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +Adafruit-Blinka +adafruit-bus-device +adafruit-circuitpython-esp32spi \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..430c025 --- /dev/null +++ b/setup.py @@ -0,0 +1,64 @@ +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='adafruit-circuitpython-azureiot', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='Access to Microsoft Azure IoT from CircuitPython', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_AzureIoT', + + # 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 azureiot azure, iot, device, services', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, + # CHANGE `py_modules=['...']` TO `packages=['...']` + py_modules=['adafruit_azureiot'], +) From 3eb01b1bba68421f8cf365da0fea314b5256388a Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 10 May 2019 15:14:21 -0400 Subject: [PATCH 02/30] add get_device, remove hardcoded authorization token --- adafruit_azureiot.py | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 1506f5d..01de4bd 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -61,26 +61,26 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token): """ wifi_type = str(type(wifi_manager)) if 'ESPSPI_WiFiManager' in wifi_type: - self.wifi = wifi_manager + self._wifi = wifi_manager else: raise TypeError("This library requires a WiFiManager object.") self._iot_hub_url = "https://{0}.azure-devices.net".format(iot_hub_name) self._sas_token = sas_token - self.azure_header = {"Authorization":'SharedAccessSignature sr=azure-airlift-test-hub.azure-devices.net&sig=4WbbY2AWdwJJzsxKKNliRnQ5mzX87JW8ToEoc%2FezuoU%3D&skn=iothubowner&se=1557550171'} + self.azure_header = {"Authorization":self._sas_token} # HTTP Request Methods def _post(self, path, payload): - response = self.wifi.post( + response = self._wifi.post( path, json=payload, headers=self.azure_header) - return response.json() + #return response.json() - def _get(self, path, payload): - response = self.wifi.get( + def _get(self, path): + response = self._wifi.get( path, - json=payload, headers=self.azure_header) + print(response.text) return response.json() # Device Messaging @@ -99,8 +99,14 @@ def send_device_message(self, device_id, message): def get_devices(self): """Retrieve devices from the identity registry of your IoT hub. """ - path = "https://{0}/devices/?api-version={1}".format(self._iot_hub_url, AZURE_API_VERSION) + path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZURE_API_VERSION) self._get(path) + def get_device(self, device_id): + """Retrieves a device from the identity registry of an IoT hub. + :param str device_id: Device Identifier. + """ + path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + self._get(path) # IoT Hub Resource Provider \ No newline at end of file From 614a0772201a429facac0d80362667ed9b6c28b7 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 10 May 2019 16:57:51 -0400 Subject: [PATCH 03/30] add delete/patch http methods, expose device twin get and replace --- adafruit_azureiot.py | 59 +++++++++++++++++++++++++++++++++----------- 1 file changed, 45 insertions(+), 14 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 01de4bd..1ff3d05 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -40,8 +40,6 @@ * Adafruit's ESP32SPI library: https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI """ -# imports - __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AzureIoT.git" @@ -49,14 +47,14 @@ class iot_hub: """ - Provides access to Azure IoT Hub. + Provides access to an Azure IoT Hub. https://docs.microsoft.com/en-us/rest/api/iothub/ """ def __init__(self, wifi_manager, iot_hub_name, sas_token): """ Creates an instance of an Azure IoT Hub Client. - :param wifi_manager: WiFiManager object from ESPSPI_WiFiManager - :param str iot_hub_name: Name of your IoT Hub - :param str sas_token: SAS Token Identifier + :param wifi_manager: WiFiManager object from ESPSPI_WiFiManager. + :param str iot_hub_name: Name of your IoT Hub. + :param str sas_token: SAS Token Identifier. (https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-security) """ wifi_type = str(type(wifi_manager)) @@ -66,21 +64,33 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token): raise TypeError("This library requires a WiFiManager object.") self._iot_hub_url = "https://{0}.azure-devices.net".format(iot_hub_name) self._sas_token = sas_token - self.azure_header = {"Authorization":self._sas_token} + self._azure_header = {"Authorization":self._sas_token} # HTTP Request Methods def _post(self, path, payload): response = self._wifi.post( path, json=payload, - headers=self.azure_header) + headers = self._azure_header) #return response.json() def _get(self, path): response = self._wifi.get( path, - headers=self.azure_header) - print(response.text) + headers = self._azure_header) + return response.json() + + def _delete(self, path): + response = self._wifi.delete( + path, + headers = self._azure_header) + return response.json() + + def _patch(self, path, payload): + response = self._wifi.patch( + path, + json = payload, + headers = self._azure_header) return response.json() # Device Messaging @@ -93,20 +103,41 @@ def send_device_message(self, device_id, message): path = "{0}/devices/{1}/messages/events?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) self._post(path, message) - # C2D: Cloud-to-Device + # TODO: Cloud-to-Device Communication + + # Device Twin Service + def get_device_twin(self, device_id): + """Returns a device twin + :param str device_id: Device Identifier. + """ + path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + return self._get(path) + + def update_device_twin(self, device_id, properties): + """Updates tags and desired properties of a device twin. + :param str device_id: Device Identifier. + :param str properties: Device Twin Properties (see: https://docs.microsoft.com/en-us/rest/api/iothub/service/updatetwin#twinproperties) + """ + path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + return self._patch(path, properties) # IoT Hub Service def get_devices(self): """Retrieve devices from the identity registry of your IoT hub. """ path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZURE_API_VERSION) - self._get(path) + return self._get(path) def get_device(self, device_id): """Retrieves a device from the identity registry of an IoT hub. :param str device_id: Device Identifier. """ path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) - self._get(path) + return self._get(path) - # IoT Hub Resource Provider \ No newline at end of file + def delete_device(self, device_id): + """Deletes a specified device_id from the identity register of an IoT Hub. + :param str device_id: Device Identifier. + """ + path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + self._delete(path) \ No newline at end of file From ee95fbb469f1bc2c94f239acf64d815884e0dfdb Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 10 May 2019 17:26:14 -0400 Subject: [PATCH 04/30] add http status parsing based on common azure error codes, add replace device twin, add put http method --- adafruit_azureiot.py | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 1ff3d05..ea924e2 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -66,24 +66,35 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token): self._sas_token = sas_token self._azure_header = {"Authorization":self._sas_token} + def _parse_http_status(self, error_code, reason): + """Parses HTTP Status, throws error based on Azure IoT Common Error Codes. + """ + error_codes = [400, 401, 404, 403, 412, 429, 500] + for error in error_codes: + if error == error_code: + raise TypeError("Error {0}: {1}".format(error_code, reason)) + # HTTP Request Methods def _post(self, path, payload): response = self._wifi.post( path, json=payload, headers = self._azure_header) - #return response.json() + self._parse_http_status(response.error_code, response.reason) + return response.json() def _get(self, path): response = self._wifi.get( path, headers = self._azure_header) + self._parse_http_status(response.error_code, response.reason) return response.json() def _delete(self, path): response = self._wifi.delete( path, headers = self._azure_header) + self._parse_http_status(response.error_code, response.reason) return response.json() def _patch(self, path, payload): @@ -91,8 +102,18 @@ def _patch(self, path, payload): path, json = payload, headers = self._azure_header) + self._parse_http_status(response.error_code, response.reason) + return response.json() + + def _put(self, path, payload): + response = self._wifi.put( + path, + json = payload, + headers = self._azure_header) + self._parse_http_status(response.error_code, response.reason) return response.json() + # Device Messaging # D2C: Device-to-Cloud def send_device_message(self, device_id, message): @@ -105,7 +126,7 @@ def send_device_message(self, device_id, message): # TODO: Cloud-to-Device Communication - # Device Twin Service + # Device Twin def get_device_twin(self, device_id): """Returns a device twin :param str device_id: Device Identifier. @@ -121,6 +142,12 @@ def update_device_twin(self, device_id, properties): path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) return self._patch(path, properties) + def replace_device_twin(self, device_id, properties): + """ + """ + path = "{0}/twins/{1}?api-version-{2}" + return self._put(self, device_id, properties) + # IoT Hub Service def get_devices(self): """Retrieve devices from the identity registry of your IoT hub. From a1c8fa8c15997c2a1cbdc57e89edd6ea63e4f9d0 Mon Sep 17 00:00:00 2001 From: brentru Date: Mon, 20 May 2019 13:10:02 -0400 Subject: [PATCH 05/30] make wifi_type private, better status parsing --- adafruit_azureiot.py | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index ea924e2..25acad4 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -23,8 +23,7 @@ `Adafruit_AzureIoT` ================================================================================ -Access to Microsoft Azure IoT from CircuitPython - +Microsoft Azure IoT for CircuitPython * Author(s): Brent Rubell @@ -44,6 +43,7 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AzureIoT.git" AZURE_API_VERSION = "2018-06-30" # Azure URI API Version Identifier +AZURE_ERROR_CODES = [400, 401, 404, 403, 412, 429, 500] class iot_hub: """ @@ -57,8 +57,8 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token): :param str sas_token: SAS Token Identifier. (https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-security) """ - wifi_type = str(type(wifi_manager)) - if 'ESPSPI_WiFiManager' in wifi_type: + _wifi_type = str(type(wifi_manager)) + if 'ESPSPI_WiFiManager' in _wifi_type: self._wifi = wifi_manager else: raise TypeError("This library requires a WiFiManager object.") @@ -66,13 +66,15 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token): self._sas_token = sas_token self._azure_header = {"Authorization":self._sas_token} - def _parse_http_status(self, error_code, reason): + def _parse_http_status(self, status_code, status_reason): """Parses HTTP Status, throws error based on Azure IoT Common Error Codes. + :param int status_code: HTTP status code. + :param str status_reason: Description of HTTP status. """ - error_codes = [400, 401, 404, 403, 412, 429, 500] - for error in error_codes: - if error == error_code: - raise TypeError("Error {0}: {1}".format(error_code, reason)) + for error in AZURE_ERROR_CODES: + if error == status_code: + raise TypeError("Error {0}: {1}".format(status_code, status_reason)) + # HTTP Request Methods def _post(self, path, payload): @@ -80,21 +82,21 @@ def _post(self, path, payload): path, json=payload, headers = self._azure_header) - self._parse_http_status(response.error_code, response.reason) + self._parse_http_status(response.status_code, response.reason) return response.json() def _get(self, path): response = self._wifi.get( path, headers = self._azure_header) - self._parse_http_status(response.error_code, response.reason) + self._parse_http_status(response.status_code, response.reason) return response.json() def _delete(self, path): response = self._wifi.delete( path, headers = self._azure_header) - self._parse_http_status(response.error_code, response.reason) + self._parse_http_status(response.status_code, response.reason) return response.json() def _patch(self, path, payload): @@ -102,7 +104,7 @@ def _patch(self, path, payload): path, json = payload, headers = self._azure_header) - self._parse_http_status(response.error_code, response.reason) + self._parse_http_status(response.status_code, response.reason) return response.json() def _put(self, path, payload): @@ -110,10 +112,9 @@ def _put(self, path, payload): path, json = payload, headers = self._azure_header) - self._parse_http_status(response.error_code, response.reason) + self._parse_http_status(response.status_code, response.reason) return response.json() - # Device Messaging # D2C: Device-to-Cloud def send_device_message(self, device_id, message): @@ -148,6 +149,7 @@ def replace_device_twin(self, device_id, properties): path = "{0}/twins/{1}?api-version-{2}" return self._put(self, device_id, properties) + # IoT Hub Service def get_devices(self): """Retrieve devices from the identity registry of your IoT hub. From 4a361f15454e74f794eee8d25ab57fab010aefab Mon Sep 17 00:00:00 2001 From: brentru Date: Mon, 20 May 2019 13:22:50 -0400 Subject: [PATCH 06/30] pylinted! --- adafruit_azureiot.py | 66 +++++++++++++++++++++++--------------------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 25acad4..4f0c7d7 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -42,20 +42,19 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AzureIoT.git" -AZURE_API_VERSION = "2018-06-30" # Azure URI API Version Identifier -AZURE_ERROR_CODES = [400, 401, 404, 403, 412, 429, 500] +AZURE_API_VER = "2018-06-30" # Azure URI API Version Identifier +AZURE_HTTP_ERROR_CODES = [400, 401, 404, 403, 412, 429, 500] # Azure HTTP Status Codes -class iot_hub: +class IOT_HUB: """ - Provides access to an Azure IoT Hub. + Provides access to a Microsoft Azure IoT Hub. https://docs.microsoft.com/en-us/rest/api/iothub/ """ def __init__(self, wifi_manager, iot_hub_name, sas_token): """ Creates an instance of an Azure IoT Hub Client. :param wifi_manager: WiFiManager object from ESPSPI_WiFiManager. :param str iot_hub_name: Name of your IoT Hub. - :param str sas_token: SAS Token Identifier. - (https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-security) + :param str sas_token: Azure IoT Hub SAS Token Identifier. """ _wifi_type = str(type(wifi_manager)) if 'ESPSPI_WiFiManager' in _wifi_type: @@ -66,63 +65,64 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token): self._sas_token = sas_token self._azure_header = {"Authorization":self._sas_token} - def _parse_http_status(self, status_code, status_reason): + @staticmethod + def _parse_http_status(status_code, status_reason): """Parses HTTP Status, throws error based on Azure IoT Common Error Codes. :param int status_code: HTTP status code. :param str status_reason: Description of HTTP status. """ - for error in AZURE_ERROR_CODES: + for error in AZURE_HTTP_ERROR_CODES: if error == status_code: raise TypeError("Error {0}: {1}".format(status_code, status_reason)) - # HTTP Request Methods def _post(self, path, payload): response = self._wifi.post( path, json=payload, - headers = self._azure_header) + headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) return response.json() def _get(self, path): response = self._wifi.get( path, - headers = self._azure_header) + headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) return response.json() - + def _delete(self, path): response = self._wifi.delete( path, - headers = self._azure_header) + headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) return response.json() - + def _patch(self, path, payload): response = self._wifi.patch( path, - json = payload, - headers = self._azure_header) + json=payload, + headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) return response.json() def _put(self, path, payload): response = self._wifi.put( path, - json = payload, - headers = self._azure_header) + json=payload, + headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) return response.json() - # Device Messaging + # Device Messaging # D2C: Device-to-Cloud def send_device_message(self, device_id, message): """Sends a device-to-cloud message. :param string device_id: Device Identifier. :param string message: Message. """ - path = "{0}/devices/{1}/messages/events?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + path = "{0}/devices/{1}/messages/events?api-version={2}".format(self._iot_hub_url, + device_id, AZURE_API_VER) self._post(path, message) # TODO: Cloud-to-Device Communication @@ -132,41 +132,43 @@ def get_device_twin(self, device_id): """Returns a device twin :param str device_id: Device Identifier. """ - path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) return self._get(path) - + def update_device_twin(self, device_id, properties): """Updates tags and desired properties of a device twin. :param str device_id: Device Identifier. - :param str properties: Device Twin Properties (see: https://docs.microsoft.com/en-us/rest/api/iothub/service/updatetwin#twinproperties) + :param str properties: Device Twin Properties + (https://docs.microsoft.com/en-us/rest/api/iothub/service/updatetwin#twinproperties) """ - path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) return self._patch(path, properties) def replace_device_twin(self, device_id, properties): + """Replaces tags and desired properties of a device twin. + :param str device_id: Device Identifier. + :param str properties: Device Twin Properties. """ - """ - path = "{0}/twins/{1}?api-version-{2}" - return self._put(self, device_id, properties) - + path = "{0}/twins/{1}?api-version-{2}".format(self._iot_hub_url, device_id, AZURE_API_VER) + return self._put(path, properties) # IoT Hub Service def get_devices(self): """Retrieve devices from the identity registry of your IoT hub. """ - path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZURE_API_VERSION) + path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZURE_API_VER) return self._get(path) def get_device(self, device_id): """Retrieves a device from the identity registry of an IoT hub. :param str device_id: Device Identifier. """ - path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) + path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) return self._get(path) def delete_device(self, device_id): """Deletes a specified device_id from the identity register of an IoT Hub. :param str device_id: Device Identifier. """ - path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VERSION) - self._delete(path) \ No newline at end of file + path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) + self._delete(path) From 7bafda54dff47df8eabdfffc63d6b51b3f0eedbe Mon Sep 17 00:00:00 2001 From: brentru Date: Mon, 20 May 2019 15:49:44 -0400 Subject: [PATCH 07/30] adding in c2d messaging --- README.rst | 65 ++++++++++++++++++++++++++++---------------- adafruit_azureiot.py | 1 - 2 files changed, 41 insertions(+), 25 deletions(-) diff --git a/README.rst b/README.rst index a31e03a..f796483 100644 --- a/README.rst +++ b/README.rst @@ -13,8 +13,7 @@ Introduction :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_AzureIoT :alt: Build Status -Access to Microsoft Azure IoT from CircuitPython - +Access to Microsoft Azure IoT from a CircuitPython device. Dependencies ============= @@ -26,38 +25,56 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. -Installing from PyPI --------------------- -.. note:: This library is not available on PyPI yet. Install documentation is included - as a standard element. Stay tuned for PyPI availability! -.. todo:: Remove the above note if PyPI version is/will be available at time of release. - If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. -On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from -PyPI `_. To install for current user: +Usage Example +============= -.. code-block:: shell +Create an instance of an Azure IoT Hub: - pip3 install adafruit-circuitpython-azureiot +.. code-block:: python -To install system-wide (this may be required in some cases): + my_hub = IOT_HUB(wifi, 'Azure_IOT_Hub_Name', 'Azure_IOT_Hub_SAS_Token') -.. code-block:: shell +Send a device-to-cloud message: - sudo pip3 install adafruit-circuitpython-azureiot +.. code-block:: python -To install in a virtual environment in your current project: + my_hub.send_device_message('deviceID', 'Hi Azure IoT!') -.. code-block:: shell +Enumerate all devices on an Azure IOT Hub: - mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate - pip3 install adafruit-circuitpython-azureiot +.. code-block:: python -Usage Example -============= + hub_devices = my_hub.get_devices() + +Get a specified device on an Azure IoT Hub: + +.. code-block:: python + + device_info = my_hub.get_device('deviceID') + +Create a new device on an Azure IoT Hub: + +.. code-block:: python + + my_hub.create_device('deviceID') + +Delete a device from an Azure IoT Hub: + +.. code-block:: python + + my_hub.delete_device('deviceID') + +Get a device twin: + +.. code-block:: python + + twin_info = my_hub.get_device_twin('deviceID') + +Update a device twin's properties: + +.. code-block:: python -.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst. + my_hub.update_device_twin('Blinka', device_properties) Contributing ============ diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 4f0c7d7..1c9e8a7 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -82,7 +82,6 @@ def _post(self, path, payload): json=payload, headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) - return response.json() def _get(self, path): response = self._wifi.get( From 0c36033047958cc1eeb72786edbd26435c57df9f Mon Sep 17 00:00:00 2001 From: brentru Date: Mon, 20 May 2019 17:28:22 -0400 Subject: [PATCH 08/30] working on get_hub_message, d2c is funky --- adafruit_azureiot.py | 135 +++++++++++++++++++++++++++++-------------- 1 file changed, 91 insertions(+), 44 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 1c9e8a7..fc659e7 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -67,7 +67,7 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token): @staticmethod def _parse_http_status(status_code, status_reason): - """Parses HTTP Status, throws error based on Azure IoT Common Error Codes. + """Parses status code, throws error based on Azure IoT Common Error Codes. :param int status_code: HTTP status code. :param str status_reason: Description of HTTP status. """ @@ -75,46 +75,26 @@ def _parse_http_status(status_code, status_reason): if error == status_code: raise TypeError("Error {0}: {1}".format(status_code, status_reason)) - # HTTP Request Methods - def _post(self, path, payload): - response = self._wifi.post( - path, - json=payload, - headers=self._azure_header) - self._parse_http_status(response.status_code, response.reason) - - def _get(self, path): - response = self._wifi.get( - path, - headers=self._azure_header) - self._parse_http_status(response.status_code, response.reason) - return response.json() - - def _delete(self, path): - response = self._wifi.delete( - path, - headers=self._azure_header) - self._parse_http_status(response.status_code, response.reason) - return response.json() - - def _patch(self, path, payload): - response = self._wifi.patch( - path, - json=payload, - headers=self._azure_header) - self._parse_http_status(response.status_code, response.reason) - return response.json() - - def _put(self, path, payload): - response = self._wifi.put( - path, - json=payload, - headers=self._azure_header) - self._parse_http_status(response.status_code, response.reason) - return response.json() + def get_hub_message(self, device_id): + """Gets a message from a Microsoft Azure IoT Hub (Cloud-to-Device). + NOTE: HTTP Cloud-to-Device messages are throttled. Poll every 25 minutes, or more. + :param int device_id: Device identifier. + """ + # GET device-bound notification + path = "{0}/devices/{1}/messages/deviceBound?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) + data = self._get(path, is_c2d = True) + # check for etag in header + print(data) + etag = data[1]['etag'] + if etag is not None: + print('etag: ', etag) + # DELETE https://fully-qualified-iothubname.azure-devices.net/devices/{id}/messages/deviceBound/{etag}?api-version=2018-06-30 + path_complete = "https://{0}.azure-devices.net/devices/{1}/messages/deviceBound/{2}?api-version=2018-06-30".format(self._iot_hub_url, device_id, etag) + print(path_complete) + self._delete(path_complete) + print('deleted!') # Device Messaging - # D2C: Device-to-Cloud def send_device_message(self, device_id, message): """Sends a device-to-cloud message. :param string device_id: Device Identifier. @@ -124,8 +104,6 @@ def send_device_message(self, device_id, message): device_id, AZURE_API_VER) self._post(path, message) - # TODO: Cloud-to-Device Communication - # Device Twin def get_device_twin(self, device_id): """Returns a device twin @@ -153,21 +131,90 @@ def replace_device_twin(self, device_id, properties): # IoT Hub Service def get_devices(self): - """Retrieve devices from the identity registry of your IoT hub. + """Enumerate devices from the identity registry of your IoT hub. """ path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZURE_API_VER) return self._get(path) def get_device(self, device_id): - """Retrieves a device from the identity registry of an IoT hub. + """Gets device information from the identity registry of an IoT hub. :param str device_id: Device Identifier. """ path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) return self._get(path) def delete_device(self, device_id): - """Deletes a specified device_id from the identity register of an IoT Hub. + """Deletes a specified device from the identity register of an IoT Hub. :param str device_id: Device Identifier. """ path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) self._delete(path) + + # HTTP Helper Methods + def _post(self, path, payload): + """HTTP POST + :param str path: Formatted Azure IOT Hub Path. + :param str payload: JSON-formatted Data Payload. + """ + response = self._wifi.post( + path, + json=payload, + headers=self._azure_header) + self._parse_http_status(response.status_code, response.reason) + return response.json() + response.close() + + def _get(self, path, is_c2d=False): + """HTTP GET + :param str path: Formatted Azure IOT Hub Path. + :param bool is_c2d: Cloud-to-device message request. + """ + response = self._wifi.get( + path, + headers=self._azure_header) + if is_c2d: + if response.status_code == 200: + return response.text, response.headers + raise TypeError('No data within message queue') + self._parse_http_status(response.status_code, response.reason) + return response.json() + response.close() + + def _delete(self, path): + """HTTP DELETE + :param str path: Formatted Azure IOT Hub Path. + """ + response = self._wifi.delete( + path, + headers=self._azure_header) + print(response.status_code, response.reason) + self._parse_http_status(response.status_code, response.reason) + return response.json() + response.close() + + def _patch(self, path, payload): + """HTTP PATCH + :param str path: Formatted Azure IOT Hub Path. + :param str payload: JSON-formatted payload. + """ + response = self._wifi.patch( + path, + json=payload, + headers=self._azure_header) + self._parse_http_status(response.status_code, response.reason) + return response.json() + response.close() + + def _put(self, path, payload=None): + """HTTP PUT + :param str path: Formatted Azure IOT Hub Path. + :param str payload: JSON-formatted payload. + """ + response = self._wifi.put( + path, + json=payload, + headers=self._azure_header) + self._parse_http_status(response.status_code, response.reason) + print('Resp:', response.status_code, response.reason) + return response.json() + response.close() \ No newline at end of file From ab2755290119136166ded13d1c32fdb9d115b12e Mon Sep 17 00:00:00 2001 From: brentru Date: Mon, 20 May 2019 17:50:24 -0400 Subject: [PATCH 09/30] pylint a bit --- adafruit_azureiot.py | 61 ++++++++++++++++++++++---------------------- 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index fc659e7..da7b8d1 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -42,7 +42,7 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AzureIoT.git" -AZURE_API_VER = "2018-06-30" # Azure URI API Version Identifier +AZ_API_VER = "2018-06-30" # Azure URI API Version Identifier AZURE_HTTP_ERROR_CODES = [400, 401, 404, 403, 412, 429, 500] # Azure HTTP Status Codes class IOT_HUB: @@ -76,23 +76,29 @@ def _parse_http_status(status_code, status_reason): raise TypeError("Error {0}: {1}".format(status_code, status_reason)) def get_hub_message(self, device_id): - """Gets a message from a Microsoft Azure IoT Hub (Cloud-to-Device). - NOTE: HTTP Cloud-to-Device messages are throttled. Poll every 25 minutes, or more. - :param int device_id: Device identifier. - """ - # GET device-bound notification - path = "{0}/devices/{1}/messages/deviceBound?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) - data = self._get(path, is_c2d = True) - # check for etag in header - print(data) - etag = data[1]['etag'] - if etag is not None: - print('etag: ', etag) - # DELETE https://fully-qualified-iothubname.azure-devices.net/devices/{id}/messages/deviceBound/{etag}?api-version=2018-06-30 - path_complete = "https://{0}.azure-devices.net/devices/{1}/messages/deviceBound/{2}?api-version=2018-06-30".format(self._iot_hub_url, device_id, etag) - print(path_complete) - self._delete(path_complete) - print('deleted!') + """Gets a message from a Microsoft Azure IoT Hub (Cloud-to-Device). + NOTE: HTTP Cloud-to-Device messages are throttled. Poll every 25 minutes, or more. + :param int device_id: Device identifier. + """ + # GET device-bound notification + path = "{0}/devices/{1}/messages/deviceBound?api-version={2}".format(self._iot_hub_url, + device_id, AZ_API_VER) + data = self._get(path, is_c2d=True) + reject_message = True + # check for etag in header + print(data) + etag = data[1]['etag'] + if etag: # either complete or nack the message + reject_message = False + etag = etag.strip('\'"') + path_complete = "https://{0}.azure-devices.net/devices/{1}/messages/ \ + deviceBound/{2}?api-version={3}".format(self._iot_hub_url, + device_id, etag, AZ_API_VER) + print(path_complete) + if reject_message: + path_complete += '&reject' + self._delete(path_complete) + print('deleted!') # Device Messaging def send_device_message(self, device_id, message): @@ -101,7 +107,7 @@ def send_device_message(self, device_id, message): :param string message: Message. """ path = "{0}/devices/{1}/messages/events?api-version={2}".format(self._iot_hub_url, - device_id, AZURE_API_VER) + device_id, AZ_API_VER) self._post(path, message) # Device Twin @@ -109,7 +115,7 @@ def get_device_twin(self, device_id): """Returns a device twin :param str device_id: Device Identifier. """ - path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) + path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) return self._get(path) def update_device_twin(self, device_id, properties): @@ -118,7 +124,7 @@ def update_device_twin(self, device_id, properties): :param str properties: Device Twin Properties (https://docs.microsoft.com/en-us/rest/api/iothub/service/updatetwin#twinproperties) """ - path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) + path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) return self._patch(path, properties) def replace_device_twin(self, device_id, properties): @@ -126,28 +132,28 @@ def replace_device_twin(self, device_id, properties): :param str device_id: Device Identifier. :param str properties: Device Twin Properties. """ - path = "{0}/twins/{1}?api-version-{2}".format(self._iot_hub_url, device_id, AZURE_API_VER) + path = "{0}/twins/{1}?api-version-{2}".format(self._iot_hub_url, device_id, AZ_API_VER) return self._put(path, properties) # IoT Hub Service def get_devices(self): """Enumerate devices from the identity registry of your IoT hub. """ - path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZURE_API_VER) + path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZ_API_VER) return self._get(path) def get_device(self, device_id): """Gets device information from the identity registry of an IoT hub. :param str device_id: Device Identifier. """ - path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) + path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) return self._get(path) def delete_device(self, device_id): """Deletes a specified device from the identity register of an IoT Hub. :param str device_id: Device Identifier. """ - path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZURE_API_VER) + path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) self._delete(path) # HTTP Helper Methods @@ -162,7 +168,6 @@ def _post(self, path, payload): headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) return response.json() - response.close() def _get(self, path, is_c2d=False): """HTTP GET @@ -178,7 +183,6 @@ def _get(self, path, is_c2d=False): raise TypeError('No data within message queue') self._parse_http_status(response.status_code, response.reason) return response.json() - response.close() def _delete(self, path): """HTTP DELETE @@ -190,7 +194,6 @@ def _delete(self, path): print(response.status_code, response.reason) self._parse_http_status(response.status_code, response.reason) return response.json() - response.close() def _patch(self, path, payload): """HTTP PATCH @@ -203,7 +206,6 @@ def _patch(self, path, payload): headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) return response.json() - response.close() def _put(self, path, payload=None): """HTTP PUT @@ -217,4 +219,3 @@ def _put(self, path, payload=None): self._parse_http_status(response.status_code, response.reason) print('Resp:', response.status_code, response.reason) return response.json() - response.close() \ No newline at end of file From c677f4f3df8ad09779237dabd64a671d057a022c Mon Sep 17 00:00:00 2001 From: brentru Date: Mon, 20 May 2019 17:53:00 -0400 Subject: [PATCH 10/30] fix url string... --- adafruit_azureiot.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index da7b8d1..50048ef 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -91,9 +91,7 @@ def get_hub_message(self, device_id): if etag: # either complete or nack the message reject_message = False etag = etag.strip('\'"') - path_complete = "https://{0}.azure-devices.net/devices/{1}/messages/ \ - deviceBound/{2}?api-version={3}".format(self._iot_hub_url, - device_id, etag, AZ_API_VER) + path_complete = "{0}.azure-devices.net/devices/{1}/messages/deviceBound/{2}?api-version={3}".format(self._iot_hub_url, device_id, etag, AZ_API_VER) print(path_complete) if reject_message: path_complete += '&reject' From d57aa03b728db4956c1fc644b2d8dbde2bc61efc Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 11:12:36 -0400 Subject: [PATCH 11/30] message-queue handling to c2d, add optional return_response kwarg to _post for sending device messages --- adafruit_azureiot.py | 42 +++++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 17 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 50048ef..ced6ce8 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -76,27 +76,30 @@ def _parse_http_status(status_code, status_reason): raise TypeError("Error {0}: {1}".format(status_code, status_reason)) def get_hub_message(self, device_id): - """Gets a message from a Microsoft Azure IoT Hub (Cloud-to-Device). + """Returns a message from a Microsoft Azure IoT Hub (Cloud-to-Device), or -1 if the message queue is empty. NOTE: HTTP Cloud-to-Device messages are throttled. Poll every 25 minutes, or more. :param int device_id: Device identifier. """ - # GET device-bound notification + reject_message = True + # get a device-bound notification path = "{0}/devices/{1}/messages/deviceBound?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) data = self._get(path, is_c2d=True) - reject_message = True - # check for etag in header - print(data) + if data == 204: # device's message queue is empty + return -1 etag = data[1]['etag'] if etag: # either complete or nack the message reject_message = False + # prepare the device-bound completion URL etag = etag.strip('\'"') - path_complete = "{0}.azure-devices.net/devices/{1}/messages/deviceBound/{2}?api-version={3}".format(self._iot_hub_url, device_id, etag, AZ_API_VER) - print(path_complete) + path_complete = "{0}/devices/{1}/messages/deviceBound/{2}?api-version={3}".format(self._iot_hub_url, device_id, etag, AZ_API_VER) if reject_message: path_complete += '&reject' - self._delete(path_complete) - print('deleted!') + del_status = self._delete(path_complete, is_c2d=True) + if del_status == 204: + return data[0] + return -1 + # Device Messaging def send_device_message(self, device_id, message): @@ -106,7 +109,7 @@ def send_device_message(self, device_id, message): """ path = "{0}/devices/{1}/messages/events?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) - self._post(path, message) + self._post(path, message, return_response=False) # Device Twin def get_device_twin(self, device_id): @@ -155,7 +158,7 @@ def delete_device(self, device_id): self._delete(path) # HTTP Helper Methods - def _post(self, path, payload): + def _post(self, path, payload, return_response=True): """HTTP POST :param str path: Formatted Azure IOT Hub Path. :param str payload: JSON-formatted Data Payload. @@ -165,32 +168,37 @@ def _post(self, path, payload): json=payload, headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) - return response.json() + if return_response: + return response.json() + response.close() def _get(self, path, is_c2d=False): """HTTP GET :param str path: Formatted Azure IOT Hub Path. - :param bool is_c2d: Cloud-to-device message request. + :param bool is_c2d: Cloud-to-device get request. """ + print(path) response = self._wifi.get( path, headers=self._azure_header) - if is_c2d: + if is_c2d: # check status of azure message queue if response.status_code == 200: return response.text, response.headers - raise TypeError('No data within message queue') + return response.status_code self._parse_http_status(response.status_code, response.reason) return response.json() - def _delete(self, path): + def _delete(self, path, is_c2d=False): """HTTP DELETE :param str path: Formatted Azure IOT Hub Path. + :param bool is_c2d: Cloud-to-device delete request. """ response = self._wifi.delete( path, headers=self._azure_header) - print(response.status_code, response.reason) self._parse_http_status(response.status_code, response.reason) + if is_c2d: # check server response for complete message request + return response.status_code return response.json() def _patch(self, path, payload): From c7d73609ddf1c84def2d470b2644807f0a66ed55 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 12:11:55 -0400 Subject: [PATCH 12/30] remove prints --- README.rst | 3 ++- adafruit_azureiot.py | 3 --- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index f796483..04b7774 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,8 @@ Introduction :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_AzureIoT :alt: Build Status -Access to Microsoft Azure IoT from a CircuitPython device. +Access to Microsoft Azure IoT from a CircuitPython device. This library can perform device +messaging services (cloud-to-device, device-to-cloud), device services, and job services. Dependencies ============= diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index ced6ce8..cf9f123 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -99,7 +99,6 @@ def get_hub_message(self, device_id): if del_status == 204: return data[0] return -1 - # Device Messaging def send_device_message(self, device_id, message): @@ -177,7 +176,6 @@ def _get(self, path, is_c2d=False): :param str path: Formatted Azure IOT Hub Path. :param bool is_c2d: Cloud-to-device get request. """ - print(path) response = self._wifi.get( path, headers=self._azure_header) @@ -223,5 +221,4 @@ def _put(self, path, payload=None): json=payload, headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) - print('Resp:', response.status_code, response.reason) return response.json() From 484158b77187882e175426cb4c5986ad152425cf Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 12:15:33 -0400 Subject: [PATCH 13/30] pylint! --- adafruit_azureiot.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index cf9f123..01d2337 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -76,7 +76,8 @@ def _parse_http_status(status_code, status_reason): raise TypeError("Error {0}: {1}".format(status_code, status_reason)) def get_hub_message(self, device_id): - """Returns a message from a Microsoft Azure IoT Hub (Cloud-to-Device), or -1 if the message queue is empty. + """Returns a message from a Microsoft Azure IoT Hub (Cloud-to-Device), or -1 + if the message queue is empty. NOTE: HTTP Cloud-to-Device messages are throttled. Poll every 25 minutes, or more. :param int device_id: Device identifier. """ @@ -92,13 +93,14 @@ def get_hub_message(self, device_id): reject_message = False # prepare the device-bound completion URL etag = etag.strip('\'"') - path_complete = "{0}/devices/{1}/messages/deviceBound/{2}?api-version={3}".format(self._iot_hub_url, device_id, etag, AZ_API_VER) + path_complete = "{0}/devices/{1}/messages/deviceBound/{2}?api-version={3}".format( + self._iot_hub_url, device_id, etag, AZ_API_VER) if reject_message: path_complete += '&reject' del_status = self._delete(path_complete, is_c2d=True) - if del_status == 204: - return data[0] - return -1 + if del_status == 204: + return data[0] + return -1 # Device Messaging def send_device_message(self, device_id, message): @@ -169,7 +171,7 @@ def _post(self, path, payload, return_response=True): self._parse_http_status(response.status_code, response.reason) if return_response: return response.json() - response.close() + return response.text def _get(self, path, is_c2d=False): """HTTP GET From 76c8273ce83ae8ec9b2062b14a964d2e08bbfa57 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 12:19:10 -0400 Subject: [PATCH 14/30] remove busdevice in favor of esp32spi --- requirements.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 7cd378a..bdc2de0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,2 @@ Adafruit-Blinka -adafruit-bus-device -adafruit-circuitpython-esp32spi \ No newline at end of file +Adafruit_CircuitPython_ESP32SPI \ No newline at end of file From 2bd864be118b9b723c9aa6cc08fcf1b576906f22 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 12:31:23 -0400 Subject: [PATCH 15/30] add simpletest for messaging --- adafruit_azureiot.py | 2 +- examples/azureiot_simpletest.py | 50 +++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 1 deletion(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 01d2337..6a5dbff 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -45,7 +45,7 @@ AZ_API_VER = "2018-06-30" # Azure URI API Version Identifier AZURE_HTTP_ERROR_CODES = [400, 401, 404, 403, 412, 429, 500] # Azure HTTP Status Codes -class IOT_HUB: +class IOT_Hub: """ Provides access to a Microsoft Azure IoT Hub. https://docs.microsoft.com/en-us/rest/api/iothub/ diff --git a/examples/azureiot_simpletest.py b/examples/azureiot_simpletest.py index e69de29..75231ed 100644 --- a/examples/azureiot_simpletest.py +++ b/examples/azureiot_simpletest.py @@ -0,0 +1,50 @@ +import microcontroller +import board +import busio +from digitalio import DigitalInOut +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager +import neopixel +from adafruit_azureiot import IOT_Hub + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# ESP32 Setup +try: + esp32_cs = DigitalInOut(board.ESP_CS) + esp32_ready = DigitalInOut(board.ESP_BUSY) + esp32_reset = DigitalInOut(board.ESP_RESET) +except AttributeError: + 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) +status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +"""Uncomment below for ItsyBitsy M4""" +#status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) + +# Create an instance of the Azure IoT Hub +hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas']) + +# Set a device id (This name must match a device connected to your Azure IoT Hub) +device_id = 'Blinka' + +# Send a Device-to-Cloud message +cpu_temp = microcontroller.cpu.temperature +print('Sending Temperature to Azure IoT Hub...') +hub.send_device_message(device_id, str(cpu_temp)) +print('Data Sent!') + +# Receive a Cloud-to-Device message +print('Receiving a message from an Azure IoT Hub...') +message = hub.get_hub_message(device_id) +if message == -1: + print('IoT Hub Message Queue is empty!') +else: + print(message) From 77489e40e0723c8513976cd191777a169c7b0edf Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 12:44:13 -0400 Subject: [PATCH 16/30] add example of fetching, modifying, and returning a device twin property --- examples/azureiot_devicetwin.py | 50 +++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 examples/azureiot_devicetwin.py diff --git a/examples/azureiot_devicetwin.py b/examples/azureiot_devicetwin.py new file mode 100644 index 0000000..d1d804c --- /dev/null +++ b/examples/azureiot_devicetwin.py @@ -0,0 +1,50 @@ +import board +import busio +from digitalio import DigitalInOut +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager +import neopixel +from adafruit_azureiot import IOT_Hub + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# ESP32 Setup +try: + esp32_cs = DigitalInOut(board.ESP_CS) + esp32_ready = DigitalInOut(board.ESP_BUSY) + esp32_reset = DigitalInOut(board.ESP_RESET) +except AttributeError: + 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) +status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +"""Uncomment below for ItsyBitsy M4""" +#status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) + +# Create an instance of the Azure IoT Hub +hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas']) + +# Set a device id (This name must match a device connected to your Azure IoT Hub) +device_id = 'Blinka' + +# Get a Device Twin +device_twin = hub.get_device_twin(device_id) +# Filter out the device's name from the twin's properties +device_name = device_twin['properties']['desired']['deviceName'] +print(device_name) + +# Update a Device Twin's Properties +data = {"properties":{"desired": {"deviceName": "{{BasementTemperatureLoggerFeather}}"}}} +hub.update_device_twin(device_id, data) + +# And read the updated device twin information +device_twin = hub.get_device_twin(device_id) +device_name = device_twin['properties']['desired']['deviceName'] +print(device_name) From 0c97a1d03704db024ca19a192b95590bd812bba7 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 13:27:56 -0400 Subject: [PATCH 17/30] fix delete_device, adding etag specifier to headers --- adafruit_azureiot.py | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 6a5dbff..7797875 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -97,7 +97,7 @@ def get_hub_message(self, device_id): self._iot_hub_url, device_id, etag, AZ_API_VER) if reject_message: path_complete += '&reject' - del_status = self._delete(path_complete, is_c2d=True) + del_status = self._delete(path_complete) if del_status == 204: return data[0] return -1 @@ -139,24 +139,25 @@ def replace_device_twin(self, device_id, properties): # IoT Hub Service def get_devices(self): - """Enumerate devices from the identity registry of your IoT hub. + """Enumerate devices from the identity registry of your IoT Hub. """ path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZ_API_VER) return self._get(path) def get_device(self, device_id): - """Gets device information from the identity registry of an IoT hub. + """Gets device information from the identity registry of an IoT Hub. :param str device_id: Device Identifier. """ path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) return self._get(path) - def delete_device(self, device_id): + def delete_device(self, device_id, device_etag): """Deletes a specified device from the identity register of an IoT Hub. :param str device_id: Device Identifier. + :param str device_etag: Device Identity Tag. """ path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) - self._delete(path) + self._delete(path, etag=device_etag) # HTTP Helper Methods def _post(self, path, payload, return_response=True): @@ -188,18 +189,19 @@ def _get(self, path, is_c2d=False): self._parse_http_status(response.status_code, response.reason) return response.json() - def _delete(self, path, is_c2d=False): + def _delete(self, path, etag=None): """HTTP DELETE :param str path: Formatted Azure IOT Hub Path. - :param bool is_c2d: Cloud-to-device delete request. """ + if etag: + data_headers = {"Authorization":self._sas_token, "If-Match":'"%s"'%etag} + else: + data_headers = self._azure_header response = self._wifi.delete( path, - headers=self._azure_header) + headers=data_headers) self._parse_http_status(response.status_code, response.reason) - if is_c2d: # check server response for complete message request - return response.status_code - return response.json() + return response.status_code def _patch(self, path, payload): """HTTP PATCH From 09e4f7800a78231e0a8b708da8a154b4d8cae8f9 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 13:29:10 -0400 Subject: [PATCH 18/30] add example of device management subset implementation --- examples/azureiot_device_management.py | 47 ++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 examples/azureiot_device_management.py diff --git a/examples/azureiot_device_management.py b/examples/azureiot_device_management.py new file mode 100644 index 0000000..c58f18f --- /dev/null +++ b/examples/azureiot_device_management.py @@ -0,0 +1,47 @@ +import board +import busio +from digitalio import DigitalInOut +from adafruit_esp32spi import adafruit_esp32spi, adafruit_esp32spi_wifimanager +import neopixel +from adafruit_azureiot import IOT_Hub + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# ESP32 Setup +try: + esp32_cs = DigitalInOut(board.ESP_CS) + esp32_ready = DigitalInOut(board.ESP_BUSY) + esp32_reset = DigitalInOut(board.ESP_RESET) +except AttributeError: + 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) +status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +"""Uncomment below for ItsyBitsy M4""" +#status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) + +# Create an instance of the Azure IoT Hub +hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas']) + +device_id = 'CircuitPython' + +# Enumerate all devices on an Azure IoT Hub +all_hub_devices = hub.get_devices() +print(all_hub_devices) + +# Get a specified device on an Azure IoT Hub +device_data = hub.get_device(device_id) +print(device_data) + +# Delete a device from an Azure IoT Hub +# NOTE: This operation requires a device's ETag +hub.delete_device(device_id, device_data['etag']) +print('Device deleted from IoT Hub!') From 9b3ea3e89cf773ee8c64f08e8b370fa302532998 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 13:46:49 -0400 Subject: [PATCH 19/30] fix for docstring --- adafruit_azureiot.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 7797875..2f6fb09 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -20,7 +20,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`Adafruit_AzureIoT` +`adafruit_azureiot` ================================================================================ Microsoft Azure IoT for CircuitPython From cb66cf0ee88231b07aabfdaba74256963ec83404 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 13:48:06 -0400 Subject: [PATCH 20/30] remove pypi deployment --- .travis.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.travis.yml b/.travis.yml index 2c7f46d..bc7f86b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -11,12 +11,6 @@ python: 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" From 9addd219093e05f2db562b00ad7599cac69b615f Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 13:50:20 -0400 Subject: [PATCH 21/30] links into readme --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 04b7774..3c472f6 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -Introduction +Adafruit_CircuitPython_AzureIoT ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-azureiot/badge/?version=latest @@ -13,7 +13,7 @@ Introduction :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_AzureIoT :alt: Build Status -Access to Microsoft Azure IoT from a CircuitPython device. This library can perform device +Access to `Microsoft Azure IoT `_ from a CircuitPython device. This library can perform device messaging services (cloud-to-device, device-to-cloud), device services, and job services. Dependencies @@ -29,7 +29,7 @@ This is easily achieved by downloading Usage Example ============= -Create an instance of an Azure IoT Hub: +Create an instance of an Azure IoT Hub (you'll need your SAS Token). .. code-block:: python From c8885f1e398864cc81a267869427fb19d6ab1eb2 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 13:54:50 -0400 Subject: [PATCH 22/30] swap cpu temp for random int --- examples/azureiot_simpletest.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/azureiot_simpletest.py b/examples/azureiot_simpletest.py index 75231ed..42d3ec8 100644 --- a/examples/azureiot_simpletest.py +++ b/examples/azureiot_simpletest.py @@ -1,4 +1,4 @@ -import microcontroller +from random import randint import board import busio from digitalio import DigitalInOut @@ -36,9 +36,9 @@ device_id = 'Blinka' # Send a Device-to-Cloud message -cpu_temp = microcontroller.cpu.temperature -print('Sending Temperature to Azure IoT Hub...') -hub.send_device_message(device_id, str(cpu_temp)) +print('Sending Data to Azure IoT Hub...') +data = randint(0, 100) +hub.send_device_message(device_id, str(data)) print('Data Sent!') # Receive a Cloud-to-Device message From b74a545fa0ab4ad60d8876bef2192076fab4988a Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 13:58:15 -0400 Subject: [PATCH 23/30] comments/cleanup --- adafruit_azureiot.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 2f6fb09..317916d 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -75,6 +75,7 @@ def _parse_http_status(status_code, status_reason): if error == status_code: raise TypeError("Error {0}: {1}".format(status_code, status_reason)) + # Cloud-to-Device Messaging def get_hub_message(self, device_id): """Returns a message from a Microsoft Azure IoT Hub (Cloud-to-Device), or -1 if the message queue is empty. @@ -91,10 +92,8 @@ def get_hub_message(self, device_id): etag = data[1]['etag'] if etag: # either complete or nack the message reject_message = False - # prepare the device-bound completion URL - etag = etag.strip('\'"') path_complete = "{0}/devices/{1}/messages/deviceBound/{2}?api-version={3}".format( - self._iot_hub_url, device_id, etag, AZ_API_VER) + self._iot_hub_url, device_id, etag.strip('\'"'), AZ_API_VER) if reject_message: path_complete += '&reject' del_status = self._delete(path_complete) @@ -102,7 +101,7 @@ def get_hub_message(self, device_id): return data[0] return -1 - # Device Messaging + # Device-to-Cloud Messaging def send_device_message(self, device_id, message): """Sends a device-to-cloud message. :param string device_id: Device Identifier. From 982fd58f483319e7f93ff9c8cda5a849a8a30228 Mon Sep 17 00:00:00 2001 From: brentru Date: Tue, 21 May 2019 13:59:05 -0400 Subject: [PATCH 24/30] fix underline on readme --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 3c472f6..1433f5f 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ Adafruit_CircuitPython_AzureIoT -============ +================================ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-azureiot/badge/?version=latest :target: https://circuitpython.readthedocs.io/projects/azureiot/en/latest/ From 012db477d86f1916075c666c3552fb0c7c0bae1b Mon Sep 17 00:00:00 2001 From: brentru Date: Wed, 22 May 2019 12:50:17 -0400 Subject: [PATCH 25/30] raise error for subsequent c2d requests --- adafruit_azureiot.py | 7 +++++-- examples/azureiot_simpletest.py | 2 ++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 317916d..546a5a3 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -79,14 +79,17 @@ def _parse_http_status(status_code, status_reason): def get_hub_message(self, device_id): """Returns a message from a Microsoft Azure IoT Hub (Cloud-to-Device), or -1 if the message queue is empty. - NOTE: HTTP Cloud-to-Device messages are throttled. Poll every 25 minutes, or more. + NOTE: HTTP Cloud-to-Device messages are throttled. Poll every 25+ minutes. :param int device_id: Device identifier. """ reject_message = True # get a device-bound notification path = "{0}/devices/{1}/messages/deviceBound?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) - data = self._get(path, is_c2d=True) + try: + data = self._get(path, is_c2d=True) + except RuntimeError: + raise RuntimeError('HTTP C2D Messages are HEAVILY throttled, poll every 25 min.') if data == 204: # device's message queue is empty return -1 etag = data[1]['etag'] diff --git a/examples/azureiot_simpletest.py b/examples/azureiot_simpletest.py index 42d3ec8..8976577 100644 --- a/examples/azureiot_simpletest.py +++ b/examples/azureiot_simpletest.py @@ -42,6 +42,8 @@ print('Data Sent!') # Receive a Cloud-to-Device message +# NOTE: HTTP Cloud-to-Device messages are HEAVILY throttled over HTTP. +# Microsoft suggests a polling interval of the below code for every 25 minutes. print('Receiving a message from an Azure IoT Hub...') message = hub.get_hub_message(device_id) if message == -1: From d169190ce9c2b240e9edd84d2b2fb38b17e20a16 Mon Sep 17 00:00:00 2001 From: brentru Date: Wed, 22 May 2019 16:49:42 -0400 Subject: [PATCH 26/30] refactor: device_id in init, move new self._device_id into all calls, remove device_id from functions, pylint --- adafruit_azureiot.py | 62 ++++++++++++++++++++------------------------ 1 file changed, 28 insertions(+), 34 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 546a5a3..987629e 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -50,11 +50,12 @@ class IOT_Hub: Provides access to a Microsoft Azure IoT Hub. https://docs.microsoft.com/en-us/rest/api/iothub/ """ - def __init__(self, wifi_manager, iot_hub_name, sas_token): + def __init__(self, wifi_manager, iot_hub_name, sas_token, device_id): """ Creates an instance of an Azure IoT Hub Client. :param wifi_manager: WiFiManager object from ESPSPI_WiFiManager. :param str iot_hub_name: Name of your IoT Hub. :param str sas_token: Azure IoT Hub SAS Token Identifier. + :param str device_id: Unique Azure IoT Device Identifier. """ _wifi_type = str(type(wifi_manager)) if 'ESPSPI_WiFiManager' in _wifi_type: @@ -63,6 +64,7 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token): raise TypeError("This library requires a WiFiManager object.") self._iot_hub_url = "https://{0}.azure-devices.net".format(iot_hub_name) self._sas_token = sas_token + self._device_id = device_id self._azure_header = {"Authorization":self._sas_token} @staticmethod @@ -76,27 +78,27 @@ def _parse_http_status(status_code, status_reason): raise TypeError("Error {0}: {1}".format(status_code, status_reason)) # Cloud-to-Device Messaging - def get_hub_message(self, device_id): + def get_hub_message(self): """Returns a message from a Microsoft Azure IoT Hub (Cloud-to-Device), or -1 if the message queue is empty. NOTE: HTTP Cloud-to-Device messages are throttled. Poll every 25+ minutes. - :param int device_id: Device identifier. """ reject_message = True # get a device-bound notification path = "{0}/devices/{1}/messages/deviceBound?api-version={2}".format(self._iot_hub_url, - device_id, AZ_API_VER) + self._device_id, + AZ_API_VER) try: data = self._get(path, is_c2d=True) except RuntimeError: - raise RuntimeError('HTTP C2D Messages are HEAVILY throttled, poll every 25 min.') + raise RuntimeError('HTTP C2D messages are HEAVILY throttled - poll every 25 mins.') if data == 204: # device's message queue is empty return -1 etag = data[1]['etag'] if etag: # either complete or nack the message reject_message = False path_complete = "{0}/devices/{1}/messages/deviceBound/{2}?api-version={3}".format( - self._iot_hub_url, device_id, etag.strip('\'"'), AZ_API_VER) + self._iot_hub_url, self._device_id, etag.strip('\'"'), AZ_API_VER) if reject_message: path_complete += '&reject' del_status = self._delete(path_complete) @@ -105,62 +107,54 @@ def get_hub_message(self, device_id): return -1 # Device-to-Cloud Messaging - def send_device_message(self, device_id, message): + def send_device_message(self, message): """Sends a device-to-cloud message. - :param string device_id: Device Identifier. - :param string message: Message. + :param string message: Message to send to Azure IoT. """ path = "{0}/devices/{1}/messages/events?api-version={2}".format(self._iot_hub_url, - device_id, AZ_API_VER) + self._device_id, AZ_API_VER) self._post(path, message, return_response=False) # Device Twin - def get_device_twin(self, device_id): - """Returns a device twin - :param str device_id: Device Identifier. + def get_device_twin(self): + """Returns the device's device twin information in JSON format. """ - path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) + path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, + self._device_id, AZ_API_VER) return self._get(path) - def update_device_twin(self, device_id, properties): - """Updates tags and desired properties of a device twin. - :param str device_id: Device Identifier. + def update_device_twin(self, properties): + """Updates tags and desired properties of the device's device twin. :param str properties: Device Twin Properties (https://docs.microsoft.com/en-us/rest/api/iothub/service/updatetwin#twinproperties) """ - path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) + path = "{0}/twins/{1}?api-version={2}".format(self._iot_hub_url, + self._device_id, AZ_API_VER) return self._patch(path, properties) - def replace_device_twin(self, device_id, properties): + def replace_device_twin(self, properties): """Replaces tags and desired properties of a device twin. - :param str device_id: Device Identifier. :param str properties: Device Twin Properties. """ - path = "{0}/twins/{1}?api-version-{2}".format(self._iot_hub_url, device_id, AZ_API_VER) + path = "{0}/twins/{1}?api-version-{2}".format(self._iot_hub_url, + self._device_id, AZ_API_VER) return self._put(path, properties) # IoT Hub Service def get_devices(self): - """Enumerate devices from the identity registry of your IoT Hub. + """Enumerate devices from the identity registry of the IoT Hub. """ path = "{0}/devices/?api-version={1}".format(self._iot_hub_url, AZ_API_VER) return self._get(path) - def get_device(self, device_id): - """Gets device information from the identity registry of an IoT Hub. - :param str device_id: Device Identifier. + def get_device(self): + """Gets device information from the identity + registry of an IoT Hub. """ - path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) + path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, + self._device_id, AZ_API_VER) return self._get(path) - def delete_device(self, device_id, device_etag): - """Deletes a specified device from the identity register of an IoT Hub. - :param str device_id: Device Identifier. - :param str device_etag: Device Identity Tag. - """ - path = "{0}/devices/{1}?api-version={2}".format(self._iot_hub_url, device_id, AZ_API_VER) - self._delete(path, etag=device_etag) - # HTTP Helper Methods def _post(self, path, payload, return_response=True): """HTTP POST From 7076504697c1871ec89cb6aebac99e61b71516f0 Mon Sep 17 00:00:00 2001 From: brentru Date: Wed, 22 May 2019 16:54:45 -0400 Subject: [PATCH 27/30] redo examples to match new location of device_id --- examples/azureiot_device_management.py | 11 ++--------- examples/azureiot_devicetwin.py | 11 ++++------- examples/azureiot_simpletest.py | 9 +++------ 3 files changed, 9 insertions(+), 22 deletions(-) diff --git a/examples/azureiot_device_management.py b/examples/azureiot_device_management.py index c58f18f..18a2c80 100644 --- a/examples/azureiot_device_management.py +++ b/examples/azureiot_device_management.py @@ -29,19 +29,12 @@ wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) # Create an instance of the Azure IoT Hub -hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas']) - -device_id = 'CircuitPython' +hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas'], secrets['device_id']) # Enumerate all devices on an Azure IoT Hub all_hub_devices = hub.get_devices() print(all_hub_devices) # Get a specified device on an Azure IoT Hub -device_data = hub.get_device(device_id) +device_data = hub.get_device() print(device_data) - -# Delete a device from an Azure IoT Hub -# NOTE: This operation requires a device's ETag -hub.delete_device(device_id, device_data['etag']) -print('Device deleted from IoT Hub!') diff --git a/examples/azureiot_devicetwin.py b/examples/azureiot_devicetwin.py index d1d804c..6430e19 100644 --- a/examples/azureiot_devicetwin.py +++ b/examples/azureiot_devicetwin.py @@ -29,22 +29,19 @@ wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) # Create an instance of the Azure IoT Hub -hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas']) - -# Set a device id (This name must match a device connected to your Azure IoT Hub) -device_id = 'Blinka' +hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas'], secrets['device_id']) # Get a Device Twin -device_twin = hub.get_device_twin(device_id) +device_twin = hub.get_device_twin() # Filter out the device's name from the twin's properties device_name = device_twin['properties']['desired']['deviceName'] print(device_name) # Update a Device Twin's Properties data = {"properties":{"desired": {"deviceName": "{{BasementTemperatureLoggerFeather}}"}}} -hub.update_device_twin(device_id, data) +hub.update_device_twin(data) # And read the updated device twin information -device_twin = hub.get_device_twin(device_id) +device_twin = hub.get_device_twin() device_name = device_twin['properties']['desired']['deviceName'] print(device_name) diff --git a/examples/azureiot_simpletest.py b/examples/azureiot_simpletest.py index 8976577..3939724 100644 --- a/examples/azureiot_simpletest.py +++ b/examples/azureiot_simpletest.py @@ -30,22 +30,19 @@ wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) # Create an instance of the Azure IoT Hub -hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas']) - -# Set a device id (This name must match a device connected to your Azure IoT Hub) -device_id = 'Blinka' +hub = IOT_Hub(wifi, secrets['azure_iot_hub'], secrets['azure_iot_sas'], secrets['device_id']) # Send a Device-to-Cloud message print('Sending Data to Azure IoT Hub...') data = randint(0, 100) -hub.send_device_message(device_id, str(data)) +hub.send_device_message(str(data)) print('Data Sent!') # Receive a Cloud-to-Device message # NOTE: HTTP Cloud-to-Device messages are HEAVILY throttled over HTTP. # Microsoft suggests a polling interval of the below code for every 25 minutes. print('Receiving a message from an Azure IoT Hub...') -message = hub.get_hub_message(device_id) +message = hub.get_hub_message() if message == -1: print('IoT Hub Message Queue is empty!') else: From 2b01b1e968cae7df60fb2f06f4618149d773d0b6 Mon Sep 17 00:00:00 2001 From: brentru Date: Wed, 22 May 2019 16:57:06 -0400 Subject: [PATCH 28/30] remove deviceid from the top-level on the readme usage examples too! --- README.rst | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 1433f5f..a4702e4 100644 --- a/README.rst +++ b/README.rst @@ -33,49 +33,37 @@ Create an instance of an Azure IoT Hub (you'll need your SAS Token). .. code-block:: python - my_hub = IOT_HUB(wifi, 'Azure_IOT_Hub_Name', 'Azure_IOT_Hub_SAS_Token') + my_hub = IOT_HUB(wifi, 'Azure_IOT_Hub_Name', 'Azure_IOT_Hub_SAS_Token', 'Azure_Device_Identifier') -Send a device-to-cloud message: +Send a device-to-cloud message .. code-block:: python - my_hub.send_device_message('deviceID', 'Hi Azure IoT!') + my_hub.send_device_message('Hello Azure IoT!') -Enumerate all devices on an Azure IOT Hub: +Enumerate all devices on an Azure IOT Hub .. code-block:: python hub_devices = my_hub.get_devices() -Get a specified device on an Azure IoT Hub: +Get information about the current device on an Azure IoT Hub .. code-block:: python - device_info = my_hub.get_device('deviceID') + device_info = my_hub.get_device() -Create a new device on an Azure IoT Hub: +Get information about the current device's device twin .. code-block:: python - my_hub.create_device('deviceID') + twin_info = my_hub.get_device_twin() -Delete a device from an Azure IoT Hub: +Update the current device's device twin properties .. code-block:: python - my_hub.delete_device('deviceID') - -Get a device twin: - -.. code-block:: python - - twin_info = my_hub.get_device_twin('deviceID') - -Update a device twin's properties: - -.. code-block:: python - - my_hub.update_device_twin('Blinka', device_properties) + my_hub.update_device_twin(device_properties) Contributing ============ From a7b05b850eb735e496a6e762ef0e3f48e0088437 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 23 May 2019 11:39:59 -0400 Subject: [PATCH 29/30] add getter/setter for device_id property --- adafruit_azureiot.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 987629e..91e7e39 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -67,6 +67,18 @@ def __init__(self, wifi_manager, iot_hub_name, sas_token, device_id): self._device_id = device_id self._azure_header = {"Authorization":self._sas_token} + @property + def device_id(self): + """Returns the current device identifier""" + return self._device_id + + @device_id.setter + def device_id(self, device_identifier): + """Sets the current device identifier + :param str device_identifier: Unique device identifier. + """ + self._device_id = device_identifier + @staticmethod def _parse_http_status(status_code, status_reason): """Parses status code, throws error based on Azure IoT Common Error Codes. From 3eac209beca1b414c963cc9f678363965be277af Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 23 May 2019 13:15:29 -0400 Subject: [PATCH 30/30] all responses need to be closed, returning responses causes errors --- adafruit_azureiot.py | 35 ++++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/adafruit_azureiot.py b/adafruit_azureiot.py index 91e7e39..1c50fcd 100644 --- a/adafruit_azureiot.py +++ b/adafruit_azureiot.py @@ -100,10 +100,7 @@ def get_hub_message(self): path = "{0}/devices/{1}/messages/deviceBound?api-version={2}".format(self._iot_hub_url, self._device_id, AZ_API_VER) - try: - data = self._get(path, is_c2d=True) - except RuntimeError: - raise RuntimeError('HTTP C2D messages are HEAVILY throttled - poll every 25 mins.') + data = self._get(path, is_c2d=True) if data == 204: # device's message queue is empty return -1 etag = data[1]['etag'] @@ -190,12 +187,18 @@ def _get(self, path, is_c2d=False): response = self._wifi.get( path, headers=self._azure_header) - if is_c2d: # check status of azure message queue - if response.status_code == 200: - return response.text, response.headers - return response.status_code - self._parse_http_status(response.status_code, response.reason) - return response.json() + status_code = response.status_code + if is_c2d: + if status_code == 200: + data = response.text + headers = response.headers + response.close() + return data, headers + response.close() + return status_code + json = response.json() + response.close() + return json def _delete(self, path, etag=None): """HTTP DELETE @@ -209,7 +212,9 @@ def _delete(self, path, etag=None): path, headers=data_headers) self._parse_http_status(response.status_code, response.reason) - return response.status_code + status_code = response.status_code + response.close() + return status_code def _patch(self, path, payload): """HTTP PATCH @@ -221,7 +226,9 @@ def _patch(self, path, payload): json=payload, headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) - return response.json() + json_data = response.json() + response.close() + return json_data def _put(self, path, payload=None): """HTTP PUT @@ -233,4 +240,6 @@ def _put(self, path, payload=None): json=payload, headers=self._azure_header) self._parse_http_status(response.status_code, response.reason) - return response.json() + json_data = response.json() + response.close() + return json_data