RFID - MFRC522

RFID Reader

Plugin details

Type: RFID

Name: MFRC5222

Status ESP32: COLLECTION C

Status ESP8266: COLLECTION C

GitHub: P111_RC522_RFID.ino

Maintainer: TD-er, twinbee77, tonhuisman

Used libraries: https://github.com/miguelbalboa/rfid (local copy)

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

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.

.

Data Acquisition

This group of settings are standard available configuration items.

• Single event with all values: When this setting is enabled, all available values will be sent in a single event <TaskName>#All, with all values in order as arguments to the event.

• Show derived values: When checked, the Devices overview page, and the /json endpoint (used for updating the Devices overview page) will include any Derived values as defined. See the TaskValueSetDerived and TaskValueSetPresentation commands.

• Event & Log derived values: When checked, the Derived values will be generated as Events, to be handled in Rules, and sent to logging devices like the Syslog server and/or SD-card logging.

(The derived values options are only available if String variables feature is included in the build.)

• Send to Controller: Select the Controller(s) to send the Values to, either on a TaskRun command applied to the task, or on an Interval time action.

Send to Controller is only visible when one or more Controllers are configured.

Depending on the controller capabilities, some configuration settings may be shown:

All configured Controllers are shown here, including the enabled or disabled state (multiple Controllers can be enabled, only a single MQTT Controller can be enabled at one time!).

For each controller the user can select wether the data should be sent on each Interval (or explicit TaskRun).

For the Domoticz controllers the value index (IDX) has to be configured.

For some controllers, like Home Assistant/openHAB, there are extra options available.

• Group: This represents the group id to combine all values from multiple tasks into a single grouped-device during MQTT AutoDiscovery. Groups, by design, can span multiple ESPEasy devices, if desired, as long as the Task/Valuename combinations are unique. If a group should only combine Tasks from a single ESPEasy unit, the group id should be unique across multiple ESPEasy units. The group description, default Group <n>, can be adjusted in Home Assistant. If the Group value matches the current Unit nr, the Unit name, %sysname%, is used instead of Group <nr>.

• Retained: For MQTT Controllers, this setting can be enabled to send the values for the current task with the Retain flag set. The Publish Retain flag in the Controller settings will override this by sending all task values with Retain flag enabled.

• Send derived: This checkbox determines if any configured Derived values should also be sent to the controller (and included in the AutoDiscovery if that’s available and enabled).

• Resend MQTT Discovery: When checked, will start a resend of the MQTT Discovery process for this task after a random delay, when Submit is clicked, so any changed settings will be updated in the MQTT broker. This setting is only available if the controller is enabled, the Auto Discovery feature is available and enabled for the controller. This setting is not stored.

Other controllers, like f.e. FHEM HTTP, do not support additional settings besides the checkbox to enable sending the data.

Change log

Added in version 2.0: …

added 2021-02-07: Moved from PluginPlayground to main repository.

Added options for tag reset and event on tag reset.