Merge branch 'mega' into feature/P004-rename-1-wire-add-fixed-res-support

2026-09-12 09:36:59 +00:00 · 2023-04-27 14:03:12 +02:00
parent 90e3fbd726 c70430e4da
commit e4acbce993
43 changed files with 4524 additions and 2676 deletions
@@ -180,7 +180,18 @@

    ``Gateway,192.168.1.1``
    
-    Example output: ``Gateway:192.168.10.254(DHCP)``"
+    Example output: ``Gateway:192.168.10.254(DHCP)``
+    "
+    "
+    HiddenSSID","
+    :red:`Internal`","
+    Get or set the Include Hidden SSID setting
+
+    ``HiddenSSID``
+
+    ``HiddenSSID,true`` (can use ``1``, ``true`` or ``on`` to enable, and ``0``, ``false`` or ``off`` to disable)
+    
+    Example output: ``Include Hidden SSID:true``"
    "
    I2Cscanner","
    :red:`Internal`","
@@ -386,6 +397,8 @@
    
    On completion of the command, the returned status code can be handled in a generated event, f.e. ``http#hostname=404`` for not found error, or ``http#hostname=200`` for success.

+    See also: ``PutToHTTP`` and ``SendToHTTP``
+
    Added: 2023-01-15
    "
    "
@@ -425,6 +438,65 @@

    ``Publish,<topic>[,<payload>]``"
    "
+    PutToHTTP","
+    :green:`Rules`","
+    *Syntax format 1:*
+
+    ``PutToHTTP,[<user>:<password>@]<host>,<port>,<uri>,[<headers>][,<putdata>]``
+
+    Send a command to another network device via HTTP using the http ``PUT`` method.
+
+    ``<host>`` can be either a domain name or IP address.
+
+    ``<port>`` is the port to connect to, usually 80 for a HTTP site.
+
+    ``<uri>`` the path on the server to put the message to.
+
+    *Syntax format 2:*
+
+    ``PutToHTTP,http://[<user>:<password>@]<url>,[<headers>][,<putdata>]``
+
+    ``<url>`` is the full hostname (or IP address) and path on the server to put the content to.
+
+    *For both syntax formats:*
+
+    ``<user>`` is an optional user to supply for Basic authentication.
+
+    ``<password>`` is an optional password to supply for Basic authentication.
+
+    ``<headers>`` when provided will be added to the header of the ``PUT`` message, has to be in ``<name>:<value>`` format. Can be used to supply a ``Authorization: Bearer <token>`` and/or ``api-key:<key>`` (instead of a user/password Basic authentication) and a ``Content-Type: <content-type>``. Multiple entries have to be separated by a NewLine (``%LF%``) to be processed correctly. When not used (empty) and ``<putdata>`` *is used*, the comma should still be included!
+
+    ``<putdata>`` is the optional content to include in the ``PUT`` message. Can be anything, f.e. a JSON formatted string, like in the example below.
+
+    Syntax examples:
+
+    ``PutToHTTP,<host>,<Portnumber>,<uri>,[<headers>][,<putdata>]``
+
+    ``PutToHTTP,<user>:<pass>@<host>,<Portnumber>,<uri>,[<headers>][,<putdata>]``
+
+    ``PutToHTTP,http://<host>/<url>,[<headers>][,<putdata>]``
+
+    ``PutToHTTP,http://<user>:<pass>@<host>/<url>,[<headers>][,<putdata>]``
+
+    ``PutToHTTP,http://<host>:<Portnumber>/<url>,[<headers>][,<putdata>]``
+    
+    ``PutToHTTP,http://<user>:<pass>@<host>:<Portnumber>/<url>,[<headers>][,<putdata>]``
+
+    Example using syntax format 1:
+
+    ``PutToHTTP,user:password@192.168.1.100,8888,/someurl,'header1:value1%LF%header2:value2',`{'this':{'string':'can','be':'JSON','data':{'one':1,'two':2.0,'bool':true}}}```
+
+    Example using syntax format 2:
+
+    ``PutToHTTP,http://user:password@192.168.1.100:8888/someurl,'header1:value1%LF%header2:value2',`{'this':{'string':'can','be':'JSON','data':{'one':1,'two':2.0,'bool':true}}}```
+    
+    On completion of the command, the returned status code can be handled in a generated event, f.e. ``http#hostname=404`` for not found error, or ``http#hostname=200`` for success.
+
+    See also: ``PostToHTTP`` and ``SendToHTTP``
+
+    Added: 2023-04-17
+    "
+    "
    Reboot","
    :red:`Internal`","
    Reboot the ESP
@@ -24,6 +24,53 @@ Used libraries: |P106_usedlibraries|
 Description
 -----------

