From 1da9c22d2fa8f2d2b66a501d0a8af191f20a9c22 Mon Sep 17 00:00:00 2001 From: Azalea <22280294+hykilpikonna@users.noreply.github.com> Date: Sat, 25 Nov 2023 02:12:56 -0500 Subject: [PATCH] [+] Libraries --- .gitmodules | 3 +++ include/README | 39 ++++++++++++++++++++++++++++ lib/PN532 | 1 + lib/PN532-repo | 1 + lib/PN532_I2C | 1 + lib/README | 46 ++++++++++++++++++++++++++++++++++ src/{firmware.cpp => main.cpp} | 24 +++++++++--------- test/README | 11 ++++++++ 8 files changed, 114 insertions(+), 12 deletions(-) create mode 100644 .gitmodules create mode 100644 include/README create mode 120000 lib/PN532 create mode 160000 lib/PN532-repo create mode 120000 lib/PN532_I2C create mode 100644 lib/README rename src/{firmware.cpp => main.cpp} (98%) create mode 100644 test/README diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..8c0f673 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "lib/PN532"] + path = lib/PN532-repo + url = https://github.com/Seeed-Studio/PN532/ 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/PN532 b/lib/PN532 new file mode 120000 index 0000000..e225928 --- /dev/null +++ b/lib/PN532 @@ -0,0 +1 @@ +PN532-repo/PN532 \ No newline at end of file diff --git a/lib/PN532-repo b/lib/PN532-repo new file mode 160000 index 0000000..40fa741 --- /dev/null +++ b/lib/PN532-repo @@ -0,0 +1 @@ +Subproject commit 40fa7418636da5e03b0126e38c221b143b24b5a4 diff --git a/lib/PN532_I2C b/lib/PN532_I2C new file mode 120000 index 0000000..62e3a10 --- /dev/null +++ b/lib/PN532_I2C @@ -0,0 +1 @@ +PN532-repo/PN532_I2C \ No newline at end of file diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..6debab1 --- /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 a 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/src/firmware.cpp b/src/main.cpp similarity index 98% rename from src/firmware.cpp rename to src/main.cpp index b6f863c..f58dbd8 100644 --- a/src/firmware.cpp +++ b/src/main.cpp @@ -14,7 +14,7 @@ PN532 nfc(pn532i2c); uint8_t _prevIDm[8]; unsigned long _prevTime; -void setup(void) +void setup() { delay(1000); Serial.begin(115200); @@ -44,7 +44,16 @@ void setup(void) memset(_prevIDm, 0, 8); } -void loop(void) +void printUid(uint8_t* uid, uint8_t uidLength) { + Serial.print("UID Length: ");Serial.print(uidLength, DEC);Serial.println(" bytes"); + Serial.print("UID Value: "); + for (uint8_t i = 0; i < uidLength; i++) { + Serial.print(uid[i], HEX); + } + Serial.println(""); +} + +void loop() { uint8_t ret; uint16_t systemCode = 0xFFFF; @@ -73,7 +82,7 @@ void loop(void) _prevTime = millis(); return; } - + Serial.print("M"); uint8_t uid[] = { 0, 0, 0, 0, 0, 0, 0 }; // Buffer to store the returned UID uint8_t uidLength; // Length of the UID (4 or 7 bytes depending on ISO14443A card type) @@ -93,12 +102,3 @@ void loop(void) return; } } - -void printUid(uint8_t* uid, uint8_t uidLength) { - Serial.print("UID Length: ");Serial.print(uidLength, DEC);Serial.println(" bytes"); - Serial.print("UID Value: "); - for (uint8_t i = 0; i < uidLength; i++) { - Serial.print(uid[i], HEX); - } - Serial.println(""); -} 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