MFRC-522 RFID Module?

[beicnet]

Hi there,

And what about MFRC-522 RFID Module (Blue) implementation?

Cheaper than any other already implemented RFID Module by two times!

Kind regards, Viktor

[patrickse]

👍

[uzi18]

But has got very short range

29.11.2017 8:36 PM "Patrick Sernetz" notifications@github.com napisał(a):

👍

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/letscontrolit/ESPEasy/issues/198#issuecomment-347971775, or mute the thread https://github.com/notifications/unsubscribe-auth/AAHOU0_AfqbJ_yijNMr_w2fMtkQKsj4Kks5s7bI4gaJpZM4MyJwi .

[vikasjee]

Do you plan to support this?

[TD-er]

Well looks like something worth to look into.

@uzi18 What range does it have? A few cm?

[beicnet]

Specification

• Module Name: MF522-ED
• Working current：13 - 26mA / DC 3.3V
• Standby current：10 - 13mA / DC 3.3V
• Sleep current：<80uA
• Peak current：<30mA
• Working frequency：13.56MHz
• Card reading distance ：0～60mm （Mifare1 card）
• Protocol：SPI
• Data communication speed：10Mbit/s Max.
• Card types supported: Mifare1 S50, Mifare1 S70, Mifare UltraLight, Mifare Pro, Mifare Desfire
• Dimension：40mm × 60mm
• Working temperature：-20—80 degree
• Storage temperature：-40—85 degree
• Humidity：relevant humidity 5%—95%

[tuxmartin]

Please add support of RC522.

I found it on wishlist https://www.letscontrolit.com/forum/viewtopic.php?t=736 Do you have a time estimate?

Thank you!

[Grovkillen]

Any developer that got this unit and its planning to have it implemented?

[TD-er]

Yep, it's here on the big pile of stuff to implement.

[Grovkillen]

Cool, I will order one as well... No hurry though! :smiley:

[Tueftler1983]

is there a Plan or date, how did it supportet?? i use at this time a extra nodemcu to integrate it in Fhem

[TD-er]

At this moment all available dev time is put into making stuff stable again. There are currently too many issues:

• wifi
• webpage loading
• damaged settings
• all kinds of other issues leading to instability.

[jensfr1]

esp-rfid works just fine with the rfid reader.

https://github.com/omersiar/esp-rfid/releases

[plin2]

Well, what's the state one year later? I have ESPeasy running on an ESP32 with OLED display. The only thing missing is my RC522 RFID reader.

[TD-er]

@plin2 I have not done anything with this plugin. The reader may have moved from the "big pile of stuff to implement" into a nice box labeled "Sensors for ESPeasy".

I have not had the time yet to have a good look at it.

[uzi18]

@TD-er my reader have range about 1-2cm

[s0170071]

I found some code on the internet and scetched a plugin. It just reads the RFID serial number which is okay for my door lock. The rest I do in OpenHab anyway. The RFID is pushed to the (MQTT) controller the very moment the card is read.

Use:

1. copy code to an empty .ino file, put it in the ESPEasy folder. (ArduinoIDE)
2. get the MFRC522 library. I used the latest version, 1.4.5. Just unzip it to your libraries folder.
3. compile...

/*
* Typical pin layout used:
* -----------------------------------------------------------------------------------------
*             MFRC522      Arduino       Arduino   Arduino    Arduino          Arduino      WemosD1 /ESP8266
*             Reader/PCD   Uno/101       Mega      Nano v3    Leonardo/Micro   Pro Micro
* Signal      Pin          Pin           Pin       Pin        Pin              Pin
* -----------------------------------------------------------------------------------------
* RST/Reset   RST          9             5         D9         RESET/ICSP-5     RST          D0/GPIO16
* SPI SS      SDA(SS)      10            53        D10        10               10           D8/GPIO15
* SPI MOSI    MOSI         11 / ICSP-4   51        D11        ICSP-4           16           D7/GPIO13
* SPI MISO    MISO         12 / ICSP-1   50        D12        ICSP-1           14           D6/GPIO12
* SPI SCK     SCK          13 / ICSP-3   52        D13        ICSP-3           15           D5/GPIO14
*/
#include <SPI.h>
#include <MFRC522.h>
#define RST_PIN   D0     // SPI Reset Pin, optional
#define SS_PIN    D8    // SPI Slave Select Pin
//#######################################################################################################

