├── .gitattributes ├── .gitignore ├── LICENSE.md ├── README.md ├── doc └── rdm6300_connections.png ├── examples ├── altsoftserial_based │ └── altsoftserial_based.ino ├── esp8266_hardware_uart │ └── esp8266_hardware_uart.ino ├── hardware_uart │ └── hardware_uart.ino ├── multiple_software_serials │ └── multiple_software_serials.ino └── read_to_serial │ └── read_to_serial.ino ├── keywords.txt ├── library.json ├── library.properties └── src ├── rdm6300.cpp └── rdm6300.h /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Compiled Object files 5 | *.slo 6 | *.lo 7 | *.o 8 | *.obj 9 | 10 | # Precompiled Headers 11 | *.gch 12 | *.pch 13 | 14 | # Compiled Dynamic libraries 15 | *.so 16 | *.dylib 17 | *.dll 18 | 19 | # Fortran module files 20 | *.mod 21 | *.smod 22 | 23 | # Compiled Static libraries 24 | *.lai 25 | *.la 26 | *.a 27 | *.lib 28 | 29 | # Executables 30 | *.exe 31 | *.out 32 | *.app 33 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 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 given GPIO pin or a `Stream`. 7 | * Can tell if the tag is still near the antenna. 8 | * Both hardware and software uart (serial) support on esp8266. 9 | * SAMD hardware uart (serial) support. 10 | * Both SoftwareSerial and [AltSoftSerial](https://github.com/PaulStoffregen/AltSoftSerial) support. 11 | 12 | ## Getting Started 13 | 14 | ### Hardware 15 | * RDM6300 module with matching antenna. 16 | * 125KHz RFID tags. 17 | * Microcontroller (arduino, esp8266, esp32...). 18 | 19 | ![rdm6300_connections](../master/doc/rdm6300_connections.png "rdm6300_connections") 20 | 21 | ### Software 22 | A simple RFID tag reader with textual serial output: 23 | [```examples/read_to_serial/read_to_serial.ino```](examples/read_to_serial/read_to_serial.ino) 24 | 25 | #### API 26 | * ```void begin(Stream *stream)``` - Initialize instance to read from a given stream. 27 | * ```void begin(int rx_pin, uint8_t uart_nr=1)``` - Initialize instance to read from a given pin. 28 | * ```void set_tag_timeout(uint32_t tag_timeout_ms)``` - sets the tag "valid" timeout, (300ms default) 29 | RDM6300 sends packet every 65ms when tag is near- better higher values for debouncing. 30 | * ```uint32_t get_tag_id()``` - Returns the tag_id as long as it is near, 0 otherwise. 31 | * ```uint32_t get_new_tag_id()``` - Returns the tag_id of a "new" near tag, 32 | following calls will return 0 as long as the same tag is kept near. 33 | * ~~```bool update()``` - Updates the internal values must be called repeatedly!~~ **deprecated!** 34 | * ~~```bool is_tag_near()``` - Returns whether a tag is held near.~~ **deprecated!** use ```get_tag_id()```. 35 | ## Enjoy! 36 | A.E.TECH 37 | -------------------------------------------------------------------------------- /doc/rdm6300_connections.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino12/rdm6300/a8ddb5fb153177d049141c1307f9e542f49bbaa3/doc/rdm6300_connections.png -------------------------------------------------------------------------------- /examples/altsoftserial_based/altsoftserial_based.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * A simple example to interface with rdm6300 rfid reader using AltSoftSerial. 3 | * We use AltSoftSerial uart instead of the default software uart driver. 4 | * 5 | * Connections: 6 | * | Board | RX Pin | PWM Unusable | Pin Unusable | 7 | * |------------------+--------+--------------+--------------| 8 | * | Teensy 3.0 & 3.1 | 20 | 22 | 21 | 9 | * | Teensy 2.0 | 10 | - | 9 | 10 | * | Teensy++ 2.0 | 4 | 26, 27 | 25 | 11 | * | Arduino Uno | 8 | 10 | 9 | 12 | * | Arduino Leonardo | 13 | - | 5 | 13 | * | Arduino Mega | 48 | 44, 45 | 46 | 14 | * | Wiring-S | 6 | 4 | 5 | 15 | * | Sanguino | 14 | 12 | 13 | 16 | * 17 | * Arad Eizen (https://github.com/arduino12). 18 | */ 19 | 20 | #include 21 | #include 22 | 23 | #define RDM6300_RX_PIN 8 24 | #define READ_LED_PIN 13 25 | 26 | Rdm6300 rdm6300; 27 | AltSoftSerial alt_soft_serial; 28 | 29 | void setup() 30 | { 31 | Serial.begin(115200); 32 | 33 | pinMode(READ_LED_PIN, OUTPUT); 34 | digitalWrite(READ_LED_PIN, LOW); 35 | 36 | alt_soft_serial.begin(RDM6300_BAUDRATE); 37 | rdm6300.begin(&alt_soft_serial); 38 | 39 | Serial.println("\nPlace RFID tag near the rdm6300..."); 40 | } 41 | 42 | void loop() 43 | { 44 | /* get_new_tag_id returns the tag_id of a "new" near tag, 45 | following calls will return 0 as long as the same tag is kept near. */ 46 | if (rdm6300.get_new_tag_id()) 47 | Serial.println(rdm6300.get_tag_id(), HEX); 48 | 49 | /* get_tag_id returns the tag_id as long as it is near, 0 otherwise. */ 50 | digitalWrite(READ_LED_PIN, rdm6300.get_tag_id()); 51 | 52 | delay(10); 53 | } 54 | -------------------------------------------------------------------------------- /examples/esp8266_hardware_uart/esp8266_hardware_uart.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * A simple example to interface with rdm6300 rfid reader using esp8266. 3 | * We use hardware uart "Serial" instead of the default software uart driver. 4 | * 5 | * Note: 6 | * The esp8266 let us use 1.5 uarts: 7 | * Serial=uart0=rx+tx, Serial1=uart1=tx only (rx pin is used as flash io). 8 | * Here we sawp the uart pins so uart0_rx goes to the rdm6300_tx, 9 | * and uart1_tx goes to what used to be uart0_tx- 10 | * so debug message goes from Serial1.print(...) to the pc debug terminal. 11 | * https://github.com/esp8266/Arduino/blob/master/doc/reference.rst#serial 12 | * 13 | * Connections: 14 | * | esp8266 | nodemcu | rdm6300 | notes | 15 | * |---------+---------+---------|-------------------------------------| 16 | * | GPIO-01 | TX | | This is TXD0, connect it to GPIO-02 | 17 | * | GPIO-02 | D4 | | This is TXD1, connect it to GPIO-01 | 18 | * | GPIO-03 | RX | | Leave it unconnected for flashing | 19 | * | GPIO-13 | D7 | TX | TX level is same 3.3V as esp8266 | 20 | * | | VU (5V) | VCC | The rdm6300 must be powered with 5V | 21 | * | GND | GND | GND | | 22 | * 23 | * * GPIO-01 to GPIO-02 is for debug terminal output. 24 | * 25 | * Arad Eizen (https://github.com/arduino12). 26 | */ 27 | 28 | #include 29 | 30 | #define RDM6300_RX_PIN 13 // can be only 13 - on esp8266 force hardware uart! 31 | #define READ_LED_PIN 16 32 | 33 | Rdm6300 rdm6300; 34 | 35 | void setup() 36 | { 37 | /* Serial1 is the debug! remember to bridge GPIO-01 to GPIO-02 */ 38 | Serial1.begin(115200); 39 | 40 | pinMode(READ_LED_PIN, OUTPUT); 41 | digitalWrite(READ_LED_PIN, LOW); 42 | 43 | rdm6300.begin(RDM6300_RX_PIN); 44 | 45 | Serial1.println("\nPlace RFID tag near the rdm6300..."); 46 | } 47 | 48 | void loop() 49 | { 50 | /* get_new_tag_id returns the tag_id of a "new" near tag, 51 | following calls will return 0 as long as the same tag is kept near. */ 52 | if (rdm6300.get_new_tag_id()) 53 | Serial1.println(rdm6300.get_tag_id(), HEX); 54 | 55 | /* get_tag_id returns the tag_id as long as it is near, 0 otherwise. */ 56 | digitalWrite(READ_LED_PIN, rdm6300.get_tag_id()); 57 | 58 | delay(10); 59 | } 60 | -------------------------------------------------------------------------------- /examples/hardware_uart/hardware_uart.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * A simple example to interface with rdm6300 rfid reader using 3 | * hardware uart "Serial" instead of the default software uart driver. 4 | * 5 | * Will only compile for boards with Serial1 or more: 6 | * https://www.arduino.cc/reference/en/language/functions/communication/serial/ 7 | * 8 | * Arad Eizen (https://github.com/arduino12). 9 | */ 10 | 11 | #include 12 | 13 | #define READ_LED_PIN 13 14 | 15 | Rdm6300 rdm6300; 16 | 17 | void setup() 18 | { 19 | Serial.begin(115200); 20 | 21 | pinMode(READ_LED_PIN, OUTPUT); 22 | digitalWrite(READ_LED_PIN, LOW); 23 | 24 | Serial1.begin(RDM6300_BAUDRATE); // read the doc above, find the RX pin number in the link 25 | rdm6300.begin(&Serial1); 26 | 27 | Serial.println("\nPlace RFID tag near the rdm6300..."); 28 | } 29 | 30 | void loop() 31 | { 32 | /* get_new_tag_id returns the tag_id of a "new" near tag, 33 | following calls will return 0 as long as the same tag is kept near. */ 34 | if (rdm6300.get_new_tag_id()) 35 | Serial.println(rdm6300.get_tag_id(), HEX); 36 | 37 | /* get_tag_id returns the tag_id as long as it is near, 0 otherwise. */ 38 | digitalWrite(READ_LED_PIN, rdm6300.get_tag_id()); 39 | 40 | delay(10); 41 | } 42 | -------------------------------------------------------------------------------- /examples/multiple_software_serials/multiple_software_serials.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * A simple example to interface with multiple software serials. 3 | * Use multiple software serials on some boards can only listen one UART at a time like Uno. 4 | * 5 | * Note: 6 | * You can use it for connect other software serials devices not only rdm6300. 7 | * In these case, we use two rdm6300 readers for example. 8 | * 9 | * The LED pin of rdm6300 is set at 5V (HIGH) at initial, 10 | * and if an RFID was read, the LED pin goes to 0V (LOW) for some moments. 11 | * We can use this property to switch between two devices, 12 | * but it still can only read from a device at a time. 13 | * 14 | * And be aware about usage of listening switch between devices. 15 | * 16 | * Connections: 17 | * | Uno | rdm6300-1 | rdm6300-2 | notes | 18 | * |-----+-----------+-----------+-------------------------------------| 19 | * | D5 | TX | | | 20 | * | D6 | LED | | | 21 | * | D7 | | TX | | 22 | * | D8 | | LED | | 23 | * | GND | GND | GND | | 24 | * | VCC | VCC | VCC | The rdm6300 must be powered with 5V | 25 | * 26 | * Zeng (https://github.com/asas1asas200) 27 | */ 28 | 29 | #include 30 | 31 | #define RDM6300_1_RX_PIN (5) 32 | #define RDM6300_1_LED_PIN (6) 33 | #define RDM6300_2_RX_PIN (7) 34 | #define RDM6300_2_LED_PIN (8) 35 | 36 | Rdm6300 rdm6300_1; 37 | Rdm6300 rdm6300_2; 38 | 39 | Rdm6300 *current_rdm6300; 40 | 41 | void setup() 42 | { 43 | Serial.begin(115200); 44 | pinMode(RDM6300_1_LED_PIN, INPUT); 45 | pinMode(RDM6300_2_LED_PIN, INPUT); 46 | 47 | rdm6300_1.begin(RDM6300_1_RX_PIN); 48 | rdm6300_2.begin(RDM6300_2_RX_PIN); 49 | 50 | rdm6300_1.listen(); 51 | current_rdm6300 = &rdm6300_1; 52 | 53 | Serial.println("Place RFID tag near any rdm6300..."); 54 | } 55 | 56 | void loop() 57 | { 58 | /* listen to a "talking" RDM6300 if needed */ 59 | if (!digitalRead(RDM6300_1_LED_PIN) && !rdm6300_1.is_listening()) { 60 | Serial.println("Switch to listening RDM6300_1"); 61 | rdm6300_1.listen(); 62 | current_rdm6300 = &rdm6300_1; 63 | } 64 | else if (!digitalRead(RDM6300_2_LED_PIN) && !rdm6300_2.is_listening()) { 65 | Serial.println("Switch to listening RDM6300_2"); 66 | rdm6300_2.listen(); 67 | current_rdm6300 = &rdm6300_2; 68 | } 69 | 70 | /* if you use rdm6300 with other devices, 71 | you had better set a TIMEOUT and run a while-loop to 72 | make sure the tag can be read correctely */ 73 | if (current_rdm6300->get_new_tag_id()) 74 | Serial.println(current_rdm6300->get_tag_id(), HEX); 75 | 76 | delay(10); 77 | } 78 | -------------------------------------------------------------------------------- /examples/read_to_serial/read_to_serial.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * A simple example to interface with rdm6300 rfid reader. 3 | * 4 | * Connect the rdm6300 to VCC=5V, GND=GND, TX=any GPIO (this case GPIO-04) 5 | * Note that the rdm6300's TX line is 3.3V level, 6 | * so it's safe to use with both AVR* and ESP* microcontrollers. 7 | * Note that on SAMD the RX_PIN is ignored, the default is Serial1 (pin0), 8 | * but if specify rdm6300.begin(RDM6300_RX_PIN, 2); then Serial2 (pin30) is used. 9 | * 10 | * This example uses SoftwareSerial, please read its limitations here: 11 | * https://www.arduino.cc/en/Reference/softwareSerial 12 | * 13 | * Arad Eizen (https://github.com/arduino12). 14 | */ 15 | 16 | #include 17 | #include 18 | 19 | #define RDM6300_RX_PIN 4 // read the SoftwareSerial doc above! may need to change this pin to 10... 20 | #define READ_LED_PIN 13 21 | 22 | Rdm6300 rdm6300; 23 | 24 | void setup() 25 | { 26 | Serial.begin(115200); 27 | 28 | pinMode(READ_LED_PIN, OUTPUT); 29 | digitalWrite(READ_LED_PIN, LOW); 30 | 31 | rdm6300.begin(RDM6300_RX_PIN); 32 | 33 | Serial.println("\nPlace RFID tag near the rdm6300..."); 34 | } 35 | 36 | void loop() 37 | { 38 | /* get_new_tag_id returns the tag_id of a "new" near tag, 39 | following calls will return 0 as long as the same tag is kept near. */ 40 | if (rdm6300.get_new_tag_id()) 41 | Serial.println(rdm6300.get_tag_id(), HEX); 42 | 43 | /* get_tag_id returns the tag_id as long as it is near, 0 otherwise. */ 44 | digitalWrite(READ_LED_PIN, rdm6300.get_tag_id()); 45 | 46 | delay(10); 47 | } 48 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Syntax Coloring Map Rdm6300 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | 9 | Rdm6300 KEYWORD1 10 | 11 | ####################################### 12 | # Methods and Functions (KEYWORD2) 13 | ####################################### 14 | begin KEYWORD2 15 | end KEYWORD2 16 | set_tag_timeout KEYWORD2 17 | get_tag_id KEYWORD2 18 | get_new_tag_id KEYWORD2 19 | listen KEYWORD2 20 | is_listening KEYWORD2 21 | 22 | ####################################### 23 | # Constants (LITERAL1) 24 | ####################################### 25 | RDM6300_BAUDRATE LITERAL1 26 | RDM6300_PACKET_SIZE LITERAL1 27 | RDM6300_PACKET_BEGIN LITERAL1 28 | RDM6300_PACKET_END LITERAL1 29 | RDM6300_DEFAULT_TAG_TIMEOUT_MS LITERAL1 30 | RDM6300_READ_TIMEOUT LITERAL1 31 | -------------------------------------------------------------------------------- /library.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rdm6300", 3 | "version": "2.0.0", 4 | "keywords": "rdm6300, rfid", 5 | "description": "A simple library to interface with rdm6300 rfid reader.", 6 | "repository": 7 | { 8 | "type": "git", 9 | "url": "https://github.com/arduino12/rdm6300.git" 10 | }, 11 | "authors": 12 | [ 13 | { 14 | "name": "Arad Eizen", 15 | "email": "https://github.com/arduino12", 16 | "url": "https://github.com/arduino12", 17 | "maintainer": true 18 | } 19 | ], 20 | "frameworks": "arduino", 21 | "platforms": "*" 22 | } 23 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=Rdm6300 2 | version=2.0.0 3 | author=Arad Eizen 4 | maintainer=Arad Eizen 5 | sentence=A simple library to interface with rdm6300 rfid reader. 6 | paragraph=A simple library to interface with rdm6300 rfid reader. 7 | category=Sensors 8 | url=https://github.com/arduino12/rdm6300 9 | architectures=* 10 | -------------------------------------------------------------------------------- /src/rdm6300.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * A simple library to interface with rdm6300 rfid reader. 3 | * Arad Eizen (https://github.com/arduino12). 4 | */ 5 | 6 | #include "rdm6300.h" 7 | 8 | void Rdm6300::begin(Stream *stream) 9 | { 10 | _stream = stream; 11 | if (!_stream) 12 | return; 13 | _stream->setTimeout(RDM6300_READ_TIMEOUT); 14 | } 15 | 16 | void Rdm6300::begin(int rx_pin, uint8_t uart_nr) 17 | { 18 | /* init serial port to rdm6300 baud, without TX, and 20ms read timeout */ 19 | end(); 20 | #if defined(ARDUINO_ARCH_ESP32) 21 | _stream = _hardware_serial = new HardwareSerial(uart_nr); 22 | _hardware_serial->begin(RDM6300_BAUDRATE, SERIAL_8N1, rx_pin, -1); 23 | #elif defined(ARDUINO_ARCH_ESP8266) 24 | if (rx_pin == 13) { 25 | _stream = _hardware_serial = &Serial; 26 | _hardware_serial->begin(RDM6300_BAUDRATE, SERIAL_8N1, SERIAL_RX_ONLY); 27 | if (uart_nr) 28 | _hardware_serial->swap(); 29 | } 30 | #elif defined(ARDUINO_ARCH_SAMD) 31 | _stream = _hardware_serial = (uart_nr == 2 ? &Serial2 : &Serial1); 32 | _hardware_serial->begin(RDM6300_BAUDRATE, SERIAL_8N1); 33 | #endif 34 | #ifdef RDM6300_SOFTWARE_SERIAL 35 | if (!_stream) { 36 | _stream = _software_serial = new SoftwareSerial(rx_pin, -1); 37 | _software_serial->begin(RDM6300_BAUDRATE); 38 | } 39 | #endif 40 | begin(_stream); 41 | } 42 | 43 | void Rdm6300::end() 44 | { 45 | _stream = NULL; 46 | #ifdef RDM6300_HARDWARE_SERIAL 47 | if (_hardware_serial) 48 | _hardware_serial->end(); 49 | #endif 50 | #ifdef RDM6300_SOFTWARE_SERIAL 51 | if (_software_serial) 52 | _software_serial->end(); 53 | #endif 54 | } 55 | 56 | uint32_t Rdm6300::_read_tag_id(void) 57 | { 58 | char buff[RDM6300_PACKET_SIZE]; 59 | uint8_t checksum; 60 | uint32_t tag_id; 61 | 62 | if (!_stream) 63 | return 0; 64 | 65 | if (!_stream->available()) 66 | return 0; 67 | 68 | /* if a packet doesn't begin with the right byte, remove that byte */ 69 | if (_stream->peek() != RDM6300_PACKET_BEGIN && _stream->read()) 70 | return 0; 71 | 72 | /* if read a packet with the wrong size, drop it */ 73 | if (RDM6300_PACKET_SIZE != _stream->readBytes(buff, RDM6300_PACKET_SIZE)) 74 | return 0; 75 | 76 | /* if a packet doesn't end with the right byte, drop it */ 77 | if (buff[13] != RDM6300_PACKET_END) 78 | return 0; 79 | 80 | /* add null and parse checksum */ 81 | buff[13] = 0; 82 | checksum = strtol(buff + 11, NULL, 16); 83 | /* add null and parse tag_id */ 84 | buff[11] = 0; 85 | tag_id = strtol(buff + 3, NULL, 16); 86 | /* add null and parse version (needs to be xored with checksum) */ 87 | buff[3] = 0; 88 | checksum ^= strtol(buff + 1, NULL, 16); 89 | 90 | /* xore the tag_id and validate checksum */ 91 | for (uint8_t i = 0; i < 32; i += 8) 92 | checksum ^= ((tag_id >> i) & 0xFF); 93 | if (checksum) 94 | return 0; 95 | 96 | return tag_id; 97 | } 98 | 99 | void Rdm6300::_update(void) 100 | { 101 | uint32_t cur_ms = millis(); 102 | uint32_t tag_id = _read_tag_id(); 103 | 104 | /* if a new tag appears- return it */ 105 | if (tag_id) { 106 | _tag_id = tag_id; 107 | if (_last_tag_id != tag_id) { 108 | _last_tag_id = tag_id; 109 | _new_tag_id = tag_id; 110 | } 111 | _last_tag_ms = cur_ms; 112 | return; 113 | } 114 | 115 | /* if the old tag id is still valid- leve it */ 116 | if (!_tag_id || (cur_ms - _last_tag_ms < _tag_timeout_ms)) 117 | return; 118 | 119 | _tag_id = _last_tag_id = _new_tag_id = 0; 120 | } 121 | 122 | /* 123 | * Sets the tag "valid" timeout, 124 | * RDM6300 sends packet every 65ms when tag is near- 125 | * so theoretically this timeout should be the same, 126 | * but it is better to debounce it by setting it higher, 127 | * like the RDM6300_DEFAULT_TAG_TIMEOUT_MS = 300. 128 | */ 129 | void Rdm6300::set_tag_timeout(uint32_t tag_timeout_ms) 130 | { 131 | _tag_timeout_ms = tag_timeout_ms; 132 | } 133 | 134 | /* 135 | * Returns the tag_id as long as it is near (and the tag timout is valid), 136 | * or 0 if no tag is near. 137 | */ 138 | uint32_t Rdm6300::get_tag_id(void) 139 | { 140 | _update(); 141 | return _tag_id; 142 | } 143 | 144 | /* 145 | * Returns the tag_id only once per "new" near tag, 146 | * or 0 if no tag is near. 147 | * Following calls will return 0 as long as the same tag is kept near. 148 | */ 149 | uint32_t Rdm6300::get_new_tag_id(void) 150 | { 151 | _update(); 152 | uint32_t tag_id = _new_tag_id; 153 | _new_tag_id = 0; 154 | return tag_id; 155 | } 156 | 157 | #ifdef RDM6300_SOFTWARE_SERIAL 158 | void Rdm6300::listen(void) 159 | { 160 | _software_serial->listen(); 161 | } 162 | 163 | bool Rdm6300::is_listening(void) 164 | { 165 | return _software_serial->isListening(); 166 | } 167 | #endif 168 | -------------------------------------------------------------------------------- /src/rdm6300.h: -------------------------------------------------------------------------------- 1 | /* 2 | * A simple library to interface with rdm6300 rfid reader. 3 | * 4 | * Arad Eizen (https://github.com/arduino12). 5 | */ 6 | 7 | #ifndef _RDM6300_h_ 8 | #define _RDM6300_h_ 9 | 10 | #include 11 | 12 | #if defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_SAMD) 13 | #define RDM6300_HARDWARE_SERIAL 14 | #endif 15 | 16 | #if !(defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_SAMD)) 17 | #define RDM6300_SOFTWARE_SERIAL 18 | #endif 19 | 20 | #ifdef RDM6300_HARDWARE_SERIAL 21 | #ifdef ARDUINO_ARCH_SAMD 22 | #include 23 | #define HardwareSerial_t Uart 24 | #else 25 | #include 26 | #define HardwareSerial_t HardwareSerial 27 | #endif 28 | #endif 29 | #ifdef RDM6300_SOFTWARE_SERIAL 30 | #include 31 | #endif 32 | 33 | #include 34 | 35 | #define RDM6300_BAUDRATE (9600) 36 | #define RDM6300_PACKET_SIZE (14) 37 | #define RDM6300_PACKET_BEGIN (0x02) 38 | #define RDM6300_PACKET_END (0x03) 39 | #define RDM6300_DEFAULT_TAG_TIMEOUT_MS (300) 40 | #define RDM6300_READ_TIMEOUT (20) 41 | 42 | class Rdm6300 43 | { 44 | public: 45 | void begin(Stream *stream); 46 | void begin(int rx_pin, uint8_t uart_nr=1); 47 | void end(void); 48 | void set_tag_timeout(uint32_t tag_timeout_ms); 49 | uint32_t get_tag_id(void); 50 | uint32_t get_new_tag_id(void); 51 | #ifdef RDM6300_SOFTWARE_SERIAL 52 | void listen(void); 53 | bool is_listening(void); 54 | #endif 55 | private: 56 | void _update(void); 57 | uint32_t _read_tag_id(void); 58 | #ifdef RDM6300_HARDWARE_SERIAL 59 | HardwareSerial_t *_hardware_serial = NULL; 60 | #endif 61 | #ifdef RDM6300_SOFTWARE_SERIAL 62 | SoftwareSerial *_software_serial = NULL; 63 | #endif 64 | Stream *_stream = NULL; 65 | uint32_t _tag_id = 0; 66 | uint32_t _new_tag_id = 0; 67 | uint32_t _last_tag_id = 0; 68 | uint32_t _last_tag_ms = 0; 69 | uint32_t _tag_timeout_ms = RDM6300_DEFAULT_TAG_TIMEOUT_MS; 70 | }; 71 | 72 | #endif 73 | --------------------------------------------------------------------------------