adafruit-circuitpython-clue


Nameadafruit-circuitpython-clue JSON
Version 3.2.0 PyPI version JSON
download
home_pageNone
SummaryA high-level library representing all the features of the Adafruit CLUE
upload_time2024-11-13 18:26:58
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit clue microbit microcontroller hardware micropython circuitpython
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-clue/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/clue/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_CLUE/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_CLUE/actions
    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

A high level library representing all the features of the Adafruit CLUE


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
* `Adafruit LSM6DS <https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS>`_
* `Adafruit LIS3MDL <https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL>`_
* `Adafruit APDS9960 <https://github.com/adafruit/Adafruit_CircuitPython_APDS9960>`_
* `Adafruit BMP280 <https://github.com/adafruit/Adafruit_CircuitPython_BMP280>`_
* `Adafruit SHT31D <https://github.com/adafruit/Adafruit_CircuitPython_SHT31D>`_
* `Adafruit NeoPixel <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel>`_
* `Adafruit Display Text <https://github.com/adafruit/Adafruit_CircuitPython_Display_Text>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.

Demos may require libraries not listed here.

Usage Example
=============
This example displays sensor and input data on the CLUE display.

.. code-block:: python

    from adafruit_clue import clue

    clue.sea_level_pressure = 1020

    clue_data = clue.simple_text_display(title="CLUE Sensor Data!", title_scale=2, num_lines=15)

    while True:
        clue_data[0].text = "Acceleration: {:.2f} {:.2f} {:.2f}".format(*clue.acceleration)
        clue_data[1].text = "Gyro: {:.2f} {:.2f} {:.2f}".format(*clue.gyro)
        clue_data[2].text = "Magnetic: {:.3f} {:.3f} {:.3f}".format(*clue.magnetic)
        clue_data[3].text = "Pressure: {:.3f}hPa".format(clue.pressure)
        clue_data[4].text = "Altitude: {:.1f}m".format(clue.altitude)
        clue_data[5].text = "Temperature: {:.1f}C".format(clue.temperature)
        clue_data[6].text = "Humidity: {:.1f}%".format(clue.humidity)
        clue_data[7].text = "Proximity: {}".format(clue.proximity)
        clue_data[8].text = "Gesture: {}".format(clue.gesture)
        clue_data[9].text = "Color: R: {} G: {} B: {} C: {}".format(*clue.color)
        clue_data[10].text = "Button A: {}".format(clue.button_a)
        clue_data[11].text = "Button B: {}".format(clue.button_b)
        clue_data[12].text = "Touch 0: {}".format(clue.touch_0)
        clue_data[13].text = "Touch 1: {}".format(clue.touch_1)
        clue_data[14].text = "Touch 2: {}".format(clue.touch_2)
        clue_data.show()


Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/clue/en/latest/>`_.

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_CLUE/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-clue",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, clue, microbit, microcontroller, hardware, micropython, circuitpython",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/6c/ec/e0d202a3b391929fe065102ed1a632e43ec32076346da28b2794a646cc7c/adafruit_circuitpython_clue-3.2.0.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-clue/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/clue/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_CLUE/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_CLUE/actions\n    :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n\nA high level library representing all the features of the Adafruit CLUE\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n* `Adafruit LSM6DS <https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS>`_\n* `Adafruit LIS3MDL <https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL>`_\n* `Adafruit APDS9960 <https://github.com/adafruit/Adafruit_CircuitPython_APDS9960>`_\n* `Adafruit BMP280 <https://github.com/adafruit/Adafruit_CircuitPython_BMP280>`_\n* `Adafruit SHT31D <https://github.com/adafruit/Adafruit_CircuitPython_SHT31D>`_\n* `Adafruit NeoPixel <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel>`_\n* `Adafruit Display Text <https://github.com/adafruit/Adafruit_CircuitPython_Display_Text>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.\n\nDemos may require libraries not listed here.\n\nUsage Example\n=============\nThis example displays sensor and input data on the CLUE display.\n\n.. code-block:: python\n\n    from adafruit_clue import clue\n\n    clue.sea_level_pressure = 1020\n\n    clue_data = clue.simple_text_display(title=\"CLUE Sensor Data!\", title_scale=2, num_lines=15)\n\n    while True:\n        clue_data[0].text = \"Acceleration: {:.2f} {:.2f} {:.2f}\".format(*clue.acceleration)\n        clue_data[1].text = \"Gyro: {:.2f} {:.2f} {:.2f}\".format(*clue.gyro)\n        clue_data[2].text = \"Magnetic: {:.3f} {:.3f} {:.3f}\".format(*clue.magnetic)\n        clue_data[3].text = \"Pressure: {:.3f}hPa\".format(clue.pressure)\n        clue_data[4].text = \"Altitude: {:.1f}m\".format(clue.altitude)\n        clue_data[5].text = \"Temperature: {:.1f}C\".format(clue.temperature)\n        clue_data[6].text = \"Humidity: {:.1f}%\".format(clue.humidity)\n        clue_data[7].text = \"Proximity: {}\".format(clue.proximity)\n        clue_data[8].text = \"Gesture: {}\".format(clue.gesture)\n        clue_data[9].text = \"Color: R: {} G: {} B: {} C: {}\".format(*clue.color)\n        clue_data[10].text = \"Button A: {}\".format(clue.button_a)\n        clue_data[11].text = \"Button B: {}\".format(clue.button_b)\n        clue_data[12].text = \"Touch 0: {}\".format(clue.touch_0)\n        clue_data[13].text = \"Touch 1: {}\".format(clue.touch_1)\n        clue_data[14].text = \"Touch 2: {}\".format(clue.touch_2)\n        clue_data.show()\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/clue/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_CLUE/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A high-level library representing all the features of the Adafruit CLUE",
    "version": "3.2.0",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_CLUE"
    },
    "split_keywords": [
        "adafruit",
        " clue",
        " microbit",
        " microcontroller",
        " hardware",
        " micropython",
        " circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68cb7f3f699ac2e7846186ee8dd6697ead8c7a6a8697c7e675aefcbc325046b1",
                "md5": "4ec666506c341b551f67728de31198c2",
                "sha256": "ebb4af0332523826a240e4389d9fe1bcdad1c825f236573d664438cd11e4b646"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_clue-3.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4ec666506c341b551f67728de31198c2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 11053,
            "upload_time": "2024-11-13T18:26:56",
            "upload_time_iso_8601": "2024-11-13T18:26:56.929522Z",
            "url": "https://files.pythonhosted.org/packages/68/cb/7f3f699ac2e7846186ee8dd6697ead8c7a6a8697c7e675aefcbc325046b1/adafruit_circuitpython_clue-3.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6cece0d202a3b391929fe065102ed1a632e43ec32076346da28b2794a646cc7c",
                "md5": "944c618a8716ee6e957ff3bf0a9a1646",
                "sha256": "628d1b0b586552a4e27a4fcbbaab6dd7994aea85d32d7a1ced95993bfc3dec49"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_clue-3.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "944c618a8716ee6e957ff3bf0a9a1646",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 17767796,
            "upload_time": "2024-11-13T18:26:58",
            "upload_time_iso_8601": "2024-11-13T18:26:58.802577Z",
            "url": "https://files.pythonhosted.org/packages/6c/ec/e0d202a3b391929fe065102ed1a632e43ec32076346da28b2794a646cc7c/adafruit_circuitpython_clue-3.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-13 18:26:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_CLUE",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-clue"
}
        
Elapsed time: 0.45506s