#define PLUGIN_017
#define PLUGIN_ID_017         17
#define PLUGIN_NAME_017       "RFID - RC522"
#define PLUGIN_VALUENAME1_017 "Tag"
MFRC522 *mfrc522 = nullptr;
boolean Plugin_017(byte function, struct EventStruct *event, String& string)
{
  boolean success = false;
  switch (function)
  {
    case PLUGIN_DEVICE_ADD:
      {
        Device[++deviceCount].Number = PLUGIN_ID_017;
        Device[deviceCount].Type = DEVICE_TYPE_SINGLE;
        Device[deviceCount].VType = SENSOR_TYPE_LONG;
        Device[deviceCount].Ports = 0;
        Device[deviceCount].PullUpOption = false;
        Device[deviceCount].InverseLogicOption = false;
        Device[deviceCount].ValueCount = 1;
        Device[deviceCount].SendDataOption = true;
        Device[deviceCount].TimerOption = false;
        Device[deviceCount].GlobalSyncOption = true;
        break;
      }
    case PLUGIN_GET_DEVICENAME:
      {
        string = F(PLUGIN_NAME_017);
        break;
      }

    case PLUGIN_GET_DEVICEVALUENAMES:
      {
        strcpy_P(ExtraTaskSettings.TaskDeviceValueNames[0], PSTR(PLUGIN_VALUENAME1_017));
        break;
      }

    case PLUGIN_WEBFORM_LOAD:
      {
         // addFormPinSelect(F("Reset Pin"), F("taskdevicepin3"), CONFIG_PIN3);
        success = true;
        break;
      }

    case PLUGIN_INIT:
      {
        if (mfrc522 == nullptr){
        mfrc522 = new MFRC522 (SS_PIN, RST_PIN);   // Instanz des MFRC522 erzeugen
        //SPI.begin();         // Initialisiere SPI Kommunikation
        mfrc522->PCD_Init();  // Initialisiere MFRC522 Lesemodul
        }
        break;

      }

    case PLUGIN_TEN_PER_SECOND:
      {
        static unsigned long tempcounter = 0;
        static byte counter;
        static byte errorCount=0;

        counter++;
        if (counter == 3 )
        {
        counter=0;
        if (mfrc522->PICC_IsNewCardPresent() && mfrc522->PICC_ReadCardSerial() ) {
          String log = F("PN532: Tag: ");

          // put only the first 4 bytes to user variables 0 and 1
          unsigned long key =  mfrc522->uid.uidByte[0];
          for (uint8_t i = 1; i < 4; i++) {
            key <<= 8;
            key +=  mfrc522->uid.uidByte[i];
          }
          log+=key;
          UserVar[event->BaseVarIndex] = (key & 0xFFFF);
          UserVar[event->BaseVarIndex + 1] = ((key >> 16) & 0xFFFF);

          // switch off card to be able to look for others
          mfrc522->PICC_HaltA();
          addLog(LOG_LEVEL_INFO, log);
          sendData(event);
          }
        }
        break;
      }
  }
  return success;
}

[TD-er]

@s0170071 If it is useful, can you make a PR for it with the proper plugin ID set?

[vincnico]

@s0170071 Hi , seems interesting, but I would like to be sure to understand => is this allow to run a MFRC522 with a NodeMcu and EspEasy ? and so enable the configuration on espeasy web interface ? I am using Jeedom + some NodeMCU with espeasy. I am lookink for a solution with espeasy to have my RC522 rfid reader connected to Jeedom

thank you

[pascalsaul]

