V2.0.0! API changed, fix tag timeout handling.

Remove ```update```.
```get_new_tag_id``` acts like the previous ```get_tag_id```.
```get_tag_id``` can be use instead of ```is_tag_near```.
Fix previous wrong tag timeout handling.

Author: arduino12

README.md

@@ -3,7 +3,7 @@ A simple library to interface with RDM6300 RFID reader.
 
 ## Features
 * Fast and single tag reading, even if it held near the antenna for a while.
-* Using a single configurable GPIO pin.
+* Using a single given GPIO pin.
 * Can tell if the tag is still near the antenna.
 * Both hardware and software uart (serial) support on esp8266.
 * SAMD hardware uart (serial) support.
@@ -23,10 +23,14 @@ A simple RFID tag reader with textual serial output:
 [```examples/read_to_serial/read_to_serial.ino```](examples/read_to_serial/read_to_serial.ino)
 
 #### API
-* ```void begin(Stream *stream)``` - Initialize the object to use the given stream to read from the RDM6300.
-* ```void begin(int rxPin, uint8_t uart_nr=1)``` - Initialize the object to use the given GPIO pin as RX from the RDM6300.
-* ```bool update()``` - Updates the internal values by reading from the RDM6300, returns true on tag detection, must be called repeatedly!
-* ```uint32_t get_tag_id()``` - Returns the last tag id read by ```update```- can be called only once after ```update```.
-* ```bool is_tag_near()``` -  Returns whether a tag is currently held near the antenna- can be called many times after ```update```.
+* ```void begin(Stream *stream)``` - Initialize instance to read from a given stream.
+* ```void begin(int rx_pin, uint8_t uart_nr=1)``` - Initialize instance to read from a given pin.
+* ```void set_tag_timeout(uint32_t tag_timeout_ms)``` - sets the tag "valid" timeout, (300ms default)  
+RDM6300 sends packet every 65ms when tag is near- better higher values for debouncing.  
+* ```uint32_t get_tag_id()``` - Returns the tag_id as long as it is near, 0 otherwise.
+* ```uint32_t get_new_tag_id()``` - Returns the tag_id of a "new" near tag,  
+following calls will return 0 as long as the same tag is kept near.
+* ~~```bool update()``` - Updates the internal values must be called repeatedly!~~ **deprecated!**
+* ~~```bool is_tag_near()``` - Returns whether a tag is held near.~~ **deprecated!** use ```get_tag_id```.
 ## Enjoy!
 A.E.TECH

examples/altsoftserial_based/altsoftserial_based.ino

@@ -26,7 +26,6 @@
 Rdm6300 rdm6300;
 AltSoftSerial alt_soft_serial;
 
