boards/shields/mikroe_weather_click/doc/index.rst

.. _mikroe_weather_click_shield:

MikroElektronika Weather Click
##############################

Overview
********

The MikroElektronika `Weather Click`_ features the `BME280`_ integrated
environmental sensor in a `mikroBUS`_ |trade| form factor. The sensor can
measure relative humidity, barometric pressure, and ambient temperature.

.. figure:: weather-click.webp
   :align: center
   :alt: MikroElektronika Weather Click

   MikroElektronika Weather Click (Credit: MikroElektronika)

Requirements
************

This shield can only be used with a board that provides a mikroBUS |trade|
socket and defines a ``mikrobus_i2c`` node label for the mikroBUS |trade| I2C
interface (see :ref:`shields` for more details).

For more information about the BME280 and the Weather Click, see the following
documentation:

- `Weather Click`_
- `Weather Click Schematic`_
- `BME280`_
- `BME280 Datasheet`_

Programming
***********

Set ``-DSHIELD=mikroe_weather_click`` when you invoke ``west build``. For
example:

.. zephyr-app-commands::
   :zephyr-app: samples/sensor/bme280
   :board: lpcxpresso55s16
   :shield: mikroe_weather_click
   :goals: build

.. _Weather Click:
   https://www.mikroe.com/weather-click

.. _Weather Click Schematic:
   https://download.mikroe.com/documents/add-on-boards/click/weather/weather-click-schematic-v101.pdf

.. _BME280:
   https://www.bosch-sensortec.com/products/environmental-sensors/humidity-sensors-bme280/

.. _BME280 Datasheet:
   https://www.bosch-sensortec.com/media/boschsensortec/downloads/datasheets/bst-bme280-ds002.pdf

.. _mikroBUS:
   https://www.mikroe.com/mikrobus