@s0170071 Hi , seems interesting, but I would like to be sure to understand => is this allow to run a MFRC522 with a NodeMcu and EspEasy ? and so enable the configuration on espeasy web interface ? I am using Jeedom + some NodeMCU with espeasy. I am lookink for a solution with espeasy to have my RC522 rfid reader connected to Jeedom

thank you

Yes @vincnico , I just build it as a custom plugin with some modifications and works with the latest MFRC522 library, NodeMCU v1 and latest available build: ESPEasy_ESP82xx_mega-20200721.

It only accepts MIFARE classic cards and ignores mobile phones with NFC enabled or Credit Cards. They generate random numbers every time so are useless to use since you can't check them. In the logging I added also debug information and under devices (and MQTT) the decimal value is posted to use with your integrations.

Logging:

RFID-RC522: Type: MIFARE 1KB, Hex: 050DEFD0700000, Dec: 84799440
RFID-RC522: Your tag is not of type MIFARE Classic but PICC compliant with ISO/IEC 14443-4
RFID-RC522: Type: MIFARE 1KB, Hex: 3985AFB0, Dec: 965062576

MQTT:

esp02/rfid/tag 84799440
esp02/rfid/tag 965062576

Within ESPEasy I can't get the hex value being returned so I stick with the decimal number which is also fine. I tried something with the "SENSOR_TYPE_STRING" but then I get float conversion error with "UserVar[event->BaseVarIndex]".

I'm personally also looking at: https://www.youtube.com/watch?v=ENMul9eAB00 (https://github.com/esprfid/esp-rfid)

@TD-er I've used 99 as the plugin number which is free. I think I can make a pull request if somebody can test this plugin also.

Compiled for ESP_Easy_mega_20200802_normal_ESP8266_4M1M

[Kev0123]

@s0170071 Hi , seems interesting, but I would like to be sure to understand => is this allow to run a MFRC522 with a NodeMcu and EspEasy ? and so enable the configuration on espeasy web interface ? I am using Jeedom + some NodeMCU with espeasy. I am lookink for a solution with espeasy to have my RC522 rfid reader connected to Jeedom thank you

Yes @vincnico , I just build it as a custom plugin with some modifications and works with the latest MFRC522 library, NodeMCU v1 and latest available build: ESPEasy_ESP82xx_mega-20200721.

It only accepts MIFARE classic cards and ignores mobile phones with NFC enabled or Credit Cards. They generate random numbers every time so are useless to use since you can't check them. In the logging I added also debug information and under devices (and MQTT) the decimal value is posted to use with your integrations.

Logging:

RFID-RC522: Type: MIFARE 1KB, Hex: 050DEFD0700000, Dec: 84799440
RFID-RC522: Your tag is not of type MIFARE Classic but PICC compliant with ISO/IEC 14443-4
RFID-RC522: Type: MIFARE 1KB, Hex: 3985AFB0, Dec: 965062576

MQTT:

esp02/rfid/tag 84799440
esp02/rfid/tag 965062576

Within ESPEasy I can't get the hex value being returned so I stick with the decimal number which is also fine. I tried something with the "SENSOR_TYPE_STRING" but then I get float conversion error with "UserVar[event->BaseVarIndex]".

I'm personally also looking at: https://www.youtube.com/watch?v=ENMul9eAB00 (https://github.com/esprfid/esp-rfid)

@TD-er I've used 99 as the plugin number which is free. I think I can make a pull request if somebody can test this plugin also.

Compiled for ESP_Easy_mega_20200802_normal_ESP8266_4M1M

I'm searching for this solution for a long time. Sadly I cant get your compiled plugin to work. I don't get any output. Could you compile it with the latest release?

Regards

[uzi18]

@Kev0123 If you got problem with configuration please attach some photos/screenshots

[Kev0123]

@uzi18 if I wire it according to the sheet above I get absolutely no readout.

The only config is the GPIO.

[s0170071]

pls check your wiring. pin numbers are at the top of the code. and remember to enable the spi in the hardware settings tab.

