[pull] mega from letscontrolit:mega

docs/source/Controller/_controller_substitutions.repl

@@ -114,7 +114,7 @@
 .. |C011_name| replace:: :cyan:`Generic HTTP Advanced`
 .. |C011_type| replace:: :cyan:`Controller`
 .. |C011_typename| replace:: :cyan:`Controller - Generic HTTP Advanced`
-.. |C011_status| replace:: :yellow:`COLLECTION`
+.. |C011_status| replace:: :yellow:`COLLECTION` :yellow:`CLIMATE`
 .. |C011_github| replace:: C011.cpp
 .. _C011_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_C011.cpp
 .. |C011_usedby| replace:: `.`

docs/source/Plugin/P000_commands.repl

@@ -383,6 +383,23 @@
 
     ``NTPHost,""`` or ``NTPHost,`` -> Clear the NTP host so a default host from pool.ntp.org will be used. (As second argument *is* provided but empty.)"
     "
+    OWScan","
+    :red:`Internal`","
+    Scan for & list 1-wire (One Wire = OW) devices on a GPIO pin.
+
+    Syntax: ``owscan,<rx-pin>[,<txpin>]``
+
+    If no separate TX pin is provided, the RX pin will be used as the TX pin too, as is the normal behavior for 1-wire communication. The separate TX pin is used on a Shelly device when adding the Shelly Temperature add-on (RX = GPIO-0 and TX = GPIO-3).
+
+    Example:
+
+    .. code-block:: none
+
+      >owscan,5
+      01-6e-56-8c-01-00-00-84 [DS1990A]    
+
+    "
+    "
     Password","
     :red:`Internal`","
     Set the password of the unit.

docs/source/Plugin/P004.rst

@@ -39,6 +39,13 @@ Supported hardware
 
 .. .. include:: P004_events.repl
 
+Get Config Values
+-----------------
+
+Get Config Values retrieves values or settings from the sensor or plugin, and can be used in Rules, Display plugins, Formula's etc. The square brackets **are** part of the variable. Replace ``<taskname>`` by the **Name** of the task.
+
+.. include:: P004_config_values.repl
+
 Change log
 ----------
 

docs/source/Plugin/P004_DS18b20.rst

@@ -227,7 +227,8 @@ Data Acquisition
 * **Interval**: How often should the task publish its value (5..15 seconds is normal).
 
 Values
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^
+
 * **Name**: Value Name of temperature indicator.
 * **Formula**: Optional math conversion. The measured temperature defaults to Celsius. It can be converted to Fahrenheit by entering this formula:
 
@@ -251,7 +252,7 @@ Rules examples
 .. code-block:: none
 
     On Temperature1#Celsius Do
