Add LICENSE.md, minor fixes

Author: arduino12

LICENSE.md

@@ -6,6 +6,7 @@ A simple library to interface with RDM6300 RFID reader.
 * Using a single configurable GPIO pin.
 * Can tell if the tag is still near the antenna.
 * Both hardware and software uart (serial) support on esp8266.
+* Both SoftwareSerial and AltSoftSerial support.
 
 ## Getting Started
 
@@ -21,7 +22,8 @@ A simple RFID to serial reciver example can be found at:
 [```examples/read_to_serial/read_to_serial.ino```](examples/read_to_serial/read_to_serial.ino)
 
 #### API
-* ```void begin(int rxPin)``` - Initialize the object to use the given GPIO pin as RX from the RDM6300.
+* ```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```.

README.md

@@ -14,7 +14,7 @@
  *     | Wiring-S         |      6 |            4 |            5 |
  *     | Sanguino         |     14 |           12 |           13 |
  *
- * Arad Eizen (https://github.com/arduino12) 08/05/19, 09/06/19, 22/06/19.
+ * Arad Eizen (https://github.com/arduino12).
  */
 
 #include <rdm6300.h>

examples/altsoftserial_based/altsoftserial_based.ino

@@ -22,7 +22,7 @@
  *
  *     * GPIO-01 to GPIO-02 is for debug terminal output.
  *
- * Arad Eizen (https://github.com/arduino12) 08/05/19, 09/06/19.
+ * Arad Eizen (https://github.com/arduino12).
  */
 
 #include <rdm6300.h>

examples/esp8266_hardware_uart/esp8266_hardware_uart.ino

@@ -5,7 +5,7 @@
  * Note that the rdm6300's TX line is 3.3V level,
  * so it's save to use with both AVR* and ESP* microcontrollers.
  *
- * Arad Eizen (https://github.com/arduino12) 23/09/18, 08/05/19, 09/06/19.
+ * Arad Eizen (https://github.com/arduino12).
  */
 
 #include <rdm6300.h>

examples/read_to_serial/read_to_serial.ino

@@ -20,8 +20,9 @@ is_tag_near	KEYWORD2
 #######################################
 # Constants (LITERAL1)
 #######################################
+RDM6300_BAUDRATE		LITERAL1
 RDM6300_PACKET_SIZE		LITERAL1
 RDM6300_PACKET_BEGIN	LITERAL1
 RDM6300_PACKET_END		LITERAL1
 RDM6300_NEXT_READ_MS	LITERAL1
-RDM6300_BAUDRATE		LITERAL1
+RDM6300_READ_TIMEOUT	LITERAL1

keywords.txt

@@ -1,6 +1,6 @@
 /*
  * A simple library to interface with rdm6300 rfid reader.
- * Arad Eizen (https://github.com/arduino12) 23/09/18, 08/05/19.
+ * Arad Eizen (https://github.com/arduino12).
  */
 
 #include "rdm6300.h"

src/rdm6300.cpp

@@ -1,7 +1,7 @@
 /*
  * A simple library to interface with rdm6300 rfid reader.
  *
- * Arad Eizen (https://github.com/arduino12) 23/09/18, 08/05/19.
+ * Arad Eizen (https://github.com/arduino12).
  */
 
 #ifndef _RDM6300_h_
@@ -35,7 +35,7 @@ class Rdm6300
 {
 	public:
 		void begin(Stream *stream);
-		void begin(int rxPin, uint8_t uart_nr=1);
+		void begin(int rx_pin, uint8_t uart_nr=1);
 		void end(void);
 		bool update(void);
 		uint32_t get_tag_id(void);