├── .gitignore ├── .gitmodules ├── .travis.yml ├── LICENSE.txt ├── Makefile ├── README.md ├── examples ├── Receive │ └── Receive.ino ├── Receive_Raw │ └── Receive_Raw.ino ├── Transmit │ └── Transmit.ino ├── Transmit_Raw │ └── Transmit_Raw.ino ├── pilight_debug │ └── pilight_debug.ino └── pilight_raw │ └── pilight_raw.ino ├── keywords.txt ├── library.json ├── library.properties ├── src ├── ESPiLight.cpp ├── ESPiLight.h ├── pilight │ └── libs │ │ └── pilight │ │ ├── core │ │ ├── common.h │ │ ├── gc.h │ │ ├── log.h │ │ └── pilight.h │ │ └── protocols │ │ ├── protocol.c │ │ └── protocol.h └── tools │ ├── aprintf.cpp │ └── aprintf.h └── tests ├── test_echo └── test_echo.ino ├── test_parse └── test_parse.ino └── test_proto_limit └── test_proto_limit.ino /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | src/pilight/libs/pilight/core/binary.c 3 | src/pilight/libs/pilight/core/binary.h 4 | src/pilight/libs/pilight/core/dso.h 5 | src/pilight/libs/pilight/core/json.c 6 | src/pilight/libs/pilight/core/json.h 7 | src/pilight/libs/pilight/core/mem.h 8 | src/pilight/libs/pilight/protocols/433.92/* 9 | src/pilight/libs/pilight/protocols/protocol_header.h 10 | src/pilight/libs/pilight/protocols/protocol_init.h 11 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "pilight"] 2 | path = pilight 3 | url = https://github.com/pilight/pilight 4 | branch = staging 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | 4 | # Cache PlatformIO packages using Travis CI container-based infrastructure 5 | sudo: false 6 | cache: 7 | directories: 8 | - "~/.platformio" 9 | 10 | env: 11 | - PLATFORMIO_CI_SRC=tests/test_parse 12 | - PLATFORMIO_CI_SRC=tests/test_proto_limit 13 | - PLATFORMIO_CI_SRC=tests/test_echo 14 | - PLATFORMIO_CI_SRC=examples/Receive 15 | - PLATFORMIO_CI_SRC=examples/Receive_Raw 16 | - PLATFORMIO_CI_SRC=examples/Transmit 17 | - PLATFORMIO_CI_SRC=examples/Transmit_Raw 18 | 19 | install: 20 | # PlatformIO 21 | - pip install -U platformio 22 | # integrate pilight 23 | - make 24 | 25 | script: 26 | - platformio ci --lib="." --board=huzzah --board=d1_mini --board=esp32dev 27 | - make stylecheck 28 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # ESPiLight - pilight 433.92 MHz protocols library for Arduino 2 | # Copyright (c) 2016 Puuu. All right reserved. 3 | # 4 | # Project home: https://github.com/puuu/espilight/ 5 | # This library is free software; you can redistribute it and/or 6 | # modify it under the terms of the GNU Lesser General Public 7 | # License as published by the Free Software Foundation; either 8 | # version 3 of the License, or (at your option) any later version. 9 | # This library is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | # Lesser General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with library. If not, see 16 | 17 | SRC_DIR = pilight 18 | 19 | DST_DIR = src/pilight 20 | PROTOCOL_DIR = libs/pilight/protocols/433.92 21 | 22 | PROTOCOLS = $(patsubst $(SRC_DIR)/$(PROTOCOL_DIR)/%.h,%,$(sort $(wildcard $(SRC_DIR)/$(PROTOCOL_DIR)/*.h))) 23 | 24 | PILIGHT_FILES = libs/pilight/core/dso.h libs/pilight/core/mem.h \ 25 | libs/pilight/core/json.h libs/pilight/core/json.c \ 26 | libs/pilight/core/binary.h libs/pilight/core/binary.c \ 27 | libs/pilight/protocols/protocol_header.h \ 28 | libs/pilight/protocols/protocol_init.h 29 | PROTOCOL_H_FILES = $(foreach protocol,$(PROTOCOLS),$(PROTOCOL_DIR)/$(protocol).h) 30 | PROTOCOL_C_FILES = $(foreach protocol,$(PROTOCOLS),$(PROTOCOL_DIR)/$(protocol).c) 31 | FILES = $(PILIGHT_FILES) $(PROTOCOL_H_FILES) $(PROTOCOL_C_FILES) 32 | 33 | DST_FILES = $(foreach file,$(FILES),$(DST_DIR)/$(file)) 34 | 35 | .PHONY: all clean copy update release 36 | 37 | all: $(SRC_DIR)/libs 38 | $(MAKE) -e copy 39 | 40 | copy: $(DST_FILES) 41 | 42 | $(DST_DIR)/%: $(SRC_DIR)/% 43 | @mkdir -p $(@D) 44 | cp $< $@ 45 | 46 | $(DST_DIR)/libs/pilight/core/json.c: $(SRC_DIR)/libs/pilight/core/json.c 47 | @mkdir -p $(@D) 48 | cp $< $@ 49 | # ESP8266 Android, sprintf not working with float. Patch: 50 | sed 's/\(^[ \t]*\)\(sprintf(buf, "%.*f", decimals, num);\)/#ifdef ESP8266\n\1dtostrf(num, 0, decimals, buf);\n#else\n\1\2\n#endif/' -i $@ 51 | # Arduino did not provide printf, fprintf 52 | sed 's!#include !#include \n#include "../../../../tools/aprintf.h"!' -i $@ 53 | 54 | $(DST_DIR)/libs/pilight/protocols/protocol_header.h: 55 | for protocol in $(PROTOCOLS); do\ 56 | echo "#include \"433.92/$${protocol}.h\"" >> $@;\ 57 | done 58 | 59 | $(DST_DIR)/libs/pilight/protocols/protocol_init.h: $(foreach file,$(PROTOCOL_C_FILES),$(DST_DIR)/$(file)) 60 | for cfile in $^; do\ 61 | grep 'void .*Init(' $$cfile | sed 's/void \(.*Init\)(.*/\1();/' >> $@;\ 62 | done 63 | 64 | pilight/libs: 65 | git submodule update --init pilight 66 | 67 | update: 68 | $(MAKE) clean 69 | git submodule update pilight 70 | $(MAKE) copy 71 | 72 | release: $(SRC_DIR)/libs 73 | git checkout release 74 | git merge master 75 | make update 76 | git add src/pilight 77 | git commit -m "integrate new pilight files" 78 | @echo "change log:" 79 | @git log --pretty="* %s" --no-merges HEAD...`git describe --abbrev=0 --tags` 80 | @git submodule summary `git describe --abbrev=0 --tags` 81 | @echo "run: git tag -a v"`grep version library.properties | sed 's/version=\(.*\)/\1/g'` 82 | 83 | clean: 84 | -rm $(DST_FILES) 85 | 86 | stylecheck: 87 | RESULT=0;\ 88 | for file in src/*.h src/*.cpp src/tools/*.h src/tools/*.cpp tests/*/*.ino examples/*/*.ino; do\ 89 | clang-format -style=google "$$file" | diff -u "$$file" - || RESULT=$$?;\ 90 | done;\ 91 | exit $$RESULT 92 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://travis-ci.org/puuu/ESPiLight.svg?branch=master)](https://travis-ci.org/puuu/ESPiLight) 2 | 3 | # ESPiLight 4 | 5 | This Arduino library is a port of the [pilight](https://pilight.org/) 6 | 433.92MHz protocols to the Arduino platform. It was tested with a 7 | ESP8266. The aim is to transmit, receive and parse many 433.92MHz 8 | protocols, by providing a simple Arduino friendly API. This should 9 | help to implement IoT bridges between the 434MHz-RF band and internet 10 | protocols. 11 | 12 | By porting the C modules of the pilight protocols, allows to 13 | participate on the excellent work of the pilight community. Thus, 14 | supporting many protocols for rc switches and weather stations without 15 | reimplementing them. 16 | 17 | A list of supported protocols can be found in the pilight manual: 18 | https://manual.pilight.org/protocols/433.92/index.html 19 | 20 | 21 | ## Installation 22 | 23 | This library can be easily installed with the Arduino Library Manager. 24 | 25 | 26 | ## Usage 27 | 28 | Please have a look to the examples. 29 | 30 | 31 | ### Requirements 32 | 33 | This library was tested and developed for the 34 | [ESP8266](https://github.com/esp8266/Arduino). It may not run on a 35 | ATmega-based boards, because of memory usage. 36 | 37 | For transmitting and receiving you need 434MHz-RF modules. More 38 | information can be found here: 39 | - https://wiki.pilight.org/receivers 40 | - https://wiki.pilight.org/senders 41 | - https://github.com/sui77/rc-switch/wiki/List_TransmitterReceiverModules 42 | 43 | 44 | ## Contributing 45 | 46 | If you find any bug, feel free to open an issue at github. Also, pull 47 | requests are welcome. The development takes place in the `master` 48 | branch. The `release` is used to integrate the pilight files and for 49 | version tagging, like necessary for the Arduino Library Manager 50 | crawler. 51 | 52 | To prevent formating issues, please make sure that your code is proper 53 | formatted. We use the `clang-format` tool with the `Google` style. 54 | You can just format the code by calling 55 | ```console 56 | $ clang-format -style=Google -i 57 | ``` 58 | 59 | 60 | ### Install from source 61 | 62 | If you are interested to install this library from source, you need to 63 | integrate the pilight source files. Since Arduino build all cpp/c 64 | files in the src directory and sub directories, only necessary files 65 | from pilight will be integrated. This will be done with GNU make. 66 | 67 | On Linux you can run: 68 | ```console 69 | $ git clone https://github.com/puuu/ESPiLight/ 70 | $ cd ESPiLight 71 | $ make 72 | $ ln -s `pwd` ~/Arduino/libraries/ 73 | ``` 74 | 75 | On MacOS you can run: 76 | ```console 77 | $ git clone https://github.com/puuu/ESPiLight/ 78 | $ cd ESPiLight 79 | $ make 80 | $ ln -s `pwd` ~/Documents/Arduino/libraries/ 81 | ``` 82 | 83 | 84 | #### Update 85 | 86 | To update ESPiLight from git run: 87 | ```console 88 | $ git pull 89 | $ make update 90 | ``` 91 | 92 | 93 | #### New protocols 94 | 95 | ESPiLight only supports the 434MHz protocols supported by 96 | [pilight](https://pilight.org/). If you are missing any protocol, 97 | please report it directly to pilight. After the intergratrion into 98 | pilight it can be merged into ESPILight. 99 | 100 | To report new protocols, please folow the 101 | [rules](https://forum.pilight.org/showthread.php?tid=761) of the 102 | [pilight forum](https://forum.pilight.org/). It is recommended to use 103 | pilight directly. Alternativly, ESPiLight offers the 104 | [`pilight_debug`](examples/pilight_debug/pilight_debug.ino) and 105 | [`pilight_raw`](examples/pilight_raw/pilight_raw.ino) examples that 106 | mimic tht pilight counterparts. 107 | 108 | 109 | ## Acknowledgement 110 | 111 | Big thanks goes to the pilight community, which implemented all the 112 | 434MHz protocols. If you want to integrate more protocols, please 113 | contribute directly to [pilight](https://pilight.org/). 114 | 115 | [@janLo](https://github.com/janLo) [contributed](https://github.com/puuu/ESPiLight/graphs/contributors) some major cleanups and new functionalities to the library. 116 | 117 | ## Other similar projects 118 | 119 | There are other, more lightweight 434Mhz implementations: 120 | - https://github.com/sui77/rc-switch 121 | - https://bitbucket.org/fuzzillogic/433mhzforarduino/wiki/Home 122 | -------------------------------------------------------------------------------- /examples/Receive/Receive.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPilight receive example 3 | 4 | https://github.com/puuu/espilight 5 | */ 6 | 7 | #include 8 | 9 | #define RECEIVER_PIN 4 // any intterupt able pin 10 | #define TRANSMITTER_PIN 13 11 | 12 | ESPiLight rf(TRANSMITTER_PIN); // use -1 to disable transmitter 13 | 14 | // callback function. It is called on successfully received and parsed rc signal 15 | void rfCallback(const String &protocol, const String &message, int status, 16 | size_t repeats, const String &deviceID) { 17 | Serial.print("RF signal arrived ["); 18 | Serial.print(protocol); // protocoll used to parse 19 | Serial.print("]["); 20 | Serial.print(deviceID); // value of id key in json message 21 | Serial.print("] ("); 22 | Serial.print(status); // status of message, depending on repeat, either: 23 | // FIRST - first message of this protocoll within the 24 | // last 0.5 s 25 | // INVALID - message repeat is not equal to the 26 | // previous message 27 | // VALID - message is equal to the previous message 28 | // KNOWN - repeat of a already valid message 29 | Serial.print(") "); 30 | Serial.print(message); // message in json format 31 | Serial.println(); 32 | 33 | // check if message is valid and process it 34 | if (status == VALID) { 35 | Serial.print("Valid message: ["); 36 | Serial.print(protocol); 37 | Serial.print("] "); 38 | Serial.print(message); 39 | Serial.println(); 40 | } 41 | } 42 | 43 | void setup() { 44 | Serial.begin(115200); 45 | // set callback funktion 46 | rf.setCallback(rfCallback); 47 | // inittilize receiver 48 | rf.initReceiver(RECEIVER_PIN); 49 | } 50 | 51 | void loop() { 52 | // process input queue and may fire calllback 53 | rf.loop(); 54 | delay(10); 55 | } 56 | -------------------------------------------------------------------------------- /examples/Receive_Raw/Receive_Raw.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPiLight receive raw (pulse train) signal example 3 | 4 | https://github.com/puuu/espilight 5 | */ 6 | 7 | #include 8 | 9 | #define RECEIVER_PIN 4 // any intterupt able pin 10 | #define TRANSMITTER_PIN 13 11 | 12 | ESPiLight rf(TRANSMITTER_PIN); // use -1 to disable transmitter 13 | 14 | // callback function. It is called on successfully received and parsed rc signal 15 | void rfRawCallback(const uint16_t* codes, size_t length) { 16 | // print pulse lengths 17 | Serial.print("RAW signal: "); 18 | for (unsigned int i = 0; i < length; i++) { 19 | Serial.print(codes[i]); 20 | Serial.print(' '); 21 | } 22 | Serial.println(); 23 | 24 | // format of pilight USB Nano 25 | String data = rf.pulseTrainToString(codes, length); 26 | Serial.print("string format: "); 27 | Serial.print(data); 28 | Serial.println(); 29 | } 30 | 31 | void setup() { 32 | Serial.begin(115200); 33 | // set callback funktion for raw messages 34 | rf.setPulseTrainCallBack(rfRawCallback); 35 | // inittilize receiver 36 | rf.initReceiver(RECEIVER_PIN); 37 | } 38 | 39 | void loop() { 40 | // process input queue and may fire calllback 41 | rf.loop(); 42 | delay(10); 43 | } 44 | -------------------------------------------------------------------------------- /examples/Transmit/Transmit.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPiLight transmit example 3 | 4 | https://github.com/puuu/espilight 5 | */ 6 | 7 | #include 8 | 9 | #define TRANSMITTER_PIN 13 10 | 11 | ESPiLight rf(TRANSMITTER_PIN); 12 | 13 | void setup() { Serial.begin(115200); } 14 | 15 | // Toggle state of elro 800 switch evrey 2 s 16 | void loop() { 17 | rf.send("elro_800_switch", "{\"systemcode\":17,\"unitcode\":1,\"on\":1}"); 18 | delay(2000); 19 | rf.send("elro_800_switch", "{\"systemcode\":17,\"unitcode\":1,\"off\":1}"); 20 | delay(2000); 21 | } 22 | -------------------------------------------------------------------------------- /examples/Transmit_Raw/Transmit_Raw.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPiLight transmit RAW signal example 3 | 4 | https://github.com/puuu/espilight 5 | */ 6 | 7 | #include 8 | 9 | #define TRANSMITTER_PIN 13 10 | 11 | ESPiLight rf(TRANSMITTER_PIN); 12 | 13 | void setup() { 14 | Serial.begin(115200); 15 | 16 | int length = 0; 17 | uint16_t codes[MAXPULSESTREAMLENGTH]; 18 | 19 | // get pulse train from string (format see: pilight USB Nano) 20 | length = rf.stringToPulseTrain( 21 | "c:102020202020202020220202020020202200202200202020202020220020202203;p:" 22 | "279,2511,1395,9486@", 23 | codes, MAXPULSESTREAMLENGTH); 24 | 25 | // transmit the pulse train 26 | rf.sendPulseTrain(codes, length); 27 | } 28 | 29 | // Toggle state of elro 800 switch evrey 2 s 30 | void loop() { 31 | // stop 32 | } 33 | -------------------------------------------------------------------------------- /examples/pilight_debug/pilight_debug.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPiLight pilight_debug example 3 | 4 | This example mimic the output of the piligh_debug tool. 5 | 6 | https://github.com/puuu/espilight 7 | */ 8 | 9 | #include 10 | 11 | #define PULSE_DIV 34 12 | 13 | #define RECEIVER_PIN 4 // any intterupt able pin 14 | #define TRANSMITTER_PIN 13 15 | 16 | ESPiLight rf(TRANSMITTER_PIN); // use -1 to disable transmitter 17 | 18 | unsigned int normalize(unsigned int i, unsigned int pulselen) { 19 | double x; 20 | x = (double)i / pulselen; 21 | 22 | return (unsigned int)(round(x)); 23 | } 24 | 25 | // callback function. It is called on successfully received and parsed rc signal 26 | void rfRawCallback(const uint16_t* pulses, size_t length) { 27 | uint16_t pulse; 28 | uint16_t pulselen = pulses[length - 1] / PULSE_DIV; 29 | if (pulselen > 25) { 30 | for (unsigned int i = 3; i < length; i++) { 31 | if ((pulses[i] / pulselen) >= 2) { 32 | pulse = pulses[i]; 33 | break; 34 | } 35 | } 36 | if (normalize(pulse, pulselen) > 0 && length > 25) { 37 | /* Print everything */ 38 | Serial.println("--[RESULTS]--"); 39 | Serial.println(); 40 | Serial.print("time:\t\t"); 41 | Serial.print(millis()); 42 | Serial.println(" ms"); 43 | Serial.println("hardware:\tESPiLight"); 44 | Serial.print("pulse:\t\t"); 45 | Serial.println(normalize(pulse, pulselen)); 46 | Serial.print("rawlen:\t\t"); 47 | Serial.println(length); 48 | Serial.printf("pulselen:\t"); 49 | Serial.println(pulselen); 50 | Serial.println(); 51 | Serial.println("Raw code:"); 52 | for (unsigned int i = 0; i < length; i++) { 53 | Serial.print(pulses[i]); 54 | Serial.print(" "); 55 | } 56 | Serial.println(); 57 | } 58 | } 59 | } 60 | 61 | void setup() { 62 | Serial.begin(115200); 63 | // set callback funktion for raw messages 64 | rf.setPulseTrainCallBack(rfRawCallback); 65 | // inittilize receiver 66 | rf.initReceiver(RECEIVER_PIN); 67 | 68 | Serial.println( 69 | "Press and hold one of the buttons on your remote or wait until"); 70 | Serial.println("another device such as a weather station has sent new codes"); 71 | Serial.println( 72 | "The debugger will automatically reset itself after one second of"); 73 | Serial.println( 74 | "failed leads. It will keep running until you explicitly stop it."); 75 | } 76 | 77 | void loop() { 78 | // process input queue and may fire calllback 79 | rf.loop(); 80 | delay(10); 81 | } 82 | -------------------------------------------------------------------------------- /examples/pilight_raw/pilight_raw.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPiLight pilight_raw example 3 | 4 | This example mimic the output of the piligh_raw tool. 5 | 6 | https://github.com/puuu/espilight 7 | */ 8 | 9 | #include 10 | 11 | #define RECEIVER_PIN 4 // any intterupt able pin 12 | #define TRANSMITTER_PIN 13 13 | 14 | ESPiLight rf(TRANSMITTER_PIN); // use -1 to disable transmitter 15 | 16 | // callback function. It is called on successfully received and parsed rc signal 17 | void rfRawCallback(const uint16_t* pulses, size_t length) { 18 | Serial.print("ESPiLight:"); 19 | for (unsigned int i = 0; i < length; i++) { 20 | Serial.print(" "); 21 | Serial.print(pulses[i]); 22 | if (pulses[i] > 5100) { 23 | Serial.printf(" -# "); 24 | Serial.println(i); 25 | } 26 | } 27 | } 28 | 29 | void setup() { 30 | Serial.begin(115200); 31 | // set callback funktion for raw messages 32 | rf.setPulseTrainCallBack(rfRawCallback); 33 | // inittilize receiver 34 | rf.initReceiver(RECEIVER_PIN); 35 | } 36 | 37 | void loop() { 38 | // process input queue and may fire calllback 39 | rf.loop(); 40 | delay(10); 41 | } 42 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Syntax Coloring Map For ESPiLight 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | 9 | ESPiLight KEYWORD1 10 | 11 | ####################################### 12 | # Methods and Functions (KEYWORD2) 13 | ####################################### 14 | 15 | send KEYWORD2 16 | loop KEYWORD2 17 | 18 | initReceiver KEYWORD2 19 | setCallback KEYWORD2 20 | setPulseTrainCallBack KEYWORD2 21 | enableReceiver KEYWORD2 22 | disableReceiver KEYWORD2 23 | 24 | pulseTrainToString KEYWORD2 25 | stringToPulseTrain KEYWORD2 26 | createPulseTrain KEYWORD2 27 | sendPulseTrain KEYWORD2 28 | parsePulseTrain KEYWORD2 29 | receivePulseTrain KEYWORD2 30 | 31 | ####################################### 32 | # Instances (KEYWORD2) 33 | ####################################### 34 | 35 | ####################################### 36 | # Constants (LITERAL1) 37 | ####################################### 38 | 39 | MAXPULSESTREAMLENGTH LITERAL1 40 | 41 | FIRST LITERAL1 42 | INVALID LITERAL1 43 | VALID LITERAL1 44 | KNOWN LITERAL1 45 | -------------------------------------------------------------------------------- /library.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ESPiLight", 3 | "keywords": "pilight, 433MHz, 434MHz, rf", 4 | "description": "pilight 433.92 MHz protocols library for Arduino. With this port of pilight 433.92 MHz protocols, you can transmit, receive and parse all 434 MHz protocols (e.g., rc switches or weather stations) supported by pilight. This should help to implement IoT bridges between the 434MHz-RF band and internet protocols. It is developed and tested on ESP8266.", 5 | "repository": 6 | { 7 | "type": "git", 8 | "url": "https://github.com/puuu/ESPiLight.git" 9 | }, 10 | "version": "0.17.0", 11 | "license": "GPL-3.0", 12 | "frameworks": "arduino", 13 | "platforms": 14 | [ 15 | "espressif8266", 16 | "espressif32" 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=ESPiLight 2 | version=0.17.0 3 | author=Puuu 4 | maintainer=Puuu 5 | sentence=pilight 433.92 MHz protocols library for Arduino 6 | paragraph=With this port of pilight 433.92 MHz protocols, you can transmit, receive and parse all 434 MHz protocols (e.g., rc switches or weather stations) supported by pilight. This should help to implement IoT bridges between the 434MHz-RF band and internet protocols. It is developed and tested on ESP8266. 7 | category=Signal Input/Output 8 | url=https://github.com/puuu/espilight 9 | architectures=esp8266,esp32 10 | -------------------------------------------------------------------------------- /src/ESPiLight.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | ESPiLight - pilight 433.92 MHz protocols library for Arduino 3 | Copyright (c) 2016 Puuu. All right reserved. 4 | 5 | Project home: https://github.com/puuu/espilight/ 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 3 of the License, or (at your option) any later version. 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with library. If not, see 17 | */ 18 | 19 | #include 20 | #include "tools/aprintf.h" 21 | 22 | // ESP32 doesn't define ICACHE_RAM_ATTR 23 | #ifndef ICACHE_RAM_ATTR 24 | #define ICACHE_RAM_ATTR IRAM_ATTR 25 | #endif 26 | 27 | #ifdef DEBUG 28 | #define Debug(x) Serial.print(x) 29 | #define DebugLn(x) Serial.println(x) 30 | #else 31 | #define Debug(x) 32 | #define DebugLn(x) 33 | #endif 34 | 35 | extern "C" { 36 | #include "pilight/libs/pilight/protocols/protocol.h" 37 | } 38 | static protocols_t *used_protocols = nullptr; 39 | 40 | volatile PulseTrain_t ESPiLight::_pulseTrains[RECEIVER_BUFFER_SIZE]; 41 | bool ESPiLight::_enabledReceiver; 42 | volatile uint8_t ESPiLight::_actualPulseTrain = 0; 43 | uint8_t ESPiLight::_avaiablePulseTrain = 0; 44 | volatile unsigned long ESPiLight::_lastChange = 45 | 0; // Timestamp of previous edge 46 | volatile uint8_t ESPiLight::_nrpulses = 0; 47 | int16_t ESPiLight::_interrupt = NOT_AN_INTERRUPT; 48 | 49 | uint8_t ESPiLight::minrawlen = std::numeric_limits::max(); 50 | uint8_t ESPiLight::maxrawlen = std::numeric_limits::min(); 51 | uint16_t ESPiLight::mingaplen = std::numeric_limits::max(); 52 | uint16_t ESPiLight::maxgaplen = std::numeric_limits::min(); 53 | uint16_t ESPiLight::minpulselen = 80; 54 | uint16_t ESPiLight::maxpulselen = 16000; 55 | 56 | static void fire_callback(protocol_t *protocol, ESPiLightCallBack callback); 57 | static void calc_lengths(); 58 | 59 | static protocols_t *get_protocols() { 60 | if (pilight_protocols == nullptr) { 61 | ESPiLight::setErrorOutput(Serial); 62 | protocol_init(); 63 | calc_lengths(); 64 | } 65 | return pilight_protocols; 66 | } 67 | 68 | static protocols_t *get_used_protocols() { 69 | if (used_protocols == nullptr) { 70 | used_protocols = get_protocols(); 71 | } 72 | return used_protocols; 73 | } 74 | 75 | static protocols_t *find_protocol_node(const char *name) { 76 | protocols_t *pnode = get_protocols(); 77 | while (pnode != nullptr) { 78 | if (strcmp(name, pnode->listener->id) == 0) { 79 | return pnode; 80 | } 81 | pnode = pnode->next; 82 | } 83 | return nullptr; 84 | } 85 | 86 | static protocol_t *find_protocol(const char *name) { 87 | protocols_t *pnode = find_protocol_node(name); 88 | if (pnode != nullptr) { 89 | return pnode->listener; 90 | } 91 | return nullptr; 92 | } 93 | 94 | static int create_pulse_train(uint16_t *pulses, protocol_t *protocol, 95 | const String &content) { 96 | Debug("piLightCreatePulseTrain: "); 97 | 98 | if (!json_validate(content.c_str())) { 99 | Debug("invalid json: "); 100 | DebugLn(content); 101 | return ESPiLight::ERROR_INVALID_JSON; 102 | } 103 | 104 | #pragma GCC diagnostic push 105 | #pragma GCC diagnostic ignored "-Wtype-limits" 106 | if ((protocol != nullptr) && (protocol->createCode != nullptr) && 107 | (protocol->maxrawlen <= MAXPULSESTREAMLENGTH)) { 108 | #pragma GCC diagnostic pop 109 | Debug("protocol: "); 110 | Debug(protocol->id); 111 | 112 | protocol->rawlen = 0; 113 | protocol->raw = pulses; 114 | JsonNode *message = json_decode(content.c_str()); 115 | int return_value = protocol->createCode(message); 116 | json_delete(message); 117 | // delete message created by createCode() 118 | json_delete(protocol->message); 119 | protocol->message = nullptr; 120 | 121 | if (return_value == EXIT_SUCCESS) { 122 | DebugLn(" create Code succeded."); 123 | return protocol->rawlen; 124 | } else { 125 | DebugLn(" create Code failed."); 126 | return ESPiLight::ERROR_INVALID_PILIGHT_MSG; 127 | } 128 | } 129 | return ESPiLight::ERROR_UNAVAILABLE_PROTOCOL; 130 | } 131 | 132 | static void calc_lengths() { 133 | protocols_t *pnode = get_used_protocols(); 134 | ESPiLight::minrawlen = std::numeric_limits::max(); 135 | ESPiLight::maxrawlen = std::numeric_limits::min(); 136 | ESPiLight::mingaplen = std::numeric_limits::max(); 137 | ESPiLight::maxgaplen = std::numeric_limits::min(); 138 | ESPiLight::minpulselen = 80; 139 | ESPiLight::maxpulselen = 16000; 140 | while (pnode != nullptr) { 141 | if (pnode->listener->parseCode != nullptr) { 142 | const protocol_t *protocol = pnode->listener; 143 | const uint8_t minLen = protocol->minrawlen; 144 | const uint8_t maxLen = protocol->maxrawlen; 145 | const uint16_t minGap = protocol->mingaplen; 146 | const uint16_t maxGap = protocol->maxgaplen; 147 | 148 | if (minLen < ESPiLight::minrawlen) { 149 | ESPiLight::minrawlen = minLen; 150 | } 151 | 152 | if (maxLen > ESPiLight::maxrawlen && maxLen <= MAXPULSESTREAMLENGTH) { 153 | ESPiLight::maxrawlen = maxLen; 154 | } 155 | 156 | if (minGap < ESPiLight::mingaplen) { 157 | ESPiLight::mingaplen = minGap; 158 | } 159 | 160 | if (maxGap > ESPiLight::maxgaplen) { 161 | ESPiLight::maxgaplen = maxGap; 162 | } 163 | 164 | if (minGap < ESPiLight::minpulselen) { 165 | ESPiLight::minpulselen = minGap; 166 | } 167 | 168 | if (maxGap > ESPiLight::maxpulselen) { 169 | ESPiLight::maxpulselen = maxGap; 170 | } 171 | } 172 | pnode = pnode->next; 173 | } 174 | Debug("minrawlen: "); 175 | DebugLn(ESPiLight::minrawlen); 176 | Debug("maxrawlen: "); 177 | DebugLn(ESPiLight::maxrawlen); 178 | Debug("mingaplen: "); 179 | DebugLn(ESPiLight::mingaplen); 180 | Debug("maxgaplen: "); 181 | DebugLn(ESPiLight::maxgaplen); 182 | Debug("minpulselen: "); 183 | DebugLn(ESPiLight::minpulselen); 184 | Debug("maxpulselen: "); 185 | DebugLn(ESPiLight::maxpulselen); 186 | } 187 | 188 | void ESPiLight::initReceiver(byte inputPin) { 189 | int16_t interrupt = digitalPinToInterrupt(inputPin); 190 | if (_interrupt == interrupt) { 191 | return; 192 | } 193 | if (_interrupt >= 0) { 194 | detachInterrupt((uint8_t)_interrupt); 195 | } 196 | _interrupt = interrupt; 197 | 198 | resetReceiver(); 199 | enableReceiver(); 200 | 201 | if (interrupt >= 0) { 202 | attachInterrupt((uint8_t)interrupt, interruptHandler, CHANGE); 203 | } 204 | } 205 | 206 | uint8_t ESPiLight::receivePulseTrain(uint16_t *pulses) { 207 | uint8_t length = nextPulseTrainLength(); 208 | 209 | if (length > 0) { 210 | volatile PulseTrain_t &pulseTrain = _pulseTrains[_avaiablePulseTrain]; 211 | _avaiablePulseTrain = (_avaiablePulseTrain + 1) % RECEIVER_BUFFER_SIZE; 212 | for (uint8_t i = 0; i < length; i++) { 213 | pulses[i] = pulseTrain.pulses[i]; 214 | } 215 | pulseTrain.length = 0; 216 | } 217 | return length; 218 | } 219 | 220 | uint8_t ESPiLight::nextPulseTrainLength() { 221 | return _pulseTrains[_avaiablePulseTrain].length; 222 | } 223 | 224 | void ICACHE_RAM_ATTR ESPiLight::interruptHandler() { 225 | if (!_enabledReceiver) { 226 | return; 227 | } 228 | 229 | volatile PulseTrain_t &pulseTrain = _pulseTrains[_actualPulseTrain]; 230 | volatile uint16_t *codes = pulseTrain.pulses; 231 | 232 | if (pulseTrain.length == 0) { 233 | const unsigned long now = micros(); 234 | const unsigned int duration = now - _lastChange; 235 | 236 | /* We first do some filtering (same as pilight BPF) */ 237 | if (duration > minpulselen) { 238 | if (duration < maxpulselen) { 239 | /* All codes are buffered */ 240 | codes[_nrpulses] = (uint16_t)duration; 241 | _nrpulses = (uint8_t)((_nrpulses + 1) % MAXPULSESTREAMLENGTH); 242 | /* Let's match footers */ 243 | if (duration > mingaplen) { 244 | // Debug('g'); 245 | /* Only match minimal length pulse streams */ 246 | if (_nrpulses >= minrawlen && _nrpulses <= maxrawlen) { 247 | // Debug(_nrpulses); 248 | // Debug('l'); 249 | pulseTrain.length = _nrpulses; 250 | _actualPulseTrain = (_actualPulseTrain + 1) % RECEIVER_BUFFER_SIZE; 251 | } 252 | _nrpulses = 0; 253 | } 254 | } 255 | _lastChange = now; 256 | } 257 | } else { 258 | Debug("_!_"); 259 | } 260 | } 261 | 262 | void ESPiLight::resetReceiver() { 263 | for (unsigned int i = 0; i < RECEIVER_BUFFER_SIZE; i++) { 264 | _pulseTrains[i].length = 0; 265 | } 266 | _avaiablePulseTrain = 0; 267 | _actualPulseTrain = 0; 268 | _nrpulses = 0; 269 | } 270 | 271 | void ESPiLight::enableReceiver() { _enabledReceiver = true; } 272 | 273 | void ESPiLight::disableReceiver() { _enabledReceiver = false; } 274 | 275 | void ESPiLight::loop() { 276 | int length = 0; 277 | uint16_t pulses[MAXPULSESTREAMLENGTH]; 278 | 279 | length = receivePulseTrain(pulses); 280 | 281 | if (length > 0) { 282 | /* 283 | Debug("RAW ("); 284 | Debug(length); 285 | Debug("): "); 286 | for(int i=0;i= 0) { 303 | pinMode((uint8_t)_outputPin, OUTPUT); 304 | digitalWrite((uint8_t)_outputPin, LOW); 305 | } 306 | 307 | get_protocols(); 308 | } 309 | 310 | void ESPiLight::setCallback(ESPiLightCallBack callback) { 311 | _callback = callback; 312 | } 313 | 314 | void ESPiLight::setPulseTrainCallBack(PulseTrainCallBack rawCallback) { 315 | _rawCallback = rawCallback; 316 | } 317 | 318 | void ESPiLight::sendPulseTrain(const uint16_t *pulses, size_t length, 319 | size_t repeats) { 320 | if (_outputPin >= 0) { 321 | bool receiverState = _enabledReceiver; 322 | _enabledReceiver = (_echoEnabled && receiverState); 323 | for (unsigned int r = 0; r < repeats; r++) { 324 | for (unsigned int i = 0; i < length; i += 2) { 325 | digitalWrite((uint8_t)_outputPin, HIGH); 326 | delayMicroseconds(pulses[i]); 327 | digitalWrite((uint8_t)_outputPin, LOW); 328 | if (i + 1 < length) { 329 | delayMicroseconds(pulses[i + 1]); 330 | } 331 | } 332 | } 333 | digitalWrite((uint8_t)_outputPin, LOW); 334 | _enabledReceiver = receiverState; 335 | } 336 | } 337 | 338 | int ESPiLight::send(const String &protocol, const String &json, 339 | size_t repeats) { 340 | if (_outputPin < 0) { 341 | DebugLn("No output pin set, cannot send"); 342 | return ERROR_NO_OUTPUT_PIN; 343 | } 344 | int length = 0; 345 | uint16_t pulses[MAXPULSESTREAMLENGTH]; 346 | 347 | protocol_t *protocol_listener = find_protocol(protocol.c_str()); 348 | length = create_pulse_train(pulses, protocol_listener, json); 349 | if (length > 0) { 350 | /* 351 | DebugLn(); 352 | Debug("send: "); 353 | Debug(length); 354 | Debug(" pulses ("); 355 | Debug(protocol); 356 | Debug(", "); 357 | Debug(content); 358 | DebugLn(")"); 359 | */ 360 | if (repeats == 0) { 361 | repeats = protocol_listener->txrpt; 362 | } 363 | sendPulseTrain(pulses, (unsigned)length, repeats); 364 | } 365 | return length; 366 | } 367 | 368 | int ESPiLight::createPulseTrain(uint16_t *pulses, const String &protocol_id, 369 | const String &content) { 370 | protocol_t *protocol = find_protocol(protocol_id.c_str()); 371 | return create_pulse_train(pulses, protocol, content); 372 | } 373 | 374 | size_t ESPiLight::parsePulseTrain(uint16_t *pulses, uint8_t length) { 375 | size_t matches = 0; 376 | protocol_t *protocol = nullptr; 377 | protocols_t *pnode = get_used_protocols(); 378 | 379 | // DebugLn("piLightParsePulseTrain start"); 380 | while ((pnode != nullptr) && (_callback != nullptr)) { 381 | protocol = pnode->listener; 382 | 383 | if (protocol->parseCode != nullptr && protocol->validate != nullptr) { 384 | protocol->raw = pulses; 385 | protocol->rawlen = length; 386 | 387 | if (protocol->validate() == 0) { 388 | Debug("pulses: "); 389 | Debug(length); 390 | Debug(" possible protocol: "); 391 | DebugLn(protocol->id); 392 | 393 | if (protocol->first > 0) { 394 | protocol->first = protocol->second; 395 | } 396 | protocol->second = micros(); 397 | if (protocol->first == 0) { 398 | protocol->first = protocol->second; 399 | } 400 | 401 | /* Reset # of repeats after a certain delay */ 402 | if ((protocol->second - protocol->first) > 500000) { 403 | protocol->repeats = 0; 404 | } 405 | 406 | protocol->message = nullptr; 407 | protocol->parseCode(); 408 | if (protocol->message != nullptr) { 409 | matches++; 410 | protocol->repeats++; 411 | 412 | fire_callback(protocol, _callback); 413 | 414 | json_delete(protocol->message); 415 | protocol->message = nullptr; 416 | } 417 | } 418 | } 419 | pnode = pnode->next; 420 | } 421 | if (_rawCallback != nullptr) { 422 | (_rawCallback)(pulses, length); 423 | } 424 | 425 | // Debug("piLightParsePulseTrain end. matches: "); 426 | // DebugLn(matches); 427 | return matches; 428 | } 429 | 430 | static void fire_callback(protocol_t *protocol, ESPiLightCallBack callback) { 431 | PilightRepeatStatus_t status = FIRST; 432 | char *content = json_encode(protocol->message); 433 | String deviceId = ""; 434 | double itmp; 435 | char *stmp; 436 | 437 | if ((protocol->repeats <= 1) || (protocol->old_content == nullptr)) { 438 | status = FIRST; 439 | json_free(protocol->old_content); 440 | protocol->old_content = content; 441 | } else if (!(protocol->repeats & 0x80)) { 442 | if (strcmp(content, protocol->old_content) == 0) { 443 | protocol->repeats |= 0x80; 444 | status = VALID; 445 | } else { 446 | status = INVALID; 447 | } 448 | json_free(protocol->old_content); 449 | protocol->old_content = content; 450 | } else { 451 | status = KNOWN; 452 | json_free(content); 453 | } 454 | if (json_find_number(protocol->message, "id", &itmp) == 0) { 455 | deviceId = String((int)round(itmp)); 456 | } else if (json_find_string(protocol->message, "id", &stmp) == 0) { 457 | deviceId = String(stmp); 458 | }; 459 | (callback)(String(protocol->id), String(protocol->old_content), status, 460 | protocol->repeats & 0x7F, deviceId); 461 | } 462 | 463 | String ESPiLight::pulseTrainToString(const uint16_t *codes, size_t length) { 464 | bool match = false; 465 | int diff = 0; 466 | 467 | uint8_t nrpulses = 0; // number of pulse types 468 | uint16_t plstypes[MAX_PULSE_TYPES] = {}; 469 | 470 | String data(""); 471 | data.reserve(6 + length); 472 | data += "c:"; 473 | for (unsigned int i = 0; i < length; i++) { 474 | match = false; 475 | for (uint8_t j = 0; j < MAX_PULSE_TYPES; j++) { 476 | // We device these numbers by 10 to normalize them a bit 477 | diff = (plstypes[j] / 50) - (codes[i] / 50); 478 | if ((diff >= -2) && (diff <= 2)) { 479 | // Write numbers 480 | data += (char)('0' + ((char)j)); 481 | match = true; 482 | break; 483 | } 484 | } 485 | if (!match) { 486 | plstypes[nrpulses++] = codes[i]; 487 | data += (char)('0' + ((char)(nrpulses - 1))); 488 | if (nrpulses >= MAX_PULSE_TYPES) { 489 | DebugLn("too many pulse types"); 490 | return String(""); 491 | } 492 | } 493 | } 494 | data += ";p:"; 495 | for (uint8_t i = 0; i < nrpulses; i++) { 496 | data += plstypes[i]; 497 | if (i + 1 < nrpulses) { 498 | data += ','; 499 | } 500 | } 501 | data += '@'; 502 | return data; 503 | } 504 | 505 | int ESPiLight::stringToPulseTrain(const String &data, uint16_t *codes, 506 | size_t maxlength) { 507 | unsigned int length = 0; // length of pulse train 508 | unsigned int nrpulses = 0; // number of pulse types 509 | uint16_t plstypes[MAX_PULSE_TYPES] = {}; 510 | 511 | // validate data string 512 | int scode = data.indexOf('c') + 2; 513 | if (scode < 2 || (unsigned)scode > data.length()) { 514 | DebugLn("'c' not found in data string, or has no data"); 515 | return ERROR_INVALID_PULSETRAIN_MSG_C; 516 | } 517 | int spulse = data.indexOf('p') + 2; 518 | if (spulse < 2 || (unsigned)spulse > data.length()) { 519 | DebugLn("'p' not found in data string, or has no data"); 520 | return ERROR_INVALID_PULSETRAIN_MSG_P; 521 | } 522 | // parsing pulse types 523 | unsigned int start = (unsigned)spulse; 524 | int end = data.indexOf(',', start); 525 | while (end > 0) { 526 | plstypes[nrpulses++] = 527 | (uint16_t)data.substring(start, (unsigned)end).toInt(); 528 | start = (unsigned)end + 1; 529 | end = data.indexOf(',', start); 530 | } 531 | end = data.indexOf(';', start); 532 | if (end < 0) { 533 | end = data.indexOf('@', start); 534 | } 535 | if (end < 0) { 536 | DebugLn("';' or '@' not found in data string"); 537 | return ERROR_INVALID_PULSETRAIN_MSG_END; 538 | } 539 | plstypes[nrpulses++] = (uint16_t)data.substring(start, (unsigned)end).toInt(); 540 | // parsing pulses 541 | int pulse_index = 0; 542 | for (unsigned int i = (unsigned)scode; i < data.length(); i++) { 543 | if ((data[i] == ';') || (data[i] == '@')) break; 544 | if (i >= maxlength) break; 545 | pulse_index = data[i] - '0'; 546 | if ((pulse_index < 0) || ((unsigned)pulse_index >= nrpulses)) { 547 | DebugLn("Pulse type not defined"); 548 | return ERROR_INVALID_PULSETRAIN_MSG_TYPE; 549 | } 550 | codes[length++] = plstypes[pulse_index]; 551 | } 552 | return length; 553 | } 554 | 555 | int ESPiLight::stringToRepeats(const String &data) { 556 | // parsing (optional) repeats 557 | int srepeat = data.indexOf('r') + 2; 558 | if (srepeat < 2 || (unsigned)srepeat > data.length()) { 559 | DebugLn("'r' not found in data string, or has no data"); 560 | return ERROR_INVALID_PULSETRAIN_MSG_R; 561 | } 562 | unsigned int start = (unsigned)srepeat; 563 | int end = data.indexOf(';', start); 564 | if (end < 0) { 565 | end = data.indexOf('@', start); 566 | } 567 | if (end < 0) { 568 | DebugLn("';' or '@' not found in data string"); 569 | return ERROR_INVALID_PULSETRAIN_MSG_END; 570 | } 571 | return data.substring(start, (unsigned)end).toInt(); 572 | } 573 | 574 | void ESPiLight::limitProtocols(const String &protos) { 575 | if (!json_validate(protos.c_str())) { 576 | DebugLn("Protocol limit argument is not a valid json message!"); 577 | return; 578 | } 579 | JsonNode *message = json_decode(protos.c_str()); 580 | 581 | if (message->tag != JSON_ARRAY) { 582 | DebugLn("Protocol limit argument is not a json array!"); 583 | json_delete(message); 584 | return; 585 | } 586 | 587 | if (get_used_protocols() != get_protocols()) { 588 | protocols_t *pnode = get_used_protocols(); 589 | while (pnode != nullptr) { 590 | protocols_t *tmp = pnode; 591 | pnode = pnode->next; 592 | delete tmp; 593 | } 594 | } 595 | 596 | used_protocols = nullptr; 597 | JsonNode *curr = message->children.head; 598 | unsigned int proto_count = 0; 599 | 600 | while (curr != nullptr) { 601 | if (curr->tag != JSON_STRING) { 602 | DebugLn("Element is not a String"); 603 | curr = curr->next; 604 | continue; 605 | } 606 | 607 | protocols_t *templ = find_protocol_node(curr->string_); 608 | if (templ == nullptr) { 609 | Debug("Protocol not found: "); 610 | DebugLn(curr->string_); 611 | curr = curr->next; 612 | continue; 613 | } 614 | 615 | protocols_t *new_node = new protocols_t; 616 | new_node->listener = templ->listener; 617 | new_node->next = used_protocols; 618 | used_protocols = new_node; 619 | 620 | Debug("activated protocol "); 621 | DebugLn(templ->listener->id); 622 | proto_count++; 623 | 624 | if (curr == message->children.tail) { 625 | break; 626 | } 627 | curr = curr->next; 628 | } 629 | 630 | json_delete(message); 631 | calc_lengths(); 632 | } 633 | 634 | static String protocols_to_array(protocols_t *pnode) { 635 | protocols_t *tmp = pnode; 636 | size_t needed_len = 2; // [] 637 | while (tmp != nullptr) { 638 | needed_len += strlen(tmp->listener->id) + 3; // "xx", 639 | tmp = tmp->next; 640 | } 641 | 642 | String ret; 643 | ret.reserve(needed_len); 644 | 645 | ret += '['; 646 | 647 | bool first = true; 648 | while (pnode != nullptr) { 649 | if (first) { 650 | first = false; 651 | } else { 652 | ret += ","; 653 | } 654 | ret += '"'; 655 | ret += pnode->listener->id; 656 | ret += '"'; 657 | pnode = pnode->next; 658 | } 659 | ret += "]"; 660 | 661 | return ret; 662 | } 663 | 664 | String ESPiLight::availableProtocols() { 665 | return protocols_to_array(get_protocols()); 666 | } 667 | 668 | String ESPiLight::enabledProtocols() { 669 | return protocols_to_array(get_used_protocols()); 670 | } 671 | 672 | void ESPiLight::setEchoEnabled(bool enabled) { _echoEnabled = enabled; } 673 | 674 | void ESPiLight::setErrorOutput(Print &output) { set_aprintf_output(&output); } 675 | -------------------------------------------------------------------------------- /src/ESPiLight.h: -------------------------------------------------------------------------------- 1 | /* 2 | ESPiLight - pilight 433.92 MHz protocols library for Arduino 3 | Copyright (c) 2016 Puuu. All right reserved. 4 | 5 | Project home: https://github.com/puuu/espilight/ 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 3 of the License, or (at your option) any later version. 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with library. If not, see 17 | */ 18 | 19 | #ifndef ESPILIGHT_H 20 | #define ESPILIGHT_H 21 | 22 | #include 23 | #include 24 | 25 | #ifndef RECEIVER_BUFFER_SIZE 26 | #define RECEIVER_BUFFER_SIZE 10 27 | #endif 28 | 29 | #ifndef MAXPULSESTREAMLENGTH 30 | #define MAXPULSESTREAMLENGTH 255 31 | #endif 32 | 33 | #define MAX_PULSE_TYPES 16 34 | 35 | enum PilightRepeatStatus_t { FIRST, INVALID, VALID, KNOWN }; 36 | 37 | typedef struct PulseTrain_t { 38 | uint16_t pulses[MAXPULSESTREAMLENGTH]; 39 | uint8_t length; 40 | } PulseTrain_t; 41 | 42 | typedef std::function 44 | ESPiLightCallBack; 45 | typedef std::function 46 | PulseTrainCallBack; 47 | 48 | class ESPiLight { 49 | public: 50 | /** 51 | * Constructor. 52 | */ 53 | ESPiLight(int8_t outputPin); 54 | 55 | /** 56 | * Transmit pulse train 57 | */ 58 | void sendPulseTrain(const uint16_t *pulses, size_t length, 59 | size_t repeats = 10); 60 | 61 | /** 62 | * Transmit Pilight json message 63 | * repeats of 0 means repeats as defined in protocol. 64 | */ 65 | int send(const String &protocol, const String &json, size_t repeats = 0); 66 | 67 | /** 68 | * Parse pulse train and fire callback 69 | */ 70 | size_t parsePulseTrain(uint16_t *pulses, uint8_t length); 71 | 72 | /** 73 | * Process receiver queue and fire callback 74 | */ 75 | void loop(); 76 | 77 | void setCallback(ESPiLightCallBack callback); 78 | void setPulseTrainCallBack(PulseTrainCallBack rawCallback); 79 | 80 | /** 81 | * If set to true, the receiver will temporarely be disabled when sending. 82 | */ 83 | void setEchoEnabled(bool enabled); 84 | 85 | /** 86 | * Initialise receiver 87 | */ 88 | static void initReceiver(byte inputPin); 89 | 90 | /** 91 | * Get last received PulseTrain. 92 | * Returns: length of PulseTrain or 0 if not avaiable 93 | */ 94 | static uint8_t receivePulseTrain(uint16_t *pulses); 95 | 96 | /** 97 | * Check if new PulseTrain avaiable. 98 | * Returns: 0 if no new PulseTrain avaiable 99 | */ 100 | static uint8_t nextPulseTrainLength(); 101 | 102 | /** 103 | * Enable Receiver. No need to call enableReceiver() after initReceiver(). 104 | */ 105 | static void enableReceiver(); 106 | 107 | /** 108 | * Disable decoding. You can re-enable decoding by calling enableReceiver(); 109 | */ 110 | static void disableReceiver(); 111 | 112 | /** 113 | * interruptHandler is called on every change in the input 114 | * signal. If RcPilight::initReceiver is called with interrupt <0, 115 | * you have to call interruptHandler() yourself. (Or use 116 | * InterruptChain) 117 | */ 118 | static void interruptHandler(); 119 | 120 | /** 121 | * Limit the available protocols. 122 | * 123 | * This gets a json array of the protocol names that should be activated. 124 | * If the array is empty, the filter gets reset. 125 | */ 126 | static void limitProtocols(const String &protos); 127 | 128 | /** 129 | * Return a json array containing all the available protocols. 130 | */ 131 | static String availableProtocols(); 132 | 133 | /** 134 | * Return an json array containing all the currently enabled protocols 135 | */ 136 | static String enabledProtocols(); 137 | 138 | /** 139 | * Set pilight error output Print class (default is Serial) 140 | */ 141 | static void setErrorOutput(Print &output); 142 | 143 | static uint8_t minrawlen; 144 | static uint8_t maxrawlen; 145 | static uint16_t mingaplen; 146 | static uint16_t maxgaplen; 147 | static uint16_t minpulselen; 148 | static uint16_t maxpulselen; 149 | 150 | static String pulseTrainToString(const uint16_t *pulses, size_t length); 151 | static int stringToPulseTrain(const String &data, uint16_t *pulses, 152 | size_t maxlength); 153 | static int stringToRepeats(const String &data); 154 | 155 | static int createPulseTrain(uint16_t *pulses, const String &protocol_id, 156 | const String &json); 157 | 158 | /** 159 | * Error return codes for send() and createPulseTrain() 160 | */ 161 | static const int ERROR_UNAVAILABLE_PROTOCOL = 0; 162 | static const int ERROR_INVALID_PILIGHT_MSG = -1; 163 | static const int ERROR_INVALID_JSON = -2; 164 | static const int ERROR_NO_OUTPUT_PIN = -3; 165 | 166 | /** 167 | * Error return codes for stringToPulseTrain() 168 | */ 169 | static const int ERROR_INVALID_PULSETRAIN_MSG_C = -1; 170 | static const int ERROR_INVALID_PULSETRAIN_MSG_P = -2; 171 | static const int ERROR_INVALID_PULSETRAIN_MSG_END = -3; 172 | static const int ERROR_INVALID_PULSETRAIN_MSG_TYPE = -4; 173 | static const int ERROR_INVALID_PULSETRAIN_MSG_R = -5; 174 | 175 | private: 176 | ESPiLightCallBack _callback; 177 | PulseTrainCallBack _rawCallback; 178 | int8_t _outputPin; 179 | bool _echoEnabled; 180 | 181 | /** 182 | * Quasi-reset. Called when the current edge is too long or short. 183 | * reset "promotes" the current edge as being the first edge of a new 184 | * sequence. 185 | */ 186 | static void resetReceiver(); 187 | 188 | /** 189 | * Internal functions 190 | */ 191 | static bool _enabledReceiver; // If true, monitoring and decoding is 192 | // enabled. If false, interruptHandler will 193 | // return immediately. 194 | static volatile PulseTrain_t _pulseTrains[]; 195 | static volatile uint8_t _actualPulseTrain; 196 | static uint8_t _avaiablePulseTrain; 197 | static volatile unsigned long _lastChange; // Timestamp of previous edge 198 | static volatile uint8_t _nrpulses; 199 | static int16_t _interrupt; 200 | }; 201 | 202 | #endif 203 | -------------------------------------------------------------------------------- /src/pilight/libs/pilight/core/common.h: -------------------------------------------------------------------------------- 1 | /*dummy*/ 2 | -------------------------------------------------------------------------------- /src/pilight/libs/pilight/core/gc.h: -------------------------------------------------------------------------------- 1 | /*dummy*/ 2 | -------------------------------------------------------------------------------- /src/pilight/libs/pilight/core/log.h: -------------------------------------------------------------------------------- 1 | /* 2 | ESPiLight - pilight 433.92 MHz protocols library for Arduino 3 | Copyright (c) 2016 Puuu. All right reserved. 4 | 5 | Project home: https://github.com/puuu/espilight/ 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 3 of the License, or (at your option) any later version. 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with library. If not, see 17 | */ 18 | 19 | #ifndef _LOG_H_ 20 | #define _LOG_H_ 21 | 22 | #define LOG_EMERG 0 23 | #define LOG_ALERT 1 24 | #define LOG_CRIT 2 25 | #define LOG_ERR 3 26 | #define LOG_WARNING 4 27 | #define LOG_NOTICE 5 28 | #define LOG_INFO 6 29 | #define LOG_DEBUG 7 30 | 31 | #define LOG_STACK 255 32 | 33 | #include 34 | 35 | #define logprintf(prio, args...) {printf("pilight(%d): ", prio);printf(args);printf("\n");} 36 | 37 | #endif 38 | -------------------------------------------------------------------------------- /src/pilight/libs/pilight/core/pilight.h: -------------------------------------------------------------------------------- 1 | /* 2 | ESPiLight - pilight 433.92 MHz protocols library for Arduino 3 | Copyright (c) 2016 Puuu. All right reserved. 4 | 5 | Project home: https://github.com/puuu/espilight/ 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 3 of the License, or (at your option) any later version. 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with library. If not, see 17 | */ 18 | 19 | #ifndef _PILIGHT_H_ 20 | #define _PILIGHT_H_ 21 | 22 | //#include "defines.h" 23 | #define PULSE_DIV 34 24 | #define EPSILON 0.00001 25 | 26 | #include "mem.h" 27 | #include "../../../../tools/aprintf.h" 28 | 29 | #endif 30 | -------------------------------------------------------------------------------- /src/pilight/libs/pilight/protocols/protocol.c: -------------------------------------------------------------------------------- 1 | /* 2 | ESPiLight - pilight 433.92 MHz protocols library for Arduino 3 | Copyright (c) 2016 Puuu. All right reserved. 4 | 5 | Project home: https://github.com/puuu/espilight/ 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 3 of the License, or (at your option) any later version. 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with library. If not, see 17 | */ 18 | 19 | #include 20 | #include 21 | #include 22 | 23 | #include "../core/pilight.h" 24 | #include "../core/log.h" 25 | #include "protocol.h" 26 | 27 | #include "protocol_header.h" 28 | 29 | struct protocols_t *pilight_protocols = NULL; 30 | 31 | void protocol_init(void) { 32 | #include "protocol_init.h" 33 | } 34 | 35 | void protocol_register(protocol_t **proto) { 36 | if((*proto = MALLOC(sizeof(struct protocol_t))) == NULL) { 37 | fprintf(stderr, "out of memory\n"); 38 | exit(EXIT_FAILURE); 39 | } 40 | //(*proto)->options = NULL; 41 | //(*proto)->devices = NULL; 42 | 43 | (*proto)->rawlen = 0; 44 | (*proto)->minrawlen = 0; 45 | (*proto)->maxrawlen = 0; 46 | (*proto)->mingaplen = 0; 47 | (*proto)->maxgaplen = 0; 48 | (*proto)->txrpt = 10; 49 | (*proto)->rxrpt = 1; 50 | (*proto)->hwtype = NONE; 51 | //(*proto)->multipleId = 1; 52 | //(*proto)->config = 1; 53 | //(*proto)->masterOnly = 0; 54 | (*proto)->parseCode = NULL; 55 | (*proto)->createCode = NULL; 56 | (*proto)->checkValues = NULL; 57 | //(*proto)->initDev = NULL; 58 | (*proto)->printHelp = NULL; 59 | //(*proto)->threadGC = NULL; 60 | (*proto)->gc = NULL; 61 | (*proto)->message = NULL; 62 | //(*proto)->threads = NULL; 63 | 64 | (*proto)->repeats = 0; 65 | (*proto)->first = 0; 66 | (*proto)->second = 0; 67 | 68 | (*proto)->raw = NULL; 69 | 70 | /* Arduino special, compare repeated messages*/ 71 | (*proto)->old_content = NULL; 72 | 73 | struct protocols_t *pnode = MALLOC(sizeof(struct protocols_t)); 74 | if(pnode == NULL) { 75 | fprintf(stderr, "out of memory\n"); 76 | exit(EXIT_FAILURE); 77 | } 78 | pnode->listener = *proto; 79 | pnode->next = pilight_protocols; 80 | pilight_protocols = pnode; 81 | } 82 | 83 | void protocol_set_id(protocol_t *proto, char *id) { 84 | proto->id = id; 85 | } 86 | -------------------------------------------------------------------------------- /src/pilight/libs/pilight/protocols/protocol.h: -------------------------------------------------------------------------------- 1 | /* 2 | ESPiLight - pilight 433.92 MHz protocols library for Arduino 3 | Copyright (c) 2016 Puuu. All right reserved. 4 | 5 | Project home: https://github.com/puuu/espilight/ 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 3 of the License, or (at your option) any later version. 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with library. If not, see 17 | */ 18 | 19 | #ifndef _PROTOCOL_H_ 20 | #define _PROTOCOL_H_ 21 | 22 | //from ../core/options.h 23 | #define options_add(options, id, name, argtype, conftype, vartype, def, mask) 24 | 25 | #include 26 | #include "../core/json.h" 27 | 28 | // from ../config/hardware.h 29 | typedef enum { 30 | HWINTERNAL = -1, 31 | NONE = 0, 32 | RF433, 33 | RF868, 34 | RFIR, 35 | ZWAVE, 36 | SENSOR, 37 | HWRELAY, 38 | API 39 | } hwtype_t; 40 | 41 | typedef enum { 42 | FIRMWARE = -2, 43 | PROCESS = -1, 44 | RAW = 0, 45 | SWITCH, 46 | DIMMER, 47 | WEATHER, 48 | RELAY, 49 | SCREEN, 50 | CONTACT, 51 | PENDINGSW, 52 | DATETIME, 53 | XBMC, 54 | LIRC, 55 | WEBCAM, 56 | MOTION, 57 | DUSK, 58 | PING, 59 | LABEL, 60 | ALARM 61 | } devtype_t; 62 | 63 | typedef struct protocol_t { 64 | char *id; 65 | uint8_t rawlen; 66 | uint8_t minrawlen; 67 | uint8_t maxrawlen; 68 | uint16_t mingaplen; 69 | uint16_t maxgaplen; 70 | uint8_t txrpt; 71 | uint8_t rxrpt; 72 | //short multipleId; 73 | //short config; 74 | //short masterOnly; 75 | //struct options_t *options; 76 | struct JsonNode *message; 77 | 78 | uint8_t repeats; 79 | unsigned long first; 80 | unsigned long second; 81 | 82 | uint16_t *raw; 83 | 84 | hwtype_t hwtype; 85 | devtype_t devtype; 86 | //struct protocol_devices_t *devices; 87 | //struct protocol_threads_t *threads; 88 | 89 | union { 90 | void (*parseCode)(void); 91 | void (*parseCommand)(struct JsonNode *code); 92 | }; 93 | int (*validate)(void); 94 | int (*createCode)(JsonNode *code); 95 | int (*checkValues)(JsonNode *code); 96 | //struct threadqueue_t *(*initDev)(JsonNode *device); 97 | void (*printHelp)(void); 98 | void (*gc)(void); 99 | //void (*threadGC)(void); 100 | 101 | /* ESPiLight special, used to compare repeated messages*/ 102 | char *old_content; 103 | } protocol_t; 104 | 105 | typedef struct protocols_t { 106 | struct protocol_t *listener; 107 | char *name; 108 | struct protocols_t *next; 109 | } protocols_; 110 | 111 | extern struct protocols_t *pilight_protocols; 112 | 113 | void protocol_init(void); 114 | void protocol_set_id(protocol_t *proto, char *id); 115 | void protocol_register(protocol_t **proto); 116 | #define protocol_device_add(proto, id, desc) 117 | 118 | #endif 119 | -------------------------------------------------------------------------------- /src/tools/aprintf.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | ESPiLight - pilight 433.92 MHz protocols library for Arduino 3 | Copyright (c) 2016 Puuu. All right reserved. 4 | 5 | Project home: https://github.com/puuu/espilight/ 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 3 of the License, or (at your option) any later version. 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with library. If not, see 17 | */ 18 | 19 | #include "aprintf.h" 20 | #include 21 | 22 | static Print *aprintf_print = nullptr; 23 | 24 | void set_aprintf_output(Print *output) { aprintf_print = output; } 25 | 26 | int aprintf_P(PGM_P formatP, ...) { 27 | if (aprintf_print == nullptr) { 28 | return 0; 29 | } 30 | va_list arg; 31 | va_start(arg, formatP); 32 | char temp[64]; 33 | char *buffer = temp; 34 | size_t len = vsnprintf_P(temp, sizeof(temp), formatP, arg); 35 | va_end(arg); 36 | if (len > sizeof(temp) - 1) { 37 | buffer = new char[len + 1]; 38 | if (!buffer) { 39 | return 0; 40 | } 41 | va_start(arg, formatP); 42 | vsnprintf_P(buffer, len + 1, formatP, arg); 43 | va_end(arg); 44 | } 45 | len = aprintf_print->write((const uint8_t *)buffer, len); 46 | if (buffer != temp) { 47 | delete[] buffer; 48 | } 49 | return len; 50 | } 51 | 52 | void exit(int n) { 53 | if (aprintf_print != nullptr) { 54 | aprintf_print->print(F("EXIT: ")); 55 | aprintf_print->println(n); 56 | } 57 | ESP.restart(); 58 | while (true) 59 | ; 60 | } 61 | -------------------------------------------------------------------------------- /src/tools/aprintf.h: -------------------------------------------------------------------------------- 1 | /* 2 | ESPiLight - pilight 433.92 MHz protocols library for Arduino 3 | Copyright (c) 2016 Puuu. All right reserved. 4 | 5 | Project home: https://github.com/puuu/espilight/ 6 | This library is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU Lesser General Public 8 | License as published by the Free Software Foundation; either 9 | version 3 of the License, or (at your option) any later version. 10 | This library is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | Lesser General Public License for more details. 14 | 15 | You should have received a copy of the GNU General Public License 16 | along with library. If not, see 17 | */ 18 | 19 | #ifndef _APRINTF_H_ 20 | #define _APRINTF_H_ 21 | 22 | #include 23 | 24 | #ifndef __cplusplus 25 | #include 26 | #define fprintf(stream, fmt, ...) aprintf_P(PSTR(fmt), ##__VA_ARGS__) 27 | #define printf(fmt, ...) aprintf_P(PSTR(fmt), ##__VA_ARGS__) 28 | #endif 29 | 30 | #ifdef __cplusplus 31 | #include 32 | void set_aprintf_output(Print *output); 33 | #endif 34 | 35 | #ifdef __cplusplus 36 | extern "C" { 37 | #endif 38 | void exit(int n); 39 | int aprintf_P(PGM_P formatP, ...) __attribute__((format(printf, 1, 2))); 40 | #ifdef __cplusplus 41 | } 42 | #endif 43 | 44 | #endif //_APRINTF_H_ 45 | -------------------------------------------------------------------------------- /tests/test_echo/test_echo.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPilight signal echo test 3 | 4 | https://github.com/puuu/espilight 5 | */ 6 | 7 | #include 8 | 9 | #define RECEIVER_PIN 4 // any intterupt able pin 10 | #define TRANSMITTER_PIN 13 11 | 12 | ESPiLight rf(TRANSMITTER_PIN); // use -1 to disable transmitter 13 | 14 | // callback function. It is called on successfully received and parsed rc signal 15 | void rfCallback(const String &protocol, const String &message, int status, 16 | size_t repeats, const String &deviceID) { 17 | Serial.print("RF signal arrived ["); 18 | Serial.print(protocol); // protocoll used to parse 19 | Serial.print("]["); 20 | Serial.print(deviceID); // value of id key in json message 21 | Serial.print("] ("); 22 | Serial.print(status); // status of message, depending on repeat, either: 23 | // FIRST - first message of this protocoll within the 24 | // last 0.5 s 25 | // INVALID - message repeat is not equal to the 26 | // previous message 27 | // VALID - message is equal to the previous message 28 | // KNOWN - repeat of a already valid message 29 | Serial.print(") "); 30 | Serial.print(message); // message in json format 31 | Serial.println(); 32 | 33 | // check if message is valid and process it 34 | if (status == VALID) { 35 | Serial.print("Valid message: ["); 36 | Serial.print(protocol); 37 | Serial.print("] "); 38 | Serial.print(message); 39 | Serial.println(); 40 | } 41 | } 42 | 43 | void setup() { 44 | Serial.begin(115200); 45 | // set callback funktion 46 | rf.setCallback(rfCallback); 47 | // inittilize receiver 48 | rf.initReceiver(RECEIVER_PIN); 49 | // enable signal echo 50 | rf.setEchoEnabled(true); 51 | } 52 | 53 | void loop() { 54 | int i; 55 | // process input queue and may fire calllback 56 | rf.send("elro_800_switch", "{\"systemcode\":17,\"unitcode\":1,\"on\":1}"); 57 | for (i = 0; i < 200; i++) { 58 | delay(10); 59 | rf.loop(); 60 | } 61 | rf.send("elro_800_switch", "{\"systemcode\":17,\"unitcode\":1,\"off\":1}"); 62 | for (i = 0; i < 200; i++) { 63 | delay(10); 64 | rf.loop(); 65 | } 66 | } -------------------------------------------------------------------------------- /tests/test_parse/test_parse.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPiLight parsing test 3 | 4 | https://github.com/puuu/espilight 5 | */ 6 | 7 | #include 8 | 9 | #define PROTOCOL "elro_800_switch" 10 | #define JMESSAGE "{\"systemcode\":17,\"unitcode\":1,\"on\":1}" 11 | 12 | ESPiLight rf(-1); // use -1 to disable transmitter 13 | 14 | // callback function. It is called on successfully received and parsed rc signal 15 | void rfRawCallback(const uint16_t *codes, size_t length) { 16 | // print pulse lengths 17 | printPulseTrain(codes, length); 18 | 19 | // format of pilight USB Nano 20 | String data = rf.pulseTrainToString(codes, length); 21 | Serial.print("string format: "); 22 | Serial.print(data); 23 | Serial.println(); 24 | } 25 | 26 | // callback function. It is called on successfully received and parsed rc signal 27 | void rfCallback(const String &protocol, const String &message, int status, 28 | size_t repeats, const String &deviceID) { 29 | Serial.print("parsed message ["); 30 | Serial.print(protocol); // protocol used to parse 31 | Serial.print("]["); 32 | Serial.print(deviceID); // value of id key in json message 33 | Serial.print("] ("); 34 | Serial.print(status); 35 | Serial.print(") "); 36 | Serial.print(message); // message in json format 37 | Serial.println(); 38 | } 39 | 40 | void printPulseTrain(const uint16_t *codes, int length) { 41 | Serial.print("RAW signal: "); 42 | for (int i = 0; i < length; i++) { 43 | Serial.print(codes[i]); 44 | Serial.print(' '); 45 | } 46 | Serial.println(); 47 | } 48 | 49 | void setup() { 50 | Serial.begin(115200); 51 | // set callback funktion 52 | rf.setCallback(rfCallback); 53 | // set callback funktion for raw messages 54 | rf.setPulseTrainCallBack(rfRawCallback); 55 | 56 | int length = 0; 57 | uint16_t pulses[MAXPULSESTREAMLENGTH]; 58 | 59 | // print free heap memory 60 | Serial.println(); 61 | Serial.print("Free heap: "); 62 | Serial.println(ESP.getFreeHeap()); 63 | 64 | // pulse train from pilight json message 65 | length = rf.createPulseTrain(pulses, PROTOCOL, JMESSAGE); 66 | // print pulse lengths 67 | printPulseTrain(pulses, length); 68 | // format of pilight USB Nano 69 | String data = rf.pulseTrainToString(pulses, length); 70 | Serial.print("string format: "); 71 | Serial.print(data); 72 | Serial.println(); 73 | 74 | // pilight USB Nano string to pulses 75 | length = rf.stringToPulseTrain(data, pulses, MAXPULSESTREAMLENGTH); 76 | // print pulse lengths 77 | printPulseTrain(pulses, length); 78 | // format of pilight USB Nano 79 | data = rf.pulseTrainToString(pulses, length); 80 | Serial.print("string format: "); 81 | Serial.print(data); 82 | Serial.println(); 83 | 84 | // parse pulse train multiple times 85 | for (int i = 0; i < 5; i++) { 86 | Serial.println(); 87 | Serial.print("Decoding turn "); 88 | Serial.println(i); 89 | Serial.println(); 90 | rf.parsePulseTrain(pulses, length); 91 | delay(10); 92 | } 93 | 94 | // parse repeats in string 95 | Serial.println(); 96 | data = "c:10011001100101010101100110011001100101011002;p:300,900,10200;r:17@"; 97 | Serial.print("string with repeats format: "); 98 | Serial.println(data); 99 | int repeats = rf.stringToRepeats(data); 100 | Serial.print("number of repeats (should be 17): "); 101 | Serial.println(repeats); 102 | } 103 | 104 | void loop() { 105 | // nothing 106 | } 107 | -------------------------------------------------------------------------------- /tests/test_proto_limit/test_proto_limit.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Basic ESPiLight protocol limiting 3 | 4 | https://github.com/puuu/espilight 5 | */ 6 | 7 | #include 8 | 9 | #define PROTOCOL "elro_800_switch" 10 | #define JMESSAGE "{\"systemcode\":17,\"unitcode\":1,\"on\":1}" 11 | 12 | ESPiLight rf(-1); // use -1 to disable transmitter 13 | 14 | // callback function. It is called on successfully received and parsed rc signal 15 | void rfCallback(const String &protocol, const String &message, int status, 16 | size_t repeats, const String &deviceID) { 17 | Serial.print("parsed message ["); 18 | Serial.print(protocol); // protocoll used to parse 19 | Serial.print("]["); 20 | Serial.print(deviceID); // value of id key in json message 21 | Serial.print("] ("); 22 | Serial.print(status); 23 | Serial.print(") "); 24 | Serial.print(message); // message in json format 25 | Serial.println(); 26 | } 27 | 28 | void setup() { 29 | Serial.begin(115200); 30 | // set callback funktion 31 | rf.setCallback(rfCallback); 32 | 33 | int length = 0; 34 | uint16_t pulses[MAXPULSESTREAMLENGTH]; 35 | 36 | // pulse train from ppilight json message 37 | length = rf.createPulseTrain(pulses, PROTOCOL, JMESSAGE); 38 | 39 | // print available and enabled protocols 40 | Serial.print("Available protocols: "); 41 | Serial.println(rf.availableProtocols()); 42 | Serial.print("Enabled protocols: "); 43 | Serial.println(rf.enabledProtocols()); 44 | 45 | // parse pulse train multiple times 46 | for (int i = 0; i < 5; i++) { 47 | Serial.println(); 48 | Serial.print("Decoding turn "); 49 | Serial.println(i); 50 | Serial.println(); 51 | rf.parsePulseTrain(pulses, length); 52 | delay(10); 53 | } 54 | 55 | // Limit the protocol 56 | rf.limitProtocols("[\"" PROTOCOL "\"]"); 57 | 58 | // print available and enabled protocols 59 | Serial.print("Available protocols: "); 60 | Serial.println(rf.availableProtocols()); 61 | Serial.print("Enabled protocols: "); 62 | Serial.println(rf.enabledProtocols()); 63 | 64 | // parse pulse train multiple times 65 | for (int i = 0; i < 5; i++) { 66 | Serial.println(); 67 | Serial.print("Decoding turn "); 68 | Serial.println(i); 69 | Serial.println(); 70 | rf.parsePulseTrain(pulses, length); 71 | delay(10); 72 | } 73 | 74 | // Reset the filter 75 | rf.limitProtocols("[]"); 76 | 77 | // print available and enabled protocols 78 | Serial.print("Available protocols: "); 79 | Serial.println(rf.availableProtocols()); 80 | Serial.print("Enabled protocols: "); 81 | Serial.println(rf.enabledProtocols()); 82 | 83 | // parse pulse train multiple times 84 | for (int i = 0; i < 5; i++) { 85 | Serial.println(); 86 | Serial.print("Decoding turn "); 87 | Serial.println(i); 88 | Serial.println(); 89 | rf.parsePulseTrain(pulses, length); 90 | delay(10); 91 | } 92 | } 93 | 94 | void loop() { 95 | // nothing 96 | } 97 | --------------------------------------------------------------------------------