[P111] MFRC522 RFID reader moved from PluginPlayground

docs/source/Plugin/P111.rst

@@ -0,0 +1,83 @@
+.. include:: ../Plugin/_plugin_substitutions_p11x.repl
+.. _P111_page:
+
+|P111_typename|
+==================================================
+
+|P111_shortinfo|
+
+Plugin details
+--------------
+
+Type: |P111_type|
+
+Name: |P111_name|
+
+Status: |P111_status|
+
+GitHub: |P111_github|_
+
+Maintainer: |P111_maintainer|
+
+Used libraries: |P111_usedlibraries|
+
+Description
+-----------
+
+This SPI device reads the tag ID from Mifare tags, cards and stickers using the NXP MFRC522 NFC chip.
+
+The value is placed in the Tag variable, and can be read from rules and sent to controllers.
+
+Settings
+--------
+
+.. image:: P111_Settings.png
+
+**Name**: The name for this task, should be unique.
+
+**Enabled**: Allows to enable/disable the device.
+
+This device is connected via SPI, so the SPI interface should be enabled on the Hardware tab. There, also the common SPI pin numbers are shown. CS and other optional pin configurations are to be set in the device cconfiguration.
+
+The MFRC522 needs at least the CS pin configured, the RST (Reset) pin is optional.
+
+**CS Pin**: The Chip Select signal, often labeled SDA on the board.
+
+**RST Pin**: Optional pin that is pulled low when communication with the device fails a few times. Usually labeled RST on the board.
+
+**Tag removal mode** After scanning a tag, it can be automatically removed (reset). There are 2 removal modes, 'None' and 'Autoremove after Time-out' (default).
+
+**Tag removal Time-out** (Default 500 mSec) The timeout in milli seconds (range 0 - 60000) after which the last Tag will be automatically removed, if the Time-out option is selected.
+
+**Value to set on Tag removal** (Default 0) Set a value to the Tag when the previous tag is removed. (Range 0 to 2147483647 as larger values are difficult to store in settings.)
+
+**Event on Tag removal** (Disabled by default) When enabled sends the removed Tag value as an event and to all enabled controllers.
+
+Supported hardware
+------------------
+
+MFRC522 based NFC RFID reader connected via SPI.
+
+|P111_usedby|
+
+.. Commands available
+.. ^^^^^^^^^^^^^^^^^^
+
+.. .. include:: P111_commands.repl
+
+.. Events
+.. ~~~~~~
+
+.. .. include:: P111_events.repl
+
+Change log
+----------
+
+.. versionadded:: 2.0
+  ...
+
+  |added|
+  2021-02-07: Moved from PluginPlayground to main repository.
+
+  Added options for tag reset and event on tag reset.
+

docs/source/Plugin/_Plugin.rst

@@ -130,6 +130,7 @@ There's three different released versions of ESP Easy:
    ":ref:`P106_page`","|P106_status|","P106"
    ":ref:`P107_page`","|P107_status|","P107"
    ":ref:`P108_page`","|P108_status|","P108"
+   ":ref:`P111_page`","|P111_status|","P111"
 
 
 Internal GPIO handling

docs/source/Plugin/_plugin_categories.repl

@@ -21,7 +21,7 @@
 .. |Plugin_Output| replace:: :ref:`P029_page`, :ref:`P038_page`, :ref:`P041_page`, :ref:`P042_page`, :ref:`P043_page`, :ref:`P070_page`
 .. |Plugin_Position| replace:: :ref:`P013_page`, :ref:`P082_page`
 .. |Plugin_Regulator| replace:: :ref:`P021_page`
-.. |Plugin_RFID| replace:: :ref:`P008_page`, :ref:`P017_page`, :ref:`P040_page`
+.. |Plugin_RFID| replace:: :ref:`P008_page`, :ref:`P017_page`, :ref:`P040_page`, :ref:`P111_page`
 .. |Plugin_Switch_input| replace:: :ref:`P001_page`, :ref:`P009_page`, :ref:`P019_page`, :ref:`P059_page`, :ref:`P080_page`, :ref:`P091_page`, :ref:`P097_page`
 .. |Plugin_Touch| replace:: :ref:`P097_page`, :ref:`P099_page`
 .. |Plugin_Weight| replace:: :ref:`P067_page`

docs/source/Plugin/_plugin_substitutions.repl

@@ -9,3 +9,4 @@
 .. include:: ../Plugin/_plugin_substitutions_p08x.repl
 .. include:: ../Plugin/_plugin_substitutions_p09x.repl
 .. include:: ../Plugin/_plugin_substitutions_p10x.repl
+.. include:: ../Plugin/_plugin_substitutions_p11x.repl

docs/source/Plugin/_plugin_substitutions_p11x.repl

@@ -0,0 +1,13 @@
+
+.. |P111_name| replace:: :cyan:`MFRC5222`
+.. |P111_type| replace:: :cyan:`RFID`
+.. |P111_typename| replace:: :cyan:`RFID - MFRC522`
+.. |P111_porttype| replace:: `.`
+.. |P111_status| replace:: :yellow:`TESTING`
+.. |P111_github| replace:: P111_RC522_RFID.ino
+.. _P111_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P111_RC522_RFID.ino
+.. |P111_usedby| replace:: `.`
+.. |P111_shortinfo| replace:: `RFID Reader`
+.. |P111_maintainer| replace:: `TD-er, twinbee77, tonhuisman`
+.. |P111_compileinfo| replace:: `.`
+.. |P111_usedlibraries| replace:: `https://github.com/miguelbalboa/rfid (local copy)`