Am 5. Februar 2021 19:23:44 schrieb Kev0123 notifications@github.com:

@s0170071 Hi , seems interesting, but I would like to be sure to understand => is this allow to run a MFRC522 with a NodeMcu and EspEasy ? and so enable the configuration on espeasy web interface ? I am using Jeedom + some NodeMCU with espeasy. I am lookink for a solution with espeasy to have my RC522 rfid reader connected to Jeedom thank youYes @vincnico , I just build it as a custom plugin with some modifications and works with the latest MFRC522 library, NodeMCU v1 and latest available build: ESPEasy_ESP82xx_mega-20200721. It only accepts MIFARE classic cards and ignores mobile phones with NFC enabled or Credit Cards. They generate random numbers every time so are useless to use since you can't check them. In the logging I added also debug information and under devices (and MQTT) the decimal value is posted to use with your integrations. Logging: RFID-RC522: Type: MIFARE 1KB, Hex: 050DEFD0700000, Dec: 84799440 RFID-RC522: Your tag is not of type MIFARE Classic but PICC compliant with ISO/IEC 14443-4 RFID-RC522: Type: MIFARE 1KB, Hex: 3985AFB0, Dec: 965062576

MQTT: esp02/rfid/tag 84799440 esp02/rfid/tag 965062576

Within ESPEasy I can't get the hex value being returned so I stick with the decimal number which is also fine. I tried something with the "SENSOR_TYPE_STRING" but then I get float conversion error with "UserVar[event->BaseVarIndex]". I'm personally also looking at: https://www.youtube.com/watch?v=ENMul9eAB00 (https://github.com/esprfid/esp-rfid) @TD-er I've used 99 as the plugin number which is free. I think I can make a pull request if somebody can test this plugin also. Compiled for ESP_Easy_mega_20200802_normal_ESP8266_4M1M I'm searching for this solution for a long time. Sadly I cant get your compiled plugin to work. I don't get any output. Could you compile it with the latest release? Regards — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

[tonhuisman]

And please don't use a dash in the task name as that will cause issues with rules processing. (Not all builds have the validation active, but it is causing issues when dashes are used).

[Kev0123]

The wiring should be according your layout (by far not the best soldering, only temp setup ;-))

SPI was indeed not enabled 🤦 But now after a reset my webserver is unreachable

[uzi18]

So you have connection problem somewhere

[Kev0123]

If I try an arduino scetch with the same setup its working fine. I just reflashed espeasy and now the webserver is available again. There is still no output for the plugin

[uzi18]

please attach photo from top

[Kev0123]

[Kev0123]

Okay, I dont know why, but now I get a readout. Tomorrow Ill test with different hardware, maybe the esp is broken. I got continous reconnects just like with my own arduino sketch.

[TD-er]

Check the 3v3 on the ESP to see if it is stable. Also the RFid close to the ESP WiFi antenna is maybe not a good idea.

[Kev0123]

After attaching longer wires my problem is solved. You can make a PR in my oppinion. Would be cool if there would be a variable "card present". For my task I could play and stop music easily this way. Like in this project: https://haus-automatisierung.com/projekt/2018/12/16/projekt-playbox-mqtt-fhem-spotify.html Here I can#t figure out why I get the connection timeouts 🤷‍♂️

Thank you all for the help!

[pascalsaul]

https://www.saul.nu/downloads/RFID-RC522-20210114.bin

I've compiled and fixed a new version of the plugin with the latest mega-20210114 and rfid 1.4.8 release for anyone who is interested. If you upgrade you should choose to a new plugin since the plugin number was overlapping.

[twinbee77]

I have try the version from pascalsaul it runs like the plugin from s0170071 how can I achieve that it jumps back to 0 after removing the card/key?

[s0170071]

spi is enabled in the hardware tab?

Am 7. Februar 2021 03:34:14 schrieb twinbee77 notifications@github.com:

