Introduction

Documentation Status Discord Build Status Code Style: Black

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

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 .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-gc-iot-core

Usage Example

Usage example within examples/ folder.

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

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.

Table of Contents

Examples

Indices and tables