Reference > Libraries > Arduino bhy2

Arduino_BHY2

Sensors

Library for BHI260AP and BME688 chip on the Nicla Sense ME
Provides the APIs for Nicla Sense ME board to make a DFU or configure/read BHI260AP (BHY2) and BME688 sensors. All these operations can be done either via ESLOV or BLE.

Compatibility

This library is compatible with the mbed, mbed_nicla architectures.

Releases

To use this library, open the Library Manager in the Arduino IDE and install it from there.

Usage

This library allows the Nicla Sense ME to interface with the onboard 6-axis IMU (BHI260AP) and environmental sensor (BME688).

Features

  • Easy access to data from Nicla Sense ME sensors using sensor ID
  • Wrapper for Bosch BHY2-Sensor-API
  • DFU (Device Firmware Update) of the ANNA-B112 and the BHI260AP
  • All functionality available over both ESLOV and BLE

Usage

The ArduinoBLE library needs to be installed, for the BLE features to function.

To use this library, use this code at the top of your sketch

#include <Arduino_BHY2.h>

Note If no wired connection is used, we can set the state of NiclaWiring to false. Also, a modified delay using the millis() function similar to the BlinkWithoutDelay.ino sketch is used.

Methods interacting with the sensor, such as configureSensor() and readSensorData(), calls methods defined by the sensortec class which are defined in BoschSensortec.h. The sensortec class itself calls methods developed by the Bosch BHY2-Sensor-API library and mirrored in the bosch folder. Motion data is parsed from the DataParser class (defined in sensors/DataParser.h). The debug() method checks the state of NiclaConfig and then calls the related method to start .debug(stream) using eslovHandler or BLEHandler class, together with sensortec, dfuManager and BoschParser.

IMU sensor objects are defined as objects of SensorXYZ. IMU readings in quaternion format are defined in SensorQuaternion.h. Activity recognition (obtained from the on-chip AI processor) in SensorActivity.h. Pressure, temperature and gas values are defined in Sensor.h. The relevant IDs are defined in SensorID.h.

A UML diagram of the main library classes are provided in the diagram below, provided as an editable SVG file.

Arduino_BHY2 Library UML Diagram

For additional information on the Arduino_BHY2 library (including a list of Sensor IDs) and how you can use it with the Nicla Sense ME, see the Arduino Nicla Sense ME Cheat Sheet page.

Examples

  • App : Control Nicla Sense ME from an external device acting as a host via I2C or ESLOV
  • AppLowDelay : Control Nicla Sense ME from an external device acting as a host via I2C or ESLOV with a lower delay
  • BHYFirmwareUpdate : Update BHI260 firmware to latest version. Can also be used to upload custom firmware binary.
  • Fail_Safe_flasher : Fail Safe flashing of a RGB blink sketch. Writes binary file to the SPI flash, then performs CRC to ensure successful writing of binary file to flash memory.
  • ReadSensorConfiguration : Send sample rate, latency and range for accelerator, gyroscope, rotation, temperature and gas sensor over Serial
  • ShowSensorList : List sensors of the Nicla Sense ME board
  • Standalone : Read motion, temperature and gas data and send over Serial
  • StandaloneFlashStorage : Save accelerator, gryoscope, temperature, gas and rotation sensor values to the onboard SPI flash in a .CSV file.

License

See LICENSE.txt