├── .github ├── FUNDING.yml └── workflows │ └── main.yml ├── .gitignore ├── LICENSE ├── README.md ├── doc └── img │ ├── config.png │ ├── debug.png │ ├── esp32-xy017.png │ ├── home.png │ └── status.png ├── include ├── README ├── config.h ├── debug.h └── pages.h ├── lib └── README ├── platformio.ini ├── src ├── config.cpp ├── debug.cpp ├── main.cpp └── pages.cpp └── test └── README /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [zivillian] 4 | custom: ['https://paypal.me/zivillian'] 5 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: PlatformIO CI 2 | 3 | on: [push, workflow_dispatch] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v3 12 | - uses: actions/cache@v3 13 | with: 14 | path: | 15 | ~/.cache/pip 16 | ~/.platformio/.cache 17 | key: ${{ runner.os }}-pio 18 | - uses: actions/setup-python@v4 19 | with: 20 | python-version: '3.9' 21 | - name: Install PlatformIO Core 22 | run: pip install --upgrade platformio 23 | 24 | - name: Build PlatformIO Project 25 | run: pio run -e esp32release 26 | - name: Upload artifacts 27 | uses: actions/upload-artifact@v3 28 | with: 29 | name: image 30 | path: .pio/build/esp32release/firmware.bin 31 | 32 | - name: Build PlatformIO Project 33 | run: pio run -e esp32debug 34 | - name: Upload artifacts 35 | uses: actions/upload-artifact@v3 36 | with: 37 | name: debug 38 | path: .pio/build/esp32debug/firmware.bin 39 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .pio 2 | .vscode -------------------------------------------------------------------------------- /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 | # ESP32 Modbus RTU/TCP Gateway 2 | 3 | A generic firmware for an ESP32 to be used as a Modbus TCP/IP gateway for any modbus RTU device. 4 | Default RX/TX pins for the TTL-RS485 communication are used from hardware-serial2 (check pinout of your esp32-board for UART2-TX and UART2-RX). 5 | If you like to use different RX/TX pins, you can define them as build_flags in the platformio.ini. 6 | E.g.: 7 | build_flags = -DRX_PIN=14 -DTX_PIN=5 8 | 9 | ## State 10 | 11 | It work's for me, but there's room for improvement. If you have an idea please open an issue - if you can improve anything just create a PR. 12 | 13 | 14 | ## Hardware 15 | 16 | ### ESP32 NodeMCU + XY-017 TTL-RS485 Board with automatic flow control 17 | ![Home](doc/img/esp32-xy017.png) 18 | 19 | 20 | ## Screenshots 21 | 22 | ### Home 23 | 24 | ![Home](doc/img/home.png) 25 | 26 | ### Status 27 | 28 | ![Status](doc/img/status.png) 29 | 30 | ### Config 31 | 32 | ![Config](doc/img/config.png) 33 | 34 | ### Debug 35 | 36 | ![Debug](doc/img/debug.png) 37 | -------------------------------------------------------------------------------- /doc/img/config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zivillian/esp32-modbus-gateway/c79f81e40644f5bb4a1e59c29ed3fb508bf694c5/doc/img/config.png -------------------------------------------------------------------------------- /doc/img/debug.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zivillian/esp32-modbus-gateway/c79f81e40644f5bb4a1e59c29ed3fb508bf694c5/doc/img/debug.png -------------------------------------------------------------------------------- /doc/img/esp32-xy017.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zivillian/esp32-modbus-gateway/c79f81e40644f5bb4a1e59c29ed3fb508bf694c5/doc/img/esp32-xy017.png -------------------------------------------------------------------------------- /doc/img/home.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zivillian/esp32-modbus-gateway/c79f81e40644f5bb4a1e59c29ed3fb508bf694c5/doc/img/home.png -------------------------------------------------------------------------------- /doc/img/status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zivillian/esp32-modbus-gateway/c79f81e40644f5bb4a1e59c29ed3fb508bf694c5/doc/img/status.png -------------------------------------------------------------------------------- /include/README: -------------------------------------------------------------------------------- 1 | 2 | This directory is intended for project header files. 3 | 4 | A header file is a file containing C declarations and macro definitions 5 | to be shared between several project source files. You request the use of a 6 | header file in your project source file (C, C++, etc) located in `src` folder 7 | by including it, with the C preprocessing directive `#include'. 8 | 9 | ```src/main.c 10 | 11 | #include "header.h" 12 | 13 | int main (void) 14 | { 15 | ... 16 | } 17 | ``` 18 | 19 | Including a header file produces the same results as copying the header file 20 | into each source file that needs it. Such copying would be time-consuming 21 | and error-prone. With a header file, the related declarations appear 22 | in only one place. If they need to be changed, they can be changed in one 23 | place, and programs that include the header file will automatically use the 24 | new version when next recompiled. The header file eliminates the labor of 25 | finding and changing all the copies as well as the risk that a failure to 26 | find one copy will result in inconsistencies within a program. 27 | 28 | In C, the usual convention is to give header files names that end with `.h'. 29 | It is most portable to use only letters, digits, dashes, and underscores in 30 | header file names, and at most one dot. 31 | 32 | Read more about using header files in official GCC documentation: 33 | 34 | * Include Syntax 35 | * Include Operation 36 | * Once-Only Headers 37 | * Computed Includes 38 | 39 | https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html 40 | -------------------------------------------------------------------------------- /include/config.h: -------------------------------------------------------------------------------- 1 | #ifndef CONFIG_H 2 | #define CONFIG_H 3 | #include 4 | #include 5 | #define debugSerial Serial 6 | #define modbusSerial Serial2 7 | #define DEBUG 8 | 9 | class Config{ 10 | private: 11 | Preferences *_prefs; 12 | int16_t _tcpPort; 13 | uint32_t _tcpTimeout; 14 | unsigned long _modbusBaudRate; 15 | uint32_t _modbusConfig; 16 | int8_t _modbusRtsPin; 17 | unsigned long _serialBaudRate; 18 | uint32_t _serialConfig; 19 | String _webPassword; 20 | public: 21 | Config(); 22 | void begin(Preferences *prefs); 23 | uint16_t getTcpPort(); 24 | void setTcpPort(uint16_t value); 25 | uint32_t getTcpTimeout(); 26 | void setTcpTimeout(uint32_t value); 27 | uint32_t getModbusConfig(); 28 | unsigned long getModbusBaudRate(); 29 | void setModbusBaudRate(unsigned long value); 30 | uint8_t getModbusDataBits(); 31 | void setModbusDataBits(uint8_t value); 32 | uint8_t getModbusParity(); 33 | void setModbusParity(uint8_t value); 34 | uint8_t getModbusStopBits(); 35 | void setModbusStopBits(uint8_t value); 36 | int8_t getModbusRtsPin(); 37 | void setModbusRtsPin(int8_t value); 38 | uint32_t getSerialConfig(); 39 | unsigned long getSerialBaudRate(); 40 | void setSerialBaudRate(unsigned long value); 41 | uint8_t getSerialDataBits(); 42 | void setSerialDataBits(uint8_t value); 43 | uint8_t getSerialParity(); 44 | void setSerialParity(uint8_t value); 45 | uint8_t getSerialStopBits(); 46 | void setSerialStopBits(uint8_t value); 47 | String getWebPassword(); 48 | void setWebPassword(String value); 49 | }; 50 | #ifdef DEBUG 51 | #define dbg(x...) debugSerial.print(x); 52 | #define dbgln(x...) debugSerial.println(x); 53 | #else /* DEBUG */ 54 | #define dbg(x...) ; 55 | #define dbgln(x...) ; 56 | #endif /* DEBUG */ 57 | #endif /* CONFIG_H */ -------------------------------------------------------------------------------- /include/debug.h: -------------------------------------------------------------------------------- 1 | #ifndef DEBUG_H 2 | #define DEBUG_H 3 | 4 | #include 5 | #include 6 | class WebPrint:public Print{ 7 | private: 8 | Print *_serial; 9 | AsyncResponseStream *_response; 10 | String escapeAmp(String text); 11 | String escapeLt(String text); 12 | String escape(String buffer, char oldValue, String newValue); 13 | public: 14 | WebPrint(Print *serial, AsyncResponseStream *reponse); 15 | size_t write(uint8_t) override; 16 | size_t write(const uint8_t *buffer, size_t size) override; 17 | }; 18 | 19 | #endif -------------------------------------------------------------------------------- /include/pages.h: -------------------------------------------------------------------------------- 1 | #ifndef PAGES_H 2 | #define PAGES_H 3 | 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include "config.h" 10 | #include "debug.h" 11 | 12 | void setupPages(AsyncWebServer* server, ModbusClientRTU *rtu, ModbusBridgeWiFi *bridge, Config *config, WiFiManager *wm); 13 | void sendResponseHeader(AsyncResponseStream *response, const char *title, bool inlineStyle = false); 14 | void sendResponseTrailer(AsyncResponseStream *response); 15 | void sendButton(AsyncResponseStream *response, const char *title, const char *action, const char *css = ""); 16 | void sendTableRow(AsyncResponseStream *response, const char *name, uint32_t value); 17 | void sendTableRow(AsyncResponseStream *response, const char *name, String value); 18 | void sendDebugForm(AsyncResponseStream *response, String slaveId, String reg, String function, String count); 19 | void sendMinCss(AsyncResponseStream *response); 20 | const String ErrorName(Modbus::Error code); 21 | const String WiFiQuality(int rssiValue); 22 | #endif /* PAGES_H */ -------------------------------------------------------------------------------- /lib/README: -------------------------------------------------------------------------------- 1 | 2 | This directory is intended for project specific (private) libraries. 3 | PlatformIO will compile them to static libraries and link into executable file. 4 | 5 | The source code of each library should be placed in a an own separate directory 6 | ("lib/your_library_name/[here are source files]"). 7 | 8 | For example, see a structure of the following two libraries `Foo` and `Bar`: 9 | 10 | |--lib 11 | | | 12 | | |--Bar 13 | | | |--docs 14 | | | |--examples 15 | | | |--src 16 | | | |- Bar.c 17 | | | |- Bar.h 18 | | | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html 19 | | | 20 | | |--Foo 21 | | | |- Foo.c 22 | | | |- Foo.h 23 | | | 24 | | |- README --> THIS FILE 25 | | 26 | |- platformio.ini 27 | |--src 28 | |- main.c 29 | 30 | and a contents of `src/main.c`: 31 | ``` 32 | #include 33 | #include 34 | 35 | int main (void) 36 | { 37 | ... 38 | } 39 | 40 | ``` 41 | 42 | PlatformIO Library Dependency Finder will find automatically dependent 43 | libraries scanning project source files. 44 | 45 | More information about PlatformIO Library Dependency Finder 46 | - https://docs.platformio.org/page/librarymanager/ldf.html 47 | -------------------------------------------------------------------------------- /platformio.ini: -------------------------------------------------------------------------------- 1 | ; PlatformIO Project Configuration File 2 | ; 3 | ; Build options: build flags, source filter 4 | ; Upload options: custom upload port, speed and extra flags 5 | ; Library options: dependencies, extra library storages 6 | ; Advanced options: extra scripting 7 | ; 8 | ; Please visit documentation for the other options and examples 9 | ; https://docs.platformio.org/page/projectconf.html 10 | 11 | [platformio] 12 | default_envs = esp32debug 13 | 14 | [env] 15 | platform = espressif32 16 | framework = arduino 17 | lib_deps = 18 | https://github.com/PBRunot/WiFiManager.git#0404abde0d9d2da5c09be7d0cc669b1188bb1c81 19 | https://github.com/me-no-dev/ESPAsyncWebServer.git 20 | https://github.com/eModbus/eModbus.git#ed343224827600409e4d57e77e60b73ff9c22f1a 21 | SPI 22 | build_flags = -Wall -Werror -DLOG_LEVEL=LOG_LEVEL_DEBUG 23 | monitor_speed = 115200 24 | 25 | [env:esp32release] 26 | board = esp32dev 27 | build_flags = ${env.build_flags} 28 | 29 | [env:esp32debug] 30 | board = esp32dev 31 | build_flags = ${env.build_flags} 32 | 33 | [env:olimex-poe] 34 | board = esp32-poe 35 | build_flags = ${env.build_flags} -DRX_PIN=14 -DTX_PIN=5 36 | upload_port = COM9 37 | monitor_port = COM9 38 | 39 | [env:d1mini] 40 | board = wemos_d1_mini32 41 | build_flags = ${env.build_flags} 42 | -------------------------------------------------------------------------------- /src/config.cpp: -------------------------------------------------------------------------------- 1 | #include "config.h" 2 | 3 | Config::Config() 4 | :_prefs(NULL) 5 | ,_tcpPort(502) 6 | ,_tcpTimeout(10000) 7 | ,_modbusBaudRate(9600) 8 | ,_modbusConfig(SERIAL_8N1) 9 | ,_modbusRtsPin(-1) 10 | ,_serialBaudRate(115200) 11 | ,_serialConfig(SERIAL_8N1) 12 | ,_webPassword("") 13 | {} 14 | 15 | void Config::begin(Preferences *prefs) 16 | { 17 | _prefs = prefs; 18 | _tcpPort = _prefs->getUShort("tcpPort", _tcpPort); 19 | _tcpTimeout = _prefs->getULong("tcpTimeout", _tcpTimeout); 20 | _modbusBaudRate = _prefs->getULong("modbusBaudRate", _modbusBaudRate); 21 | _modbusConfig = _prefs->getULong("modbusConfig", _modbusConfig); 22 | _modbusRtsPin = _prefs->getChar("modbusRtsPin", _modbusRtsPin); 23 | _serialBaudRate = _prefs->getULong("serialBaudRate", _serialBaudRate); 24 | _serialConfig = _prefs->getULong("serialConfig", _serialConfig); 25 | _webPassword = _prefs->getString("webPassword", _webPassword); 26 | } 27 | 28 | uint16_t Config::getTcpPort(){ 29 | return _tcpPort; 30 | } 31 | 32 | void Config::setTcpPort(uint16_t value){ 33 | if (_tcpPort == value) return; 34 | _tcpPort = value; 35 | _prefs->putUShort("tcpPort", _tcpPort); 36 | } 37 | 38 | uint32_t Config::getTcpTimeout(){ 39 | return _tcpTimeout; 40 | } 41 | 42 | void Config::setTcpTimeout(uint32_t value){ 43 | if (_tcpTimeout == value) return; 44 | _tcpTimeout = value; 45 | _prefs->putULong("tcpTimeout", _tcpTimeout); 46 | } 47 | 48 | uint32_t Config::getModbusConfig(){ 49 | return _modbusConfig; 50 | } 51 | 52 | unsigned long Config::getModbusBaudRate(){ 53 | return _modbusBaudRate; 54 | } 55 | 56 | void Config::setModbusBaudRate(unsigned long value){ 57 | if (_modbusBaudRate == value) return; 58 | _modbusBaudRate = value; 59 | _prefs->putULong("modbusBaudRate", _modbusBaudRate); 60 | } 61 | 62 | uint8_t Config::getModbusDataBits(){ 63 | return ((_modbusConfig & 0xc) >> 2) + 5; 64 | } 65 | 66 | void Config::setModbusDataBits(uint8_t value){ 67 | auto dataBits = getModbusDataBits(); 68 | value -= 5; 69 | value = (value << 2) & 0xc; 70 | if (value == dataBits) return; 71 | _modbusConfig = (_modbusConfig & 0xfffffff3) | value; 72 | _prefs->putULong("modbusConfig", _modbusConfig); 73 | } 74 | 75 | uint8_t Config::getModbusParity(){ 76 | return _modbusConfig & 0x3; 77 | } 78 | 79 | void Config::setModbusParity(uint8_t value){ 80 | auto parity = getModbusParity(); 81 | value = value & 0x3; 82 | if (parity == value) return; 83 | _modbusConfig = (_modbusConfig & 0xfffffffc) | value; 84 | _prefs->putULong("modbusConfig", _modbusConfig); 85 | } 86 | 87 | uint8_t Config::getModbusStopBits(){ 88 | return (_modbusConfig & 0x30) >> 4; 89 | } 90 | 91 | void Config::setModbusStopBits(uint8_t value){ 92 | auto stopbits = getModbusStopBits(); 93 | value = (value << 4) & 0x30; 94 | if (stopbits == value) return; 95 | _modbusConfig = (_modbusConfig & 0xffffffcf) | value; 96 | _prefs->putULong("modbusConfig", _modbusConfig); 97 | } 98 | 99 | int8_t Config::getModbusRtsPin(){ 100 | return _modbusRtsPin; 101 | } 102 | 103 | void Config::setModbusRtsPin(int8_t value){ 104 | if (_modbusRtsPin == value) return; 105 | _modbusRtsPin = value; 106 | _prefs->putChar("modbusRtsPin", _modbusRtsPin); 107 | } 108 | 109 | uint32_t Config::getSerialConfig(){ 110 | return _serialConfig; 111 | } 112 | 113 | unsigned long Config::getSerialBaudRate(){ 114 | return _serialBaudRate; 115 | } 116 | 117 | void Config::setSerialBaudRate(unsigned long value){ 118 | if (_serialBaudRate == value) return; 119 | _serialBaudRate = value; 120 | _prefs->putULong("serialBaudRate", _serialBaudRate); 121 | } 122 | 123 | uint8_t Config::getSerialDataBits(){ 124 | return ((_serialConfig & 0xc) >> 2) + 5; 125 | } 126 | 127 | void Config::setSerialDataBits(uint8_t value){ 128 | auto dataBits = getSerialDataBits(); 129 | value -= 5; 130 | value = (value << 2) & 0xc; 131 | if (value == dataBits) return; 132 | _serialConfig = (_serialConfig & 0xfffffff3) | value; 133 | _prefs->putULong("serialConfig", _serialConfig); 134 | } 135 | 136 | uint8_t Config::getSerialParity(){ 137 | return _serialConfig & 0x3; 138 | } 139 | 140 | void Config::setSerialParity(uint8_t value){ 141 | auto parity = getSerialParity(); 142 | value = value & 0x3; 143 | if (parity == value) return; 144 | _serialConfig = (_serialConfig & 0xfffffffc) | value; 145 | _prefs->putULong("serialConfig", _serialConfig); 146 | } 147 | 148 | uint8_t Config::getSerialStopBits(){ 149 | return (_serialConfig & 0x30) >> 4; 150 | } 151 | 152 | void Config::setSerialStopBits(uint8_t value){ 153 | auto stopbits = getSerialStopBits(); 154 | value = (value << 4) & 0x30; 155 | if (stopbits == value) return; 156 | _serialConfig = (_serialConfig & 0xffffffcf) | value; 157 | _prefs->putULong("serialConfig", _serialConfig); 158 | } 159 | 160 | 161 | String Config::getWebPassword(){ 162 | return _webPassword; 163 | } 164 | 165 | void Config::setWebPassword(String value){ 166 | auto webpass = getWebPassword(); 167 | if (webpass == value) return; 168 | _webPassword = value; 169 | _prefs->putString("webPassword", _webPassword); 170 | } 171 | -------------------------------------------------------------------------------- /src/debug.cpp: -------------------------------------------------------------------------------- 1 | #include "debug.h" 2 | 3 | WebPrint::WebPrint(Print *serial, AsyncResponseStream *response) 4 | :_serial(serial) 5 | ,_response(response) 6 | {} 7 | 8 | size_t WebPrint::write(uint8_t arg){ 9 | if (arg == '<'){ 10 | _response->print("<"); 11 | } 12 | else if (arg == '&'){ 13 | _response->print("&"); 14 | } 15 | else{ 16 | _response->print((char)arg); 17 | } 18 | return _serial->write(arg); 19 | } 20 | 21 | size_t WebPrint::write(const uint8_t *buffer, size_t size){ 22 | _response->print(escapeLt(escapeAmp((const char*)buffer))); 23 | return _serial->write(buffer, size); 24 | } 25 | 26 | String WebPrint::escapeAmp(String text){ 27 | return escape(text, '&', "&"); 28 | } 29 | 30 | String WebPrint::escapeLt(String text){ 31 | return escape(text, '<', "<"); 32 | } 33 | 34 | String WebPrint::escape(String text, char oldValue, String newValue){ 35 | auto pos = text.indexOf(oldValue); 36 | if (pos < 0) return text; 37 | String result = text.substring(0, pos) + newValue; 38 | auto last = pos; 39 | pos = text.indexOf(oldValue, pos + 1); 40 | while(pos >= 0) 41 | { 42 | result += text.substring(last + 1, pos) + newValue; 43 | last = pos; 44 | pos = text.indexOf(oldValue, pos + 1); 45 | } 46 | result += text.substring(last + 1); 47 | return result; 48 | } -------------------------------------------------------------------------------- /src/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include "config.h" 10 | #include "pages.h" 11 | 12 | AsyncWebServer webServer(80); 13 | Config config; 14 | Preferences prefs; 15 | ModbusClientRTU *MBclient; 16 | ModbusBridgeWiFi MBbridge; 17 | WiFiManager wm; 18 | 19 | void setup() { 20 | debugSerial.begin(115200); 21 | dbgln(); 22 | dbgln("[config] load") 23 | prefs.begin("modbusRtuGw"); 24 | config.begin(&prefs); 25 | debugSerial.end(); 26 | debugSerial.begin(config.getSerialBaudRate(), config.getSerialConfig()); 27 | dbgln("[wifi] start"); 28 | WiFi.mode(WIFI_STA); 29 | wm.setClass("invert"); 30 | auto reboot = false; 31 | wm.setAPCallback([&reboot](WiFiManager *wifiManager){reboot = true;}); 32 | wm.autoConnect(); 33 | if (reboot){ 34 | ESP.restart(); 35 | } 36 | dbgln("[wifi] finished"); 37 | dbgln("[modbus] start"); 38 | 39 | MBUlogLvl = LOG_LEVEL_WARNING; 40 | RTUutils::prepareHardwareSerial(modbusSerial); 41 | #if defined(RX_PIN) && defined(TX_PIN) 42 | // use rx and tx-pins if defined in platformio.ini 43 | modbusSerial.begin(config.getModbusBaudRate(), config.getModbusConfig(), RX_PIN, TX_PIN ); 44 | dbgln("Use user defined RX/TX pins"); 45 | #else 46 | // otherwise use default pins for hardware-serial2 47 | modbusSerial.begin(config.getModbusBaudRate(), config.getModbusConfig()); 48 | #endif 49 | 50 | MBclient = new ModbusClientRTU(config.getModbusRtsPin()); 51 | MBclient->setTimeout(1000); 52 | MBclient->begin(modbusSerial, 1); 53 | for (uint8_t i = 1; i < 248; i++) 54 | { 55 | MBbridge.attachServer(i, i, ANY_FUNCTION_CODE, MBclient); 56 | } 57 | MBbridge.start(config.getTcpPort(), 10, config.getTcpTimeout()); 58 | dbgln("[modbus] finished"); 59 | setupPages(&webServer, MBclient, &MBbridge, &config, &wm); 60 | webServer.begin(); 61 | dbgln("[setup] finished"); 62 | } 63 | 64 | void loop() { 65 | // put your main code here, to run repeatedly: 66 | } -------------------------------------------------------------------------------- /src/pages.cpp: -------------------------------------------------------------------------------- 1 | #include "pages.h" 2 | #define ETAG "\"" __DATE__ "" __TIME__ "\"" 3 | #define ADMIN_WEB_PASS \ 4 | if ((!config->getWebPassword().equals("")) && (!request->authenticate("admin", config->getWebPassword().c_str()))) \ 5 | return request->requestAuthentication(); 6 | #define WEB_PASS_PLACEHOLDER "****" 7 | 8 | 9 | void setupPages(AsyncWebServer *server, ModbusClientRTU *rtu, ModbusBridgeWiFi *bridge, Config *config, WiFiManager *wm){ 10 | server->on("/", HTTP_GET, [config](AsyncWebServerRequest *request){ 11 | 12 | ADMIN_WEB_PASS; 13 | 14 | dbgln("[webserver] GET /"); 15 | auto *response = request->beginResponseStream("text/html"); 16 | sendResponseHeader(response, "Main"); 17 | sendButton(response, "Status", "status"); 18 | sendButton(response, "Config", "config"); 19 | sendButton(response, "Debug", "debug"); 20 | sendButton(response, "Firmware update", "update"); 21 | sendButton(response, "WiFi reset", "wifi", "r"); 22 | sendButton(response, "Reboot", "reboot", "r"); 23 | sendResponseTrailer(response); 24 | request->send(response); 25 | }); 26 | server->on("/status", HTTP_GET, [rtu, bridge, config](AsyncWebServerRequest *request){ 27 | 28 | ADMIN_WEB_PASS; 29 | 30 | dbgln("[webserver] GET /status"); 31 | auto *response = request->beginResponseStream("text/html"); 32 | sendResponseHeader(response, "Status"); 33 | response->print(""); 34 | 35 | // show ESP infos... 36 | sendTableRow(response, "ESP Uptime (sec)", esp_timer_get_time() / 1000000); 37 | sendTableRow(response, "ESP SSID", WiFi.SSID()); 38 | sendTableRow(response, "ESP RSSI", WiFi.RSSI()); 39 | sendTableRow(response, "ESP WiFi Quality", WiFiQuality(WiFi.RSSI())); 40 | sendTableRow(response, "ESP MAC", WiFi.macAddress()); 41 | sendTableRow(response, "ESP IP", WiFi.localIP().toString() ); 42 | 43 | sendTableRow(response, "RTU Messages", rtu->getMessageCount()); 44 | sendTableRow(response, "RTU Pending Messages", rtu->pendingRequests()); 45 | sendTableRow(response, "RTU Errors", rtu->getErrorCount()); 46 | sendTableRow(response, "Bridge Message", bridge->getMessageCount()); 47 | sendTableRow(response, "Bridge Clients", bridge->activeClients()); 48 | sendTableRow(response, "Bridge Errors", bridge->getErrorCount()); 49 | response->print(""); 50 | sendTableRow(response, "Build time", __DATE__ " " __TIME__); 51 | response->print("
 

