boards: shields: Adding a new amg88xx shield

Added the new amg88xx sensor shield with designation
amg88xx_grid_eye_eval_shield and updated the overlay, Kconfig and
documentation files accordingly.
The platforms that are compatible with new shield changed, so
sensor sample yaml file was extended for both available shields.

Signed-off-by: Steffen Jahnke <steffen.jahnke@eu.panasonic.com>
This commit is contained in:
Steffen Jahnke 2022-12-21 06:53:32 +01:00 committed by Fabio Baltieri
commit 39b50ee37c
7 changed files with 170 additions and 44 deletions

View file

@ -2,5 +2,8 @@
#
# SPDX-License-Identifier: Apache-2.0
config SHIELD_AMG88XX_GRID_EYE_EVAL_SHIELD
def_bool $(shields_list_contains,amg88xx_grid_eye_eval_shield)
config SHIELD_AMG88XX_EVAL_KIT
def_bool $(shields_list_contains,amg88xx_eval_kit)

View file

@ -0,0 +1,15 @@
/*
* Copyright (c) 2022 Panasonic Industrial Devices Europe GmbH
* SPDX-License-Identifier: Apache-2.0
*/
&arduino_i2c {
status = "okay";
amg88xx_amg88xx_grid_eye_eval_shield: amg88xx@68 {
compatible = "panasonic,amg88xx";
reg = <0x68>;
/* Pin D2 from Arduino Connector */
int-gpios = <&arduino_header 8 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>;
status = "okay";
};
};

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

View file

