diff --git a/docs/source/Plugin/P114.rst b/docs/source/Plugin/P114.rst new file mode 100644 index 000000000..d474ddbed --- /dev/null +++ b/docs/source/Plugin/P114.rst @@ -0,0 +1,99 @@ +.. include:: ../Plugin/_plugin_substitutions_p11x.repl +.. _P114_page: + +|P114_typename| +================================================== + +|P114_shortinfo| + +Plugin details +-------------- + +Type: |P114_type| + +Name: |P114_name| + +Status: |P114_status| + +GitHub: |P114_github|_ + +Maintainer: |P114_maintainer| + +Used libraries: |P114_usedlibraries| + +Description +----------- + +This I2C sensor with 2 resolutions (normal/high dynamic) offers UVA (365 +/-10 nm) and UVB (330 +/-10 nm) measurement and a calculated UVIndex value. Output result for UV is in irradiance, watt per square metre. The maximum value that can me measured is 65535, as the chip provides 16 bit values. + +NB: If the unit is over-exposed, possibly the measurement could exceed the maximum returned value of 65535, and the calculated UVIndex value will *not* be correct. + +NB2: When measuring outside UV exposure, the sensor should also be outside, as f.e. window glass filters out most UV radiance, and measurements will be (very) inaccurate. + +Configuration +-------------- + +.. image:: P114_DeviceConfiguration.png + +**Name** A unique name should be entered here. + +**Enabled** The device can be disabled or enabled. When not enabled the device should not use any resources. + +I2C Options +^^^^^^^^^^^^ + +The available settings here depend on the build used. At least the **Force Slow I2C speed** option is available, but selections for the I2C Multiplexer can also be shown. For details see the :ref:`Hardware_page` + +**I2C Address**: The address the device is using. Depending on the board used, when available a SDO pin, or soldering a 0 ohm resistor on a different location, can be used to select the used address. If that address selection is not available, then an I2C multiplexer (in a matching ESPEasy build) can be used to use multiple sensors on a single ESPEasy unit. + +Device Settings +^^^^^^^^^^^^^^^^ + +**Integration Time**: The integration time setting of the sensor determines the accuracy of the measurement. There are 5 options available: + +.. image:: P114_IntegrationTime.png + +*50 ms* The default value, using an integration time of 50 msec. + +*100ms* + +*200ms* + +*400ms* + +*800ms* + +Usually a higher integration time results in a more accurate measurement. + +**Dynamic Setting**: This determines the dynamic setting: + +.. image:: P114_DynamicSetting.png + +*Normal Dynamic* + +*High Dynamic* For better response to changing conditions during measurement. + + + +The Data Acquisition, Send to Controller and Interval settings are standard available configuration items. Send to Controller only when one or more Controllers are configured. + +**Interval** By default, Interval will be set to 60 sec. The minimum value allowed is 1 sec. but for measuring UV values, that don't change very quickly, reasonable values should be between 10 and 300 sec. + +Values +^^^^^^ + +The measured values are available in ``UVA``, ``UVB`` and ``UCIndex``. A formula can be set to recalculate. The number of decimals is by default set to 2, and can be set to 0 for ``UVA`` and ``UVB``, as no decimals are provided from the measurement. ``UVIndex`` value is often used without decimals, but can be set as desired. + +.. Events +.. ~~~~~~ + +.. .. include:: P114_events.repl + + + +Change log +---------- + +.. versionchanged:: 2.0 + + |added| 2021-04-24 Moved to main repository as Plugin 114 UV - VEML6075 UVA/UVB Sensor from the ESPEasyPluginPlayground (P130). diff --git a/docs/source/Plugin/P114_DeviceConfiguration.png b/docs/source/Plugin/P114_DeviceConfiguration.png new file mode 100644 index 000000000..29d39775d Binary files /dev/null and b/docs/source/Plugin/P114_DeviceConfiguration.png differ diff --git a/docs/source/Plugin/P114_DynamicSetting.png b/docs/source/Plugin/P114_DynamicSetting.png new file mode 100644 index 000000000..18f6c8b5b Binary files /dev/null and b/docs/source/Plugin/P114_DynamicSetting.png differ diff --git a/docs/source/Plugin/P114_IntegrationTime.png b/docs/source/Plugin/P114_IntegrationTime.png new file mode 100644 index 000000000..8810be80c Binary files /dev/null and b/docs/source/Plugin/P114_IntegrationTime.png differ diff --git a/docs/source/Plugin/_Plugin.rst b/docs/source/Plugin/_Plugin.rst index b83e803af..908a6bdff 100644 --- a/docs/source/Plugin/_Plugin.rst +++ b/docs/source/Plugin/_Plugin.rst @@ -133,6 +133,7 @@ There's three different released versions of ESP Easy: ":ref:`P110_page`","|P110_status|","P110" ":ref:`P111_page`","|P111_status|","P111" ":ref:`P113_page`","|P113_status|","P113" + ":ref:`P114_page`","|P114_status|","P114" Internal GPIO handling diff --git a/docs/source/Plugin/_plugin_categories.repl b/docs/source/Plugin/_plugin_categories.repl index fa9ca4bc9..75440ff27 100644 --- a/docs/source/Plugin/_plugin_categories.repl +++ b/docs/source/Plugin/_plugin_categories.repl @@ -15,7 +15,7 @@ .. |Plugin_Hardware| replace:: :ref:`P046_page` .. |Plugin_Keypad| replace:: :ref:`P058_page`, :ref:`P061_page`, :ref:`P062_page`, :ref:`P063_page` .. |Plugin_Light_Color| replace:: :ref:`P050_page`, :ref:`P066_page` -.. |Plugin_Light_UV| replace:: :ref:`P084_page`, :ref:`P107_page` +.. |Plugin_Light_UV| replace:: :ref:`P084_page`, :ref:`P107_page`, :ref:`P114_page` .. |Plugin_Light_Lux| replace:: :ref:`P010_page`, :ref:`P015_page`, :ref:`P074_page` .. |Plugin_Motor| replace:: :ref:`P048_page`, :ref:`P079_page` .. |Plugin_Notify| replace:: :ref:`P055_page`, :ref:`P065_page` diff --git a/docs/source/Plugin/_plugin_substitutions_p11x.repl b/docs/source/Plugin/_plugin_substitutions_p11x.repl index cbce729f4..c025563f1 100644 --- a/docs/source/Plugin/_plugin_substitutions_p11x.repl +++ b/docs/source/Plugin/_plugin_substitutions_p11x.repl @@ -36,3 +36,16 @@ .. |P113_maintainer| replace:: `TD-er, tonhuisman` .. |P113_compileinfo| replace:: `.` .. |P113_usedlibraries| replace:: `https://github.com/sparkfun/SparkFun_VL53L1X_Arduino_Library (local copy)` + +.. |P114_name| replace:: :cyan:`VEML6075` +.. |P114_type| replace:: :cyan:`UV` +.. |P114_typename| replace:: :cyan:`UV - VEML6075` +.. |P114_porttype| replace:: `.` +.. |P114_status| replace:: :yellow:`TESTING D` +.. |P114_github| replace:: P114_VEML6075.ino +.. _P114_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P114_VEML6075.ino +.. |P114_usedby| replace:: `.` +.. |P114_shortinfo| replace:: `UVA/UVB Sensor` +.. |P114_maintainer| replace:: `TD-er, clumsy-stefan, tonhuisman` +.. |P114_compileinfo| replace:: `.` +.. |P114_usedlibraries| replace:: `.`