"); 52 | sendButton(response, "Back", "/"); 53 | sendResponseTrailer(response); 54 | request->send(response); 55 | }); 56 | server->on("/reboot", HTTP_GET, [config](AsyncWebServerRequest *request){ 57 | 58 | ADMIN_WEB_PASS; 59 | 60 | dbgln("[webserver] GET /reboot"); 61 | auto *response = request->beginResponseStream("text/html"); 62 | sendResponseHeader(response, "Really?"); 63 | sendButton(response, "Back", "/"); 64 | response->print("
" 65 | "" 66 | "
"); 67 | sendResponseTrailer(response); 68 | request->send(response); 69 | }); 70 | server->on("/reboot", HTTP_POST, [config](AsyncWebServerRequest *request){ 71 | 72 | ADMIN_WEB_PASS; 73 | 74 | dbgln("[webserver] POST /reboot"); 75 | request->redirect("/"); 76 | dbgln("[webserver] rebooting...") 77 | ESP.restart(); 78 | dbgln("[webserver] rebooted...") 79 | }); 80 | server->on("/config", HTTP_GET, [config](AsyncWebServerRequest *request){ 81 | 82 | ADMIN_WEB_PASS; 83 | 84 | dbgln("[webserver] GET /config"); 85 | auto *response = request->beginResponseStream("text/html"); 86 | sendResponseHeader(response, "Modbus TCP"); 87 | response->print("
"); 88 | response->print("" 89 | "" 90 | "" 93 | "" 96 | "" 97 | "" 98 | "" 101 | "" 104 | "" 105 | "
" 91 | "" 92 | ""); 94 | response->printf("", config->getTcpPort()); 95 | response->print("
" 99 | "" 100 | ""); 102 | response->printf("", config->getTcpTimeout()); 103 | response->print("
" 106 | "

