Some tweaks

Author: GOB52

examples/UnitUnified/Dump/main/Dump.cpp

@@ -63,10 +63,9 @@ void loop()
         if (unit.detectDevice()) {
             UID uid{};
             if (unit.activateDevice(uid)) {
+                M5.Speaker.tone(1000, 20);
                 M5_LOGI("UID:%s %s", uid.uidAsString().c_str(), uid.typeAsString().c_str());
-                //
-                // Use any API...
-                //
+                unit.dumpDevice(uid);  // Using defaukt keyA if Classic
                 unit.deactivateDevice();
             }
         }

examples/UnitUnified/ValueBlock/main/ValueBlock.cpp

@@ -209,7 +209,7 @@ void loop()
             if (unit.activateDevice(uid)) {
                 if (uid.isClassic()) {
                     M5_LOGI("Restore");
-                    M5.Speaker.tone(1000, 20);
+                    M5.Speaker.tone(2000, 20);
                     M5_LOGI("UID:%s %s", uid.uidAsString().c_str(), uid.typeAsString().c_str());
 
                     uint8_t block = uid.type == Type::MIFARE_Classic_4K ? 128 : 44;

src/rfid/nfc/ndef.cpp

@@ -5,8 +5,7 @@
  */
 /*!
   @file ndef.cpp
-  @brief NFC related
-  @warning Only support NFC-A Type-2
+  @brief NDEF related
 */
 
 #include "ndef.hpp"

src/rfid/nfc/ndef.hpp

@@ -16,6 +16,10 @@
 namespace m5 {
 namespace rfid {
 namespace nfc {
+/*!
+  @namespace ndef
+  @brief For NDEF
+ */
 namespace ndef {
 
 /*!

src/rfid/nfc/nfc.hpp

@@ -18,12 +18,11 @@
 namespace m5 {
 namespace rfid {
 /*!
-  @namespce nfc
-  @brief namespace for NFC
+  @namespace nfc
+  @brief For NFC
  */
 namespace nfc {
 }  // namespace nfc
-
 }  // namespace rfid
 }  // namespace m5
 #endif

src/rfid/rfid.hpp

@@ -75,20 +75,20 @@ enum class Type : uint8_t {
     MIFARE_Classic_4K,    //!< Also known as MIFARE Standard 4K
     MIFARE_UltraLight,    //!< MIFARE Ultralight
     MIFARE_UltraLightC,   //!< MIFARE UltralightC
-    MIFARE_Plus_2K,       //!< MIFARE Plus 2K
-    MIFARE_Plus_4K,       //!< MIFARE Plus 4K
-    MIFARE_DESFire_2K,    //!< MIFARE DESFire 2K
-    MIFARE_DESFire_4K,    //!< MIFARE DESFire 4K
-    MIFARE_DESFire_8K,    //!< MIFARE DESFire 8K
+    MIFARE_Plus_2K,       //!< MIFARE Plus 2K [Not supported]
+    MIFARE_Plus_4K,       //!< MIFARE Plus 4K [Not supported]
+    MIFARE_DESFire_2K,    //!< MIFARE DESFire 2K [Not supported]
+    MIFARE_DESFire_4K,    //!< MIFARE DESFire 4K [Not supported]
+    MIFARE_DESFire_8K,    //!< MIFARE DESFire 8K [Not supported]
     NTAG_203,             //!< NATG 203
     NTAG_210u,            //!< NTAG 210μ
     NTAG_210,             //!< NTAG 210
     NTAG_212,             //!< NTAG 212
     NTAG_213,             //!< NTAG 213
     NTAG_215,             //!< NTAG 215
     NTAG_216,             //!< NTAG 216
-    ISO_14443_4,          //!< PICC compliant with ISO/IEC 14443-4
-    ISO_18092,            //!< PICC compliant with ISO/IEC 18092 (NFC)
+    ISO_14443_4,          //!< PICC compliant with ISO/IEC 14443-4 [Not supported]
+    ISO_18092,            //!< PICC compliant with ISO/IEC 18092 (NFC) [Not supported]
     NotCompleted = 0xFF,  //!< SAK indicates UID is not complete
 };
 

src/unit/unit_MFRC522.hpp

@@ -26,17 +26,17 @@ namespace mfrc522 {
   @brief PCD command
 */
 enum class Command : uint8_t {
-    Idle,                //!< no action, cancels current command execution
-    Mem,                 //!< stores 25 bytes into the internal buffer
-    GenerateRandomID,    //!< generates a 10-byte random ID number
-    CalcCRC,             //!< activates the CRC coprocessor or performs a self test
-    Transmit,            //!< transmits data from the FIFO buffer
-    NoCmdChange = 0x07,  //!< no command change
-    Receive,             //!< activates the receiver circuits
-    Transceive = 0x0C,   //!< transmits data from FIFO buffer to antenna and automatically activates the receiver after
+    Idle,                //!< No action, cancels current command execution
+    Mem,                 //!< Stores 25 bytes into the internal buffer
+    GenerateRandomID,    //!< Generates a 10-byte random ID number
+    CalcCRC,             //!< Activates the CRC coprocessor or performs a self test
+    Transmit,            //!< Transmits data from the FIFO buffer
+    NoCmdChange = 0x07,  //!< No command change
+    Receive,             //!< Activates the receiver circuits
+    Transceive = 0x0C,   //!< Transmits data from FIFO buffer to antenna and automatically activates the receiver after
                          //!< transmission
-    MFAuthent = 0x0E,    //!< performs the MIFARE standard authentication as a reader
-    SoftReset,           //!< performs the MIFARE standard authentication as a reader
+    MFAuthent = 0x0E,    //!< Performs the MIFARE standard authentication as a reader
+    SoftReset,           //!< Resets the MFRC522
 };
 
 /*!
@@ -61,7 +61,7 @@ enum class ReceiverGain : uint8_t {
 enum class Error : uint8_t {
     OCCUR_COLLISION,     //!< Ccollision occurs
     UID_NOT_COLMPLETED,  //!< UID is not yet complete
-    ARGUMENT = 0x80,     //!< Error caused by arguments
+    ARGUMENT = 0x80,     //!< Error caused by arguments (0x80)
     COMMUNICATION,       //!< Error in communication (0x81)
     REGISTER,            //!< Error by error register value (0x82)
     TIMEOUT,             //!< Timeout occurs (0x83)
@@ -84,6 +84,10 @@ class UnitMFRC522 : public Component {
     M5_UNIT_COMPONENT_HPP_BUILDER(UnitMFRC522, 0x28);
 
 public:
+    /*!
+      @brief API return value
+      @note The user can treat it as if it were a bool type
+    */
     using result_t = m5::stl::expected<void, mfrc522::Error>;
 
     /*!
@@ -192,11 +196,16 @@ class UnitMFRC522 : public Component {
     bool writeReceiverGain(const mfrc522::ReceiverGain gain);
     ///@}
 
+    ///@note Timer settings
     ///@name TPrescale
     ///@{
+    //! @brief Read the TPrescale
     bool readTPrescale(uint16_t& tprescale);
+    //! @brief Read the TPrescale
     bool readTPrescale(float& tprescale);
+    //! @brief Write the TPrescale
     bool writeTPrescale(const uint16_t tprescale);
+    //! @brief Write the TPrescale
     bool writeTPrescale(const float tprescale);
     ///@}
 
@@ -242,14 +251,16 @@ class UnitMFRC522 : public Component {
       @note Device status changes from READY to ACTIVE
       @note Device status changes from READY* to ACTIVE*
       @note ISO14443-4 processing can be performed on devices in ACTIVE state
+      @warning Whenever an operation on an activated device is no longer required, it must be deactivated
     */
     result_t activateDevice(UID& uid);
     /*!
       @brief Deactivate device
-      @param uid target UID
+      @param uid Target UID
       @return True if successful
       @note Send HLTA command and stop crypt1
       @note Device status changes from ACTIVE to HALT
+      @note Device status changes from ACTIVE* to HALT
     */
     result_t deactivateDevice();
     ///@}