├── .gitignore ├── LICENSE ├── README.md └── WifiModem.ino /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/maccasoft/WifiModem/c517d8d9de60b56eb4921ebe539dfc2c5ffbb81a/.gitignore -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # WifiModem 2 | 3 | This is a firmware for the ESP8266 module that emulates an Hayes-compatible modem. 4 | 5 | ## Command set 6 | 7 | | Command | Description | 8 | | ------- | ----------- | 9 | | **A** | Answer incoming call | 10 | | **D** | Connect (dial) to the following host/ip

Examples:

ATDP n.n.n.n[:port]. Connect to IP addres n.n.n.n.
ATDT hostname.com[:port]. Connect to hostname.com.

If not specified, the default port number is 23.| 11 | | **E0** | Will not echo commands to the computer | 12 | | **E1** | Will echo commands to the computer (so one can see what one types if the computer software does not support echo) | 13 | | **H** | On hook. Hangs up the phone, ending any call in progress. | 14 | | **I0** to **I6** | Inquiry, Information, or Interrogation | 15 | | **L** | Speaker loudness (ignored, always returns OK). | 16 | | **M** | Speaker off (ignored, always returns OK). | 17 | | **O** | Return online.
Returns the modem back to the normal connected state after being interrupted by the "+++" escape code. | 18 | | **Q0** or **Q** | Quiet mode off, displays result codes, user sees command responses (e.g. OK) | 19 | | **Q1** | Quiet mode on, result codes are suppressed, user does not see responses. | 20 | | **Sn?** | Display register n value | 21 | | **Sn=r** | Set register n value to r | 22 | | **V0** or **V** | Verbose mode off, display numeric result codes | 23 | | **V1** | Verbose mode on, display english result codes (e.g. CONNECT, NO CARRIER, etc.) | 24 | | **X0** | Disables extended result codes | 25 | | **X1** | Enables extended result codes | 26 | | **Z** | Reset modem to stored configuration | 27 | | **&F** | Restore factory settings | 28 | | **&W** | Store current configuration into eeprom | 29 | 30 | When a call is established, type the escape sequence "+++" to switch to command mode. 31 | 32 | ## EspressIf-compatible commands 33 | 34 | The firmware supports a small subset of the original EspressIf AT commands. 35 | 36 | | Command | Description | 37 | | ------- | ----------- | 38 | | **+UART=baud,data,stop,parity,flow** | Serial port configuration.

**baud** - UART baud rate
**data** - data bits (5-8)
**stop** - stop bits (1-2)
**parity** - 0 (none), 1 (odd), 2 (even)
**flow** - flow control (ignored) | 39 | | **+CWJAP=ssid,pwd** | Connect to access point

**ssid** - string, access point SSID
**pwd** - string, password (ASCII) | 40 | | **+CWQAP** | Disconnect from access point | 41 | | **+CWLAP** | List available access points.

Response: +CWLAP: ecn,ssid,rssi,mac,ch | 42 | | **+CWCIPMUX=mode** | Enable multiple connections or not. Only single connection (mode=0) is supported | 43 | | **+CWCIPSTART=type,addr,port** | Establish a connection to a remote host.