+Plugin to use the Bosch BME680 and BME688 Temperature, Humidity, Barometric pressure and MOX Gas resistance values.
+
+.. warning:: For the BME688 sensor the AI features are not supported, only the BME680 features, as it is fully backward compatible.
+
+Specifications:
+ * Temperature (-40C to +85C)
+ * Relative humidity (0-100 %RH)
+ * Barometric pressure (300-1100 hPa)
+ * Gas resistance (can be used to determine IAQ, Index of Air Quality)
+
+
+configuration
+-------------
+
+.. image:: P106_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 device supports 2 addresses, that can be configured using the ``SDO`` pin: (not all boards have that pin available, but could use soldering-pads to configure the address)
+
+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`
+
+Device Settings
+^^^^^^^^^^^^^^^
+
+* **Altitude** When not at sea-level, the plugin can apply an altitude compensation on the **Pressure** value.
+
+* **Present `Gas` in Ohm (not kOhm)**: Normally the Gas resistance value, received from the MOX Gas sensor, is divided to be presented as kOhm, but with this setting checked, the native Ohm value is shown.
+
+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.
+
+Values
+^^^^^^
+
+The plugin provides the ``Temperature``, ``Humidity``, ``Pressure`` and ``Gas`` values. A formula can be set to recalculate. The number of decimals can be set as desired.
+
+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>`


 .. Events
@@ -37,6 +84,8 @@ Change log
 ----------

 .. versionchanged:: 2.0
-  ...

-  |added| 2020-04-25
+
+|changed| 2023-04-16 Renamed to BME68x, make ``Gas`` output scale configurable.  ...
+
+|added| 2020-04-25
@@ -0,0 +1,155 @@
+.. include:: ../Plugin/_plugin_substitutions_p15x.repl
+.. _P150_page:
+
+|P150_typename|
+==================================================
+
+|P150_shortinfo|
+
+Plugin details
+--------------
+
+Type: |P150_type|
+
+Name: |P150_name|
+
+Status: |P150_status|
+
+GitHub: |P150_github|_
+
+Maintainer: |P150_maintainer|
+
+Used libraries: |P150_usedlibraries|
+
+Description
+-----------
+
+The Texas Instruments TMP117 High-accuracy temperature sensor offers an accuracy of 0.1°C in the range of -20°C to 50°C, and requires very low power when in shutdown mode.
+
+The low/high alarm options and accompanying ``INT`` pin, as provided by the sensor, are *not* implemented in this plugin.
+
+The datasheet offers the most up to date information: `Texas Instruments TMP117 Datasheet (online) <https://www.ti.com/document-viewer/tmp117/datasheet>`_
+
+Hardware
+--------
+
+.. image:: P150_AdafruitTMP117.png
+  :height: 200
+
+Adafruit TMP117 board.
+
+.. image:: P150_SparkfunTMP117.png
+  :height: 200
+
+SparkFun TMP117 board.
+
+Configuration
+-------------
+
+.. image:: P150_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 device supports up to 4 addresses, that can be configured using the ``ADDR`` pin: (not all boards have the ADDR pin directly available, but use soldering-pads to configure the address)
+
+.. csv-table::
+    :header: "Address", "ADDR pin to:", "Remark"
+    :widths: 10, 10, 40
+
+    "0x48", "GND", "Default, also when not connected."
+    "0x49", "VCC / VIN", ""
+    "0x4A", "SDA", ""
+    "0x4B", "SCL", ""
+
+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`
+
+Device Settings
+^^^^^^^^^^^^^^^
+
+* **Temperature offset**: An offset from the current temperature can be applied in 0.1°C steps. The number of steps can be set here.
+
+* **Averaging**: The sensor supports several averaging options, to stabilize the measurement. By default the average of 8 measurements is used.
+
+.. image:: P150_AveragingOptions.png
+
+*No averaging*: This turns off averaging.
+
+*8 sample averaging*: Average the last 8 measured samples (default).
+
+*32 sample averaging*: Average the last 32 measured samples.
+
+*64 sample averaging*: Average the last 64 measured samples.
+
+.. .. separator
+
+* **Conversion mode**: The default measuring conversion mode is to continuously perform measurements.
+
+.. image:: P150_ConversionModeOptions.png
+
+*Continuous*: Continuously perform measurements, with a configurable cycle-time (see below).
+
+*One-shot*: Perform a single measurement, then go into shutdown mode to conserve power. When the values are retrieved by the Interval event cycle, the One-shot mode is started, and read as soon as available (once per second). This value is returned on the next Interval, and a new One-shot measurement is started.
+
+.. warning:: When changing this setting, the current settings are saved, and the page is reloaded, to show or hide the **Continuous conversion cycle time** setting, as that is only available/applicable for Continuous mode.
+
+* **Continuous conversion cycle time**: The delay between actual measurements in Continuous conversion mode. When this is set to a value longer than the **Interval** time, some of the Interval readings will return the previous values, as no new value has been read yet. It is advised to set the **Interval** higher than the configured cycle time.
+
+.. image:: P150_CycleTimeOptions.png
+
+*15.5 msec*: A new measurement is performed every 15.5 milliseconds.
+
+*125 msec*: A new measurement is performed every 125 milliseconds.
+
+*250 msec*: A new measurement is performed every 250 milliseconds.
+
+*500 msec*: A new measurement is performed every 500 milliseconds.
+
+*1 sec*: A new measurement is performed every second.
+
+*4 sec*: A new measurement is performed every 4 seconds.
+
+*8 sec*: A new measurement is performed every 8 seconds.
+
+*16 sec*: A new measurement is performed every 16 seconds.
+
+This option is only available if **Conversion mode** is set to **Continuous**.
+
+Output
+^^^^^^
+
+* **Enable 'Raw' value**: Select Yes if you want to include the **Raw** value on the Devices overview page, and when sent to controllers. This contains the raw digital value read from the sensor.
+
+.. warning:: When changing this setting, the current settings are saved, and the page is reloaded, to show or hide the **Raw** Value (bottom of the page).
+
+* **Log measured values (INFO)**: When checked, the values will be included in the serial log, when that is enabled, on INFO level.
+
+* **Log low-level values (INFO)**: When checked, the values during the actual read (max. 1 per second) will be output to the serial log, on INFO level. This can be used for debugging purposes. May not be available in all builds to save space in the bin file.
+
+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 than the **Continuous conversion cycle time**, the interval will return the previously measured value until an actual measurement has been retrieved from the sensor.
+
+Values
+^^^^^^
+
+The plugin provides the ``Temperature`` and ``Raw`` values. Raw can be disabled, see above. A formula can be set to recalculate. The number of decimals can be set as desired, and defaults to 2 for Temperature, and 0 for Raw.
+
+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>`
+
+Change log
+----------
+
+.. versionchanged:: 2.0
+  ...
+
+  |added|
+  2023-04-15 Initial release version.
+
@@ -369,6 +369,7 @@ There are different released versions of ESP Easy:
   ":ref:`P144_page`","|P144_status|","P144"
   ":ref:`P145_page`","|P145_status|","P145"
   ":ref:`P148_page`","|P148_status|","P148"
