Firmware Documentation

Overview

The RRH46410 Firmware Package provides a set of APIs to access the RRH46410 sensor and optionally an Renesas humidity sensor along with an example of how to configure and use these sensors in an application.

The example 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 RRH46410 gas sensor module on the Arduino platform.

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.

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
• doc: Documentation
• windows: Pre-compiled example for the EVK board on a 64-bit Windows platform
• raspberrypi: Pre-compiled example for the 32 bit Raspberry-Pi, using the PiGPIO library
• arduino: Arduino library for installation in Arduino IDE (including fully working example code)

Building

Windows

The Windows build assumes the availability of the w64devkit build tools. w64devkit requires no installation. Please follow the instructions below to build the example code for Windows:

• Unzip contents of the RRH46410-Firmware.zip to a location of your choice, e.g. C:\myCode
• Download w64devkit.zip
• Unzip contents w64devkit.zip to a location of your choice, e.g. C:\myTools
• Open a command prompt
• Change to C:\myCode\RRH46410-Firmware
• type
  set PATH=C:\myTools\w64devkit\bin:%PATH%
  followed by enter
• type
  make
  followed by enter
• If the build process succeeds, a rrh46410-example.exe is generated in subfolder build

Raspberry Pi

The Raspberry Pi build assumes the availability of the pigpio library. Please follow the instructions below to build the example for the Rasperry Pi.

• copy the RRH46410-Firmware.zip to the Raspberry Pi
• unzip it to a location of your choice
• open a command prompt and change the directory to the location of the unzipped RRH46410-Firmware.zip
• type
  make
  followed by enter
• If the build process succeeds, a rrh46410-example binary is generated in subfolder build

Note

Root privileges are required to execute the rrh46410-example.