ZMOD4510 Nitrogen Dioxide and Ozone Firmware Documentation |

Overview

This document describes the libraries for the ZMOD4510 gas sensor module using the Ozone and Nitrogen Dioxide algorithm for air quality measurements in ultra-low power mode (ULP). This algorithm is recommended for accurate and consistent ozone and nitrogen dioxide concentration as well as Air Quality Index (AQI) measurement.

The firmware package includes an example that can be compiled for the use with an EVK board which is connected to a host computer or for an Raspberry Pi. In addition an Arduino library is provided, that allows using the gas sensor on the Arduino MKRZERO.

The figure below shows an overview of the ZMOD4xxx API, programming example and libraries.

If required, the example can be adapted to run on customer specific hardware. For the adaption to the customer hardware, this firmware packages provides a HAL template in hal/custom/template.c. Please refer to the documentation of this file, and the HAL API documentation. Note that some of the HAL functions may not be required by specific sensors. Please refer to the HAL API Requirements section of the sensor you're trying to interface. Refer to the ZMOD4510 Programming Manual - Read Me for further information regarding sample code.

Please use the navigation bar above to navigate through the reference documentation of the different APIs.

# Folder Structure

- `src`: Source code directory, including a Makefile for below mentioned binaries
  - `sensors`: Headers and sources for different sensors
  - `hal`: Headers, sources and libraries for hardware abstraction
  - `algos`: Headers for algorithm and cleaning library
- `lib`: Precompiled algorithm libraries
- `doc`: Documentation
- `windows`: Pre-compiled example application for the EVK board on a 64-bit Windows platform
- `raspberrypi`: Pre-compiled example application for Raspberry-Pi, using the PiGPIO library
- `arduino`: Arduino library for installation in Arduino IDE (including fully working example code)

Note
  Root privileges are required to execute the Raspbery-Pi example program.