Skip to content
Google Cloud IoT Core client for CircuitPython devices
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs require Adafruit_NTP instead of dep. on Adafruit IO. Remove _get_loca… Aug 22, 2019
examples cleanup old time code Aug 23, 2019
.gitignore
.pylintrc add all code from previous library, re-cookiecut Aug 22, 2019
.readthedocs.yml
.travis.yml
CODE_OF_CONDUCT.md
LICENSE
README.rst
adafruit_gc_iot_core.py Fix GitHub repository information to correct URL. Sep 3, 2019
requirements.txt add all code from previous library, re-cookiecut Aug 22, 2019
setup.py

README.rst

Introduction

Documentation Status Discord Build Status

Google Cloud IoT Core Client for CircuitPython

Dependencies

This driver depends on:

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:

pip3 install adafruit-circuitpython-gc-iot-core

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-gc-iot-core

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-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):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

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.

You can’t perform that action at this time.