**type** - string, "UDP" only is supported
**addr** - string, remote IP or host name
**port** - number, remote port | 44 | | **+CWCIPSEND=length** | Send data.
Returns ">" to begin receiving the data, when length bytes are received the is are sent. | 45 | | **+CWCIPCLOSE** | Close connection | 46 | 47 | ## S Register definitions 48 | 49 | The firmware allows to set and store all registers from 0 to 255, however only a small number have a meaning. 50 | 51 | | Register | Description | Range | Default | 52 | | -------- | ----------- | ----- | ------- | 53 | | **S0** | Number of rings before Auto-Answer | 0-255 (0=Never) | 0 | 54 | | **S1** | Ring counter | 0-255 rings | 0 | 55 | | **S2** | Escape character | 0-255, ASCII decimal | 43 ("+") | 56 | | **S3** | Carriage Return character | 0-255, ASCII decimal | 13 (Carriage Return) | 57 | | **S4** | Line Feed character | 0-255, ASCII decimal | 10 (Line Feed) | 58 | | **S5** | Backspace character | 0-255, ASCII decimal | 8 (Backspace) | 59 | | **S12** | Escape Code Guard Time | 0–255 fiftieths of a second | 50 (1 second) | 60 | | **S15** | Telnet Protocol | 0=Disable, 1=Enable | 0 | 61 | | **S37** | Desired telco line speed. | 0-11 | 0 | 62 | 63 | By default the module will send and receive its information as fast as the serial connection baud rate allows. 64 | However, if you want the true nostalgic feel of a slow modem connection, you can limit the speed by setting the 65 | "Desired Telco Line Speed" register (S37). Before dialing, issue the command "AT S37=N" where N is an index 66 | defining the desired baud rate: 0=auto (default), 1=75, 2=110, 3=300, 4=600, 5=1200, 6=2400, 7=4800, 8=7200, 9=9600, 10=12000, 11=14400 67 | 68 | ## Credits 69 | 70 | This firmware is based on the [WifiModem](https://github.com/dhansel/WifiModem) code by David Hansel. 71 | 72 | -------------------------------------------------------------------------------- /WifiModem.ino: -------------------------------------------------------------------------------- 1 | // ----------------------------------------------------------------------------- 2 | // WiFi Modem and Telnet Server 3 | // Copyright (C) 2018 David Hansel 4 | // Copyright (C) 2020 Marco Maccaferri 5 | // 6 | // This program is free software; you can redistribute it and/or modify 7 | // it under the terms of the GNU General Public License as published by 8 | // the Free Software Foundation; either version 3 of the License, or 9 | // (at your option) any later version. 10 | // 11 | // This program is distributed in the hope that it will be useful, 12 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | // GNU General Public License for more details. 15 | // 16 | // You should have received a copy of the GNU General Public License 17 | // along with this program; if not, write to the Free Software Foundation, 18 | // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 19 | // ----------------------------------------------------------------------------- 20 | 21 | #include 22 | #include 23 | #include 24 | 25 | 26 | WiFiServer server(23); 27 | WiFiClient modemClient; 28 | WiFiClient telnetClient; 29 | 30 | WiFiUDP udp; 31 | int udpPort; 32 | IPAddress udpAddr; 33 | char packetBuffer[UDP_TX_PACKET_MAX_SIZE]; 34 | 35 | unsigned long lastConnectCheck = 0; 36 | unsigned long prevCharTime = 0; 37 | unsigned long prevRingTime = 0; 38 | uint8_t modemEscapeState = 0, modemExtCodes = 0, modemReg[255]; 39 | bool modemCommandMode = true, modemEcho = true, modemQuiet = false, modemVerbose = true; 40 | 41 | 42 | static int linespeeds[] = {0, 75, 110, 300, 600, 1200, 2400, 4800, 7200, 9600, 12000, 14400}; 43 | #define NSPEEDS (sizeof(linespeeds)/sizeof(int)) 44 | 45 | #define LED_PIN 2 46 | #define DCD_PIN 2 47 | 48 | #define REG_ESC 2 49 | #define REG_CR 3 50 | #define REG_LF 4 51 | #define REG_BSP 5 52 | #define REG_GUARDTIME 12 53 | #define REG_TELNET 15 54 | #define REG_LINESPEED 37 55 | #define REG_CURLINESPEED 43 56 | 57 | #define RING_MILLIS 4500 58 | 59 | enum 60 | { 61 | E_OK = 0, 62 | E_CONNECT, 63 | E_RING, 64 | E_NOCARRIER, 65 | E_ERROR, 66 | E_CONNECT1200, 67 | E_NODIALTONE, 68 | E_BUSY, 69 | E_NOANSWER, 70 | E_CONNECT600, 71 | E_CONNECT2400, 72 | E_CONNECT4800, 73 | E_CONNECT9600, 74 | E_CONNECT14400, 75 | E_CONNECT19200 76 | }; 77 | 78 | 79 | struct TelnetStateStruct 80 | { 81 | uint8_t cmdLen; 82 | uint8_t cmd[4]; 83 | bool sendBinary; 84 | bool receiveBinary; 85 | bool receivedCR; 86 | bool subnegotiation; 87 | } modemTelnetState, clientTelnetState; 88 | 89 | 90 | #define MAGICVAL 0xF0E1D2C3B4A59687 91 | 92 | struct ModemDataStruct 93 | { 94 | uint64_t magic; 95 | 96 | uint32_t baud; 97 | byte bits; 98 | byte parity; 99 | byte stopbits; 100 | byte silent; 101 | byte unused; 102 | char telnetTerminalType[32]; 103 | 104 | uint8_t reg[256]; 105 | } ModemData; 106 | 107 | 108 | SerialConfig GetSerialConfig() 109 | { 110 | if( ModemData.bits==5 && ModemData.parity==0 && ModemData.stopbits==1 ) 111 | return SERIAL_5N1; 112 | else if( ModemData.bits==5 && ModemData.parity==0 && ModemData.stopbits==2 ) 113 | return SERIAL_5N2; 114 | else if( ModemData.bits==5 && ModemData.parity==1 && ModemData.stopbits==1 ) 115 | return SERIAL_5E1; 116 | else if( ModemData.bits==5 && ModemData.parity==1 && ModemData.stopbits==2 ) 117 | return SERIAL_5E2; 118 | else if( ModemData.bits==5 && ModemData.parity==2 && ModemData.stopbits==1 ) 119 | return SERIAL_5O1; 120 | else if( ModemData.bits==5 && ModemData.parity==2 && ModemData.stopbits==2 ) 121 | return SERIAL_5O2; 122 | else if( ModemData.bits==6 && ModemData.parity==0 && ModemData.stopbits==1 ) 123 | return SERIAL_6N1; 124 | else if( ModemData.bits==6 && ModemData.parity==0 && ModemData.stopbits==2 ) 125 | return SERIAL_6N2; 126 | else if( ModemData.bits==6 && ModemData.parity==1 && ModemData.stopbits==1 ) 127 | return SERIAL_6E1; 128 | else if( ModemData.bits==6 && ModemData.parity==1 && ModemData.stopbits==2 ) 129 | return SERIAL_6E2; 130 | else if( ModemData.bits==6 && ModemData.parity==2 && ModemData.stopbits==1 ) 131 | return SERIAL_6O1; 132 | else if( ModemData.bits==6 && ModemData.parity==2 && ModemData.stopbits==2 ) 133 | return SERIAL_6O2; 134 | else if( ModemData.bits==7 && ModemData.parity==0 && ModemData.stopbits==1 ) 135 | return SERIAL_7N1; 136 | else if( ModemData.bits==7 && ModemData.parity==0 && ModemData.stopbits==2 ) 137 | return SERIAL_7N2; 138 | else if( ModemData.bits==7 && ModemData.parity==1 && ModemData.stopbits==1 ) 139 | return SERIAL_7E1; 140 | else if( ModemData.bits==7 && ModemData.parity==1 && ModemData.stopbits==2 ) 141 | return SERIAL_7E2; 142 | else if( ModemData.bits==7 && ModemData.parity==2 && ModemData.stopbits==1 ) 143 | return SERIAL_7O1; 144 | else if( ModemData.bits==7 && ModemData.parity==2 && ModemData.stopbits==2 ) 145 | return SERIAL_7O2; 146 | else if( ModemData.bits==8 && ModemData.parity==0 && ModemData.stopbits==1 ) 147 | return SERIAL_8N1; 148 | else if( ModemData.bits==8 && ModemData.parity==0 && ModemData.stopbits==2 ) 149 | return SERIAL_8N2; 150 | else if( ModemData.bits==8 && ModemData.parity==1 && ModemData.stopbits==1 ) 151 | return SERIAL_8E1; 152 | else if( ModemData.bits==8 && ModemData.parity==1 && ModemData.stopbits==2 ) 153 | return SERIAL_8E2; 154 | else if( ModemData.bits==8 && ModemData.parity==2 && ModemData.stopbits==1 ) 155 | return SERIAL_8O1; 156 | else if( ModemData.bits==8 && ModemData.parity==2 && ModemData.stopbits==2 ) 157 | return SERIAL_8O2; 158 | else 159 | return SERIAL_8N1; 160 | } 161 | 162 | 163 | void applySerialSettings() 164 | { 165 | Serial.flush(); 166 | Serial.end(); 167 | delay(100); 168 | Serial.begin(ModemData.baud, GetSerialConfig()); 169 | } 170 | 171 | 172 | void clearSerialBuffer() 173 | { 174 | // empty the serial buffer 175 | delay(100); 176 | while( Serial.available()>0 ) { Serial.read(); delay(10); } 177 | } 178 | 179 | 180 | void setup() 181 | { 182 | pinMode(LED_PIN, OUTPUT); 183 | digitalWrite(LED_PIN, HIGH); 184 | pinMode(DCD_PIN, OUTPUT); 185 | digitalWrite(DCD_PIN, HIGH); 186 | 187 | // read serial info 188 | EEPROM.begin(1024); 189 | EEPROM.get(0, ModemData); 190 | if( ModemData.magic != MAGICVAL ) 191 | { 192 | // use default settings 193 | memset(&ModemData, 0, sizeof(ModemData)); 194 | ModemData.magic = MAGICVAL; 195 | ModemData.baud = 9600; 196 | ModemData.bits = 8; 197 | ModemData.parity = 0; 198 | ModemData.stopbits = 1; 199 | ModemData.silent = false; 200 | strcpy(ModemData.telnetTerminalType, "vt100"); 201 | EEPROM.put(0, ModemData); 202 | EEPROM.commit(); 203 | } 204 | 205 | // start serial interface 206 | Serial.begin(ModemData.baud); 207 | 208 | // set sdk parameters 209 | if (!WiFi.getAutoConnect() ) WiFi.setAutoConnect(true); 210 | if (!WiFi.getAutoReconnect() ) WiFi.setAutoReconnect(true); 211 | if (!WiFi.getPersistent() ) WiFi.persistent(true); 212 | 213 | // start WiFi interface 214 | WiFi.mode(WIFI_STA); 215 | WiFi.begin(); 216 | 217 | lastConnectCheck = millis(); 218 | 219 | server.begin(); 220 | server.setNoDelay(true); 221 | 222 | resetModemState(); 223 | 224 | // flush serial input buffer 225 | while( Serial.available() ) Serial.read(); 226 | } 227 | 228 | 229 | void resetTelnetState(struct TelnetStateStruct &s) 230 | { 231 | s.cmdLen = 0; 232 | s.sendBinary = false; 233 | s.receiveBinary = false; 234 | s.receivedCR = false; 235 | s.subnegotiation = false; 236 | } 237 | 238 | 239 | void resetModemState() 240 | { 241 | const uint8_t regDefaults[] = {2, '+', 242 | 3, '\r', 243 | 4, '\n', 244 | 5, 8, 245 | 6, 2, 246 | 7, 50, 247 | 8, 2, 248 | 9, 6, 249 | 10, 14, 250 | 11, 95, 251 | 12, 50, 252 | 25, 5, 253 | 38, 20}; 254 | 255 | for(int i=0; i<256; i++) modemReg[i] = 0; 256 | for(int i=0; i1 ) {Serial.print('<'); Serial.print(b, HEX);} 386 | 387 | if( state.cmdLen==0 && b == T_IAC ) 388 | state.cmdLen = 1; 389 | else if( state.cmdLen==1 && b == T_SE ) 390 | { 391 | state.subnegotiation = false; 392 | state.cmdLen = 0; 393 | } 394 | else 395 | state.cmdLen = 0; 396 | 397 | return true; 398 | } 399 | 400 | // ---- handle CR-NUL sequences 401 | 402 | if( state.receivedCR ) 403 | { 404 | state.receivedCR = false; 405 | if( b==0 ) 406 | { 407 | // CR->NUL => CR (i.e. ignore the NUL) 408 | if( modemReg[REG_TELNET]>1 ) Serial.print("<0d<00"); 409 | return true; 410 | } 411 | } 412 | else if( b == 0x0d && state.cmdLen==0 && !state.receiveBinary ) 413 | { 414 | // received CR while not in binary mode => remember but pass through 415 | state.receivedCR = true; 416 | return false; 417 | } 418 | 419 | // ---- handle IAC sequences 420 | 421 | if( state.cmdLen==0 ) 422 | { 423 | // waiting for IAC byte 424 | if( b == T_IAC ) 425 | { 426 | state.cmdLen = 1; 427 | state.cmd[0] = T_IAC; 428 | if( modemReg[REG_TELNET]>1 ) {Serial.print('<'); Serial.print(b, HEX);} 429 | return true; 430 | } 431 | } 432 | else if( state.cmdLen==1 ) 433 | { 434 | if( modemReg[REG_TELNET]>1 ) {Serial.print('<'); Serial.print(b, HEX);} 435 | // received second byte of IAC sequence 436 | if( b == T_IAC ) 437 | { 438 | // IAC->IAC sequence means regular 0xff data value 439 | state.cmdLen = 0; 440 | 441 | // we already skipped the first IAC (0xff), so just return 'false' to pass this one through 442 | return false; 443 | } 444 | else if( b == T_NOP || b == T_BREAK || b == T_GOAHEAD ) 445 | { 446 | // NOP, BREAK, GOAHEAD => do nothing and skip 447 | state.cmdLen = 0; 448 | return true; 449 | } 450 | else if( b == T_SB ) 451 | { 452 | // start of sub-negotiation 453 | state.subnegotiation = true; 454 | state.cmdLen = 0; 455 | return true; 456 | } 457 | else 458 | { 459 | // record second byte of sequence 460 | state.cmdLen = 2; 461 | state.cmd[1] = b; 462 | return true; 463 | } 464 | } 465 | else if( state.cmdLen==2 ) 466 | { 467 | // received third (i.e. last) byte of IAC sequence 468 | if( modemReg[REG_TELNET]>1 ) {Serial.print('<'); Serial.print(b, HEX);} 469 | state.cmd[2] = b; 470 | 471 | bool reply = true; 472 | if( state.cmd[1] == T_WILL ) 473 | { 474 | switch( state.cmd[2] ) 475 | { 476 | case TO_SEND_BINARY: state.cmd[1] = T_DO; state.receiveBinary = true; break; 477 | case TO_ECHO: state.cmd[1] = T_DO; break; 478 | case TO_SUPPRESS_GO_AHEAD: state.cmd[1] = T_DO; break; 479 | default: state.cmd[1] = T_DONT; break; 480 | } 481 | } 482 | else if( state.cmd[1] == T_WONT ) 483 | { 484 | switch( state.cmd[2] ) 485 | { 486 | case TO_SEND_BINARY: state.cmd[1] = T_DO; state.receiveBinary = false; break; 487 | } 488 | state.cmd[1] = T_DONT; 489 | } 490 | else if( state.cmd[1] == T_DO ) 491 | { 492 | switch( state.cmd[2] ) 493 | { 494 | case TO_SEND_BINARY: state.cmd[1] = T_WILL; state.sendBinary = true; break; 495 | case TO_SUPPRESS_GO_AHEAD: state.cmd[1] = T_WILL; break; 496 | case TO_TERMINAL_TYPE: state.cmd[1] = ModemData.telnetTerminalType[0]==0 ? T_WONT : T_WILL; break; 497 | default: state.cmd[1] = T_WONT; break; 498 | } 499 | } 500 | else if( state.cmd[1] == T_DONT ) 501 | { 502 | switch( state.cmd[2] ) 503 | { 504 | case TO_SEND_BINARY: state.cmd[1] = T_WILL; state.sendBinary = false; break; 505 | } 506 | state.cmd[1] = T_WONT; 507 | } 508 | else 509 | reply = false; 510 | 511 | // send reply if necessary 512 | if( reply ) 513 | { 514 | if( modemReg[REG_TELNET]>1 ) 515 | for(int k=0; k<3; k++) {Serial.print('>'); Serial.print(state.cmd[k], HEX);} 516 | 517 | client.write(state.cmd, 3); 518 | 519 | if( state.cmd[1] == T_WILL && state.cmd[2] == TO_TERMINAL_TYPE ) 520 | { 521 | // send terminal-type subnegoatiation sequence 522 | uint8_t buf[110], i, n=0; 523 | buf[n++] = T_IAC; 524 | buf[n++] = T_SB; 525 | buf[n++] = TO_TERMINAL_TYPE; 526 | buf[n++] = 0; // IS 527 | for(i=0; i<100 && ModemData.telnetTerminalType[i]>=32 && ModemData.telnetTerminalType[i]<127; i++) 528 | buf[n++] = ModemData.telnetTerminalType[i]; 529 | buf[n++] = T_IAC; 530 | buf[n++] = T_SE; 531 | client.write(buf, n); 532 | if( modemReg[REG_TELNET]>1 ) 533 | for(int k=0; k'); Serial.print(buf[k], HEX);} 534 | } 535 | } 536 | 537 | // start over 538 | state.cmdLen = 0; 539 | return true; 540 | } 541 | else 542 | { 543 | // invalid state (should never happen) => just reset 544 | state.cmdLen = 0; 545 | } 546 | 547 | return false; 548 | } 549 | 550 | 551 | int strncmpi(const char *s1, const char *s2, size_t cchars) 552 | { 553 | char c1, c2; 554 | 555 | if ( s1==s2 ) 556 | return 0; 557 | 558 | if ( s1==0 ) 559 | return -1; 560 | 561 | if ( s2==0 ) 562 | return 1; 563 | 564 | if ( cchars==0 ) 565 | return 0; 566 | 567 | do { 568 | c1 = toupper(*s1); 569 | c2 = toupper(*s2); 570 | s1++; 571 | s2++; 572 | cchars--; 573 | } while ( (c1 != 0) && (c1 == c2) && (cchars>0) ); 574 | 575 | return (int)(c1 - c2); 576 | } 577 | 578 | 579 | int getConnectStatus() 580 | { 581 | int res; 582 | 583 | if( modemReg[REG_LINESPEED]==0 ) 584 | { 585 | int i = 0; 586 | while( i32 ) 629 | cmd[cmdLen++] = c; 630 | else if( cmdLen>0 && c == modemReg[REG_BSP] ) 631 | cmdLen--; 632 | 633 | if( modemEcho ) 634 | { 635 | if( c == modemReg[REG_BSP] ) 636 | { Serial.print(char(8)); Serial.print(' '); Serial.print(char(8)); } 637 | else 638 | Serial.print(c); 639 | } 640 | 641 | prevCharTime = millis(); 642 | } 643 | 644 | if( cmdLen==2 && toupper(cmd[0])=='A' && cmd[1]=='/' ) 645 | { 646 | c = modemReg[REG_CR]; 647 | cmd[1] = 'T'; 648 | cmdLen = prevCmdLen; 649 | } 650 | 651 | if( c == modemReg[REG_CR] ) 652 | { 653 | while( (millis()-prevCharTime)<100 ) 654 | { 655 | if( Serial.available() ) 656 | { 657 | Serial.read(); 658 | break; 659 | } 660 | } 661 | 662 | prevCmdLen = cmdLen; 663 | if( cmdLen>=2 && toupper(cmd[0])=='A' && toupper(cmd[1])=='T' ) 664 | { 665 | cmd[cmdLen]=0; 666 | int ptr = 2; 667 | bool connecting = false; 668 | int status = E_OK; 669 | while( status!=E_ERROR && ptr0 && Serial.read() == 27 ) break; 1037 | } 1038 | 1039 | WiFi.begin(ssid, key); 1040 | 1041 | // try to connect to WiFi 1042 | uint8_t i = 0; 1043 | while( WiFi.status() != WL_CONNECTED && i++ < 40 ) 1044 | { 1045 | delay(250); 1046 | if( Serial.available()>0 && Serial.read() == 27 ) break; 1047 | } 1048 | 1049 | if( WiFi.status() != WL_CONNECTED ) 1050 | { 1051 | if( i == 41 ) 1052 | status = E_ERROR; 1053 | } 1054 | 1055 | lastConnectCheck = millis(); 1056 | } 1057 | else 1058 | status = E_ERROR; 1059 | } 1060 | else if( strncmpi(cmd+ptr, "CWQAP", 5)==0 ) 1061 | { 1062 | WiFi.disconnect(); 1063 | while( WiFi.status() == WL_CONNECTED ) 1064 | { 1065 | delay(250); 1066 | if( Serial.available()>0 && Serial.read() == 27 ) break; 1067 | } 1068 | } 1069 | else if( strncmpi(cmd+ptr, "CWLAP", 5)==0 ) 1070 | { 1071 | int n = WiFi.scanNetworks(); 1072 | if ( n!=0 ) 1073 | { 1074 | for (int i = 0; i < n; ++i) 1075 | { 1076 | printModemCR(); 1077 | Serial.print("+CWLAP:"); 1078 | Serial.print(WiFi.encryptionType(i)); 1079 | Serial.print(","); 1080 | Serial.print(WiFi.SSID(i)); 1081 | Serial.print(","); 1082 | Serial.print(WiFi.RSSI(i)); 1083 | Serial.print(","); 1084 | Serial.print(WiFi.BSSIDstr(i)); 1085 | Serial.print(","); 1086 | Serial.print(WiFi.channel(i)); 1087 | } 1088 | } 1089 | } 1090 | else if( strncmpi(cmd+ptr, "UART", 4)==0 ) 1091 | { 1092 | ptr += 4; 1093 | int i = getCmdParam(cmd, ptr); 1094 | if ( i!=0 ) 1095 | { 1096 | ModemData.baud = i; 1097 | if( cmd[ptr]==',' ) 1098 | { 1099 | i = getCmdParam(cmd, ptr); 1100 | ModemData.bits = i; 1101 | } 1102 | if( cmd[ptr]==',' ) 1103 | { 1104 | i = getCmdParam(cmd, ptr); 1105 | ModemData.stopbits = i; 1106 | } 1107 | if( cmd[ptr]==',' ) 1108 | { 1109 | i = getCmdParam(cmd, ptr); 1110 | ModemData.parity = i; 1111 | } 1112 | if( cmd[ptr]==',' ) 1113 | { 1114 | getCmdParam(cmd, ptr); 1115 | // Ignore flow control 1116 | } 1117 | printModemResult(E_OK); 1118 | applySerialSettings(); 1119 | status = -1; 1120 | } 1121 | else 1122 | status = E_ERROR; 1123 | } 1124 | else if( strncmpi(cmd+ptr, "CIPMUX", 6)==0 ) 1125 | { 1126 | ptr += 6; 1127 | if( getCmdParam(cmd, ptr) == 0 ) 1128 | { 1129 | printModemResult(E_OK); 1130 | status = -1; 1131 | } 1132 | else 1133 | status = E_ERROR; 1134 | } 1135 | else if( strncmpi(cmd+ptr, "CIPSTART", 8)==0 ) 1136 | { 1137 | char type[32]; 1138 | char host[64]; 1139 | 1140 | ptr += 8; 1141 | status = E_ERROR; 1142 | 1143 | getCmdParam(cmd, type, ptr); 1144 | if( strncmpi(type, "UDP", 3)==0 && cmd[ptr]==',' ) 1145 | { 1146 | getCmdParam(cmd, host, ptr); 1147 | if( cmd[ptr]==',' ) 1148 | { 1149 | udpPort = getCmdParam(cmd, ptr); 1150 | 1151 | status = -1; 1152 | if ( !WiFi.hostByName(host, udpAddr) ) 1153 | { 1154 | if ( !udpAddr.fromString(host) ) 1155 | status = E_ERROR; 1156 | } 1157 | 1158 | if ( status==-1 ) 1159 | { 1160 | udp.stop(); 1161 | udp.begin(udpPort); 1162 | printModemResult(E_OK); 1163 | } 1164 | } 1165 | } 1166 | } 1167 | else if( strncmpi(cmd+ptr, "CIPSEND", 7)==0 ) 1168 | { 1169 | ptr += 7; 1170 | int len = getCmdParam(cmd, ptr); 1171 | if ( len!=0 ) 1172 | { 1173 | printModemResult(E_OK); 1174 | status = E_ERROR; 1175 | 1176 | Serial.print("> "); 1177 | 1178 | int i = 0; 1179 | while ( i=0 ) 1213 | printModemResult(status); 1214 | 1215 | // delay 1 second after a "CONNECT" message 1216 | if( connecting ) delay(1000); 1217 | } 1218 | else if( cmdLen>0 ) 1219 | printModemResult(E_ERROR); 1220 | 1221 | cmdLen = 0; 1222 | } 1223 | } 1224 | 1225 | 1226 | void relayModemData() 1227 | { 1228 | if( modemClient && modemClient.connected() && modemClient.available() ) 1229 | { 1230 | int baud = modemReg[REG_CURLINESPEED]==255 ? ModemData.baud : linespeeds[modemReg[REG_CURLINESPEED]]; 1231 | 1232 | if( baud == ModemData.baud ) 1233 | { 1234 | // use full modem<->computer data rate 1235 | unsigned long t = millis(); 1236 | while( modemClient.available() && Serial.availableForWrite() && millis()-t < 100 ) 1237 | { 1238 | uint8_t b = modemClient.read(); 1239 | if( !handleTelnetProtocol(b, modemClient, modemTelnetState) ) Serial.write(b); 1240 | } 1241 | } 1242 | else if( modemClient.available() && Serial.availableForWrite() ) 1243 | { 1244 | // limit data rate 1245 | static unsigned long nextChar = 0; 1246 | if( millis()>=nextChar ) 1247 | { 1248 | uint8_t b = modemClient.read(); 1249 | if( !handleTelnetProtocol(b, modemClient, modemTelnetState) ) 1250 | { 1251 | Serial.write(b); 1252 | nextChar = millis() + 10000/baud; 1253 | } 1254 | } 1255 | } 1256 | } 1257 | 1258 | if( millis() > prevCharTime + 20*modemReg[REG_GUARDTIME] ) 1259 | { 1260 | if( modemEscapeState==0 ) 1261 | modemEscapeState = 1; 1262 | else if( modemEscapeState==4 ) 1263 | { 1264 | // received [1 second pause] +++ [1 second pause] 1265 | // => switch to command mode 1266 | modemCommandMode = true; 1267 | printModemResult(E_OK); 1268 | } 1269 | } 1270 | 1271 | if( Serial.available() ) 1272 | { 1273 | uint8_t buf[256]; 1274 | int n = 0, millisPerChar = 1000 / (ModemData.baud / (1+ModemData.bits+ModemData.stopbits)) + 1; 1275 | unsigned long startTime = millis(); 1276 | 1277 | if( millisPerChar<5 ) millisPerChar = 5; 1278 | while( Serial.available() && n<256 && millis()-startTime < 100 ) 1279 | { 1280 | uint8_t b = Serial.read(); 1281 | 1282 | if( modemReg[REG_TELNET] ) 1283 | { 1284 | // Telnet protocol handling is enabled 1285 | 1286 | // must duplicate IAC tokens 1287 | if( b==T_IAC ) buf[n++] = b; 1288 | 1289 | // if not sending in binary mode then a stand-alone CR (without LF) must be followd by NUL 1290 | if( !modemTelnetState.sendBinary && n>0 && buf[n-1] == 0x0d && b != 0x0a ) buf[n++] = 0; 1291 | } 1292 | 1293 | buf[n++] = b; 1294 | prevCharTime = millis(); 1295 | 1296 | if( modemEscapeState>=1 && modemEscapeState<=3 && b==modemReg[REG_ESC] ) 1297 | modemEscapeState++; 1298 | else 1299 | modemEscapeState=0; 1300 | 1301 | // wait a short time to see if another character is coming in so we 1302 | // can send multi-character (escape) sequences in the same packet 1303 | // some BBSs don't recognize the sequence if there is too much delay 1304 | while( !Serial.available() && millis()-prevCharTime < millisPerChar ); 1305 | } 1306 | 1307 | // if not sending in binary mode then a stand-alone CR (without LF) must be followd by NUL 1308 | if( modemReg[REG_TELNET] && !modemTelnetState.sendBinary && buf[n-1] == 0x0d && !Serial.available() ) buf[n++] = 0; 1309 | 1310 | modemClient.write(buf, n); 1311 | } 1312 | } 1313 | 1314 | 1315 | void relayTelnetData() 1316 | { 1317 | if (telnetClient.available()) 1318 | { 1319 | //get data from the telnet client and push it to the UART 1320 | unsigned long t = millis(); 1321 | while(telnetClient.available() && Serial.availableForWrite() && millis()-t < 100) 1322 | { 1323 | uint8_t b = telnetClient.read(); 1324 | if( !handleTelnetProtocol(b, telnetClient, clientTelnetState) ) Serial.write(b); 1325 | } 1326 | } 1327 | 1328 | if( millis() > prevCharTime + 20*modemReg[REG_GUARDTIME] ) 1329 | { 1330 | if( modemEscapeState==0 ) 1331 | modemEscapeState = 1; 1332 | else if( modemEscapeState==4 ) 1333 | { 1334 | // received [1 second pause] +++ [1 second pause] 1335 | // => switch to command mode 1336 | modemCommandMode = true; 1337 | printModemResult(E_OK); 1338 | } 1339 | } 1340 | 1341 | //check UART for data 1342 | if( Serial.available() ) 1343 | { 1344 | uint8_t buf[256]; 1345 | int n = 0, millisPerChar = 1000 / (ModemData.baud / (1+ModemData.bits+ModemData.stopbits))+1; 1346 | unsigned long t, startTime = millis(); 1347 | 1348 | if( millisPerChar<5 ) millisPerChar = 5; 1349 | while( Serial.available() && n<256 && millis()-startTime < 100 ) 1350 | { 1351 | uint8_t b = Serial.read(); 1352 | buf[n++] = b; 1353 | prevCharTime = millis(); 1354 | 1355 | // if Telnet protocol handling is enabled then we need to duplicate IAC tokens 1356 | // if they occur in the general data stream 1357 | if( b==T_IAC && modemReg[REG_TELNET] ) buf[n++] = b; 1358 | 1359 | if( modemEscapeState>=1 && modemEscapeState<=3 && b==modemReg[REG_ESC] ) 1360 | modemEscapeState++; 1361 | else 1362 | modemEscapeState=0; 1363 | 1364 | // wait a short time to see if another character is coming in so we 1365 | // can send multi-character (escape) sequences in the same packet 1366 | t = millis(); 1367 | while( !Serial.available() && millis()-t < millisPerChar ); 1368 | } 1369 | 1370 | // push UART data to all connected telnet clients 1371 | if( !modemReg[REG_TELNET] || clientTelnetState.sendBinary ) 1372 | telnetClient.write(buf, n); 1373 | else 1374 | { 1375 | // if sending in telnet non-binary mode then a stand-alone CR (without LF) must be followd by NUL 1376 | uint8_t buf2[512]; 1377 | int j, m = 0; 1378 | for(j=0; j=n-1 || buf[j+1]!=0x0a) ) buf2[m++] = 0; 1382 | } 1383 | telnetClient.write(buf2, m); 1384 | } 1385 | } 1386 | } 1387 | 1388 | void loop() 1389 | { 1390 | if( millis()-lastConnectCheck >= 5000 ) 1391 | { 1392 | if( WiFi.status() != WL_CONNECTED && WiFi.SSID() != "" ) 1393 | { 1394 | digitalWrite(LED_PIN, LOW); 1395 | delay(250); 1396 | digitalWrite(LED_PIN, HIGH); 1397 | } 1398 | lastConnectCheck = millis(); 1399 | } 1400 | 1401 | if( modemClient && modemClient.connected() ) 1402 | { 1403 | // modem is connected. if telnet server has new client then reject 1404 | if( server.hasClient() ) server.available().stop(); 1405 | 1406 | // only relay data if not in command mode 1407 | if( !modemCommandMode ) relayModemData(); 1408 | } 1409 | else if( telnetClient && telnetClient.connected() ) 1410 | { 1411 | // modem is connected. if telnet server has new client then reject 1412 | if( server.hasClient() ) server.available().stop(); 1413 | 1414 | // only relay data if not in command mode 1415 | if( !modemCommandMode ) relayTelnetData(); 1416 | } 1417 | else 1418 | { 1419 | // check whether connection to modem client was lost 1420 | if( !modemCommandMode ) 1421 | { 1422 | if( telnetClient ) telnetClient.stop(); 1423 | if( modemClient ) modemClient.stop(); 1424 | 1425 | digitalWrite(DCD_PIN, HIGH); 1426 | 1427 | modemCommandMode = true; 1428 | modemReg[REG_CURLINESPEED] = 0; 1429 | printModemResult(E_NOCARRIER); 1430 | } 1431 | 1432 | // check if there are any new telnet clients 1433 | if( server.hasClient() ) 1434 | { 1435 | if( millis()-prevRingTime > RING_MILLIS ) 1436 | { 1437 | if( modemReg[1] >= 10 ) 1438 | { 1439 | // failsafe, after 10 rings we are not going to answer... 1440 | server.available().stop(); 1441 | prevRingTime = 0; 1442 | modemReg[1] = 0; 1443 | } 1444 | else 1445 | { 1446 | printModemResult(E_RING); 1447 | prevRingTime = millis(); 1448 | modemReg[1]++; 1449 | } 1450 | } 1451 | 1452 | if( modemReg[0] != 0 && modemReg[1] >= modemReg[0] ) 1453 | { 1454 | // force at least 1 second before responding 1455 | delay(1000); 1456 | 1457 | telnetClient = server.available(); 1458 | int i = getConnectStatus(); 1459 | printModemResult(i); 1460 | digitalWrite(DCD_PIN, LOW); 1461 | 1462 | resetTelnetState(clientTelnetState); 1463 | modemEscapeState=0; 1464 | modemCommandMode = false; 1465 | } 1466 | } 1467 | else 1468 | { 1469 | prevRingTime = 0; 1470 | modemReg[1] = 0; 1471 | } 1472 | } 1473 | 1474 | if( modemCommandMode ) 1475 | { 1476 | int packetSize = udp.parsePacket(); 1477 | if (packetSize) 1478 | { 1479 | int n = udp.read(packetBuffer, UDP_TX_PACKET_MAX_SIZE); 1480 | Serial.print("+IPD,"); 1481 | Serial.print(n); 1482 | Serial.print(":"); 1483 | Serial.write(packetBuffer, n); 1484 | printModemCR(); 1485 | } 1486 | handleModemCommand(); 1487 | } 1488 | } 1489 | --------------------------------------------------------------------------------