@ -1,63 +1,159 @@
.. _amg88xx_shields:
Panasonic Grid-EYE (AMG88xx) Shields
####################################
Panasonic Grid-EYE Shields
##########################
Overview
********
The Panasonic AMG88XX is an 8x8 (64) pixel infrared array sensor available
only in a SMD design. Here are two sources for easily working with this sensor:
The Panasonic Grid-EYE is an infra-red sensor, which is comprised of 64
individual thermopile elements arranged in an 8x8 matrix.
The sensor comes in a compact surface mount package and can be very easily
integrated into thermometry applications.
Grid-EYE is available in different varieties which differ in field of view,
amplification factor and operating voltages. For example AMG8833 features a 60
degree field of view, a high gain amplification factor and 3.3V operating
voltage.
For the different part numbers that follow the AMG88xx scheme please refer to
`IR Thermophile Array Sensor - Grid-EYE`_.
For sensor evaluation and rapid prototyping multiple shields are available:
- `Panasonic Grid-EYE Evaluation Shield`_
.. figure:: AMG88XX_panasonic_grid_eye_evaluation_shield.png
:width: 300px
:align: center
:alt: Panasonic Grid-EYE Evaluation Shield
- `AMG88xx Evaluation Kit`_
- `Adafruit AMG8833 8x8 Thermal Camera Sensor`_
Current supported shields
=========================
.. figure:: AMG8833_adafruit_ir_thermal_camera_sensor.png
:width: 200px
:align: center
:alt: Adafruit AMG8833 8x8 Thermal Camera Sensor
+--------------------------------+--------------------------------+
| Name | Shield Designation |
| | |
+================================+================================+
| AMG88xx Evaluation Kit | amg88xx_eval_kit |
+--------------------------------+--------------------------------+
Please note that the former follows the Arduino shield standard, while the
latter is a breakout board only. Please use the ``amg88xx_grid_eye_eval_shield``
Grid-EYE shield designation for these boards.
Requirements AMG88xx Evaluation Kit
***********************************
For the Panasonic Grid-EYE sensor an older evaluation kit was available, that
also could be used as an Arduino shield.
On the AMG88xx Evaluation Kit, all jumpers except the J11 and J14 must be removed.
This shield can only be used with a board that provides a configuration
for Arduino connectors and defines node aliases for I2C and GPIO interfaces
(see :ref:`shields` for more details).
- Panasonic Grid-EYE Evaluation Kit
Pins Assignment of the AMG88xx Evaluation Kit Shield
====================================================
.. figure:: AMG88XX_panasonic_grid_eye_evaluation_kit.png
:width: 250px
:align: center
:alt: Panasonic Grid-EYE Evaluation Kit (deprecated)
+-----------------------+------------+----------------------------+
| Shield Connector Pin | Function | |
+=======================+============+============================+
| D6 | INT | AMG88xx INT Pin |
+-----------------------+------------+----------------------------+
| D14 | I2C SDA | AMG88xx SDA Pin |
+-----------------------+------------+----------------------------+
| D15 | I2C SCL | AMG88xx SCL Pin |
+-----------------------+------------+----------------------------+
Please note that this evaluation kit is no longer available and no online
documentation is available anymore. Please use the ``amg88xx_eval_kit``
Grid-EYE shield designation for this board instead.
The same shield designation can also be used with breakout boards like
`Adafruit AMG8833 8x8 Thermal Camera Sensor`_. The wires should be connected
according to the table above.
Requirements
************
Programming
***********
These shields can only be used with a board that has Arduino connectors and
where node aliases for I2C and GPIO interfaces are correctly defined in the
board's device tree.
Correct shield designation (see the table above) for your shield must
be entered when you invoke ``west build``.
For example:
This is true for example for Panasonic's PAN1780/PAN1770, PAN1781 and PAN1782
evaluation boards (`Panasonic Wireless Connectivity Development Hub`_).
Jumper Configuration
********************
Panasonic Grid-EYE Evaluation Shield
====================================
The Grid-EYE sensor is powered using a LDO. Make sure to set a jumper on
P10: LDO_EN.
A jumper on P11 configures the I2C address selection.
When you use the ``amg88xx_grid_eye_eval_shield`` Grid-EYE shield designation
make sure to use the following jumper configurations:
* P10: LDO_EN
* P11: AD 0x68
Panasonic Grid-EYE Evaluation Kit
=================================
On the AMG88xx Evaluation Kit, all jumpers except the J11 and J14 must be
removed.
Pin Assignment
**************
Panasonic Grid-EYE Evaluation Shield
====================================
The following table shows the complete pin assignment of the Grid-EYE
Evaluation Shield.
+---------------------------+-----------------+
| Shield Connector Pin | Function |
+===========================+=================+
| D2 | Interrupt |
+---------------------------+-----------------+
| D14 | I2C SDA |
+---------------------------+-----------------+
| D15 | I2C SCL |
+---------------------------+-----------------+
| Power supply header pin 5 | 5V Power Supply |
+---------------------------+-----------------+
| Power supply header pin 6 | GND |
+---------------------------+-----------------+
| Power supply header pin 7 | GND |
+---------------------------+-----------------+
For more detailed information please refer to
`Panasonic Grid-EYE Evaluation Shield`_.
For the `Adafruit AMG8833 8x8 Thermal Camera Sensor`_ breakout board you can
use the ``amg88xx_grid_eye_eval_shield`` shield designation as well.
The wiring has to be done according to
`Adafruit AMG8833 8x8 Thermal Camera Sensor Pinouts`_ and the pin assignment
table mentioned above.
Panasonic Grid-EYE Evaluation Kit
=================================
The following table shows the complete pin assignment of the Grid-EYE
Evaluation Kit.
+---------------------------+-----------------+
| Shield Connector Pin | Function |
+===========================+=================+
| D6 | Interrupt |
+---------------------------+-----------------+
| D14 | I2C SDA |
+---------------------------+-----------------+
| D15 | I2C SCL |
+---------------------------+-----------------+
Building
********
The ``samples/sensor/amg88xx`` application demonstrates the basic usage of the
Panasonic Grid-EYE sensor.
If you want to build the application you have to use the
``-DSHIELD=amg88xx_grid_eye_eval_shield`` shield designation accordingly when
you invoke ``west build``.
When using the PAN1780 evaluation board the build invocation looks like this:
.. zephyr-app-commands::
:zephyr-app: samples/sensor/amg88xx
:board: nrf52840dk_nrf52840
:shield: amg88xx_eval_kit
:board: pan1780_evb
:shield: amg88xx_grid_eye_eval_shield
:goals: build
References
@ -65,7 +161,8 @@ References
.. target-notes::
- https://eu.industrial.panasonic.com/products/sensors-optical-devices/sensors-automotive-and-industrial-applications/infrared-array
.. _`AMG88xx Evaluation Kit`: https://eu.industrial.panasonic.com/grideye-evalkit
.. _`IR Thermophile Array Sensor - Grid-EYE`: https://industry.panasonic.eu/products/components/sensors/ir-thermophile-array-sensor-grid-eye
.. _`Panasonic Grid-EYE Evaluation Shield`: https://industry.panasonic.eu/products/components/sensors/ir-thermophile-array-sensor-grid-eye/grid-eye-evaluation-kit
.. _`Panasonic Wireless Connectivity Development Hub`: https://pideu.panasonic.de/development-hub/
.. _`Adafruit AMG8833 8x8 Thermal Camera Sensor`: https://learn.adafruit.com/adafruit-amg8833-8x8-thermal-camera-sensor/overview
.. _`Adafruit AMG8833 8x8 Thermal Camera Sensor Pinouts`: https://learn.adafruit.com/adafruit-amg8833-8x8-thermal-camera-sensor/pinouts

View file

@ -1,8 +1,19 @@
common:
tags: sensors
sample:
description: AMG88XX sensor sample
name: AMG88XX sample
tests:
sample.sensor.amg88xx:
sample.sensor.amg88xx.amg88xx_grid_eye_eval_shield:
build_only: true
depends_on: arduino_i2c arduino_gpio
platform_allow: pan1780_evb pan1770_evb pan1781_evb pan1782_evb
integration_platforms:
- pan1780_evb
extra_args: SHIELD=amg88xx_grid_eye_eval_shield
extra_configs:
- CONFIG_AMG88XX_TRIGGER_GLOBAL_THREAD=y
sample.sensor.amg88xx.amg88xx_eval_kit:
build_only: true
depends_on:
- arduino_i2c