Skip to content

Commit d1897c4

Browse files
authored
Create README.md
1 parent 9d2f991 commit d1897c4

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# rdm6300
2+
A simple library to interface with RDM6300 RFID reader.
3+
4+
## Features
5+
* Fast and single tag reading, even if it held near the antenna for a while.
6+
* Using a single configurable GPIO pin.
7+
* Can tell if the tag is still near the antenna.
8+
9+
## Getting Started
10+
11+
### Hardware
12+
* RDM6300 module with matching antenna.
13+
* 125KHz RFID tags.
14+
* Microcontroller (arduino, esp8266, esp32...).
15+
* Jump-Wires (Resistors of 1K and 2K if you are using 3.3V based microcontroller).
16+
17+
![alt text](https://lh3.googleusercontent.com/xaZxf4aRQCM8teJDho_jtRJmqZsE5Da2rX5pBThctffH6az2lyWtEnTPPcqcCPayg55p8bbobJLVRCW-M5e5ywGp2nlcUq1dZAzxXvzCjm2zXq0e8K1EeNI6WG2G_gApMI90Lkt_rYKPiamGgXwFvjGCE-rI2NmOciinfDIbdIpCHMlPf-0WRTxo7s7hSY86b0BDnNRpCKgZBeJizIM3karj6Y5EwH3xP5heDDr2sunw4YWF5EQCmVrU-ipS8Umzp5EnyQELH0nW9JfAXFHkN4aCVoO2QW2oOMRajGpEW8IGxAQUEmLHmYQEsqV1dUd4aVvkTFnN-H2JoOssspcIpXoHExpLLxOwlk2QjT6KVw7hQaeENwv-my6gEbTOzfg9DoC__j6WMkjewsaph408ALDsqxjm5lOoZDl9ag8nwqXi0SmmCphq7FiwG9pbyrTCbOqh4V8Dep4vXg3lkchZeedWLSU51xIJjN3K2RYG9tSiemIO4TjjNB_fEZiq5dbakNeSjKdyjjCUoKsWTOsrDlkBSpvC7U_2VcrU_4eExXkf8qyY_HPYD-X6QRodMqBzvQJUOlC_UIihDbZd8MUW0WMsGBCKAzVScL4msemZphtI4vhWAwNj4l1ss5P9hCkAdhpWPJkzz8hIYvBt3HLfxPv9NL0S12C1TKVNEGmu_PZkPvrk4j1I0hXwVA=w688-h578-no "rdm6300_connections")
18+
19+
### Software
20+
A simple RFID to serial reciver example can be found at:
21+
[```examples/read_to_serial/read_to_serial.ino```](examples/read_to_serial/read_to_serial.ino)
22+
23+
#### API
24+
* ```void begin(int rxPin)``` - Initialize the object to use the given GPIO pin as RX from the RDM6300.
25+
* ```bool update()``` - Updates the internal values by reading from the RDM6300, returns true on tag detection, must be called repeatedly!
26+
* ```uint32_t get_tag_id()``` - Returns the last tag id read by ```update```- can be called only once after ```update```.
27+
* ```bool is_tag_near()``` - Returns whether a tag is currently held near the antenna- can be called many times after ```update```.
28+
## enjoy!
29+
A.E.TECH

0 commit comments

Comments
 (0)