├── .gitignore ├── LICENSE ├── README.md └── serial ├── Notes.h ├── esp8266mon-serial.ino ├── functions.h ├── functions.ino └── structures.h /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Compiled Object files 5 | *.slo 6 | *.lo 7 | *.o 8 | *.obj 9 | 10 | # Precompiled Headers 11 | *.gch 12 | *.pch 13 | 14 | # Compiled Dynamic libraries 15 | *.so 16 | *.dylib 17 | *.dll 18 | 19 | # Fortran module files 20 | *.mod 21 | *.smod 22 | 23 | # Compiled Static libraries 24 | *.lai 25 | *.la 26 | *.a 27 | *.lib 28 | 29 | # Executables 30 | *.exe 31 | *.out 32 | *.app 33 | 34 | .vscode* 35 | -------------------------------------------------------------------------------- /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 | # ESP8266mini-sniff 2 | Wifi packet sniffer based on the ESP8266 chipset 3 | 4 | The serial version simply reports details of surrounding Wifi devices to the serial port. 5 | 6 | Credits: 7 | 8 | Original RTOS version https://github.com/espressif/esp8266-rtos-sample-code/tree/master/03Wifi/Sniffer_DEMO/sniffer 9 | 10 | Adapted to Arduino https://github.com/RandDruid/esp8266-deauth , https://github.com/kripthor/WiFiBeaconJam and https://git.schneefux.xyz/schneefux/jimmiejammer 11 | 12 | Code refactor and improvements https://www.hackster.io/rayburne/esp8266-mini-sniff-f6b93a. This version is purely a sniffer that doesnt interfere with Wifi commuication 13 | 14 | This version fixes handling of PROBE packets, further refactors code 15 | This version compiled on Windows 10/Arduino 1.6.5 for Wemos D1 mini but should work on any ESP8266 dev board. 16 | Tested with Expressif SDK version:1.5.4(baaeaebb) 17 | -------------------------------------------------------------------------------- /serial/Notes.h: -------------------------------------------------------------------------------- 1 | // Notes.h tab in Arduino IDE is only for comments and references! 2 | 3 | // based on RandDruid/esp8266-deauth (MIT) https://github.com/RandDruid/esp8266-deauth 4 | // inspired by kripthor/WiFiBeaconJam (no license) https://github.com/kripthor/WiFiBeaconJam 5 | // https://git.schneefux.xyz/schneefux/jimmiejammer/src/master/jimmiejammer.ino 6 | // requires SDK v1.3: install esp8266/Arduino from git and checkout commit 1c5751460b7988041fdc80e0f28a31464cdf97a3 7 | // Modified by M. Ray Burnette for publication as WiFi Sniffer 20161013 8 | /* 9 | Arduino 1.6.12 on Linux Mint 17.3 10 | Sketch uses 227,309 bytes (21%) of program storage space. Maximum is 1,044,464 bytes. 11 | Global variables use 45,196 bytes (55%) of dynamic memory, leaving 36,724 bytes for local variables. Maximum is 81,920 bytes. 12 | 13 | */ 14 | 15 | /* 16 | // beacon template 17 | uint8_t template_beacon[128] = { 0x80, 0x00, 0x00, 0x00, 18 | /*4*/ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 19 | /*10*/ 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 20 | /*16*/ 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 21 | /*22*/ 0xc0, 0x6c, 22 | /*24*/ 0x83, 0x51, 0xf7, 0x8f, 0x0f, 0x00, 0x00, 0x00, 23 | /*32*/ 0x64, 0x00, 24 | /*34*/ 0x01, 0x04, 25 | /* SSID */ 26 | /*36*/ 0x00, 0x06, 0x72, 0x72, 0x72, 0x72, 0x72, 0x72, 27 | 0x01, 0x08, 0x82, 0x84, 28 | 0x8b, 0x96, 0x24, 0x30, 0x48, 0x6c, 0x03, 0x01, 29 | /*56*/ 0x04 30 | }; 31 | * / 32 | 33 | /* Notes: 34 | Ref: http://www.esp8266.com/viewtopic.php?f=32&t=7025 35 | In the ESP8266WiFi.h, there is the function getNetworkInfo() which I presume allows you to get 36 | info for hidden AP. 37 | 38 | bool getNetworkInfo(uint8_t networkItem, String &ssid, uint8_t &encryptionType, int32_t &RSSI, uint8_t* &BSSID, int32_t &channel, bool &isHidden); 39 | CODE: SELECT ALL 40 | /** 41 | loads all infos from a scanned wifi in to the ptr parameters 42 | @param networkItem uint8_t 43 | @param ssid const char* 44 | @param encryptionType uint8_t 45 | @param RSSI int32_t 46 | @param BSSID uint8_t * 47 | @param channel int32_t 48 | @param isHidden bool 49 | @return (true if ok) 50 | */ 51 | 52 | /* Serial Console Sample Output: 53 | ESP8266 mini-sniff by Ray Burnette http://www.hackster.io/rayburne/projects 54 | Type: /-------MAC------/-----WiFi Access Point SSID-----/ /----MAC---/ Chnl RSSI 55 | BEACON: <=============== [ TardisTime] 1afe34a08bc9 8 -76 56 | BEACON: <=============== [ xfinitywifi] 56571a0730c0 11 -90 57 | BEACON: <=============== [ ] 52571a0730c0 11 -91 58 | BEACON: <=============== [ ATTGH6Gs22] 1005b1d6ff90 11 -95 59 | BEACON: <=============== [ ATT4P3G9f8] 1c1448777420 11 -92 60 | BEACON: <=============== [ HOME-30C2] 5c571a0730c0 11 -91 61 | BEACON: <=============== [ ATT8Q4z656] b077acc4dfd0 11 -92 62 | BEACON: <=============== [ HOME-B1C2] 94877c55b1c0 11 -94 63 | BEACON: <=============== [ HUXU2012] 0c54a5d6e480 6 -94 64 | BEACON: <=============== [ xfinitywifi] 0c54a5d6e482 6 -97 65 | BEACON: <=============== [ ] 0c54a5d6e481 6 -96 66 | DEVICE: 18fe34fdc2b8 ==> [ TardisTime] 1afe34a08bc9 8 -79 67 | DEVICE: 18fe34f977a0 ==> [ TardisTime] 1afe34a08bc9 8 -94 68 | DEVICE: 6002b4484f2d ==> [ ATTGH6Gs22] 0180c2000000 11 -98 69 | BEACON: <=============== [ HOME-01FC-2.4] 84002da251d8 6 -100 70 | DEVICE: 503955d34834 ==> [ ATT8Q4z656] 01005e7ffffa 11 -87 71 | BEACON: <=============== [ ] 84002da251d9 6 -98 72 | BEACON: <=============== [ xfinitywifi] 84002da251da 6 -95 73 | BEACON: <=============== [ ] fa8fca34e26c 11 -94 74 | DEVICE: cc0dec048363 ==> [ ATT8Q4z656] 01005e7ffffa 11 -88 75 | BEACON: <=============== [ ] fa8fca95bad3 11 -92 76 | BEACON: <=============== [ HOME-5475] 58238c3b5475 1 -96 77 | BEACON: <=============== [ xfinitywifi] 5a238c3b5477 1 -94 78 | BEACON: <=============== [ ] 5a238c3b5476 1 -96 79 | DEVICE: 1859330bf08e ==> [ ATT8Q4z656] 01005e7ffffa 11 -92 80 | BEACON: <=============== [ ] 92877c55b1c0 11 -92 81 | DEVICE: f45fd47bd5e0 ==> [ ATTGH6Gs22] ffffffffffff 11 -93 82 | BEACON: <=============== [ Lynch] 744401480a27 11 -96 83 | BEACON: <=============== [ xfinitywifi] 96877c55b1c0 11 -93 84 | DEVICE: f43e9d006c10 ==> [ xfinitywifi] 8485066ff726 6 -96 85 | DEVICE: 285aeb4f16bf ==> [ ATTGH6Gs22] 3333ffb3c678 11 -94 86 | DEVICE: 006b9e7fab90 ==> [ ATTGH6Gs22] 01005e7ffffa 11 -91 87 | DEVICE: 78456155b9f0 ==> [ Lynch] 01005e7ffffa 11 -95 88 | DEVICE: 6cadf84a419d ==> [ HOME-30C2] 88cb8787697a 11 -89 89 | BEACON: <=============== [ Verizon-SM-G935V-6526] a608ea306526 11 -92 90 | 91 | 92 | */ 93 | -------------------------------------------------------------------------------- /serial/esp8266mon-serial.ino: -------------------------------------------------------------------------------- 1 | // Credits 2 | // Original RTOS version https://github.com/espressif/esp8266-rtos-sample-code/tree/master/03Wifi/Sniffer_DEMO/sniffer 3 | // Converted to Arduino https://github.com/RandDruid/esp8266-deauth and https://github.com/kripthor/WiFiBeaconJam 4 | // Code refactor and improvements Ray Burnette https://www.hackster.io/rayburne/esp8266-mini-sniff-f6b93a 5 | // This version fixes handling of PROBE packets, further refactors code 6 | // This version compiled on Windows 10/Arduino 1.6.5 for Wemos D1 mini but should work on any ESP8266 28Jul2017 7 | // Tested on SDK version:1.5.4(baaeaebb) 8 | // Using Visual Studio Code and the Arduino extension https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.vscode-arduino 9 | 10 | #include 11 | 12 | 13 | #include "functions.h" 14 | 15 | 16 | #define MAX_APS_TRACKED 50 17 | #define MAX_CLIENTS_TRACKED 100 18 | #undef PRINT_RAW_HEADER // define this to print raw packet headers 19 | #undef PERIODIC //define this to get summary of new and expired entries periodically 20 | 21 | beaconinfo aps_known[MAX_APS_TRACKED]; // Array to save MACs of known APs 22 | int aps_known_count = 0; // Number of known APs 23 | int nothing_new = 0; 24 | clientinfo clients_known[MAX_CLIENTS_TRACKED]; // Array to save MACs of known CLIENTs 25 | int clients_known_count = 0; // Number of known CLIENTs 26 | probeinfo probes_known[MAX_CLIENTS_TRACKED]; // Array to save MACs of known CLIENTs 27 | int probes_known_count = 0; 28 | #define disable 0 29 | #define enable 1 30 | #define MAX_CLIENT_AGE 1000 //age before entry is considered old (seconds) 31 | #define CHECK_INTERVAL 60 // periodic check interval (seconds) 32 | 33 | unsigned int channel = 1; 34 | uint32_t last_check_time, next_check_time; 35 | 36 | 37 | void setup() { 38 | Serial.begin(57600); 39 | Serial.printf("\n\nSDK version:%s\n\r", system_get_sdk_version()); 40 | Serial.println(F("ESP8266 mini-sniff")); 41 | Serial.println(F("Type: /-------MAC------/-----WiFi Access Point SSID-----/ /----MAC---/ Chnl RSSI")); 42 | 43 | wifi_set_opmode(STATION_MODE); // Promiscuous works only with station mode 44 | wifi_set_channel(channel); 45 | wifi_promiscuous_enable(disable); 46 | wifi_set_promiscuous_rx_cb(promisc_cb); // Set up promiscuous callback 47 | wifi_promiscuous_enable(enable); 48 | last_check_time = 0; 49 | next_check_time = last_check_time + CHECK_INTERVAL; 50 | 51 | } 52 | 53 | void loop() { 54 | channel = 1; 55 | wifi_set_channel(channel); 56 | while (true) { 57 | nothing_new++; // Array is not finite, check bounds and adjust if required 58 | if (nothing_new > 200) { 59 | nothing_new = 0; 60 | channel++; 61 | if (channel == 15) break; // Only scan channels 1 to 14 62 | wifi_set_channel(channel); 63 | } 64 | delay(1); // critical processing timeslice for NONOS SDK! No delay(0) yield() 65 | // Press keyboard ENTER in console with NL active to repaint the screen 66 | if ((Serial.available() > 0) && (Serial.read() == '\n')) { 67 | Serial.println("\n-------------------------------------------------------------------------------------\n"); 68 | for (int u = 0; u < clients_known_count; u++) print_client(clients_known[u]); 69 | for (int u = 0; u < aps_known_count; u++) print_beacon(aps_known[u]); 70 | for (int u = 0; u < probes_known_count; u++) print_probe(probes_known[u]); 71 | Serial.println("\n-------------------------------------------------------------------------------------\n"); 72 | 73 | } 74 | 75 | #ifdef PERIODIC 76 | uint32_t now = millis()/1000; 77 | if (now >= next_check_time) { 78 | Serial.println("Periodic "); 79 | 80 | for (int u = 0; u < clients_known_count; u++) { 81 | 82 | if ( !clients_known[u].reported && clients_known[u].last_heard >= last_check_time ) { 83 | Serial.print("New "); 84 | print_client(clients_known[u]); 85 | clients_known[u].reported=1; 86 | 87 | 88 | } else if ( clients_known[u].reported && now > MAX_CLIENT_AGE && 89 | clients_known[u].last_heard <= (last_check_time - MAX_CLIENT_AGE) ) { 90 | Serial.print("Old "); 91 | print_client(clients_known[u]); 92 | clients_known[u].reported=0; 93 | }; 94 | }; 95 | for (int u = 0; u < aps_known_count; u++) { 96 | if ( !aps_known[u].reported && aps_known[u].err == 0 97 | && aps_known[u].last_heard >= last_check_time ) { 98 | 99 | Serial.print("New "); 100 | print_beacon(aps_known[u]); 101 | aps_known[u].reported=1; 102 | 103 | 104 | 105 | } else if ( aps_known[u].reported && aps_known[u].err == 0 && now > MAX_CLIENT_AGE && 106 | aps_known[u].last_heard <= (last_check_time - MAX_CLIENT_AGE) ) { 107 | Serial.print("Old "); 108 | print_beacon(aps_known[u]); 109 | aps_known[u].reported=0; 110 | }; 111 | }; 112 | 113 | 114 | for (int u = 0; u < probes_known_count; u++) { 115 | 116 | if ( !probes_known[u].reported && probes_known[u].last_heard >= last_check_time ) { 117 | Serial.print("New "); 118 | print_probe(probes_known[u]); 119 | probes_known[u].reported=1; 120 | 121 | } else if ( probes_known[u].reported && now > MAX_CLIENT_AGE && 122 | probes_known[u].last_heard <= (last_check_time - MAX_CLIENT_AGE) ) { 123 | Serial.print("Old "); 124 | print_probe(probes_known[u]); 125 | probes_known[u].reported=0; 126 | }; 127 | }; 128 | 129 | last_check_time = now; 130 | next_check_time = now + CHECK_INTERVAL; 131 | }; 132 | #endif 133 | } 134 | 135 | } 136 | 137 | -------------------------------------------------------------------------------- /serial/functions.h: -------------------------------------------------------------------------------- 1 | // include ESP8266 SDK functions 2 | extern "C" { 3 | #include "user_interface.h" 4 | typedef void (*freedom_outside_cb_t)(uint8 status); 5 | int wifi_register_send_pkt_freedom_cb(freedom_outside_cb_t cb); 6 | void wifi_unregister_send_pkt_freedom_cb(void); 7 | int wifi_send_pkt_freedom(uint8 *buf, int len, bool sys_seq); 8 | } 9 | 10 | #include "structures.h" 11 | struct clientinfo parse_data(uint8_t *frame, uint16_t framelen, signed rssi, unsigned channel); 12 | struct beaconinfo parse_beacon(uint8_t *frame, uint16_t framelen, signed rssi); 13 | struct probeinfo parse_probe(uint8_t *frame, uint16_t framelen, signed rssi); 14 | 15 | int register_beacon(beaconinfo beacon); 16 | int register_client(clientinfo ci); 17 | int register_probe(probeinfo pi); 18 | 19 | void print_beacon(beaconinfo beacon); 20 | void print_client(clientinfo ci); 21 | void print_probe(probeinfo ci); 22 | 23 | void print_pkt_header(uint8_t *buf, uint16_t len, char *pkt_type); 24 | 25 | void promisc_cb(uint8_t *buf, uint16_t len); -------------------------------------------------------------------------------- /serial/functions.ino: -------------------------------------------------------------------------------- 1 | //parse out details of client frame 2 | struct clientinfo parse_data(uint8_t *frame, uint16_t framelen, signed rssi, unsigned channel) 3 | { 4 | // takes 36 byte frame control frame 5 | struct clientinfo ci; 6 | ci.channel = channel; 7 | ci.err = 0; 8 | ci.rssi = rssi; 9 | ci.header=frame[0]; 10 | ci.last_heard=millis()/1000; 11 | ci.reported=0; 12 | //int pos = 36; 13 | uint8_t *bssid; 14 | uint8_t *station; 15 | uint8_t *ap; 16 | uint8_t ds; 17 | ds = frame[1] & 3; //Set first 6 bits to 0 18 | switch (ds) { 19 | // p[1] - xxxx xx00 => NoDS p[4]-DST p[10]-SRC p[16]-BSS 20 | case 0: 21 | bssid = frame + 16; 22 | station = frame + 10; 23 | ap = frame + 4; 24 | break; 25 | // p[1] - xxxx xx01 => ToDS p[4]-BSS p[10]-SRC p[16]-DST 26 | case 1: 27 | bssid = frame + 4; 28 | station = frame + 10; 29 | ap = frame + 16; 30 | break; 31 | // p[1] - xxxx xx10 => FromDS p[4]-DST p[10]-BSS p[16]-SRC 32 | case 2: 33 | bssid = frame + 10; 34 | // hack - don't know why it works like this... 35 | if (memcmp(frame + 4, broadcast1, 3) || memcmp(frame + 4, broadcast2, 3) || memcmp(frame + 4, broadcast3, 3)) { 36 | station = frame + 16; 37 | ap = frame + 4; 38 | } else { 39 | station = frame + 4; 40 | ap = frame + 16; 41 | } 42 | break; 43 | // p[1] - xxxx xx11 => WDS p[4]-RCV p[10]-TRM p[16]-DST p[26]-SRC 44 | case 3: 45 | bssid = frame + 10; 46 | station = frame + 4; 47 | ap = frame + 4; 48 | break; 49 | } 50 | 51 | memcpy(ci.station, station, ETH_MAC_LEN); 52 | memcpy(ci.bssid, bssid, ETH_MAC_LEN); 53 | memcpy(ci.ap, ap, ETH_MAC_LEN); 54 | 55 | ci.seq_n = frame[23] * 0xFF + (frame[22] & 0xF0); 56 | return ci; 57 | } 58 | 59 | 60 | 61 | struct beaconinfo parse_beacon(uint8_t *frame, uint16_t framelen, signed rssi) 62 | { 63 | // takes 112 byte beacon frame 64 | struct beaconinfo bi; 65 | bi.ssid_len = 0; 66 | bi.channel = 0; 67 | bi.err = 0; 68 | bi.rssi = rssi; 69 | bi.last_heard=millis()/1000; 70 | bi.reported=0; 71 | bi.header=frame[0]; 72 | int pos = 36; 73 | uint8_t frame_type= (frame[0] & 0x0C)>>2; 74 | uint8_t frame_subtype= (frame[0] & 0xF0)>>4; 75 | if (frame[pos] == 0x00) { 76 | while (pos < framelen) { 77 | switch (frame[pos]) { 78 | case 0x00: //SSID 79 | bi.ssid_len = (int) frame[pos + 1]; 80 | if (bi.ssid_len == 0) { 81 | memset(bi.ssid, '\x00', 33); 82 | break; 83 | } 84 | if (bi.ssid_len < 0) { 85 | bi.err = -1; 86 | break; 87 | } 88 | if (bi.ssid_len > 32) { 89 | bi.err = -2; 90 | break; 91 | } 92 | memset(bi.ssid, '\x00', 33); 93 | memcpy(bi.ssid, frame + pos + 2, bi.ssid_len); 94 | bi.err = 0; // before was error?? 95 | break; 96 | case 0x03: //Channel 97 | bi.channel = (int) frame[pos + 2]; 98 | pos = -1; 99 | break; 100 | default: 101 | break; 102 | } 103 | if (pos < 0) break; 104 | pos += (int) frame[pos + 1] + 2; 105 | } 106 | } else { 107 | bi.err = -3; 108 | } 109 | 110 | bi.capa[0] = frame[34]; 111 | bi.capa[1] = frame[35]; 112 | memcpy(bi.bssid, frame + 10, ETH_MAC_LEN); 113 | return bi; 114 | }; 115 | 116 | struct probeinfo parse_probe(uint8_t *frame, uint16_t framelen, signed rssi) 117 | { 118 | // takes 112 byte probe request frame 119 | struct probeinfo pi; 120 | pi.ssid_len = 0; 121 | pi.channel = 0; 122 | pi.err = 0; 123 | pi.rssi = rssi; 124 | pi.last_heard=millis()/1000; 125 | pi.reported=0; 126 | pi.header=frame[0]; 127 | int pos = 24; 128 | uint8_t frame_type= (frame[0] & 0x0C)>>2; 129 | uint8_t frame_subtype= (frame[0] & 0xF0)>>4; 130 | 131 | if (frame[pos] == 0x00) { 132 | pi.ssid_len = (int) frame[pos + 1]; 133 | if (pi.ssid_len == 0) { 134 | memset(pi.ssid, '\x00', 33); 135 | } 136 | if (pi.ssid_len < 0) { 137 | pi.err = -1; 138 | } 139 | if (pi.ssid_len > 32) { 140 | pi.err = -2; 141 | } 142 | memset(pi.ssid, '\x00', 33); 143 | memcpy(pi.ssid, frame + pos + 2, pi.ssid_len); 144 | pi.err = 0; // before was error?? 145 | } else { 146 | pi.err = -3; 147 | } 148 | 149 | if (pi.err!=0){ 150 | Serial.printf("Error parsing PROBE %d",(int)pi.err); 151 | } 152 | memcpy(pi.ap, frame+4, ETH_MAC_LEN); 153 | memcpy(pi.station, frame+10, ETH_MAC_LEN); 154 | memcpy(pi.bssid, frame+16, ETH_MAC_LEN); 155 | return pi; 156 | } 157 | 158 | 159 | int register_beacon(beaconinfo beacon) 160 | { 161 | // add beacon to list if not already included 162 | int known = 0; // Clear known flag 163 | for (int u = 0; u < aps_known_count; u++) 164 | { 165 | if (! memcmp(aps_known[u].bssid, beacon.bssid, ETH_MAC_LEN)) { 166 | known = 1; 167 | aps_known[u].last_heard = beacon.last_heard; 168 | break; 169 | } // AP known => Set known flag 170 | } 171 | if (! known) // AP is NEW, copy MAC to array and return it 172 | { 173 | memcpy(&aps_known[aps_known_count], &beacon, sizeof(beacon)); 174 | aps_known_count++; 175 | 176 | if ((unsigned int) aps_known_count >= 177 | sizeof (aps_known) / sizeof (aps_known[0]) ) { 178 | Serial.printf("exceeded max aps_known\n"); 179 | aps_known_count = 0; 180 | } 181 | } 182 | return known; 183 | } 184 | 185 | int register_client(clientinfo ci) 186 | { 187 | // add client to list if not already included 188 | int known = 0; // Clear known flag 189 | for (int u = 0; u < clients_known_count; u++) 190 | { 191 | if (! memcmp(clients_known[u].station, ci.station, ETH_MAC_LEN)) { 192 | known = 1; 193 | clients_known[u].last_heard = ci.last_heard; 194 | break; 195 | } 196 | } 197 | if (! known) 198 | { 199 | memcpy(&clients_known[clients_known_count], &ci, sizeof(ci)); 200 | clients_known_count++; 201 | 202 | if ((unsigned int) clients_known_count >= 203 | sizeof (clients_known) / sizeof (clients_known[0]) ) { 204 | Serial.printf("exceeded max clients_known\n"); 205 | clients_known_count = 0; 206 | } 207 | } 208 | return known; 209 | } 210 | 211 | int register_probe(probeinfo pi) 212 | { 213 | //add probe to list if not already included. 214 | int known = 0; // Clear known flag 215 | for (int u = 0; u < probes_known_count; u++) 216 | { 217 | if ((memcmp(probes_known[u].station, pi.station, ETH_MAC_LEN)==0) 218 | && (memcmp(probes_known[u].bssid, pi.bssid, ETH_MAC_LEN)==0 ) 219 | && (strncmp((char*)probes_known[u].ssid, (char*)pi.ssid, sizeof(pi.ssid)) ==0 )) { 220 | known = 1; 221 | probes_known[u].last_heard = pi.last_heard; 222 | break; 223 | } 224 | } 225 | if (! known) 226 | { 227 | memcpy(&probes_known[probes_known_count], &pi, sizeof(pi)); 228 | probes_known_count++; 229 | 230 | if ((unsigned int) probes_known_count >= 231 | sizeof (probes_known) / sizeof (probes_known[0]) ) { 232 | Serial.printf("exceeded max probes_known\n"); 233 | probes_known_count = 0; 234 | } 235 | } 236 | return known; 237 | } 238 | 239 | void print_beacon(beaconinfo beacon) 240 | { 241 | uint64_t now = millis()/1000; 242 | if (beacon.err != 0) { 243 | Serial.printf("BEACON ERR: (%d) \r\n", beacon.err); 244 | } else { 245 | Serial.printf("BEACON: <=============== [%32s] ", beacon.ssid); 246 | for (int i = 0; i < 6; i++) Serial.printf("%02x", beacon.bssid[i]); 247 | //Serial.printf(" %02x", beacon.header); 248 | Serial.printf(" %3d", beacon.channel); 249 | Serial.printf(" %d", (now - beacon.last_heard)); 250 | Serial.printf(" %d", (beacon.reported)); 251 | Serial.printf(" %4d\r\n", beacon.rssi); 252 | 253 | } 254 | } 255 | 256 | void print_client(clientinfo ci) 257 | { 258 | int u = 0; 259 | int known = 0; // Clear known flag 260 | uint64_t now = millis()/1000; 261 | if (ci.err != 0) { 262 | Serial.printf("ci.err %02d", ci.err); 263 | Serial.printf("\r\n"); 264 | } else { 265 | Serial.printf("DEVICE: "); 266 | for (int i = 0; i < 6; i++) Serial.printf("%02x", ci.station[i]); 267 | Serial.printf(" ==> "); 268 | 269 | for (u = 0; u < aps_known_count; u++) 270 | { 271 | if (! memcmp(aps_known[u].bssid, ci.bssid, ETH_MAC_LEN)) { 272 | Serial.printf("[%32s] ", aps_known[u].ssid); 273 | known = 1; // AP known => Set known flag 274 | break; 275 | } 276 | } 277 | 278 | if (! known) { 279 | Serial.printf("[%32s] ", "??"); 280 | }; 281 | for (int i = 0; i < 6; i++) Serial.printf("%02x", ci.bssid[i]); 282 | Serial.printf(" %3d", ci.channel); 283 | Serial.printf(" %d", (now - ci.last_heard)); 284 | Serial.printf(" %d", (ci.reported)); 285 | Serial.printf(" %4d\r\n", ci.rssi); 286 | } 287 | } 288 | 289 | void print_probe(probeinfo ci) 290 | { 291 | int u = 0; 292 | int known = 0; // Clear known flag 293 | uint64_t now = millis()/1000; 294 | if (ci.err != 0) { 295 | Serial.printf("ci.err %02d", ci.err); 296 | Serial.printf("\r\n"); 297 | } else { 298 | Serial.printf("PROBE: "); 299 | for (int i = 0; i < 6; i++) Serial.printf("%02x", ci.station[i]); 300 | Serial.printf(" ==> "); 301 | Serial.printf("[%32s] ", ci.ssid); 302 | for (int i = 0; i < 6; i++) Serial.printf("%02x", ci.bssid[i]); 303 | Serial.printf(" %3d", ci.channel); 304 | Serial.printf(" %d", (now - ci.last_heard)); 305 | Serial.printf(" %d", (ci.reported)); 306 | Serial.printf(" %4d\r\n", ci.rssi); 307 | } 308 | }; 309 | 310 | 311 | void print_pkt_header(uint8_t *buf, uint16_t len, char *pkt_type) 312 | { 313 | char ssid_name[33]; 314 | memset(ssid_name, '\x00', 33); 315 | Serial.printf("%s", pkt_type); 316 | uint8_t frame_control_pkt = buf[12]; // just after the RxControl Structure 317 | uint8_t protocol_version = frame_control_pkt & 0x03; // should always be 0x00 318 | uint8_t frame_type = (frame_control_pkt & 0x0C) >> 2; 319 | uint8_t frame_subtype = (frame_control_pkt & 0xF0) >> 4; 320 | uint8_t ds= buf[13] & 0x3; 321 | 322 | // print the 3 MAC-address fields 323 | Serial.printf("%02x %02x %02x ", frame_type, frame_subtype, ds); 324 | if (len<35) { 325 | Serial.printf("Short Packet!! %d\r\n",len); 326 | return; 327 | } 328 | for (int n = 16; n < 22; n++) { 329 | Serial.printf("%02x", buf[n]); 330 | }; 331 | Serial.print(" "); 332 | for (int n = 22; n < 28; n++) { 333 | Serial.printf("%02x", buf[n]); 334 | }; 335 | Serial.print(" "); 336 | for (int n = 28; n < 34; n++) { 337 | Serial.printf("%02x", buf[n]); 338 | }; 339 | //ACTION frames are 112 long but contain nothing useful 340 | if (len>=112 && !( frame_type==0 && frame_subtype==13)) { 341 | 342 | int pos=49; 343 | if (frame_type==0 && frame_subtype==4) { 344 | pos=37; // probe request frames 345 | } 346 | 347 | int bssid_len=(int) buf[pos]; 348 | if(bssid_len<0 || bssid_len>32) { 349 | Serial.printf(" Bad ssid len %d!!\r\n",bssid_len); 350 | return; 351 | }; 352 | if (bssid_len==0) { 353 | Serial.print(" "); 354 | } else { 355 | memcpy(ssid_name,&(buf[pos+1]),bssid_len); 356 | Serial.printf(" %s",ssid_name); 357 | }; 358 | Serial.printf(":%d %d %d ",(int)buf[pos+bssid_len+1],(int)buf[pos+bssid_len+2],(int)buf[pos+bssid_len+3]); 359 | 360 | }; 361 | Serial.print("\r\n"); 362 | } 363 | 364 | void promisc_cb(uint8_t *buf, uint16_t len) 365 | { 366 | int i = 0; 367 | uint16_t seq_n_new = 0; 368 | #ifdef PRINT_RAW_HEADER 369 | if (len >= 35) { 370 | uint8_t frame_control_pkt = buf[12]; // just after the RxControl Structure 371 | uint8_t protocol_version = frame_control_pkt & 0x03; // should always be 0x00 372 | uint8_t frame_type = (frame_control_pkt & 0x0C) >> 2; 373 | uint8_t frame_subtype = (frame_control_pkt & 0xF0) >> 4; 374 | 375 | struct control_frame *cf=(struct control_frame *)&buf[12]; 376 | 377 | switch (cf->type) { 378 | case 0: 379 | switch (cf->subtype) { 380 | case 0: 381 | print_pkt_header(buf,len,"ASREQ:"); 382 | break; 383 | case 1: 384 | print_pkt_header(buf,len,"ASRSP:"); 385 | break; 386 | case 2: 387 | print_pkt_header(buf,len,"RSRSP:"); 388 | break; 389 | case 3: 390 | print_pkt_header(buf,len,"RSRSP:"); 391 | break; 392 | case 4: 393 | print_pkt_header(buf,len,"PRREQ:"); 394 | break; 395 | case 5: 396 | print_pkt_header(buf,len,"PRRSP:"); 397 | break; 398 | case 8: 399 | print_pkt_header(buf,len,"BECON:"); 400 | break; 401 | case 9: 402 | print_pkt_header(buf,len,"ATIM :"); 403 | break; 404 | case 10: 405 | print_pkt_header(buf,len,"DASSO:"); 406 | break; 407 | case 11: 408 | print_pkt_header(buf,len,"AUTH :"); 409 | break; 410 | case 12: 411 | print_pkt_header(buf,len,"DAUTH:"); 412 | break; 413 | case 13: 414 | print_pkt_header(buf,len,"ACTON:"); 415 | break; 416 | default: 417 | print_pkt_header(buf,len,"MGMT?:"); 418 | break; 419 | }; 420 | break; 421 | case 1: 422 | print_pkt_header(buf,len,"CONTR:"); 423 | break; 424 | case 2: 425 | print_pkt_header(buf,len,"DATA :"); 426 | break; 427 | default: 428 | print_pkt_header(buf,len,"UNKNOW:"); 429 | } 430 | 431 | } 432 | #endif 433 | 434 | if (len == 12) { 435 | struct RxControl *sniffer = (struct RxControl*) buf; 436 | } else if (len == 128) { 437 | uint8_t frame_control_pkt = buf[12]; // just after the RxControl Structure 438 | uint8_t frame_type = (frame_control_pkt & 0x0C) >> 2; 439 | uint8_t frame_subtype = (frame_control_pkt & 0xF0) >> 4; 440 | struct sniffer_buf2 *sniffer = (struct sniffer_buf2*) buf; 441 | if (frame_type == 0 && (frame_subtype == 8 || frame_subtype == 5)) 442 | { 443 | struct beaconinfo beacon = parse_beacon(sniffer->buf, 112, sniffer->rx_ctrl.rssi); 444 | if (register_beacon(beacon) == 0) 445 | { 446 | print_beacon(beacon); 447 | nothing_new = 0; 448 | }; 449 | } else if (frame_type ==0 && frame_subtype==4) { 450 | struct probeinfo probe = parse_probe(sniffer->buf, 112, sniffer->rx_ctrl.rssi); 451 | if (register_probe(probe) == 0) 452 | { 453 | print_probe(probe); 454 | nothing_new = 0; 455 | }; 456 | } else { 457 | print_pkt_header(buf,112,"UKNOWN:"); 458 | }; 459 | } else { 460 | struct sniffer_buf *sniffer = (struct sniffer_buf*) buf; 461 | struct clientinfo ci = parse_data(sniffer->buf, 36, sniffer->rx_ctrl.rssi, sniffer->rx_ctrl.channel); 462 | if (register_client(ci) == 0) { 463 | print_client(ci); 464 | nothing_new = 0; 465 | } 466 | } 467 | } 468 | -------------------------------------------------------------------------------- /serial/structures.h: -------------------------------------------------------------------------------- 1 | // This-->tab == "structures.h" 2 | 3 | #define ETH_MAC_LEN 6 4 | 5 | uint8_t broadcast1[3] = { 0x01, 0x00, 0x5e }; 6 | uint8_t broadcast2[6] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }; 7 | uint8_t broadcast3[3] = { 0x33, 0x33, 0x00 }; 8 | 9 | struct beaconinfo 10 | { 11 | uint8_t bssid[ETH_MAC_LEN]; 12 | uint8_t ssid[33]; 13 | int ssid_len; 14 | int channel; 15 | int err; 16 | signed rssi; 17 | uint8_t capa[2]; 18 | uint32_t last_heard; 19 | uint8_t reported; 20 | uint8_t header; 21 | }; 22 | 23 | struct clientinfo 24 | { 25 | uint8_t bssid[ETH_MAC_LEN]; 26 | uint8_t station[ETH_MAC_LEN]; 27 | uint8_t ap[ETH_MAC_LEN]; 28 | int channel; 29 | int err; 30 | signed rssi; 31 | uint16_t seq_n; 32 | /* rpw additions */ 33 | uint8_t header; 34 | uint32_t last_heard; 35 | uint8_t reported; 36 | }; 37 | 38 | struct probeinfo 39 | { 40 | uint8_t bssid[ETH_MAC_LEN]; 41 | uint8_t station[ETH_MAC_LEN]; 42 | uint8_t ap[ETH_MAC_LEN]; 43 | uint8_t ssid[33]; 44 | int ssid_len; 45 | int channel; 46 | int err; 47 | signed rssi; 48 | uint16_t seq_n; 49 | /* rpw additions */ 50 | uint8_t header; 51 | uint32_t last_heard; 52 | uint8_t reported; 53 | }; 54 | 55 | /* ============================================== 56 | Promiscous callback structures, see ESP manual 57 | ============================================== */ 58 | struct RxControl { 59 | signed rssi: 8; 60 | unsigned rate: 4; 61 | unsigned is_group: 1; 62 | unsigned: 1; 63 | unsigned sig_mode: 2; 64 | unsigned legacy_length: 12; 65 | unsigned damatch0: 1; 66 | unsigned damatch1: 1; 67 | unsigned bssidmatch0: 1; 68 | unsigned bssidmatch1: 1; 69 | unsigned MCS: 7; 70 | unsigned CWB: 1; 71 | unsigned HT_length: 16; 72 | unsigned Smoothing: 1; 73 | unsigned Not_Sounding: 1; 74 | unsigned: 1; 75 | unsigned Aggregation: 1; 76 | unsigned STBC: 2; 77 | unsigned FEC_CODING: 1; 78 | unsigned SGI: 1; 79 | unsigned rxend_state: 8; 80 | unsigned ampdu_cnt: 8; 81 | unsigned channel: 4; 82 | unsigned: 12; 83 | }; 84 | 85 | struct LenSeq { 86 | uint16_t length; 87 | uint16_t seq; 88 | uint8_t address3[6]; 89 | }; 90 | 91 | struct sniffer_buf { 92 | struct RxControl rx_ctrl; 93 | uint8_t buf[36]; 94 | uint16_t cnt; 95 | struct LenSeq lenseq[1]; 96 | }; 97 | 98 | struct sniffer_buf2 { 99 | struct RxControl rx_ctrl; 100 | uint8_t buf[112]; 101 | uint16_t cnt; 102 | uint16_t len; 103 | }; 104 | struct control_frame { 105 | unsigned int ver :2; // protocol version (should be 0x0) 106 | unsigned int type : 2; //0x0= Management, 0x1=Control, 0x2=Data 107 | unsigned int subtype : 4; 108 | 109 | } ; 110 | --------------------------------------------------------------------------------