History

srg74 8caeddde15 Spelling check by @wthomson (#2940 ) A lot of spelling corrections. Now repo will sound like educated person :) Co-authored-by: Bill Thomson <bt@kattt.org>		2022-12-10 16:12:55 +01:00
..
platformio_override.ini	added SN_Photoresistor usermod	2021-06-02 12:01:06 +12:00
readme.md	Spelling check by @wthomson (#2940 )	2022-12-10 16:12:55 +01:00
usermod_sn_photoresistor.h	Float and better 3rd party library compatibility (#2534 )	2022-02-09 09:46:54 +01:00
usermods_list.cpp	added SN_Photoresistor usermod	2021-06-02 12:01:06 +12:00

readme.md

SN_Photoresistor usermod

This usermod will read from an attached photoresistor sensor like the KY-018. The luminance is displayed in both the Info section of the web UI as well as published to the /luminance MQTT topic, if enabled.

Installation

Copy the example platformio_override.ini to the root directory. This file should be placed in the same directory as platformio.ini.

Define Your Options

USERMOD_SN_PHOTORESISTOR - Enables this user mod. wled00\usermods_list.cpp
USERMOD_SN_PHOTORESISTOR_MEASUREMENT_INTERVAL - Number of milliseconds between measurements. Defaults to 60000 ms
USERMOD_SN_PHOTORESISTOR_FIRST_MEASUREMENT_AT - Number of milliseconds after boot to take first measurement. Defaults to 20000 ms
USERMOD_SN_PHOTORESISTOR_REFERENCE_VOLTAGE - Voltage supplied to the sensor. Defaults to 5v
USERMOD_SN_PHOTORESISTOR_ADC_PRECISION - ADC precision. Defaults to 10 bits
USERMOD_SN_PHOTORESISTOR_RESISTOR_VALUE - Resistor size, defaults to 10000.0 (10K Ohms)
USERMOD_SN_PHOTORESISTOR_OFFSET_VALUE - Offset value to report on. Defaults to 25

All parameters can be configured at runtime via the Usermods settings page.

Project link

QuinLED-Dig-Uno - Project link

PlatformIO requirements

If you are using platformio_override.ini, you should be able to refresh the task list and see your custom task, for example env:usermod_sn_photoresistor_d1_mini.