From b73457cad10be1ca9b1be3984ef7b7f4008fe6b4 Mon Sep 17 00:00:00 2001 From: Rotzbua Date: Mon, 4 Jan 2016 07:03:24 +0100 Subject: [PATCH] upd codestyle example - make examples more equal --- examples/ChangeUID/ChangeUID.ino | 161 ++++++++---------- examples/DumpInfo/DumpInfo.ino | 37 ++-- examples/FixBrickedUID/FixBrickedUID.ino | 67 +++----- examples/firmware_check/firmware_check.ino | 6 +- .../rfid_write_personal_data.ino | 9 +- 5 files changed, 123 insertions(+), 157 deletions(-) diff --git a/examples/ChangeUID/ChangeUID.ino b/examples/ChangeUID/ChangeUID.ino index c04ee87..72f6b44 100644 --- a/examples/ChangeUID/ChangeUID.ino +++ b/examples/ChangeUID/ChangeUID.ino @@ -1,28 +1,15 @@ /* - * MFRC522 - Library to use ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS SPI W AND R BY COOQROBOT. - * The library file MFRC522.h has a wealth of useful info. Please read it. - * The functions are documented in MFRC522.cpp. - * - * Based on code Dr.Leong ( WWW.B2CQSHOP.COM ) - * Created by Miguel Balboa (circuitito.com), Jan, 2012. - * Rewritten by Søren Thing Andersen (access.thing.dk), fall of 2013 (Translation to English, refactored, comments, anti collision, cascade levels.) - * Extended by Tom Clement with functionality to write to sector 0 of UID changeable Mifare cards. + * -------------------------------------------------------------------------------------------------------------------- + * Example to change UID of changeable MIFARE card. + * -------------------------------------------------------------------------------------------------------------------- + * This is a MFRC522 library example; for further details and other examples see: https://github.com/miguelbalboa/rfid * - * Released into the public domain. - * * This sample shows how to set the UID on a UID changeable MIFARE card. + * NOTE: for more informations read the README.rst * - ----------------------------------------------------------------------------- empty_skull - - - Aggiunti pin per arduino Mega - - Scritto semplice codice per la scrittura e lettura - - - add pin configuration for arduino mega - - write simple read/write Code for new entry user - - http://mac86project.altervista.org/ - - ----------------------------------------------------------------------------- Nicola Coppola + * @author Tom Clement + * @license Released into the public domain. + * * Typical pin layout used: * ----------------------------------------------------------------------------------------- * MFRC522 Arduino Arduino Arduino Arduino Arduino @@ -34,91 +21,91 @@ * SPI MOSI MOSI 11 / ICSP-4 51 D11 ICSP-4 16 * SPI MISO MISO 12 / ICSP-1 50 D12 ICSP-1 14 * SPI SCK SCK 13 / ICSP-3 52 D13 ICSP-3 15 - * - * The reader can be found on eBay for around 5 dollars. Search for "mf-rc522" on ebay.com. */ #include #include +#define RST_PIN 9 // Configurable, see typical pin layout above +#define SS_PIN 10 // Configurable, see typical pin layout above + +MFRC522 mfrc522(SS_PIN, RST_PIN); // Create MFRC522 instance + /* Set your new UID here! */ #define NEW_UID {0xDE, 0xAD, 0xBE, 0xEF} -#define SS_PIN 10 -#define RST_PIN 9 -MFRC522 mfrc522(SS_PIN, RST_PIN); // Create MFRC522 instance. MFRC522::MIFARE_Key key; void setup() { - Serial.begin(9600); // Initialize serial communications with the PC - while (!Serial); // Do nothing if no serial port is opened (added for Arduinos based on ATMEGA32U4) - SPI.begin(); // Init SPI bus - mfrc522.PCD_Init(); // Init MFRC522 card - Serial.println(F("Warning: this example overwrites the UID of your UID changeable card, use with care!")); - - // Prepare key - all keys are set to FFFFFFFFFFFFh at chip delivery from the factory. - for (byte i = 0; i < 6; i++) { - key.keyByte[i] = 0xFF; - } + Serial.begin(9600); // Initialize serial communications with the PC + while (!Serial); // Do nothing if no serial port is opened (added for Arduinos based on ATMEGA32U4) + SPI.begin(); // Init SPI bus + mfrc522.PCD_Init(); // Init MFRC522 card + Serial.println(F("Warning: this example overwrites the UID of your UID changeable card, use with care!")); + + // Prepare key - all keys are set to FFFFFFFFFFFFh at chip delivery from the factory. + for (byte i = 0; i < 6; i++) { + key.keyByte[i] = 0xFF; + } } // Setting the UID can be as simple as this: //void loop() { -// byte newUid[] = NEW_UID; -// if ( mfrc522.MIFARE_SetUid(newUid, (byte)4, true) ) { -// Serial.println("Wrote new UID to card."); -// } -// delay(1000); +// byte newUid[] = NEW_UID; +// if ( mfrc522.MIFARE_SetUid(newUid, (byte)4, true) ) { +// Serial.println("Wrote new UID to card."); +// } +// delay(1000); //} // But of course this is a more proper approach void loop() { - // Look for new cards, and select one if present - if ( ! mfrc522.PICC_IsNewCardPresent() || ! mfrc522.PICC_ReadCardSerial() ) { - delay(50); - return; - } - - // Now a card is selected. The UID and SAK is in mfrc522.uid. - - // Dump UID - Serial.print(F("Card UID:")); - for (byte i = 0; i < mfrc522.uid.size; i++) { - Serial.print(mfrc522.uid.uidByte[i] < 0x10 ? " 0" : " "); - Serial.print(mfrc522.uid.uidByte[i], HEX); - } - Serial.println(); + // Look for new cards, and select one if present + if ( ! mfrc522.PICC_IsNewCardPresent() || ! mfrc522.PICC_ReadCardSerial() ) { + delay(50); + return; + } + + // Now a card is selected. The UID and SAK is in mfrc522.uid. + + // Dump UID + Serial.print(F("Card UID:")); + for (byte i = 0; i < mfrc522.uid.size; i++) { + Serial.print(mfrc522.uid.uidByte[i] < 0x10 ? " 0" : " "); + Serial.print(mfrc522.uid.uidByte[i], HEX); + } + Serial.println(); - // Dump PICC type -// MFRC522::PICC_Type piccType = mfrc522.PICC_GetType(mfrc522.uid.sak); -// Serial.print(F("PICC type: ")); -// Serial.print(mfrc522.PICC_GetTypeName(piccType)); -// Serial.print(F(" (SAK ")); -// Serial.print(mfrc522.uid.sak); -// Serial.print(")\r\n"); -// if ( piccType != MFRC522::PICC_TYPE_MIFARE_MINI -// && piccType != MFRC522::PICC_TYPE_MIFARE_1K -// && piccType != MFRC522::PICC_TYPE_MIFARE_4K) { -// Serial.println(F("This sample only works with MIFARE Classic cards.")); -// return; -// } - - // Set new UID - byte newUid[] = NEW_UID; - if ( mfrc522.MIFARE_SetUid(newUid, (byte)4, true) ) { - Serial.println(F("Wrote new UID to card.")); - } - - // Halt PICC and re-select it so DumpToSerial doesn't get confused - mfrc522.PICC_HaltA(); - if ( ! mfrc522.PICC_IsNewCardPresent() || ! mfrc522.PICC_ReadCardSerial() ) { - return; - } - - // Dump the new memory contents - Serial.println(F("New UID and contents:")); - mfrc522.PICC_DumpToSerial(&(mfrc522.uid)); - - delay(2000); + // Dump PICC type +// MFRC522::PICC_Type piccType = mfrc522.PICC_GetType(mfrc522.uid.sak); +// Serial.print(F("PICC type: ")); +// Serial.print(mfrc522.PICC_GetTypeName(piccType)); +// Serial.print(F(" (SAK ")); +// Serial.print(mfrc522.uid.sak); +// Serial.print(")\r\n"); +// if ( piccType != MFRC522::PICC_TYPE_MIFARE_MINI +// && piccType != MFRC522::PICC_TYPE_MIFARE_1K +// && piccType != MFRC522::PICC_TYPE_MIFARE_4K) { +// Serial.println(F("This sample only works with MIFARE Classic cards.")); +// return; +// } + + // Set new UID + byte newUid[] = NEW_UID; + if ( mfrc522.MIFARE_SetUid(newUid, (byte)4, true) ) { + Serial.println(F("Wrote new UID to card.")); + } + + // Halt PICC and re-select it so DumpToSerial doesn't get confused + mfrc522.PICC_HaltA(); + if ( ! mfrc522.PICC_IsNewCardPresent() || ! mfrc522.PICC_ReadCardSerial() ) { + return; + } + + // Dump the new memory contents + Serial.println(F("New UID and contents:")); + mfrc522.PICC_DumpToSerial(&(mfrc522.uid)); + + delay(2000); } diff --git a/examples/DumpInfo/DumpInfo.ino b/examples/DumpInfo/DumpInfo.ino index c74281a..a6345b1 100644 --- a/examples/DumpInfo/DumpInfo.ino +++ b/examples/DumpInfo/DumpInfo.ino @@ -1,29 +1,24 @@ /* - * ---------------------------------------------------------------------------- - * This is a MFRC522 library example; see https://github.com/miguelbalboa/rfid - * for further details and other examples. + * -------------------------------------------------------------------------------------------------------------------- + * Example sketch/program showing how to read data from a PICC to serial. + * -------------------------------------------------------------------------------------------------------------------- + * This is a MFRC522 library example; for further details and other examples see: https://github.com/miguelbalboa/rfid * - * NOTE: The library file MFRC522.h has a lot of useful info. Please read it. + * Example sketch/program showing how to read data from a PICC (that is: a RFID Tag or Card) using a MFRC522 based RFID + * Reader on the Arduino SPI interface. * - * Released into the public domain. - * ---------------------------------------------------------------------------- - * Example sketch/program showing how to read data from a PICC (that is: a RFID - * Tag or Card) using a MFRC522 based RFID Reader on the Arduino SPI interface. + * When the Arduino and the MFRC522 module are connected (see the pin layout below), load this sketch into Arduino IDE + * then verify/compile and upload it. To see the output: use Tools, Serial Monitor of the IDE (hit Ctrl+Shft+M). When + * you present a PICC (that is: a RFID Tag or Card) at reading distance of the MFRC522 Reader/PCD, the serial output + * will show the ID/UID, type and any data blocks it can read. Note: you may see "Timeout in communication" messages + * when removing the PICC from reading distance too early. * - * When the Arduino and the MFRC522 module are connected (see the pin layout - * below), load this sketch into Arduino IDE then verify/compile and upload it. - * To see the output: use Tools, Serial Monitor of the IDE (hit Ctrl+Shft+M). - * When you present a PICC (that is: a RFID Tag or Card) at reading distance - * of the MFRC522 Reader/PCD, the serial output will show the ID/UID, type and - * any data blocks it can read. Note: you may see "Timeout in communication" - * messages when removing the PICC from reading distance too early. + * If your reader supports it, this sketch/program will read all the PICCs presented (that is: multiple tag reading). + * So if you stack two or more PICCs on top of each other and present them to the reader, it will first output all + * details of the first and then the next PICC. Note that this may take some time as all data blocks are dumped, so + * keep the PICCs at reading distance until complete. * - * If your reader supports it, this sketch/program will read all the PICCs - * presented (that is: multiple tag reading). So if you stack two or more - * PICCs on top of each other and present them to the reader, it will first - * output all details of the first and then the next PICC. Note that this - * may take some time as all data blocks are dumped, so keep the PICCs at - * reading distance until complete. + * @license Released into the public domain. * * Typical pin layout used: * ----------------------------------------------------------------------------------------- diff --git a/examples/FixBrickedUID/FixBrickedUID.ino b/examples/FixBrickedUID/FixBrickedUID.ino index eea1cf4..838b8a9 100644 --- a/examples/FixBrickedUID/FixBrickedUID.ino +++ b/examples/FixBrickedUID/FixBrickedUID.ino @@ -1,28 +1,14 @@ /* - * MFRC522 - Library to use ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS SPI W AND R BY COOQROBOT. - * The library file MFRC522.h has a wealth of useful info. Please read it. - * The functions are documented in MFRC522.cpp. - * - * Based on code Dr.Leong ( WWW.B2CQSHOP.COM ) - * Created by Miguel Balboa (circuitito.com), Jan, 2012. - * Rewritten by Søren Thing Andersen (access.thing.dk), fall of 2013 (Translation to English, refactored, comments, anti collision, cascade levels.) - * Extended by Tom Clement with functionality to write to sector 0 of UID changeable Mifare cards. + * -------------------------------------------------------------------------------------------------------------------- + * Example sketch/program to fix a broken UID changeable MIFARE cards. + * -------------------------------------------------------------------------------------------------------------------- + * This is a MFRC522 library example; for further details and other examples see: https://github.com/miguelbalboa/rfid * - * Released into the public domain. - * - * This sample shows how to fix a UID changeable MIFARE cards that have a corrupted sector 0. + * This sample shows how to fix a broken UID changeable MIFARE cards that have a corrupted sector 0. + * + * @author Tom Clement + * @license Released into the public domain. * - ----------------------------------------------------------------------------- empty_skull - - - Aggiunti pin per arduino Mega - - Scritto semplice codice per la scrittura e lettura - - - add pin configuration for arduino mega - - write simple read/write Code for new entry user - - http://mac86project.altervista.org/ - - ----------------------------------------------------------------------------- Nicola Coppola * Typical pin layout used: * ----------------------------------------------------------------------------------------- * MFRC522 Arduino Arduino Arduino Arduino Arduino @@ -34,35 +20,34 @@ * SPI MOSI MOSI 11 / ICSP-4 51 D11 ICSP-4 16 * SPI MISO MISO 12 / ICSP-1 50 D12 ICSP-1 14 * SPI SCK SCK 13 / ICSP-3 52 D13 ICSP-3 15 - * - * The reader can be found on eBay for around 5 dollars. Search for "mf-rc522" on ebay.com. */ #include #include -#define SS_PIN 10 -#define RST_PIN 9 +#define RST_PIN 9 // Configurable, see typical pin layout above +#define SS_PIN 10 // Configurable, see typical pin layout above + +MFRC522 mfrc522(SS_PIN, RST_PIN); // Create MFRC522 instance -MFRC522 mfrc522(SS_PIN, RST_PIN); // Create MFRC522 instance. MFRC522::MIFARE_Key key; void setup() { - Serial.begin(9600); // Initialize serial communications with the PC - while (!Serial); // Do nothing if no serial port is opened (added for Arduinos based on ATMEGA32U4) - SPI.begin(); // Init SPI bus - mfrc522.PCD_Init(); // Init MFRC522 card - Serial.println(F("Warning: this example clears your mifare UID, use with care!")); - - // Prepare key - all keys are set to FFFFFFFFFFFFh at chip delivery from the factory. - for (byte i = 0; i < 6; i++) { - key.keyByte[i] = 0xFF; - } + Serial.begin(9600); // Initialize serial communications with the PC + while (!Serial); // Do nothing if no serial port is opened (added for Arduinos based on ATMEGA32U4) + SPI.begin(); // Init SPI bus + mfrc522.PCD_Init(); // Init MFRC522 card + Serial.println(F("Warning: this example clears your mifare UID, use with care!")); + + // Prepare key - all keys are set to FFFFFFFFFFFFh at chip delivery from the factory. + for (byte i = 0; i < 6; i++) { + key.keyByte[i] = 0xFF; + } } void loop() { - if ( mfrc522.MIFARE_UnbrickUidSector(false) ) { - Serial.println(F("Cleared sector 0, set UID to 1234. Card should be responsive again now.")); - } - delay(1000); + if ( mfrc522.MIFARE_UnbrickUidSector(false) ) { + Serial.println(F("Cleared sector 0, set UID to 1234. Card should be responsive again now.")); + } + delay(1000); } diff --git a/examples/firmware_check/firmware_check.ino b/examples/firmware_check/firmware_check.ino index 5c4a7f5..66bc706 100644 --- a/examples/firmware_check/firmware_check.ino +++ b/examples/firmware_check/firmware_check.ino @@ -6,10 +6,10 @@ * * This example test the firmware of your MFRC522 reader module, only known version can be checked. If the test passed * it do not mean that your module is faultless! Some modules have bad or broken antennas or the PICC is broken. - * * NOTE: for more informations read the README.rst * - * Released into the public domain. + * @author Rotzbua + * @license Released into the public domain. * * Typical pin layout used: * ----------------------------------------------------------------------------------------- @@ -22,8 +22,6 @@ * SPI MOSI MOSI 11 / ICSP-4 51 D11 ICSP-4 16 * SPI MISO MISO 12 / ICSP-1 50 D12 ICSP-1 14 * SPI SCK SCK 13 / ICSP-3 52 D13 ICSP-3 15 - * - * @author Rotzbua */ #include diff --git a/examples/rfid_write_personal_data/rfid_write_personal_data.ino b/examples/rfid_write_personal_data/rfid_write_personal_data.ino index aea8310..2ee6cbc 100644 --- a/examples/rfid_write_personal_data/rfid_write_personal_data.ino +++ b/examples/rfid_write_personal_data/rfid_write_personal_data.ino @@ -22,13 +22,14 @@ #include #include -#define SS_PIN 10 //Arduino Uno -#define RST_PIN 9 -MFRC522 mfrc522(SS_PIN, RST_PIN); // Create MFRC522 instance. +#define RST_PIN 9 // Configurable, see typical pin layout above +#define SS_PIN 10 // Configurable, see typical pin layout above + +MFRC522 mfrc522(SS_PIN, RST_PIN); // Create MFRC522 instance void setup() { Serial.begin(9600); // Initialize serial communications with the PC - SPI.begin(); // Init SPI bus + SPI.begin(); // Init SPI bus mfrc522.PCD_Init(); // Init MFRC522 card Serial.println(F("Write personal data on a MIFARE PICC ")); }