├── .gitignore ├── LICENSE ├── README.md ├── examples ├── GSM_MQTT_Arduino_Publish │ └── GSM_MQTT_Arduino_Publish.ino ├── GSM_MQTT_Arduino_Subscribe │ └── GSM_MQTT_Arduino_Subscribe.ino └── GSM_MQTT_Arduino_Subscribe_Publish │ └── GSM_MQTT_Arduino_Subscribe_Publish.ino ├── keywords.txt └── src ├── GSM_MQTT.cpp └── GSM_MQTT.h /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | *.obj 6 | 7 | # Precompiled Headers 8 | *.gch 9 | *.pch 10 | 11 | # Compiled Dynamic libraries 12 | *.so 13 | *.dylib 14 | *.dll 15 | 16 | # Fortran module files 17 | *.mod 18 | *.smod 19 | 20 | # Compiled Static libraries 21 | *.lai 22 | *.la 23 | *.a 24 | *.lib 25 | 26 | # Executables 27 | *.exe 28 | *.out 29 | *.app 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | # SIM800_MQTT 2 | 3 | #AutoConnect CallBack function 4 | * Use this function if you want to use autoconnect(and auto reconnect) facility 5 | * This function is called whenever TCP connection is established (or re-established). 6 | 7 | 8 | #connect function 9 | * This function can be used to connect your client to MQTT broker. 10 | * Use only if you do not use Auto connect functionality. 11 | * Optionally you can use username, password, WILL topic and WILL Message. 12 | 13 | 14 | #OnConnect CallBack function 15 | * This call back function is called when MQTT connection is established. 16 | * You can call subscription and publish functions inside it (according to your need). 17 | 18 | 19 | # Publish function 20 | * This function can be used to publish messages to different topics. 21 | * You can select QoS levels and RETAIN flag according to your need. 22 | 23 | 24 | # Subscribe function 25 | * This function can be used to subscribe messages from different topics. 26 | 27 | 28 | # OnMessage CallBack function 29 | * This callback function is called when messages are received from subscribed topics 30 | * Topic, TopicLength, Message, MessageLength are the arguments of OnMessage callback function. 31 | * Inside this, you can write your custom code. 32 | 33 | 34 | #unsubscribe function 35 | * This function can be used to unsubscribe from a previously subscribed topic. 36 | 37 | 38 | #disconnect function 39 | * This function can be used to disconnect your client from MQTT broker. 40 | 41 | 42 | #available function 43 | * return true when connection with mqtt brocker is existing 44 | 45 | 46 | # Other Features : 47 | * You can specify your KeepAlive duration while initializing. 48 | * Ping requests are sent and received automatically. 49 | * QoS 0,1,2 50 | 51 | ## Note: 52 | Use the examples as a template. 53 | 54 | ## To Do: 55 | * [ ] Move the functions Autoconnect, OnConnect and OnMessage to the source code 56 | * [ ] Implement a generic way to include external functions and their parameters to the funtions AutoConnect and OnConnect 57 | * [ ] Change the function OnMessage to be a callback 58 | -------------------------------------------------------------------------------- /examples/GSM_MQTT_Arduino_Publish/GSM_MQTT_Arduino_Publish.ino: -------------------------------------------------------------------------------- 1 | #include "GSM_MQTT.h" 2 | #include 3 | 4 | String MQTT_HOST = "test.mosquitto.org"; 5 | /* 6 | MQTT host address 7 | */ 8 | String MQTT_PORT = "1883"; 9 | /* 10 | MQTT port 11 | */ 12 | SoftwareSerial mySerial(10, 11); // RX, TX 13 | /* 14 | Software Serial through which mqtt events log is printed at 9600 baud rate 15 | */ 16 | void GSM_MQTT::AutoConnect(void) 17 | { 18 | /* 19 | Use this function if you want to use autoconnect(and auto reconnect) facility 20 | This function is called whenever TCP connection is established (or re-established). 21 | put your connect codes here. 22 | */ 23 | connect("qwertyuiop", 0, 0, "", "", 1, 0, 0, 0, "", ""); 24 | /* void connect(char *ClientIdentifier, char UserNameFlag, char PasswordFlag, char *UserName, char *Password, char CleanSession, char WillFlag, char WillQoS, char WillRetain, char *WillTopic, char *WillMessage); 25 | ClientIdentifier :Is a string that uniquely identifies the client to the server. 26 | :It must be unique across all clients connecting to a single server.(So it will be better for you to change that). 27 | :It's length must be greater than 0 and less than 24 28 | :Example "qwerty" 29 | UserNameFlag :Indicates whether UserName is present 30 | :Possible values (0,1) 31 | :Default value 0 (Disabled) 32 | PasswordFlag :Valid only when UserNameFlag is 1, otherwise its value is disregarded. 33 | :Indicates whether Password is present 34 | :Possible values (0,1) 35 | :Default value 0 (Disabled) 36 | UserName :Mandatory when UserNameFlag is 1, otherwise its value is disregarded. 37 | :The UserName corresponding to the user who is connecting, which can be used for authentication. 38 | Password :alid only when UserNameFlag and PasswordFlag are 1 , otherwise its value is disregarded. 39 | :The password corresponding to the user who is connecting, which can be used for authentication. 40 | CleanSession :If not set (0), then the server must store the subscriptions of the client after it disconnects. 41 | :If set (1), then the server must discard any previously maintained information about the client and treat the connection as "clean". 42 | :Possible values (0,1) 43 | :Default value 1 44 | WillFlag :This flag determines whether a WillMessage published on behalf of the client when client is disconnected involuntarily. 45 | :If the WillFlag is set, the WillQoS, WillRetain, WillTopic, WilMessage fields are valid. 46 | :Possible values (0,1) 47 | :Default value 0 (Disables will Message) 48 | WillQoS :Valid only when WillFlag is 1, otherwise its value is disregarded. 49 | :Determines the QoS level of WillMessage 50 | :Possible values (0,1,2) 51 | :Default value 0 (QoS 0) 52 | WillRetain :Valid only when WillFlag is 1, otherwise its value is disregarded. 53 | :Determines whether the server should retain the Will message. 54 | :Possible values (0,1) 55 | :Default value 0 56 | WillTopic :Mandatory when WillFlag is 1, otherwise its value is disregarded. 57 | :The Will Message will published to this topic (WillTopic) in case of involuntary client disconnection. 58 | WillMessage :Mandatory when WillFlag is 1, otherwise its value is disregarded. 59 | :This message (WillMessage) will published to WillTopic in case of involuntary client disconnection. 60 | */ 61 | 62 | } 63 | void GSM_MQTT::OnConnect(void) 64 | { 65 | /* 66 | This function is called when mqqt connection is established. 67 | put your subscription publish codes here. 68 | */ 69 | // subscribe(0, _generateMessageID(), "SampleTopic", 1); 70 | /* void subscribe(char DUP, unsigned int MessageID, char *SubTopic, char SubQoS); 71 | DUP :This flag is set when the client or server attempts to re-deliver a SUBSCRIBE message 72 | :This applies to messages where the value of QoS is greater than zero (0) 73 | :Possible values (0,1) 74 | :Default value 0 75 | Message ID:The Message Identifier (Message ID) field 76 | :Used only in messages where the QoS levels greater than 0 (SUBSCRIBE message is at QoS =1) 77 | SubTopic :Topic names to which subscription is needed 78 | SubQoS :QoS level at which the client wants to receive messages 79 | :Possible values (0,1,2) 80 | :Default value 0 81 | */ 82 | 83 | publish(0, 0, 0, _generateMessageID(), "SampleTopic", "Hello"); 84 | /* void publish(char DUP, char Qos, char RETAIN, unsigned int MessageID, char *Topic, char *Message); 85 | DUP :This flag is set when the client or server attempts to re-deliver a PUBLISH message 86 | :This applies to messages where the value of QoS is greater than zero (0) 87 | :Possible values (0,1) 88 | :Default value 0 89 | QoS :Quality of Service 90 | :This flag indicates the level of assurance for delivery of a PUBLISH message 91 | :Possible values (0,1,2) 92 | :Default value 0 93 | RETAIN :if the Retain flag is set (1), the server should hold on to the message after it has been delivered to the current subscribers. 94 | :When a new subscription is established on a topic, the last retained message on that topic is sent to the subscriber 95 | :Possible values (0,1) 96 | :Default value 0 97 | Message ID:The Message Identifier (Message ID) field 98 | :Used only in messages where the QoS levels greater than 0 99 | Topic :Publishing topic 100 | Message :Publishing Message 101 | */ 102 | } 103 | void GSM_MQTT::OnMessage(char *Topic, int TopicLength, char *Message, int MessageLength) 104 | { 105 | /* 106 | This function is called whenever a message received from subscribed topics 107 | put your subscription publish codes here. 108 | */ 109 | 110 | /* 111 | Topic :Name of the topic from which message is coming 112 | TopicLength :Number of characters in topic name 113 | Message :The containing array 114 | MessageLength:Number of characters in message 115 | */ 116 | mySerial.println(TopicLength); 117 | mySerial.println(Topic); 118 | mySerial.println(MessageLength); 119 | mySerial.println(Message); 120 | 121 | } 122 | GSM_MQTT MQTT(20); 123 | /* 124 | 20 is the keepalive duration in seconds 125 | */ 126 | 127 | void setup() 128 | { 129 | // initialize mqtt: 130 | // GSM modem should be connected to Harware Serial 131 | // index =0; 132 | MQTT.begin(); 133 | 134 | /* 135 | You can write your code here 136 | */ 137 | 138 | } 139 | void loop() 140 | { 141 | 142 | /* 143 | You can write your code here 144 | */ 145 | if (MQTT.available()) 146 | { 147 | /* 148 | if you want to do something when mqtt connection is live. 149 | You can write your code here 150 | */ 151 | } 152 | 153 | MQTT.processing(); 154 | } 155 | 156 | -------------------------------------------------------------------------------- /examples/GSM_MQTT_Arduino_Subscribe/GSM_MQTT_Arduino_Subscribe.ino: -------------------------------------------------------------------------------- 1 | #include "GSM_MQTT.h" 2 | #include 3 | String MQTT_HOST = "test.mosquitto.org"; 4 | /* 5 | MQTT host address 6 | */ 7 | String MQTT_PORT = "1883"; 8 | /* 9 | MQTT port 10 | */ 11 | SoftwareSerial mySerial(10, 11); // RX, TX 12 | /* 13 | Software Serial through which mqtt events log is printed at 9600 baud rate 14 | */ 15 | void GSM_MQTT::AutoConnect(void) 16 | { 17 | /* 18 | Use this function if you want to use autoconnect(and auto reconnect) facility 19 | This function is called whenever TCP connection is established (or re-established). 20 | put your connect codes here. 21 | */ 22 | connect("qwertyuiop", 0, 0, "", "", 1, 0, 0, 0, "", ""); 23 | /* void connect(char *ClientIdentifier, char UserNameFlag, char PasswordFlag, char *UserName, char *Password, char CleanSession, char WillFlag, char WillQoS, char WillRetain, char *WillTopic, char *WillMessage); 24 | ClientIdentifier :Is a string that uniquely identifies the client to the server. 25 | :It must be unique across all clients connecting to a single server.(So it will be better for you to change that). 26 | :It's length must be greater than 0 and less than 24 27 | :Example "qwerty" 28 | UserNameFlag :Indicates whether UserName is present 29 | :Possible values (0,1) 30 | :Default value 0 (Disabled) 31 | PasswordFlag :Valid only when UserNameFlag is 1, otherwise its value is disregarded. 32 | :Indicates whether Password is present 33 | :Possible values (0,1) 34 | :Default value 0 (Disabled) 35 | UserName :Mandatory when UserNameFlag is 1, otherwise its value is disregarded. 36 | :The UserName corresponding to the user who is connecting, which can be used for authentication. 37 | Password :alid only when UserNameFlag and PasswordFlag are 1 , otherwise its value is disregarded. 38 | :The password corresponding to the user who is connecting, which can be used for authentication. 39 | CleanSession :If not set (0), then the server must store the subscriptions of the client after it disconnects. 40 | :If set (1), then the server must discard any previously maintained information about the client and treat the connection as "clean". 41 | :Possible values (0,1) 42 | :Default value 1 43 | WillFlag :This flag determines whether a WillMessage published on behalf of the client when client is disconnected involuntarily. 44 | :If the WillFlag is set, the WillQoS, WillRetain, WillTopic, WilMessage fields are valid. 45 | :Possible values (0,1) 46 | :Default value 0 (Disables will Message) 47 | WillQoS :Valid only when WillFlag is 1, otherwise its value is disregarded. 48 | :Determines the QoS level of WillMessage 49 | :Possible values (0,1,2) 50 | :Default value 0 (QoS 0) 51 | WillRetain :Valid only when WillFlag is 1, otherwise its value is disregarded. 52 | :Determines whether the server should retain the Will message. 53 | :Possible values (0,1) 54 | :Default value 0 55 | WillTopic :Mandatory when WillFlag is 1, otherwise its value is disregarded. 56 | :The Will Message will published to this topic (WillTopic) in case of involuntary client disconnection. 57 | WillMessage :Mandatory when WillFlag is 1, otherwise its value is disregarded. 58 | :This message (WillMessage) will published to WillTopic in case of involuntary client disconnection. 59 | */ 60 | 61 | } 62 | void GSM_MQTT::OnConnect(void) 63 | { 64 | /* 65 | This function is called when mqqt connection is established. 66 | put your subscription publish codes here. 67 | */ 68 | subscribe(0, _generateMessageID(), "SampleTopic", 1); 69 | /* void subscribe(char DUP, unsigned int MessageID, char *SubTopic, char SubQoS); 70 | DUP :This flag is set when the client or server attempts to re-deliver a SUBSCRIBE message 71 | :This applies to messages where the value of QoS is greater than zero (0) 72 | :Possible values (0,1) 73 | :Default value 0 74 | Message ID:The Message Identifier (Message ID) field 75 | :Used only in messages where the QoS levels greater than 0 (SUBSCRIBE message is at QoS =1) 76 | SubTopic :Topic names to which subscription is needed 77 | SubQoS :QoS level at which the client wants to receive messages 78 | :Possible values (0,1,2) 79 | :Default value 0 80 | */ 81 | 82 | // publish(0, 0, 0, _generateMessageID(), "SampleTopic", "Hello"); 83 | /* void publish(char DUP, char Qos, char RETAIN, unsigned int MessageID, char *Topic, char *Message); 84 | DUP :This flag is set when the client or server attempts to re-deliver a PUBLISH message 85 | :This applies to messages where the value of QoS is greater than zero (0) 86 | :Possible values (0,1) 87 | :Default value 0 88 | QoS :Quality of Service 89 | :This flag indicates the level of assurance for delivery of a PUBLISH message 90 | :Possible values (0,1,2) 91 | :Default value 0 92 | RETAIN :if the Retain flag is set (1), the server should hold on to the message after it has been delivered to the current subscribers. 93 | :When a new subscription is established on a topic, the last retained message on that topic is sent to the subscriber 94 | :Possible values (0,1) 95 | :Default value 0 96 | Message ID:The Message Identifier (Message ID) field 97 | :Used only in messages where the QoS levels greater than 0 98 | Topic :Publishing topic 99 | Message :Publishing Message 100 | */ 101 | } 102 | void GSM_MQTT::OnMessage(char *Topic, int TopicLength, char *Message, int MessageLength) 103 | { 104 | /* 105 | This function is called whenever a message received from subscribed topics 106 | put your subscription publish codes here. 107 | */ 108 | 109 | /* 110 | Topic :Name of the topic from which message is coming 111 | TopicLength :Number of characters in topic name 112 | Message :The containing array 113 | MessageLength:Number of characters in message 114 | */ 115 | mySerial.println(TopicLength); 116 | mySerial.println(Topic); 117 | mySerial.println(MessageLength); 118 | mySerial.println(Message); 119 | 120 | } 121 | GSM_MQTT MQTT(20); 122 | /* 123 | 20 is the keepalive duration in seconds 124 | */ 125 | 126 | void setup() 127 | { 128 | // initialize mqtt: 129 | // GSM modem should be connected to Harware Serial 130 | // index =0; 131 | MQTT.begin(); 132 | 133 | /* 134 | You can write your code here 135 | */ 136 | 137 | } 138 | void loop() 139 | { 140 | 141 | /* 142 | You can write your code here 143 | */ 144 | if (MQTT.available()) 145 | { 146 | /* 147 | if you want to do something when mqtt connection is live. 148 | You can write your code here 149 | */ 150 | } 151 | 152 | MQTT.processing(); 153 | } 154 | 155 | -------------------------------------------------------------------------------- /examples/GSM_MQTT_Arduino_Subscribe_Publish/GSM_MQTT_Arduino_Subscribe_Publish.ino: -------------------------------------------------------------------------------- 1 | #include "GSM_MQTT.h" 2 | #include 3 | String MQTT_HOST = "test.mosquitto.org"; 4 | /* 5 | MQTT host address 6 | */ 7 | String MQTT_PORT = "1883"; 8 | /* 9 | MQTT port 10 | */ 11 | SoftwareSerial mySerial(10, 11); // RX, TX 12 | /* 13 | Software Serial through which mqtt events log is printed at 9600 baud rate 14 | */ 15 | void GSM_MQTT::AutoConnect(void) 16 | { 17 | /* 18 | Use this function if you want to use autoconnect(and auto reconnect) facility 19 | This function is called whenever TCP connection is established (or re-established). 20 | put your connect codes here. 21 | */ 22 | connect("qwertyuiop", 0, 0, "", "", 1, 0, 0, 0, "", ""); 23 | /* void connect(char *ClientIdentifier, char UserNameFlag, char PasswordFlag, char *UserName, char *Password, char CleanSession, char WillFlag, char WillQoS, char WillRetain, char *WillTopic, char *WillMessage); 24 | ClientIdentifier :Is a string that uniquely identifies the client to the server. 25 | :It must be unique across all clients connecting to a single server.(So it will be better for you to change that). 26 | :It's length must be greater than 0 and less than 24 27 | :Example "qwerty" 28 | UserNameFlag :Indicates whether UserName is present 29 | :Possible values (0,1) 30 | :Default value 0 (Disabled) 31 | PasswordFlag :Valid only when UserNameFlag is 1, otherwise its value is disregarded. 32 | :Indicates whether Password is present 33 | :Possible values (0,1) 34 | :Default value 0 (Disabled) 35 | UserName :Mandatory when UserNameFlag is 1, otherwise its value is disregarded. 36 | :The UserName corresponding to the user who is connecting, which can be used for authentication. 37 | Password :alid only when UserNameFlag and PasswordFlag are 1 , otherwise its value is disregarded. 38 | :The password corresponding to the user who is connecting, which can be used for authentication. 39 | CleanSession :If not set (0), then the server must store the subscriptions of the client after it disconnects. 40 | :If set (1), then the server must discard any previously maintained information about the client and treat the connection as "clean". 41 | :Possible values (0,1) 42 | :Default value 1 43 | WillFlag :This flag determines whether a WillMessage published on behalf of the client when client is disconnected involuntarily. 44 | :If the WillFlag is set, the WillQoS, WillRetain, WillTopic, WilMessage fields are valid. 45 | :Possible values (0,1) 46 | :Default value 0 (Disables will Message) 47 | WillQoS :Valid only when WillFlag is 1, otherwise its value is disregarded. 48 | :Determines the QoS level of WillMessage 49 | :Possible values (0,1,2) 50 | :Default value 0 (QoS 0) 51 | WillRetain :Valid only when WillFlag is 1, otherwise its value is disregarded. 52 | :Determines whether the server should retain the Will message. 53 | :Possible values (0,1) 54 | :Default value 0 55 | WillTopic :Mandatory when WillFlag is 1, otherwise its value is disregarded. 56 | :The Will Message will published to this topic (WillTopic) in case of involuntary client disconnection. 57 | WillMessage :Mandatory when WillFlag is 1, otherwise its value is disregarded. 58 | :This message (WillMessage) will published to WillTopic in case of involuntary client disconnection. 59 | */ 60 | 61 | } 62 | void GSM_MQTT::OnConnect(void) 63 | { 64 | /* 65 | This function is called when mqqt connection is established. 66 | put your subscription publish codes here. 67 | */ 68 | subscribe(0, _generateMessageID(), "SampleTopic", 1); 69 | /* void subscribe(char DUP, unsigned int MessageID, char *SubTopic, char SubQoS); 70 | DUP :This flag is set when the client or server attempts to re-deliver a SUBSCRIBE message 71 | :This applies to messages where the value of QoS is greater than zero (0) 72 | :Possible values (0,1) 73 | :Default value 0 74 | Message ID:The Message Identifier (Message ID) field 75 | :Used only in messages where the QoS levels greater than 0 (SUBSCRIBE message is at QoS =1) 76 | SubTopic :Topic names to which subscription is needed 77 | SubQoS :QoS level at which the client wants to receive messages 78 | :Possible values (0,1,2) 79 | :Default value 0 80 | */ 81 | 82 | publish(0, 0, 0, _generateMessageID(), "SampleTopic", "Hello"); 83 | /* void publish(char DUP, char Qos, char RETAIN, unsigned int MessageID, char *Topic, char *Message); 84 | DUP :This flag is set when the client or server attempts to re-deliver a PUBLISH message 85 | :This applies to messages where the value of QoS is greater than zero (0) 86 | :Possible values (0,1) 87 | :Default value 0 88 | QoS :Quality of Service 89 | :This flag indicates the level of assurance for delivery of a PUBLISH message 90 | :Possible values (0,1,2) 91 | :Default value 0 92 | RETAIN :if the Retain flag is set (1), the server should hold on to the message after it has been delivered to the current subscribers. 93 | :When a new subscription is established on a topic, the last retained message on that topic is sent to the subscriber 94 | :Possible values (0,1) 95 | :Default value 0 96 | Message ID:The Message Identifier (Message ID) field 97 | :Used only in messages where the QoS levels greater than 0 98 | Topic :Publishing topic 99 | Message :Publishing Message 100 | */ 101 | } 102 | void GSM_MQTT::OnMessage(char *Topic, int TopicLength, char *Message, int MessageLength) 103 | { 104 | /* 105 | This function is called whenever a message received from subscribed topics 106 | put your subscription publish codes here. 107 | */ 108 | 109 | /* 110 | Topic :Name of the topic from which message is coming 111 | TopicLength :Number of characters in topic name 112 | Message :The containing array 113 | MessageLength:Number of characters in message 114 | */ 115 | mySerial.println(TopicLength); 116 | mySerial.println(Topic); 117 | mySerial.println(MessageLength); 118 | mySerial.println(Message); 119 | 120 | } 121 | GSM_MQTT MQTT(20); 122 | /* 123 | 20 is the keepalive duration in seconds 124 | */ 125 | 126 | void setup() 127 | { 128 | // initialize mqtt: 129 | // GSM modem should be connected to Harware Serial 130 | // index =0; 131 | MQTT.begin(); 132 | 133 | /* 134 | You can write your code here 135 | */ 136 | 137 | } 138 | void loop() 139 | { 140 | 141 | /* 142 | You can write your code here 143 | */ 144 | if (MQTT.available()) 145 | { 146 | /* 147 | if you want to do something when mqtt connection is live. 148 | You can write your code here 149 | */ 150 | } 151 | 152 | MQTT.processing(); 153 | } 154 | 155 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | # Syntax Coloring Map For SIM800_MQTT 2 | 3 | GSM_MQTT KEYWORD1 4 | 5 | begin KEYWORD2 6 | connect KEYWORD2 7 | publish KEYWORD2 8 | subscribe KEYWORD2 9 | unsubscribe KEYWORD2 10 | disconnect KEYWORD2 11 | processing KEYWORD2 12 | available KEYWORD2 13 | AutoConnect KEYWORD2 14 | OnConnect KEYWORD2 15 | OnMessage KEYWORD2 16 | publishACK KEYWORD2 17 | publishREC KEYWORD2 18 | publishREL KEYWORD2 19 | publishCOMP KEYWORD2 20 | printMessageType KEYWORD2 21 | printConnectAck KEYWORD2 22 | sendATreply KEYWORD2 23 | 24 | TCP_Flag KEYWORD3 25 | GSM_ReplyFlag KEYWORD3 26 | reply KEYWORD3 27 | pingFlag KEYWORD3 28 | tcpATerrorcount KEYWORD3 29 | pingSent KEYWORD3 30 | MQTT_Flag KEYWORD3 31 | ConnectionAcknowledgement KEYWORD3 32 | PublishIndex KEYWORD3 33 | Topic KEYWORD3 34 | TopicLength KEYWORD3 35 | Message KEYWORD3 36 | MessageLength KEYWORD3 37 | MessageFlag KEYWORD3 38 | modemStatus KEYWORD3 39 | index KEYWORD3 40 | length KEYWORD3 41 | inputString KEYWORD3 -------------------------------------------------------------------------------- /src/GSM_MQTT.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | MQTT.h - Library for GSM MQTT Client. 3 | Created by Nithin K. Kurian, Dhanish Vijayan, Elementz Engineers Guild Pvt. Ltd, July 2, 2016. 4 | Released into the public domain. 5 | */ 6 | 7 | #include "GSM_MQTT.h" 8 | #include "Arduino.h" 9 | #include 10 | #include 11 | extern uint8_t GSM_Response; 12 | 13 | extern SoftwareSerial mySerial; 14 | extern String MQTT_HOST; 15 | extern String MQTT_PORT; 16 | 17 | extern GSM_MQTT MQTT; 18 | uint8_t GSM_Response = 0; 19 | unsigned long previousMillis = 0; 20 | //char inputString[UART_BUFFER_LENGTH]; // a string to hold incoming data 21 | boolean stringComplete = false; // whether the string is complete 22 | void serialEvent(); 23 | GSM_MQTT::GSM_MQTT(unsigned long KeepAlive) 24 | { 25 | _KeepAliveTimeOut = KeepAlive; 26 | } 27 | 28 | void GSM_MQTT::begin(void) 29 | { 30 | mySerial.begin(9600); 31 | Serial.begin(9600); 32 | Serial.write("AT\r\n"); 33 | delay(1000); 34 | _tcpInit(); 35 | } 36 | char GSM_MQTT::_sendAT(char *command, unsigned long waitms) 37 | { 38 | 39 | unsigned long PrevMillis = millis(); 40 | strcpy(reply, "none"); 41 | GSM_Response = 0; 42 | Serial.write(command); 43 | unsigned long currentMillis = millis(); 44 | // mySerial.println(PrevMillis); 45 | // mySerial.println(currentMillis); 46 | while ( (GSM_Response == 0) && ((currentMillis - PrevMillis) < waitms) ) 47 | { 48 | // delay(1); 49 | serialEvent(); 50 | currentMillis = millis(); 51 | } 52 | return GSM_Response; 53 | } 54 | char GSM_MQTT::sendATreply(char *command, char *replystr, unsigned long waitms) 55 | { 56 | strcpy(reply, replystr); 57 | unsigned long PrevMillis = millis(); 58 | GSM_ReplyFlag = 0; 59 | Serial.write(command); 60 | unsigned long currentMillis = millis(); 61 | 62 | // mySerial.println(PrevMillis); 63 | // mySerial.println(currentMillis); 64 | while ( (GSM_ReplyFlag == 0) && ((currentMillis - PrevMillis) < waitms) ) 65 | { 66 | // delay(1); 67 | serialEvent(); 68 | currentMillis = millis(); 69 | } 70 | return GSM_ReplyFlag; 71 | } 72 | void GSM_MQTT::_tcpInit(void) 73 | { 74 | switch (modemStatus) 75 | { 76 | case 0: 77 | { 78 | delay(1000); 79 | Serial.print("+++"); 80 | delay(500); 81 | if (_sendAT("AT\r\n", 5000) == 1) 82 | { 83 | modemStatus = 1; 84 | } 85 | else 86 | { 87 | modemStatus = 0; 88 | break; 89 | } 90 | } 91 | case 1: 92 | { 93 | if (_sendAT("ATE1\r\n", 2000) == 1) 94 | { 95 | modemStatus = 2; 96 | } 97 | else 98 | { 99 | modemStatus = 1; 100 | break; 101 | } 102 | } 103 | case 2: 104 | { 105 | if (sendATreply("AT+CREG?\r\n", "0,1", 5000) == 1) 106 | { 107 | _sendAT("AT+CIPMUX=0\r\n", 2000); 108 | _sendAT("AT+CIPMODE=1\r\n", 2000); 109 | if (sendATreply("AT+CGATT?\r\n", ": 1", 4000) != 1) 110 | { 111 | _sendAT("AT+CGATT=1\r\n", 2000); 112 | } 113 | modemStatus = 3; 114 | _tcpStatus = 2; 115 | } 116 | else 117 | { 118 | modemStatus = 2; 119 | break; 120 | } 121 | } 122 | case 3: 123 | { 124 | if (GSM_ReplyFlag != 7) 125 | { 126 | _tcpStatus = sendATreply("AT+CIPSTATUS\r\n", "STATE", 4000); 127 | if (_tcpStatusPrev == _tcpStatus) 128 | { 129 | tcpATerrorcount++; 130 | if (tcpATerrorcount >= 10) 131 | { 132 | tcpATerrorcount = 0; 133 | _tcpStatus = 7; 134 | } 135 | 136 | } 137 | else 138 | { 139 | _tcpStatusPrev = _tcpStatus; 140 | tcpATerrorcount = 0; 141 | } 142 | } 143 | _tcpStatusPrev = _tcpStatus; 144 | mySerial.print(_tcpStatus); 145 | switch (_tcpStatus) 146 | { 147 | case 2: 148 | { 149 | _sendAT("AT+CSTT=\"AIRTELGPRS.COM\"\r\n", 5000); 150 | break; 151 | } 152 | case 3: 153 | { 154 | _sendAT("AT+CIICR\r\n", 5000) ; 155 | break; 156 | } 157 | case 4: 158 | { 159 | sendATreply("AT+CIFSR\r\n", ".", 4000) ; 160 | break; 161 | } 162 | case 5: 163 | { 164 | Serial.print("AT+CIPSTART=\"TCP\",\""); 165 | Serial.print(MQTT_HOST); 166 | Serial.print("\",\""); 167 | Serial.print(MQTT_PORT); 168 | if (_sendAT("\"\r\n", 5000) == 1) 169 | { 170 | unsigned long PrevMillis = millis(); 171 | unsigned long currentMillis = millis(); 172 | while ( (GSM_Response != 4) && ((currentMillis - PrevMillis) < 20000) ) 173 | { 174 | // delay(1); 175 | serialEvent(); 176 | currentMillis = millis(); 177 | } 178 | } 179 | break; 180 | } 181 | case 6: 182 | { 183 | unsigned long PrevMillis = millis(); 184 | unsigned long currentMillis = millis(); 185 | while ( (GSM_Response != 4) && ((currentMillis - PrevMillis) < 20000) ) 186 | { 187 | // delay(1); 188 | serialEvent(); 189 | currentMillis = millis(); 190 | } 191 | break; 192 | } 193 | case 7: 194 | { 195 | sendATreply("AT+CIPSHUT\r\n", "OK", 4000) ; 196 | modemStatus = 0; 197 | _tcpStatus = 2; 198 | break; 199 | } 200 | } 201 | } 202 | } 203 | 204 | } 205 | 206 | void GSM_MQTT::_ping(void) 207 | { 208 | 209 | if (pingFlag == true) 210 | { 211 | unsigned long currentMillis = millis(); 212 | if ((currentMillis - _PingPrevMillis ) >= _KeepAliveTimeOut * 1000) 213 | { 214 | // save the last time you blinked the LED 215 | _PingPrevMillis = currentMillis; 216 | if(pingSent){ 217 | mySerial.println("Ping failed"); 218 | disconnect(); 219 | MQTT.TCP_Flag = false; 220 | MQTT.MQTT_Flag = false; 221 | MQTT.pingFlag = false; 222 | MQTT.sendATreply("AT+CIPSHUT\r\n", ".", 4000); 223 | MQTT.modemStatus = 0; 224 | pingSent = false; 225 | return; 226 | } 227 | Serial.print(char(PINGREQ * 16)); 228 | _sendLength(0); 229 | pingSent = true; 230 | mySerial.println("pingSent = true"); 231 | } 232 | } 233 | } 234 | void GSM_MQTT::_sendUTFString(char *string) 235 | { 236 | int localLength = strlen(string); 237 | Serial.print(char(localLength / 256)); 238 | Serial.print(char(localLength % 256)); 239 | Serial.print(string); 240 | } 241 | void GSM_MQTT::_sendLength(int len) 242 | { 243 | bool length_flag = false; 244 | while (length_flag == false) 245 | { 246 | if ((len / 128) > 0) 247 | { 248 | Serial.print(char(len % 128 + 128)); 249 | len /= 128; 250 | } 251 | else 252 | { 253 | length_flag = true; 254 | Serial.print(char(len)); 255 | } 256 | } 257 | } 258 | void GSM_MQTT::connect(char *ClientIdentifier, char UserNameFlag, char PasswordFlag, char *UserName, char *Password, char CleanSession, char WillFlag, char WillQoS, char WillRetain, char *WillTopic, char *WillMessage) 259 | { 260 | ConnectionAcknowledgement = NO_ACKNOWLEDGEMENT ; 261 | Serial.print(char(CONNECT * 16 )); 262 | char ProtocolName[7] = "MQIsdp"; 263 | int localLength = (2 + strlen(ProtocolName)) + 1 + 3 + (2 + strlen(ClientIdentifier)); 264 | if (WillFlag != 0) 265 | { 266 | localLength = localLength + 2 + strlen(WillTopic) + 2 + strlen(WillMessage); 267 | } 268 | if (UserNameFlag != 0) 269 | { 270 | localLength = localLength + 2 + strlen(UserName); 271 | 272 | if (PasswordFlag != 0) 273 | { 274 | localLength = localLength + 2 + strlen(Password); 275 | } 276 | } 277 | _sendLength(localLength); 278 | _sendUTFString(ProtocolName); 279 | Serial.print(char(_ProtocolVersion)); 280 | Serial.print(char(UserNameFlag * User_Name_Flag_Mask + PasswordFlag * Password_Flag_Mask + WillRetain * Will_Retain_Mask + WillQoS * Will_QoS_Scale + WillFlag * Will_Flag_Mask + CleanSession * Clean_Session_Mask)); 281 | Serial.print(char(_KeepAliveTimeOut / 256)); 282 | Serial.print(char(_KeepAliveTimeOut % 256)); 283 | _sendUTFString(ClientIdentifier); 284 | if (WillFlag != 0) 285 | { 286 | _sendUTFString(WillTopic); 287 | _sendUTFString(WillMessage); 288 | } 289 | if (UserNameFlag != 0) 290 | { 291 | _sendUTFString(UserName); 292 | if (PasswordFlag != 0) 293 | { 294 | _sendUTFString(Password); 295 | } 296 | } 297 | } 298 | void GSM_MQTT::publish(char DUP, char Qos, char RETAIN, unsigned int MessageID, char *Topic, char *Message) 299 | { 300 | Serial.print(char(PUBLISH * 16 + DUP * DUP_Mask + Qos * QoS_Scale + RETAIN)); 301 | int localLength = (2 + strlen(Topic)); 302 | if (Qos > 0) 303 | { 304 | localLength += 2; 305 | } 306 | localLength += strlen(Message); 307 | _sendLength(localLength); 308 | _sendUTFString(Topic); 309 | if (Qos > 0) 310 | { 311 | Serial.print(char(MessageID / 256)); 312 | Serial.print(char(MessageID % 256)); 313 | } 314 | Serial.print(Message); 315 | } 316 | void GSM_MQTT::publishACK(unsigned int MessageID) 317 | { 318 | Serial.print(char(PUBACK * 16)); 319 | _sendLength(2); 320 | Serial.print(char(MessageID / 256)); 321 | Serial.print(char(MessageID % 256)); 322 | } 323 | void GSM_MQTT::publishREC(unsigned int MessageID) 324 | { 325 | Serial.print(char(PUBREC * 16)); 326 | _sendLength(2); 327 | Serial.print(char(MessageID / 256)); 328 | Serial.print(char(MessageID % 256)); 329 | } 330 | void GSM_MQTT::publishREL(char DUP, unsigned int MessageID) 331 | { 332 | Serial.print(char(PUBREL * 16 + DUP * DUP_Mask + 1 * QoS_Scale)); 333 | _sendLength(2); 334 | Serial.print(char(MessageID / 256)); 335 | Serial.print(char(MessageID % 256)); 336 | } 337 | 338 | void GSM_MQTT::publishCOMP(unsigned int MessageID) 339 | { 340 | Serial.print(char(PUBCOMP * 16)); 341 | _sendLength(2); 342 | Serial.print(char(MessageID / 256)); 343 | Serial.print(char(MessageID % 256)); 344 | } 345 | void GSM_MQTT::subscribe(char DUP, unsigned int MessageID, char *SubTopic, char SubQoS) 346 | { 347 | Serial.print(char(SUBSCRIBE * 16 + DUP * DUP_Mask + 1 * QoS_Scale)); 348 | int localLength = 2 + (2 + strlen(SubTopic)) + 1; 349 | _sendLength(localLength); 350 | Serial.print(char(MessageID / 256)); 351 | Serial.print(char(MessageID % 256)); 352 | _sendUTFString(SubTopic); 353 | Serial.print(SubQoS); 354 | 355 | } 356 | void GSM_MQTT::unsubscribe(char DUP, unsigned int MessageID, char *SubTopic) 357 | { 358 | Serial.print(char(UNSUBSCRIBE * 16 + DUP * DUP_Mask + 1 * QoS_Scale)); 359 | int localLength = (2 + strlen(SubTopic)) + 2; 360 | _sendLength(localLength); 361 | 362 | Serial.print(char(MessageID / 256)); 363 | Serial.print(char(MessageID % 256)); 364 | 365 | _sendUTFString(SubTopic); 366 | } 367 | void GSM_MQTT::disconnect(void) 368 | { 369 | Serial.print(char(DISCONNECT * 16)); 370 | _sendLength(0); 371 | pingFlag = false; 372 | } 373 | //Messages 374 | const char CONNECTMessage[] PROGMEM = {"Client request to connect to Server\r\n"}; 375 | const char CONNACKMessage[] PROGMEM = {"Connect Acknowledgment\r\n"}; 376 | const char PUBLISHMessage[] PROGMEM = {"Publish message\r\n"}; 377 | const char PUBACKMessage[] PROGMEM = {"Publish Acknowledgment\r\n"}; 378 | const char PUBRECMessage[] PROGMEM = {"Publish Received (assured delivery part 1)\r\n"}; 379 | const char PUBRELMessage[] PROGMEM = {"Publish Release (assured delivery part 2)\r\n"}; 380 | const char PUBCOMPMessage[] PROGMEM = {"Publish Complete (assured delivery part 3)\r\n"}; 381 | const char SUBSCRIBEMessage[] PROGMEM = {"Client Subscribe request\r\n"}; 382 | const char SUBACKMessage[] PROGMEM = {"Subscribe Acknowledgment\r\n"}; 383 | const char UNSUBSCRIBEMessage[] PROGMEM = {"Client Unsubscribe request\r\n"}; 384 | const char UNSUBACKMessage[] PROGMEM = {"Unsubscribe Acknowledgment\r\n"}; 385 | const char PINGREQMessage[] PROGMEM = {"PING Request\r\n"}; 386 | const char PINGRESPMessage[] PROGMEM = {"PING Response\r\n"}; 387 | const char DISCONNECTMessage[] PROGMEM = {"Client is Disconnecting\r\n"}; 388 | 389 | void GSM_MQTT::printMessageType(uint8_t Message) 390 | { 391 | switch (Message) 392 | { 393 | case CONNECT: 394 | { 395 | int k, len = strlen_P(CONNECTMessage); 396 | char myChar; 397 | for (k = 0; k < len; k++) 398 | { 399 | myChar = pgm_read_byte_near(CONNECTMessage + k); 400 | mySerial.print(myChar); 401 | } 402 | break; 403 | } 404 | case CONNACK: 405 | { 406 | int k, len = strlen_P(CONNACKMessage); 407 | char myChar; 408 | for (k = 0; k < len; k++) 409 | { 410 | myChar = pgm_read_byte_near(CONNACKMessage + k); 411 | mySerial.print(myChar); 412 | } 413 | break; 414 | } 415 | case PUBLISH: 416 | { 417 | int k, len = strlen_P(PUBLISHMessage); 418 | char myChar; 419 | for (k = 0; k < len; k++) 420 | { 421 | myChar = pgm_read_byte_near(PUBLISHMessage + k); 422 | mySerial.print(myChar); 423 | } 424 | break; 425 | } 426 | case PUBACK: 427 | { 428 | int k, len = strlen_P(PUBACKMessage); 429 | char myChar; 430 | for (k = 0; k < len; k++) 431 | { 432 | myChar = pgm_read_byte_near(PUBACKMessage + k); 433 | mySerial.print(myChar); 434 | } 435 | break; 436 | } 437 | case PUBREC: 438 | { 439 | int k, len = strlen_P(PUBRECMessage); 440 | char myChar; 441 | for (k = 0; k < len; k++) 442 | { 443 | myChar = pgm_read_byte_near(PUBRECMessage + k); 444 | mySerial.print(myChar); 445 | } 446 | break; 447 | } 448 | case PUBREL: 449 | { 450 | int k, len = strlen_P(PUBRELMessage); 451 | char myChar; 452 | for (k = 0; k < len; k++) 453 | { 454 | myChar = pgm_read_byte_near(PUBRELMessage + k); 455 | mySerial.print(myChar); 456 | } 457 | break; 458 | } 459 | case PUBCOMP: 460 | { 461 | int k, len = strlen_P(PUBCOMPMessage ); 462 | char myChar; 463 | for (k = 0; k < len; k++) 464 | { 465 | myChar = pgm_read_byte_near(PUBCOMPMessage + k); 466 | mySerial.print(myChar); 467 | } 468 | break; 469 | } 470 | case SUBSCRIBE: 471 | { 472 | int k, len = strlen_P(SUBSCRIBEMessage ); 473 | char myChar; 474 | for (k = 0; k < len; k++) 475 | { 476 | myChar = pgm_read_byte_near(SUBSCRIBEMessage + k); 477 | mySerial.print(myChar); 478 | } 479 | break; 480 | } 481 | case SUBACK: 482 | { 483 | int k, len = strlen_P(SUBACKMessage ); 484 | char myChar; 485 | for (k = 0; k < len; k++) 486 | { 487 | myChar = pgm_read_byte_near(SUBACKMessage + k); 488 | mySerial.print(myChar); 489 | } 490 | break; 491 | } 492 | case UNSUBSCRIBE: 493 | { 494 | int k, len = strlen_P(UNSUBSCRIBEMessage ); 495 | char myChar; 496 | for (k = 0; k < len; k++) 497 | { 498 | myChar = pgm_read_byte_near(UNSUBSCRIBEMessage + k); 499 | mySerial.print(myChar); 500 | } 501 | break; 502 | } 503 | case UNSUBACK: 504 | { 505 | int k, len = strlen_P(UNSUBACKMessage ); 506 | char myChar; 507 | for (k = 0; k < len; k++) 508 | { 509 | myChar = pgm_read_byte_near(UNSUBACKMessage + k); 510 | mySerial.print(myChar); 511 | } 512 | break; 513 | } 514 | case PINGREQ: 515 | { 516 | int k, len = strlen_P(PINGREQMessage); 517 | char myChar; 518 | for (k = 0; k < len; k++) 519 | { 520 | myChar = pgm_read_byte_near(PINGREQMessage + k); 521 | mySerial.print(myChar); 522 | } 523 | break; 524 | } 525 | case PINGRESP: 526 | { 527 | pingSent = false; 528 | mySerial.println("pingSent = false"); 529 | int k, len = strlen_P(PINGRESPMessage); 530 | char myChar; 531 | for (k = 0; k < len; k++) 532 | { 533 | myChar = pgm_read_byte_near(PINGRESPMessage + k); 534 | mySerial.print(myChar); 535 | } 536 | break; 537 | } 538 | case DISCONNECT: 539 | { 540 | int k, len = strlen_P(DISCONNECTMessage); 541 | char myChar; 542 | for (k = 0; k < len; k++) 543 | { 544 | myChar = pgm_read_byte_near(DISCONNECTMessage + k); 545 | mySerial.print(myChar); 546 | } 547 | break; 548 | } 549 | } 550 | } 551 | 552 | //Connect Ack 553 | const char ConnectAck0[] PROGMEM = {"Connection Accepted\r\n"}; 554 | const char ConnectAck1[] PROGMEM = {"Connection Refused: unacceptable protocol version\r\n"}; 555 | const char ConnectAck2[] PROGMEM = {"Connection Refused: identifier rejected\r\n"}; 556 | const char ConnectAck3[] PROGMEM = {"Connection Refused: server unavailable\r\n"}; 557 | const char ConnectAck4[] PROGMEM = {"Connection Refused: bad user name or password\r\n"}; 558 | const char ConnectAck5[] PROGMEM = {"Connection Refused: not authorized\r\n"}; 559 | void GSM_MQTT::printConnectAck(uint8_t Ack) 560 | { 561 | switch (Ack) 562 | { 563 | case 0: 564 | { 565 | int k, len = strlen_P(ConnectAck0); 566 | char myChar; 567 | for (k = 0; k < len; k++) 568 | { 569 | myChar = pgm_read_byte_near(ConnectAck0 + k); 570 | mySerial.print(myChar); 571 | } 572 | break; 573 | } 574 | case 1: 575 | { 576 | int k, len = strlen_P(ConnectAck1); 577 | char myChar; 578 | for (k = 0; k < len; k++) 579 | { 580 | myChar = pgm_read_byte_near(ConnectAck1 + k); 581 | mySerial.print(myChar); 582 | } 583 | break; 584 | } 585 | case 2: 586 | { 587 | int k, len = strlen_P(ConnectAck2); 588 | char myChar; 589 | for (k = 0; k < len; k++) 590 | { 591 | myChar = pgm_read_byte_near(ConnectAck2 + k); 592 | mySerial.print(myChar); 593 | } 594 | break; 595 | } 596 | case 3: 597 | { 598 | int k, len = strlen_P(ConnectAck3); 599 | char myChar; 600 | for (k = 0; k < len; k++) 601 | { 602 | myChar = pgm_read_byte_near(ConnectAck3 + k); 603 | mySerial.print(myChar); 604 | } 605 | break; 606 | } 607 | case 4: 608 | { 609 | int k, len = strlen_P(ConnectAck4); 610 | char myChar; 611 | for (k = 0; k < len; k++) 612 | { 613 | myChar = pgm_read_byte_near(ConnectAck4 + k); 614 | mySerial.print(myChar); 615 | } 616 | break; 617 | } 618 | case 5: 619 | { 620 | int k, len = strlen_P(ConnectAck5); 621 | char myChar; 622 | for (k = 0; k < len; k++) 623 | { 624 | myChar = pgm_read_byte_near(ConnectAck5 + k); 625 | mySerial.print(myChar); 626 | } 627 | break; 628 | } 629 | } 630 | } 631 | unsigned int GSM_MQTT::_generateMessageID(void) 632 | { 633 | if (_LastMessaseID < 65535) 634 | { 635 | return ++_LastMessaseID; 636 | } 637 | else 638 | { 639 | _LastMessaseID = 0; 640 | return _LastMessaseID; 641 | } 642 | } 643 | void GSM_MQTT::processing(void) 644 | { 645 | if (TCP_Flag == false) 646 | { 647 | MQTT_Flag = false; 648 | _tcpInit(); 649 | } 650 | _ping(); 651 | } 652 | bool GSM_MQTT::available(void) 653 | { 654 | return MQTT_Flag; 655 | } 656 | void serialEvent() 657 | { 658 | 659 | while (Serial.available()) 660 | { 661 | char inChar = (char)Serial.read(); 662 | if (MQTT.TCP_Flag == false) 663 | { 664 | if (MQTT.index < 200) 665 | { 666 | MQTT.inputString[MQTT.index++] = inChar; 667 | } 668 | if (inChar == '\n') 669 | { 670 | MQTT.inputString[MQTT.index] = 0; 671 | stringComplete = true; 672 | mySerial.print(MQTT.inputString); 673 | if (strstr(MQTT.inputString, MQTT.reply) != NULL) 674 | { 675 | MQTT.GSM_ReplyFlag = 1; 676 | if (strstr(MQTT.inputString, " INITIAL") != 0) 677 | { 678 | MQTT.GSM_ReplyFlag = 2; // 679 | } 680 | else if (strstr(MQTT.inputString, " START") != 0) 681 | { 682 | MQTT.GSM_ReplyFlag = 3; // 683 | } 684 | else if (strstr(MQTT.inputString, "IP CONFIG") != 0) 685 | { 686 | _delay_us(10); 687 | MQTT.GSM_ReplyFlag = 4; 688 | } 689 | else if (strstr(MQTT.inputString, " GPRSACT") != 0) 690 | { 691 | MQTT.GSM_ReplyFlag = 4; // 692 | } 693 | else if ((strstr(MQTT.inputString, " STATUS") != 0) || (strstr(MQTT.inputString, "TCP CLOSED") != 0)) 694 | { 695 | MQTT.GSM_ReplyFlag = 5; // 696 | } 697 | else if (strstr(MQTT.inputString, " TCP CONNECTING") != 0) 698 | { 699 | MQTT.GSM_ReplyFlag = 6; // 700 | } 701 | else if ((strstr(MQTT.inputString, " CONNECT OK") != 0) || (strstr(MQTT.inputString, "CONNECT FAIL") != NULL) || (strstr(MQTT.inputString, "PDP DEACT") != 0)) 702 | { 703 | MQTT.GSM_ReplyFlag = 7; 704 | } 705 | } 706 | else if (strstr(MQTT.inputString, "OK") != NULL) 707 | { 708 | GSM_Response = 1; 709 | } 710 | else if (strstr(MQTT.inputString, "ERROR") != NULL) 711 | { 712 | GSM_Response = 2; 713 | } 714 | else if (strstr(MQTT.inputString, ".") != NULL) 715 | { 716 | GSM_Response = 3; 717 | } 718 | else if (strstr(MQTT.inputString, "CONNECT FAIL") != NULL) 719 | { 720 | GSM_Response = 5; 721 | } 722 | else if (strstr(MQTT.inputString, "CONNECT") != NULL) 723 | { 724 | GSM_Response = 4; 725 | MQTT.TCP_Flag = true; 726 | mySerial.println("MQTT.TCP_Flag = True"); 727 | MQTT.AutoConnect(); 728 | MQTT.pingFlag = true; 729 | MQTT.tcpATerrorcount = 0; 730 | } 731 | else if (strstr(MQTT.inputString, "CLOSED") != NULL) 732 | { 733 | GSM_Response = 4; 734 | MQTT.TCP_Flag = false; 735 | MQTT.MQTT_Flag = false; 736 | } 737 | MQTT.index = 0; 738 | MQTT.inputString[0] = 0; 739 | } 740 | } 741 | else 742 | { 743 | uint8_t ReceivedMessageType = (inChar / 16) & 0x0F; 744 | uint8_t DUP = (inChar & DUP_Mask) / DUP_Mask; 745 | uint8_t QoS = (inChar & QoS_Mask) / QoS_Scale; 746 | uint8_t RETAIN = (inChar & RETAIN_Mask); 747 | if ((ReceivedMessageType >= CONNECT) && (ReceivedMessageType <= DISCONNECT)) 748 | { 749 | bool NextLengthByte = true; 750 | MQTT.length = 0; 751 | MQTT.lengthLocal = 0; 752 | uint32_t multiplier=1; 753 | delay(2); 754 | char Cchar = inChar; 755 | while ( (NextLengthByte == true) && (MQTT.TCP_Flag == true)) 756 | { 757 | if (Serial.available()) 758 | { 759 | inChar = (char)Serial.read(); 760 | mySerial.println(inChar, DEC); 761 | if ((((Cchar & 0xFF) == 'C') && ((inChar & 0xFF) == 'L') && (MQTT.length == 0)) || (((Cchar & 0xFF) == '+') && ((inChar & 0xFF) == 'P') && (MQTT.length == 0))) 762 | { 763 | MQTT.index = 0; 764 | MQTT.inputString[MQTT.index++] = Cchar; 765 | MQTT.inputString[MQTT.index++] = inChar; 766 | MQTT.TCP_Flag = false; 767 | MQTT.MQTT_Flag = false; 768 | MQTT.pingFlag = false; 769 | mySerial.println("Disconnecting"); 770 | } 771 | else 772 | { 773 | if ((inChar & 128) == 128) 774 | { 775 | MQTT.length += (inChar & 127) * multiplier; 776 | multiplier *= 128; 777 | mySerial.println("More"); 778 | } 779 | else 780 | { 781 | NextLengthByte = false; 782 | MQTT.length += (inChar & 127) * multiplier; 783 | multiplier *= 128; 784 | } 785 | } 786 | } 787 | } 788 | MQTT.lengthLocal = MQTT.length; 789 | mySerial.println(MQTT.length); 790 | if (MQTT.TCP_Flag == true) 791 | { 792 | MQTT.printMessageType(ReceivedMessageType); 793 | MQTT.index = 0L; 794 | uint32_t a = 0; 795 | while ((MQTT.length-- > 0) && (Serial.available())) 796 | { 797 | MQTT.inputString[uint32_t(MQTT.index++)] = (char)Serial.read(); 798 | 799 | delay(1); 800 | 801 | } 802 | mySerial.println(" "); 803 | if (ReceivedMessageType == CONNACK) 804 | { 805 | MQTT.ConnectionAcknowledgement = MQTT.inputString[0] * 256 + MQTT.inputString[1]; 806 | if (MQTT.ConnectionAcknowledgement == 0) 807 | { 808 | MQTT.MQTT_Flag = true; 809 | MQTT.OnConnect(); 810 | 811 | } 812 | 813 | MQTT.printConnectAck(MQTT.ConnectionAcknowledgement); 814 | // MQTT.OnConnect(); 815 | } 816 | else if (ReceivedMessageType == PUBLISH) 817 | { 818 | uint32_t TopicLength = (MQTT.inputString[0]) * 256 + (MQTT.inputString[1]); 819 | mySerial.print("Topic : '"); 820 | MQTT.PublishIndex = 0; 821 | for (uint32_t iter = 2; iter < TopicLength + 2; iter++) 822 | { 823 | mySerial.print(MQTT.inputString[iter]); 824 | MQTT.Topic[MQTT.PublishIndex++] = MQTT.inputString[iter]; 825 | } 826 | MQTT.Topic[MQTT.PublishIndex] = 0; 827 | mySerial.print("' Message :'"); 828 | MQTT.TopicLength = MQTT.PublishIndex; 829 | 830 | MQTT.PublishIndex = 0; 831 | uint32_t MessageSTART = TopicLength + 2UL; 832 | int MessageID = 0; 833 | if (QoS != 0) 834 | { 835 | MessageSTART += 2; 836 | MessageID = MQTT.inputString[TopicLength + 2UL] * 256 + MQTT.inputString[TopicLength + 3UL]; 837 | } 838 | for (uint32_t iter = (MessageSTART); iter < (MQTT.lengthLocal); iter++) 839 | { 840 | mySerial.print(MQTT.inputString[iter]); 841 | MQTT.Message[MQTT.PublishIndex++] = MQTT.inputString[iter]; 842 | } 843 | MQTT.Message[MQTT.PublishIndex] = 0; 844 | mySerial.println("'"); 845 | MQTT.MessageLength = MQTT.PublishIndex; 846 | if (QoS == 1) 847 | { 848 | MQTT.publishACK(MessageID); 849 | } 850 | else if (QoS == 2) 851 | { 852 | MQTT.publishREC(MessageID); 853 | } 854 | MQTT.OnMessage(MQTT.Topic, MQTT.TopicLength, MQTT.Message, MQTT.MessageLength); 855 | MQTT.MessageFlag = true; 856 | } 857 | else if (ReceivedMessageType == PUBREC) 858 | { 859 | mySerial.print("Message ID :"); 860 | MQTT.publishREL(0, MQTT.inputString[0] * 256 + MQTT.inputString[1]) ; 861 | mySerial.println(MQTT.inputString[0] * 256 + MQTT.inputString[1]) ; 862 | 863 | } 864 | else if (ReceivedMessageType == PUBREL) 865 | { 866 | mySerial.print("Message ID :"); 867 | MQTT.publishCOMP(MQTT.inputString[0] * 256 + MQTT.inputString[1]) ; 868 | mySerial.println(MQTT.inputString[0] * 256 + MQTT.inputString[1]) ; 869 | 870 | } 871 | else if ((ReceivedMessageType == PUBACK) || (ReceivedMessageType == PUBCOMP) || (ReceivedMessageType == SUBACK) || (ReceivedMessageType == UNSUBACK)) 872 | { 873 | mySerial.print("Message ID :"); 874 | mySerial.println(MQTT.inputString[0] * 256 + MQTT.inputString[1]) ; 875 | } 876 | else if (ReceivedMessageType == PINGREQ) 877 | { 878 | MQTT.TCP_Flag = false; 879 | MQTT.MQTT_Flag = false; 880 | MQTT.pingFlag = false; 881 | mySerial.println("Disconnecting"); 882 | MQTT.sendATreply("AT+CIPSHUT\r\n", ".", 4000) ; 883 | MQTT.modemStatus = 0; 884 | } 885 | } 886 | } 887 | else if ((inChar = 13) || (inChar == 10)) 888 | { 889 | } 890 | else 891 | { 892 | mySerial.print("Received :Unknown Message Type :"); 893 | mySerial.println(inChar); 894 | } 895 | } 896 | } 897 | } 898 | -------------------------------------------------------------------------------- /src/GSM_MQTT.h: -------------------------------------------------------------------------------- 1 | /* 2 | MQTT.h - Library for GSM MQTT Client. 3 | Created by Nithin K. Kurian, Dhanish Vijayan, Elementz Engineers Guild Pvt. Ltd, July 2, 2016. 4 | Released into the public domain. 5 | */ 6 | #ifndef GSM_MQTT_H_ 7 | #define GSM_MQTT_H_ 8 | 9 | //Arduino toolchain header, version dependent 10 | #if defined(ARDUINO) && ARDUINO >= 100 11 | #include "Arduino.h" 12 | #else 13 | #include "WProgram.h" 14 | #endif 15 | 16 | #include "pins_arduino.h" 17 | 18 | #include 19 | 20 | #define UART_BUFFER_LENGTH 300 //Maximum length allowed for UART data 21 | #define TOPIC_BUFFER_LENGTH 50 //Maximum length allowed Topic 22 | #define MESSAGE_BUFFER_LENGTH 250 //Maximum length allowed data 23 | 24 | // ###################################################################################################################### 25 | #define CONNECT 1 //Client request to connect to Server Client Server 26 | #define CONNACK 2 //Connect Acknowledgment Server/Client Server/Client 27 | #define PUBLISH 3 //Publish message Server/Client Server/Client 28 | #define PUBACK 4 //Publish Acknowledgment Server/Client Server/Client 29 | #define PUBREC 5 //Publish Received (assured delivery part 1) Server/Client Server/Client 30 | #define PUBREL 6 //Publish Release (assured delivery part 2) Server/Client Server/Client 31 | #define PUBCOMP 7 //Publish Complete (assured delivery part 3) Server/Client Server/Client 32 | #define SUBSCRIBE 8 //Client Subscribe request Client Server 33 | #define SUBACK 9 //Subscribe Acknowledgment Server Client 34 | #define UNSUBSCRIBE 10 //Client Unsubscribe request Client Server 35 | #define UNSUBACK 11 //Unsubscribe Acknowledgment Server Client 36 | #define PINGREQ 12 //PING Request Client Server 37 | #define PINGRESP 13 //PING Response Server Client 38 | #define DISCONNECT 14 //Client is Disconnecting Client Server 39 | 40 | // QoS value bit 2 bit 1 Description 41 | // 0 0 0 At most once Fire and Forget <=1 42 | // 1 0 1 At least once Acknowledged delivery >=1 43 | // 2 1 0 Exactly once Assured delivery =1 44 | // 3 1 1 Reserved 45 | #define DUP_Mask 8 // Duplicate delivery Only for QoS>0 46 | #define QoS_Mask 6 // Quality of Service 47 | #define QoS_Scale 2 // (()&QoS)/QoS_Scale 48 | #define RETAIN_Mask 1 // RETAIN flag 49 | 50 | #define User_Name_Flag_Mask 128 51 | #define Password_Flag_Mask 64 52 | #define Will_Retain_Mask 32 53 | #define Will_QoS_Mask 24 54 | #define Will_QoS_Scale 8 55 | #define Will_Flag_Mask 4 56 | #define Clean_Session_Mask 2 57 | 58 | #define DISCONNECTED 0 59 | #define CONNECTED 1 60 | #define NO_ACKNOWLEDGEMENT 255 61 | 62 | class GSM_MQTT 63 | { 64 | public: 65 | volatile bool TCP_Flag = false; 66 | volatile char GSM_ReplyFlag; 67 | char reply[10]; 68 | volatile bool pingFlag = false; 69 | volatile char tcpATerrorcount = 0; 70 | volatile bool pingSent = false; 71 | volatile bool MQTT_Flag = false; 72 | volatile int ConnectionAcknowledgement = NO_ACKNOWLEDGEMENT ; 73 | volatile int PublishIndex = 0; 74 | char Topic[TOPIC_BUFFER_LENGTH]; 75 | volatile int TopicLength = 0; 76 | char Message[MESSAGE_BUFFER_LENGTH]; 77 | volatile int MessageLength = 0; 78 | volatile int MessageFlag = false; 79 | volatile char modemStatus = 0; 80 | volatile uint32_t index = 0; 81 | volatile uint32_t length = 0, lengthLocal = 0; 82 | 83 | char inputString[UART_BUFFER_LENGTH]; 84 | 85 | GSM_MQTT(unsigned long KeepAlive); 86 | void begin(void); 87 | void connect(char *ClientIdentifier, char UserNameFlag, char PasswordFlag, char *UserName, char *Password, char CleanSession, char WillFlag, char WillQoS, char WillRetain, char *WillTopic, char *WillMessage); 88 | void publish(char DUP, char Qos, char RETAIN, unsigned int MessageID, char *Topic, char *Message); 89 | void subscribe(char DUP, unsigned int MessageID, char *SubTopic, char SubQoS); 90 | void unsubscribe(char DUP, unsigned int MessageID, char *SubTopic); 91 | void disconnect(void); 92 | void processing(void); 93 | bool available(void); 94 | 95 | void AutoConnect(void); 96 | void OnConnect(void); 97 | void OnMessage(char *Topic, int TopicLength, char *Message, int MessageLength); 98 | 99 | void publishACK(unsigned int MessageID); 100 | void publishREC(unsigned int MessageID); 101 | void publishREL(char DUP, unsigned int MessageID); 102 | void publishCOMP(unsigned int MessageID); 103 | 104 | void printMessageType(uint8_t Message); 105 | void printConnectAck(uint8_t Ack); 106 | char sendATreply(char *command, char *replystr, unsigned long waitms); 107 | 108 | private: 109 | volatile unsigned int _LastMessaseID = 0; 110 | volatile char _ProtocolVersion = 3; 111 | volatile unsigned long _PingPrevMillis = 0; 112 | volatile char _tcpStatus = 0; 113 | volatile char _tcpStatusPrev = 0; 114 | volatile unsigned long _KeepAliveTimeOut; 115 | 116 | void _sendUTFString(char *string); 117 | void _sendLength(int len); 118 | void _ping(void); 119 | void _tcpInit(void); 120 | char _sendAT(char *command, unsigned long waitms); 121 | unsigned int _generateMessageID(void); 122 | }; 123 | #endif /* GSM_MQTT_H_ */ 124 | --------------------------------------------------------------------------------