1.. _amg88xx_shields:
2
3Panasonic Grid-EYE Shields
4##########################
5
6Overview
7********
8
9The Panasonic Grid-EYE is an infra-red sensor, which is comprised of 64
10individual thermopile elements arranged in an 8x8 matrix.
11
12The sensor comes in a compact surface mount package and can be very easily
13integrated into thermometry applications.
14
15Grid-EYE is available in different varieties which differ in field of view,
16amplification factor and operating voltages. For example AMG8833 features a 60
17degree field of view, a high gain amplification factor and 3.3V operating
18voltage.
19
20For the different part numbers that follow the AMG88xx scheme please refer to
21`IR Thermophile Array Sensor - Grid-EYE`_.
22
23For sensor evaluation and rapid prototyping multiple shields are available:
24
25- `Panasonic Grid-EYE Evaluation Shield`_
26
27 .. figure:: AMG88XX_panasonic_grid_eye_evaluation_shield.png
28     :width: 300px
29     :align: center
30     :alt: Panasonic Grid-EYE Evaluation Shield
31
32- `Adafruit AMG8833 8x8 Thermal Camera Sensor`_
33
34 .. figure:: AMG8833_adafruit_ir_thermal_camera_sensor.png
35      :width: 200px
36      :align: center
37      :alt: Adafruit AMG8833 8x8 Thermal Camera Sensor
38
39Please note that the former follows the Arduino shield standard, while the
40latter is a breakout board only. Please use the ``amg88xx_grid_eye_eval_shield``
41Grid-EYE shield designation for these boards.
42
43For the Panasonic Grid-EYE sensor an older evaluation kit was available, that
44also could be used as an Arduino shield.
45
46- Panasonic Grid-EYE Evaluation Kit
47
48 .. figure:: AMG88XX_panasonic_grid_eye_evaluation_kit.png
49      :width: 250px
50      :align: center
51      :alt: Panasonic Grid-EYE Evaluation Kit (deprecated)
52
53Please note that this evaluation kit is no longer available and no online
54documentation is available anymore. Please use the ``amg88xx_eval_kit``
55Grid-EYE shield designation for this board instead.
56
57Requirements
58************
59
60These shields can only be used with a board that has Arduino connectors and
61where node aliases for I2C and GPIO interfaces are correctly defined in the
62board's device tree.
63
64This is true for example for Panasonic's PAN1780/PAN1770, PAN1781 and PAN1782
65evaluation boards (`Panasonic Wireless Connectivity Development Hub`_).
66
67Jumper Configuration
68********************
69
70Panasonic Grid-EYE Evaluation Shield
71====================================
72
73The Grid-EYE sensor is powered using a LDO. Make sure to set a jumper on
74P10: LDO_EN.
75
76A jumper on P11 configures the I2C address selection.
77
78When you use the ``amg88xx_grid_eye_eval_shield`` Grid-EYE shield designation
79make sure to use the following jumper configurations:
80
81* P10: LDO_EN
82* P11: AD 0x68
83
84Panasonic Grid-EYE Evaluation Kit
85=================================
86
87On the AMG88xx Evaluation Kit, all jumpers except the J11 and J14 must be
88removed.
89
90Pin Assignment
91**************
92
93Panasonic Grid-EYE Evaluation Shield
94====================================
95
96The following table shows the complete pin assignment of the Grid-EYE
97Evaluation Shield.
98
99+---------------------------+-----------------+
100| Shield Connector Pin      | Function        |
101+===========================+=================+
102| D2                        | Interrupt       |
103+---------------------------+-----------------+
104| D14                       | I2C SDA         |
105+---------------------------+-----------------+
106| D15                       | I2C SCL         |
107+---------------------------+-----------------+
108| Power supply header pin 5 | 5V Power Supply |
109+---------------------------+-----------------+
110| Power supply header pin 6 | GND             |
111+---------------------------+-----------------+
112| Power supply header pin 7 | GND             |
113+---------------------------+-----------------+
114
115For more detailed information please refer to
116`Panasonic Grid-EYE Evaluation Shield`_.
117
118For the `Adafruit AMG8833 8x8 Thermal Camera Sensor`_ breakout board you can
119use the ``amg88xx_grid_eye_eval_shield`` shield designation as well.
120
121The wiring has to be done according to
122`Adafruit AMG8833 8x8 Thermal Camera Sensor Pinouts`_ and the pin assignment
123table mentioned above.
124
125Panasonic Grid-EYE Evaluation Kit
126=================================
127
128The following table shows the complete pin assignment of the Grid-EYE
129Evaluation Kit.
130
131+---------------------------+-----------------+
132| Shield Connector Pin      | Function        |
133+===========================+=================+
134| D6                        | Interrupt       |
135+---------------------------+-----------------+
136| D14                       | I2C SDA         |
137+---------------------------+-----------------+
138| D15                       | I2C SCL         |
139+---------------------------+-----------------+
140
141Building
142********
143
144The ``samples/sensor/amg88xx`` application demonstrates the basic usage of the
145Panasonic Grid-EYE sensor.
146
147If you want to build the application you have to use the
148``-DSHIELD=amg88xx_grid_eye_eval_shield`` shield designation accordingly when
149you invoke ``west build``.
150
151When using the PAN1780 evaluation board the build invocation looks like this:
152
153.. zephyr-app-commands::
154   :zephyr-app: samples/sensor/amg88xx
155   :board: pan1780_evb
156   :shield: amg88xx_grid_eye_eval_shield
157   :goals: build
158
159References
160**********
161
162.. target-notes::
163
164.. _`IR Thermophile Array Sensor - Grid-EYE`: https://industry.panasonic.eu/products/components/sensors/ir-thermophile-array-sensor-grid-eye
165.. _`Panasonic Grid-EYE Evaluation Shield`: https://industry.panasonic.eu/products/components/sensors/ir-thermophile-array-sensor-grid-eye/grid-eye-evaluation-kit
166.. _`Panasonic Wireless Connectivity Development Hub`: https://pideu.panasonic.de/development-hub/
167.. _`Adafruit AMG8833 8x8 Thermal Camera Sensor`: https://learn.adafruit.com/adafruit-amg8833-8x8-thermal-camera-sensor/overview
168.. _`Adafruit AMG8833 8x8 Thermal Camera Sensor Pinouts`: https://learn.adafruit.com/adafruit-amg8833-8x8-thermal-camera-sensor/pinouts
169