From 73ec319246fb9b0b60958dde17f6715d4d3e9a06 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 22 Aug 2019 12:49:02 -0400 Subject: [PATCH 1/8] add all code from previous library, re-cookiecut --- .gitignore | 12 + .pylintrc | 433 +++++++++++++++++++++++++++++ .readthedocs.yml | 3 + .travis.yml | 48 ++++ CODE_OF_CONDUCT.md | 127 +++++++++ LICENSE | 36 +-- README.md | 2 - README.rst | 105 +++++++ adafruit_gc_iot_core.py | 390 ++++++++++++++++++++++++++ docs/_static/favicon.ico | Bin 0 -> 4414 bytes docs/api.rst | 8 + docs/conf.py | 158 +++++++++++ docs/examples.rst | 8 + docs/index.rst | 47 ++++ examples/gc_iot_core_simpletest.py | 124 +++++++++ requirements.txt | 1 + setup.py | 64 +++++ 17 files changed, 1543 insertions(+), 23 deletions(-) create mode 100644 .gitignore create mode 100644 .pylintrc create mode 100644 .readthedocs.yml create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md delete mode 100644 README.md create mode 100644 README.rst create mode 100644 adafruit_gc_iot_core.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/gc_iot_core_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..a8e3f8d --- /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_gc_iot_core.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-gc_iot_core --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7ca3a1d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +The goal of the standards and moderation guidelines outlined here is to build +and maintain a respectful community. We ask that you don’t just aim to be +"technically unimpeachable", but rather try to be your best self. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +You may report in the following ways: + +In any situation, you may send an email to . + +On the Adafruit Discord, you may send an open message from any channel +to all Community Helpers by tagging @community moderators. You may also send an +open message from any channel, or a direct message to @kattni#1507, +@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or +@Andon#8175. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. diff --git a/LICENSE b/LICENSE index 5739aaa..a647a6a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,15 @@ -MIT License - -Copyright (c) 2019 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. +# Copyright 2019 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Modified by Brent Rubell for Adafruit Industries, 2019 \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index e452a4e..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_GC_IOT_Core -Google Cloud IoT Core client for CircuitPython devices diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6fb7ed5 --- /dev/null +++ b/README.rst @@ -0,0 +1,105 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-gc_iot_core/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/gc_iot_core/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_GC_IOT_CORE.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_GC_IOT_CORE + :alt: Build Status + +Google Cloud IoT Core Client for CircuitPython + + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ +* `Adafruit CircuitPython JWT `_ +* `Adafruit CircuitPython Logging `_ + + +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! + + +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-gc-iot-core + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-gc-iot-core + +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-gc-iot-core + +Usage Example +============= + +Usage example within examples/ folder. + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +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. + +License +======= + +This library was written by Google for MicroPython. We've converted it to +work with CircuitPython and made changes so it works with boards supported by +CircuitPython and the CircuitPython API. + +We've added examples for using this library to transmit board telemetry data along +with sensor data to Google's Cloud Platform. + +This open source code is licensed under the Apache license (see LICENSE) for details. \ No newline at end of file diff --git a/adafruit_gc_iot_core.py b/adafruit_gc_iot_core.py new file mode 100644 index 0000000..c5934f9 --- /dev/null +++ b/adafruit_gc_iot_core.py @@ -0,0 +1,390 @@ +# Copyright 2019 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Modified by Brent Rubell for Adafruit Industries, 2019 +""" +`adafruit_gc_iot_core` +================================================================================ + +CircuitPython Google Cloud IoT Module + +* Author(s): Brent Rubell, Google Inc. + +Implementation Notes +-------------------- + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +* Adafruit CircuitPython JWT Module: + https://github.com/adafruit/Adafruit_CircuitPython_JWT + +* Adafruit CircuitPython Logging Module: + https://github.com/adafruit/Adafruit_CircuitPython_Logging + +""" + +# Core CircuitPython modules +import gc +import time +import rtc + +import adafruit_logging as logging +from adafruit_jwt import JWT + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cloud_IOT_Core.git" + +TIME_SERVICE = ( + "https://io.adafruit.com/api/v2/%s/integrations/time/strftime?x-aio-key=%s" +) + +# our strftime is %Y-%m-%d %H:%M:%S.%L %j %u %z %Z see http://strftime.net/ for decoding details +# See https://apidock.com/ruby/DateTime/strftime for full options +TIME_SERVICE_STRFTIME = ( + "&fmt=%25Y-%25m-%25d+%25H%3A%25M%3A%25S.%25L+%25j+%25u+%25z+%25Z" +) + +class MQTT_API_ERROR(Exception): + """Exception raised on MQTT API return-code errors.""" + # pylint: disable=unnecessary-pass + pass + +class MQTT_API: + """Client for interacting with Google's Cloud Core MQTT API. + + :param MiniMQTT mqtt_client: MiniMQTT Client object. + """ + + # pylint: disable=protected-access + def __init__(self, mqtt_client): + # Check that provided object is a MiniMQTT client object + mqtt_client_type = str(type(mqtt_client)) + if "MQTT" in mqtt_client_type: + self._client = mqtt_client + else: + raise TypeError( + "This class requires a MiniMQTT client object, please create one." + ) + # Verify that the MiniMQTT client was setup correctly. + try: + self._user = self._client._user + except: + raise TypeError("Google Cloud Core IoT MQTT API requires a username.") + # Validate provided JWT before connecting + try: + JWT.validate(self._client._pass) + except: + raise TypeError("Invalid JWT provided.") + # If client has KeepAlive =0 or if KeepAlive > 20min, + # set KeepAlive to 19 minutes to avoid disconnection + # due to Idle Time (https://cloud.google.com/iot/quotas). + if self._client._keep_alive == 0 or self._client._keep_alive >= 1200: + self._client._keep_alive = 1140 + # User-defined MQTT callback methods must be init'd to None + self.on_connect = None + self.on_disconnect = None + self.on_message = None + self.on_subscribe = None + self.on_unsubscribe = None + # MQTT event callbacks + self._client.on_connect = self._on_connect_mqtt + self._client.on_disconnect = self._on_disconnect_mqtt + self._client.on_message = self._on_message_mqtt + self._logger = False + if self._client._logger is not None: + # Allow IOTCore to share MiniMQTT Client's logger + self._logger = True + self._client.set_logger_level("DEBUG") + self._connected = False + # Set up a device identifier by splitting out the full CID + self.device_id = self._client._client_id.split("/")[7] + + def __enter__(self): + return self + + def __exit__(self, exception_type, exception_value, traceback): + self.disconnect() + + def disconnect(self): + """Disconnects from the Google MQTT Broker. + """ + try: + self._client.disconnect() + except: + raise ValueError("Unable to disconnect from Google's MQTT broker.") + self._connected = False + # Reset all user-defined callbacks + self.on_connect = None + self.on_disconnect = None + self.on_message = None + self.on_subscribe = None + self.on_unsubscribe = None + # De-initialize MiniMQTT Client + self._client.deinit() + + def connect(self): + """Connects to the Google MQTT Broker. + """ + self._client.connect() + self._connected = True + + @property + def is_connected(self): + """Returns if client is connected to Google's MQTT broker. + """ + return self._connected + + # pylint: disable=not-callable, unused-argument + def _on_connect_mqtt(self, client, userdata, flags, return_code): + """Runs when the mqtt client calls on_connect. + """ + if self._logger: + self._client._logger.debug("Client called on_connect.") + if return_code == 0: + self._connected = True + else: + raise MQTT_API_ERROR(return_code) + # Call the user-defined on_connect callback if defined + if self.on_connect is not None: + self.on_connect(self, userdata, flags, return_code) + + # pylint: disable=not-callable, unused-argument + def _on_disconnect_mqtt(self, client, userdata, return_code): + """Runs when the client calls on_disconnect. + """ + if self._logger: + self._client._logger.debug("Client called on_disconnect") + self._connected = False + # Call the user-defined on_disconnect callblack if defined + if self.on_disconnect is not None: + self.on_disconnect(self) + + # pylint: disable=not-callable + def _on_message_mqtt(self, client, topic, payload): + """Runs when the client calls on_message + """ + if self._logger: + self._client._logger.debug("Client called on_message") + if self.on_message is not None: + self.on_message(self, topic, payload) + + def loop(self): + """Maintains a connection with Google Cloud IoT Core's MQTT broker. You will + need to manually call this method within a loop to retain connection. + + Example of "pumping" a Google Core IoT loop. + ..code-block:: python + + while True: + google_iot.loop() + + """ + if self._connected: + self._client.loop() + + def loop_blocking(self): + """Begins a blocking loop to process messages from + IoT Core. Code below a call to this method will NOT run. + """ + self._client.loop_forever() + + def subscribe(self, topic, subfolder=None, qos=1): + """Subscribes to a Google Cloud IoT device topic. + :param str topic: Required MQTT topic. Defaults to events. + :param str subfolder: Optional MQTT topic subfolder. Defaults to None. + :param int qos: Quality of Service level for the message. + """ + if subfolder is not None: + mqtt_topic = "/devices/{}/{}/{}".format(self.device_id, topic, subfolder) + else: + mqtt_topic = "/devices/{}/{}".format(self.device_id, topic) + self._client.subscribe(mqtt_topic, qos) + + def subscribe_to_subfolder(self, topic, subfolder, qos=1): + """Subscribes to a Google Cloud IoT device's topic subfolder + :param str topic: Required MQTT topic. + :param str subfolder: Optional MQTT topic subfolder. Defaults to None. + :param int qos: Quality of Service level for the message. + """ + self.subscribe(topic, subfolder, qos) + + def subscribe_to_config(self, qos=1): + """Subscribes to a Google Cloud IoT device's configuration + topic. + :param int qos: Quality of Service level for the message. + """ + self.subscribe("config", qos=qos) + + def subscribe_to_all_commands(self, qos=1): + """Subscribes to a device's "commands/#" topic. + :param int qos: Quality of Service level for the message. + """ + self.subscribe("commands/#", qos=qos) + + def publish(self, payload, topic="events", subfolder=None, qos=0): + """Publishes a payload from the device to its Google Cloud IoT + device topic, defaults to "events" topic. To send state, use the + publish_state method. + + :param int payload: Data to publish to Google Cloud IoT + :param str payload: Data to publish to Google Cloud IoT + :param float payload: Data to publish to Google Cloud IoT + :param str topic: Required MQTT topic. Defaults to events. + :param str subfolder: Optional MQTT topic subfolder. Defaults to None. + :param int qos: Quality of Service level for the message. + """ + if subfolder is not None: + mqtt_topic = "/devices/{}/{}/{}".format(self.device_id, topic, subfolder) + elif topic is not None: + mqtt_topic = "/devices/{}/{}".format(self.device_id, topic) + elif topic == "state" and subfolder is not None: + raise ValueError("Subfolders are not supported for state messages.") + else: + raise TypeError("A topic string must be specified.") + self._client.publish(mqtt_topic, payload, qos=qos) + + def publish_state(self, payload): + """Publishes a device state message to the Cloud IoT MQTT API. Data + sent by this method should be information about the device itself (such as number of + crashes, battery level, or device health). This method is unidirectional, + it communicates Device-to-Cloud only. + """ + self._client.publish(payload, "state") + + +# pylint: disable=too-many-instance-attributes +class Cloud_Core: + """CircuitPython Google Cloud IoT Core module. + + :param network_manager: Network Manager module, such as WiFiManager. + :param dict secrets: Secrets.py file. + :param bool log: Enable Cloud_Core logging, defaults to False. + + """ + + def __init__(self, network_manager, secrets, log=False): + # Validate NetworkManager + network_manager_type = str(type(network_manager)) + if "ESPSPI_WiFiManager" in network_manager_type: + self._wifi = network_manager + else: + raise TypeError("This library requires a NetworkManager object.") + # Validate Secrets + if hasattr(secrets, "keys"): + self._secrets = secrets + else: + raise AttributeError( + "Project settings are kept in secrets.py, please add them there!" + ) + self._logger = None + if log is True: + self._logger = logging.getLogger("log") + self._logger.setLevel(logging.DEBUG) + # Configuration, from secrets file + self._proj_id = secrets["project_id"] + self._region = secrets["cloud_region"] + self._reg_id = secrets["registry_id"] + self._device_id = secrets["device_id"] + self._private_key = secrets["private_key"] + self.broker = "mqtt.googleapis.com" + self.username = b"unused" + self.cid = self.client_id + + @property + def client_id(self): + """Returns a Google Cloud IOT Core Client ID. + """ + client_id = "projects/{0}/locations/{1}/registries/{2}/devices/{3}".format( + self._proj_id, self._region, self._reg_id, self._device_id + ) + if self._logger: + self._logger.debug("Client ID: {}".format(client_id)) + return client_id + + + def generate_jwt(self, ttl=43200, algo="RS256"): + """Generates a JSON Web Token (https://jwt.io/) using network time. + :param int jwt_ttl: When the JWT token expires, defaults to 43200 minutes (or 12 hours). + :param str algo: Algorithm used to create a JSON Web Token. + + Example usage of generating and setting a JSON-Web-Token: + ..code-block:: python + + jwt = CloudCore.generate_jwt() + print("Generated JWT: ", jwt) + """ + if self._logger: + self._logger.debug("Generating JWT...") + self._get_local_time() + claims = { + # The time that the token was issued at + "iat": time.time(), + # The time the token expires. + "exp": time.time() + ttl, + # The audience field should always be set to the GCP project id. + "aud": self._proj_id, + } + jwt = JWT.generate(claims, self._private_key, algo) + return jwt + + # pylint: disable=line-too-long, too-many-locals + def _get_local_time(self): + """Fetch and "set" the local time of this microcontroller to the + local time at the location, using an internet time API. + from Adafruit IO Arduino + """ + api_url = None + try: + aio_username = self._secrets["aio_username"] + aio_key = self._secrets["aio_key"] + except KeyError: + raise KeyError( + "\n\nOur time service requires a login/password to rate-limit. Please register for a free adafruit.io account and place the user/key in your secrets file under 'aio_username' and 'aio_key'" + ) + location = None + location = self._secrets.get("timezone", location) + if location: + if self._logger: + self._logger.debug("Getting time for timezone.") + api_url = (TIME_SERVICE + "&tz=%s") % (aio_username, aio_key, location) + else: # we'll try to figure it out from the IP address + self._logger.debug("Getting time from IP Address..") + api_url = TIME_SERVICE % (aio_username, aio_key) + api_url += TIME_SERVICE_STRFTIME + try: + response = self._wifi.get(api_url) + times = response.text.split(" ") + the_date = times[0] + the_time = times[1] + year_day = int(times[2]) + week_day = int(times[3]) + is_dst = None # no way to know yet + except KeyError: + raise KeyError( + "Was unable to lookup the time, try setting secrets['timezone'] according to http://worldtimeapi.org/timezones" + ) # pylint: disable=line-too-long + year, month, mday = [int(x) for x in the_date.split("-")] + the_time = the_time.split(".")[0] + hours, minutes, seconds = [int(x) for x in the_time.split(":")] + now = time.struct_time( + (year, month, mday, hours, minutes, seconds, week_day, year_day, is_dst) + ) + rtc.RTC().datetime = now + # now clean up + response.close() + response = None + gc.collect() 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/gc_iot_core_simpletest.py b/examples/gc_iot_core_simpletest.py new file mode 100644 index 0000000..2d4a2c7 --- /dev/null +++ b/examples/gc_iot_core_simpletest.py @@ -0,0 +1,124 @@ +import board +import busio +from digitalio import DigitalInOut +import neopixel +from adafruit_esp32spi import adafruit_esp32spi +from adafruit_esp32spi import adafruit_esp32spi_wifimanager +import adafruit_esp32spi.adafruit_esp32spi_socket as socket + +from adafruit_minimqtt import MQTT +from adafruit_iotcore import Cloud_Core, MQTT_API + +### WiFi ### + +# 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 + +# If you are using a board with pre-defined ESP32 Pins: +esp32_cs = DigitalInOut(board.ESP_CS) +esp32_ready = DigitalInOut(board.ESP_BUSY) +esp32_reset = DigitalInOut(board.ESP_RESET) + +# If you have an externally connected ESP32: +# 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, debug=False) +"""Use below for Most Boards""" +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) +# Uncomment below for an externally defined RGB LED +# import adafruit_rgbled +# from adafruit_esp32spi import PWMOut +# RED_LED = PWMOut.PWMOut(esp, 26) +# GREEN_LED = PWMOut.PWMOut(esp, 27) +# BLUE_LED = PWMOut.PWMOut(esp, 25) +# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) +wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light) + +### Code ### + +# Define callback methods which are called when events occur +# pylint: disable=unused-argument, redefined-outer-name +def connect(client, userdata, flags, rc): + # This function will be called when the client is connected + # successfully to the broker. + print('Connected to MQTT Broker!') + print('Flags: {0}\n RC: {1}'.format(flags, rc)) + # Subscribes to commands/# topic + google_mqtt.subscribe_to_all_commands() + + # Publish to the default "events" topic + google_mqtt.publish('testing','events', qos=1) + +def disconnect(client, userdata, rc): + # This method is called when the client disconnects + # from the broker. + print('Disconnected from MQTT Broker!') + +def subscribe(client, userdata, topic, granted_qos): + # This method is called when the client subscribes to a new topic. + print('Subscribed to {0} with QOS level {1}'.format(topic, granted_qos)) + +def unsubscribe(client, userdata, topic, pid): + # This method is called when the client unsubscribes from a topic. + print('Unsubscribed from {0} with PID {1}'.format(topic, pid)) + +def publish(client, userdata, topic, pid): + # This method is called when the client publishes data to a topic. + print('Published to {0} with PID {1}'.format(topic, pid)) + +def message(client, topic, msg): + # This method is called when the client receives data from a topic. + print("Message from {}: {}".format(topic, msg)) + +# Connect to WiFi +print("connecting to WiFi...") +wifi.connect() +print("Connected!") + +# Initialize Google Cloud IoT Core interface +google_iot = Cloud_Core(wifi, secrets, log=False) + +# Optional JSON-Web-Token (JWT) Generation +# print("Generating JWT...") +# jwt = google_iot.generate_jwt() +# print("Your JWT is: ", jwt) + +# Set up a new MiniMQTT Client +client = MQTT(socket, + broker = google_iot.broker, + username = google_iot.username, + password = secrets['jwt'], + client_id = google_iot.cid, + network_manager = wifi, + log=True) + +# Initialize Google MQTT API Client +google_mqtt = MQTT_API(client) + +# Connect callback handlers to Google MQTT Client +google_mqtt.on_connect = connect +google_mqtt.on_disconnect = disconnect +google_mqtt.on_subscribe = subscribe +google_mqtt.on_unsubscribe = unsubscribe +google_mqtt.on_publish = publish +google_mqtt.on_message = message + +print('Attempting to connect to %s'%client.broker) +google_mqtt.connect() + +# Pump the message loop forever, all events are +# handled in their callback handlers +# while True: +# google_mqtt.loop() + +# Attempt to loop forever and handle network disconnection +google_mqtt.loop_blocking() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..edf9394 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +Adafruit-Blinka diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..44d4897 --- /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-gc-iot-core', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='Google Cloud IoT Core Client for CircuitPython', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_GC_IOT_CORE', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka' + ], + + # Choose your license + license='MIT', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries', + 'Topic :: System :: Hardware', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + ], + + # What does your project relate to? + keywords='adafruit blinka circuitpython micropython gc_iot_core gcs, google cloud ' + 'platform, cloud, iot, core', + + # 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_gc_iot_core'], +) From a7dc6c8ba793d98be81486946fe0f48f9aa42299 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 22 Aug 2019 12:51:48 -0400 Subject: [PATCH 2/8] update simpletest for new library name, tested --- examples/gc_iot_core_simpletest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/gc_iot_core_simpletest.py b/examples/gc_iot_core_simpletest.py index 2d4a2c7..ccf546a 100644 --- a/examples/gc_iot_core_simpletest.py +++ b/examples/gc_iot_core_simpletest.py @@ -7,7 +7,7 @@ import adafruit_esp32spi.adafruit_esp32spi_socket as socket from adafruit_minimqtt import MQTT -from adafruit_iotcore import Cloud_Core, MQTT_API +from adafruit_gc_iot_core import Cloud_Core, MQTT_API ### WiFi ### From 86656ff2a5051853c79311a7414cfef521d38152 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 22 Aug 2019 17:17:57 -0400 Subject: [PATCH 3/8] require Adafruit_NTP instead of dep. on Adafruit IO. Remove _get_local_time method and fetch the local time within jwt generation method --- adafruit_gc_iot_core.py | 64 +++++------------------------------------ docs/conf.py | 2 +- 2 files changed, 8 insertions(+), 58 deletions(-) diff --git a/adafruit_gc_iot_core.py b/adafruit_gc_iot_core.py index c5934f9..6fba88c 100644 --- a/adafruit_gc_iot_core.py +++ b/adafruit_gc_iot_core.py @@ -44,6 +44,7 @@ import adafruit_logging as logging from adafruit_jwt import JWT +import adafruit_ntp as NTP __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cloud_IOT_Core.git" @@ -270,19 +271,14 @@ def publish_state(self, payload): class Cloud_Core: """CircuitPython Google Cloud IoT Core module. - :param network_manager: Network Manager module, such as WiFiManager. + :param ESP_SPIcontrol esp: ESP32SPI object. :param dict secrets: Secrets.py file. :param bool log: Enable Cloud_Core logging, defaults to False. """ - def __init__(self, network_manager, secrets, log=False): - # Validate NetworkManager - network_manager_type = str(type(network_manager)) - if "ESPSPI_WiFiManager" in network_manager_type: - self._wifi = network_manager - else: - raise TypeError("This library requires a NetworkManager object.") + def __init__(self, esp, secrets, log=False): + self._esp = esp # Validate Secrets if hasattr(secrets, "keys"): self._secrets = secrets @@ -329,7 +325,9 @@ def generate_jwt(self, ttl=43200, algo="RS256"): """ if self._logger: self._logger.debug("Generating JWT...") - self._get_local_time() + ntp = NTP.NTP(self._esp) + ntp.set_time() + #self._get_local_time() claims = { # The time that the token was issued at "iat": time.time(), @@ -340,51 +338,3 @@ def generate_jwt(self, ttl=43200, algo="RS256"): } jwt = JWT.generate(claims, self._private_key, algo) return jwt - - # pylint: disable=line-too-long, too-many-locals - def _get_local_time(self): - """Fetch and "set" the local time of this microcontroller to the - local time at the location, using an internet time API. - from Adafruit IO Arduino - """ - api_url = None - try: - aio_username = self._secrets["aio_username"] - aio_key = self._secrets["aio_key"] - except KeyError: - raise KeyError( - "\n\nOur time service requires a login/password to rate-limit. Please register for a free adafruit.io account and place the user/key in your secrets file under 'aio_username' and 'aio_key'" - ) - location = None - location = self._secrets.get("timezone", location) - if location: - if self._logger: - self._logger.debug("Getting time for timezone.") - api_url = (TIME_SERVICE + "&tz=%s") % (aio_username, aio_key, location) - else: # we'll try to figure it out from the IP address - self._logger.debug("Getting time from IP Address..") - api_url = TIME_SERVICE % (aio_username, aio_key) - api_url += TIME_SERVICE_STRFTIME - try: - response = self._wifi.get(api_url) - times = response.text.split(" ") - the_date = times[0] - the_time = times[1] - year_day = int(times[2]) - week_day = int(times[3]) - is_dst = None # no way to know yet - except KeyError: - raise KeyError( - "Was unable to lookup the time, try setting secrets['timezone'] according to http://worldtimeapi.org/timezones" - ) # pylint: disable=line-too-long - year, month, mday = [int(x) for x in the_date.split("-")] - the_time = the_time.split(".")[0] - hours, minutes, seconds = [int(x) for x in the_time.split(":")] - now = time.struct_time( - (year, month, mday, hours, minutes, seconds, week_day, year_day, is_dst) - ) - rtc.RTC().datetime = now - # now clean up - response.close() - response = None - gc.collect() diff --git a/docs/conf.py b/docs/conf.py index bb6e06f..883990c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["adafruit_logging", "adafruit_jwt", "rtc"] +autodoc_mock_imports = ["adafruit_logging", "adafruit_jwt", "adafruit_ntp", "rtc"] intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} From 4d61fea3649842aa44bed30c2cb69b667153f230 Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 22 Aug 2019 17:24:37 -0400 Subject: [PATCH 4/8] update simpletest for NTP dep --- examples/gc_iot_core_simpletest.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/examples/gc_iot_core_simpletest.py b/examples/gc_iot_core_simpletest.py index ccf546a..b82fcd8 100644 --- a/examples/gc_iot_core_simpletest.py +++ b/examples/gc_iot_core_simpletest.py @@ -29,7 +29,7 @@ # 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, debug=False) +esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) """Use below for Most Boards""" status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards """Uncomment below for ItsyBitsy M4""" @@ -85,7 +85,7 @@ def message(client, topic, msg): print("Connected!") # Initialize Google Cloud IoT Core interface -google_iot = Cloud_Core(wifi, secrets, log=False) +google_iot = Cloud_Core(esp, secrets, log=False) # Optional JSON-Web-Token (JWT) Generation # print("Generating JWT...") @@ -98,8 +98,7 @@ def message(client, topic, msg): username = google_iot.username, password = secrets['jwt'], client_id = google_iot.cid, - network_manager = wifi, - log=True) + network_manager = wifi) # Initialize Google MQTT API Client google_mqtt = MQTT_API(client) From 2382fe11a03a274f8c48956ccbe4afcaa107a00a Mon Sep 17 00:00:00 2001 From: brentru Date: Thu, 22 Aug 2019 17:25:35 -0400 Subject: [PATCH 5/8] linting --- adafruit_gc_iot_core.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/adafruit_gc_iot_core.py b/adafruit_gc_iot_core.py index 6fba88c..eca5087 100644 --- a/adafruit_gc_iot_core.py +++ b/adafruit_gc_iot_core.py @@ -36,11 +36,7 @@ https://github.com/adafruit/Adafruit_CircuitPython_Logging """ - -# Core CircuitPython modules -import gc import time -import rtc import adafruit_logging as logging from adafruit_jwt import JWT From e5247c655edd4c9ef12c850c30471bab9827fce9 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 23 Aug 2019 09:46:01 -0400 Subject: [PATCH 6/8] cleanup old time code --- adafruit_gc_iot_core.py | 20 +++++++++----------- examples/gc_iot_core_simpletest.py | 4 ++-- 2 files changed, 11 insertions(+), 13 deletions(-) diff --git a/adafruit_gc_iot_core.py b/adafruit_gc_iot_core.py index eca5087..60a31d1 100644 --- a/adafruit_gc_iot_core.py +++ b/adafruit_gc_iot_core.py @@ -45,16 +45,6 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Cloud_IOT_Core.git" -TIME_SERVICE = ( - "https://io.adafruit.com/api/v2/%s/integrations/time/strftime?x-aio-key=%s" -) - -# our strftime is %Y-%m-%d %H:%M:%S.%L %j %u %z %Z see http://strftime.net/ for decoding details -# See https://apidock.com/ruby/DateTime/strftime for full options -TIME_SERVICE_STRFTIME = ( - "&fmt=%25Y-%25m-%25d+%25H%3A%25M%3A%25S.%25L+%25j+%25u+%25z+%25Z" -) - class MQTT_API_ERROR(Exception): """Exception raised on MQTT API return-code errors.""" # pylint: disable=unnecessary-pass @@ -64,6 +54,7 @@ class MQTT_API: """Client for interacting with Google's Cloud Core MQTT API. :param MiniMQTT mqtt_client: MiniMQTT Client object. + """ # pylint: disable=protected-access @@ -196,6 +187,7 @@ def loop(self): def loop_blocking(self): """Begins a blocking loop to process messages from IoT Core. Code below a call to this method will NOT run. + """ self._client.loop_forever() @@ -204,6 +196,7 @@ def subscribe(self, topic, subfolder=None, qos=1): :param str topic: Required MQTT topic. Defaults to events. :param str subfolder: Optional MQTT topic subfolder. Defaults to None. :param int qos: Quality of Service level for the message. + """ if subfolder is not None: mqtt_topic = "/devices/{}/{}/{}".format(self.device_id, topic, subfolder) @@ -216,6 +209,7 @@ def subscribe_to_subfolder(self, topic, subfolder, qos=1): :param str topic: Required MQTT topic. :param str subfolder: Optional MQTT topic subfolder. Defaults to None. :param int qos: Quality of Service level for the message. + """ self.subscribe(topic, subfolder, qos) @@ -223,12 +217,14 @@ def subscribe_to_config(self, qos=1): """Subscribes to a Google Cloud IoT device's configuration topic. :param int qos: Quality of Service level for the message. + """ self.subscribe("config", qos=qos) def subscribe_to_all_commands(self, qos=1): """Subscribes to a device's "commands/#" topic. :param int qos: Quality of Service level for the message. + """ self.subscribe("commands/#", qos=qos) @@ -243,6 +239,7 @@ def publish(self, payload, topic="events", subfolder=None, qos=0): :param str topic: Required MQTT topic. Defaults to events. :param str subfolder: Optional MQTT topic subfolder. Defaults to None. :param int qos: Quality of Service level for the message. + """ if subfolder is not None: mqtt_topic = "/devices/{}/{}/{}".format(self.device_id, topic, subfolder) @@ -259,6 +256,7 @@ def publish_state(self, payload): sent by this method should be information about the device itself (such as number of crashes, battery level, or device health). This method is unidirectional, it communicates Device-to-Cloud only. + """ self._client.publish(payload, "state") @@ -318,12 +316,12 @@ def generate_jwt(self, ttl=43200, algo="RS256"): jwt = CloudCore.generate_jwt() print("Generated JWT: ", jwt) + """ if self._logger: self._logger.debug("Generating JWT...") ntp = NTP.NTP(self._esp) ntp.set_time() - #self._get_local_time() claims = { # The time that the token was issued at "iat": time.time(), diff --git a/examples/gc_iot_core_simpletest.py b/examples/gc_iot_core_simpletest.py index b82fcd8..f7add36 100644 --- a/examples/gc_iot_core_simpletest.py +++ b/examples/gc_iot_core_simpletest.py @@ -80,12 +80,12 @@ def message(client, topic, msg): print("Message from {}: {}".format(topic, msg)) # Connect to WiFi -print("connecting to WiFi...") +print("Connecting to WiFi...") wifi.connect() print("Connected!") # Initialize Google Cloud IoT Core interface -google_iot = Cloud_Core(esp, secrets, log=False) +google_iot = Cloud_Core(esp, secrets) # Optional JSON-Web-Token (JWT) Generation # print("Generating JWT...") From 6d25933988f02dec43dc20fccef8ac4384cb63ef Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 23 Aug 2019 16:50:26 -0400 Subject: [PATCH 7/8] tie together unsuback and subacks --- adafruit_gc_iot_core.py | 43 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/adafruit_gc_iot_core.py b/adafruit_gc_iot_core.py index 60a31d1..605eaa3 100644 --- a/adafruit_gc_iot_core.py +++ b/adafruit_gc_iot_core.py @@ -92,9 +92,11 @@ def __init__(self, mqtt_client): self._client.on_connect = self._on_connect_mqtt self._client.on_disconnect = self._on_disconnect_mqtt self._client.on_message = self._on_message_mqtt + self._client.on_subscribe = self._on_subscribe_mqtt + self._client.on_unsubscribe = self._on_unsubscribe_mqtt self._logger = False if self._client._logger is not None: - # Allow IOTCore to share MiniMQTT Client's logger + # Allow MQTT_API to utilize MiniMQTT Client's logger self._logger = True self._client.set_logger_level("DEBUG") self._connected = False @@ -163,13 +165,31 @@ def _on_disconnect_mqtt(self, client, userdata, return_code): # pylint: disable=not-callable def _on_message_mqtt(self, client, topic, payload): - """Runs when the client calls on_message + """Runs when the client calls on_message. """ if self._logger: self._client._logger.debug("Client called on_message") if self.on_message is not None: self.on_message(self, topic, payload) + # pylint: disable=not-callable + def _on_subscribe_mqtt(self, client, user_data, topic, qos): + """Runs when the client calls on_subscribe. + """ + if self._logger: + self._client._logger.debug("Client called on_subscribe") + if self.on_subscribe is not None: + self.on_subscribe(self, user_data, topic, qos) + + # pylint: disable=not-callable + def _on_unsubscribe_mqtt(self, client, user_data, topic, pid): + """Runs when the client calls on_unsubscribe. + """ + if self._logger: + self._client._logger.debug("Client called on_unsubscribe") + if self.on_unsubscribe is not None: + self.on_unsubscribe(self, user_data, topic, pid) + def loop(self): """Maintains a connection with Google Cloud IoT Core's MQTT broker. You will need to manually call this method within a loop to retain connection. @@ -191,6 +211,25 @@ def loop_blocking(self): """ self._client.loop_forever() + def unsubscribe(self, topic, subfolder=None): + """Unsubscribes from a Google Cloud IoT device topic. + :param str topic: Required MQTT topic. Defaults to events. + :param str subfolder: Optional MQTT topic subfolder. Defaults to None. + + """ + if subfolder is not None: + mqtt_topic = "/devices/{}/{}/{}".format(self.device_id, topic, subfolder) + else: + mqtt_topic = "/devices/{}/{}".format(self.device_id, topic) + self._client.unsubscribe(mqtt_topic) + + def unsubscribe_from_all_commands(self): + """Unsubscribes from a device's "commands/#" topic. + :param int qos: Quality of Service level for the message. + + """ + self.unsubscribe("commands/#") + def subscribe(self, topic, subfolder=None, qos=1): """Subscribes to a Google Cloud IoT device topic. :param str topic: Required MQTT topic. Defaults to events. From 3f934e37387953ebc0887d3096e4c93daa2bdd07 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 23 Aug 2019 18:16:55 -0400 Subject: [PATCH 8/8] update to remove private minimqtt properties --- adafruit_gc_iot_core.py | 51 ++++++++++++++++++++--------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/adafruit_gc_iot_core.py b/adafruit_gc_iot_core.py index 605eaa3..a579688 100644 --- a/adafruit_gc_iot_core.py +++ b/adafruit_gc_iot_core.py @@ -57,7 +57,6 @@ class MQTT_API: """ - # pylint: disable=protected-access def __init__(self, mqtt_client): # Check that provided object is a MiniMQTT client object mqtt_client_type = str(type(mqtt_client)) @@ -69,19 +68,19 @@ def __init__(self, mqtt_client): ) # Verify that the MiniMQTT client was setup correctly. try: - self._user = self._client._user + self.user = self._client.user except: raise TypeError("Google Cloud Core IoT MQTT API requires a username.") # Validate provided JWT before connecting try: - JWT.validate(self._client._pass) + JWT.validate(self._client.password) except: raise TypeError("Invalid JWT provided.") # If client has KeepAlive =0 or if KeepAlive > 20min, # set KeepAlive to 19 minutes to avoid disconnection # due to Idle Time (https://cloud.google.com/iot/quotas). - if self._client._keep_alive == 0 or self._client._keep_alive >= 1200: - self._client._keep_alive = 1140 + if self._client.keep_alive == 0 or self._client.keep_alive >= 1200: + self._client.keep_alive = 1140 # User-defined MQTT callback methods must be init'd to None self.on_connect = None self.on_disconnect = None @@ -94,14 +93,14 @@ def __init__(self, mqtt_client): self._client.on_message = self._on_message_mqtt self._client.on_subscribe = self._on_subscribe_mqtt self._client.on_unsubscribe = self._on_unsubscribe_mqtt - self._logger = False - if self._client._logger is not None: + self.logger = False + if self._client.logger is not None: # Allow MQTT_API to utilize MiniMQTT Client's logger - self._logger = True + self.logger = True self._client.set_logger_level("DEBUG") self._connected = False # Set up a device identifier by splitting out the full CID - self.device_id = self._client._client_id.split("/")[7] + self.device_id = self._client.client_id.split("/")[7] def __enter__(self): return self @@ -142,8 +141,8 @@ def is_connected(self): def _on_connect_mqtt(self, client, userdata, flags, return_code): """Runs when the mqtt client calls on_connect. """ - if self._logger: - self._client._logger.debug("Client called on_connect.") + if self.logger: + self._client.logger.debug("Client called on_connect.") if return_code == 0: self._connected = True else: @@ -156,8 +155,8 @@ def _on_connect_mqtt(self, client, userdata, flags, return_code): def _on_disconnect_mqtt(self, client, userdata, return_code): """Runs when the client calls on_disconnect. """ - if self._logger: - self._client._logger.debug("Client called on_disconnect") + if self.logger: + self._client.logger.debug("Client called on_disconnect") self._connected = False # Call the user-defined on_disconnect callblack if defined if self.on_disconnect is not None: @@ -167,8 +166,8 @@ def _on_disconnect_mqtt(self, client, userdata, return_code): def _on_message_mqtt(self, client, topic, payload): """Runs when the client calls on_message. """ - if self._logger: - self._client._logger.debug("Client called on_message") + if self.logger: + self._client.logger.debug("Client called on_message") if self.on_message is not None: self.on_message(self, topic, payload) @@ -176,8 +175,8 @@ def _on_message_mqtt(self, client, topic, payload): def _on_subscribe_mqtt(self, client, user_data, topic, qos): """Runs when the client calls on_subscribe. """ - if self._logger: - self._client._logger.debug("Client called on_subscribe") + if self.logger: + self._client.logger.debug("Client called on_subscribe") if self.on_subscribe is not None: self.on_subscribe(self, user_data, topic, qos) @@ -185,8 +184,8 @@ def _on_subscribe_mqtt(self, client, user_data, topic, qos): def _on_unsubscribe_mqtt(self, client, user_data, topic, pid): """Runs when the client calls on_unsubscribe. """ - if self._logger: - self._client._logger.debug("Client called on_unsubscribe") + if self.logger: + self._client.logger.debug("Client called on_unsubscribe") if self.on_unsubscribe is not None: self.on_unsubscribe(self, user_data, topic, pid) @@ -319,10 +318,10 @@ def __init__(self, esp, secrets, log=False): raise AttributeError( "Project settings are kept in secrets.py, please add them there!" ) - self._logger = None + self.logger = None if log is True: - self._logger = logging.getLogger("log") - self._logger.setLevel(logging.DEBUG) + self.logger = logging.getLogger("log") + self.logger.setLevel(logging.DEBUG) # Configuration, from secrets file self._proj_id = secrets["project_id"] self._region = secrets["cloud_region"] @@ -340,8 +339,8 @@ def client_id(self): client_id = "projects/{0}/locations/{1}/registries/{2}/devices/{3}".format( self._proj_id, self._region, self._reg_id, self._device_id ) - if self._logger: - self._logger.debug("Client ID: {}".format(client_id)) + if self.logger: + self.logger.debug("Client ID: {}".format(client_id)) return client_id @@ -357,8 +356,8 @@ def generate_jwt(self, ttl=43200, algo="RS256"): print("Generated JWT: ", jwt) """ - if self._logger: - self._logger.debug("Generating JWT...") + if self.logger: + self.logger.debug("Generating JWT...") ntp = NTP.NTP(self._esp) ntp.set_time() claims = {