├── .gitignore ├── .travis.yml ├── LICENSE ├── README.adoc ├── examples ├── BasicEthernet │ └── BasicEthernet.ino └── ESP8266 │ ├── BasicESP8266 │ └── BasicESP8266.ino │ ├── BasicESP8266Reply │ └── BasicESP8266Reply.ino │ └── TwtichSendReceive │ └── TwtichSendReceive.ino ├── keywords.txt ├── library.properties └── src ├── IRCClient.cpp ├── IRCClient.h └── IRCMessage.h /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode/arduino.json 2 | .vscode/c_cpp_properties.json 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: c 2 | before_install: 3 | - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16" 4 | - sleep 3 5 | - export DISPLAY=:1.0 6 | - wget http://downloads.arduino.cc/arduino-1.6.8-linux64.tar.xz 7 | - tar xf arduino-1.6.8-linux64.tar.xz 8 | - sudo mv arduino-1.6.8 $HOME/arduino_ide 9 | - ln -s $PWD $HOME/arduino_ide/libraries/ArduinoIRC 10 | - export PATH="$HOME/arduino_ide:$PATH" 11 | install: 12 | - ln -s $PWD $HOME/arduino_ide/libraries/ArduinoIRC 13 | script: 14 | - arduino --board arduino:avr:uno --verify $PWD/examples/BasicEthernet/BasicEthernet.ino 15 | 16 | notifications: 17 | email: 18 | on_success: change 19 | on_failure: change 20 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | (This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.) 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | {description} 474 | Copyright (C) {year} {fullname} 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | {signature of Ty Coon}, 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | = IRC Client Library for Arduino image:https://travis-ci.org/fredimachado/ArduinoIRC.svg?branch=master["Build Status", link="https://travis-ci.org/fredimachado/ArduinoIRC"] 2 | 3 | Connects your arduino project to an IRC server. 4 | 5 | == Features 6 | 7 | * Easy connection to an IRC server through a Client implementation; 8 | * Receive parsed IRC messages through a callback function; 9 | * Send raw messages to the server or messages to a channel or user; 10 | * Supports Twitch Chat 11 | 12 | == Usage 13 | 14 | See the examples... 15 | 16 | == Contribution 17 | 18 | Just send a pull request! :) 19 | 20 | == License 21 | 22 | Copyright (c) 2016 Fredi Machado. All right reserved. 23 | 24 | This library is free software; you can redistribute it and/or 25 | modify it under the terms of the GNU Lesser General Public 26 | License as published by the Free Software Foundation; either 27 | version 2.1 of the License, or (at your option) any later version. 28 | 29 | This library is distributed in the hope that it will be useful, 30 | but WITHOUT ANY WARRANTY; without even the implied warranty of 31 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 32 | Lesser General Public License for more details. 33 | 34 | You should have received a copy of the GNU Lesser General Public 35 | License along with this library; if not, write to the Free Software 36 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 37 | -------------------------------------------------------------------------------- /examples/BasicEthernet/BasicEthernet.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | #define IRC_SERVER "irc.rizon.net" 5 | #define IRC_PORT 6667 6 | #define IRC_NICKNAME "MCUIRCClient" 7 | #define IRC_USER "MCUIRCClient" 8 | 9 | // Enter a MAC address for your controller below. 10 | // Newer Ethernet shields have a MAC address printed on a sticker on the shield 11 | byte mac[] = { 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED }; 12 | 13 | // Set the static IP address to use if the DHCP fails to assign 14 | IPAddress ip(192, 168, 0, 177); 15 | 16 | EthernetClient ethernetClient; 17 | IRCClient client(IRC_SERVER, IRC_PORT, ethernetClient); 18 | 19 | void setup() { 20 | // Open serial communications and wait for port to open: 21 | Serial.begin(9600); 22 | while (!Serial) { 23 | ; // wait for serial port to connect. Needed for native USB port only 24 | } 25 | 26 | // start the Ethernet connection: 27 | if (Ethernet.begin(mac) == 0) { 28 | Serial.println("Failed to configure Ethernet using DHCP"); 29 | // try to congifure using IP address instead of DHCP: 30 | Ethernet.begin(mac, ip); 31 | } 32 | // give the Ethernet shield a second to initialize: 33 | delay(1000); 34 | 35 | client.setCallback(callback); 36 | client.setSentCallback(debugSentCallback); 37 | } 38 | 39 | void loop() { 40 | if (!client.connected()) { 41 | Serial.println("Attempting IRC connection..."); 42 | // Attempt to connect 43 | if (client.connect(IRC_NICKNAME, IRC_USER)) { 44 | Serial.println("connected"); 45 | } else { 46 | Serial.println("failed... try again in 5 seconds"); 47 | // Wait 5 seconds before retrying 48 | delay(5000); 49 | } 50 | return; 51 | } 52 | 53 | client.loop(); 54 | } 55 | 56 | void callback(IRCMessage ircMessage) { 57 | // PRIVMSG ignoring CTCP messages 58 | if (ircMessage.command == "PRIVMSG" && ircMessage.text[0] != '\001') { 59 | String message("<" + ircMessage.nick + "> " + ircMessage.text); 60 | Serial.println(message); 61 | return; 62 | } 63 | Serial.println(ircMessage.original); 64 | } 65 | 66 | void debugSentCallback(String data) { 67 | Serial.println(data); 68 | } -------------------------------------------------------------------------------- /examples/ESP8266/BasicESP8266/BasicESP8266.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | #define ssid "" 5 | #define password "" 6 | 7 | #define IRC_SERVER "irc.rizon.net" 8 | #define IRC_PORT 6667 9 | #define IRC_NICKNAME "MCUIRCClient" 10 | #define IRC_USER "MCUIRCClient" 11 | 12 | WiFiClient wiFiClient; 13 | IRCClient client(IRC_SERVER, IRC_PORT, wiFiClient); 14 | 15 | void setup() { 16 | Serial.begin(115200); 17 | 18 | delay(100); 19 | 20 | Serial.println(""); 21 | Serial.print("Connecting to "); 22 | Serial.println(ssid); 23 | WiFi.begin(ssid, password); 24 | 25 | while (WiFi.status() != WL_CONNECTED) { 26 | delay(500); 27 | Serial.print("."); 28 | } 29 | 30 | Serial.println(""); 31 | Serial.println("WiFi connected"); 32 | Serial.println("IP address: "); 33 | Serial.println(WiFi.localIP()); 34 | WiFi.printDiag(Serial); 35 | 36 | client.setCallback(callback); 37 | client.setSentCallback(debugSentCallback); 38 | } 39 | 40 | void loop() { 41 | if (!client.connected()) { 42 | Serial.println("Attempting IRC connection..."); 43 | // Attempt to connect 44 | if (client.connect(IRC_NICKNAME, IRC_USER)) { 45 | Serial.println("connected"); 46 | } else { 47 | Serial.println("failed... try again in 5 seconds"); 48 | // Wait 5 seconds before retrying 49 | delay(5000); 50 | } 51 | return; 52 | } 53 | 54 | client.loop(); 55 | } 56 | 57 | void callback(IRCMessage ircMessage) { 58 | // PRIVMSG ignoring CTCP messages 59 | if (ircMessage.command == "PRIVMSG" && ircMessage.text[0] != '\001') { 60 | String message("<" + ircMessage.nick + "> " + ircMessage.text); 61 | Serial.println(message); 62 | return; 63 | } 64 | Serial.println(ircMessage.original); 65 | } 66 | 67 | void debugSentCallback(String data) { 68 | Serial.println(data); 69 | } 70 | -------------------------------------------------------------------------------- /examples/ESP8266/BasicESP8266Reply/BasicESP8266Reply.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | #define ssid "" 5 | #define password "" 6 | 7 | #define IRC_SERVER "irc.rizon.net" 8 | #define IRC_PORT 6667 9 | #define IRC_NICKNAME "MCUIRCClient" 10 | #define IRC_USER "MCUIRCClient" 11 | 12 | #define REPLY_TO "NICK" // Reply only to this nick 13 | 14 | WiFiClient wiFiClient; 15 | IRCClient client(IRC_SERVER, IRC_PORT, wiFiClient); 16 | 17 | void setup() { 18 | Serial.begin(115200); 19 | 20 | delay(100); 21 | 22 | Serial.println(""); 23 | Serial.print("Connecting to "); 24 | Serial.println(ssid); 25 | WiFi.begin(ssid, password); 26 | 27 | while (WiFi.status() != WL_CONNECTED) { 28 | delay(500); 29 | Serial.print("."); 30 | } 31 | 32 | Serial.println(""); 33 | Serial.println("WiFi connected"); 34 | Serial.println("IP address: "); 35 | Serial.println(WiFi.localIP()); 36 | WiFi.printDiag(Serial); 37 | 38 | client.setCallback(callback); 39 | client.setSentCallback(debugSentCallback); 40 | } 41 | 42 | void loop() { 43 | if (!client.connected()) { 44 | Serial.println("Attempting IRC connection..."); 45 | // Attempt to connect 46 | if (client.connect(IRC_NICKNAME, IRC_USER)) { 47 | Serial.println("connected"); 48 | } else { 49 | Serial.println("failed... try again in 5 seconds"); 50 | // Wait 5 seconds before retrying 51 | delay(5000); 52 | } 53 | return; 54 | } 55 | 56 | client.loop(); 57 | } 58 | 59 | void callback(IRCMessage ircMessage) { 60 | // PRIVMSG ignoring CTCP messages 61 | if (ircMessage.command == "PRIVMSG" && ircMessage.text[0] != '\001') { 62 | String message("<" + ircMessage.nick + "> " + ircMessage.text); 63 | Serial.println(message); 64 | 65 | if (ircMessage.nick == REPLY_TO) { 66 | client.sendMessage(ircMessage.nick, "Hi " + ircMessage.nick + "! I'm your IRC bot."); 67 | } 68 | 69 | return; 70 | } 71 | Serial.println(ircMessage.original); 72 | } 73 | 74 | void debugSentCallback(String data) { 75 | Serial.println(data); 76 | } 77 | -------------------------------------------------------------------------------- /examples/ESP8266/TwtichSendReceive/TwtichSendReceive.ino: -------------------------------------------------------------------------------- 1 | /******************************************************************* 2 | Connect to Twtich Chat with a Bot 3 | 4 | Created with code from TheOtherLoneStar (https://www.twitch.tv/theotherlonestar) 5 | Hackaday IO: https://hackaday.io/otherlonestar 6 | 7 | By Brian Lough (https://www.twitch.tv/brianlough) 8 | YouTube: https://www.youtube.com/channel/UCezJOfu7OtqGzd5xrP3q6WA 9 | *******************************************************************/ 10 | 11 | #include //https://github.com/esp8266/Arduino 12 | #include 13 | 14 | //define your default values here, if there are different values in config.json, they are overwritten. 15 | 16 | #define IRC_SERVER "irc.chat.twitch.tv" 17 | #define IRC_PORT 6667 18 | 19 | //------- Replace the following! ------ 20 | char ssid[] = "ssid"; // your network SSID (name) 21 | char password[] = "password"; // your network key 22 | 23 | //The name of the channel that you want the bot to join 24 | const String twitchChannelName = "EXAMPLE_CHANNEL_NAME"; 25 | 26 | //The name that you want the bot to have 27 | #define TWITCH_BOT_NAME "exampleName" 28 | 29 | //OAuth Key for your twitch bot 30 | // https://twitchapps.com/tmi/ 31 | #define TWITCH_OAUTH_TOKEN "oauth:124678uhgfhfghgfjgfjfgjgfhhgfh" 32 | 33 | 34 | //------------------------------ 35 | 36 | 37 | int led = LED_BUILTIN; 38 | String ircChannel = ""; 39 | 40 | WiFiClient wiFiClient; 41 | IRCClient client(IRC_SERVER, IRC_PORT, wiFiClient); 42 | 43 | // put your setup code here, to run once: 44 | void setup() { 45 | 46 | pinMode(led, OUTPUT); 47 | 48 | Serial.begin(115200); 49 | Serial.println(); 50 | 51 | // Set WiFi to station mode and disconnect from an AP if it was Previously 52 | // connected 53 | WiFi.mode(WIFI_STA); 54 | WiFi.disconnect(); 55 | delay(100); 56 | 57 | // Attempt to connect to Wifi network: 58 | Serial.print("Connecting Wifi: "); 59 | Serial.println(ssid); 60 | WiFi.begin(ssid, password); 61 | while (WiFi.status() != WL_CONNECTED) { 62 | Serial.print("."); 63 | delay(500); 64 | } 65 | Serial.println(""); 66 | Serial.println("WiFi connected"); 67 | Serial.println("IP address: "); 68 | IPAddress ip = WiFi.localIP(); 69 | Serial.println(ip); 70 | 71 | ircChannel = "#" + twitchChannelName; 72 | 73 | client.setCallback(callback); 74 | } 75 | 76 | void loop() { 77 | 78 | // Try to connect to chat. If it loses connection try again 79 | if (!client.connected()) { 80 | Serial.println("Attempting to connect to " + ircChannel ); 81 | // Attempt to connect 82 | // Second param is not needed by Twtich 83 | if (client.connect(TWITCH_BOT_NAME, "", TWITCH_OAUTH_TOKEN)) { 84 | client.sendRaw("JOIN " + ircChannel); 85 | Serial.println("connected and ready to rock"); 86 | sendTwitchMessage("Ready to go Boss!"); 87 | } else { 88 | Serial.println("failed... try again in 5 seconds"); 89 | // Wait 5 seconds before retrying 90 | delay(5000); 91 | } 92 | return; 93 | } 94 | client.loop(); 95 | } 96 | 97 | void sendTwitchMessage(String message) { 98 | client.sendMessage(ircChannel, message); 99 | } 100 | 101 | 102 | void callback(IRCMessage ircMessage) { 103 | //Serial.println("In CallBack"); 104 | 105 | if (ircMessage.command == "PRIVMSG" && ircMessage.text[0] != '\001') { 106 | //Serial.println("Passed private message."); 107 | ircMessage.nick.toUpperCase(); 108 | 109 | String message("<" + ircMessage.nick + "> " + ircMessage.text); 110 | 111 | //prints chat to serial 112 | Serial.println(message); 113 | 114 | for (int i = 0; i < 6; i++) { 115 | digitalWrite(led, HIGH); 116 | delay(50); 117 | digitalWrite(led, LOW); 118 | delay(25); 119 | } 120 | 121 | 122 | 123 | return; 124 | } 125 | } 126 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Syntax Coloring Map ArduinoIRC 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | 9 | IRCClient KEYWORD1 10 | 11 | ####################################### 12 | # Methods and Functions (KEYWORD2) 13 | ####################################### 14 | setCallback KEYWORD2 15 | setSentCallback KEYWORD2 16 | connect KEYWORD2 17 | loop KEYWORD2 18 | connected KEYWORD2 19 | SendRaw KEYWORD2 20 | SendMessage KEYWORD2 21 | 22 | ####################################### 23 | # Constants (LITERAL1) 24 | ####################################### 25 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=ArduinoIRC 2 | version=0.2.0 3 | author=Fredi Machado 4 | maintainer=Fredi Machado 5 | sentence=Easy library to make an Arduino IRC Bot (Also supports Twitch chat). 6 | paragraph=This library allows your project to connect to an IRC server. 7 | category=Communication 8 | url=https://github.com/fredimachado/ArduinoIRC 9 | architectures=* 10 | -------------------------------------------------------------------------------- /src/IRCClient.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | IRCClient.cpp - Internet Relay Chat library v0.1.0 - 2016-4-9 3 | Copyright (C) 2016 Fredi Machado. All rights reserved. 4 | 5 | This library is free software; you can redistribute it and/or 6 | modify it under the terms of the GNU Lesser General Public 7 | License as published by the Free Software Foundation; either 8 | version 2.1 of the License, or (at your option) any later version. 9 | 10 | See file LICENSE.txt for further informations on licensing terms. 11 | */ 12 | 13 | #include "IRCClient.h" 14 | 15 | IRCClient::IRCClient(const char* host, uint16_t port, Client& client) { 16 | this->host = host; 17 | this->port = port; 18 | this->client = &client; 19 | this->isConnected = false; 20 | } 21 | 22 | IRCClient& IRCClient::setCallback(IRC_CALLBACK_SIGNATURE) { 23 | this->callback = callback; 24 | return *this; 25 | } 26 | 27 | IRCClient& IRCClient::setSentCallback(IRC_SENTCALLBACK_SIGNATURE) { 28 | this->debugSentCallback = debugSentCallback; 29 | return *this; 30 | } 31 | 32 | boolean IRCClient::connect(String nickname, String user, String password) { 33 | if (!connected()) { 34 | int result = client->connect(this->host, this->port); 35 | if (result == 1) { 36 | this->nickname = nickname; 37 | sendIRC("HELLO"); 38 | if(password != "") 39 | { 40 | sendIRC("PASS " + password); 41 | } 42 | sendIRC("NICK " + nickname); 43 | sendIRC("USER " + user + " 8 * :Arduino IRC Client"); 44 | this->isConnected = true; 45 | return true; 46 | } 47 | return false; 48 | } 49 | return true; 50 | } 51 | 52 | boolean IRCClient::loop() { 53 | if (connected() && client->available()) { 54 | String message = ""; 55 | while (client->available()) { 56 | char c = client->read(); 57 | if (c == '\r') { 58 | client->read(); // discard \n 59 | parse(message); 60 | message = ""; 61 | } else { 62 | message += c; 63 | } 64 | } 65 | return true; 66 | } 67 | return false; 68 | } 69 | 70 | void IRCClient::parse(String data) { 71 | IRCMessage ircMessage(data); 72 | 73 | if (data[0] == ':') { 74 | ircMessage.prefix = data.substring(1, data.indexOf(" ") - 1); 75 | int index = ircMessage.prefix.indexOf("@"); 76 | if (index != -1) { 77 | ircMessage.nick = ircMessage.prefix.substring(0, index); 78 | ircMessage.host = ircMessage.prefix.substring(index); 79 | } 80 | index = ircMessage.nick.indexOf("!"); 81 | if (index != -1) { 82 | String temp = ircMessage.nick; 83 | ircMessage.nick = temp.substring(0, index); 84 | ircMessage.user = temp.substring(index); 85 | } 86 | 87 | data = data.substring(data.indexOf(" ") + 1); 88 | } 89 | 90 | int index = data.indexOf(" "); 91 | ircMessage.command = data.substring(0, index); 92 | ircMessage.command.toUpperCase(); 93 | 94 | data = data.substring(index + 1); 95 | 96 | if (data != "") { 97 | if (data[0] == ':') { 98 | ircMessage.text = data.substring(1); 99 | } else { 100 | int pos1 = 0, pos2; 101 | while ((pos2 = data.indexOf(" ", pos1)) != -1) { 102 | pos1 = pos2 + 1; 103 | if (data[pos1] == ':') { 104 | ircMessage.parameters = data.substring(0, pos2); 105 | ircMessage.text = data.substring(pos1 + 1); 106 | break; 107 | } 108 | } 109 | if (ircMessage.text == "") { 110 | ircMessage.text = data; 111 | } 112 | } 113 | } 114 | 115 | if (ircMessage.command == "PING") { 116 | sendIRC("PONG " + data); 117 | return; 118 | } 119 | 120 | if (ircMessage.command == "PRIVMSG") { 121 | String to = ircMessage.parameters; 122 | String text = ircMessage.text; 123 | 124 | if (text[0] == '\001') { // CTCP 125 | text = text.substring(1, text.length() - 1); 126 | if (to == this->nickname) { 127 | if (text == "VERSION") { 128 | sendIRC("NOTICE " + ircMessage.nick + " :\001VERSION Open source Arduino IRC client by Fredi Machado - https://github.com/Fredi/ArduinoIRC \001"); 129 | return; 130 | } 131 | // CTCP not implemented 132 | sendIRC("NOTICE " + ircMessage.nick + " :\001ERRMSG " + text + " :Not implemented\001"); 133 | return; 134 | } 135 | } 136 | } 137 | 138 | executeCallback(ircMessage); 139 | } 140 | 141 | boolean IRCClient::connected() { 142 | if (client == NULL) { 143 | return false; 144 | } 145 | boolean rc = (int)client->connected(); 146 | if (!rc && this->isConnected) { 147 | this->isConnected = false; 148 | client->flush(); 149 | client->stop(); 150 | } 151 | return rc; 152 | } 153 | 154 | void IRCClient::sendIRC(String data) { 155 | client->print(data + "\r\n"); 156 | if (debugSentCallback) { 157 | debugSentCallback("SENT: " + data); 158 | } 159 | } 160 | 161 | void IRCClient::executeCallback(IRCMessage ircMessage) { 162 | if (callback) { 163 | callback(ircMessage); 164 | } 165 | } 166 | 167 | void IRCClient::sendRaw(String rawData) { 168 | sendIRC(rawData); 169 | } 170 | 171 | void IRCClient::sendMessage(String to, String message) { 172 | String rawData("PRIVMSG " + to + " :" + message); 173 | sendIRC(rawData); 174 | } 175 | -------------------------------------------------------------------------------- /src/IRCClient.h: -------------------------------------------------------------------------------- 1 | /* 2 | IRCClient.h - Internet Relay Chat library v0.1.0 - 2016-4-9 3 | Copyright (C) 2016 Fredi Machado. All rights reserved. 4 | 5 | This library is free software; you can redistribute it and/or 6 | modify it under the terms of the GNU Lesser General Public 7 | License as published by the Free Software Foundation; either 8 | version 2.1 of the License, or (at your option) any later version. 9 | 10 | See file LICENSE.txt for further informations on licensing terms. 11 | */ 12 | 13 | #ifndef IRCClient_h 14 | #define IRCClient_h 15 | 16 | #include "Arduino.h" 17 | #include "Client.h" 18 | #include "IRCMessage.h" 19 | 20 | #ifdef ESP8266 21 | #include 22 | #define IRC_CALLBACK_SIGNATURE std::function callback 23 | #define IRC_SENTCALLBACK_SIGNATURE std::function debugSentCallback 24 | #else 25 | #define IRC_CALLBACK_SIGNATURE void (*callback)(IRCMessage ircMessage) 26 | #define IRC_SENTCALLBACK_SIGNATURE void (*debugSentCallback)(String data) 27 | #endif 28 | 29 | class IRCClient 30 | { 31 | private: 32 | Client* client; 33 | IRC_CALLBACK_SIGNATURE; 34 | IRC_SENTCALLBACK_SIGNATURE; 35 | const char* host; 36 | uint16_t port; 37 | bool isConnected; 38 | String nickname; 39 | void sendIRC(String data); 40 | void parse(String data); 41 | void executeCallback(IRCMessage ircMessage); 42 | 43 | public: 44 | IRCClient(const char*, uint16_t, Client& client); 45 | IRCClient& setCallback(IRC_CALLBACK_SIGNATURE); 46 | IRCClient& setSentCallback(IRC_SENTCALLBACK_SIGNATURE); 47 | boolean connect(String nickname, String user, String password = ""); 48 | boolean loop(); 49 | boolean connected(); 50 | void sendRaw(String data); 51 | void sendMessage(String to, String message); 52 | }; 53 | 54 | #endif /* IRCClient_h */ 55 | -------------------------------------------------------------------------------- /src/IRCMessage.h: -------------------------------------------------------------------------------- 1 | /* 2 | IRCMessage.h - Internet Relay Chat library v0.1.0 - 2016-4-9 3 | Copyright (C) 2016 Fredi Machado. All rights reserved. 4 | 5 | This library is free software; you can redistribute it and/or 6 | modify it under the terms of the GNU Lesser General Public 7 | License as published by the Free Software Foundation; either 8 | version 2.1 of the License, or (at your option) any later version. 9 | 10 | See file LICENSE.txt for further informations on licensing terms. 11 | */ 12 | 13 | #ifndef IRCMessage_h 14 | #define IRCMessage_h 15 | 16 | struct IRCMessage { 17 | IRCMessage(String data) : 18 | original(data) {}; 19 | 20 | String original; 21 | String prefix; 22 | String nick; 23 | String user; 24 | String host; 25 | String command; 26 | String parameters; 27 | String text; 28 | }; 29 | 30 | #endif /* IRCMessage_h */ 31 | --------------------------------------------------------------------------------