UV
Device Compatibility
Overview
The UV sensor reports values for:
- UV Index scale used in the United States, conforms with international guidelines for UVI reporting established by the World Health Organization. From UV Index Scale
References
Below is the overview of the UV sensor implementation. Code example can be found here.
These header files are required to use the UV sensor.
// Interfaces with UV sensor #include "matrix_hal/uv_sensor.h" // Holds data from UV sensor #include "matrix_hal/uv_data.h" // Communicates with MATRIX device #include "matrix_hal/matrixio_bus.h"
UVData
UVData is a required object that contains the UV sensor's supported data parameters.
// Create UVData object matrix_hal::UVData uv_data;
The following code accesses the parameters of UVData.
// Output is represented in UV Index float UV = uv_data.uv;
UVSensor
UVSensor is a required object that contains functions to interface with the UV sensor.
// Create UVSensor object matrix_hal::UVSensor uv_sensor;
UVSensor.
.Setup
Setup is a function that takes a MatrixIOBus object as a parameter and sets that object as the bus to use for communicating with MATRIX device.
// Function declaration in header file void Setup(MatrixIOBus *bus);
// Set uv_sensor to use MatrixIOBus bus uv_sensor.Setup(&bus);
.Read
Read is a function that takes a UVData object as a parameter and writes the current humidity sensor data into the UVData object.
// Function declaration in header file bool Read(UVData *data);
// Overwrites uv_data with new data from UV sensor uv_sensor.Read(&uv_data);