-
 void setup()
 {
 	Serial.begin(115200);
@@ -42,11 +41,13 @@ void setup()
 
 void loop()
 {
-	/* if non-zero tag_id, update() returns true- a new tag is near! */
-	if (rdm6300.update())
+	/* get_new_tag_id returns the tag_id of a "new" near tag,
+	following calls will return 0 as long as the same tag is kept near. */
+	if (rdm6300.get_new_tag_id())
 		Serial.println(rdm6300.get_tag_id(), HEX);
 
-	digitalWrite(READ_LED_PIN, rdm6300.is_tag_near());
+	/* get_tag_id returns the tag_id as long as it is near, 0 otherwise. */
+	digitalWrite(READ_LED_PIN, rdm6300.get_tag_id());
 
 	delay(10);
 }

examples/esp8266_hardware_uart/esp8266_hardware_uart.ino

@@ -47,11 +47,13 @@ void setup()
 
 void loop()
 {
-	/* if non-zero tag_id, update() returns true- a new tag is near! */
-	if (rdm6300.update())
+	/* get_new_tag_id returns the tag_id of a "new" near tag,
+	following calls will return 0 as long as the same tag is kept near. */
+	if (rdm6300.get_new_tag_id())
 		Serial1.println(rdm6300.get_tag_id(), HEX);
 
-	digitalWrite(READ_LED_PIN, rdm6300.is_tag_near());
+	/* get_tag_id returns the tag_id as long as it is near, 0 otherwise. */
+	digitalWrite(READ_LED_PIN, rdm6300.get_tag_id());
 
 	delay(10);
 }

examples/hardware_uart/hardware_uart.ino

@@ -29,11 +29,13 @@ void setup()
 
 void loop()
 {
-	/* if non-zero tag_id, update() returns true- a new tag is near! */
-	if (rdm6300.update())
+	/* get_new_tag_id returns the tag_id of a "new" near tag,
+	following calls will return 0 as long as the same tag is kept near. */
+	if (rdm6300.get_new_tag_id())
 		Serial.println(rdm6300.get_tag_id(), HEX);
 
-	digitalWrite(READ_LED_PIN, rdm6300.is_tag_near());
+	/* get_tag_id returns the tag_id as long as it is near, 0 otherwise. */
+	digitalWrite(READ_LED_PIN, rdm6300.get_tag_id());
 
 	delay(10);
 }

examples/multiple_software_serials/multiple_software_serials.ino

@@ -28,10 +28,10 @@
 
 #include <rdm6300.h>
 
-#define RDM6300_1_RX_PIN	5
-#define RDM6300_1_LED_PIN	6
-#define RDM6300_2_RX_PIN	7
-#define RDM6300_2_LED_PIN	8
+#define RDM6300_1_RX_PIN	(5)
+#define RDM6300_1_LED_PIN	(6)
+#define RDM6300_2_RX_PIN	(7)
+#define RDM6300_2_LED_PIN	(8)
 
 Rdm6300 rdm6300_1;
 Rdm6300 rdm6300_2;
@@ -55,23 +55,23 @@ void setup()
 
 void loop()
 {
-	// checkout listening if needed
-	if (digitalRead(RDM6300_1_LED_PIN) == LOW
-			&& !rdm6300_1.is_listening()) {
+	/* listen to a "talking" RDM6300 if needed */
+	if (!digitalRead(RDM6300_1_LED_PIN) && !rdm6300_1.is_listening()) {
 		Serial.println("Switch to listening RDM6300_1");
 		rdm6300_1.listen();
 		current_rdm6300 = &rdm6300_1;
-	} else if (digitalRead(RDM6300_2_LED_PIN) == LOW
-			&& !rdm6300_2.is_listening()) {
+	}
+	else if (!digitalRead(RDM6300_2_LED_PIN) && !rdm6300_2.is_listening()) {
 		Serial.println("Switch to listening RDM6300_2");
 		rdm6300_2.listen();
 		current_rdm6300 = &rdm6300_2;
 	}
 
-	/* If you use rdm6300 with other devices, you had better set a TIMEOUT and run a while-loop to
-		make sure the tag can be read correctely. */
-	if (current_rdm6300->update()) 
+	/* if you use rdm6300 with other devices,
+	you had better set a TIMEOUT and run a while-loop to
+	make sure the tag can be read correctely */
+	if (current_rdm6300->get_new_tag_id()) 
 		Serial.println(current_rdm6300->get_tag_id(), HEX);
-	
+
 	delay(10);
 }

examples/read_to_serial/read_to_serial.ino

@@ -13,6 +13,7 @@
  * Arad Eizen (https://github.com/arduino12).
  */
 
+#include <Arduino.h>
 #include <rdm6300.h>
 
 #define RDM6300_RX_PIN 4 // read the SoftwareSerial doc above! may need to change this pin to 10...
@@ -34,11 +35,13 @@ void setup()
 
 void loop()
 {
-	/* if non-zero tag_id, update() returns true- a new tag is near! */
-	if (rdm6300.update())
+	/* get_new_tag_id returns the tag_id of a "new" near tag,
+	following calls will return 0 as long as the same tag is kept near. */
+	if (rdm6300.get_new_tag_id())
 		Serial.println(rdm6300.get_tag_id(), HEX);
 
-	digitalWrite(READ_LED_PIN, rdm6300.is_tag_near());
+	/* get_tag_id returns the tag_id as long as it is near, 0 otherwise. */
+	digitalWrite(READ_LED_PIN, rdm6300.get_tag_id());
 
 	delay(10);
 }

keywords.txt

@@ -13,18 +13,18 @@ Rdm6300	KEYWORD1
 #######################################
 begin			KEYWORD2
 end				KEYWORD2
-update			KEYWORD2
+set_tag_timeout	KEYWORD2
 get_tag_id		KEYWORD2
-is_tag_near		KEYWORD2
+get_new_tag_id	KEYWORD2
 listen			KEYWORD2
 is_listening	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)
 #######################################
-RDM6300_BAUDRATE		LITERAL1
-RDM6300_PACKET_SIZE		LITERAL1
-RDM6300_PACKET_BEGIN	LITERAL1
-RDM6300_PACKET_END		LITERAL1
-RDM6300_NEXT_READ_MS	LITERAL1
-RDM6300_READ_TIMEOUT	LITERAL1
+RDM6300_BAUDRATE				LITERAL1
+RDM6300_PACKET_SIZE				LITERAL1
+RDM6300_PACKET_BEGIN			LITERAL1
+RDM6300_PACKET_END				LITERAL1
+RDM6300_DEFAULT_TAG_TIMEOUT_MS	LITERAL1
+RDM6300_READ_TIMEOUT			LITERAL1

library.json

@@ -1,6 +1,6 @@
 {
   "name": "rdm6300",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "keywords": "rdm6300, rfid",
   "description": "A simple library to interface with rdm6300 rfid reader.",
   "repository":

library.properties

@@ -1,5 +1,5 @@
 name=Rdm6300
-version=1.3.0
+version=2.0.0
 author=Arad Eizen
 maintainer=Arad Eizen <https://github.com/arduino12>
 sentence=A simple library to interface with rdm6300 rfid reader.

src/rdm6300.cpp

@@ -4,8 +4,6 @@
  */
 
 #include "rdm6300.h"
-#include <Arduino.h>
-
 
 void Rdm6300::begin(Stream *stream)
 {
@@ -55,29 +53,29 @@ void Rdm6300::end()
 #endif
 }
 
-bool Rdm6300::update(void)
+uint32_t Rdm6300::_read_tag_id(void)
 {
 	char buff[RDM6300_PACKET_SIZE];
-	uint32_t tag_id;
 	uint8_t checksum;
+	uint32_t tag_id;
 
 	if (!_stream)
-		return false;
+		return 0;
 
 	if (!_stream->available())
-		return false;
+		return 0;
 
 	/* if a packet doesn't begin with the right byte, remove that byte */
 	if (_stream->peek() != RDM6300_PACKET_BEGIN && _stream->read())
-		return false;
+		return 0;
 
 	/* if read a packet with the wrong size, drop it */
 	if (RDM6300_PACKET_SIZE != _stream->readBytes(buff, RDM6300_PACKET_SIZE))
-		return false;
+		return 0;
 
 	/* if a packet doesn't end with the right byte, drop it */
 	if (buff[13] != RDM6300_PACKET_END)
-		return false;
+		return 0;
 
 	/* add null and parse checksum */
 	buff[13] = 0;
@@ -93,31 +91,66 @@ bool Rdm6300::update(void)
 	for (uint8_t i = 0; i < 32; i += 8)
 		checksum ^= ((tag_id >> i) & 0xFF);
 	if (checksum)
-		return false;
+		return 0;
+
+	return tag_id;
+}
+
+void Rdm6300::_update(void)
+{
+	uint32_t cur_ms = millis();
+	uint32_t tag_id = _read_tag_id();
 
 	/* if a new tag appears- return it */
-	if (_last_tag_id != tag_id) {
-		_last_tag_id = tag_id;
-		_last_read_ms = 0;
+	if (tag_id) {
+		_tag_id = tag_id;
+		if (_last_tag_id != tag_id) {
+			_last_tag_id = tag_id;
+			_new_tag_id = tag_id;
+		}
+		_last_tag_ms = cur_ms;
+		return;
 	}
-	/* if the old tag is still here set tag_id to zero */
-	if (is_tag_near())
-		tag_id = 0;
-	_last_read_ms = millis();
 
-	_tag_id = tag_id;
-	return tag_id;
+	/* if the old tag id is still valid- leve it */
+	if (!_tag_id || (cur_ms - _last_tag_ms < _tag_timeout_ms))
+		return;
+
+	_tag_id = _last_tag_id = _new_tag_id = 0;
 }
 
-bool Rdm6300::is_tag_near(void)
+/*
+ * Sets the tag "valid" timeout,
+ * RDM6300 sends packet every 65ms when tag is near-
+ * so theoretically this timeout should be the same,
+ * but it is better to debounce it by setting it higher,
+ * like the RDM6300_DEFAULT_TAG_TIMEOUT_MS = 300.
+ */
+void Rdm6300::set_tag_timeout(uint32_t tag_timeout_ms)
 {
-	return millis() - _last_read_ms < RDM6300_NEXT_READ_MS;
+	_tag_timeout_ms = tag_timeout_ms;
 }
 
+/*
+ * Returns the tag_id as long as it is near (and the tag timout is valid),
+ * or 0 if no tag is near.
+ */
 uint32_t Rdm6300::get_tag_id(void)
 {
-	uint32_t tag_id = _tag_id;
-	_tag_id = 0;
+	_update();
+	return _tag_id;
+}
+
+/*
+ * Returns the tag_id only once per "new" near tag,
+ * or 0 if no tag is near.
+ * Following calls will return 0 as long as the same tag is kept near.
+ */
+uint32_t Rdm6300::get_new_tag_id(void)
+{
+	_update();
+	uint32_t tag_id = _new_tag_id;
+	_new_tag_id = 0;
 	return tag_id;
 }