/Adafruit_CircuitPython_AMG88xx

circuit python driver from AMG88xx GRID-EYE 8x8 IR sensor

Primary LanguagePythonMIT LicenseMIT

Introduction

Documentation Status Discord Build Status

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

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

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

sudo pip3 install adafruit-circuitpython-amg88xx

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

Usage Example

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

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:

import board

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

Now, to initialize the I2C bus:

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

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)

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

Pixels can be then be read by doing:

print(amg.pixels)

Documentation

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

Contributing

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

Documentation

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