From cad91967b1051c8ba1813bba0f36c68f6c8fcec7 Mon Sep 17 00:00:00 2001 From: Marcel Date: Thu, 23 May 2024 16:16:00 +0200 Subject: [PATCH] migration to platformio --- .gitattributes | 49 ++ .gitignore | 2 + include/README | 39 + lib/README | 46 + platformio.ini | 18 + src/Adafruit_PN532.cpp | 1820 ++++++++++++++++++++++++++++++++++++++++ src/Adafruit_PN532.h | 221 +++++ src/audioState.h | 73 ++ src/context.cpp | 17 + src/context.h | 15 + src/main.cpp | 185 ++++ src/sounds.h | 10 + src/state.h | 17 + src/statemachine.cpp | 37 + src/statemachine.h | 21 + src/states.cpp | 213 +++++ src/states.h | 98 +++ src/station.cpp | 17 + src/station.h | 12 + src/timer.cpp | 47 ++ src/timer.h | 17 + test/README | 11 + 22 files changed, 2985 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 include/README create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/Adafruit_PN532.cpp create mode 100644 src/Adafruit_PN532.h create mode 100644 src/audioState.h create mode 100644 src/context.cpp create mode 100644 src/context.h create mode 100644 src/main.cpp create mode 100644 src/sounds.h create mode 100644 src/state.h create mode 100644 src/statemachine.cpp create mode 100644 src/statemachine.h create mode 100644 src/states.cpp create mode 100644 src/states.h create mode 100644 src/station.cpp create mode 100644 src/station.h create mode 100644 src/timer.cpp create mode 100644 src/timer.h create mode 100644 test/README diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..145857d --- /dev/null +++ b/.gitattributes @@ -0,0 +1,49 @@ +# Auto detect text files and perform LF normalization +* text=auto +# Custom for Visual Studio +*.cs diff=csharp +# Standard to msysgit +*.doc diff=astextplain +*.DOC diff=astextplain +*.docx diff=astextplain +*.DOCX diff=astextplain +*.dot diff=astextplain +*.DOT diff=astextplain +*.pdf diff=astextplain +*.PDF diff=astextplain +*.rtf diff=astextplain +*.RTF diff=astextplain + +# ------------------------ +# LFS +#------------------------- +# libraries and packages +*.a filter=lfs -crlf +*.apk filter=lfs diff=lfs merge=lfs -text +*.dll filter=lfs -crlf +*.dylib filter=lfs diff=lfs merge=lfs -text +*.exe filter=lfs -crlf +*.rar filter=lfs diff=lfs merge=lfs -text +*.unitypackage filter=lfs -crlf +*.zip filter=lfs -crlf + +# models and playables +*.blend filter=lfs -crlf +*.wav filter=lfs diff=lfs merge=lfs -text + +# images +*.cubemap filter=lfs -crlf +*.exr filter=lfs -crlf +*.fbx filter=lfs -crlf +*.hdr filter=lfs diff=lfs merge=lfs -text +*.jpg filter=lfs -crlf +*.gif filter=lfs -crlf +*.mp3 filter=lfs -crlf +*.wav filter=lfs -crlf +*.mp4 filter=lfs -crlf +*.png filter=lfs -crlf +*.psd filter=lfs -crlf +*.tga filter=lfs -crlf +*.tif filter=lfs -crlf + + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b43bfca --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.pio +.idea diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/include/README @@ -0,0 +1,39 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..2593a33 --- /dev/null +++ b/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..89e16ed --- /dev/null +++ b/platformio.ini @@ -0,0 +1,18 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:uno] +platform = atmelavr +board = uno +framework = arduino +lib_deps = + adafruit/Adafruit BusIO@^1.16.1 + dfrobot/DFRobotDFPlayerMini@^1.0.6 + fmalpartida/LiquidCrystal@^1.5.0 diff --git a/src/Adafruit_PN532.cpp b/src/Adafruit_PN532.cpp new file mode 100644 index 0000000..802db33 --- /dev/null +++ b/src/Adafruit_PN532.cpp @@ -0,0 +1,1820 @@ +/**************************************************************************/ +/*! + @file Adafruit_PN532.cpp + + @section intro_sec Introduction + + Driver for NXP's PN532 NFC/13.56MHz RFID Transceiver + + This is a library for the Adafruit PN532 NFC/RFID breakout boards + This library works with the Adafruit NFC breakout + ----> https://www.adafruit.com/products/364 + + Check out the links above for our tutorials and wiring diagrams + These chips use SPI or I2C to communicate. + + Adafruit invests time and resources providing this open source code, + please support Adafruit and open-source hardware by purchasing + products from Adafruit! + + @section author Author + + Adafruit Industries + + @section license License + + BSD (see license.txt) + + @section HISTORY + + v2.2 - Added startPassiveTargetIDDetection() to start card detection and + readDetectedPassiveTargetID() to read it, useful when using the + IRQ pin. + + v2.1 - Added NTAG2xx helper functions + + v2.0 - Refactored to add I2C support from Adafruit_NFCShield_I2C library. + + v1.4 - Added setPassiveActivationRetries() + + v1.2 - Added writeGPIO() + - Added readGPIO() + + v1.1 - Changed readPassiveTargetID() to handle multiple UID sizes + - Added the following helper functions for text display + static void PrintHex(const byte * data, const uint32_t numBytes) + static void PrintHexChar(const byte * pbtData, const uint32_t + numBytes) + - Added the following Mifare Classic functions: + bool mifareclassic_IsFirstBlock (uint32_t uiBlock) + bool mifareclassic_IsTrailerBlock (uint32_t uiBlock) + uint8_t mifareclassic_AuthenticateBlock (uint8_t * uid, uint8_t + uidLen, uint32_t blockNumber, uint8_t keyNumber, uint8_t * keyData) uint8_t + mifareclassic_ReadDataBlock (uint8_t blockNumber, uint8_t * data) uint8_t + mifareclassic_WriteDataBlock (uint8_t blockNumber, uint8_t * data) + - Added the following Mifare Ultalight functions: + uint8_t mifareultralight_ReadPage (uint8_t page, uint8_t * buffer) +*/ +/**************************************************************************/ + +#include "Adafruit_PN532.h" + +byte pn532ack[] = {0x00, 0x00, 0xFF, + 0x00, 0xFF, 0x00}; ///< ACK message from PN532 +byte pn532response_firmwarevers[] = { + 0x00, 0x00, 0xFF, + 0x06, 0xFA, 0xD5}; ///< Expected firmware version message from PN532 + +// Uncomment these lines to enable debug output for PN532(SPI) and/or MIFARE +// related code + +// #define PN532DEBUG +// #define MIFAREDEBUG + +// If using Native Port on Arduino Zero or Due define as SerialUSB +#define PN532DEBUGPRINT Serial ///< Fixed name for debug Serial instance +//#define PN532DEBUGPRINT SerialUSB ///< Fixed name for debug Serial instance + +#define PN532_PACKBUFFSIZ 64 ///< Packet buffer size in bytes +byte pn532_packetbuffer[PN532_PACKBUFFSIZ]; ///< Packet buffer used in various + ///< transactions + +/**************************************************************************/ +/*! + @brief Instantiates a new PN532 class using software SPI. + + @param clk SPI clock pin (SCK) + @param miso SPI MISO pin + @param mosi SPI MOSI pin + @param ss SPI chip select pin (CS/SSEL) +*/ +/**************************************************************************/ +Adafruit_PN532::Adafruit_PN532(uint8_t clk, uint8_t miso, uint8_t mosi, + uint8_t ss) { + _cs = ss; + spi_dev = new Adafruit_SPIDevice(ss, clk, miso, mosi, 1000000, + SPI_BITORDER_LSBFIRST, SPI_MODE0); +} + +/**************************************************************************/ +/*! + @brief Instantiates a new PN532 class using I2C. + + @param irq Location of the IRQ pin + @param reset Location of the RSTPD_N pin + @param theWire pointer to I2C bus to use +*/ +/**************************************************************************/ +Adafruit_PN532::Adafruit_PN532(uint8_t irq, uint8_t reset, TwoWire *theWire) + : _irq(irq), _reset(reset) { + pinMode(_irq, INPUT); + pinMode(_reset, OUTPUT); + i2c_dev = new Adafruit_I2CDevice(PN532_I2C_ADDRESS, theWire); +} + +/**************************************************************************/ +/*! + @brief Instantiates a new PN532 class using hardware SPI. + + @param ss SPI chip select pin (CS/SSEL) + @param theSPI pointer to the SPI bus to use +*/ +/**************************************************************************/ +Adafruit_PN532::Adafruit_PN532(uint8_t ss, SPIClass *theSPI) { + _cs = ss; + spi_dev = new Adafruit_SPIDevice(ss, 1000000, SPI_BITORDER_LSBFIRST, + SPI_MODE0, theSPI); +} + +/**************************************************************************/ +/*! + @brief Instantiates a new PN532 class using hardware UART (HSU). + + @param reset Location of the RSTPD_N pin + @param theSer pointer to HardWare Serial bus to use +*/ +/**************************************************************************/ +Adafruit_PN532::Adafruit_PN532(uint8_t reset, HardwareSerial *theSer) + : _reset(reset) { + pinMode(_reset, OUTPUT); + ser_dev = theSer; +} + +/**************************************************************************/ +/*! + @brief Setups the HW + + @returns true if successful, otherwise false +*/ +/**************************************************************************/ +bool Adafruit_PN532::begin() { + if (spi_dev) { + // SPI initialization + if (!spi_dev->begin()) { + return false; + } + } else if (i2c_dev) { + // I2C initialization + // PN532 will fail address check since its asleep, so suppress + if (!i2c_dev->begin(false)) { + return false; + } + } else if (ser_dev) { + ser_dev->begin(115200); + // clear out anything in read buffer + while (ser_dev->available()) + ser_dev->read(); + } else { + // no interface specified + return false; + } + reset(); // HW reset - put in known state + delay(10); + wakeup(); // hey! wakeup! + return true; +} + +/**************************************************************************/ +/*! + @brief Perform a hardware reset. Requires reset pin to have been provided. +*/ +/**************************************************************************/ +void Adafruit_PN532::reset(void) { + // see Datasheet p.209, Fig.48 for timings + if (_reset != -1) { + digitalWrite(_reset, LOW); + delay(1); // min 20ns + digitalWrite(_reset, HIGH); + delay(2); // max 2ms + } +} + +/**************************************************************************/ +/*! + @brief Wakeup from LowVbat mode into Normal Mode. +*/ +/**************************************************************************/ +void Adafruit_PN532::wakeup(void) { + // interface specific wakeups - each one is unique! + if (spi_dev) { + // hold CS low for 2ms + digitalWrite(_cs, LOW); + delay(2); + } else if (ser_dev) { + uint8_t w[3] = {0x55, 0x00, 0x00}; + ser_dev->write(w, 3); + delay(2); + } + + // PN532 will clock stretch I2C during SAMConfig as a "wakeup" + + // need to config SAM to stay in Normal Mode + SAMConfig(); +} + +/**************************************************************************/ +/*! + @brief Prints a hexadecimal value in plain characters + + @param data Pointer to the byte data + @param numBytes Data length in bytes +*/ +/**************************************************************************/ +void Adafruit_PN532::PrintHex(const byte *data, const uint32_t numBytes) { + uint32_t szPos; + for (szPos = 0; szPos < numBytes; szPos++) { + PN532DEBUGPRINT.print(F("0x")); + // Append leading 0 for small values + if (data[szPos] <= 0xF) + PN532DEBUGPRINT.print(F("0")); + PN532DEBUGPRINT.print(data[szPos] & 0xff, HEX); + if ((numBytes > 1) && (szPos != numBytes - 1)) { + PN532DEBUGPRINT.print(F(" ")); + } + } + PN532DEBUGPRINT.println(); +} + +/**************************************************************************/ +/*! + @brief Prints a hexadecimal value in plain characters, along with + the char equivalents in the following format + + 00 00 00 00 00 00 ...... + + @param data Pointer to the byte data + @param numBytes Data length in bytes +*/ +/**************************************************************************/ +void Adafruit_PN532::PrintHexChar(const byte *data, const uint32_t numBytes) { + uint32_t szPos; + for (szPos = 0; szPos < numBytes; szPos++) { + // Append leading 0 for small values + if (data[szPos] <= 0xF) + PN532DEBUGPRINT.print(F("0")); + PN532DEBUGPRINT.print(data[szPos], HEX); + if ((numBytes > 1) && (szPos != numBytes - 1)) { + PN532DEBUGPRINT.print(F(" ")); + } + } + PN532DEBUGPRINT.print(F(" ")); + for (szPos = 0; szPos < numBytes; szPos++) { + if (data[szPos] <= 0x1F) + PN532DEBUGPRINT.print(F(".")); + else + PN532DEBUGPRINT.print((char)data[szPos]); + } + PN532DEBUGPRINT.println(); +} + +/**************************************************************************/ +/*! + @brief Checks the firmware version of the PN5xx chip + + @returns The chip's firmware version and ID +*/ +/**************************************************************************/ +uint32_t Adafruit_PN532::getFirmwareVersion(void) { + uint32_t response; + + pn532_packetbuffer[0] = PN532_COMMAND_GETFIRMWAREVERSION; + + if (!sendCommandCheckAck(pn532_packetbuffer, 1)) { + return 0; + } + + // read data packet + readdata(pn532_packetbuffer, 13); + + // check some basic stuff + if (0 != memcmp((char *)pn532_packetbuffer, + (char *)pn532response_firmwarevers, 6)) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Firmware doesn't match!")); +#endif + return 0; + } + + int offset = 7; + response = pn532_packetbuffer[offset++]; + response <<= 8; + response |= pn532_packetbuffer[offset++]; + response <<= 8; + response |= pn532_packetbuffer[offset++]; + response <<= 8; + response |= pn532_packetbuffer[offset++]; + + return response; +} + +/**************************************************************************/ +/*! + @brief Sends a command and waits a specified period for the ACK + + @param cmd Pointer to the command buffer + @param cmdlen The size of the command in bytes + @param timeout timeout before giving up + + @returns 1 if everything is OK, 0 if timeout occured before an + ACK was recieved +*/ +/**************************************************************************/ +// default timeout of one second +bool Adafruit_PN532::sendCommandCheckAck(uint8_t *cmd, uint8_t cmdlen, + uint16_t timeout) { + + // I2C works without using IRQ pin by polling for RDY byte + // seems to work best with some delays between transactions + uint8_t SLOWDOWN = 0; + if (i2c_dev) + SLOWDOWN = 1; + + // write the command + writecommand(cmd, cmdlen); + + // I2C TUNING + delay(1); + + // Wait for chip to say its ready! + if (!waitready(timeout)) { + return false; + } + +#ifdef PN532DEBUG + if (spi_dev == NULL) { + PN532DEBUGPRINT.println(F("IRQ received")); + } +#endif + + // read acknowledgement + if (!readack()) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("No ACK frame received!")); +#endif + return false; + } + + // I2C TUNING + delay(SLOWDOWN); + + // Wait for chip to say its ready! + if (!waitready(timeout)) { + return false; + } + + return true; // ack'd command +} + +/**************************************************************************/ +/*! + @brief Writes an 8-bit value that sets the state of the PN532's GPIO + pins. + @param pinstate P3 pins state. + + @warning This function is provided exclusively for board testing and + is dangerous since it will throw an error if any pin other + than the ones marked "Can be used as GPIO" are modified! All + pins that can not be used as GPIO should ALWAYS be left high + (value = 1) or the system will become unstable and a HW reset + will be required to recover the PN532. + + pinState[0] = P30 Can be used as GPIO + pinState[1] = P31 Can be used as GPIO + pinState[2] = P32 *** RESERVED (Must be 1!) *** + pinState[3] = P33 Can be used as GPIO + pinState[4] = P34 *** RESERVED (Must be 1!) *** + pinState[5] = P35 Can be used as GPIO + + @return 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +bool Adafruit_PN532::writeGPIO(uint8_t pinstate) { + // uint8_t errorbit; + + // Make sure pinstate does not try to toggle P32 or P34 + pinstate |= (1 << PN532_GPIO_P32) | (1 << PN532_GPIO_P34); + + // Fill command buffer + pn532_packetbuffer[0] = PN532_COMMAND_WRITEGPIO; + pn532_packetbuffer[1] = PN532_GPIO_VALIDATIONBIT | pinstate; // P3 Pins + pn532_packetbuffer[2] = 0x00; // P7 GPIO Pins (not used ... taken by SPI) + +#ifdef PN532DEBUG + PN532DEBUGPRINT.print(F("Writing P3 GPIO: ")); + PN532DEBUGPRINT.println(pn532_packetbuffer[1], HEX); +#endif + + // Send the WRITEGPIO command (0x0E) + if (!sendCommandCheckAck(pn532_packetbuffer, 3)) + return 0x0; + + // Read response packet (00 FF PLEN PLENCHECKSUM D5 CMD+1(0x0F) DATACHECKSUM + // 00) + readdata(pn532_packetbuffer, 8); + +#ifdef PN532DEBUG + PN532DEBUGPRINT.print(F("Received: ")); + PrintHex(pn532_packetbuffer, 8); + PN532DEBUGPRINT.println(); +#endif + + int offset = 6; + return (pn532_packetbuffer[offset] == 0x0F); +} + +/**************************************************************************/ +/*! + Reads the state of the PN532's GPIO pins + + @returns An 8-bit value containing the pin state where: + + pinState[0] = P30 + pinState[1] = P31 + pinState[2] = P32 + pinState[3] = P33 + pinState[4] = P34 + pinState[5] = P35 +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::readGPIO(void) { + pn532_packetbuffer[0] = PN532_COMMAND_READGPIO; + + // Send the READGPIO command (0x0C) + if (!sendCommandCheckAck(pn532_packetbuffer, 1)) + return 0x0; + + // Read response packet (00 FF PLEN PLENCHECKSUM D5 CMD+1(0x0D) P3 P7 IO1 + // DATACHECKSUM 00) + readdata(pn532_packetbuffer, 11); + + /* READGPIO response should be in the following format: + + byte Description + ------------- ------------------------------------------ + b0..5 Frame header and preamble (with I2C there is an extra 0x00) + b6 P3 GPIO Pins + b7 P7 GPIO Pins (not used ... taken by SPI) + b8 Interface Mode Pins (not used ... bus select pins) + b9..10 checksum */ + + int p3offset = 7; + +#ifdef PN532DEBUG + PN532DEBUGPRINT.print(F("Received: ")); + PrintHex(pn532_packetbuffer, 11); + PN532DEBUGPRINT.println(); + PN532DEBUGPRINT.print(F("P3 GPIO: 0x")); + PN532DEBUGPRINT.println(pn532_packetbuffer[p3offset], HEX); + PN532DEBUGPRINT.print(F("P7 GPIO: 0x")); + PN532DEBUGPRINT.println(pn532_packetbuffer[p3offset + 1], HEX); + PN532DEBUGPRINT.print(F("IO GPIO: 0x")); + PN532DEBUGPRINT.println(pn532_packetbuffer[p3offset + 2], HEX); + // Note: You can use the IO GPIO value to detect the serial bus being used + switch (pn532_packetbuffer[p3offset + 2]) { + case 0x00: // Using UART + PN532DEBUGPRINT.println(F("Using UART (IO = 0x00)")); + break; + case 0x01: // Using I2C + PN532DEBUGPRINT.println(F("Using I2C (IO = 0x01)")); + break; + case 0x02: // Using SPI + PN532DEBUGPRINT.println(F("Using SPI (IO = 0x02)")); + break; + } +#endif + + return pn532_packetbuffer[p3offset]; +} + +/**************************************************************************/ +/*! + @brief Configures the SAM (Secure Access Module) + @return true on success, false otherwise. +*/ +/**************************************************************************/ +bool Adafruit_PN532::SAMConfig(void) { + pn532_packetbuffer[0] = PN532_COMMAND_SAMCONFIGURATION; + pn532_packetbuffer[1] = 0x01; // normal mode; + pn532_packetbuffer[2] = 0x14; // timeout 50ms * 20 = 1 second + pn532_packetbuffer[3] = 0x01; // use IRQ pin! + + if (!sendCommandCheckAck(pn532_packetbuffer, 4)) + return false; + + // read data packet + readdata(pn532_packetbuffer, 9); + + int offset = 6; + return (pn532_packetbuffer[offset] == 0x15); +} + +/**************************************************************************/ +/*! + Sets the MxRtyPassiveActivation byte of the RFConfiguration register + + @param maxRetries 0xFF to wait forever, 0x00..0xFE to timeout + after mxRetries + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +bool Adafruit_PN532::setPassiveActivationRetries(uint8_t maxRetries) { + pn532_packetbuffer[0] = PN532_COMMAND_RFCONFIGURATION; + pn532_packetbuffer[1] = 5; // Config item 5 (MaxRetries) + pn532_packetbuffer[2] = 0xFF; // MxRtyATR (default = 0xFF) + pn532_packetbuffer[3] = 0x01; // MxRtyPSL (default = 0x01) + pn532_packetbuffer[4] = maxRetries; + +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Setting MxRtyPassiveActivation to ")); + PN532DEBUGPRINT.print(maxRetries, DEC); + PN532DEBUGPRINT.println(F(" ")); +#endif + + if (!sendCommandCheckAck(pn532_packetbuffer, 5)) + return 0x0; // no ACK + + return 1; +} + +/***** ISO14443A Commands ******/ + +/**************************************************************************/ +/*! + @brief Waits for an ISO14443A target to enter the field and reads + its ID. + + @param cardbaudrate Baud rate of the card + @param uid Pointer to the array that will be populated + with the card's UID (up to 7 bytes) + @param uidLength Pointer to the variable that will hold the + length of the card's UID. + @param timeout Timeout in milliseconds. + + @return 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +bool Adafruit_PN532::readPassiveTargetID(uint8_t cardbaudrate, uint8_t *uid, + uint8_t *uidLength, uint16_t timeout) { + pn532_packetbuffer[0] = PN532_COMMAND_INLISTPASSIVETARGET; + pn532_packetbuffer[1] = 1; // max 1 cards at once (we can set this to 2 later) + pn532_packetbuffer[2] = cardbaudrate; + + if (!sendCommandCheckAck(pn532_packetbuffer, 3, timeout)) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("No card(s) read")); +#endif + return 0x0; // no cards read + } + + return readDetectedPassiveTargetID(uid, uidLength); +} + +/**************************************************************************/ +/*! + @brief Put the reader in detection mode, non blocking so interrupts + must be enabled. + @param cardbaudrate Baud rate of the card + @return 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +bool Adafruit_PN532::startPassiveTargetIDDetection(uint8_t cardbaudrate) { + pn532_packetbuffer[0] = PN532_COMMAND_INLISTPASSIVETARGET; + pn532_packetbuffer[1] = 1; // max 1 cards at once (we can set this to 2 later) + pn532_packetbuffer[2] = cardbaudrate; + + return sendCommandCheckAck(pn532_packetbuffer, 3); +} + +/**************************************************************************/ +/*! + Reads the ID of the passive target the reader has deteceted. + + @param uid Pointer to the array that will be populated + with the card's UID (up to 7 bytes) + @param uidLength Pointer to the variable that will hold the + length of the card's UID. + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +bool Adafruit_PN532::readDetectedPassiveTargetID(uint8_t *uid, + uint8_t *uidLength) { + // read data packet + readdata(pn532_packetbuffer, 20); + // check some basic stuff + + /* ISO14443A card response should be in the following format: + + byte Description + ------------- ------------------------------------------ + b0..6 Frame header and preamble + b7 Tags Found + b8 Tag Number (only one used in this example) + b9..10 SENS_RES + b11 SEL_RES + b12 NFCID Length + b13..NFCIDLen NFCID */ + +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Found ")); + PN532DEBUGPRINT.print(pn532_packetbuffer[7], DEC); + PN532DEBUGPRINT.println(F(" tags")); +#endif + if (pn532_packetbuffer[7] != 1) + return 0; + + uint16_t sens_res = pn532_packetbuffer[9]; + sens_res <<= 8; + sens_res |= pn532_packetbuffer[10]; +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("ATQA: 0x")); + PN532DEBUGPRINT.println(sens_res, HEX); + PN532DEBUGPRINT.print(F("SAK: 0x")); + PN532DEBUGPRINT.println(pn532_packetbuffer[11], HEX); +#endif + + /* Card appears to be Mifare Classic */ + *uidLength = pn532_packetbuffer[12]; +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("UID:")); +#endif + for (uint8_t i = 0; i < pn532_packetbuffer[12]; i++) { + uid[i] = pn532_packetbuffer[13 + i]; +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F(" 0x")); + PN532DEBUGPRINT.print(uid[i], HEX); +#endif + } +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(); +#endif + + return 1; +} + +/**************************************************************************/ +/*! + @brief Exchanges an APDU with the currently inlisted peer + + @param send Pointer to data to send + @param sendLength Length of the data to send + @param response Pointer to response data + @param responseLength Pointer to the response data length + @return true on success, false otherwise. +*/ +/**************************************************************************/ +bool Adafruit_PN532::inDataExchange(uint8_t *send, uint8_t sendLength, + uint8_t *response, + uint8_t *responseLength) { + if (sendLength > PN532_PACKBUFFSIZ - 2) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("APDU length too long for packet buffer")); +#endif + return false; + } + uint8_t i; + + pn532_packetbuffer[0] = 0x40; // PN532_COMMAND_INDATAEXCHANGE; + pn532_packetbuffer[1] = _inListedTag; + for (i = 0; i < sendLength; ++i) { + pn532_packetbuffer[i + 2] = send[i]; + } + + if (!sendCommandCheckAck(pn532_packetbuffer, sendLength + 2, 1000)) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Could not send APDU")); +#endif + return false; + } + + if (!waitready(1000)) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Response never received for APDU...")); +#endif + return false; + } + + readdata(pn532_packetbuffer, sizeof(pn532_packetbuffer)); + + if (pn532_packetbuffer[0] == 0 && pn532_packetbuffer[1] == 0 && + pn532_packetbuffer[2] == 0xff) { + uint8_t length = pn532_packetbuffer[3]; + if (pn532_packetbuffer[4] != (uint8_t)(~length + 1)) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Length check invalid")); + PN532DEBUGPRINT.println(length, HEX); + PN532DEBUGPRINT.println((~length) + 1, HEX); +#endif + return false; + } + if (pn532_packetbuffer[5] == PN532_PN532TOHOST && + pn532_packetbuffer[6] == PN532_RESPONSE_INDATAEXCHANGE) { + if ((pn532_packetbuffer[7] & 0x3f) != 0) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Status code indicates an error")); +#endif + return false; + } + + length -= 3; + + if (length > *responseLength) { + length = *responseLength; // silent truncation... + } + + for (i = 0; i < length; ++i) { + response[i] = pn532_packetbuffer[8 + i]; + } + *responseLength = length; + + return true; + } else { + PN532DEBUGPRINT.print(F("Don't know how to handle this command: ")); + PN532DEBUGPRINT.println(pn532_packetbuffer[6], HEX); + return false; + } + } else { + PN532DEBUGPRINT.println(F("Preamble missing")); + return false; + } +} + +/**************************************************************************/ +/*! + @brief 'InLists' a passive target. PN532 acting as reader/initiator, + peer acting as card/responder. + @return true on success, false otherwise. +*/ +/**************************************************************************/ +bool Adafruit_PN532::inListPassiveTarget() { + pn532_packetbuffer[0] = PN532_COMMAND_INLISTPASSIVETARGET; + pn532_packetbuffer[1] = 1; + pn532_packetbuffer[2] = 0; + +#ifdef PN532DEBUG + PN532DEBUGPRINT.print(F("About to inList passive target")); +#endif + + if (!sendCommandCheckAck(pn532_packetbuffer, 3, 1000)) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Could not send inlist message")); +#endif + return false; + } + + if (!waitready(30000)) { + return false; + } + + readdata(pn532_packetbuffer, sizeof(pn532_packetbuffer)); + + if (pn532_packetbuffer[0] == 0 && pn532_packetbuffer[1] == 0 && + pn532_packetbuffer[2] == 0xff) { + uint8_t length = pn532_packetbuffer[3]; + if (pn532_packetbuffer[4] != (uint8_t)(~length + 1)) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Length check invalid")); + PN532DEBUGPRINT.println(length, HEX); + PN532DEBUGPRINT.println((~length) + 1, HEX); +#endif + return false; + } + if (pn532_packetbuffer[5] == PN532_PN532TOHOST && + pn532_packetbuffer[6] == PN532_RESPONSE_INLISTPASSIVETARGET) { + if (pn532_packetbuffer[7] != 1) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Unhandled number of targets inlisted")); +#endif + PN532DEBUGPRINT.println(F("Number of tags inlisted:")); + PN532DEBUGPRINT.println(pn532_packetbuffer[7]); + return false; + } + + _inListedTag = pn532_packetbuffer[8]; + PN532DEBUGPRINT.print(F("Tag number: ")); + PN532DEBUGPRINT.println(_inListedTag); + + return true; + } else { +#ifdef PN532DEBUG + PN532DEBUGPRINT.print(F("Unexpected response to inlist passive host")); +#endif + return false; + } + } else { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println(F("Preamble missing")); +#endif + return false; + } + + return true; +} + +/***** Mifare Classic Functions ******/ + +/**************************************************************************/ +/*! + @brief Indicates whether the specified block number is the first block + in the sector (block 0 relative to the current sector) + @param uiBlock Block number to test. + @return true if first block, false otherwise. +*/ +/**************************************************************************/ +bool Adafruit_PN532::mifareclassic_IsFirstBlock(uint32_t uiBlock) { + // Test if we are in the small or big sectors + if (uiBlock < 128) + return ((uiBlock) % 4 == 0); + else + return ((uiBlock) % 16 == 0); +} + +/**************************************************************************/ +/*! + @brief Indicates whether the specified block number is the sector + trailer. + @param uiBlock Block number to test. + @return true if sector trailer, false otherwise. +*/ +/**************************************************************************/ +bool Adafruit_PN532::mifareclassic_IsTrailerBlock(uint32_t uiBlock) { + // Test if we are in the small or big sectors + if (uiBlock < 128) + return ((uiBlock + 1) % 4 == 0); + else + return ((uiBlock + 1) % 16 == 0); +} + +/**************************************************************************/ +/*! + Tries to authenticate a block of memory on a MIFARE card using the + INDATAEXCHANGE command. See section 7.3.8 of the PN532 User Manual + for more information on sending MIFARE and other commands. + + @param uid Pointer to a byte array containing the card UID + @param uidLen The length (in bytes) of the card's UID (Should + be 4 for MIFARE Classic) + @param blockNumber The block number to authenticate. (0..63 for + 1KB cards, and 0..255 for 4KB cards). + @param keyNumber Which key type to use during authentication + (0 = MIFARE_CMD_AUTH_A, 1 = MIFARE_CMD_AUTH_B) + @param keyData Pointer to a byte array containing the 6 byte + key value + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::mifareclassic_AuthenticateBlock(uint8_t *uid, + uint8_t uidLen, + uint32_t blockNumber, + uint8_t keyNumber, + uint8_t *keyData) { + // uint8_t len; + uint8_t i; + + // Hang on to the key and uid data + memcpy(_key, keyData, 6); + memcpy(_uid, uid, uidLen); + _uidLen = uidLen; + +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Trying to authenticate card ")); + Adafruit_PN532::PrintHex(_uid, _uidLen); + PN532DEBUGPRINT.print(F("Using authentication KEY ")); + PN532DEBUGPRINT.print(keyNumber ? 'B' : 'A'); + PN532DEBUGPRINT.print(F(": ")); + Adafruit_PN532::PrintHex(_key, 6); +#endif + + // Prepare the authentication command // + pn532_packetbuffer[0] = + PN532_COMMAND_INDATAEXCHANGE; /* Data Exchange Header */ + pn532_packetbuffer[1] = 1; /* Max card numbers */ + pn532_packetbuffer[2] = (keyNumber) ? MIFARE_CMD_AUTH_B : MIFARE_CMD_AUTH_A; + pn532_packetbuffer[3] = + blockNumber; /* Block Number (1K = 0..63, 4K = 0..255 */ + memcpy(pn532_packetbuffer + 4, _key, 6); + for (i = 0; i < _uidLen; i++) { + pn532_packetbuffer[10 + i] = _uid[i]; /* 4 byte card ID */ + } + + if (!sendCommandCheckAck(pn532_packetbuffer, 10 + _uidLen)) + return 0; + + // Read the response packet + readdata(pn532_packetbuffer, 12); + + // check if the response is valid and we are authenticated??? + // for an auth success it should be bytes 5-7: 0xD5 0x41 0x00 + // Mifare auth error is technically byte 7: 0x14 but anything other and 0x00 + // is not good + if (pn532_packetbuffer[7] != 0x00) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.print(F("Authentification failed: ")); + Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 12); +#endif + return 0; + } + + return 1; +} + +/**************************************************************************/ +/*! + Tries to read an entire 16-byte data block at the specified block + address. + + @param blockNumber The block number to authenticate. (0..63 for + 1KB cards, and 0..255 for 4KB cards). + @param data Pointer to the byte array that will hold the + retrieved data (if any) + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::mifareclassic_ReadDataBlock(uint8_t blockNumber, + uint8_t *data) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Trying to read 16 bytes from block ")); + PN532DEBUGPRINT.println(blockNumber); +#endif + + /* Prepare the command */ + pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; + pn532_packetbuffer[1] = 1; /* Card number */ + pn532_packetbuffer[2] = MIFARE_CMD_READ; /* Mifare Read command = 0x30 */ + pn532_packetbuffer[3] = + blockNumber; /* Block Number (0..63 for 1K, 0..255 for 4K) */ + + /* Send the command */ + if (!sendCommandCheckAck(pn532_packetbuffer, 4)) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Failed to receive ACK for read command")); +#endif + return 0; + } + + /* Read the response packet */ + readdata(pn532_packetbuffer, 26); + + /* If byte 8 isn't 0x00 we probably have an error */ + if (pn532_packetbuffer[7] != 0x00) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Unexpected response")); + Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); +#endif + return 0; + } + + /* Copy the 16 data bytes to the output buffer */ + /* Block content starts at byte 9 of a valid response */ + memcpy(data, pn532_packetbuffer + 8, 16); + +/* Display data for debug if requested */ +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Block ")); + PN532DEBUGPRINT.println(blockNumber); + Adafruit_PN532::PrintHexChar(data, 16); +#endif + + return 1; +} + +/**************************************************************************/ +/*! + Tries to write an entire 16-byte data block at the specified block + address. + + @param blockNumber The block number to authenticate. (0..63 for + 1KB cards, and 0..255 for 4KB cards). + @param data The byte array that contains the data to write. + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::mifareclassic_WriteDataBlock(uint8_t blockNumber, + uint8_t *data) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Trying to write 16 bytes to block ")); + PN532DEBUGPRINT.println(blockNumber); +#endif + + /* Prepare the first command */ + pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; + pn532_packetbuffer[1] = 1; /* Card number */ + pn532_packetbuffer[2] = MIFARE_CMD_WRITE; /* Mifare Write command = 0xA0 */ + pn532_packetbuffer[3] = + blockNumber; /* Block Number (0..63 for 1K, 0..255 for 4K) */ + memcpy(pn532_packetbuffer + 4, data, 16); /* Data Payload */ + + /* Send the command */ + if (!sendCommandCheckAck(pn532_packetbuffer, 20)) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); +#endif + return 0; + } + delay(10); + + /* Read the response packet */ + readdata(pn532_packetbuffer, 26); + + return 1; +} + +/**************************************************************************/ +/*! + Formats a Mifare Classic card to store NDEF Records + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::mifareclassic_FormatNDEF(void) { + uint8_t sectorbuffer1[16] = {0x14, 0x01, 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, + 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1}; + uint8_t sectorbuffer2[16] = {0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, + 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1}; + uint8_t sectorbuffer3[16] = {0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0x78, 0x77, + 0x88, 0xC1, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; + + // Note 0xA0 0xA1 0xA2 0xA3 0xA4 0xA5 must be used for key A + // for the MAD sector in NDEF records (sector 0) + + // Write block 1 and 2 to the card + if (!(mifareclassic_WriteDataBlock(1, sectorbuffer1))) + return 0; + if (!(mifareclassic_WriteDataBlock(2, sectorbuffer2))) + return 0; + // Write key A and access rights card + if (!(mifareclassic_WriteDataBlock(3, sectorbuffer3))) + return 0; + + // Seems that everything was OK (?!) + return 1; +} + +/**************************************************************************/ +/*! + Writes an NDEF URI Record to the specified sector (1..15) + + Note that this function assumes that the Mifare Classic card is + already formatted to work as an "NFC Forum Tag" and uses a MAD1 + file system. You can use the NXP TagWriter app on Android to + properly format cards for this. + + @param sectorNumber The sector that the URI record should be written + to (can be 1..15 for a 1K card) + @param uriIdentifier The uri identifier code (0 = none, 0x01 = + "http://www.", etc.) + @param url The uri text to write (max 38 characters). + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::mifareclassic_WriteNDEFURI(uint8_t sectorNumber, + uint8_t uriIdentifier, + const char *url) { + // Figure out how long the string is + uint8_t len = strlen(url); + + // Make sure we're within a 1K limit for the sector number + if ((sectorNumber < 1) || (sectorNumber > 15)) + return 0; + + // Make sure the URI payload is between 1 and 38 chars + if ((len < 1) || (len > 38)) + return 0; + + // Note 0xD3 0xF7 0xD3 0xF7 0xD3 0xF7 must be used for key A + // in NDEF records + + // Setup the sector buffer (w/pre-formatted TLV wrapper and NDEF message) + uint8_t sectorbuffer1[16] = {0x00, + 0x00, + 0x03, + (uint8_t)(len + 5), + 0xD1, + 0x01, + (uint8_t)(len + 1), + 0x55, + uriIdentifier, + 0x00, + 0x00, + 0x00, + 0x00, + 0x00, + 0x00, + 0x00}; + uint8_t sectorbuffer2[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t sectorbuffer3[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t sectorbuffer4[16] = {0xD3, 0xF7, 0xD3, 0xF7, 0xD3, 0xF7, 0x7F, 0x07, + 0x88, 0x40, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; + if (len <= 6) { + // Unlikely we'll get a url this short, but why not ... + memcpy(sectorbuffer1 + 9, url, len); + sectorbuffer1[len + 9] = 0xFE; + } else if (len == 7) { + // 0xFE needs to be wrapped around to next block + memcpy(sectorbuffer1 + 9, url, len); + sectorbuffer2[0] = 0xFE; + } else if ((len > 7) && (len <= 22)) { + // Url fits in two blocks + memcpy(sectorbuffer1 + 9, url, 7); + memcpy(sectorbuffer2, url + 7, len - 7); + sectorbuffer2[len - 7] = 0xFE; + } else if (len == 23) { + // 0xFE needs to be wrapped around to final block + memcpy(sectorbuffer1 + 9, url, 7); + memcpy(sectorbuffer2, url + 7, len - 7); + sectorbuffer3[0] = 0xFE; + } else { + // Url fits in three blocks + memcpy(sectorbuffer1 + 9, url, 7); + memcpy(sectorbuffer2, url + 7, 16); + memcpy(sectorbuffer3, url + 23, len - 24); + sectorbuffer3[len - 22] = 0xFE; + } + + // Now write all three blocks back to the card + if (!(mifareclassic_WriteDataBlock(sectorNumber * 4, sectorbuffer1))) + return 0; + if (!(mifareclassic_WriteDataBlock((sectorNumber * 4) + 1, sectorbuffer2))) + return 0; + if (!(mifareclassic_WriteDataBlock((sectorNumber * 4) + 2, sectorbuffer3))) + return 0; + if (!(mifareclassic_WriteDataBlock((sectorNumber * 4) + 3, sectorbuffer4))) + return 0; + + // Seems that everything was OK (?!) + return 1; +} + +/***** Mifare Ultralight Functions ******/ + +/**************************************************************************/ +/*! + @brief Tries to read an entire 4-byte page at the specified address. + + @param page The page number (0..63 in most cases) + @param buffer Pointer to the byte array that will hold the + retrieved data (if any) + @return 1 on success, 0 on error. +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::mifareultralight_ReadPage(uint8_t page, + uint8_t *buffer) { + if (page >= 64) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Page value out of range")); +#endif + return 0; + } + +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Reading page ")); + PN532DEBUGPRINT.println(page); +#endif + + /* Prepare the command */ + pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; + pn532_packetbuffer[1] = 1; /* Card number */ + pn532_packetbuffer[2] = MIFARE_CMD_READ; /* Mifare Read command = 0x30 */ + pn532_packetbuffer[3] = page; /* Page Number (0..63 in most cases) */ + + /* Send the command */ + if (!sendCommandCheckAck(pn532_packetbuffer, 4)) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); +#endif + return 0; + } + + /* Read the response packet */ + readdata(pn532_packetbuffer, 26); +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Received: ")); + Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); +#endif + + /* If byte 8 isn't 0x00 we probably have an error */ + if (pn532_packetbuffer[7] == 0x00) { + /* Copy the 4 data bytes to the output buffer */ + /* Block content starts at byte 9 of a valid response */ + /* Note that the command actually reads 16 byte or 4 */ + /* pages at a time ... we simply discard the last 12 */ + /* bytes */ + memcpy(buffer, pn532_packetbuffer + 8, 4); + } else { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Unexpected response reading block: ")); + Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); +#endif + return 0; + } + +/* Display data for debug if requested */ +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Page ")); + PN532DEBUGPRINT.print(page); + PN532DEBUGPRINT.println(F(":")); + Adafruit_PN532::PrintHexChar(buffer, 4); +#endif + + // Return OK signal + return 1; +} + +/**************************************************************************/ +/*! + Tries to write an entire 4-byte page at the specified block + address. + + @param page The page number to write. (0..63 for most cases) + @param data The byte array that contains the data to write. + Should be exactly 4 bytes long. + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::mifareultralight_WritePage(uint8_t page, + uint8_t *data) { + + if (page >= 64) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Page value out of range")); +#endif + // Return Failed Signal + return 0; + } + +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Trying to write 4 byte page")); + PN532DEBUGPRINT.println(page); +#endif + + /* Prepare the first command */ + pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; + pn532_packetbuffer[1] = 1; /* Card number */ + pn532_packetbuffer[2] = + MIFARE_ULTRALIGHT_CMD_WRITE; /* Mifare Ultralight Write command = 0xA2 */ + pn532_packetbuffer[3] = page; /* Page Number (0..63 for most cases) */ + memcpy(pn532_packetbuffer + 4, data, 4); /* Data Payload */ + + /* Send the command */ + if (!sendCommandCheckAck(pn532_packetbuffer, 8)) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); +#endif + + // Return Failed Signal + return 0; + } + delay(10); + + /* Read the response packet */ + readdata(pn532_packetbuffer, 26); + + // Return OK Signal + return 1; +} + +/***** NTAG2xx Functions ******/ + +/**************************************************************************/ +/*! + @brief Tries to read an entire 4-byte page at the specified address. + + @param page The page number (0..63 in most cases) + @param buffer Pointer to the byte array that will hold the + retrieved data (if any) + @return 1 on success, 0 on error. +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::ntag2xx_ReadPage(uint8_t page, uint8_t *buffer) { + // TAG Type PAGES USER START USER STOP + // -------- ----- ---------- --------- + // NTAG 203 42 4 39 + // NTAG 213 45 4 39 + // NTAG 215 135 4 129 + // NTAG 216 231 4 225 + + if (page >= 231) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Page value out of range")); +#endif + return 0; + } + +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Reading page ")); + PN532DEBUGPRINT.println(page); +#endif + + /* Prepare the command */ + pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; + pn532_packetbuffer[1] = 1; /* Card number */ + pn532_packetbuffer[2] = MIFARE_CMD_READ; /* Mifare Read command = 0x30 */ + pn532_packetbuffer[3] = page; /* Page Number (0..63 in most cases) */ + + /* Send the command */ + if (!sendCommandCheckAck(pn532_packetbuffer, 4)) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); +#endif + return 0; + } + + /* Read the response packet */ + readdata(pn532_packetbuffer, 26); +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Received: ")); + Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); +#endif + + /* If byte 8 isn't 0x00 we probably have an error */ + if (pn532_packetbuffer[7] == 0x00) { + /* Copy the 4 data bytes to the output buffer */ + /* Block content starts at byte 9 of a valid response */ + /* Note that the command actually reads 16 byte or 4 */ + /* pages at a time ... we simply discard the last 12 */ + /* bytes */ + memcpy(buffer, pn532_packetbuffer + 8, 4); + } else { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Unexpected response reading block: ")); + Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); +#endif + return 0; + } + +/* Display data for debug if requested */ +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Page ")); + PN532DEBUGPRINT.print(page); + PN532DEBUGPRINT.println(F(":")); + Adafruit_PN532::PrintHexChar(buffer, 4); +#endif + + // Return OK signal + return 1; +} + +/**************************************************************************/ +/*! + Tries to write an entire 4-byte page at the specified block + address. + + @param page The page number to write. (0..63 for most cases) + @param data The byte array that contains the data to write. + Should be exactly 4 bytes long. + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::ntag2xx_WritePage(uint8_t page, uint8_t *data) { + // TAG Type PAGES USER START USER STOP + // -------- ----- ---------- --------- + // NTAG 203 42 4 39 + // NTAG 213 45 4 39 + // NTAG 215 135 4 129 + // NTAG 216 231 4 225 + + if ((page < 4) || (page > 225)) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Page value out of range")); +#endif + // Return Failed Signal + return 0; + } + +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.print(F("Trying to write 4 byte page")); + PN532DEBUGPRINT.println(page); +#endif + + /* Prepare the first command */ + pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; + pn532_packetbuffer[1] = 1; /* Card number */ + pn532_packetbuffer[2] = + MIFARE_ULTRALIGHT_CMD_WRITE; /* Mifare Ultralight Write command = 0xA2 */ + pn532_packetbuffer[3] = page; /* Page Number (0..63 for most cases) */ + memcpy(pn532_packetbuffer + 4, data, 4); /* Data Payload */ + + /* Send the command */ + if (!sendCommandCheckAck(pn532_packetbuffer, 8)) { +#ifdef MIFAREDEBUG + PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); +#endif + + // Return Failed Signal + return 0; + } + delay(10); + + /* Read the response packet */ + readdata(pn532_packetbuffer, 26); + + // Return OK Signal + return 1; +} + +/**************************************************************************/ +/*! + Writes an NDEF URI Record starting at the specified page (4..nn) + + Note that this function assumes that the NTAG2xx card is + already formatted to work as an "NFC Forum Tag". + + @param uriIdentifier The uri identifier code (0 = none, 0x01 = + "http://www.", etc.) + @param url The uri text to write (null-terminated string). + @param dataLen The size of the data area for overflow checks. + + @returns 1 if everything executed properly, 0 for an error +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::ntag2xx_WriteNDEFURI(uint8_t uriIdentifier, char *url, + uint8_t dataLen) { + uint8_t pageBuffer[4] = {0, 0, 0, 0}; + + // Remove NDEF record overhead from the URI data (pageHeader below) + uint8_t wrapperSize = 12; + + // Figure out how long the string is + uint8_t len = strlen(url); + + // Make sure the URI payload will fit in dataLen (include 0xFE trailer) + if ((len < 1) || (len + 1 > (dataLen - wrapperSize))) + return 0; + + // Setup the record header + // See NFCForum-TS-Type-2-Tag_1.1.pdf for details + uint8_t pageHeader[12] = { + /* NDEF Lock Control TLV (must be first and always present) */ + 0x01, /* Tag Field (0x01 = Lock Control TLV) */ + 0x03, /* Payload Length (always 3) */ + 0xA0, /* The position inside the tag of the lock bytes (upper 4 = page + address, lower 4 = byte offset) */ + 0x10, /* Size in bits of the lock area */ + 0x44, /* Size in bytes of a page and the number of bytes each lock bit can + lock (4 bit + 4 bits) */ + /* NDEF Message TLV - URI Record */ + 0x03, /* Tag Field (0x03 = NDEF Message) */ + (uint8_t)(len + 5), /* Payload Length (not including 0xFE trailer) */ + 0xD1, /* NDEF Record Header (TNF=0x1:Well known record + SR + ME + MB) */ + 0x01, /* Type Length for the record type indicator */ + (uint8_t)(len + 1), /* Payload len */ + 0x55, /* Record Type Indicator (0x55 or 'U' = URI Record) */ + uriIdentifier /* URI Prefix (ex. 0x01 = "http://www.") */ + }; + + // Write 12 byte header (three pages of data starting at page 4) + memcpy(pageBuffer, pageHeader, 4); + if (!(ntag2xx_WritePage(4, pageBuffer))) + return 0; + memcpy(pageBuffer, pageHeader + 4, 4); + if (!(ntag2xx_WritePage(5, pageBuffer))) + return 0; + memcpy(pageBuffer, pageHeader + 8, 4); + if (!(ntag2xx_WritePage(6, pageBuffer))) + return 0; + + // Write URI (starting at page 7) + uint8_t currentPage = 7; + char *urlcopy = url; + while (len) { + if (len < 4) { + memset(pageBuffer, 0, 4); + memcpy(pageBuffer, urlcopy, len); + pageBuffer[len] = 0xFE; // NDEF record footer + if (!(ntag2xx_WritePage(currentPage, pageBuffer))) + return 0; + // DONE! + return 1; + } else if (len == 4) { + memcpy(pageBuffer, urlcopy, len); + if (!(ntag2xx_WritePage(currentPage, pageBuffer))) + return 0; + memset(pageBuffer, 0, 4); + pageBuffer[0] = 0xFE; // NDEF record footer + currentPage++; + if (!(ntag2xx_WritePage(currentPage, pageBuffer))) + return 0; + // DONE! + return 1; + } else { + // More than one page of data left + memcpy(pageBuffer, urlcopy, 4); + if (!(ntag2xx_WritePage(currentPage, pageBuffer))) + return 0; + currentPage++; + urlcopy += 4; + len -= 4; + } + } + + // Seems that everything was OK (?!) + return 1; +} + +/************** high level communication functions (handles both I2C and SPI) */ + +/**************************************************************************/ +/*! + @brief Tries to read the SPI or I2C ACK signal +*/ +/**************************************************************************/ +bool Adafruit_PN532::readack() { + uint8_t ackbuff[6]; + + if (spi_dev) { + uint8_t cmd = PN532_SPI_DATAREAD; + spi_dev->write_then_read(&cmd, 1, ackbuff, 6); + } else if (i2c_dev || ser_dev) { + readdata(ackbuff, 6); + } + + return (0 == memcmp((char *)ackbuff, (char *)pn532ack, 6)); +} + +/**************************************************************************/ +/*! + @brief Return true if the PN532 is ready with a response. +*/ +/**************************************************************************/ +bool Adafruit_PN532::isready() { + if (spi_dev) { + // SPI ready check via Status Request + uint8_t cmd = PN532_SPI_STATREAD; + uint8_t reply; + spi_dev->write_then_read(&cmd, 1, &reply, 1); + return reply == PN532_SPI_READY; + } else if (i2c_dev) { + // I2C ready check via reading RDY byte + uint8_t rdy[1]; + i2c_dev->read(rdy, 1); + return rdy[0] == PN532_I2C_READY; + } else if (ser_dev) { + // Serial ready check based on non-zero read buffer + return (ser_dev->available() != 0); + } else if (_irq != -1) { + uint8_t x = digitalRead(_irq); + return x == 0; + } + return false; +} + +/**************************************************************************/ +/*! + @brief Waits until the PN532 is ready. + + @param timeout Timeout before giving up +*/ +/**************************************************************************/ +bool Adafruit_PN532::waitready(uint16_t timeout) { + uint16_t timer = 0; + while (!isready()) { + if (timeout != 0) { + timer += 10; + if (timer > timeout) { +#ifdef PN532DEBUG + PN532DEBUGPRINT.println("TIMEOUT!"); +#endif + return false; + } + } + delay(10); + } + return true; +} + +/**************************************************************************/ +/*! + @brief Reads n bytes of data from the PN532 via SPI or I2C. + + @param buff Pointer to the buffer where data will be written + @param n Number of bytes to be read +*/ +/**************************************************************************/ +void Adafruit_PN532::readdata(uint8_t *buff, uint8_t n) { + if (spi_dev) { + // SPI read + uint8_t cmd = PN532_SPI_DATAREAD; + spi_dev->write_then_read(&cmd, 1, buff, n); + } else if (i2c_dev) { + // I2C read + uint8_t rbuff[n + 1]; // +1 for leading RDY byte + i2c_dev->read(rbuff, n + 1); + for (uint8_t i = 0; i < n; i++) { + buff[i] = rbuff[i + 1]; + } + } else if (ser_dev) { + // Serial read + ser_dev->readBytes(buff, n); + } +#ifdef PN532DEBUG + PN532DEBUGPRINT.print(F("Reading: ")); + for (uint8_t i = 0; i < n; i++) { + PN532DEBUGPRINT.print(F(" 0x")); + PN532DEBUGPRINT.print(buff[i], HEX); + } + PN532DEBUGPRINT.println(); +#endif +} + +/**************************************************************************/ +/*! + @brief set the PN532 as iso14443a Target behaving as a SmartCard + @return true on success, false otherwise. + @note Author: Salvador Mendoza (salmg.net) new functions: + -AsTarget + -getDataTarget + -setDataTarget +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::AsTarget() { + pn532_packetbuffer[0] = 0x8C; + uint8_t target[] = { + 0x8C, // INIT AS TARGET + 0x00, // MODE -> BITFIELD + 0x08, 0x00, // SENS_RES - MIFARE PARAMS + 0xdc, 0x44, 0x20, // NFCID1T + 0x60, // SEL_RES + 0x01, 0xfe, // NFCID2T MUST START WITH 01fe - FELICA PARAMS - POL_RES + 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xc0, + 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, // PAD + 0xff, 0xff, // SYSTEM CODE + 0xaa, 0x99, 0x88, 0x77, 0x66, 0x55, 0x44, + 0x33, 0x22, 0x11, 0x01, 0x00, // NFCID3t MAX 47 BYTES ATR_RES + 0x0d, 0x52, 0x46, 0x49, 0x44, 0x49, 0x4f, + 0x74, 0x20, 0x50, 0x4e, 0x35, 0x33, 0x32 // HISTORICAL BYTES + }; + if (!sendCommandCheckAck(target, sizeof(target))) + return false; + + // read data packet + readdata(pn532_packetbuffer, 8); + + int offset = 6; + return (pn532_packetbuffer[offset] == 0x15); +} +/**************************************************************************/ +/*! + @brief Retrieve response from the emulation mode + + @param cmd = data + @param cmdlen = data length + @return true on success, false otherwise. +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::getDataTarget(uint8_t *cmd, uint8_t *cmdlen) { + uint8_t length; + pn532_packetbuffer[0] = 0x86; + if (!sendCommandCheckAck(pn532_packetbuffer, 1, 1000)) { + PN532DEBUGPRINT.println(F("Error en ack")); + return false; + } + + // read data packet + readdata(pn532_packetbuffer, 64); + length = pn532_packetbuffer[3] - 3; + + // if (length > *responseLength) {// Bug, should avoid it in the reading + // target data + // length = *responseLength; // silent truncation... + //} + + for (int i = 0; i < length; ++i) { + cmd[i] = pn532_packetbuffer[8 + i]; + } + *cmdlen = length; + return true; +} + +/**************************************************************************/ +/*! + @brief Set data in PN532 in the emulation mode + + @param cmd = data + @param cmdlen = data length + @return true on success, false otherwise. +*/ +/**************************************************************************/ +uint8_t Adafruit_PN532::setDataTarget(uint8_t *cmd, uint8_t cmdlen) { + uint8_t length; + // cmd1[0] = 0x8E; Must! + + if (!sendCommandCheckAck(cmd, cmdlen)) + return false; + + // read data packet + readdata(pn532_packetbuffer, 8); + length = pn532_packetbuffer[3] - 3; + for (int i = 0; i < length; ++i) { + cmd[i] = pn532_packetbuffer[8 + i]; + } + // cmdl = 0 + cmdlen = length; + + int offset = 6; + return (pn532_packetbuffer[offset] == 0x15); +} + +/**************************************************************************/ +/*! + @brief Writes a command to the PN532, automatically inserting the + preamble and required frame details (checksum, len, etc.) + + @param cmd Pointer to the command buffer + @param cmdlen Command length in bytes +*/ +/**************************************************************************/ +void Adafruit_PN532::writecommand(uint8_t *cmd, uint8_t cmdlen) { + if (spi_dev) { + // SPI command write. + uint8_t checksum; + uint8_t packet[9 + cmdlen]; + uint8_t *p = packet; + cmdlen++; + + p[0] = PN532_SPI_DATAWRITE; + p++; + + p[0] = PN532_PREAMBLE; + p++; + p[0] = PN532_STARTCODE1; + p++; + p[0] = PN532_STARTCODE2; + p++; + checksum = PN532_PREAMBLE + PN532_STARTCODE1 + PN532_STARTCODE2; + + p[0] = cmdlen; + p++; + p[0] = ~cmdlen + 1; + p++; + + p[0] = PN532_HOSTTOPN532; + p++; + checksum += PN532_HOSTTOPN532; + + for (uint8_t i = 0; i < cmdlen - 1; i++) { + p[0] = cmd[i]; + p++; + checksum += cmd[i]; + } + + p[0] = ~checksum; + p++; + p[0] = PN532_POSTAMBLE; + p++; + +#ifdef PN532DEBUG + Serial.print("Sending : "); + for (int i = 1; i < 8 + cmdlen; i++) { + Serial.print("0x"); + Serial.print(packet[i], HEX); + Serial.print(", "); + } + Serial.println(); +#endif + + spi_dev->write(packet, 8 + cmdlen); + } else if (i2c_dev || ser_dev) { + // I2C or Serial command write. + uint8_t packet[8 + cmdlen]; + uint8_t LEN = cmdlen + 1; + + packet[0] = PN532_PREAMBLE; + packet[1] = PN532_STARTCODE1; + packet[2] = PN532_STARTCODE2; + packet[3] = LEN; + packet[4] = ~LEN + 1; + packet[5] = PN532_HOSTTOPN532; + uint8_t sum = 0; + for (uint8_t i = 0; i < cmdlen; i++) { + packet[6 + i] = cmd[i]; + sum += cmd[i]; + } + packet[6 + cmdlen] = ~(PN532_HOSTTOPN532 + sum) + 1; + packet[7 + cmdlen] = PN532_POSTAMBLE; + +#ifdef PN532DEBUG + Serial.print("Sending : "); + for (int i = 1; i < 8 + cmdlen; i++) { + Serial.print("0x"); + Serial.print(packet[i], HEX); + Serial.print(", "); + } + Serial.println(); +#endif + + if (i2c_dev) { + i2c_dev->write(packet, 8 + cmdlen); + } else { + ser_dev->write(packet, 8 + cmdlen); + } + } +} diff --git a/src/Adafruit_PN532.h b/src/Adafruit_PN532.h new file mode 100644 index 0000000..744e7cf --- /dev/null +++ b/src/Adafruit_PN532.h @@ -0,0 +1,221 @@ +/**************************************************************************/ +/*! + @file Adafruit_PN532.h + + v2.0 - Refactored to add I2C support from Adafruit_NFCShield_I2C library. + + v1.1 - Added full command list + - Added 'verbose' mode flag to constructor to toggle debug output + - Changed readPassiveTargetID() to return variable length values +*/ +/**************************************************************************/ + +#ifndef ADAFRUIT_PN532_H +#define ADAFRUIT_PN532_H + +#include "Arduino.h" + +#include +#include + +#define PN532_PREAMBLE (0x00) ///< Command sequence start, byte 1/3 +#define PN532_STARTCODE1 (0x00) ///< Command sequence start, byte 2/3 +#define PN532_STARTCODE2 (0xFF) ///< Command sequence start, byte 3/3 +#define PN532_POSTAMBLE (0x00) ///< EOD + +#define PN532_HOSTTOPN532 (0xD4) ///< Host-to-PN532 +#define PN532_PN532TOHOST (0xD5) ///< PN532-to-host + +// PN532 Commands +#define PN532_COMMAND_DIAGNOSE (0x00) ///< Diagnose +#define PN532_COMMAND_GETFIRMWAREVERSION (0x02) ///< Get firmware version +#define PN532_COMMAND_GETGENERALSTATUS (0x04) ///< Get general status +#define PN532_COMMAND_READREGISTER (0x06) ///< Read register +#define PN532_COMMAND_WRITEREGISTER (0x08) ///< Write register +#define PN532_COMMAND_READGPIO (0x0C) ///< Read GPIO +#define PN532_COMMAND_WRITEGPIO (0x0E) ///< Write GPIO +#define PN532_COMMAND_SETSERIALBAUDRATE (0x10) ///< Set serial baud rate +#define PN532_COMMAND_SETPARAMETERS (0x12) ///< Set parameters +#define PN532_COMMAND_SAMCONFIGURATION (0x14) ///< SAM configuration +#define PN532_COMMAND_POWERDOWN (0x16) ///< Power down +#define PN532_COMMAND_RFCONFIGURATION (0x32) ///< RF config +#define PN532_COMMAND_RFREGULATIONTEST (0x58) ///< RF regulation test +#define PN532_COMMAND_INJUMPFORDEP (0x56) ///< Jump for DEP +#define PN532_COMMAND_INJUMPFORPSL (0x46) ///< Jump for PSL +#define PN532_COMMAND_INLISTPASSIVETARGET (0x4A) ///< List passive target +#define PN532_COMMAND_INATR (0x50) ///< ATR +#define PN532_COMMAND_INPSL (0x4E) ///< PSL +#define PN532_COMMAND_INDATAEXCHANGE (0x40) ///< Data exchange +#define PN532_COMMAND_INCOMMUNICATETHRU (0x42) ///< Communicate through +#define PN532_COMMAND_INDESELECT (0x44) ///< Deselect +#define PN532_COMMAND_INRELEASE (0x52) ///< Release +#define PN532_COMMAND_INSELECT (0x54) ///< Select +#define PN532_COMMAND_INAUTOPOLL (0x60) ///< Auto poll +#define PN532_COMMAND_TGINITASTARGET (0x8C) ///< Init as target +#define PN532_COMMAND_TGSETGENERALBYTES (0x92) ///< Set general bytes +#define PN532_COMMAND_TGGETDATA (0x86) ///< Get data +#define PN532_COMMAND_TGSETDATA (0x8E) ///< Set data +#define PN532_COMMAND_TGSETMETADATA (0x94) ///< Set metadata +#define PN532_COMMAND_TGGETINITIATORCOMMAND (0x88) ///< Get initiator command +#define PN532_COMMAND_TGRESPONSETOINITIATOR (0x90) ///< Response to initiator +#define PN532_COMMAND_TGGETTARGETSTATUS (0x8A) ///< Get target status + +#define PN532_RESPONSE_INDATAEXCHANGE (0x41) ///< Data exchange +#define PN532_RESPONSE_INLISTPASSIVETARGET (0x4B) ///< List passive target + +#define PN532_WAKEUP (0x55) ///< Wake + +#define PN532_SPI_STATREAD (0x02) ///< Stat read +#define PN532_SPI_DATAWRITE (0x01) ///< Data write +#define PN532_SPI_DATAREAD (0x03) ///< Data read +#define PN532_SPI_READY (0x01) ///< Ready + +#define PN532_I2C_ADDRESS (0x48 >> 1) ///< Default I2C address +#define PN532_I2C_READBIT (0x01) ///< Read bit +#define PN532_I2C_BUSY (0x00) ///< Busy +#define PN532_I2C_READY (0x01) ///< Ready +#define PN532_I2C_READYTIMEOUT (20) ///< Ready timeout + +#define PN532_MIFARE_ISO14443A (0x00) ///< MiFare + +// Mifare Commands +#define MIFARE_CMD_AUTH_A (0x60) ///< Auth A +#define MIFARE_CMD_AUTH_B (0x61) ///< Auth B +#define MIFARE_CMD_READ (0x30) ///< Read +#define MIFARE_CMD_WRITE (0xA0) ///< Write +#define MIFARE_CMD_TRANSFER (0xB0) ///< Transfer +#define MIFARE_CMD_DECREMENT (0xC0) ///< Decrement +#define MIFARE_CMD_INCREMENT (0xC1) ///< Increment +#define MIFARE_CMD_STORE (0xC2) ///< Store +#define MIFARE_ULTRALIGHT_CMD_WRITE (0xA2) ///< Write (MiFare Ultralight) + +// Prefixes for NDEF Records (to identify record type) +#define NDEF_URIPREFIX_NONE (0x00) ///< No prefix +#define NDEF_URIPREFIX_HTTP_WWWDOT (0x01) ///< HTTP www. prefix +#define NDEF_URIPREFIX_HTTPS_WWWDOT (0x02) ///< HTTPS www. prefix +#define NDEF_URIPREFIX_HTTP (0x03) ///< HTTP prefix +#define NDEF_URIPREFIX_HTTPS (0x04) ///< HTTPS prefix +#define NDEF_URIPREFIX_TEL (0x05) ///< Tel prefix +#define NDEF_URIPREFIX_MAILTO (0x06) ///< Mailto prefix +#define NDEF_URIPREFIX_FTP_ANONAT (0x07) ///< FTP +#define NDEF_URIPREFIX_FTP_FTPDOT (0x08) ///< FTP dot +#define NDEF_URIPREFIX_FTPS (0x09) ///< FTPS +#define NDEF_URIPREFIX_SFTP (0x0A) ///< SFTP +#define NDEF_URIPREFIX_SMB (0x0B) ///< SMB +#define NDEF_URIPREFIX_NFS (0x0C) ///< NFS +#define NDEF_URIPREFIX_FTP (0x0D) ///< FTP +#define NDEF_URIPREFIX_DAV (0x0E) ///< DAV +#define NDEF_URIPREFIX_NEWS (0x0F) ///< NEWS +#define NDEF_URIPREFIX_TELNET (0x10) ///< Telnet prefix +#define NDEF_URIPREFIX_IMAP (0x11) ///< IMAP prefix +#define NDEF_URIPREFIX_RTSP (0x12) ///< RTSP +#define NDEF_URIPREFIX_URN (0x13) ///< URN +#define NDEF_URIPREFIX_POP (0x14) ///< POP +#define NDEF_URIPREFIX_SIP (0x15) ///< SIP +#define NDEF_URIPREFIX_SIPS (0x16) ///< SIPS +#define NDEF_URIPREFIX_TFTP (0x17) ///< TFPT +#define NDEF_URIPREFIX_BTSPP (0x18) ///< BTSPP +#define NDEF_URIPREFIX_BTL2CAP (0x19) ///< BTL2CAP +#define NDEF_URIPREFIX_BTGOEP (0x1A) ///< BTGOEP +#define NDEF_URIPREFIX_TCPOBEX (0x1B) ///< TCPOBEX +#define NDEF_URIPREFIX_IRDAOBEX (0x1C) ///< IRDAOBEX +#define NDEF_URIPREFIX_FILE (0x1D) ///< File +#define NDEF_URIPREFIX_URN_EPC_ID (0x1E) ///< URN EPC ID +#define NDEF_URIPREFIX_URN_EPC_TAG (0x1F) ///< URN EPC tag +#define NDEF_URIPREFIX_URN_EPC_PAT (0x20) ///< URN EPC pat +#define NDEF_URIPREFIX_URN_EPC_RAW (0x21) ///< URN EPC raw +#define NDEF_URIPREFIX_URN_EPC (0x22) ///< URN EPC +#define NDEF_URIPREFIX_URN_NFC (0x23) ///< URN NFC + +#define PN532_GPIO_VALIDATIONBIT (0x80) ///< GPIO validation bit +#define PN532_GPIO_P30 (0) ///< GPIO 30 +#define PN532_GPIO_P31 (1) ///< GPIO 31 +#define PN532_GPIO_P32 (2) ///< GPIO 32 +#define PN532_GPIO_P33 (3) ///< GPIO 33 +#define PN532_GPIO_P34 (4) ///< GPIO 34 +#define PN532_GPIO_P35 (5) ///< GPIO 35 + +/** + * @brief Class for working with Adafruit PN532 NFC/RFID breakout boards. + */ +class Adafruit_PN532 { +public: + Adafruit_PN532(uint8_t clk, uint8_t miso, uint8_t mosi, + uint8_t ss); // Software SPI + Adafruit_PN532(uint8_t ss, SPIClass *theSPI = &SPI); // Hardware SPI + Adafruit_PN532(uint8_t irq, uint8_t reset, + TwoWire *theWire = &Wire); // Hardware I2C + Adafruit_PN532(uint8_t reset, HardwareSerial *theSer); // Hardware UART + bool begin(void); + + void reset(void); + void wakeup(void); + + // Generic PN532 functions + bool SAMConfig(void); + uint32_t getFirmwareVersion(void); + bool sendCommandCheckAck(uint8_t *cmd, uint8_t cmdlen, + uint16_t timeout = 100); + bool writeGPIO(uint8_t pinstate); + uint8_t readGPIO(void); + bool setPassiveActivationRetries(uint8_t maxRetries); + + // ISO14443A functions + bool readPassiveTargetID( + uint8_t cardbaudrate, uint8_t *uid, uint8_t *uidLength, + uint16_t timeout = 0); // timeout 0 means no timeout - will block forever. + bool startPassiveTargetIDDetection(uint8_t cardbaudrate); + bool readDetectedPassiveTargetID(uint8_t *uid, uint8_t *uidLength); + bool inDataExchange(uint8_t *send, uint8_t sendLength, uint8_t *response, + uint8_t *responseLength); + bool inListPassiveTarget(); + uint8_t AsTarget(); + uint8_t getDataTarget(uint8_t *cmd, uint8_t *cmdlen); + uint8_t setDataTarget(uint8_t *cmd, uint8_t cmdlen); + + // Mifare Classic functions + bool mifareclassic_IsFirstBlock(uint32_t uiBlock); + bool mifareclassic_IsTrailerBlock(uint32_t uiBlock); + uint8_t mifareclassic_AuthenticateBlock(uint8_t *uid, uint8_t uidLen, + uint32_t blockNumber, + uint8_t keyNumber, uint8_t *keyData); + uint8_t mifareclassic_ReadDataBlock(uint8_t blockNumber, uint8_t *data); + uint8_t mifareclassic_WriteDataBlock(uint8_t blockNumber, uint8_t *data); + uint8_t mifareclassic_FormatNDEF(void); + uint8_t mifareclassic_WriteNDEFURI(uint8_t sectorNumber, + uint8_t uriIdentifier, const char *url); + + // Mifare Ultralight functions + uint8_t mifareultralight_ReadPage(uint8_t page, uint8_t *buffer); + uint8_t mifareultralight_WritePage(uint8_t page, uint8_t *data); + + // NTAG2xx functions + uint8_t ntag2xx_ReadPage(uint8_t page, uint8_t *buffer); + uint8_t ntag2xx_WritePage(uint8_t page, uint8_t *data); + uint8_t ntag2xx_WriteNDEFURI(uint8_t uriIdentifier, char *url, + uint8_t dataLen); + + // Help functions to display formatted text + static void PrintHex(const byte *data, const uint32_t numBytes); + static void PrintHexChar(const byte *pbtData, const uint32_t numBytes); + +private: + int8_t _irq = -1, _reset = -1, _cs = -1; + int8_t _uid[7]; // ISO14443A uid + int8_t _uidLen; // uid len + int8_t _key[6]; // Mifare Classic key + int8_t _inListedTag; // Tg number of inlisted tag. + + // Low level communication functions that handle both SPI and I2C. + void readdata(uint8_t *buff, uint8_t n); + void writecommand(uint8_t *cmd, uint8_t cmdlen); + bool isready(); + bool waitready(uint16_t timeout); + bool readack(); + + Adafruit_SPIDevice *spi_dev = NULL; + Adafruit_I2CDevice *i2c_dev = NULL; + HardwareSerial *ser_dev = NULL; +}; + +#endif diff --git a/src/audioState.h b/src/audioState.h new file mode 100644 index 0000000..bc75ac7 --- /dev/null +++ b/src/audioState.h @@ -0,0 +1,73 @@ +#pragma once +#include +#include +#include + +void printMp3Detail(LiquidCrystal* lcd, uint8_t type, int value) +{ + lcd->clear(); + switch (type) + { + case TimeOut: + lcd->print("Time Out!"); + break; + case WrongStack: + lcd->print("Stack Wrong!"); + break; + case DFPlayerCardInserted: + lcd->print("Card Inserted!"); + break; + case DFPlayerCardRemoved: + lcd->print("Card Removed!"); + break; + case DFPlayerCardOnline: + lcd->print("Card Online!"); + break; + case DFPlayerUSBInserted: + lcd->print("USB Inserted!"); + break; + case DFPlayerUSBRemoved: + lcd->print("USB Removed!"); + break; + case DFPlayerPlayFinished: + lcd->print("Num:"); + lcd->print(value); + lcd->print(" Finished!"); + break; + case DFPlayerError: + lcd->print("DFPlayerError:"); + switch (value) + { + case Busy: + lcd->print("Card not found"); + break; + case Sleeping: + lcd->print("Sleeping"); + break; + case SerialWrongStack: + lcd->print("Wrong Stack"); + break; + case CheckSumNotMatch: + lcd->print("Checksum Error"); + break; + case FileIndexOut: + lcd->print("File Index OOB"); + break; + case FileMismatch: + lcd->print("File Mismatch"); + break; + case Advertise: + lcd->print("In Advertise"); + break; + default: + lcd->print("Unknown Error"); + break; + } + break; + default: + lcd->print("Unknown Type"); + break; + } + delay(2000); // Display the message for 2 seconds +} + diff --git a/src/context.cpp b/src/context.cpp new file mode 100644 index 0000000..b9a6081 --- /dev/null +++ b/src/context.cpp @@ -0,0 +1,17 @@ +#include "Context.h" + +Context::Context(Station* stations, const int stationCount, const unsigned long delta, DFRobotDFPlayerMini* dfPlayer) { + this->stations = stations; + this->stationCount = stationCount; + this->delta = delta; + this->dfPlayer = dfPlayer; +} +int Context::getStationIndex(const Station* station) const +{ + for (int i = 0; i < stationCount; ++i) { + if (&stations[i] == station) { + return i; + } + } + return -1; +} diff --git a/src/context.h b/src/context.h new file mode 100644 index 0000000..f1ee594 --- /dev/null +++ b/src/context.h @@ -0,0 +1,15 @@ +#pragma once +#include +#include "station.h" + +class Context { +public: + Context(Station* stations, int stationCount, unsigned long delta, DFRobotDFPlayerMini* dfPlayer); + + Station* stations; + int stationCount; + unsigned long delta; + DFRobotDFPlayerMini* dfPlayer; + + int getStationIndex(const Station* station) const; +}; diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..04ce725 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,185 @@ +#include +#include +#include +#include +#include +#include + +#include "station.h" +#include "statemachine.h" +#include "state.h" +#include "states.h" +#include "timer.h" +#include "audioState.h" + +#define PN532_CS 10 + +// Using this library to set a timeout on readPassiveTagID +// The library in use is slightly modified to fix this issue: https://github.com/adafruit/Adafruit-PN532/issues/117 +Adafruit_PN532 nfc(PN532_CS); + +constexpr int rs = 9, en = 8, d4 = 5, d5 = 4, d6 = 3, d7 = 2; +LiquidCrystal lcd(rs, en, d4, d5, d6, d7); + +SoftwareSerial softSerial(6, 7); // RX, TX +DFRobotDFPlayerMini dfPlayer; + +Station stations[5] = { + Station(1680767519, "Yellow"), Station(3346823711, "Green"), Station(3569318175, "Pink"), + Station(2174777887, "Blue"), Station(102951984, "Weird") +}; +Station* currentStation; +int currentStationIndex = -1; + +Timer stationDetectionTimer(500, true); + +String previousDisplayContent; + +StateMachine stateMachine(new Startup()); + +unsigned long lastLoopTime = 0; +unsigned long currentLoopTime = 0; +unsigned long deltaTime = 0; + + +void setupNFC() +{ + nfc.begin(); + + uint32_t versiondata = nfc.getFirmwareVersion(); + if (!versiondata) + { + while (1); // halt + } + // configure board to read RFID tags and cards + nfc.SAMConfig(); +} + + +Station* detectStation() +{ + uint8_t uid[7]; + uint8_t uidLength; + constexpr uint16_t timeout = 100; + const bool success = nfc.readPassiveTargetID(PN532_MIFARE_ISO14443A, uid, &uidLength, timeout); + if (!success) + { + return nullptr; + } + + uint32_t id = 0; + for (uint8_t i = 0; i < uidLength; i++) + { + id <<= 8; + id |= uid[i]; + } + + Station* found = 0; + for (unsigned int i = 0; i < sizeof(stations) / sizeof(stations[0]); i++) + { + Station* currentStation = &stations[i]; + if (currentStation->check(id)) + { + found = currentStation; + } + } + return found; +} + +void checkStations() +{ + Station* station = detectStation(); + + if (station != nullptr) + { + if (currentStation == nullptr) + { + currentStation = station; + stateMachine.putDown(Context(stations, sizeof(stations) / sizeof(stations[0]), deltaTime, &dfPlayer), currentStation); + } + } + else + { + if (currentStation != nullptr) + { + currentStation = nullptr; + stateMachine.pickedUp(Context(stations, sizeof(stations) / sizeof(stations[0]), deltaTime, &dfPlayer)); + } + } +} + +void printString(const String& str) +{ + int currentColumn = 0; + int currentRow = 0; + lcd.clear(); + + for (unsigned int i = 0; i < str.length(); i++) + { + lcd.setCursor(currentColumn, currentRow); + lcd.print(str[i]); + currentColumn++; + if (currentColumn >= 16) + { + currentColumn = 0; + currentRow++; + if (currentRow >= 2) + { + break; + } + } + } +} + +void loop(void) +{ + currentLoopTime = millis(); + deltaTime = currentLoopTime - lastLoopTime; + + bool doCheck = stationDetectionTimer.update(deltaTime); + if (doCheck) + { + checkStations(); + } + + stateMachine.update(Context(stations, sizeof(stations) / sizeof(stations[0]), deltaTime, &dfPlayer)); + String newContent = stateMachine.updateDisplay(); + if (previousDisplayContent != newContent) + { + lcd.clear(); + printString(newContent); + previousDisplayContent = newContent; + } + + lastLoopTime = currentLoopTime; + delay(10); +} + +void setup(void) +{ + setupNFC(); + + Serial.begin(9600); + + lcd.begin(16, 2); + stationDetectionTimer.start(); + + softSerial.begin(9600); + + lcd.print("Initializing MP3"); + lcd.clear(); + if (!dfPlayer.begin(softSerial, true, true)) + { + lcd.print("Failed to init"); + lcd.setCursor(0, 1); + lcd.print("DFPlayer!"); + while (true) + { + delay(100); + printMp3Detail(&lcd, dfPlayer.readType(), dfPlayer.read()); + } + } + + // dfPlayer.volume(15); + // dfPlayer.play(1); +} diff --git a/src/sounds.h b/src/sounds.h new file mode 100644 index 0000000..f48acd2 --- /dev/null +++ b/src/sounds.h @@ -0,0 +1,10 @@ +#include + +#define IDLE 1 +#define WRONG_SIDE_STATION 2 +#define TIMER_DOWN 3 +#define GAME_WON 4 +#define REMOVED_FROM_SIDE_STATION 5 +#define REMOVED_FROM_MAIN_STATION 6 +#define OBJECT_PLACED_ON_MAIN_STATION 7 +#define OBJECT_PLACED_ON_SIDE_STATION 8 diff --git a/src/state.h b/src/state.h new file mode 100644 index 0000000..b3d8160 --- /dev/null +++ b/src/state.h @@ -0,0 +1,17 @@ +#pragma once +#include "station.h" +#include "context.h" + +class Station; + +class State +{ +public: + virtual ~State() = default; + + virtual State* pickedUp(Context context) { return this; } + virtual State* putDown(Context context, Station* newStation) { return this; } + virtual State* update(Context context) { return this; } + + virtual String updateDisplay() { return ""; } +}; diff --git a/src/statemachine.cpp b/src/statemachine.cpp new file mode 100644 index 0000000..b558512 --- /dev/null +++ b/src/statemachine.cpp @@ -0,0 +1,37 @@ +#include "statemachine.h" +#include "station.h" +#include "context.h" + +StateMachine::StateMachine(State* initialState) + : currentState(initialState) {} + +StateMachine::~StateMachine() { + delete currentState; +} + +void StateMachine::updateState(State* newState) { + if (newState != currentState) { + delete currentState; + currentState = newState; + } +} + +void StateMachine::pickedUp(const Context& context) { + State* newState = currentState->pickedUp(context); + updateState(newState); +} + +void StateMachine::putDown(const Context& context, Station* newStation) { + State* newState = currentState->putDown(context, newStation); + updateState(newState); +} + +void StateMachine::update(const Context& context) { + State* newState = currentState->update(context); + updateState(newState); +} + +String StateMachine::updateDisplay() const +{ + return currentState->updateDisplay(); +} diff --git a/src/statemachine.h b/src/statemachine.h new file mode 100644 index 0000000..f16b413 --- /dev/null +++ b/src/statemachine.h @@ -0,0 +1,21 @@ +#pragma once +#include +#include "state.h" +#include "station.h" +#include "context.h" + +class StateMachine { +private: + State* currentState; + void updateState(State* newState); + +public: + StateMachine(State* initialState); + ~StateMachine(); + + void pickedUp(const Context& context); + void putDown(const Context& context, Station* newStation); + void update(const Context& context); + + String updateDisplay() const; +}; diff --git a/src/states.cpp b/src/states.cpp new file mode 100644 index 0000000..5ac1241 --- /dev/null +++ b/src/states.cpp @@ -0,0 +1,213 @@ +#include "states.h" +#include "state.h" +#include "station.h" + +Startup::Startup() = default; + +State* Startup::putDown(const Context context, Station* newStation) +{ + const int newStationIndex = context.getStationIndex(newStation); + if (newStationIndex == 0) + { + return new WaitingForGameStart(); + } + + return this; +} + +State* Startup::update(Context context) +{ + return this; +} + +String Startup::updateDisplay() +{ + return "Initializing:Put" + "on first station"; +} + + +//------------------------------------ + + +WaitingForGameStart::WaitingForGameStart() = default; + +State* WaitingForGameStart::pickedUp(const Context context) +{ + return new OnTheMove(context.stations + 1); // first element of the array +} + +State* WaitingForGameStart::update(Context context) +{ + return this; +} + +String WaitingForGameStart::updateDisplay() +{ + return "Waiting for Game" + "Start..."; +} + + +//------------------------------------ + + +OnTheMove::OnTheMove(Station* targetStation) +{ + this->targetStation = targetStation; +} + +State* OnTheMove::putDown(const Context context, Station* newStation) +{ + if (newStation == this->targetStation) + { + if (targetStation == context.stations) // first station + { + return new End(); + } + return new Hacking(this->targetStation); + } + + return new IncorrectStation(targetStation); +} + +State* OnTheMove::update(const Context context) +{ + return this; +} + +String OnTheMove::updateDisplay() +{ + return "On the Move... "; +} + + +//------------------------------------ + + +IncorrectStation::IncorrectStation(Station* targetStation) +{ + this->targetStation = targetStation; +} + +State* IncorrectStation::pickedUp(const Context context) +{ + return new OnTheMove(this->targetStation); +} + +State* IncorrectStation::update(const Context context) +{ + return this; +} + +String IncorrectStation::updateDisplay() +{ + return "Wrong Station! "; +} + + +//------------------------------------ + + +Hacking::Hacking(Station* currentStation): timer(5000, false) +{ + this->currentStation = currentStation; + this->timer.start(); +} + +State* Hacking::pickedUp(const Context context) +{ + return new Complain(currentStation); +} + +State* Hacking::update(const Context context) +{ + Serial.println(String(context.delta)); + const bool done = timer.update(context.delta); + if (done) + { + const int currentStationIndex = context.getStationIndex(currentStation); + const int nextStationIndex = (currentStationIndex + 1) % context.stationCount; + Station* nextStation = context.stations + nextStationIndex; + return new WaitingForPickup(currentStation, nextStation); + } + return this; +} + +String Hacking::updateDisplay() +{ + return "Hacking B)"; +} + + +//------------------------------------ + + +Complain::Complain(Station* currentStation) +{ + this->currentStation = currentStation; +} + +State* Complain::putDown(const Context context, Station* newStation) +{ + if (this->currentStation == newStation) // was put back on correct station + { + return new Hacking(this->currentStation); + } + return this; // was not put back on correct station (just keeps complaining) +} + +State* Complain::update(Context context) +{ + return this; +} + +String Complain::updateDisplay() +{ + return "Put me back!!"; +} + + +//------------------------------------ + + +WaitingForPickup::WaitingForPickup(Station* currentStation, Station* targetStation) +{ + this->currentStation = currentStation; + this->targetStation = targetStation; +} + +State* WaitingForPickup::pickedUp(Context context) +{ + return new OnTheMove(targetStation); +} + +State* WaitingForPickup::update(Context context) +{ + return this; +} + +String WaitingForPickup::updateDisplay() +{ + return "Pick me up "; +} + +End::End() = default; + + +State* End::pickedUp(const Context context) +{ + // todo what happens when we pick up here?... + return this; +} + +State* End::update(const Context context) +{ + // todo after some time return waiting for game start... + return this; +} + +String End::updateDisplay() +{ + return "END..."; +} diff --git a/src/states.h b/src/states.h new file mode 100644 index 0000000..40b6015 --- /dev/null +++ b/src/states.h @@ -0,0 +1,98 @@ +#pragma once +#include + +#include "context.h" +#include "state.h" +#include "states.h" +#include "station.h" + +class Startup final : public State +{ +public: + Startup(); + State* putDown(Context context, Station* newStation) override; + State* update(Context context) override; + String updateDisplay() override; +}; + + +class WaitingForGameStart final : public State +{ +public: + WaitingForGameStart(); + State* pickedUp(Context context) override; + State* update(Context context) override; + String updateDisplay() override; +}; + +class OnTheMove final : public State +{ +private: + Station* targetStation; + +public: + explicit OnTheMove(Station* targetStation); + State* putDown(Context context, Station* newStation) override; + State* update(Context context) override; + String updateDisplay() override; +}; + +class IncorrectStation final : public State +{ +private: + Station* targetStation; + +public: + explicit IncorrectStation(Station* targetStation); + State* pickedUp(Context context) override; + State* update(Context context) override; + String updateDisplay() override; +}; + + +class Hacking final : public State +{ +private: + Timer timer; + Station* currentStation; + +public: + explicit Hacking(Station* currentStation); + State* pickedUp(Context context) override; + State* update(Context context) override; + String updateDisplay() override; +}; + +class Complain final : public State +{ +private: + Station* currentStation; + +public: + explicit Complain(Station* currentStation); + State* putDown(Context context, Station* newStation) override; + State* update(Context context) override; + String updateDisplay() override; +}; + +class WaitingForPickup final : public State +{ +private: + Station* currentStation; + Station* targetStation; + +public: + WaitingForPickup(Station* currentStation, Station* targetStation); + State* pickedUp(Context context) override; + State* update(Context context) override; + String updateDisplay() override; +}; + +class End final : public State +{ +public: + End(); + State* pickedUp(Context context) override; + State* update(Context context) override; + String updateDisplay() override; +}; diff --git a/src/station.cpp b/src/station.cpp new file mode 100644 index 0000000..68927c7 --- /dev/null +++ b/src/station.cpp @@ -0,0 +1,17 @@ +#include +#include "station.h" + +Station::Station(uint32_t nfcTagId, String name) { + { + this->nfcTagId = nfcTagId; + this->name = name; + } +} + +bool Station::check(uint32_t nfcTagId) { + return nfcTagId == this->nfcTagId; +} + +String Station::getName() { + return this->name; +} diff --git a/src/station.h b/src/station.h new file mode 100644 index 0000000..c8468bc --- /dev/null +++ b/src/station.h @@ -0,0 +1,12 @@ +#pragma once +#include + +class Station { +private: + uint32_t nfcTagId; + String name; +public: + Station(uint32_t nfcTagId, String name); + bool check(uint32_t nfcTagId); + String getName(); +}; diff --git a/src/timer.cpp b/src/timer.cpp new file mode 100644 index 0000000..5d5c9a4 --- /dev/null +++ b/src/timer.cpp @@ -0,0 +1,47 @@ +#include "timer.h" + +#include + +Timer::Timer(const unsigned long duration, const bool autoRestart): currentTime(0), running(false) +{ + this->autoRestart = autoRestart; + this->duration = duration; + this->endTime = duration; +} + +void Timer::start() +{ + this->running = true; +} + +bool Timer::update(const unsigned long delta) +{ + Serial.print("Timer "); + if (!running) + { + Serial.print(" not running..."); + return false; + } + bool timedOut = false; + this->currentTime += delta; + Serial.print(" target : " + String(this->currentTime) + "/" + String(this->endTime)); + if (currentTime > this->endTime) + { + timedOut = true; + } + if (timedOut && this->autoRestart) + { + this->endTime += this->duration; + } + if (timedOut && !this->autoRestart) + { + running = false; + } + Serial.println(); + return timedOut; +} + +bool Timer::isRunning() const +{ + return this->running; +} diff --git a/src/timer.h b/src/timer.h new file mode 100644 index 0000000..9667847 --- /dev/null +++ b/src/timer.h @@ -0,0 +1,17 @@ +#pragma once + +class Timer { +private: + unsigned long duration; + bool autoRestart; + + unsigned long currentTime; + unsigned long endTime; + bool running; + +public: + Timer(unsigned long duration, bool autoRestart); + void start(); + bool update(unsigned long delta); + bool isRunning() const; +}; diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html