Modbus RTU

" 107 | "" 108 | "" 109 | "" 112 | "" 115 | "" 116 | "" 117 | "" 120 | "" 123 | "" 124 | "" 125 | "" 128 | "" 135 | "" 136 | "" 137 | "" 140 | "" 147 | "" 148 | "" 149 | "" 152 | "" 170 | "" 171 | "
" 110 | "" 111 | ""); 113 | response->printf("", config->getModbusBaudRate()); 114 | response->print("
" 118 | "" 119 | ""); 121 | response->printf("", config->getModbusDataBits()); 122 | response->print("
" 126 | "" 127 | ""); 129 | response->printf("" 134 | "
" 138 | "" 139 | ""); 141 | response->printf("" 146 | "
" 150 | "" 151 | ""); 153 | response->printf("" 169 | "
" 172 | "

Serial (Debug)

" 173 | "" 174 | "" 175 | "" 178 | "" 181 | "" 182 | "" 183 | "" 186 | "" 189 | "" 190 | "" 191 | "" 194 | "" 201 | "" 202 | "" 203 | "" 206 | "" 213 | "" 214 | "
" 176 | "" 177 | ""); 179 | response->printf("", config->getSerialBaudRate()); 180 | response->print("
" 184 | "" 185 | ""); 187 | response->printf("", config->getSerialDataBits()); 188 | response->print("
" 192 | "" 193 | ""); 195 | response->printf("" 200 | "
" 204 | "" 205 | ""); 207 | response->printf("" 212 | "
"); 215 | 216 | response->print( "

