P164 gases ens160

docs/source/Plugin/P164.rst

@@ -0,0 +1,117 @@
+.. include:: ../Plugin/_plugin_substitutions_p16x.repl
+.. _P164_page:
+
+|P164_typename|
+==================================================
+
+|P164_shortinfo|
+
+Plugin details
+--------------
+
+Type: |P164_type|
+
+Name: |P164_name|
+
+Status: |P164_status|
+
+GitHub: |P164_github|_
+
+Maintainer: |P164_maintainer|
+
+Used libraries: |P164_usedlibraries|
+
+Description
+-----------
+
+Sciosense ENS160 and its successor ENS161 are multi-gas sensors based on metal oxide (MOX) technology. They can detect multiple VOCs including ethanol, toluene, hydrogen and oxidizing gases.
+The sensors are connected to the I2C bus and provide preprocessed data as TVOC and eCO2 values. See https://www.sciosense.com/ens16x-digital-metal-oxide-multi-gas-sensor-family/ for details about the device.
+
+Hardware 
+--------
+
+Various boards with the ENS160 are available through electronics market places like Aliexpress. A popular board contains both ENS160 and AHT21 on a single PCB. The AHT21 can be used for temperature compensation as provided by this plugin.
+
+.. image:: P164_board.jpg
+
+Configuration
+-------------
+
+.. image:: P164_DeviceConfiguration.png
+
+* **Name**: Required by ESPEasy, must be unique among the list of available devices/tasks.
+
+* **Enabled**: The device can be disabled or enabled. When not enabled the device should not use any resources.
+
+I2C options
+^^^^^^^^^^^
+
+* **I2C Address**: The sensor supports two addresses. The actual address depends on the voltage on the ADDR pin of the device.
+
+.. csv-table::
+    :header: "Address", "Remark"
+    :widths: 10, 50
+
+    "0x52",  "Connect ADDR GND"
+    "0x53",  "Connect ADDR to VDD (default on most boards)"
+
+The available I2C 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`
+
+The chip supports both SPI and I2C. The plugin only support I2C using the following pins:
+
+* 1 SDA: Data [MOSI/SDA]
+* 2 SCL: Serial Clock [SCLK/SCL]
+* 3 ADDR: Address [MISO/ADDR]
+* 6 INTn: Interrupt [INTn]
+* 7 CSn: SPI interface select, low-> SPI, high->I2C [CSn]
+
+For this plugin the CSn must be wired to VDD to enable the I2C protocol. 
+
+On boards sold online, SDO and SDI are often already pulled-up, setting the default I2C address to 0x53.
+
+
+Device Settings
+^^^^^^^^^^^^^^^
+
+* **Detected Sensor Type**: Shows either ``ENS160`` or ``ENS161`` or a number if no sensor or an unknown sensor ID is detected. It will also show the firmware version read from the device if the data is available.
+* **Temperature Task**: Task (plugin) providing the temperature compensation
+* **Temperature Value**: Value for the temperature compensation
+* **Humidity Task**: Task (plugin) providing the humidity compensation
+* **Humidity Value**: Value for the humidity compensation
+
+The ENS16x provides temperature and humidity compensation. The plugin must provide the actual temperature and humidity to the device to enable this compensation. For this the plugin needs to read these values from other tasks. 
+
+Using the **Temperature Task** and **Temperature Value** the task and value for the Temperature compensation can be selected. Compensation can be switched off by selecting **Not Set**. 
+
+Using the **Humidity Task** and **Humidity Value** the task and value for the Humidity compensation can be selected. Compensation can be switched off by selecting **Not Set**. 
+
+Note that if either one of the tasks is set to **Not Set** compensation is switched off and a default value is used.
+
+The ENS160 is sold on popular websites on a board including the AHT21 temperature and humidity sensor. This sensor can be used for the compensation algorithm of the ENS160.
+
+Data Acquisition
+^^^^^^^^^^^^^^^^
+
+This group of settings, **Single event with all values** and **Send to Controller** settings are standard available configuration items. Send to Controller is only visible when one or more Controllers are configured.
+
+* **Interval** By default, Interval will be set to 60 sec. The data will be collected and optionally sent to any configured controllers using this interval. If the Interval is set lower or equal than the required 10 * Heater time, the plugin will not start!
+
+Values
+^^^^^^
+
+The plugin provides the ``TVOC`` and ``eCO2`` values. A formula can be set to recalculate. The number of decimals can be set as desired, and defaults to 2.
+
+In selected builds, per Value is a **Stats** checkbox available, that when checked, gathers the data and presents recent data in a graph, as described here: :ref:`Task Value Statistics:  <Task Value Statistics>`
+
+Currently the extra features offered by the sensore are not configurable in this plugin.
+These may be added later.
+
+Change log
+----------
+
+.. versionchanged:: 2.0
+  ...
+
+  |added|
+  2023-12-27 Initial release version.
+

docs/source/Plugin/_Plugin.rst

@@ -386,6 +386,7 @@ There are different released versions of ESP Easy:
    ":ref:`P153_page`","|P153_status|","P153"
    ":ref:`P154_page`","|P154_status|","P154"
    ":ref:`P159_page`","|P159_status|","P159"
+   ":ref:`P164_page`","|P164_status|","P164"
    ":ref:`P166_page`","|P166_status|","P166"
 
 

docs/source/Plugin/_plugin_categories.repl

@@ -10,7 +10,7 @@
 .. |Plugin_Energy_Heat| replace:: :ref:`P088_page`, :ref:`P093_page`
 .. |Plugin_Environment| replace:: :ref:`P004_page`, :ref:`P005_page`, :ref:`P006_page`, :ref:`P014_page`, :ref:`P024_page`, :ref:`P028_page`, :ref:`P030_page`, :ref:`P031_page`, :ref:`P032_page`, :ref:`P034_page`, :ref:`P039_page`, :ref:`P047_page`, :ref:`P051_page`, :ref:`P068_page`, :ref:`P069_page`, :ref:`P072_page`, :ref:`P103_page`, :ref:`P105_page`, :ref:`P106_page`, :ref:`P122_page`, :ref:`P150_page`, :ref:`P151_page`, :ref:`P153_page`, :ref:`P154_page`
 .. |Plugin_Extra_IO| replace:: :ref:`P011_page`, :ref:`P022_page`
-.. |Plugin_Gases| replace:: :ref:`P049_page`, :ref:`P052_page`, :ref:`P083_page`, :ref:`P090_page`, :ref:`P117_page`, :ref:`P127_page`, :ref:`P135_page`, :ref:`P145_page`, :ref:`P147_page`
+.. |Plugin_Gases| replace:: :ref:`P049_page`, :ref:`P052_page`, :ref:`P083_page`, :ref:`P090_page`, :ref:`P117_page`, :ref:`P127_page`, :ref:`P135_page`, :ref:`P145_page`, :ref:`P147_page`, :ref:`P164_page`
 .. |Plugin_Generic| replace:: :ref:`P003_page`, :ref:`P026_page`, :ref:`P033_page`, :ref:`P037_page`, :ref:`P081_page`, :ref:`P100_page`, :ref:`P146_page`
 .. |Plugin_Gesture| replace:: :ref:`P064_page`
 .. |Plugin_Gyro| replace:: :ref:`P045_page`, :ref:`P119_page`

docs/source/Plugin/_plugin_substitutions_p16x.repl

@@ -1,3 +1,16 @@
+.. |P164_name| replace:: :cyan:`ENS16x TVOC/eCO2`
+.. |P164_type| replace:: :cyan:`Gases`
+.. |P164_typename| replace:: :cyan:`Gases - ENS16x TVOC/eCO2`
+.. |P164_porttype| replace:: `.`
+.. |P164_status| replace:: :yellow:`COLLECTION G` :yellow:`CLIMATE`
+.. |P164_github| replace:: P164_gases_ens160.ino
+.. _P164_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P164_gases_ens160.ino
+.. |P164_usedby| replace:: `.`
+.. |P164_shortinfo| replace:: `ENS16x TVOC/eCO2 sensors`
+.. |P164_maintainer| replace:: `flashmark`
+.. |P164_compileinfo| replace:: `.`
+.. |P164_usedlibraries| replace:: `I2C`
+
 .. |P166_name| replace:: :cyan:`GP8403 Dual channel DAC 0-10V`
 .. |P166_type| replace:: :cyan:`Output`
 .. |P166_typename| replace:: :cyan:`Output - GP8403 Dual channel DAC 0-10V`

src/Custom-sample.h

@@ -538,6 +538,7 @@ static const char DATA_ESPEASY_DEFAULT_MIN_CSS[] PROGMEM = {
 
 // #define USES_P159   // Presence - LD2410 Radar detection
 
+// #define USES_P164   // Gases - ENS16x TVOC/eCO2
 /*
  #######################################################################################################
  ###########     Controllers

src/_P164_gases_ens160.ino

@@ -0,0 +1,153 @@
+#include "_Plugin_Helper.h"
+#ifdef USES_P164
+
+// #######################################################################################################
+// #################################### Plugin-164: Gases - ENS16x (tvoc,eco2) ###########################
+// #######################################################################################################
+// P164 "GASES - ENS16x (TVOC, eCO2)"
+// Plugin for ENS160 & ENS161 TVOC and eCO2 sensor with I2C interface from ScioSense
+// For documentation of the ENS160 hardware device see 
+// https://www.sciosense.com/wp-content/uploads/documents/SC-001224-DS-9-ENS160-Datasheet.pdf
+//
+// PLugin code:
+// 2023 By flashmark
+// #######################################################################################################
+
+# include "src/PluginStructs/P164_data_struct.h"
+
+# define PLUGIN_164
+# define PLUGIN_ID_164         164
+# define PLUGIN_NAME_164       "Gases - ENS16x"
+# define PLUGIN_VALUENAME1_164 "TVOC"
+# define PLUGIN_VALUENAME2_164 "eCO2"
+
+boolean Plugin_164(uint8_t function, struct EventStruct *event, String& string)
+{
+  boolean success = false;
+
+  switch (function)
+  {
+    case PLUGIN_DEVICE_ADD:
+    {
+      Device[++deviceCount].Number           = PLUGIN_ID_164;
+      Device[deviceCount].Type               = DEVICE_TYPE_I2C;
+      Device[deviceCount].VType              = Sensor_VType::SENSOR_TYPE_DUAL;
+      Device[deviceCount].Ports              = 0;
+      Device[deviceCount].PullUpOption       = false;
+      Device[deviceCount].InverseLogicOption = false;
+      Device[deviceCount].FormulaOption      = true;
+      Device[deviceCount].ValueCount         = 2;
+      Device[deviceCount].SendDataOption     = true;
+      Device[deviceCount].TimerOption        = true;
+      Device[deviceCount].GlobalSyncOption   = true;
+      Device[deviceCount].PluginStats        = true;
+      break;
+    }
+
+    case PLUGIN_GET_DEVICENAME:
+    {
+      string = F(PLUGIN_NAME_164);
+      break;
+    }
+
+    case PLUGIN_GET_DEVICEVALUENAMES:
+    {
+      strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[0], PSTR(PLUGIN_VALUENAME1_164));
+      strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[1], PSTR(PLUGIN_VALUENAME2_164));
+      break;
+    }
+
+    case PLUGIN_I2C_HAS_ADDRESS:
+    case PLUGIN_WEBFORM_SHOW_I2C_PARAMS:
+    {
+      const uint8_t i2cAddressValues[] = { P164_ENS160_I2CADDR_0, P164_ENS160_I2CADDR_1 };
+      constexpr int nrAddressOptions   = NR_ELEMENTS(i2cAddressValues);
+
+      if (function == PLUGIN_WEBFORM_SHOW_I2C_PARAMS) {
+        addFormSelectorI2C(F("i2c_addr"), nrAddressOptions, i2cAddressValues, P164_PCONFIG_I2C_ADDR);
+        addFormNote(F("ADDR Low=0x52, High=0x53"));
+      } else {
+        success = intArrayContains(nrAddressOptions, i2cAddressValues, event->Par1);
+      }
+
+      break;
+    }
+
+    # if FEATURE_I2C_GET_ADDRESS
+    case PLUGIN_I2C_GET_ADDRESS:
+    {
+      event->Par1 = P164_PCONFIG_I2C_ADDR;
+      success     = true;
+      break;
+    }
+    # endif // if FEATURE_I2C_GET_ADDRESS
+
+    case PLUGIN_SET_DEFAULTS:
+    {
+      P164_PCONFIG_I2C_ADDR = P164_ENS160_I2CADDR_1;
+      success = true;
+      break;
+    }
+
+    case PLUGIN_INIT:
+    {
+      initPluginTaskData(event->TaskIndex, new (std::nothrow) P164_data_struct(event));
+      P164_data_struct *P164_data = static_cast<P164_data_struct *>(getPluginTaskData(event->TaskIndex));
+
+      success = (nullptr != P164_data && P164_data->begin());
+      break;
+    }
+
+    case PLUGIN_READ:
+    {
+      P164_data_struct *P164_data = static_cast<P164_data_struct *>(getPluginTaskData(event->TaskIndex));
+
+      if (nullptr == P164_data) {
+        addLogMove(LOG_LEVEL_ERROR, F("P164: plugin_read NULLPTR"));
+        break;
+      }
+
+      float temperature = 20.0f;  // A reasonable value in case temperature source task is invalid
+      float humidity = 50.0f;     // A reasonable value in case humidity source task is invalid
+      float tvoc = 0.0f;          // tvoc value to be retrieved from device
+      float eco2 = 0.0f;          // eCO2 value to be retrieved from device
+
+      if (validTaskIndex(P164_PCONFIG_TEMP_TASK) && validTaskIndex(P164_PCONFIG_HUM_TASK))
+      {
+        // we're checking a value from other tasks
+        temperature = UserVar.getFloat(P164_PCONFIG_TEMP_TASK, P164_PCONFIG_TEMP_VAL); // in degrees C
+        humidity    = UserVar.getFloat(P164_PCONFIG_HUM_TASK, P164_PCONFIG_HUM_VAL);   // in % relative
+      }
+      success = P164_data->read(tvoc, eco2, temperature, humidity);
+      UserVar.setFloat(event->TaskIndex, 0, tvoc);
+      UserVar.setFloat(event->TaskIndex, 1, eco2);
+      break;
+    }
+
+    case PLUGIN_WEBFORM_LOAD:
+    {
+      success = P164_data_struct::webformLoad(event);
+      break;
+    }
+
+    case PLUGIN_WEBFORM_SAVE:
+    {
+      success = P164_data_struct::webformSave(event);
+      break;
+    }
+
+    case PLUGIN_TEN_PER_SECOND:
+    {
+      P164_data_struct *P164_data =
+        static_cast<P164_data_struct *>(getPluginTaskData(event->TaskIndex));
+      if (nullptr == P164_data) {
+        break;
+      }
+      success = P164_data->tenPerSecond(event);
+      break;
+    }
+  }
+  return success;
+}
+
+#endif // ifdef USES_P164

src/src/CustomBuild/define_plugin_sets.h

@@ -1622,6 +1622,9 @@ To create/register a plugin, you have to :
   #ifndef USES_P159
     #define USES_P159   // Presence - LD2410 Radar detection
   #endif
+  #ifndef USES_P164
+    #define USES_P164   // Gases - ENS16x TVOC\eCO2
+  #endif
   #ifndef USES_P166
     #define USES_P166   // Output - GP8403 DAC 0-10V
   #endif
@@ -1907,8 +1910,12 @@ To create/register a plugin, you have to :
   #ifndef USES_P154
     #define USES_P154   // Environment - BMP3xx
   #endif
-
-
+  #ifndef USES_P164
+    #define USES_P164   // Gases - ENS16x TVOC/eCO2
+  #endif
+  #ifndef USES_P166
+    #define USES_P166   // Output - GP8403 DAC 0-10V
+  #endif
 
   // Controllers
   #ifndef USES_C011