adafruit-circuitpython-amg88xx


Nameadafruit-circuitpython-amg88xx JSON
Version 1.2.22 PyPI version JSON
download
home_pageNone
SummaryCircuitPython library for AMG88xx thermal camera.
upload_time2024-10-10 15:52:39
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit thermal camera featherwing temperature breakout 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-amg88xx/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/amg88xx/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_AMG88xx/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_AMG88xx/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


Adafruit CircuitPython module for the AMG88xx GRID-Eye IR 8x8 thermal camera.

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>`_

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

Installing from PyPI
====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-amg88xx/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-amg88xx

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-amg88xx

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-amg88xx

Usage Example
=============

Of course, you must import the library to use it:

.. code-block:: python

    import busio
    import adafruit_amg88xx

The way to create an I2C object depends on the board you are using. For boards with labeled SCL and SDA pins, you can:

.. code-block:: python

    import board

You can also use pins defined by the onboard microcontroller through the microcontroller.pin module.

Now, to initialize the I2C bus:

.. code-block:: python

    i2c_bus = busio.I2C(board.SCL, board.SDA)

Once you have created the I2C interface object, you can use it to instantiate the AMG88xx object

.. code-block:: python

    amg = adafruit_amg88xx.AMG88XX(i2c_bus)

You can also optionally use the alternate i2c address (make sure to solder the jumper on the back of the board if you want to do this)

.. code-block:: python

    amg = adafruit_amg88xx.AMG88XX(i2c_bus, addr=0x68)

Pixels can be then be read by doing:

.. code-block:: python

    print(amg.pixels)


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

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/amg88xx/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_LIS3DH/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-amg88xx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, thermal, camera, featherwing, temperature, breakout, hardware, micropython, circuitpython",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/14/62/ca7c7b7624c2f08a7658f20bfb63ae73cfb06c8d1618880fec1ef99198d0/adafruit_circuitpython_amg88xx-1.2.22.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-amg88xx/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/amg88xx/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_AMG88xx/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_AMG88xx/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\n\nAdafruit CircuitPython module for the AMG88xx GRID-Eye IR 8x8 thermal camera.\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\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-amg88xx/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-amg88xx\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-amg88xx\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .venv\n    source .venv/bin/activate\n    pip3 install adafruit-circuitpython-amg88xx\n\nUsage Example\n=============\n\nOf course, you must import the library to use it:\n\n.. code-block:: python\n\n    import busio\n    import adafruit_amg88xx\n\nThe way to create an I2C object depends on the board you are using. For boards with labeled SCL and SDA pins, you can:\n\n.. code-block:: python\n\n    import board\n\nYou can also use pins defined by the onboard microcontroller through the microcontroller.pin module.\n\nNow, to initialize the I2C bus:\n\n.. code-block:: python\n\n    i2c_bus = busio.I2C(board.SCL, board.SDA)\n\nOnce you have created the I2C interface object, you can use it to instantiate the AMG88xx object\n\n.. code-block:: python\n\n    amg = adafruit_amg88xx.AMG88XX(i2c_bus)\n\nYou can also optionally use the alternate i2c address (make sure to solder the jumper on the back of the board if you want to do this)\n\n.. code-block:: python\n\n    amg = adafruit_amg88xx.AMG88XX(i2c_bus, addr=0x68)\n\nPixels can be then be read by doing:\n\n.. code-block:: python\n\n    print(amg.pixels)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/amg88xx/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_LIS3DH/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for AMG88xx thermal camera.",
    "version": "1.2.22",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_AMG88xx"
    },
    "split_keywords": [
        "adafruit",
        " thermal",
        " camera",
        " featherwing",
        " temperature",
        " breakout",
        " hardware",
        " micropython",
        " circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf6858f3584a8ce97012d654ce03885ca9a0f43311fb1dc24cae43d9d6ba7776",
                "md5": "8fc4c5f507767bf0ae2a47f26ad5c802",
                "sha256": "4f219557b341efd96f304489e2d4ee188442b4f5326bf3d188420b7dd345b21d"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_amg88xx-1.2.22-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8fc4c5f507767bf0ae2a47f26ad5c802",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5675,
            "upload_time": "2024-10-10T15:52:37",
            "upload_time_iso_8601": "2024-10-10T15:52:37.952236Z",
            "url": "https://files.pythonhosted.org/packages/bf/68/58f3584a8ce97012d654ce03885ca9a0f43311fb1dc24cae43d9d6ba7776/adafruit_circuitpython_amg88xx-1.2.22-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1462ca7c7b7624c2f08a7658f20bfb63ae73cfb06c8d1618880fec1ef99198d0",
                "md5": "6e15479c8ed8a28cd6d5df65250faadb",
                "sha256": "eb8f59e499ac633b623bf024fa4db8f4821f2273b82a3b328711a696b2e22661"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_amg88xx-1.2.22.tar.gz",
            "has_sig": false,
            "md5_digest": "6e15479c8ed8a28cd6d5df65250faadb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 30268,
            "upload_time": "2024-10-10T15:52:39",
            "upload_time_iso_8601": "2024-10-10T15:52:39.519449Z",
            "url": "https://files.pythonhosted.org/packages/14/62/ca7c7b7624c2f08a7658f20bfb63ae73cfb06c8d1618880fec1ef99198d0/adafruit_circuitpython_amg88xx-1.2.22.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-10 15:52:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_AMG88xx",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-amg88xx"
}
        
Elapsed time: 0.35531s