Skip to content

Latest commit

 

History

History
92 lines (56 loc) · 4.38 KB

README.md

File metadata and controls

92 lines (56 loc) · 4.38 KB
Raw

Arduino Sensirion UPT BLE Auto Detection

PlatformIO Registry arduino-library-badge

This library enables you to retrieve live measurements form your own Do-It-Yourself BLE enabled sensor gadget or most Sensirion Gadgets on the ESP32 platform.

Supported Gadgets

  • AQ Minion
  • MyCO2
  • SHT3X Gadget
  • SHT40 Gadget
  • SHT43 Gadget
  • DIY BLE Gadget

Key features are

Please see the example provided as reference on how to use this library.

How to use

Recommended Hardware

This project was developed and tested on Espressif ESP32 DevKitC hardware (see e.g. ESP32-DevKitC-32D). This library requires standard library compatibility. Some boards such as Arduino AVR Uno do not ship with this functionnality.

Arduino

Install the software from the official website and read this short tutorial to get an introduction to the IDE. Next, select your board and port in the Board Manager by following these instructions.

This library can be installed easily using the Arduino Library manager: Start the Arduino IDE and open the Library Manager via

Sketch => Include Library => Manage Libraries...

Search for the Sensirion UPT BLE Auto Detection library in the Filter your search... field and install it by clicking the install button. Make sure to click "Install All", lest you'll have to manually search for and install the dependencies:

Alternatively, the library can also be added manually. To do this, download the latest release from github as a .zip file via

Code => Download Zip

and add it to the Arduino IDE via

Sketch => Include Library => Add .ZIP Library...

In this second case, you'll have to also add all dependencies the same way.

PlatformIO

An often more straightforward alternative to the Arduino IDE is the PlatformIO framework, which is the recommended approach on Linux/Unix systems and is detailed in the following.

The most straight-forward way to use PlatformIO is as an extension to Microsoft's Visual Studio Code, you'll find it easily among the extensions available for it. Please refer to the official installation instructions here.

To use the library, add the following dependencies to your platformio.ini's lib_deps:

lib_deps =
    Sensirion UPT BLE Auto Detection

PlatformIO will automatically fetch the latest version of the dependencies during the build process.

Alternatively, to install this library in your project environment execute the following command in a terminal:

pio pkg install --library "Sensirion UPT BLE Auto Detection"

To test the default example (GetLiveValues), use the following platformio command from the project's root directory (the one containing the platformio.ini file):

pio run -t upload

and start the Serial monitor with

pio device monitor

In case you're using some other board, it is recommended you create a new environment in the platformio.ini file, using the existing environment as a template. Find your board parameter here.

License

See LICENSE.

Credits

This repository is based on the great work of @MBjoern called arduino-ble-sensiscan. Kudos to him !