├── LICENSE ├── README.md ├── examples └── basic │ └── basic.ino └── src ├── NowMesh.cpp └── NowMesh.h /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 | # NowMesh 2 | --- 3 | 4 | NowMesh is an easy-to-use mesh networking library for the ESP8266. 5 | Utilizes ESP Now, a fast connectionless protocol. 6 | 7 | See [examples/basic/basic.ino](https://github.com/chuckwagoncomputing/NowMesh/blob/master/examples/basic/basic.ino) for basic usage. 8 | 9 | ## Reliability 10 | Tested with 11 nodes: Works perfectly 11 | Tested with 31 nodes: STORED_MESSAGES in EspNow.h must be set to the number of nodes. Even then, several nodes gave problems. 12 | -------------------------------------------------------------------------------- /examples/basic/basic.ino: -------------------------------------------------------------------------------- 1 | #include "Arduino.h" 2 | #include "NowMesh.h" 3 | 4 | // Scan every 5 seconds. If your nodes don't move around much or you don't 5 | // require high availability/reliability, you can increase this. 6 | // Scans take around 3 seconds to complete, so don't go too low. 7 | #define SCAN_INTERVAL 5000 8 | 9 | // Send a message every second. 10 | #define MESSAGE_INTERVAL 1000 11 | 12 | // In this example sketch, we use a interval timer to scan. 13 | os_timer_t scan_timer; 14 | // The callback from the timer sets this boolean to true. 15 | volatile bool should_scan = true; 16 | // We'll do the same for our message timer. 17 | os_timer_t message_timer; 18 | // Only not attempt a message right away as we won't have any peers yet. 19 | volatile bool should_message = false; 20 | 21 | // Create mesh object. 22 | NowMesh mesh; 23 | 24 | // Here's the timer callback. Very simple. We'll check should_scan in loop(). 25 | void scanTimerCallback(void* arg) { 26 | should_scan = true; 27 | } 28 | 29 | // And the same for the message timer. 30 | void messageTimerCallback(void* arg) { 31 | should_message = true; 32 | } 33 | 34 | // When we receive a message, whatever function we have set as receive callback will be called. 35 | // The arguments are as follows: 36 | // String request - the message 37 | // bool self_is_target - true if the message was targeted and we are the intended recepient 38 | // uint8_t* originator - MAC address of the node which originally sent the message 39 | void messageReceivedCallback(String request, bool self_is_target, uint8_t* originator) { 40 | Serial.print("Received message"); 41 | if (self_is_target) { 42 | Serial.print(" targeted at me"); 43 | } 44 | Serial.print(" from "); 45 | for (int i = 0; i < 6; i++) { 46 | Serial.print(originator[i], HEX); 47 | Serial.print(":"); 48 | } 49 | Serial.println(" " + request); 50 | } 51 | 52 | // When a message has been sent, whatever function we have set as sendcallback will be called. 53 | // This does not necessarily indicate success. Check the status argument before assuming success. 54 | void messageSendCallback(int status) { 55 | Serial.println("Message sent with status " + String(status, DEC)); 56 | } 57 | 58 | void setup() { 59 | Serial.begin(115200); 60 | // Initialize the mesh. No arguments necessary. 61 | mesh.begin(); 62 | // Receive and Send callbacks must be set. 63 | mesh.setReceiveCallback(messageReceivedCallback); 64 | mesh.setSendCallback(messageSendCallback); 65 | // Initialize the timers. 66 | os_timer_setfn(&scan_timer, scanTimerCallback, NULL); 67 | os_timer_arm(&scan_timer, SCAN_INTERVAL, true); 68 | os_timer_setfn(&message_timer, messageTimerCallback, NULL); 69 | os_timer_arm(&message_timer, MESSAGE_INTERVAL, true); 70 | } 71 | 72 | void loop() { 73 | // Check if the scan timer has fired. 74 | if (should_scan) { 75 | // Scan for peers. NowMesh will automatically connect to found peers. 76 | mesh.scanForPeers(); 77 | should_scan = false; 78 | } 79 | // And if the message timer has fired 80 | if (should_message) { 81 | // Send a message. 82 | mesh.send("hi!"); 83 | // You can also call NowMesh.send with two arguments, 84 | // the second being the MAC address of the target. 85 | // uint8_t target = {0x0a, 0xdf, 0xae, 0x5c, 0x9d, 0x07}; 86 | // mesh.send("hi", target); 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /src/NowMesh.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | // A bit of info on how NowMesh works: 4 | // There are two kinds of messages, broadcast and targeted. 5 | // Nodes forward broadcast messages to all their peers unless they 6 | // have already received the message. 7 | // If you have trouble with messages that won't die, but keep being sent around, 8 | // increase STORED_MESSAGES in NowMesh.h 9 | // When receiving a targeted message, nodes look through their stored messages in 10 | // order to find the best route. If they can't find a best route, they broadcast the message. 11 | // Message format, each field separated by a comma: 12 | // 1: [1-2] Message type. 1 = Broadcast, 2 = Targeted 13 | // 2: [0-255] First byte of MAC address of the node that originated the message. 14 | // 3: [0-255] Second 15 | // 4: [0-255] Third 16 | // 5: [0-255] Fourth 17 | // 6: [0-255] Fifth 18 | // 7: [0-255] Sixth 19 | // 8: [0-255] First byte of MAC addresss of the target node, else 0 if message is broadcast. 20 | // 9: [0-255] 21 | // 10: [0-255] 22 | // 11: [0-255] 23 | // 12: [0-255] 24 | // 13: [0-255] 25 | // 14: [0-65535] Message ID. Each Node tracks their message ID, incrementing it every time they send a message. 26 | // 15: ^[,]* Message. This can be anything as long as it has no commas 27 | // and the total message length is less than MAX_MSG_LEN, set in NowMesh.h 28 | 29 | // This is where we store messages. 30 | message_info NowMesh::message_store[STORED_MESSAGES]; 31 | 32 | // User facing callbacks for when we receive a message or a message has been sent. 33 | // These callbacks won't get the whole message, only the part that was sent with NowMesh::send by the other node. 34 | std::function NowMesh::receiveCallback; 35 | std::function NowMesh::sendCallback; 36 | 37 | NowMesh::NowMesh() { 38 | } 39 | 40 | // Set callbacks 41 | void ICACHE_FLASH_ATTR NowMesh::setReceiveCallback(std::function callback) { 42 | NowMesh::receiveCallback = callback; 43 | } 44 | 45 | void ICACHE_FLASH_ATTR NowMesh::setSendCallback(std::function callback) { 46 | NowMesh::sendCallback = callback; 47 | } 48 | 49 | // We scan for peers. User code should call NowMesh::scanForPeers every once in a while. 50 | // scanForPeers is asynchrous, and this is its callback. 51 | void ICACHE_FLASH_ATTR NowMesh::scanDoneCallback(void* arg, STATUS status) { 52 | // Make sure scan was successful. 53 | if (status == OK) { 54 | nowmeshDebug("Scan Done status OK", LEVEL_NORMAL); 55 | // We store found peers temporarily for processing. 56 | peer_info peer_store[MAX_PEERS]; 57 | // Found AP info is in a tail queue; let's loop through it. 58 | struct bss_info* ap_link = (struct bss_info *)arg; 59 | while (ap_link != NULL) { 60 | String ssid = (const char*)ap_link->ssid; 61 | nowmeshDebug(String("Found AP: " + ssid), LEVEL_NORMAL); 62 | // Check for the default ESP8266 prefix so we don't try to peer with some random router. 63 | if (ssid.substring(0, 4) == "ESP_") { 64 | // Strategy here is to loop through stored peers and find an empty spot or replace the peer with the worst score. 65 | // candidate is the index of the one we want to replace 66 | int candidate = -1; 67 | int16_t worst_score = 0; 68 | // Score is based on signal strength 69 | int16_t score = 128 - abs(ap_link->rssi); 70 | // Loop through stored messages and add score for every message we have gotten from or through this peer. 71 | // This gives peers we have previously been in contact with an advantage. 72 | for (int i = 0; i < STORED_MESSAGES; i++) { 73 | if (memcmp(ap_link->bssid, message_store[i].originator, 6) == 0 || memcmp(ap_link->bssid, message_store[i].sender, 6) == 0) { 74 | score += 20; 75 | } 76 | } 77 | nowmeshDebug(String("AP score: " + String(score, DEC)), LEVEL_NORMAL); 78 | // Loop through the stored peers 79 | for (int i = 0; i < MAX_PEERS; i++) { 80 | // This place is empty, we'll just go ahead and store there. 81 | if (!(peer_store[i].score > 0)) { 82 | candidate = i; 83 | // Break from loop so we don't keep trying to find a place. 84 | break; 85 | } 86 | // If this peer has a worse score than we do and also breaks the record for worst score, 87 | // it's the best candidate for replacement yet. 88 | if (peer_store[i].score < score && peer_store[i].score < worst_score) { 89 | candidate = i; 90 | // Set the record. 91 | worst_score = peer_store[i].score; 92 | } 93 | } 94 | // If we didn't find one to replace, candidate will still be -1. 95 | if (candidate >= 0) { 96 | nowmeshDebug(String("Storing in position " + String(candidate, DEC)), LEVEL_NORMAL); 97 | memcpy(peer_store[candidate].mac, ap_link->bssid, 6); 98 | peer_store[candidate].score = score; 99 | } 100 | } 101 | // Get the next AP in the tail queue 102 | ap_link = STAILQ_NEXT(ap_link, next); 103 | } 104 | // Now loop through peer storage. If they aren't already our peers, make them so. 105 | for (int i = 0; i < MAX_PEERS; i++) { 106 | if (peer_store[i].score > 0) { 107 | if (!esp_now_is_peer_exist(peer_store[i].mac)) { 108 | esp_now_add_peer(peer_store[i].mac, ESP_NOW_ROLE_SLAVE, CHANNEL, NULL, 0); 109 | } 110 | } 111 | } 112 | // Now loop through our peers to purge those we don't want to burden ourselves with. 113 | u8* peer = esp_now_fetch_peer(true); 114 | while (peer != NULL) { 115 | bool found = false; 116 | // Loop through peer storage to try to find them. 117 | for (int i = 0; i < MAX_PEERS; i++) { 118 | if (memcmp(peer, peer_store[i].mac, 6) == 0) { 119 | found = true; 120 | } 121 | } 122 | if (!found) { 123 | esp_now_del_peer(peer); 124 | } 125 | // Get the next peer. 126 | peer = esp_now_fetch_peer(false); 127 | } 128 | } 129 | } 130 | 131 | // User facing scan function, which should be called periodically. 132 | void ICACHE_FLASH_ATTR NowMesh::scanForPeers() { 133 | // wifi_station_scan takes a config, which is nice because we can restrict it to only the channel which 134 | // we know all peers will be using, saving time. 135 | struct scan_config config; 136 | config.ssid = NULL; 137 | config.bssid = NULL; 138 | config.channel = CHANNEL; 139 | wifi_station_scan(&config, scanDoneCallback); 140 | } 141 | 142 | // Send a message, any message... 143 | // Used by sendBroadcast and sendTargeted 144 | int ICACHE_FLASH_ATTR NowMesh::sendMessage(uint8_t* target, char* data){ 145 | nowmeshDebug(String("Sending message out: " + String((const char*)data)), LEVEL_NORMAL); 146 | system_soft_wdt_feed(); 147 | // If target is NULL, esp_now_send will send to all peers. 148 | return esp_now_send(target, reinterpret_cast(data), strlen(data)); 149 | } 150 | 151 | // Send a broadcast message. 152 | int ICACHE_FLASH_ATTR NowMesh::sendBroadcast(String message, uint8_t* originator, uint16_t message_id) { 153 | char data[MAX_MSG_LEN]; 154 | sprintf(data, "1,%u,%u,%u,%u,%u,%u,0,0,0,0,0,0,%u,%s", 155 | originator[0], 156 | originator[1], 157 | originator[2], 158 | originator[3], 159 | originator[4], 160 | originator[5], 161 | message_id, 162 | message.c_str() 163 | ); 164 | return sendMessage(NULL, data); 165 | } 166 | 167 | // Send targeted message. 168 | int ICACHE_FLASH_ATTR NowMesh::sendTargeted(String message, uint8_t* originator, uint8_t* target, uint16_t message_id) { 169 | uint8_t self[6]; 170 | wifi_get_macaddr(0, self); 171 | char data[MAX_MSG_LEN]; 172 | sprintf(data, "2,%u,%u,%u,%u,%u,%u,%u,%u,%u,%u,%u,%u,%u,%s", 173 | originator[0], 174 | originator[1], 175 | originator[2], 176 | originator[3], 177 | originator[4], 178 | originator[5], 179 | target[0], 180 | target[1], 181 | target[2], 182 | target[3], 183 | target[4], 184 | target[5], 185 | message_id, 186 | message.c_str() 187 | ); 188 | // Loop through stored messages, looking for messages from the target. 189 | for (int i = 0; message_store[i].id > 0 && i < STORED_MESSAGES; i++) { 190 | // If this message originated from our target or was received directly from our target 191 | if (memcmp(message_store[i].originator, target, 6) == 0 || memcmp(message_store[i].sender, target, 6) == 0) { 192 | nowmeshDebug(String("Found stored message originating from or sent by the target of this message"), LEVEL_NORMAL); 193 | // If we are still peered with the sender of the message. 194 | if (esp_now_is_peer_exist(message_store[i].sender)) { 195 | // Send the message only to the sender. 196 | return sendMessage(message_store[i].sender, data); 197 | } 198 | } 199 | } 200 | // If control reaches this point, we didn't find any good route, so just broadcast the message. 201 | return sendMessage(NULL, data); 202 | } 203 | 204 | // Callback when we have received a message. 205 | void ICACHE_FLASH_ATTR NowMesh::receiveData(unsigned char* mac, unsigned char* data, uint8_t len) { 206 | nowmeshDebug(String("Received raw: " + String((const char*)data)), LEVEL_NORMAL); 207 | nowmeshDebug(String("Receive length: " + String(len, DEC)), LEVEL_NORMAL); 208 | // If the message is too long, toss it out. 209 | // We don't wanna hang on a bad actor or transmission error. 210 | if (len > MAX_MSG_LEN) { 211 | nowmeshDebug("Bad message: too long", LEVEL_UNLIKELY_ERROR); 212 | return; 213 | } 214 | // Track field position 215 | int pos = 0; 216 | uint8_t message_type; 217 | uint8_t originator[6]; 218 | uint8_t target[6]; 219 | uint16_t message_id; 220 | // Each field is stored here 221 | char* token; 222 | // Message out. 223 | String message; 224 | // Message in. Cut it to length because it's not null terminated and there will be some garbage at the end. 225 | String received_message = String(reinterpret_cast(data)).substring(0, len); 226 | nowmeshDebug(String("Received cut: " + received_message), LEVEL_NORMAL); 227 | char received_buffer[MAX_MSG_LEN]; 228 | strcpy(received_buffer, received_message.c_str()); 229 | // Loop through one token at a time 230 | token = strtok(received_buffer, ","); 231 | while (token != NULL) { 232 | switch (pos) { 233 | case 0: 234 | message_type = String(token).toInt(); 235 | break; 236 | case 1: 237 | originator[0] = String(token).toInt(); 238 | break; 239 | case 2: 240 | originator[1] = String(token).toInt(); 241 | break; 242 | case 3: 243 | originator[2] = String(token).toInt(); 244 | break; 245 | case 4: 246 | originator[3] = String(token).toInt(); 247 | break; 248 | case 5: 249 | originator[4] = String(token).toInt(); 250 | break; 251 | case 6: 252 | originator[5] = String(token).toInt(); 253 | break; 254 | case 7: 255 | target[0] = String(token).toInt(); 256 | break; 257 | case 8: 258 | target[1] = String(token).toInt(); 259 | break; 260 | case 9: 261 | target[2] = String(token).toInt(); 262 | break; 263 | case 10: 264 | target[3] = String(token).toInt(); 265 | break; 266 | case 11: 267 | target[4] = String(token).toInt(); 268 | break; 269 | case 12: 270 | target[5] = String(token).toInt(); 271 | break; 272 | case 13: 273 | message_id = String(token).toInt(); 274 | break; 275 | case 14: 276 | message = token; 277 | break; 278 | } 279 | pos++; 280 | token = strtok(NULL, ","); 281 | } 282 | system_soft_wdt_feed(); 283 | // If we had too many positions, give up. This will happen if there is a comma in the message sent! 284 | if (pos != 15) { 285 | nowmeshDebug("Bad Message: too many tokens", LEVEL_UNLIKELY_ERROR); 286 | return; 287 | } 288 | uint8_t self[6]; 289 | wifi_get_macaddr(0, self); 290 | if (memcmp(originator, self, 6) == 0) { 291 | nowmeshDebug("We sent this message", LEVEL_NORMAL); 292 | return; 293 | } 294 | // Loop through stored messages and make sure we haven't seen this message already. 295 | // If we keep forwarding previously seen messages, the pipes will quickly clog. 296 | int msg_i = 0; 297 | while (msg_i < STORED_MESSAGES && message_store[msg_i].id > 0) { 298 | if (message_store[msg_i].id == message_id && memcmp(message_store[msg_i].originator, originator, 6) == 0) { 299 | nowmeshDebug("Message is already stored", LEVEL_NORMAL); 300 | return; 301 | } 302 | msg_i++; 303 | } 304 | nowmeshDebug(String("Stored Messages: " + String(msg_i, DEC)), LEVEL_NORMAL); 305 | // msg_i will hold the index of the first empty message. 306 | // If there are no empty messages, it will be the first address past the end of our array, 307 | // so we need to store this message at the first index of the array and shift all messages to the back. 308 | if (msg_i == STORED_MESSAGES) { 309 | msg_i--; 310 | } 311 | // Loop through message store backwards and store the next message forward here. 312 | for (; msg_i > 0; msg_i--) { 313 | memcpy(message_store[msg_i].originator, message_store[msg_i - 1].originator, 6); 314 | memcpy(message_store[msg_i].sender, message_store[msg_i - 1].sender, 6); 315 | message_store[msg_i].id = message_store[msg_i - 1].id; 316 | } 317 | // Store this message as the first in the array. 318 | memcpy(message_store[0].originator, originator, 6); 319 | memcpy(message_store[0].sender, mac, 6); 320 | message_store[0].id = message_id; 321 | system_soft_wdt_feed(); 322 | // If we are the target 323 | if (memcmp(target, self, 6) == 0) { 324 | // Call user facing received message callback. 325 | receiveCallback(message, false, originator); 326 | } 327 | else { 328 | // Resend message as necessary 329 | if (message_type == 1) { 330 | sendBroadcast(message, originator, message_id); 331 | } 332 | else if (message_type == 2) { 333 | sendTargeted(message, originator, target, message_id); 334 | } 335 | // Call user facing received message callback. 336 | receiveCallback(message, true, originator); 337 | } 338 | } 339 | 340 | // Callback for when message has been sent. 341 | void ICACHE_FLASH_ATTR NowMesh::sendData(unsigned char* mac_addr, unsigned char status) { 342 | // We don't need to do any processing, just call the user facing callback. 343 | sendCallback(status); 344 | } 345 | 346 | // Debug function. 347 | // Debug level settings are in NowMesh.h 348 | void ICACHE_FLASH_ATTR NowMesh::nowmeshDebug(String message, int level) { 349 | if (NOWMESH_DEBUG >= level) { 350 | Serial.println(message); 351 | } 352 | } 353 | 354 | // User facing initialization function 355 | void ICACHE_FLASH_ATTR NowMesh::begin() { 356 | nowmeshDebug("Starting NowMesh", LEVEL_NORMAL); 357 | // Set opmode as access point + station 358 | wifi_set_opmode(3); 359 | // Set channel 360 | wifi_set_channel(CHANNEL); 361 | // Initialize ESP Now and register callbacks 362 | if (esp_now_init() == 0) { 363 | nowmeshDebug("ESP Now init successful", LEVEL_NORMAL); 364 | esp_now_register_send_cb(reinterpret_cast(&NowMesh::sendData)); 365 | esp_now_register_recv_cb(reinterpret_cast(&NowMesh::receiveData)); 366 | esp_now_set_self_role(ESP_NOW_ROLE_SLAVE); 367 | } 368 | else { 369 | nowmeshDebug("ESP Now init failed", LEVEL_ERROR); 370 | } 371 | } 372 | 373 | // User-facing send function for broadcast messages. 374 | void ICACHE_FLASH_ATTR NowMesh::send(String message) { 375 | last_message_id++; 376 | uint8_t self[6]; 377 | wifi_get_macaddr(0, self); 378 | sendBroadcast(message, self, last_message_id); 379 | } 380 | 381 | // User-facing send function for targeted messages. 382 | void ICACHE_FLASH_ATTR NowMesh::send(String message, uint8_t* target) { 383 | last_message_id++; 384 | uint8_t self[6]; 385 | wifi_get_macaddr(0, self); 386 | sendTargeted(message, self, target, last_message_id); 387 | } 388 | -------------------------------------------------------------------------------- /src/NowMesh.h: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | extern "C" { 5 | #include 6 | #include 7 | } 8 | 9 | // WiFi channel 10 | #define CHANNEL 1 11 | 12 | // Number of messages to remember 13 | // If you have a very large mesh and/or very high message quantity, 14 | // you may want to increase STORED_MESSAGES. 15 | #define STORED_MESSAGES 10 16 | // Number of peers to be connected to. 17 | // Any number can be connected to us. 18 | // If you have trouble with messages not reaching their destination, 19 | // try increasing MAX_PEERS 20 | #define MAX_PEERS 10 21 | 22 | // Set NOWMESH_DEBUG to get debugging messages on Serial. 23 | // Each level includes those below it. 24 | #define NOWMESH_DEBUG 0 25 | #define LEVEL_UNLIKELY_ERROR 1 26 | #define LEVEL_ERROR 2 27 | #define LEVEL_NORMAL 3 28 | 29 | // Maximum message length 30 | // 31 | // Message lengths. Add 1 for each character of message sent. 32 | // Minimum Typical Maximum 33 | // broadcast: 28 36 44 34 | // targeted: 28 44 56 35 | #define MAX_MSG_LEN 65 36 | 37 | struct message_info { 38 | uint8_t originator[6]; 39 | uint8_t sender[6]; 40 | uint16_t id; 41 | }; 42 | 43 | struct peer_info { 44 | uint8_t mac[6] = {0, 0, 0, 0, 0, 0}; 45 | int16_t score = 0; 46 | }; 47 | 48 | class NowMesh { 49 | protected: 50 | static message_info message_store[STORED_MESSAGES]; 51 | 52 | static std::function receiveCallback; 53 | static std::function sendCallback; 54 | 55 | static void ICACHE_FLASH_ATTR scanDoneCallback(void* arg, STATUS status); 56 | static void ICACHE_FLASH_ATTR receiveData(unsigned char* mac, unsigned char* data, uint8_t len); 57 | static void ICACHE_FLASH_ATTR sendData(unsigned char* mac_addr, unsigned char status); 58 | 59 | static void ICACHE_FLASH_ATTR nowmeshDebug(String message, int level); 60 | 61 | static int ICACHE_FLASH_ATTR sendMessage(uint8_t* target, char* data); 62 | static int ICACHE_FLASH_ATTR sendBroadcast(String message, uint8_t* originator, uint16_t message_id); 63 | static int ICACHE_FLASH_ATTR sendTargeted(String message, uint8_t* originator, uint8_t* target, uint16_t message_id); 64 | 65 | private: 66 | uint16_t last_message_id = 0; 67 | 68 | public: 69 | NowMesh(); 70 | void ICACHE_FLASH_ATTR begin(); 71 | void ICACHE_FLASH_ATTR setReceiveCallback(std::function callback); 72 | void ICACHE_FLASH_ATTR setSendCallback(std::function callback); 73 | void ICACHE_FLASH_ATTR scanForPeers(); 74 | void ICACHE_FLASH_ATTR send(String message); 75 | void ICACHE_FLASH_ATTR send(String message, uint8_t* target); 76 | }; 77 | --------------------------------------------------------------------------------