-     If [Temperature1#Celsius]>37
+     If %eventvalue1%>37
        NeoPixelAll,255,0,0 //Your body temperature is too high!
      Else
        NeoPixelAll,0,255,0 //Body temperature is OK.

docs/source/Plugin/P004_config_values.repl

@@ -0,0 +1,46 @@
+.. csv-table::
+    :header: "Config value", "Information"
+    :widths: 20, 30
+
+    "
+    | ``[<taskname>#SensorStats.<sensornr>.Success]``
+
+    | ``<sensornr>``: The number of the device address within the configuration, range 1..4.
+    ","
+    | Returns the number of successful reads for this sensor as shown in the settings page.
+    "
+    "
+    | ``[<taskname>#SensorStats.<sensornr>.Retry]``
+
+    | ``<sensornr>``: The number of the device address within the configuration, range 1..4.
+    ","
+    | Returns the number of retries for this sensor as shown in the settings page.
+    "
+    "
+    | ``[<taskname>#SensorStats.<sensornr>.Failed]``
+
+    | ``<sensornr>``: The number of the device address within the configuration, range 1..4.
+    ","
+    | Returns the number of failed reads for this sensor as shown in the settings page.
+    "
+    "
+    | ``[<taskname>#SensorStats.<sensornr>.InitFailed]``
+
+    | ``<sensornr>``: The number of the device address within the configuration, range 1..4.
+    ","
+    | Returns the number of failed initialization-reads (second retry failed too) for this sensor as shown in the settings page.
+    "
+    "
+    | ``[<taskname>#SensorStats.<sensornr>.Resolution]``
+
+    | ``<sensornr>``: The number of the device address within the configuration, range 1..4.
+    ","
+    | Returns the resolution in bits for this sensor as shown in the settings page.
+    "
+    "
+    | ``[<taskname>#SensorStats.<sensornr>.Address]``
+
+    | ``<sensornr>``: The number of the device address within the configuration, range 1..4.
+    ","
+    | Returns the formatted Device Address, including the device type, for this sensor as shown in the settings page.
+    "

docs/source/Plugin/P080.rst

@@ -1,4 +1,4 @@
-.. include:: ../Plugin/_plugin_substitutions_p08x.repl
+.. include:: ../Plugin/_plugin_substitutions_p08x.repl
 .. _P080_page:
 
 |P080_typename|
@@ -24,24 +24,95 @@ Used libraries: |P080_usedlibraries|
 Supported hardware
 ------------------
 
-|P080_usedby|
+.. .. |P080_usedby|
+
+.. image:: P080_iButtonReader1.png
+  :width: 200px
+
+.. image:: P080_iButtonReader2.png
+  :width: 200px
+
+This type of reader is available at sites like Aliexpress and eBay. The wiring for these units can be somewhat confusing:
+
+.. code-block:: none
+
+  ESP           iButton (4 wires)
+  GPIO   <-->   1-wire/D (green) with 1k..10k Pull-up to VCC
+  GND    <-->   GND (red)
+
+  ESP           Resistor        LED
+  VCC    <-->                   Anode (black)
+  GPIO   <-->   470 ohm   <-->  Cathode (white)
+
+The value for the pull-up resistor on the 1-wire GPIO pin depends somewhat, sometimes, 10k doesn't work reliable, especially when using longer wires (> 2m), then lowering to 4k7 or 2k2 usually fixes that. For really problematic installations with high (electrical) noise levels, a 1k resistor may be needed to make it work reliable.
+
+Description
+-----------
+
+The iButton, developed by Dallas, now Maxim, is a coded key or button, that can be used for access control or similar identity checks. They use RFID technology to transfer their ID to the receiver, once in close proximity of the receiver.
+
+The iButtons often come in the shape shown in the image below, and can be attached to a keyring for easy access and use.
+
+These buttons are available as read-only iButtons, and as rewritable iButtons, where the user can change the ID of the button. Both types can be read by ESPEasy, but ESPEasy does not provide tools or features to write an ID to the rewritable buttons, separate tools for that can be obtained elsewhere.
+
+.. image:: P080_iButtonExamples.png
+  :width: 200px
+
+Configuration
+-------------
+
+.. image:: P080_DeviceConfiguration.png
+  :alt: Device configuration
+
+
+* **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.
+
+Sensor
+^^^^^^
+
+* **GPIO 1-Wire**: The reader only needs a single GPIO pin (and GND) to be connected. The 1-Wire hardware configured in ESPEasy requires a ca. 4k7 ohm (range 1k..10k depending on wire-length) pull-up resistor between VCC (3.3V) and the GPIO pin. Internal pull-up of the ESP is not sufficient!
+
+Any additional wires on the receiver unit mostly are used for indicator leds, that can optionally be controlled using standard GPIO commands from rules. (Don't forget a resistor to limit the current...)
+
+Device Settings
+^^^^^^^^^^^^^^^
+
+* **Device Address**: Select the desired device ID that the plugin should respond to. This requires the device to be enabled, and an iButton in contact with the receiver when opening the device settings page! When set, the task will only respond to this iButton ID, when read.
+
+* **Event with iButton address**: With this option enabled, and the **Device Address** selection left to ``- None -``, instead of responding to a single iButton, an event is generated for any iButton that is recognized by the receiver. And once removed, the same event is generated without the iButton address. This can be processed in rules. See below in the **Events** chapter for a more detailed description.
+
+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 0 sec. as it is optional. It is the frequency used to send the value to any Controllers configured for this device.
+
+Values
+^^^^^^
+
+The plugin provides the ``iButton`` value, that shows either 0 (no iButton on the receiver) or 1 (iButton recognized).
 
 .. Commands available
 .. ^^^^^^^^^^^^^^^^^^
 
 .. .. include:: P080_commands.repl
 
-.. Events
-.. ~~~~~~
+Events
+~~~~~~
 
-.. .. include:: P080_events.repl
+.. include:: P080_events.repl
 
 Change log
 ----------
 
 .. versionchanged:: 2.0
   ...
 
+  |added| 2024-05-10 Support for Event with iButton address.
+
   |added|
   Major overhaul for 2.0 release.
 

docs/source/Plugin/P080_events.repl

@@ -0,0 +1,32 @@
+.. csv-table::
+   :header: "Event", "Example"
+   :widths: 30, 30
+
+   "
+   ``<taskName>#Address=<state>[,<iButtonAddress_high>,<iButtonAddress_low>]``
+
+   ``<state>``: 0 or 1, depending on wether the iButton is on the receiver (1) or not (0).
+
+   ``<iButtonAddress_high>``: The high 4 bytes of the (64 bit) iButton address in hexadecimal presentation, with a ``0x`` prefix. The address parts are only included if the iButton is detected by the receiver.
+
+   ``<iButtonAddress_low>``: The low 4 bytes of the iButton address in hexadecimal presentation.
+
+   ","
+
+   This event is generated when the **Event with iButton address** setting is *enabled*, and no **Device Address** is selected (*None*).
+
+   As the iButton address is in fact a 64 bit value (though only 57 bits are used), this value is too large to be stored in a regular variable in the rules, so they are split into 2 parts, as often sets of iButtons are produced in the same batch, where the higher bits are the same, and only the lower bits vary.
+
+   These numbers can be processed, f.e. in a lookup table, similar to the example `Validate a RFID tag against a sorted list <../Rules/Rules.html#validate-a-rfid-tag-against-a-sorted-list>`_ (though somewhat different...)
+
+   Simply logging the data could look like this:
+
+   .. code-block:: none
+
+      On iButton#Address Do
+        Let,1,%eventvalue2%
+        Let,2,%eventvalue3%
+        LogEntry,'iButton %eventvalue2%_%eventvalue3% = %eventvalue1% (%v1% / %v2%)'
+      Endon
+
+   "

docs/source/Plugin/P123.rst

@@ -0,0 +1,79 @@
+.. include:: ../Plugin/_plugin_substitutions_p12x.repl
+.. _P123_page:
+
+|P123_typename|
+==================================================
+
+|P123_shortinfo|
+
+Plugin details
+--------------
+
+Type: |P123_type|
+
+Name: |P123_name|
+
+Status: |P123_status|
+
+GitHub: |P123_github|_
+
+Maintainer: |P123_maintainer|
+
+Used libraries: |P123_usedlibraries|
+
+Supported hardware
+------------------
+
+Some displays are available with a touch overlay mounted on top of the visible side of the display. There's a choice of resistive and capacitive touch overlays. The FT62x6 series of touch overlays are of the Capacitive kind, being very easy to interact with, comparable to modern smartphones, where you can use a finger for the interaction. (Resistive touch overlays usually require a special pen to be used, or pressed with a finger-nail, to get a response.)
+
+The FT62x6 touch overlay (or touch screen), can be found on several displays, f.e. some M5Stack devices and the WT32-SC01 display unit.
+
+Device configuration
+--------------------
+
+.. image:: P123_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
+^^^^^^^^^^^
+
+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`
+
+Device Settings
+^^^^^^^^^^^^^^^
+
+* **Display task**: Select the display task the touch screen is mounted on. By default, the current task is selected (and ignored), as any other guess would be wrong, and there is no 'None' selection available.
+
+When choosing the correct task, the current display resolution, color depth and rotation settings are tried to be fetched from that task, and copied here in the matching settings. If no settings can be obtained, defaults will be applied.
+
+The configured display will be used to draw the objects, if any, that can be configured below, on.
+
+* **Screen Width (px) (x)**: Width of the display, the (horizontal) ``x`` coordinate, in pixels.
+
+* **Screen Height (px) (y)**: Height of the display, the (vertical) ``y`` coordinate, in pixels. Top/Left coordinate is 0,0.
+
+* **Rotation**: The rotation setting should match the rotation setting of the display, and can be selected as Normal (0), +90, +180 or +270 degrees.
+
+* **Display Color-depth**: If the display settings have been retrieved successfully, this setting can not be changed, but will be used from the display. This value is used to select the correct color mappings for displaying the Objects.
+
+* **Touch minimum pressure**: This setting determines the relative pressure or sensitivity of the touch display. Lower values make it more sensitive. The range is 0 to 255.
+
+.. include:: Touch_Configuration.repl
+
+
+Change log
+----------
+
+.. versionadded:: 2.0
+  ...
+
+  |added|
+  Initial release version.
+
+
+
+
+