Wrote rdm6300 rfid reader lib, tested on esp32, esp8266, avr!

Author: arduino12

examples/read_to_serial/read_to_serial.ino

@@ -0,0 +1,40 @@
+/*
+ * A simple example to interface with rdm6300 rfid reader.
+ *
+ * Connect the rdm6300 to VCC=5V, GND=GND, TX=any GPIO (this case GPIO_2)
+ * Note: for ESP* or other 3.3V based microcontroller,
+ *       you must divide the TX out of the rdm6300 to the 3.3V levels,
+ *       I used the following resistor divider:
+ *       GND--<2K resistor>--GPIO_2--<1K resistor>--TX(rdm6300).
+ *
+ * Arad Eizen (https://github.com/arduino12) 23/09/18.
+ */
+#include <rdm6300.h>
+
+#define RDM6300_RX_PIN 2
+#define READ_LED_PIN 13
+
+Rdm6300 rdm6300;
+
+void setup()
+{
+	Serial.begin(115200);
+
+	pinMode(READ_LED_PIN, OUTPUT);
+	digitalWrite(READ_LED_PIN, LOW);
+
+	rdm6300.begin(RDM6300_RX_PIN);
+
+	Serial.println("Place RFID tag near the rdm6300...");
+}
+
+void loop()
+{
+	/* if non-zero tag_id, update() returns true- a new tag is near! */
+	if (rdm6300.update())
+		Serial.println(rdm6300.get_tag_id(), HEX);
+
+	digitalWrite(READ_LED_PIN, rdm6300.is_tag_near());
+
+	delay(10);
+}

keywords.txt

@@ -0,0 +1,26 @@
+#######################################
+# Syntax Coloring Map Rdm6300
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+Rdm6300	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+begin		KEYWORD2
+update		KEYWORD2
+get_tag_id	KEYWORD2
+is_tag_near	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+RDM6300_PACKET_SIZE		LITERAL1
+RDM6300_PACKET_BEGIN	LITERAL1
+RDM6300_PACKET_END		LITERAL1
+RDM6300_NEXT_READ_MS	LITERAL1
+RDM6300_BAUDRATE		LITERAL1

library.json

@@ -0,0 +1,22 @@
+{
+  "name": "rdm6300",
+  "version": "1.0.0",
+  "keywords": "rdm6300, rfid",
+  "description": "A simple library to interface with rdm6300 rfid reader.",
+  "repository":
+  {
+    "type": "git",
+    "url": "https://github.com/arduino12/rdm6300.git"
+  },
+  "authors":
+  [
+    {
+        "name": "Arad Eizen",
+        "email": "https://github.com/arduino12",
+        "url": "https://github.com/arduino12"
+		"maintainer": true
+    }
+  ],
+  "frameworks": "arduino",
+  "platforms": "*"
+}

library.properties

@@ -0,0 +1,9 @@
+name=Rdm6300
+version=1.0.0
+author=Arad Eizen
+maintainer=Arad Eizen <https://github.com/arduino12>
+sentence=A simple library to interface with rdm6300 rfid reader.
+paragraph=A simple library to interface with rdm6300 rfid reader.
+category=Sensors
+url=https://github.com/arduino12/rdm6300
+architectures=*

rdm6300.cpp

@@ -0,0 +1,84 @@
+/*
+ * A simple library to interface with rdm6300 rfid reader.
+ * Arad Eizen (https://github.com/arduino12) 23/09/18.
+ */
+
+#include "RDM6300.h"
+#include <Arduino.h>
+
+
+void Rdm6300::begin(int rx_pin)
+{
+	/* init serial port to rdm6300 baud, without TX, and 20ms read timeout */
+#ifdef ARDUINO_ARCH_ESP32
+	_serial = new HardwareSerial(1);
+	_serial->begin(RDM6300_BAUDRATE, SERIAL_8N1, rx_pin, -1);
+#else
+	_serial = new SoftwareSerial(rx_pin, -1);
+	_serial->begin(RDM6300_BAUDRATE);
+#endif
+	_serial->setTimeout(20);
+}
+
+bool Rdm6300::update(void)
+{
+	char buff[RDM6300_PACKET_SIZE];
+	uint32_t tag_id;
+	uint8_t checksum;
+
+	if (!_serial->available())
+		return false;
+
+	/* if a packet doesn't begin with the right byte, remove that byte */
+	if (_serial->peek() != RDM6300_PACKET_BEGIN && _serial->read())
+		return false;
+
+	/* if read a packet with the wrong size, drop it */
+	if (RDM6300_PACKET_SIZE != _serial->readBytes(buff, RDM6300_PACKET_SIZE))
+		return false;
+
+	/* if a packet doesn't end with the right byte, drop it */
+	if (buff[13] != RDM6300_PACKET_END)
+		return false;
+
+	/* add null and parse checksum */
+	buff[13] = 0;
+	checksum = strtol(buff + 11, NULL, 16);
+	/* add null and parse tag_id */
+	buff[11] = 0;
+	tag_id = strtol(buff + 3, NULL, 16);
+	/* add null and parse version (needs to be xored with checksum) */
+	buff[3] = 0;
+	checksum ^= strtol(buff + 1, NULL, 16);
+
+	/* xore the tag_id and validate checksum */
+	for (uint8_t i = 0; i < 32; i += 8)
+		checksum ^= ((tag_id >> i) & 0xFF);
+	if (checksum)
+		return false;
+
+	/* if a new tag appears- return it */
+	if (_last_tag_id != tag_id) {
+		_last_tag_id = tag_id;
+		_next_read_ms = 0;
+	}
+	/* if the old tag is still here set tag_id to zero */
+	if (_next_read_ms > millis())
+		tag_id = 0;
+	_next_read_ms = millis() + RDM6300_NEXT_READ_MS;
+
+	_tag_id = tag_id;
+	return tag_id;
+}
+
+bool Rdm6300::is_tag_near(void)
+{
+	return _next_read_ms > millis();
+}
+
+uint32_t Rdm6300::get_tag_id(void)
+{
+	uint32_t tag_id = _tag_id;
+	_tag_id = 0;
+	return tag_id;
+}

rdm6300.h

@@ -0,0 +1,39 @@
+/*
+ * A simple library to interface with rdm6300 rfid reader.
+ * Arad Eizen (https://github.com/arduino12) 23/09/18.
+ */
+
+#ifndef RDM6300_h
+#define RDM6300_h
+
+#ifdef ARDUINO_ARCH_ESP32
+	#include <HardwareSerial.h>
+#else
+	#include <SoftwareSerial.h>
+#endif
+
+#define RDM6300_PACKET_SIZE 14
+#define RDM6300_PACKET_BEGIN 0x02
+#define RDM6300_PACKET_END 0x03
+#define RDM6300_NEXT_READ_MS 220
+#define RDM6300_BAUDRATE 9600
+
+class Rdm6300
+{
+	public:
+		void begin(int rxPin);
+		bool update(void);
+		uint32_t get_tag_id(void);
+		bool is_tag_near(void);
+	private:
+#ifdef ARDUINO_ARCH_ESP32
+		HardwareSerial * _serial;
+#else
+		SoftwareSerial * _serial;
+#endif
+		uint32_t _tag_id = 0;
+		uint32_t _last_tag_id = 0;
+		uint32_t _next_read_ms = 0;
+};
+
+#endif