I have try the version from pascalsaul But i dont have a readout then I checked the wiring several times.nothing happend then i try to the plugin from ESPEasyPluginPlayground.the same result=nothing. then i try the snippet from s0170071. Nothing When i used the example sketch from the ardunio ide all works fine. someone has an idea where I can still look for mistakes— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

[twinbee77]

I compiled your code with latest esp-mega version. It runs now.i don't know where my mistakes were. when i hold the card on the reader it shows a number always even whn i take away the card. how can I achieve that it jumps back to 0 after removing the card?

[Kev0123]

I compiled your code with latest esp-mega version. It runs now.i don't know where my mistakes were. when i hold the card on the reader it shows a number always even whn i take away the card. how can I achieve that it jumps back to 0 after removing the card?

That would be the desired behaviour like I wanted. This would make it possible to detect a present card and switch states according this. So thumbs up from me as well for this idea!

[TD-er]

That has been implemented for other RFid plugins, by @uzi18 and @tonhuisman Can one of you take a look at this one too?

[tonhuisman]

Can I safely assume that P129 in the PluginPlayground is the latest source for this plugin? If that's the case, then I can add that feature, like I did for other RFID plugins. Don't have this hardware btw, I ordered a PN532 because a) it supports I2C, and b) does accept more cards/tags (it's less picky it seems). And that makes the price less of an issue 😃 (AliX: $1.41 - $2.91 for the PN532 vs $1.13 - $1.43 for the RC522, excluding shipping).

[twinbee77]

i have modified the p129 now i can compile it runs it shows me but it dont get back to zero. Now when you can help me to add the feature it would be nice the code looks now:

_P129_RC522_RFID.txt

[tonhuisman]

I'll have a look, your adaptions seem pretty OK, except you have hard-coded the GPIO pins, I'll try to fix that too.

Edit: The Device VType should be Sensor_VType::SENSOR_TYPE_LONG, so it will display the tag completely (the long tag value is stored in 2 float fields to make it fit without bits getting 'lost', and ESPEasy then displays it correct/complete)

[TD-er]

@tonhuisman For SPI you cannot set a lot of pins, as long as you make a proper selection between ESP32 and ESP8266.

[Kev0123]

May someone could upload a compiled .bin when the "zero-readout" is working? I can't even get this to compile

[tonhuisman]

I can't even get this to compile

Working on it... it's compiling here 😉

Question (for all users of this plugin): AFAICS, currently the plugin repeats sending the last tag read until a new tag is detected, is that the desired behavior, or should it only send a tag once? (to make it consistent with the other RFID plugins)

[Kev0123]

For me It would be desired if it would only send once when the tag is placed. Otherwise the attached script would be triggered continously ( but this could be esaily be changed) I dont know how the other readers behave

[tonhuisman]

That is how I'm crafting it now, if only to make it work in the same way as the other RFID plugins, currently available.

[twinbee77]

only once when the tag is placed. and when no card is placed thy should send 0

[tonhuisman]

I've put in the requested changes, and started preparations for a PR, so I assigned a new plugin number: Plugin 111. This implies that you will have to re-add the plugin and set any configuration as required. (More work is planned to enable multiple instances of the plugin and somewhat lower memory use when not used.) Option 'Automatic Tag removal' is On by default, and 'Event on Tag removal' option is Off by default. (that's similar to the Wiegand RFID and PN532 RFID plugins) Based on current mega branch (latest development branch, including all WiFi enhancements)

A screenshot of the settings:

Created .bin files for ESP8266 (normal, 4M) and ESP32 (test, 4M). ESPEasy_20210207_normal_ESP8266_4M1M_test_ESP32_4M316k-MFRC522.zip

[twinbee77]

I give it a try

[twinbee77]

I think you are my hero today When i hold the card they show me the tag after 500 ms it goes back to 0. sending to domoticz is possible it shows correct after i mark "Event on Tag removal:" Now the plugin work how it should I will try later today the esp 32 version of the plugin.

many many thanks.

p.s. can i have the .ino file then i can compile my self or give it a github for this file?