🎉 Initial commit

Author: Prepager

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -0,0 +1,46 @@
+# Arduino - EEPROM Key Database
+This library is a wrapper around EEPROM as a key storing database. The libraries initial purpose was to be used for RFID HEX ID storing and verification.
+
+## Methods
+``int KeyDB::count()`` _Returns key count from storage._
+
+``void KeyDB::loadKeys()`` _Loads keys from storage into array._
+
+``void KeyDB::saveKeys()`` _Saves array keys to storage._
+
+``void KeyDB::addKey(String key)`` _Adds key to array and storage._
+
+``void KeyDB::removeKey(String key)`` _Removes key from array and shift indexes._
+> Because of heavy read/write actions when removing you must manually call KeyDB::saveKeys() to save changes.
+
+``bool KeyDB::keyExists(String key)`` _Checks if key exists in array._
+
+``String KeyDB::keyLengthen(String key)`` _Forces a key to a fixed defined length._
+
+## Variables
+``#define DB_KEY_MAX 12`` _The maximum amount of keys in the database._
+
+``#define DB_KEY_LENGTH 8`` _The char length of the key._
+
+``String KeyDB::keys[DB_KEY_MAX] = {""}`` _The main array of keys._
+
+## Usage
+> **BEFORE USE:** The initial count must be set by doing: ``#include <EEPROM.h>`` & ``EEPROM.write(0, 0);``
+```cpp
+// Include the KeyDB file.
+#include "KeyDB.h"
+
+// Create a new KeyDB object.
+KeyDB database;
+
+void setup() {
+    Serial.begin(9600);
+
+    // Add new key to database.
+    database.addKey("ABC12345");
+
+    // Check if it exists in storage.
+    if (database.keyExists("ABC12345"))
+        Serial.println("Valid key!");
+}
+```

keywords.txt

@@ -0,0 +1,25 @@
+#######################################
+# KeyDB Syntax Coloring
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+KeyDB	KEYWORD1	KeyDB
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+count	KEYWORD2
+addKey	KEYWORD2
+loadKeys	KEYWORD2
+saveKeys	KEYWORD2
+removeKey	KEYWORD2
+keyExists	KEYWORD2
+keyLengthen	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################

library.properties

@@ -0,0 +1,10 @@
+name=KeyDB
+version=1.0
+author=Andreas <andreas@zapsterstudios.com>
+maintainer=Andreas <andreas@zapsterstudios.com>
+sentence=Wrapper around EEPROM as a key storing database.
+paragraph=This library is a wrapper around EEPROM as a key storing database. The libraries initial purpose was to be used for RFID HEX ID storing and verification.
+category=Data Storage
+url=https://github.com/zapsterstudios/Arduino-KeyDB
+architectures=*
+includes=KeyDB.h

src/KeyDB.cpp

@@ -0,0 +1,166 @@
+// Include header file.
+#include "KeyDB.h"
+
+/**
+ * Load all keys into array on init.
+ */
+KeyDB::KeyDB() {
+    this->loadKeys();
+}
+
+/**
+ * Returns key count from storage.
+ *
+ * @return int
+ */
+int KeyDB::count() {
+    return EEPROM.read(0);
+}
+
+/**
+ * Loads keys from storage into array.
+ */
+void KeyDB::loadKeys() {
+    // Read key count from storage.
+    int count = this->count();
+    
+    // Loop through key count.
+    int position = 1;
+    for (int i = 0; i < count; i++) {
+        // Loop through the key char length.
+        for(int k = 0; k < DB_KEY_LENGTH; k++) {
+            // Add read char to key string.
+            char readChar = char(EEPROM.read(position));
+            this->keys[i].concat(readChar);
+
+            // Increment position.
+            position++;
+        }
+    }
+}
+
+/**
+ * Saves array keys to storage.
+ */
+void KeyDB::saveKeys() {
+    // Loop through the key list.
+    int keys = 0;
+    int position = 1;
+    for (int i = 0; i < DB_KEY_MAX; i++) {
+        // Break out of array if empty.
+        if (this->keys[i] == "")
+            break;
+
+        // Loop through the key char length.
+        for(int k = 0; k < DB_KEY_LENGTH; k++) {
+            // Write key char to storage.
+            EEPROM.update(position, this->keys[i][k]);
+
+            // Increment position.
+            position++;
+        }
+
+        // Increment keys.
+        keys++;
+    }
+
+    // Update key count in storage.
+    EEPROM.write(0, keys);
+}
+
+/**
+ * Adds key to array and storage.
+ *
+ * @param  String  key
+ */
+void KeyDB::addKey(String key) {
+    // Make key fixed length.
+    key = this->keyLengthen(key);
+
+    // Set index to new value.
+    int keys = this->count();
+    this->keys[keys] = key;
+
+    // Find position for next input.
+    int position = (keys * DB_KEY_LENGTH) + 1;
+
+    // Loop through the key char length.
+    for(int k = 0; k < DB_KEY_LENGTH; k++) {
+        // Write key char to storage.
+        EEPROM.update(position, this->keys[keys][k]);
+
+        // Increment position.
+        position++;
+    }
+
+    // Update key count in storage.
+    EEPROM.write(0, keys + 1);
+}
+
+/**
+ * Removes key from array and shift indexes. 
+ *
+ * @param  String  key
+ */
+void KeyDB::removeKey(String key) {
+    // Make key fixed length.
+    key = this->keyLengthen(key);
+
+    // Loop through keys.
+    int shifting = 0;
+    for (int i = 0; i < DB_KEY_MAX; i++) {
+        // Shift indexes if shifting.
+        if (shifting) 
+            this->keys[i - 1] = this->keys[i];
+
+        // Break out of loop if empty.
+        if (this->keys[i] == "")
+            break;
+
+        // Continue if not same key.
+        if (this->keys[i] != key)
+            continue;
+
+        // Start shifting indexes.
+        shifting = 1;
+    }
+}
+
+/**
+ * Checks if key exists in array.
+ *
+ * @param  String  key
+ * @return bool
+ */
+bool KeyDB::keyExists(String key) {
+    // Make key fixed length.
+    key = this->keyLengthen(key);
+
+    // Loop through keys.
+    for (int i = 0; i < DB_KEY_MAX; i++) {
+        // Return out of array if empty.
+        if (this->keys[i] == "")
+            return true;
+
+        // Return found status if same key.
+        if (this->keys[i] == key) {
+            return false;
+        }
+    }
+}
+
+/**
+ * Forces a key to a fixed defined length.
+ *
+ * @param  String  key
+ * @return String
+ */
+String KeyDB::keyLengthen(String key) {
+    // Add zeros untill correct char length.
+    while (key.length() < DB_KEY_LENGTH) {
+        key = '0' + key;
+    }
+
+    // Return key with fixed length.
+    return key;
+}

src/KeyDB.h

@@ -0,0 +1,30 @@
+// Include guard.
+#ifndef KEY_DB_H
+#define KEY_DB_H
+
+// Define max key count and char length.
+#define DB_KEY_MAX 12
+#define DB_KEY_LENGTH 8
+
+// Include Arduino and EEPROM libraries.
+#include "Arduino.h"
+#include <EEPROM.h>
+
+// Start class declaration.
+class KeyDB {
+    public:
+        KeyDB();
+
+        int count();
+        void loadKeys();
+        void saveKeys();
+
+        void addKey(String key);
+        void removeKey(String key);
+        bool keyExists(String key);
+
+        String keyLengthen(String key);
+        String keys[DB_KEY_MAX] = {""};
+};
+
+#endif