Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO
Adafruit IO for CircuitPython
https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO
adafruit-io circuitpython hacktoberfest iot mqtt-client rest-client
Last synced: 2 months ago
JSON representation
Adafruit IO for CircuitPython
- Host: GitHub
- URL: https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO
- Owner: adafruit
- License: mit
- Created: 2019-02-19T21:34:02.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T22:27:21.000Z (3 months ago)
- Last Synced: 2024-11-11T20:51:27.833Z (2 months ago)
- Topics: adafruit-io, circuitpython, hacktoberfest, iot, mqtt-client, rest-client
- Language: Python
- Homepage: http://io.adafruit.com
- Size: 359 KB
- Stars: 49
- Watchers: 19
- Forks: 33
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-adafruitio - Adafruit IO CircuitPython Library - A CircuitPython client for Adafruit IO. (Code)
README
Adafruit_CircuitPython_AdafruitIO
=================================.. image:: https://readthedocs.org/projects/adafruit-circuitpython-adafruitio/badge/?version=latest
:target: https://docs.circuitpython.org/projects/adafruitio/en/latest/
:alt: Documentation Status.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord.. image:: https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO/actions/
:alt: Build Status.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: BlackCircuitPython wrapper library for communicating with `Adafruit IO `_.
Dependencies
============This driver depends on:
* `Adafruit CircuitPython `_
* `Adafruit CircuitPython ConnectionManager `_
* `Adafruit CircuitPython MiniMQTT `_Please ensure that 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:.. code-block:: shell
pip3 install adafruit-circuitpython-adafruitio
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-adafruitio
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-adafruitioUsage Example
=============Usage examples for the Adafruit IO HTTP API are within the examples/http folder.
Usage examples for the Adafruit IO MQTT API are within the examples/mqtt 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.