GY-63_MS5611/libraries/AnalogUVSensor
2024-04-13 10:35:57 +02:00
..
.github bulk update GitHub actions 2024-04-13 10:35:57 +02:00
examples 0.1.6 AnalogUVSensor 2024-04-06 11:27:13 +02:00
test 0.1.4 AnalogUVSensor 2023-01-22 19:19:42 +01:00
.arduino-ci.yml 0.1.3 AnalogUVSensor 2022-10-28 21:40:39 +02:00
AnalogUVSensor.cpp 0.1.6 AnalogUVSensor 2024-04-06 11:27:13 +02:00
AnalogUVSensor.h 0.1.6 AnalogUVSensor 2024-04-06 11:27:13 +02:00
CHANGELOG.md 0.1.6 AnalogUVSensor 2024-04-06 11:27:13 +02:00
keywords.txt 0.1.2 AnalogUVSensor 2021-12-12 17:20:41 +01:00
library.json 0.1.6 AnalogUVSensor 2024-04-06 11:27:13 +02:00
library.properties 0.1.6 AnalogUVSensor 2024-04-06 11:27:13 +02:00
LICENSE 0.1.6 AnalogUVSensor 2024-04-06 11:27:13 +02:00
README.md 0.1.6 AnalogUVSensor 2024-04-06 11:27:13 +02:00

Arduino CI Arduino-lint JSON check GitHub issues

License: MIT GitHub release PlatformIO Registry

AnalogUVSensor

Arduino library for an analogue UV sensor.

Description

Foo Image courtesy Tinytronics

This small (type-less) UV-sensor is powered by 3.3 .. 5.0 V so it can be used by almost any microprocessor.

The sensor has an analogue output that is roughly linear with the UV-index (sunlight assumed, see notes).

Voltage UV index risk of harm Colour
<0.050 0 low Green
0.227 1 low Green
0.318 2 low Green
0.408 3 moderate Yellow
0.503 4 moderate Yellow
0.606 5 moderate Yellow
0.696 6 high Orange
0.795 7 high Orange
0.881 8 very high Red
0.976 9 very high Red
1.079 10 very high Red
1.170> 11 extreme Purple

From this table the formula is derived (spreadsheet) which is pretty linear between UV 1 and 11. Between 0 and 1 there seems to be a curve / other linear relation.

Notes

Note: risk of harm based upon Wikipedia.

Note: The sensor is not calibrated and the table is indicative for sunlight (warning, assumption!) and therefore not suitable for e.g. medical or industrial usage.

Note: UV radiation will not go through normal glass, so inside (a house) you will most likely always read zero. This may of course help to calibrate the zero level of the sensor.

Note: depending on the light source used, the table above is not correct. If one wants to use other values one need to fix the formula in the mv2index() function. (mv stands for millivolt)

Note: the output of the sensor is typically 0 .. 1.1 volt. To increase precision one might configure the ADC used to match this voltage range. E.g. Arduino UNO can be set to use an internal 1.1 volt reference. See Arduino manual setAnalogReference()

Note: for a continuous colour scale check

Wavelength sensitivity

The sensor is sensitive for wavelengths from 200 - 370 nm, so mostly in UVB and UVA region and less in the UVC. There is no information about the detailed wavelength sensitivity, so it is not possible to compensate. However one could assume that there is a normal (or other) distribution over the 200 - 370 nm range and create a compensation table based upon the assumed distribution.

More about UV see - https://en.wikipedia.org/wiki/Ultraviolet

Interface

#include "AnalogUVSensor.h"
  • AnalogUVSensor() Constructor.
  • void begin(uint8_t analogPin, float volts = 5.0, uint16_t maxADC = 1023) set the parameters of the sensor, analogPin, volts and maxADC to specify the internal ADC. Volts and maxADC have a default so these can be omitted if these match.
    • Note: one needs to reset these parameters if the settings of the internal ADC are changed e.g. to INTERNAL_1V1 to change the accuracy.
  • float read(uint8_t times = 1) Returns the UV index. Read the analogue sensor one (or more) times to average the reading. This can improve the accuracy of the reading. If times == 0 it is set to 1.
  • float mV2index(uint16_t milliVolt) MilliVolt to index. Returns the UV index. The conversion formula from milliVolt to the UV index is used internally by the read() function. This function can also be called with a voltage measured with an external ADC. The function will return a value between 0.0 and 12.0.
  • char index2color(float index) Converts an UV index to the first letter of Green, Yellow, Orange, Red or Purple. Can be used as indication on a user interface. This function can also be called with an index from an other UV index sensor.

Power interface

Works only if setPowerPin is called properly.

  • void setPowerPin(uint8_t powerPin, bool invert = false) Can be used to control the power of the sensor e.g. for low power mode. Optionally one can set the invert flag to true to invert the HIGH LOW levels e.g. when the analogue sensor is switched through a MOSFET.
  • void switchOff() switch off the power of the sensor.
  • void switchOn() switch on the power of the sensor.

Future

Must

  • verify vs calibrated sensor

Should

  • documentation
    • investigate with different light sources (UVled, TL, sunlight).
  • move powerPin setting to constructor (breaking 0.2.0 ?)

Could

  • investigate angle sensitivity e.g. if the UV light comes from an angle - cosine law.
  • investigate response time to stabilize e.g. does it react fast on clouds.
  • investigate time needed to first (stable) measurement.

Wont

  • index2time() calculate max exposure time?
    • dangerous advice, so better keep that out of the library ?
  • uint32_t index2RGB(float index) full (smooth) colour RGB mapping.
  • add code for external ADC (see ACS712)
    • users can call mV2index()

Sponsor

The development of this library is sponsored by TinyTronics, Netherlands.

Support

If you appreciate my libraries, you can support the development and maintenance. Improve the quality of the libraries by providing issues and Pull Requests, or donate through PayPal or GitHub sponsors.

Thank you,