1.. _adafruit_data_logger_shield:
2
3Adafruit Data Logger Shield
4###########################
5
6Overview
7********
8
9The `Adafruit Data Logger Shield`_ rev. B features an `NXP PCF8523 Real-Time Clock/Calendar with
10Battery Backup`_, an SD card interface, two user LEDs, and a prototyping area.
11
12.. figure:: adafruit_data_logger.jpg
13   :align: center
14   :alt: Adafruit Data Logger Shield
15
16   Adafruit Data Logger Shield (Credit: Adafruit)
17
18.. note::
19   The older revision A of the Adafruit Data Logger Shield is not supported.
20
21Pin Assignments
22===============
23
24+-----------------------+---------------------------------------------+
25| Shield Connector Pin  | Function                                    |
26+=======================+=============================================+
27| D3                    | User LED1 (green) [1]_                      |
28+-----------------------+---------------------------------------------+
29| D4                    | User LED2 (red) [1]_                        |
30+-----------------------+---------------------------------------------+
31| D7                    | PCF8523 RTC INT1 [2]_                       |
32+-----------------------+---------------------------------------------+
33| D10                   | SD card SPI CS                              |
34+-----------------------+---------------------------------------------+
35| D11                   | SD card SPI MOSI                            |
36+-----------------------+---------------------------------------------+
37| D12                   | SD card SPI MISO                            |
38+-----------------------+---------------------------------------------+
39| D13                   | SD card SPI SCK                             |
40+-----------------------+---------------------------------------------+
41| SDA                   | PCF8523 RTC I2C SDA                         |
42+-----------------------+---------------------------------------------+
43| SCL                   | PCF8523 RTC I2C SCL                         |
44+-----------------------+---------------------------------------------+
45
46.. [1] The user LEDs are not connected to ``D3`` and ``D4`` by default. Jumper or jumper wire
47       connections must be established between the ``L1`` and ``Digital I/O 3`` pins for ``LED1``
48       and ``L2`` and ``Digital I/O 4`` pins for ``LED2`` if they are to be used.
49
50.. [2] The PCF8523 RTC ``INT1`` interrupt output pin is not connected to ``D7`` by default. A jumper
51       wire connection must be established between the ``SQ`` pin and the ``Digital I/O 7`` pin in
52       order to use the RTC interrupt functionality (i.e. alarm callback, 1 pulse per second
53       callback). The ``INT1`` interrupt output is open-drain, but the shield definition enables an
54       internal GPIO pull-up and thus no external pull-up resistor is needed.
55
56Requirements
57************
58
59This shield can only be used with a board which provides a configuration for Arduino connectors and
60defines node aliases for SPI and GPIO interfaces (see :ref:`shields` for more details).
61
62Programming
63***********
64
65Set ``--shield adafruit_data_logger`` when you invoke ``west build``. For example:
66
67.. zephyr-app-commands::
68   :zephyr-app: tests/drivers/rtc/rtc_api
69   :board: frdm_k64f
70   :shield: adafruit_data_logger
71   :goals: build
72
73.. _Adafruit Data Logger Shield:
74   https://learn.adafruit.com/adafruit-data-logger-shield/
75
76.. _NXP PCF8523 Real-Time Clock/Calendar with Battery Backup:
77   https://www.nxp.com/docs/en/data-sheet/PCF8523.pdf
78