Michel2/ESPEasy
1
0
Fork 0
mirror of https://github.com/letscontrolit/ESPEasy.git synced 2026-09-12 09:36:59 +00:00
Code Issues Releases Activity

[P016] Update documentation

Browse Source
This commit is contained in:
Ton Huisman
2022-08-08 22:00:09 +02:00
parent 8d3df1ad02
commit ac305fdf7f
4 changed files with 34 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/Plugin/P016.rst
+8 -1
View File
@@ -44,14 +44,21 @@ Change log
.. versionchanged:: 2.0
...
2022-08-08:
|added|
Major overhaul for 2.0 release.
The buffer used for receiving and processing the incoming data can now be manually configured.
2021-05-24:
|added|
Support for IR codes up to 64 bit with separated Decode type and Repeat option, existing settings are converted, reworked the settings UI to reflect those changes.
.
|added|
Major overhaul for 2.0 release.
.. versionadded:: 1.0
...
docs/source/Plugin/P016_DeviceConfiguration.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 90 KiB

docs/source/Plugin/P016_Setup.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 39 KiB

docs/source/Plugin/P016_TSOP4838.rst
+26 -45
View File
@@ -19,7 +19,7 @@ A datasheet for the TSOP4838 receiver can be found here: http://www.vishay.com/d
Setup
-----
.. image:: P016_Setup.png
.. image:: P016_DeviceConfiguration.png
Task settings
~~~~~~~~~~~~~
@@ -31,71 +31,52 @@ Task settings
Sensor
^^^^^^
* **Sensor**: standard definition for a GPIO pin setting
* **Internal PullUp**: To enable the internal pull-up resistor of the ESP. Usually not needed for the TSOP4838 as it has a built-in pull-up mechanism.
* **Inversed Logic**: Can be used to invert the signal if a different type of receiver is used.
* **GPIO <- IR**: Select the pin that the TSOP is connected to. Avoid selecting a pin that has a warning sign next to it, as that may block the boot process or normal working of the ESP.
* **Receiver buffer size**: For receiving and decoding the data from the sensor, a buffer is needed. For more complex protocols, like often used for Air Conditioner remote controls, a larger buffer may be needed. By default this buffer is dimensioned at 300 bytes (will be rounded up to the next even number when stored), and needs to be enlarged if a message of this intent is shown in the log at INFO level (Either Web or serial log).
Content
^^^^^^^
Add new received code to command lines
""""""""""""""""""""""""""""""""""""""
* **Add new received code to command lines**: After receiving a valid IR code the code is automatically added to the following table if it not already exists.
After receiving a valid IR code the code is automatically added to the following table if it not already exists.
* **Execute commands**: After receiving a valid IR the command that is assigned to this code (**Code [Hex]** or **Alt. Code [Hex]**) is executed.
Execute commands
""""""""""""""""
* **Inhibit time for the same command [ms]**: The time that a same command will be ignored if receiving it multiple times. When set too high, often repeated commands like volume-up or volume-down will respond slower than expected.
After receiving a valid IR the command that is assigned to this code (**Code [Hex]** or **Alt. Code [Hex]**) is executed.
Inhibit time for the same command [ms]
""""""""""""""""""""""""""""""""""""""
The time that a same command will be ignored if receiving it multiple times. When set too high, often repeated commands like volume-up or volume-down will respond slower than expected.
.. note:: The code is only added automatically to field **Code [Hex]**!
.. note:: The code is *only* added automatically to field **Code [Hex]**!
Code - command map
^^^^^^^^^^^^^^^^^^
Decode type
""""""""""""
* **Decode type**: The type as detected by the receiver, the list contains all supported types.
The type as detected by the receiver, the list contains all supported types.
* **Repeat**: If a repeat code is detected, this is checked.
Repeat
""""""
* **Code [Hex]**: If the received valid IR code matches this setting the **Command nn** is executed.
If a repeat code is detected, this is checked.
* **Alt. Decode type**: The type as detected by the receiver, the list contains all supported types.
Code [Hex]
"""""""""""""
* **Repeat**: If a repeat code is detected, this is checked.
If the received valid IR code matches this setting the **Command nn** is executed.
* **Alt. Code [Hex]**: If the received valid IR code matches this setting the **Command nn** is executed.
Alt. Decode type
""""""""""""""""
The type as detected by the receiver, the list contains all supported types.
Repeat
""""""
If a repeat code is detected, this is checked.
Alt. Code [Hex]
"""""""""""""""
If the received valid IR code matches this setting the **Command nn** is executed.
Command nn
""""""""""
If the received valid IR code matches the code in **Code [Hex]** or **Alt. Code [Hex]** this command is executed.
* **Command nn**:If the received valid IR code matches the code in **Code [Hex]** or **Alt. Code [Hex]** this command is executed.
.. note:: Up to 10 commands can be set !
.. note:: Using compile-time options, the **Code - command map** and related options can be disabled.
Data acquisition
^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~
This group of settings, **Single event with all values** settings are standard available configuration items.
Values
^^^^^^
~~~~~~
The last received code is available in numeric for in the Value that's selected here. It can be used in rules and other template processing plugins like Display devices.