Other

" 217 | "" 218 | "" 219 | "" 222 | "" 225 | "" 226 | "
" 220 | "" 221 | ""); 223 | response->printf("", WEB_PASS_PLACEHOLDER); // we're not returning configured password to user instead we're sending placeholder 224 | response->print("
"); 227 | 228 | response->print("" 229 | "
" 230 | "

"); 231 | sendButton(response, "Back", "/"); 232 | response->print(""); 239 | sendResponseTrailer(response); 240 | request->send(response); 241 | }); 242 | server->on("/config", HTTP_POST, [config](AsyncWebServerRequest *request){ 243 | 244 | ADMIN_WEB_PASS; 245 | 246 | dbgln("[webserver] POST /config"); 247 | if (request->hasParam("tp", true)){ 248 | auto port = request->getParam("tp", true)->value().toInt(); 249 | config->setTcpPort(port); 250 | dbgln("[webserver] saved port"); 251 | } 252 | if (request->hasParam("tt", true)){ 253 | auto timeout = request->getParam("tt", true)->value().toInt(); 254 | config->setTcpTimeout(timeout); 255 | dbgln("[webserver] saved timeout"); 256 | } 257 | if (request->hasParam("mb", true)){ 258 | auto baud = request->getParam("mb", true)->value().toInt(); 259 | config->setModbusBaudRate(baud); 260 | dbgln("[webserver] saved modbus baud rate"); 261 | } 262 | if (request->hasParam("md", true)){ 263 | auto data = request->getParam("md", true)->value().toInt(); 264 | config->setModbusDataBits(data); 265 | dbgln("[webserver] saved modbus data bits"); 266 | } 267 | if (request->hasParam("mp", true)){ 268 | auto parity = request->getParam("mp", true)->value().toInt(); 269 | config->setModbusParity(parity); 270 | dbgln("[webserver] saved modbus parity"); 271 | } 272 | if (request->hasParam("ms", true)){ 273 | auto stop = request->getParam("ms", true)->value().toInt(); 274 | config->setModbusStopBits(stop); 275 | dbgln("[webserver] saved modbus stop bits"); 276 | } 277 | if (request->hasParam("mr", true)){ 278 | auto rts = request->getParam("mr", true)->value().toInt(); 279 | config->setModbusRtsPin(rts); 280 | dbgln("[webserver] saved modbus rts pin"); 281 | } 282 | if (request->hasParam("sb", true)){ 283 | auto baud = request->getParam("sb", true)->value().toInt(); 284 | config->setSerialBaudRate(baud); 285 | dbgln("[webserver] saved serial baud rate"); 286 | } 287 | if (request->hasParam("sd", true)){ 288 | auto data = request->getParam("sd", true)->value().toInt(); 289 | config->setSerialDataBits(data); 290 | dbgln("[webserver] saved serial data bits"); 291 | } 292 | if (request->hasParam("sp", true)){ 293 | auto parity = request->getParam("sp", true)->value().toInt(); 294 | config->setSerialParity(parity); 295 | dbgln("[webserver] saved serial parity"); 296 | } 297 | if (request->hasParam("ss", true)){ 298 | auto stop = request->getParam("ss", true)->value().toInt(); 299 | config->setSerialStopBits(stop); 300 | dbgln("[webserver] saved serial stop bits"); 301 | } 302 | if (request->hasParam("wp", true)){ 303 | String wp = request->getParam("wp", true)->value(); 304 | if (!wp.equals(WEB_PASS_PLACEHOLDER)) { // if we get default value prefilled in the wp input we're not changing current one 305 | config->setWebPassword(wp); 306 | dbgln("[webserver] saved web password"); 307 | } else { 308 | dbgln("[webserver] web password not changed"); 309 | } 310 | } 311 | request->redirect("/"); 312 | }); 313 | server->on("/debug", HTTP_GET, [config](AsyncWebServerRequest *request){ 314 | 315 | ADMIN_WEB_PASS; 316 | 317 | dbgln("[webserver] GET /debug"); 318 | auto *response = request->beginResponseStream("text/html"); 319 | sendResponseHeader(response, "Debug"); 320 | sendDebugForm(response, "1", "1", "3", "1"); 321 | sendButton(response, "Back", "/"); 322 | sendResponseTrailer(response); 323 | request->send(response); 324 | }); 325 | server->on("/debug", HTTP_POST, [rtu, config](AsyncWebServerRequest *request){ 326 | 327 | ADMIN_WEB_PASS; 328 | 329 | dbgln("[webserver] POST /debug"); 330 | String slaveId = "1"; 331 | if (request->hasParam("slave", true)){ 332 | slaveId = request->getParam("slave", true)->value(); 333 | } 334 | String reg = "1"; 335 | if (request->hasParam("reg", true)){ 336 | reg = request->getParam("reg", true)->value(); 337 | } 338 | String func = "3"; 339 | if (request->hasParam("func", true)){ 340 | func = request->getParam("func", true)->value(); 341 | } 342 | String count = "1"; 343 | if (request->hasParam("count", true)){ 344 | count = request->getParam("count", true)->value(); 345 | } 346 | auto *response = request->beginResponseStream("text/html"); 347 | sendResponseHeader(response, "Debug"); 348 | response->print("
");
349 |     auto previous = LOGDEVICE;
350 |     auto previousLevel = MBUlogLvl;
351 |     auto debug = WebPrint(previous, response);
352 |     LOGDEVICE = &debug;
353 |     MBUlogLvl = LOG_LEVEL_DEBUG;
354 |     ModbusMessage answer = rtu->syncRequest(0xdeadbeef, slaveId.toInt(), func.toInt(), reg.toInt(), count.toInt());
355 |     MBUlogLvl = previousLevel;
356 |     LOGDEVICE = previous;
357 |     response->print("
"); 358 | auto error = answer.getError(); 359 | if (error == SUCCESS){ 360 | auto count = answer[2]; 361 | response->print("Answer: 0x"); 362 | for (size_t i = 0; i < count; i++) 363 | { 364 | response->printf("%02x", answer[i + 3]); 365 | } 366 | response->print(""); 367 | } 368 | else{ 369 | response->printf("Error: %#02x (%s)", error, ErrorName(error).c_str()); 370 | } 371 | sendDebugForm(response, slaveId, reg, func, count); 372 | sendButton(response, "Back", "/"); 373 | sendResponseTrailer(response); 374 | request->send(response); 375 | }); 376 | server->on("/update", HTTP_GET, [config](AsyncWebServerRequest *request){ 377 | 378 | ADMIN_WEB_PASS; 379 | 380 | dbgln("[webserver] GET /update"); 381 | auto *response = request->beginResponseStream("text/html"); 382 | sendResponseHeader(response, "Firmware Update"); 383 | response->print("
" 384 | "" 385 | "

" 386 | "" 387 | "
" 388 | "

"); 389 | sendButton(response, "Back", "/"); 390 | sendResponseTrailer(response); 391 | request->send(response); 392 | }); 393 | server->on("/update", HTTP_POST, [config](AsyncWebServerRequest *request){ 394 | 395 | ADMIN_WEB_PASS; 396 | 397 | request->onDisconnect([](){ 398 | ESP.restart(); 399 | }); 400 | dbgln("[webserver] OTA finished"); 401 | if (Update.hasError()){ 402 | auto *response = request->beginResponse(500, "text/plain", "Ota failed"); 403 | response->addHeader("Connection", "close"); 404 | request->send(response); 405 | } 406 | else{ 407 | auto *response = request->beginResponseStream("text/html"); 408 | response->addHeader("Connection", "close"); 409 | sendResponseHeader(response, "Firmware Update", true); 410 | response->print("

Update successful.

"); 411 | sendButton(response, "Back", "/"); 412 | sendResponseTrailer(response); 413 | request->send(response); 414 | } 415 | }, [&](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final){ 416 | 417 | ADMIN_WEB_PASS; 418 | 419 | dbg("[webserver] OTA progress ");dbgln(index); 420 | if (!index) { 421 | //TODO add MD5 Checksum and Update.setMD5 422 | int cmd = (filename == "filesystem") ? U_SPIFFS : U_FLASH; 423 | if (!Update.begin(UPDATE_SIZE_UNKNOWN, cmd)) { // Start with max available size 424 | Update.printError(Serial); 425 | return request->send(400, "text/plain", "OTA could not begin"); 426 | } 427 | } 428 | // Write chunked data to the free sketch space 429 | if(len){ 430 | if (Update.write(data, len) != len) { 431 | return request->send(400, "text/plain", "OTA could not write data"); 432 | } 433 | } 434 | if (final) { // if the final flag is set then this is the last frame of data 435 | if (!Update.end(true)) { //true to set the size to the current progress 436 | Update.printError(Serial); 437 | return request->send(400, "text/plain", "Could not end OTA"); 438 | } 439 | }else{ 440 | return; 441 | } 442 | }); 443 | server->on("/wifi", HTTP_GET, [config](AsyncWebServerRequest *request){ 444 | 445 | ADMIN_WEB_PASS; 446 | 447 | dbgln("[webserver] GET /wifi"); 448 | auto *response = request->beginResponseStream("text/html"); 449 | sendResponseHeader(response, "WiFi reset"); 450 | response->print("

" 451 | "This will delete the stored WiFi config
" 452 | "and restart the ESP in AP mode.
Are you sure?" 453 | "

"); 454 | sendButton(response, "Back", "/"); 455 | response->print("

" 456 | "
" 457 | "" 458 | "
"); 459 | sendResponseTrailer(response); 460 | request->send(response); 461 | }); 462 | server->on("/wifi", HTTP_POST, [wm, config](AsyncWebServerRequest *request){ 463 | 464 | ADMIN_WEB_PASS; 465 | 466 | dbgln("[webserver] POST /wifi"); 467 | request->redirect("/"); 468 | wm->erase(); 469 | dbgln("[webserver] erased wifi config"); 470 | dbgln("[webserver] rebooting..."); 471 | ESP.restart(); 472 | dbgln("[webserver] rebooted..."); 473 | }); 474 | server->on("/favicon.ico", [](AsyncWebServerRequest *request){ 475 | dbgln("[webserver] GET /favicon.ico"); 476 | request->send(204);//TODO add favicon 477 | }); 478 | server->on("/style.css", [config](AsyncWebServerRequest *request){ 479 | if (request->hasHeader("If-None-Match")){ 480 | auto header = request->getHeader("If-None-Match"); 481 | if (header->value() == String(ETAG)){ 482 | request->send(304); 483 | return; 484 | } 485 | } 486 | dbgln("[webserver] GET /style.css"); 487 | auto *response = request->beginResponseStream("text/css"); 488 | sendMinCss(response); 489 | response->print( 490 | "button.r{" 491 | "background: #d43535;" 492 | "}" 493 | "button.r:hover{" 494 | "background: #931f1f;" 495 | "}" 496 | "table{" 497 | "text-align:left;" 498 | "width:100%;" 499 | "}" 500 | "input{" 501 | "width:100%;" 502 | "}" 503 | ".e{" 504 | "color:red;" 505 | "}" 506 | "pre{" 507 | "text-align:left;" 508 | "}" 509 | ); 510 | response->addHeader("ETag", ETAG); 511 | request->send(response); 512 | }); 513 | server->onNotFound([config](AsyncWebServerRequest *request){ 514 | dbg("[webserver] request to ");dbg(request->url());dbgln(" not found"); 515 | request->send(404, "text/plain", "404"); 516 | }); 517 | } 518 | 519 | void sendMinCss(AsyncResponseStream *response){ 520 | response->print("body{" 521 | "font-family:sans-serif;" 522 | "text-align: center;" 523 | "background: #252525;" 524 | "color: #faffff;" 525 | "}" 526 | "#content{" 527 | "display: inline-block;" 528 | "min-width: 340px;" 529 | "}" 530 | "button{" 531 | "width: 100%;" 532 | "line-height: 2.4rem;" 533 | "background: #1fa3ec;" 534 | "border: 0;" 535 | "border-radius: 0.3rem;" 536 | "font-size: 1.2rem;" 537 | "-webkit-transition-duration: 0.4s;" 538 | "transition-duration: 0.4s;" 539 | "color: #faffff;" 540 | "}" 541 | "button:hover{" 542 | "background: #0e70a4;" 543 | "}"); 544 | } 545 | 546 | void sendResponseHeader(AsyncResponseStream *response, const char *title, bool inlineStyle){ 547 | response->print("" 548 | "" 549 | "" 550 | "" 551 | ""); 552 | response->printf("ESP32 Modbus Gateway - %s", title); 553 | if (inlineStyle){ 554 | response->print(""); 557 | } 558 | else{ 559 | response->print(""); 560 | } 561 | response->print( 562 | "" 563 | "" 564 | "

ESP32 Modbus Gateway

"); 565 | response->printf("

%s

", title); 566 | response->print("
"); 567 | } 568 | 569 | void sendResponseTrailer(AsyncResponseStream *response){ 570 | response->print("
"); 571 | } 572 | 573 | void sendButton(AsyncResponseStream *response, const char *title, const char *action, const char *css){ 574 | response->printf( 575 | "
" 576 | "" 577 | "
" 578 | "

", action, css, title); 579 | } 580 | 581 | void sendTableRow(AsyncResponseStream *response, const char *name, String value){ 582 | response->printf( 583 | "" 584 | "%s:" 585 | "%s" 586 | "", name, value.c_str()); 587 | } 588 | 589 | void sendTableRow(AsyncResponseStream *response, const char *name, uint32_t value){ 590 | response->printf( 591 | "" 592 | "%s:" 593 | "%d" 594 | "", name, value); 595 | } 596 | 597 | void sendDebugForm(AsyncResponseStream *response, String slaveId, String reg, String function, String count){ 598 | response->print("
"); 599 | response->print("" 600 | "" 601 | "" 604 | "" 607 | "" 608 | "" 609 | "" 612 | "" 620 | "" 621 | "" 622 | "" 625 | "" 628 | "" 629 | "" 630 | "" 633 | "" 636 | "" 637 | "
" 602 | "" 603 | ""); 605 | response->printf("", slaveId.c_str()); 606 | response->print("
" 610 | "" 611 | ""); 613 | response->printf("" 619 | "
" 623 | "" 624 | ""); 626 | response->printf("", reg.c_str()); 627 | response->print("
" 631 | "" 632 | ""); 634 | response->printf("", count.c_str()); 635 | response->print("
"); 638 | response->print("" 639 | "
" 640 | "

"); 641 | response->print(""); 648 | } 649 | 650 | const String ErrorName(Modbus::Error code) 651 | { 652 | switch (code) 653 | { 654 | case Modbus::Error::SUCCESS: return "Success"; 655 | case Modbus::Error::ILLEGAL_FUNCTION: return "Illegal function"; 656 | case Modbus::Error::ILLEGAL_DATA_ADDRESS: return "Illegal data address"; 657 | case Modbus::Error::ILLEGAL_DATA_VALUE: return "Illegal data value"; 658 | case Modbus::Error::SERVER_DEVICE_FAILURE: return "Server device failure"; 659 | case Modbus::Error::ACKNOWLEDGE: return "Acknowledge"; 660 | case Modbus::Error::SERVER_DEVICE_BUSY: return "Server device busy"; 661 | case Modbus::Error::NEGATIVE_ACKNOWLEDGE: return "Negative acknowledge"; 662 | case Modbus::Error::MEMORY_PARITY_ERROR: return "Memory parity error"; 663 | case Modbus::Error::GATEWAY_PATH_UNAVAIL: return "Gateway path unavailable"; 664 | case Modbus::Error::GATEWAY_TARGET_NO_RESP: return "Gateway target no response"; 665 | case Modbus::Error::TIMEOUT: return "Timeout"; 666 | case Modbus::Error::INVALID_SERVER: return "Invalid server"; 667 | case Modbus::Error::CRC_ERROR: return "CRC error"; 668 | case Modbus::Error::FC_MISMATCH: return "Function code mismatch"; 669 | case Modbus::Error::SERVER_ID_MISMATCH: return "Server id mismatch"; 670 | case Modbus::Error::PACKET_LENGTH_ERROR: return "Packet length error"; 671 | case Modbus::Error::PARAMETER_COUNT_ERROR: return "Parameter count error"; 672 | case Modbus::Error::PARAMETER_LIMIT_ERROR: return "Parameter limit error"; 673 | case Modbus::Error::REQUEST_QUEUE_FULL: return "Request queue full"; 674 | case Modbus::Error::ILLEGAL_IP_OR_PORT: return "Illegal ip or port"; 675 | case Modbus::Error::IP_CONNECTION_FAILED: return "IP connection failed"; 676 | case Modbus::Error::TCP_HEAD_MISMATCH: return "TCP header mismatch"; 677 | case Modbus::Error::EMPTY_MESSAGE: return "Empty message"; 678 | case Modbus::Error::ASCII_FRAME_ERR: return "ASCII frame error"; 679 | case Modbus::Error::ASCII_CRC_ERR: return "ASCII crc error"; 680 | case Modbus::Error::ASCII_INVALID_CHAR: return "ASCII invalid character"; 681 | default: return "undefined error"; 682 | } 683 | } 684 | 685 | // translate RSSI to quality string 686 | const String WiFiQuality(int rssiValue) 687 | { 688 | switch (rssiValue) 689 | { 690 | case -30 ... 0: return "Amazing"; 691 | case -67 ... -31: return "Very Good"; 692 | case -70 ... -68: return "Okay"; 693 | case -80 ... -71: return "Not Good"; 694 | default: return "Unusable"; 695 | } 696 | } 697 | -------------------------------------------------------------------------------- /test/README: -------------------------------------------------------------------------------- 1 | 2 | This directory is intended for PlatformIO Test Runner and project tests. 3 | 4 | Unit Testing is a software testing method by which individual units of 5 | source code, sets of one or more MCU program modules together with associated 6 | control data, usage procedures, and operating procedures, are tested to 7 | determine whether they are fit for use. Unit testing finds problems early 8 | in the development cycle. 9 | 10 | More information about PlatformIO Unit Testing: 11 | - https://docs.platformio.org/en/latest/advanced/unit-testing/index.html 12 | --------------------------------------------------------------------------------