+   ":ref:`P150_page`","|P150_status|","P150"
   ":ref:`P151_page`","|P151_status|","P151"


@@ -7,7 +7,7 @@
 .. |Plugin_Energy_AC| replace:: :ref:`P076_page`, :ref:`P077_page`, :ref:`P078_page`, :ref:`P102_page`, :ref:`P108_page`
 .. |Plugin_Energy_DC| replace:: :ref:`P027_page`, :ref:`P085_page`, :ref:`P115_page`, :ref:`P132_page`
 .. |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:`P151_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:`P150_page`, :ref:`P151_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`
 .. |Plugin_Generic| replace:: :ref:`P003_page`, :ref:`P026_page`, :ref:`P033_page`, :ref:`P037_page`, :ref:`P081_page`, :ref:`P100_page`
@@ -92,16 +92,16 @@
 .. |P105_datasheet3| replace:: http://www.aosong.com/en/products-60.html


-.. |P106_name| replace:: :cyan:`BME680`
+.. |P106_name| replace:: :cyan:`BME68x`
 .. |P106_type| replace:: :cyan:`Environment`
-.. |P106_typename| replace:: :cyan:`Environment - BME680`
+.. |P106_typename| replace:: :cyan:`Environment - BME68x`
 .. |P106_porttype| replace:: `.`
 .. |P106_status| replace:: :yellow:`COLLECTION B` :yellow:`CLIMATE`
 .. |P106_github| replace:: P106_BME680.ino
 .. _P106_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P106_BME680.ino
 .. |P106_usedby| replace:: `.`
 .. |P106_shortinfo| replace:: `.`
-.. |P106_maintainer| replace:: TD-er
+.. |P106_maintainer| replace:: `TD-er, tonhuisman`
 .. |P106_compileinfo| replace:: `.`
 .. |P106_usedlibraries| replace::  https://github.com/adafruit/Adafruit_BME680

@@ -1,3 +1,16 @@
+.. |P150_name| replace:: :cyan:`TMP117 Temperature`
+.. |P150_type| replace:: :cyan:`Environment`
+.. |P150_typename| replace:: :cyan:`Environment - TMP117 Temperature`
+.. |P150_porttype| replace:: `.`
+.. |P150_status| replace:: :yellow:`COLLECTION F` :yellow:`CLIMATE`
+.. |P150_github| replace:: P150_TMP117.ino
+.. _P150_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P150_TMP117.ino
+.. |P150_usedby| replace:: `.`
+.. |P150_shortinfo| replace:: `TMP117 Precision temperature sensor`
+.. |P150_maintainer| replace:: `tonhuisman`
+.. |P150_compileinfo| replace:: `.`
+.. |P150_usedlibraries| replace:: `.`
+
 .. |P151_name| replace:: :cyan:`I2C Honeywell Pressure`
 .. |P151_type| replace:: :cyan:`Environment`
 .. |P151_typename| replace:: :cyan:`Environment - I2C Honeywell Pressure`