├── .gitignore ├── LICENSE.txt ├── README.md ├── as3935.jpg └── kaminari ├── AS3935.cpp ├── AS3935.h ├── Config.cpp ├── Config.h ├── kaminari.ino └── myWiFi.h.example /.gitignore: -------------------------------------------------------------------------------- 1 | myWiFi.h 2 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | # Kaminari 2 | 3 | This is an ESP8266 and AS3935 based Franklin Lightning Detector. It connects to a WiFi network, and offers a JSON web service for detected lightnings. 4 | 5 | **WARNING: This project is for educational purposes only.** This is just a toy. It is not intended to be used as an early warning indicator for lightning related storms. It does not guarantee accuracy or predict exact strike locations. It it not a replacement for a professional lightning detector. Again: **This is just a toy.** 6 | 7 | ## Features 8 | 9 | * Small size and low power consumption 10 | * Can be read out and configured via HTTP web service and JSON 11 | * Lightnings can be reported via MQTT 12 | * Optional RGBW LED for showing the system status and detected lightnings 13 | * Self-calibrating detector 14 | * Permanent automatic noise floor level adjustment 15 | 16 | ## Building and Installation 17 | 18 | ![Prototype](as3935.jpg) 19 | 20 | ### Hardware 21 | 22 | You need: 23 | 24 | - An **ESP8266** module. You can use any brand, as long as it provides a regulated 3.3 V power source, and exposes the SPI interface and GPIO 5. 25 | - An **AS3935** Franklin Lightning Detector module. Again, no special brand is required, as long as the SPI interface is exposed. 26 | 27 | The lightning detector is connected like this: 28 | 29 | - Vcc → 3.3 V power output of the ESP board 30 | - SCL → CLK (IO14) 31 | - MOSI → MOSI (IO13) 32 | - MISO → MISO (IO12) 33 | - CS → CS (IO15) 34 | - IRQ → IO5 35 | 36 | All other terminals of the detector are connected to GND of the ESP board. 37 | 38 | Optionally, a single **SK6812** RGBW LED can be added as a status LED. It is must be powered by 5 V, and its data input is directly connected to IO4. 39 | 40 | No other components are required. 41 | 42 | To fully understand the functionality of the lightning detector, please read the [AS3935 datasheet](https://www.sciosense.com/wp-content/uploads/documents/AS3935-Data-Sheet.pdf). 43 | 44 | ### Important Notes 45 | 46 | - The ESP8266's WiFi is disturbing the AS3935 detector, and reducing the quality of lightning detection up to a point where lightnings cannot be detected at all. **Make sure there is sufficient space between both boards!** There should be at least 10 cm between the WiFi antenna and the detector coil. The more space, the better. 47 | 48 | * Some manufacturers of the lightning detector print a calibration value on the package. As Kaminari calibrates the detector automatically, the calibration value is not needed. 49 | 50 | * Some AS3935 boards are equipped with non-standard parts in the antenna RC, and thus cannot be tuned to the recommended frequency of 500 kHz. If you're lucky, it is still within the required tolerance of ±3.5%. Those boards can be used, but may give inferior results. It is not a fault of Kaminari if the exact frequency is missed. (I got multiple reports about CJMCU boards having this issue, and can confirm it with my own board of this brand.) 51 | 52 | ### Firmware 53 | 54 | To build the firmware, you need to install the [Arduino IDE](https://www.arduino.cc/en/Main/Software). After installation, just open the `kaminari.ino` file. 55 | 56 | ### Dependencies 57 | 58 | Please make sure these libraries are installed in the Library Manager of the Arduino IDE: 59 | 60 | * [Arduino on ESP8266](https://github.com/esp8266/Arduino) (via Board Manager) 61 | * [ArduinoJson](https://arduinojson.org/) 62 | * [Adafruit NeoPixel](https://github.com/adafruit/Adafruit_NeoPixel) 63 | * [EEPROM_Rotate](https://github.com/xoseperez/eeprom_rotate) 64 | * [PubSubClient](https://github.com/knolleary/pubsubclient) 65 | 66 | ### Configuration 67 | 68 | Before you build the project for the first time, please copy the `myWiFi.h.example` file to `myWiFi.h`, and adapt it to your needs: 69 | 70 | - `MY_SSID`: The SSID of your WLAN to connect to 71 | - `MY_PSK`: The password of your WLAN 72 | - `MY_APIKEY`: Your API key for endpoint calls that change the state of the detector. You can set a random, password-like word here. 73 | - `MY_MDNS_NAME`: Your preferred mDNS name. Just use the default value `kaminari` if you don't know what to use here. 74 | 75 | To send lightning events via MQTT, these additional options need to be configured: 76 | 77 | - `MY_MQTT_ENABLED`: This line needs to be commented in to activate MQTT support. MQTT is disabled by default. 78 | - `MY_MQTT_SERVER_HOST`: Host name of the MQTT server. 79 | - `MY_MQTT_SERVER_PORT`: Port of the MQTT server (default is 1883). 80 | - `MY_MQTT_USER`: MQTT authentication user name 81 | - `MY_MQTT_PASSWORD`: MQTT authentication password 82 | - `MY_MQTT_TOPIC`: MQTT topic to be used 83 | - `MY_MQTT_RETAIN`: `true` if messages shall be retained. Default is `false`. 84 | 85 | ### Installation 86 | 87 | Now you can build the project in ArduinoIDE. 88 | 89 | After that, connect your ESP8266 via USB. In the _Tools_ menu, please set all parameters so you can upload the sketch to your ESP8266. The settings depend on the brand of your module and on your computer's operating system, so there are no generic settings that can be recommended here. 90 | 91 | When everything is completed, upload the sketch to your module. That's all. 92 | 93 | You can open the _Serial Monitor_ to read some debug output of Kaminari as it starts up. You will find the WiFi status, the IP address, and the calibration results there. 94 | 95 | ### Connection 96 | 97 | There is a small web server running in Kaminari. You can connect to it by pointing your browser to the IP address (e.g. http://192.168.1.23/status). 98 | 99 | Kaminari uses mDNS. If your operating system supports it, you can also connect to the sensor via http://kaminari.local/status (or whatever mDNS name you have used in your `myWiFi.h` file). 100 | 101 | ## Endpoints 102 | 103 | Kaminari offers a set of endpoints. Some endpoints are read-only. Other endpoints change the state of the detector, and thus require the API key to be passed in via `X-API-Key` header or `api_key` URL parameter. For the sake of simplicity, all requests are `GET` requests, even those that change the state of the detector. 104 | 105 | ### `/status` 106 | 107 | Returns the current status of the detector as JSON structure. This is an example result: 108 | 109 | ``` 110 | { 111 | "lightnings": [ 112 | { 113 | "age": 34, 114 | "distance": 12, 115 | "energy": 38123 116 | } 117 | ], 118 | "distance": null, 119 | "energy": 0, 120 | "noiseFloorLevel": 146, 121 | "disturbersPerMinute": 81, 122 | "watchdogThreshold": 1, 123 | "wifiSignalStrength": -55 124 | } 125 | ``` 126 | 127 | This is the meaning of the individual properties: 128 | 129 | - `lightnings`: An array of detected lightnings. It contains the `age` of the event (in seconds), the estimated `distance` of the lightning (in kilometres) and the lightning `energy` (no physical unit). Kaminari stores up to 64 lightning events, and returns them in antichronological order. When a 65th event is recorded, the oldest record will automatically be removed from the list. This array is empty if no lightnings have been detected yet. 130 | - `distance`: General distance of the storm, in kilometres. `null` means that the storm is out of range, while `1` means that the storm is overhead. May also contain values caused by disturbers. For debugging purposes only, may be removed in a future version. 131 | - `energy`: General energy of detected lightnings, with no physical unit. May also contain values caused by disturbers. For debugging purposes only, may be removed in a future version. 132 | - `noiseFloorLevel`: Current noise floor level, in µVrms. Kaminari raises or lowers the level automatically, depending on the level of environment radio noises. 133 | - `disturbersPerMinute`: Number of detected disturbers per minute. The value should be as low as possible for best results. Higher values mean that the detector is receiving a lot of disturbing radio noises. 134 | - `watchdogThreshold`: Current watchdog threshold. Range is between 0 and 10. Higher values mean lower sensibility against disturbers, but also lower sensibility against very far lightning events. 135 | - `wifiSignalStrength`: Current WiFi received signal strength, in dBm. 136 | 137 | ### `/settings` 138 | 139 | Returns the current settings of the detector as JSON structure, for example: 140 | 141 | ``` 142 | { 143 | "tuning": 500135, 144 | "noiseFloorLevel": 146, 145 | "outdoorMode": false, 146 | "watchdogThreshold": 2, 147 | "minimumNumberOfLightning": 1, 148 | "spikeRejection": 2, 149 | "statusLed": true, 150 | "blueBrightness": 48, 151 | "disturberBrightness": 100 152 | } 153 | ``` 154 | 155 | - `tuning`: The tuning of the internal antenna, in Hz. Should be around 500 kHz, with a tolerance of ±3.5%. 156 | - `noiseFloorLevel`: Current noise floor level, in µVrms. 157 | - `outdoorMode`: `true` if the detector is switched to outdoor mode. In outdoor mode, a higher noise floor level voltage is used for suppressing disturbers. If the LED is blinking blue, you can try to enable the outdoor mode to make the device less sensitive for disturbers. 158 | - `watchdogThreshold`: Current watchdog threshold, see AS3935 datasheet. 159 | - `minimumNumberOfLightning`: Minimum number of lightnings until a lightning detected event is triggered. 160 | - `spikeRejection`: Current spike rejection, see AS3935 datasheet. 161 | - `statusLed`: If `true`, the status LED displays signal quality and detected lightnings. If `false`, the status LED will only display important system states (WLAN disconnected, calibration in progress) and is turned off otherwise. 162 | - `blueBrightness`: Maximum brightness of the blue LED indicating the noise floor level. 163 | - `disturberBrightness`: Brightness of the LED when a disturber is detected. 164 | 165 | ### `/update` 166 | 167 | This endpoint permits to change the settings. Settings to be changed are passed as URL parameter: 168 | 169 | - `outdoorMode`: Enable or disable the outdoor mode. 170 | - `watchdogThreshold`: Watchdog threshold, between 0 and 10, see AS3935 datasheet. Higher numbers give better robustness against disturber signals, but a lower lightning detection rate. 171 | - `minimumNumberOfLightning`: Minimum number of lightnings until a lightning detected event is triggered. Only 1, 5, 9, and 16 are permitted, other values will be ignored. 172 | - `spikeRejection`: Spike rejection, between 0 and 11, see AS3935 datasheet. Higher numbers give better robustness against disturber signals, but a lower lightning detection rate. 173 | - `statusLed`: Change the status LED operation. 174 | - `blueBrightness`: Maximum brightness of the blue LED indicating the noise floor level, between 0 and 255. 0 turns the constant blue light off, while lightnings, disturbers, and system states are still indicated. 175 | - `disturberBrightness`: Brightness of the LED when a disturber is detected, between 0 and 255. 0 to turn off disturber indication. 176 | 177 | The changes are permanently stored and will still be effective after Kaminari had been powered off and on. 178 | 179 | Other settings are managed by Kaminari and cannot be changed externally. 180 | 181 | The API key is required for this call. 182 | 183 | ### `/calibrate` 184 | 185 | This endpoint forces a new calibration of the internal oscillators. The calibration takes approximately 5 seconds. The calibrated antenna tuning is returned. It should be around 500 kHz. 186 | 187 | The API key is required for this call. 188 | 189 | ### `/clear` 190 | 191 | This endpoint clears the list of detected lightnings, the age of the last detected disturber, and the counter of disturbers per minute. 192 | 193 | The API key is required for this call. 194 | 195 | ### `/reset` 196 | 197 | This endpoint resets the detector chip. May be useful if the detector cracks up or behaves strangely. This call also includes a calibration and resetting the statistics. 198 | 199 | The API key is required for this call. 200 | 201 | ## Status LED 202 | 203 | An optional RGBW LED is showing the current status of the device: 204 | 205 | - **constant yellow**: The antenna is being calibrated. This takes approximately 5 seconds. 206 | - **blinking red**: The WLAN connection is lost, and the device is currently trying to reconnect. 207 | - **constant blue**: The device is in normal operation mode. The brightness of the blue color is an indicator for the current noise floor level. Darker blue indicates a lower noise floor level, which should be preferred. The maximum brightness can be changed via the `/update` endpoint. 208 | - **blinking blue**: The maximum noise floor level has been reached. Background noise is too high. You should find a different place for your detector, or enable the outdoor mode. Try to keep it away from electronic devices, especially bluetooth devices, mobile phones or microwaves. 209 | - **white flash**: A lightning has been detected. 210 | - **fading red, yellow or green tints**: Indicates the estimated distance (color) and the intensity of the lightning (brightness). Green indicates that the storm is about 40 km away. Red indicates that the storm is overhead. The hue of other colors represent distances between. 211 | - **fading pink/red tints** without prior white flash: A disturber has been detected. 212 | 213 | ## MQTT events 214 | 215 | If MQTT support is enabled, Kaminari will publish a message on every detected lightning event. The payload is a JSON structure: 216 | 217 | ``` 218 | { 219 | "energy": 0, 220 | "distance": null, 221 | "tuning": 500135, 222 | "noiseFloorLevel": 146, 223 | "disturbersPerMinute": 2, 224 | "watchdogThreshold": 1, 225 | "wifiSignalStrength": -55 226 | } 227 | ``` 228 | 229 | This is the meaning of the individual properties: 230 | 231 | - `energy`: Estimated energy of the detected lightning (no physical unit). May be `null` if a disturber was detected. 232 | - `distance`: Estimated distance of the lightning, in kilometres. May be `null` if the storm is out of range. `1` means that the storm is overhead. 233 | - `tuning`: The tuning of the internal antenna, in Hz. Should be around 500 kHz, with a tolerance of ±3.5%. 234 | - `noiseFloorLevel`: Current noise floor level, in µVrms. Kaminari raises or lowers the level automatically, depending on the level of environment radio noises. This value gives a hint about signal quality. 235 | - `disturbersPerMinute`: Number of detected disturbers per minute. The value should be as low as possible for best results. Higher values mean that the detector is receiving a lot of disturbing radio noises. This value gives a hint about signal quality. 236 | - `watchdogThreshold`: Current watchdog threshold. Range is between 0 and 10. Higher values mean lower sensibility against disturbers, but also lower sensibility against very far lightning events. This value gives a hint about signal quality. 237 | - `wifiSignalStrength`: Current WiFi received signal strength, in dBm. 238 | 239 | ## Data Recording 240 | 241 | You can frequently poll the `/status` endpoint for lightnings and other sensor values. This can be done either manually or automated. 242 | 243 | [Geordi](https://geordi.shredzone.org) is a tool that frequently polls the status and stores the samples in a Postgresql database. It supports Kaminari directly. [Grafana](https://grafana.com/) can be used for visualising the results. 244 | 245 | ## FAQ 246 | 247 | - **Does this detector warn me in time if…** 248 | 249 | No. 250 | 251 | Seriously, this is just a toy, and only meant for experimenting and having fun. Never trust your life and other valuable stuff on it. 252 | 253 | - **How can I test it?** 254 | 255 | The manufacturer sells a [demo kit](https://www.sciosense.com/products/wireless-sensor-nodes/demo-kit-for-as3935/) that also contains a "lightning emulator", but the least expensive way is to wait for an actual thunderstorm. 256 | 257 | You can also increase sensitivity by reducing `watchdogThreshold` and `spikeRejection`, and then try to simulate lightnings by switching a light switch. I could also simulate lightnings by using a bluetooth mouse or a mobile phone close to the sensor. 258 | 259 | - **I get a lot of false lightning events.** 260 | 261 | You can experiment with the `watchdogThreshold`, `spikeRejection` and `minimumNumberOfLightning` settings. There is not much more that can be done though. 262 | 263 | - **Lightnings are not detected.** 264 | 265 | Your detector might be located in a place with too many radio noises. Try to find a different place, far away from radio sources (like smartphones or bluetooth devices). You can also try to reduce `watchdogThreshold`, `spikeRejection` or `minimumNumberOfLightning`. 266 | 267 | The ESP8266 WiFi is a strong disturber. Try to give more space between the WiFi antenna and the detector coil, in order to reduce disturbers. 268 | 269 | Lightnings are only detected in a radius of up to 40 km. However, lightnings are poorer detected with increasing distance. 270 | 271 | - **I get a lot of disturber indications.** 272 | 273 | Try to find a place with less radio disturbers, and experiment with the `watchdogThreshold` and `spikeRejection` settings. If the disturber indications are annoying you, you can also set `disturberBrightness` to 0. 274 | 275 | - **I'd to write my own lightning detector firmware.** 276 | 277 | The `AS3935.cpp` and `AS3935.h` files in this project provide a generic driver class for the AS3935 sensor chip. You can use it in your own project, as long as you won't remove the copyright header and respect the terms of our license. 278 | 279 | - **Are kits or assembled devices available?** 280 | 281 | No, at least not that I am aware of. 282 | 283 | ## Contribute 284 | 285 | * Fork the [Source code at Codeberg](https://codeberg.org/shred/kaminari). Feel free to send pull requests. 286 | * Found a bug? [File a bug report!](https://codeberg.org/shred/kaminari/issues) However, please don't file complaints about a poor accuracy or false detections. Remember that this is a toy and not a professional lightning detector. 287 | 288 | ## License 289 | 290 | _Kaminari_ is open source software. The source code is distributed under the terms of [GNU General Public License (GPLv3+)](https://www.gnu.org/licenses/gpl-3.0.en.html). 291 | -------------------------------------------------------------------------------- /as3935.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/shred/kaminari/a784a5da6d2c485238fa9907eae09aabb7554b20/as3935.jpg -------------------------------------------------------------------------------- /kaminari/AS3935.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Kaminari 3 | * 4 | * Copyright (C) 2020 Richard "Shred" Körber 5 | * https://codeberg.org/shred/kaminari 6 | * 7 | * This program is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | */ 17 | 18 | #include 19 | #include 20 | 21 | #include "AS3935.h" 22 | 23 | #define BITRATE 1400000 // max bitrate is 2 MHz, should not be dividable by 500 kHz 24 | #define NOISE_LEVEL_RAISE_DELAY 60000 // Delay before noise level can be raised again 25 | #define NOISE_LEVEL_REDUCTION_DELAY 600000 // Delay before noise reduction is lowered again 26 | 27 | const int outdoorLevels[] = { 390, 630, 860, 1100, 1140, 1570, 1800, 2000 }; 28 | const int indoorLevels[] = { 28, 45, 62, 78, 95, 112, 130, 146 }; 29 | const int minNumLightning[] = { 1, 5, 9, 16 }; 30 | 31 | volatile static unsigned long counter = 0; // Internal counter 32 | 33 | ICACHE_RAM_ATTR static void counterISR() { 34 | counter++; 35 | } 36 | 37 | 38 | AS3935::AS3935(int csPin, int intPin) { 39 | unsigned long now = millis(); 40 | this->csPin = csPin; 41 | this->intPin = intPin; 42 | this->frequency = 0; 43 | this->lastNoiseLevelChange = now; 44 | this->lastNoiseLevelRaise = now; 45 | this->noiseLevelBalance = 0; 46 | this->currentNoiseFloorLevel = -1; 47 | this->currentOutdoorMode = false; 48 | this->noiseFloorLevelOutOfRange = false; 49 | this->disturberCounterStart = now; 50 | this->disturberCounter = 0; 51 | this->lastDisturber = 0; 52 | 53 | clearDetections(); 54 | } 55 | 56 | void AS3935::begin() { 57 | SPI.begin(); 58 | 59 | pinMode(this->csPin, OUTPUT); 60 | digitalWrite(this->csPin, HIGH); 61 | 62 | pinMode(this->intPin, INPUT); 63 | 64 | attachInterrupt(digitalPinToInterrupt(this->intPin), counterISR, RISING); 65 | } 66 | 67 | void AS3935::end() { 68 | detachInterrupt(digitalPinToInterrupt(this->intPin)); 69 | digitalWrite(this->csPin, HIGH); 70 | SPI.end(); 71 | } 72 | 73 | bool AS3935::update() { 74 | bool hasChanged = false; 75 | unsigned long now = millis(); 76 | 77 | if (counter > 0) { 78 | counter = 0; 79 | 80 | open(); 81 | delay(2); // wait 2 ms before reading the interrupt register! 82 | char interrupt = spiRead(0x03) & 0x0F; 83 | close(); 84 | 85 | if ((interrupt & 0x01) != 0 && (now - lastNoiseLevelRaise) > NOISE_LEVEL_RAISE_DELAY) { 86 | // Noise level too high 87 | lastNoiseLevelChange = now; 88 | lastNoiseLevelRaise = now; 89 | noiseLevelBalance++; 90 | if (noiseLevelBalance > 1) { 91 | noiseLevelBalance--; 92 | if (raiseNoiseFloorLevel()) { 93 | noiseFloorLevelOutOfRange = false; 94 | hasChanged = true; 95 | } else { 96 | noiseFloorLevelOutOfRange = true; 97 | } 98 | } 99 | } 100 | 101 | if ((interrupt & 0x04) != 0) { 102 | // Disturber detected 103 | disturberCounter++; 104 | this->lastDisturber = now; 105 | } 106 | 107 | if ((interrupt & 0x08) != 0) { 108 | // Lightning detected 109 | for (int ix = sizeof(lastLightningDetections) / sizeof(Lightning) - 1; ix > 0; ix--) { 110 | lastLightningDetections[ix] = lastLightningDetections[ix - 1]; 111 | } 112 | lastLightningDetections[0].time = now; 113 | lastLightningDetections[0].energy = getEnergy(); 114 | lastLightningDetections[0].distance = getEstimatedDistance(); 115 | hasChanged = true; 116 | } 117 | } 118 | 119 | // Try to reduce the noise level again 120 | if ((now - lastNoiseLevelChange) > NOISE_LEVEL_REDUCTION_DELAY) { 121 | lastNoiseLevelChange = now; 122 | noiseLevelBalance--; 123 | if (noiseLevelBalance < -1) { 124 | noiseLevelBalance++; 125 | if (noiseFloorLevelOutOfRange) { 126 | noiseFloorLevelOutOfRange = false; 127 | } else { 128 | reduceNoiseFloorLevel(); 129 | hasChanged = true; 130 | } 131 | } 132 | } 133 | 134 | return hasChanged; 135 | } 136 | 137 | void AS3935::powerDown() { 138 | open(); 139 | spiWrite(0x00, 0x25); 140 | close(); 141 | } 142 | 143 | void AS3935::reset() { 144 | open(); 145 | spiWrite(0x3C, 0x96); // PRESET_DEFAULT: Reset all registers 146 | delay(2); 147 | spiRead(0x03); // Clear interrupts 148 | counter = 0; 149 | close(); 150 | } 151 | 152 | unsigned long AS3935::calibrate(unsigned long freq) { 153 | open(); 154 | if (spiRead(0x00) & 0x37 == 0x00) { 155 | Serial.println("The AS3935 does not respond. Please check your SPI wiring!"); 156 | } 157 | 158 | spiWrite(0x03, 0xC0); // Set division ratio to 128 159 | 160 | byte mask = 0x00; 161 | unsigned long actualFreq; 162 | unsigned long bestFreq; 163 | byte testMask; 164 | byte bestMask; 165 | long bestDiff = 1000000; 166 | long currentDiff; 167 | for (int bit = 3; bit >= 0; bit--) { 168 | testMask = mask | (1 << bit); 169 | spiWrite(0x08, 0x80 | testMask); 170 | delay(50); // Let oscillator settle... 171 | 172 | // Measure frequency for 500ms, repeat if not plausible 173 | do { 174 | counter = 0; 175 | delay(500); 176 | actualFreq = counter * 128 * 2; 177 | currentDiff = actualFreq - freq; 178 | if (currentDiff < 0) { 179 | currentDiff = -currentDiff; 180 | } 181 | } while (actualFreq > 0 && currentDiff > 50000); 182 | 183 | // Remember the best frequency and corresponding bit mask 184 | if (currentDiff < bestDiff) { 185 | bestDiff = currentDiff; 186 | bestFreq = actualFreq; 187 | bestMask = testMask; 188 | if (bestDiff < 500) { 189 | break; 190 | } 191 | } 192 | 193 | // Test the next bit 194 | if (actualFreq/1000 > freq/1000) { 195 | mask = testMask; 196 | } 197 | } 198 | 199 | if (bestFreq == 0) { 200 | Serial.println("No interrupt was detected during calibration. Please check your IRQ wiring!"); 201 | } else if (bestFreq < 483092 || bestFreq > 517500) { 202 | Serial.println("Warning: calibrated frequency is out of tolerance range."); 203 | } 204 | 205 | this->frequency = bestFreq; 206 | 207 | spiWrite(0x08, bestMask); // Set the target frequency, disable DISP_LCO output 208 | delay(50); // Let everything settle for a while 209 | spiWrite(0x3D, 0x96); // CALIB_RCO: Now calibrate the RCOs 210 | spiWrite(0x08, 0x20 | bestMask); // Enable TRCO for calibration 211 | delay(2); // Wait another 2 ms 212 | spiWrite(0x08, bestMask); // Disable TRCO again 213 | delay(50); // Let everything settle again 214 | spiRead(0x03); // Clear interrupts 215 | counter = 0; 216 | 217 | close(); 218 | return bestFreq; 219 | } 220 | 221 | bool AS3935::raiseNoiseFloorLevel() { 222 | bool success = false; 223 | open(); 224 | byte current = spiRead(0x01); 225 | int value = (current >> 4) & 0x07; 226 | value++; 227 | if (value <= 7) { 228 | spiWrite(0x01, (current & 0x8F) | value << 4); 229 | success = true; 230 | } 231 | updateNoiseFloorLevel(); 232 | close(); 233 | return success; 234 | } 235 | 236 | bool AS3935::reduceNoiseFloorLevel() { 237 | bool success = false; 238 | open(); 239 | byte current = spiRead(0x01); 240 | int value = (current >> 4) & 0x07; 241 | value--; 242 | if (value >= 0) { 243 | spiWrite(0x01, (current & 0x8F) | value << 4); 244 | success = true; 245 | } 246 | updateNoiseFloorLevel(); 247 | close(); 248 | return success; 249 | } 250 | 251 | int AS3935::getNoiseFloorLevel() { 252 | if (currentNoiseFloorLevel == -1) { 253 | open(); 254 | updateNoiseFloorLevel(); 255 | close(); 256 | } 257 | return currentNoiseFloorLevel; 258 | } 259 | 260 | bool AS3935::isNoiseFloorLevelOutOfRange() const { 261 | return noiseFloorLevelOutOfRange; 262 | } 263 | 264 | bool AS3935::getOutdoorMode() const { 265 | return currentOutdoorMode; 266 | } 267 | 268 | void AS3935::setOutdoorMode(bool outdoor) { 269 | open(); 270 | spiWrite(0x00, outdoor ? 0x1C : 0x24); 271 | updateNoiseFloorLevel(); 272 | close(); 273 | } 274 | 275 | int AS3935::getWatchdogThreshold() { 276 | open(); 277 | int current = spiRead(0x01) & 0x0F; 278 | close(); 279 | return current; 280 | } 281 | 282 | void AS3935::setWatchdogThreshold(int threshold) { 283 | open(); 284 | byte current = spiRead(0x01); 285 | current = (current & 0xF0) | (threshold & 0x0F); 286 | spiWrite(0x01, current); 287 | close(); 288 | } 289 | 290 | void AS3935::clearStatistics() { 291 | open(); 292 | byte current = spiRead(0x02); 293 | current &= 0xBF; 294 | spiWrite(0x02, current); 295 | delay(2); 296 | current |= 0x40; 297 | spiWrite(0x02, current); 298 | close(); 299 | } 300 | 301 | int AS3935::getMinimumNumberOfLightning() const { 302 | open(); 303 | int value = (spiRead(0x02) & 0x30) >> 4; 304 | close(); 305 | return minNumLightning[value]; 306 | } 307 | 308 | void AS3935::setMinimumNumberOfLightning(int num) { 309 | int value = -1; 310 | switch (num) { 311 | case 1: value = 0x00; break; 312 | case 5: value = 0x01; break; 313 | case 9: value = 0x02; break; 314 | case 16: value = 0x03; break; 315 | } 316 | if (value >= 0) { 317 | open(); 318 | byte current = spiRead(0x02); 319 | current &= 0xCF; 320 | current |= value << 4; 321 | spiWrite(0x02, current); 322 | close(); 323 | } 324 | } 325 | 326 | int AS3935::getSpikeRejection() const { 327 | open(); 328 | int value = spiRead(0x02) & 0x0F; 329 | close(); 330 | return value; 331 | } 332 | 333 | void AS3935::setSpikeRejection(int rejection) { 334 | open(); 335 | byte current = spiRead(0x02); 336 | current &= 0xF0; 337 | current |= rejection & 0x0F; 338 | spiWrite(0x02, current); 339 | close(); 340 | } 341 | 342 | unsigned long AS3935::getFrequency() const { 343 | return this->frequency; 344 | } 345 | 346 | unsigned long AS3935::getEnergy() const { 347 | open(); 348 | byte mmsb = spiRead(0x06) & 0x1F; 349 | byte msb = spiRead(0x05) & 0xFF; 350 | byte lsb = spiRead(0x04) & 0xFF; 351 | unsigned long energy = (mmsb << 16) | (msb << 8) | lsb; 352 | close(); 353 | return energy; 354 | } 355 | 356 | unsigned int AS3935::getEstimatedDistance() const { 357 | open(); 358 | unsigned int distance = spiRead(0x07) & 0x3F; 359 | close(); 360 | return distance; 361 | } 362 | 363 | unsigned int AS3935::getDisturbersPerMinute() const { 364 | return (60 * 1000L * disturberCounter) / (millis() - disturberCounterStart); 365 | } 366 | 367 | bool AS3935::getLastLightningDetection(int index, Lightning& lightning) const { 368 | if (index >= 0 369 | && index < sizeof(lastLightningDetections) / sizeof(Lightning) 370 | && lastLightningDetections[index].time != 0) { 371 | lightning.time = lastLightningDetections[index].time; 372 | lightning.energy = lastLightningDetections[index].energy; 373 | lightning.distance = lastLightningDetections[index].distance; 374 | return true; 375 | } 376 | return false; 377 | } 378 | 379 | unsigned long AS3935::getLastDisturber() const { 380 | return this->lastDisturber; 381 | } 382 | 383 | void AS3935::clearDetections() { 384 | for (int ix = 0; ix < sizeof(lastLightningDetections) / sizeof(Lightning); ix++) { 385 | lastLightningDetections[ix].time = 0; 386 | } 387 | disturberCounterStart = millis(); 388 | disturberCounter = 0; 389 | } 390 | 391 | void AS3935::dump(byte* dump) const { 392 | open(); 393 | digitalWrite(csPin, LOW); 394 | SPI.transfer(0x40); 395 | for (int i = 0; i < 0x33; i++) { 396 | dump[i] = SPI.transfer(0x00); 397 | } 398 | digitalWrite(csPin, HIGH); 399 | close(); 400 | } 401 | 402 | void AS3935::debug() const { 403 | char output[40]; 404 | open(); 405 | digitalWrite(csPin, LOW); 406 | SPI.transfer(0x40); 407 | for (int i = 0; i <= 0x32; i++) { 408 | byte value = SPI.transfer(0x00); 409 | sprintf(output, "%02X = %02X", i, value); 410 | Serial.println(output); 411 | } 412 | digitalWrite(csPin, HIGH); 413 | close(); 414 | } 415 | 416 | void AS3935::open() const { 417 | SPI.beginTransaction(SPISettings(BITRATE, MSBFIRST, SPI_MODE1)); 418 | } 419 | 420 | void AS3935::close() const { 421 | SPI.endTransaction(); 422 | } 423 | 424 | void AS3935::spiWrite(byte address, byte value) const { 425 | digitalWrite(csPin, LOW); 426 | SPI.transfer(address & 0x3F); 427 | SPI.transfer(value); 428 | digitalWrite(csPin, HIGH); 429 | } 430 | 431 | byte AS3935::spiRead(byte address) const { 432 | digitalWrite(csPin, LOW); 433 | SPI.transfer(0x40 | (address & 0x3F)); 434 | byte result = SPI.transfer(0x00); 435 | digitalWrite(csPin, HIGH); 436 | return result; 437 | } 438 | 439 | void AS3935::updateNoiseFloorLevel() { 440 | int level = (spiRead(0x01) >> 4) & 0x07; 441 | currentOutdoorMode = spiRead(0x00) == 0x1C; 442 | currentNoiseFloorLevel = currentOutdoorMode ? outdoorLevels[level] : indoorLevels[level]; 443 | } 444 | -------------------------------------------------------------------------------- /kaminari/AS3935.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Kaminari 3 | * 4 | * Copyright (C) 2020 Richard "Shred" Körber 5 | * https://codeberg.org/shred/kaminari 6 | * 7 | * This program is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | */ 17 | 18 | #ifndef __AS3935__ 19 | #define __AS3935__ 20 | 21 | struct Lightning { 22 | unsigned long time; 23 | unsigned long energy; 24 | unsigned int distance; 25 | }; 26 | 27 | /** 28 | * Driver for an AS3935 Franklin Lightning Detector connected via SPI. 29 | * 30 | * The driver takes care for automatic adjustment of the noise floor level. If too much 31 | * noise is detected, the noise floor level is raised automatically. After a while, the 32 | * noise floor level is lowered again. 33 | * 34 | * The driver collects the time, energy and distance of up to 64 lightning events. After 35 | * that, if another lightning is detected, the oldest event is removed. 36 | * 37 | * All returned times represent the system time (millis()) when the event occurred. 38 | * 39 | * Note that for technical reasons, you can only run one instance per microcontroller. 40 | */ 41 | class AS3935 { 42 | public: 43 | 44 | /** 45 | * Create a new AS3935 driver object. 46 | * 47 | * @param csPin Pin number of the detector's Chip Select input 48 | * @param intPin Pin number of the detector's Interrupt output 49 | */ 50 | AS3935(int csPin, int intPin); 51 | 52 | /** 53 | * Begin working with the detector. This call initiates the hardware. 54 | */ 55 | void begin(); 56 | 57 | /** 58 | * End working with the detector. Resources are freed. 59 | */ 60 | void end(); 61 | 62 | /** 63 | * Update the detector status. This method should be invoked frequently, e.g. in 64 | * loop(). 65 | * 66 | * @return true if something has changed, false if nothing happened 67 | */ 68 | bool update(); 69 | 70 | /** 71 | * Power down the detector. It can be powered up by a reset, and must then be 72 | * recalibrated. 73 | */ 74 | void powerDown(); 75 | 76 | /** 77 | * Reset the detector. All settings are reset to default values. 78 | */ 79 | void reset(); 80 | 81 | /** 82 | * Auto-tune the antenna resonator to the given frequency. 83 | * 84 | * The calibration process takes a little more than 4 seconds. If the target frequency 85 | * cannot be reached, the closest possible frequency is used instead. System RCO and 86 | * Timer RCO are calibrated as well. 87 | * 88 | * @param freq Target frequency in Hz, 500 kHz by default 89 | * @return Actual tuned-in resonator frequency (measured, not 100% accurate) 90 | */ 91 | unsigned long calibrate(unsigned long freq = 500000); 92 | 93 | /** 94 | * Raise the noise floor level. The detector will be less sensitive to noise, but also 95 | * less sensitive to lightning events. 96 | * 97 | * Usually the driver takes care of adjusting the noise floor level automatically, 98 | * so there is no need to invoke this method. 99 | * 100 | * @return true if the level could be raised, false if the upper limit was reached. 101 | */ 102 | bool raiseNoiseFloorLevel(); 103 | 104 | /** 105 | * Reduce the noise floor level. The detector will be more sensitive to lightning 106 | * events, but also more sensitive to noise. 107 | * 108 | * Usually the driver takes care of adjusting the noise floor level automatically, 109 | * so there is no need to invoke this method. 110 | * 111 | * @return true if the level could be reduced, false if the lower limit was reached. 112 | */ 113 | bool reduceNoiseFloorLevel(); 114 | 115 | /** 116 | * Read the current continuous input noise level, in µVrms. 117 | */ 118 | int getNoiseFloorLevel(); 119 | 120 | /** 121 | * Return true if the noise floor level is out of its upper range. The detector is 122 | * unable to work properly if this happens. 123 | */ 124 | bool isNoiseFloorLevelOutOfRange() const; 125 | 126 | /** 127 | * Return the current outdoor mode setting. 128 | */ 129 | bool getOutdoorMode() const; 130 | 131 | /** 132 | * Enable or disable the outdoor mode. 133 | */ 134 | void setOutdoorMode(bool outdoor); 135 | 136 | /** 137 | * Return the current watchdog threshold. 138 | */ 139 | int getWatchdogThreshold(); 140 | 141 | /** 142 | * Set a watchdog threshold. Value must be between 0 and 15. Default is 1. 143 | */ 144 | void setWatchdogThreshold(int threshold); 145 | 146 | /** 147 | * Clear the statistics of the lightning distance estimation algorithm. Usually there 148 | * is no need to clear the statistics manually. 149 | */ 150 | void clearStatistics(); 151 | 152 | /** 153 | * Return the current minimum number of lightnings required for lightning detection. 154 | */ 155 | int getMinimumNumberOfLightning() const; 156 | 157 | /** 158 | * Set the minimum number of lightnings required for lightning detection. Value must 159 | * be 1, 5, 9, or 16. Other values will be ignored. 160 | */ 161 | void setMinimumNumberOfLightning(int num); 162 | 163 | /** 164 | * Return the current spike rejection value. 165 | */ 166 | int getSpikeRejection() const; 167 | 168 | /** 169 | * Set a new spike rejection value. Value must be between 0 and 15. Default is 2. 170 | */ 171 | void setSpikeRejection(int rejection); 172 | 173 | /** 174 | * Read the resonator frequency since last calibration run. If 0, the detector has not 175 | * been calibrated yet. The frequency was measured and is not 100% accurate. 176 | */ 177 | unsigned long getFrequency() const; 178 | 179 | /** 180 | * Read the estimated energy of the last lightning or disturber. The energy has no 181 | * actual physical unit. 182 | */ 183 | unsigned long getEnergy() const; 184 | 185 | /** 186 | * Read the estimated distance of the head of the approaching storm. The distance is 187 | * returned in kilometres. 1 means that the storm is overhead. 0x3F means that a 188 | * possible storm is out of range. 189 | */ 190 | unsigned int getEstimatedDistance() const; 191 | 192 | /** 193 | * Return the number of detected disturbers per minute. The value is cleared when 194 | * clearDetections() is invoked. 195 | */ 196 | unsigned int getDisturbersPerMinute() const; 197 | 198 | /** 199 | * Return one of the last detected lightnings. Lightnings are always returned in 200 | * descending order, starting from the most recent event. 201 | * 202 | * @param index Index number of lightning detection, starting with 0 203 | * @param lightning Target structure 204 | * @return true if the target structure was filled with lightning data, false if 205 | * there is no more lightning data. 206 | */ 207 | bool getLastLightningDetection(int index, Lightning& lightning) const; 208 | 209 | /** 210 | * Return the time of the last detected disturber. 211 | */ 212 | unsigned long getLastDisturber() const; 213 | 214 | /** 215 | * Clear all detected lightnings. 216 | */ 217 | void clearDetections(); 218 | 219 | /** 220 | * Dump the AS3935 register set. 221 | * 222 | * @param dump Dump target, must be able to contain 51 bytes. 223 | */ 224 | void dump(byte* dump) const; 225 | 226 | /** 227 | * Debug the AS3935 detector by dumping all registers to the console. 228 | */ 229 | void debug() const; 230 | 231 | private: 232 | int csPin; 233 | int intPin; 234 | unsigned long frequency; 235 | unsigned long lastNoiseLevelChange; 236 | unsigned long lastNoiseLevelRaise; 237 | unsigned long disturberCounterStart; 238 | unsigned long lastDisturber; 239 | int noiseLevelBalance; 240 | int currentNoiseFloorLevel; 241 | unsigned int disturberCounter; 242 | bool currentOutdoorMode; 243 | bool noiseFloorLevelOutOfRange; 244 | Lightning lastLightningDetections[64]; 245 | 246 | /** 247 | * Open the connection to the detector. 248 | * 249 | * There is no check whether SPI is currently in use! 250 | */ 251 | void open() const; 252 | 253 | /** 254 | * Close the connection to the detector. 255 | */ 256 | void close() const; 257 | 258 | /** 259 | * Write to a register. 260 | * 261 | * @param address Register address to write 262 | * @param value New register value 263 | */ 264 | void spiWrite(byte address, byte value) const; 265 | 266 | /** 267 | * Read from a register. 268 | * 269 | * @param address Register address to read 270 | * @return Current register value 271 | */ 272 | byte spiRead(byte address) const; 273 | 274 | /** 275 | * Read the current noise floor level from the detector, and update the object's 276 | * state accordingly. 277 | */ 278 | void updateNoiseFloorLevel(); 279 | 280 | }; 281 | 282 | #endif -------------------------------------------------------------------------------- /kaminari/Config.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Kaminari 3 | * 4 | * Copyright (C) 2020 Richard "Shred" Körber 5 | * https://codeberg.org/shred/kaminari 6 | * 7 | * This program is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | */ 17 | 18 | #include 19 | #include 20 | 21 | #include "Config.h" 22 | 23 | #define CHECKSUM_ADDRESS 0xF00 24 | #define CHECKSUM_VALUE 0x8F 25 | 26 | void ConfigManager::begin() { 27 | EEPROMr.offset(0xFF0); 28 | EEPROMr.begin(4096); 29 | EEPROMr.get(0, config); 30 | 31 | int checksum = EEPROMr.read(CHECKSUM_ADDRESS); 32 | if (checksum != CHECKSUM_VALUE) { 33 | EEPROMr.write(CHECKSUM_ADDRESS, CHECKSUM_VALUE); 34 | init(); 35 | } 36 | } 37 | 38 | void ConfigManager::init() { 39 | config.ledEnabled = true; 40 | config.blueBrightness = 48; 41 | config.disturberBrightness = 100; 42 | config.watchdogThreshold = 2; 43 | config.minimumNumberOfLightning = 1; 44 | config.spikeRejection = 2; 45 | config.outdoorMode = false; 46 | 47 | Serial.println("Configuration was initialized."); 48 | commit(); 49 | } 50 | 51 | void ConfigManager::commit() { 52 | EEPROMr.put(0, config); 53 | if (EEPROMr.commit()) { 54 | Serial.println("Configuration was persisted."); 55 | } else { 56 | Serial.println("Failed to persist configuration."); 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /kaminari/Config.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Kaminari 3 | * 4 | * Copyright (C) 2020 Richard "Shred" Körber 5 | * https://codeberg.org/shred/kaminari 6 | * 7 | * This program is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | */ 17 | 18 | #ifndef __Config__ 19 | #define __Config__ 20 | 21 | #include 22 | 23 | /** 24 | * Kaminari's permanent configuration. 25 | */ 26 | struct Config { 27 | int watchdogThreshold; 28 | int minimumNumberOfLightning; 29 | int spikeRejection; 30 | int blueBrightness; 31 | bool ledEnabled; 32 | bool outdoorMode; 33 | int disturberBrightness; 34 | }; 35 | 36 | /** 37 | * Manager for the configuration structure. 38 | */ 39 | class ConfigManager { 40 | public: 41 | 42 | /** 43 | * Set up the config, reading the config from EEPROM. 44 | */ 45 | void begin(); 46 | 47 | /** 48 | * Initialize the configuration, by setting default values. 49 | */ 50 | void init(); 51 | 52 | /** 53 | * Commit changes to the config in the EEPROM. 54 | */ 55 | void commit(); 56 | 57 | /** 58 | * The configuration itself. 59 | */ 60 | Config config; 61 | 62 | private: 63 | EEPROM_Rotate EEPROMr; 64 | }; 65 | 66 | #endif -------------------------------------------------------------------------------- /kaminari/kaminari.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * Kaminari 3 | * 4 | * Copyright (C) 2020 Richard "Shred" Körber 5 | * https://codeberg.org/shred/kaminari 6 | * 7 | * This program is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | */ 17 | 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | 27 | #include "AS3935.h" 28 | #include "Config.h" 29 | #include "myWiFi.h" 30 | 31 | #define SPI_CS 15 // IO15 (D8) 32 | #define SPI_MOSI 13 // IO13 (D7) 33 | #define SPI_MISO 12 // IO12 (D6) 34 | #define SPI_SCK 14 // IO14 (D5) 35 | #define AS_INT 5 // IO5 (D1) 36 | #define NEOPIXEL 4 // IO4 (D2) 37 | 38 | #define PORT 80 39 | 40 | #define COLOR_CONNECTING 0x00800000 41 | #define COLOR_CALIBRATING 0x00404000 42 | #define COLOR_BLACK 0x00000000 43 | 44 | #define DISTANCE_ANIMATION_TIME 5000 45 | #define ENERGY_ANIMATION_TIME 500 46 | #define DISTURBER_ANIMATION_TIME 1000 47 | 48 | ConfigManager cfgMgr; 49 | ESP8266WebServer server(PORT); 50 | AS3935 detector(SPI_CS, AS_INT); 51 | Adafruit_NeoPixel neopixel(1, NEOPIXEL, NEO_GRBW + NEO_KHZ800); 52 | WiFiClient wifiClient; 53 | PubSubClient client(MY_MQTT_SERVER_HOST, MY_MQTT_SERVER_PORT, wifiClient); 54 | WiFiEventHandler connectedEventHandler, gotIpEventHandler, disconnectedEventHandler; 55 | 56 | unsigned long beforeAnimation = millis(); 57 | unsigned long beforeMqttConnection = millis(); 58 | bool connected = false; 59 | unsigned int currentColor = 0; 60 | Lightning ledLightning; 61 | 62 | inline static unsigned long timeDifference(unsigned long now, unsigned long past) { 63 | // This is actually safe from millis() overflow because all types are unsigned long! 64 | return past > 0 ? (now - past) : 0; 65 | } 66 | 67 | void sendJsonResponse(ArduinoJson::JsonDocument &doc, int status = 200) { 68 | String json; 69 | serializeJson(doc, json); 70 | server.send(status, "application/json", json); 71 | } 72 | 73 | bool authenticated() { 74 | if (server.header("X-API-Key") == MY_APIKEY) { 75 | return true; 76 | } 77 | if (server.arg("api_key") == MY_APIKEY) { 78 | return true; 79 | } 80 | server.send(403); 81 | return false; 82 | } 83 | 84 | void handleStatus() { 85 | DynamicJsonDocument doc(8192); 86 | 87 | unsigned long now = millis(); 88 | 89 | JsonArray la = doc.createNestedArray("lightnings"); 90 | Lightning lightning; 91 | for (int ix = 0; ; ix++) { 92 | if (!detector.getLastLightningDetection(ix, lightning)) { 93 | break; 94 | } 95 | StaticJsonDocument<200> subdoc; 96 | subdoc["age"] = timeDifference(now, lightning.time) / 1000; 97 | subdoc["energy"] = lightning.energy; 98 | if (lightning.distance < 0x3F) { 99 | subdoc["distance"] = lightning.distance; 100 | } else { 101 | subdoc["distance"] = (char*) NULL; 102 | } 103 | la.add(subdoc); 104 | } 105 | 106 | unsigned int distance = detector.getEstimatedDistance(); 107 | if (distance < 0x3F) { 108 | doc["distance"] = distance; 109 | } else { 110 | doc["distance"] = (char*) NULL; 111 | } 112 | 113 | doc["energy"] = detector.getEnergy(); 114 | doc["noiseFloorLevel"] = detector.getNoiseFloorLevel(); 115 | doc["disturbersPerMinute"] = detector.getDisturbersPerMinute(); 116 | doc["watchdogThreshold"] = detector.getWatchdogThreshold(); 117 | doc["wifiSignalStrength"] = WiFi.RSSI(); 118 | 119 | sendJsonResponse(doc); 120 | } 121 | 122 | void handleSettings() { 123 | DynamicJsonDocument doc(1024); 124 | doc["tuning"] = detector.getFrequency(); 125 | doc["noiseFloorLevel"] = detector.getNoiseFloorLevel(); 126 | doc["outdoorMode"] = detector.getOutdoorMode(); 127 | doc["watchdogThreshold"] = detector.getWatchdogThreshold(); 128 | doc["minimumNumberOfLightning"] = detector.getMinimumNumberOfLightning(); 129 | doc["spikeRejection"] = detector.getSpikeRejection(); 130 | doc["outdoorMode"] = detector.getOutdoorMode(); 131 | doc["statusLed"] = cfgMgr.config.ledEnabled; 132 | doc["blueBrightness"] = cfgMgr.config.blueBrightness; 133 | doc["disturberBrightness"] = cfgMgr.config.disturberBrightness; 134 | sendJsonResponse(doc); 135 | } 136 | 137 | void handleUpdate() { 138 | if (authenticated()) { 139 | bool needsClearing = false; 140 | 141 | if (server.hasArg("watchdogThreshold")) { 142 | long val = String(server.arg("watchdogThreshold")).toInt(); 143 | if (val >= 0 && val <= 10) { 144 | cfgMgr.config.watchdogThreshold = val; 145 | detector.setWatchdogThreshold(val); 146 | needsClearing = true; 147 | } 148 | } 149 | 150 | if (server.hasArg("minimumNumberOfLightning")) { 151 | long val = String(server.arg("minimumNumberOfLightning")).toInt(); 152 | if (val == 1 || val == 5 || val == 9 || val == 16) { 153 | cfgMgr.config.minimumNumberOfLightning = val; 154 | detector.setMinimumNumberOfLightning(val); 155 | } 156 | } 157 | 158 | if (server.hasArg("spikeRejection")) { 159 | long val = String(server.arg("spikeRejection")).toInt(); 160 | if (val >= 0 && val <= 11) { 161 | cfgMgr.config.spikeRejection = val; 162 | detector.setSpikeRejection(val); 163 | needsClearing = true; 164 | } 165 | } 166 | 167 | if (server.hasArg("outdoorMode")) { 168 | bool val = String(server.arg("outdoorMode")) == "true"; 169 | cfgMgr.config.outdoorMode = val; 170 | detector.setOutdoorMode(val); 171 | needsClearing = true; 172 | } 173 | 174 | if (server.hasArg("statusLed")) { 175 | cfgMgr.config.ledEnabled = String(server.arg("statusLed")) == "true"; 176 | } 177 | 178 | if (server.hasArg("blueBrightness")) { 179 | long val = String(server.arg("blueBrightness")).toInt(); 180 | if (val >= 0 && val <= 255) { 181 | cfgMgr.config.blueBrightness = val; 182 | } 183 | } 184 | 185 | if (server.hasArg("disturberBrightness")) { 186 | long val = String(server.arg("disturberBrightness")).toInt(); 187 | if (val >= 0 && val <= 255) { 188 | cfgMgr.config.disturberBrightness = val; 189 | } 190 | } 191 | 192 | cfgMgr.commit(); 193 | handleSettings(); 194 | 195 | if (needsClearing) { 196 | // clear detector statistics after changing the detector config 197 | detector.clearStatistics(); 198 | } 199 | } 200 | } 201 | 202 | void handleCalibrate() { 203 | if (authenticated()) { 204 | unsigned int oldColor = currentColor; 205 | color(COLOR_CALIBRATING); 206 | StaticJsonDocument<200> doc; 207 | doc["tuning"] = detector.calibrate(); 208 | sendJsonResponse(doc); 209 | color(oldColor); 210 | } 211 | } 212 | 213 | void handleClear() { 214 | if (authenticated()) { 215 | detector.clearDetections(); 216 | server.send(200, "text/plain", "OK"); 217 | } 218 | } 219 | 220 | void handleReset() { 221 | if (authenticated()) { 222 | detector.reset(); 223 | handleCalibrate(); 224 | setupDetector(); 225 | detector.clearStatistics(); 226 | } 227 | } 228 | 229 | void sendMqttStatus() { 230 | DynamicJsonDocument doc(8192); 231 | String json; 232 | 233 | Lightning lightning; 234 | if (detector.getLastLightningDetection(0, lightning)) { 235 | doc["energy"] = lightning.energy; 236 | if (lightning.distance < 0x3F) { 237 | doc["distance"] = lightning.distance; 238 | } else { 239 | doc["distance"] = (char*) NULL; 240 | } 241 | } else { 242 | doc["energy"] = (char*) NULL; 243 | doc["distance"] = (char*) NULL; 244 | } 245 | 246 | doc["tuning"] = detector.getFrequency(); 247 | doc["noiseFloorLevel"] = detector.getNoiseFloorLevel(); 248 | doc["disturbersPerMinute"] = detector.getDisturbersPerMinute(); 249 | doc["watchdogThreshold"] = detector.getWatchdogThreshold(); 250 | doc["wifiSignalStrength"] = WiFi.RSSI(); 251 | 252 | serializeJson(doc, json); 253 | if (!client.publish(MY_MQTT_TOPIC, json.c_str(), MY_MQTT_RETAIN)) { 254 | Serial.print("Failed to send MQTT message, rc="); 255 | Serial.println(client.state()); 256 | } 257 | } 258 | 259 | void setupDetector() { 260 | detector.setOutdoorMode(cfgMgr.config.outdoorMode); 261 | detector.setWatchdogThreshold(cfgMgr.config.watchdogThreshold); 262 | detector.setMinimumNumberOfLightning(cfgMgr.config.minimumNumberOfLightning); 263 | detector.setSpikeRejection(cfgMgr.config.spikeRejection); 264 | } 265 | 266 | void color(unsigned int color) { 267 | if (color != currentColor) { 268 | neopixel.fill(color); 269 | neopixel.show(); 270 | currentColor = color; 271 | } 272 | } 273 | 274 | inline int limit(int v) { 275 | return v <= 255 ? (v >= 0 ? v : 0): 255; 276 | } 277 | 278 | void updateColor(unsigned long now) { 279 | if (!connected) { 280 | color(now % 1000 <= 500 ? COLOR_CONNECTING : COLOR_BLACK); 281 | return; 282 | } 283 | 284 | if (!cfgMgr.config.ledEnabled) { 285 | color(COLOR_BLACK); 286 | return; 287 | } 288 | 289 | // Calculate blue color (noise floor level) 290 | int blue = 0; 291 | if (detector.isNoiseFloorLevelOutOfRange()) { 292 | blue = now % 1000 <= 500 ? (cfgMgr.config.blueBrightness > 128 ? cfgMgr.config.blueBrightness : 128) : 0; 293 | } else { 294 | blue = detector.getNoiseFloorLevel() * cfgMgr.config.blueBrightness / (detector.getOutdoorMode() ? 2000 : 146); 295 | } 296 | 297 | // Calculate lightning age (white) and distance (green to red) 298 | long red = 0; 299 | long green = 0; 300 | long white = 0; 301 | if (ledLightning.time > 0 && ledLightning.distance <= 40) { 302 | unsigned long diff = timeDifference(now, ledLightning.time); 303 | long distancePast = (DISTANCE_ANIMATION_TIME + ENERGY_ANIMATION_TIME) - diff; 304 | long energyPast = ENERGY_ANIMATION_TIME - diff; 305 | if (energyPast >= 0) { 306 | white = (( ledLightning.energy ) * energyPast * 255) / (300000 * ENERGY_ANIMATION_TIME); 307 | blue = 0; 308 | } else if (distancePast >= 0) { 309 | green = (( ledLightning.distance) * distancePast * 255) / (40 * DISTANCE_ANIMATION_TIME); 310 | red = ((40 - ledLightning.distance) * distancePast * 255) / (40 * DISTANCE_ANIMATION_TIME); 311 | long newblue = ((long) blue) * diff / (DISTANCE_ANIMATION_TIME + ENERGY_ANIMATION_TIME); 312 | if (newblue < blue) { 313 | blue = newblue; 314 | } 315 | } 316 | } 317 | 318 | // Calculate last disturber fade 319 | unsigned long lastDisturber = detector.getLastDisturber(); 320 | unsigned long disturberDiff = timeDifference(now, lastDisturber); 321 | if (cfgMgr.config.disturberBrightness > 0 && lastDisturber != 0 && disturberDiff <= DISTURBER_ANIMATION_TIME) { 322 | red = (cfgMgr.config.disturberBrightness * (DISTURBER_ANIMATION_TIME - disturberDiff)) / DISTURBER_ANIMATION_TIME; 323 | } 324 | 325 | color( (limit(white) & 0xFF) << 24 326 | | (limit(red ) & 0xFF) << 16 327 | | (limit(green) & 0xFF) << 8 328 | | (limit(blue ) & 0xFF)); 329 | } 330 | 331 | void setup() { 332 | Serial.begin(115200); 333 | Serial.println(""); 334 | 335 | cfgMgr.begin(); 336 | 337 | detector.begin(); 338 | 339 | neopixel.begin(); 340 | neopixel.setBrightness(255); 341 | 342 | // Init detector 343 | color(COLOR_CALIBRATING); 344 | Serial.println("Calibrating antenna..."); 345 | detector.reset(); 346 | unsigned int freq = detector.calibrate(); 347 | Serial.print("Calibrated antenna frequency: "); 348 | Serial.print(freq); 349 | Serial.println(" Hz"); 350 | color(COLOR_BLACK); 351 | 352 | // Set up the detector 353 | setupDetector(); 354 | 355 | // Start WiFi 356 | WiFi.setSleepMode(WIFI_NONE_SLEEP); 357 | WiFi.mode(WIFI_STA); 358 | connectedEventHandler = WiFi.onStationModeConnected([](const WiFiEventStationModeConnected& event) { 359 | Serial.print("WiFi connected to: "); 360 | Serial.println(WiFi.SSID()); 361 | Serial.print("MAC: "); 362 | Serial.println(WiFi.macAddress()); 363 | }); 364 | gotIpEventHandler = WiFi.onStationModeGotIP([](const WiFiEventStationModeGotIP& event) { 365 | Serial.print("IP address: "); 366 | Serial.println(WiFi.localIP()); 367 | server.begin(); 368 | Serial.print("Server is listening on port: "); 369 | Serial.println(PORT); 370 | connected = true; 371 | }); 372 | disconnectedEventHandler = WiFi.onStationModeDisconnected([](const WiFiEventStationModeDisconnected& event) { 373 | connected = false; 374 | Serial.println("WiFi connection lost. Reconnecting..."); 375 | WiFi.begin(MY_SSID, MY_PSK); 376 | }); 377 | WiFi.begin(MY_SSID, MY_PSK); 378 | 379 | // Start MDNS 380 | if (MDNS.begin(MY_MDNS_NAME)) { 381 | Serial.println("MDNS responder started"); 382 | MDNS.addService("http", "tcp", PORT); 383 | } 384 | 385 | // Start server 386 | server.on("/status", handleStatus); 387 | server.on("/settings", handleSettings); 388 | server.on("/update", handleUpdate); 389 | server.on("/calibrate", handleCalibrate); 390 | server.on("/clear", handleClear); 391 | server.on("/reset", handleReset); 392 | server.onNotFound([]() { 393 | server.send(404, "text/plain", server.uri() + ": not found\n"); 394 | }); 395 | const char * headerkeys[] = { "X-API-Key" }; 396 | server.collectHeaders(headerkeys, sizeof(headerkeys) / sizeof(char*)); 397 | } 398 | 399 | void loop() { 400 | const unsigned long now = millis(); 401 | 402 | if (connected) { 403 | server.handleClient(); 404 | MDNS.update(); 405 | 406 | #ifdef MY_MQTT_ENABLED 407 | if (!client.loop() && timeDifference(now, beforeMqttConnection) > 1000) { 408 | beforeMqttConnection = now; 409 | if (client.connect(MY_MQTT_CLIENT_ID, MY_MQTT_USER, MY_MQTT_PASSWORD)) { 410 | Serial.println("Successfully connected to MQTT server"); 411 | } else { 412 | Serial.print("Connection to MQTT server failed, rc="); 413 | Serial.println(client.state()); 414 | } 415 | } 416 | #endif 417 | } 418 | 419 | if (detector.update()) { 420 | if (!detector.getLastLightningDetection(0, ledLightning)) { 421 | ledLightning.time = 0; 422 | } 423 | #ifdef MY_MQTT_ENABLED 424 | if (connected && client.connected()) { 425 | sendMqttStatus(); 426 | } 427 | #endif 428 | } 429 | 430 | if (timeDifference(now, beforeAnimation) > 50) { 431 | beforeAnimation = now; 432 | updateColor(now); 433 | } 434 | } 435 | -------------------------------------------------------------------------------- /kaminari/myWiFi.h.example: -------------------------------------------------------------------------------- 1 | /* 2 | * Kaminari 3 | * 4 | * Copyright (C) 2020 Richard "Shred" Körber 5 | * https://codeberg.org/shred/kaminari 6 | * 7 | * This program is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | */ 17 | 18 | // The name of your WLAN 19 | #define MY_SSID "HomeSweetHome" 20 | 21 | // Your WLAN's password 22 | #define MY_PSK "mYsEcReTpAsSwOrD" 23 | 24 | // A random API key to protect your lightning detector from unauthorized access 25 | #define MY_APIKEY "mYsEcReTaPiKeY" 26 | 27 | // The MDNS name of your detector 28 | #define MY_MDNS_NAME "kaminari" 29 | 30 | // ---- MQTT ---------------------------------------------- 31 | // Uncomment the next line to enable MQTT 32 | // #define MY_MQTT_ENABLED 33 | 34 | // MQTT server host name 35 | #define MY_MQTT_SERVER_HOST "mqtt.localdomain" 36 | 37 | // Port of the MQTT server, usually 1883 38 | #define MY_MQTT_SERVER_PORT 1883 39 | 40 | // MQTT Client ID (just use the default if in doubt) 41 | #define MY_MQTT_CLIENT_ID "kaminari-1" 42 | 43 | // User name for MQTT server authentication, NULL if no authentication needed 44 | #define MY_MQTT_USER "kaminari" 45 | 46 | // Password for MQTT server authentication, NULL if no authentication needed 47 | #define MY_MQTT_PASSWORD "mYsEcReTmQtTpAsSwOrD" 48 | 49 | // MQTT topic to be used 50 | #define MY_MQTT_TOPIC "sensors/lightning" 51 | 52 | // Set to true if message should be retained 53 | #define MY_MQTT_RETAIN false 54 | --------------------------------------------------------------------------------