├── .idea └── .gitignore ├── LICENSE ├── README.md └── components └── knx ├── LICENSE ├── README.md ├── __init__.py ├── knx_component.cpp ├── knx_component.h ├── knx_telegram.cpp └── knx_telegram.h /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | # Editor-based HTTP Client requests 5 | /httpRequests/ 6 | # Datasource local storage ignored files 7 | /dataSources/ 8 | /dataSources.local.xml 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # custom-esphome -------------------------------------------------------------------------------- /components/knx/LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 fxmike08 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /components/knx/README.md: -------------------------------------------------------------------------------- 1 | # knx - Component for esphome 2 | ## Esphome Component that allow comunication using Knx - Twisted Pair 3 | This component is written for ESPHome to enable communication via KNX TP(Twisted Pair). 4 | This is based on [KnxTpUart](https://github.com/majuss/KnxTpUart) and has been modified to compile on ESP32/ESP8266, following ESPHome coding style. 5 | ### Knx component configuration: 6 | 7 | 8 | * **id (Required** , ID): Specifies the ID used for the KNX component. 9 | * **uart_id (Required**, ID): Specifies the ID of the UART hub. 10 | * **use_address (Required**, string): Defines the KNX device address. The format is group.subgroup.address (e.g., 10.22.10). 11 | * **listen_group_address (Required**, Array[string]): An array of addresses that the component will listen to. 12 | * **serial_timeout** (Optional, int): Sets the serial read timeout in milliseconds. The default is 1000 ms. 13 | * **lambda (Required**): Required for receiving KNX events. The KNX event will have one of the addresses specified in the `listen_group_address` entries. 14 | 15 | 16 | Usage example : 17 | ```yaml 18 | 19 | external_components: 20 | - source: 21 | type: git 22 | ref: main 23 | url: https://github.com/fxmike08/custom-esphome 24 | components: [ knx ] 25 | refresh: 0s 26 | 27 | ... 28 | uart: 29 | - id: uart_bus 30 | tx_pin: 1 #carefull with strapping pins 31 | rx_pin: 3 #carefull with strapping pins 32 | baud_rate: 19200 33 | parity: even 34 | debug: 35 | direction: BOTH 36 | dummy_receiver: false 37 | after: 38 | delimiter: "\n" 39 | sequence: 40 | - lambda: UARTDebug::log_binary(direction, bytes, 32); 41 | 42 | ... 43 | knx: 44 | id: knxd 45 | uart_id: uart_bus 46 | use_address: 10.10.1 47 | listen_group_address: ["0/0/3", "0/0/1"] 48 | lambda: |- 49 | KnxTelegram* telegram = knx.get_received_telegram(); 50 | ESP_LOGD("KNX", "group: %s",telegram->get_target_group()); 51 | if(telegram->get_target_group() == "0/0/3" ){ 52 | if(telegram->get_bool()){ 53 | ESP_LOGD("KNX", "KNX ON"); 54 | } else { 55 | ESP_LOGD("KNX", "KNX OFF"); 56 | } 57 | } 58 | return; 59 | 60 | ... 61 | api: 62 | services: 63 | - service: knx_write_group_bool 64 | variables: 65 | address: string 66 | value: bool 67 | then: 68 | - lambda: |- 69 | id(knxd).group_write_bool(address.c_str(), value); 70 | 71 | ... 72 | - platform: gpio 73 | name: $friendly_devicename Relay 2 74 | id: relay_2 75 | pin: 76 | number: 19 77 | on_turn_on: 78 | - lambda: |- 79 | id(knxd).group_write_bool("0/0/3", true); 80 | ``` 81 | 82 | **If you like this project, consider buying me a beer 🍺 ** 83 | -------------------------------------------------------------------------------- /components/knx/__init__.py: -------------------------------------------------------------------------------- 1 | import esphome.codegen as cg 2 | import esphome.config_validation as cv 3 | from esphome.components import uart 4 | from esphome.const import CONF_ID, CONF_UART_ID, CONF_USE_ADDRESS, CONF_LAMBDA 5 | 6 | 7 | CODEOWNERS = ["@fxmike@gmail.com"] 8 | DEPENDENCIES = ["uart"] 9 | 10 | knx_ns = cg.esphome_ns.namespace("knx") 11 | knx_component = knx_ns.class_("KnxComponent", cg.Component, uart.UARTDevice) 12 | 13 | CONF_LISTENING_ADDRESSES = "listen_group_address" 14 | CONF_SERIAL_TIMEOUT = "serial_timeout" 15 | 16 | CONFIG_SCHEMA = ( 17 | cv.Schema( 18 | { 19 | cv.GenerateID(): cv.declare_id(knx_component), 20 | cv.Required(CONF_USE_ADDRESS): cv.string, 21 | cv.Required(CONF_LAMBDA): cv.returning_lambda, 22 | cv.Optional(CONF_LISTENING_ADDRESSES, default=[]): cv.ensure_list( 23 | cv.string_strict 24 | ), 25 | cv.Optional(CONF_SERIAL_TIMEOUT, default=1000): cv.uint32_t, 26 | } 27 | ) 28 | .extend(cv.COMPONENT_SCHEMA) 29 | .extend(uart.UART_DEVICE_SCHEMA) 30 | ) 31 | 32 | 33 | async def to_code(config): 34 | uart_component = await cg.get_variable(config[CONF_UART_ID]) 35 | var = cg.new_Pvariable(config[CONF_ID], uart_component) 36 | 37 | if CONF_LAMBDA in config: 38 | lambda_ = await cg.process_lambda( 39 | config[CONF_LAMBDA], [(knx_component, "knx")], return_type=cg.void 40 | ) 41 | cg.add(var.set_lambda_writer(lambda_)) 42 | 43 | cg.add(var.set_use_address(config[CONF_USE_ADDRESS])) 44 | cg.add(var.set_serial_timeout(config[CONF_SERIAL_TIMEOUT])) 45 | 46 | for addreses in config[CONF_LISTENING_ADDRESSES]: 47 | cg.add(var.add_listen_group_address(addreses)) 48 | 49 | await cg.register_component(var, config) 50 | await uart.register_uart_device(var, config) 51 | -------------------------------------------------------------------------------- /components/knx/knx_component.cpp: -------------------------------------------------------------------------------- 1 | // Author: Dulgheru Mihaita (Since 2022) 2 | // Last modified: 05.05.2022 3 | 4 | #include "knx_component.h" 5 | #include "esphome/core/util.h" 6 | #include "esphome/core/log.h" 7 | #include "esphome/components/uart/uart_component.h" 8 | 9 | namespace esphome { 10 | namespace knx { 11 | 12 | int buffer[MAX_KNX_TELEGRAM_SIZE]; 13 | void KnxComponent::loop() { 14 | KnxComponentserial_eventType eType = this->serial_event(); 15 | //Evaluation of the received telegram -> only KNX telegrams are accepted 16 | if (eType == KNX_TELEGRAM) { 17 | KnxTelegram* telegram = this->get_received_telegram(); 18 | ESP_LOGD(TAG, "Received event for group %s.", telegram->get_target_group().c_str()); 19 | if (this->lambda_writer_.has_value()) // insert Labda function if available 20 | (*this->lambda_writer_)(*this); 21 | } 22 | } 23 | 24 | void KnxComponent::setup() { 25 | this->_source_area = String(this->use_address_.substr(0, this->use_address_.find('.')).c_str()).toInt(); 26 | this->_source_line = String(this->use_address_.substr(this->use_address_.find('.') + 1, this->use_address_.length()).substr(0, this->use_address_.substr(this->use_address_.find('.') + 1, this->use_address_.length()).find('.')).c_str()).toInt(); 27 | this->_source_member = String(this->use_address_.substr(this->use_address_.find_last_of('.') + 1, this->use_address_.length()).c_str()).toInt(); 28 | this->_tg = new KnxTelegram(); 29 | this->_tg_ptp = new KnxTelegram(); 30 | this->_listen_to_broadcasts = false; 31 | 32 | this->uart_reset(); 33 | } 34 | 35 | void KnxComponent::dump_config(){ 36 | ESP_LOGCONFIG(TAG, " Knx use_address: %s", this->use_address_.c_str()); 37 | for(int i = 0 ; i < this->_listen_group_address_count; i++){ 38 | ESP_LOGCONFIG(TAG, " Knx is listening for group address: %d/%d/%d ", 39 | this->_listen_group_addresses[i][0], this->_listen_group_addresses[i][1], this->_listen_group_addresses[i][2] 40 | ); 41 | } 42 | } 43 | 44 | void KnxComponent::set_use_address(const std::string &use_address) { this->use_address_ = use_address; } 45 | 46 | void KnxComponent::set_serial_timeout(const uint32_t &serial_timeout) { 47 | this->serial_timeout_ = serial_timeout; 48 | } 49 | /* ============== ADAPTED ======================= */ 50 | 51 | void KnxComponent::set_listen_to_broadcasts(bool listen) { 52 | this->_listen_to_broadcasts = listen; 53 | } 54 | 55 | void KnxComponent::uart_reset() { 56 | byte sendByte = 0x01; 57 | this->write(sendByte); 58 | } 59 | 60 | void KnxComponent::uart_state_request() { 61 | byte sendByte = 0x02; 62 | this->write(sendByte); 63 | } 64 | 65 | void KnxComponent::set_individual_address(int area, int line, int member) { 66 | this->_source_area = area; 67 | this->_source_line = line; 68 | this->_source_member = member; 69 | } 70 | 71 | KnxComponentserial_eventType KnxComponent::serial_event() { 72 | while (this->available() > 0) { 73 | this->check_errors(); 74 | int incomingByte = this->peek(); 75 | print_byte(incomingByte); 76 | 77 | if (this->is_knx_control_byte(incomingByte)) { 78 | ESP_LOGD(TAG, "We have KNX CONTROL BYTE"); 79 | bool interested = this->read_knx_telegram(); 80 | if (interested) { 81 | ESP_LOGD(TAG, "Event KNX_TELEGRAM"); 82 | return KNX_TELEGRAM; 83 | } 84 | else { 85 | ESP_LOGD(TAG, "Event IRRELEVANT_KNX_TELEGRAM"); 86 | return IRRELEVANT_KNX_TELEGRAM; 87 | } 88 | } 89 | else if (incomingByte == TPUART_RESET_INDICATION_BYTE) { 90 | this->serial_read(); 91 | ESP_LOGD(TAG, "Event TPUART_RESET_INDICATION"); 92 | return TPUART_RESET_INDICATION; 93 | } 94 | else { 95 | this->serial_read(); 96 | ESP_LOGV(TAG, "UNKNOWN"); 97 | return UNKNOWN; 98 | } 99 | } 100 | return UNKNOWN; 101 | } 102 | 103 | 104 | bool KnxComponent::is_knx_control_byte(int b) { 105 | return ( (b | B00101100) == B10111100 ); // Ignore repeat flag and priority flag 106 | } 107 | 108 | void KnxComponent::check_errors() { 109 | this->check_uart_settings(19200, 1, esphome::uart::UARTParityOptions::UART_CONFIG_PARITY_EVEN, 8); 110 | } 111 | 112 | void KnxComponent::print_byte(int incomingByte) { 113 | ESP_LOGV(TAG,"Incoming Byte: "); 114 | ESP_LOGV(TAG, "int: %i ", incomingByte); 115 | ESP_LOGV(TAG, " - "); 116 | ESP_LOGV(TAG, "hex: %x", incomingByte); 117 | } 118 | 119 | bool KnxComponent::read_knx_telegram() { 120 | // Receive header 121 | for (int i = 0; i < 6; i++) { 122 | this->_tg->set_buffer_byte(i, this->serial_read()); 123 | } 124 | ESP_LOGV(TAG,"Payload Length: %d", this->_tg->get_payload_length()); 125 | 126 | int bufpos = 6; 127 | for (int i = 0; i < this->_tg->get_payload_length(); i++) { 128 | _tg->set_buffer_byte(bufpos, this->serial_read()); 129 | bufpos++; 130 | } 131 | 132 | // Checksum 133 | this->_tg->set_buffer_byte(bufpos, this->serial_read()); 134 | 135 | // Verify if we are interested in this message - GroupAddress 136 | bool interested = this->_tg->is_target_group() && this->is_listening_to_group_address(this->_tg->get_target_main_group(), this->_tg->get_target_middle_group(), this->_tg->get_target_sub_group()); 137 | 138 | // Physical address 139 | interested = interested || ((!this->_tg->is_target_group()) && this->_tg->get_target_area() == _source_area && this->_tg->get_target_line() == _source_line && this->_tg->get_target_member() == _source_member); 140 | 141 | // Broadcast (Programming Mode) 142 | interested = interested || (this->_listen_to_broadcasts && this->_tg->is_target_group() && this->_tg->get_target_main_group() == 0 && this->_tg->get_target_middle_group() == 0 && this->_tg->get_target_sub_group() == 0); 143 | 144 | if (interested) { 145 | this->send_ack(); 146 | } 147 | else { 148 | this->send_not_addressed(); 149 | } 150 | 151 | if (this->_tg->get_communication_type() == KNX_COMM_UCD) { 152 | ESP_LOGV(TAG,"UCD Telegram received"); 153 | } 154 | else if (_tg->get_communication_type() == KNX_COMM_NCD) { 155 | ESP_LOGV(TAG,"NCD Telegram %d received", this->_tg->get_sequence_number()); 156 | 157 | if (interested) { 158 | this->send_ncd_pos_confirm(this->_tg->get_sequence_number(), this->_tg->get_source_area(), this->_tg->get_source_line(), this->_tg->get_source_member()); 159 | } 160 | } 161 | 162 | // Returns if we are interested in this diagram 163 | return interested; 164 | } 165 | 166 | KnxTelegram* KnxComponent::get_received_telegram() { 167 | return this->_tg; 168 | } 169 | 170 | // Command Write 171 | 172 | bool KnxComponent::group_write_bool(String address, bool value) { 173 | int valueAsInt = 0; 174 | if (value) { 175 | valueAsInt = B00000001; 176 | } 177 | 178 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, valueAsInt); 179 | return this->send_message(); 180 | } 181 | 182 | bool KnxComponent::group_write_4bit_int(String address, int value) { 183 | int out_value = 0; 184 | if (value) { 185 | out_value = value & B00001111; 186 | } 187 | 188 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, out_value); 189 | return this->send_message(); 190 | } 191 | 192 | bool KnxComponent::group_write_4Bit_dim(String address, bool direction, byte steps) { 193 | int value = 0; 194 | if (direction || steps) { 195 | value = (direction << 3) + (steps & B00000111); 196 | } 197 | 198 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, value); 199 | return this->send_message(); 200 | } 201 | 202 | bool KnxComponent::group_write_1byte_int(String address, int value) { 203 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, 0); 204 | this->_tg->set_1byte_int_value(value); 205 | this->_tg->create_checksum(); 206 | return this->send_message(); 207 | } 208 | 209 | bool KnxComponent::group_write_2byte_int(String address, int value) { 210 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, 0); 211 | this->_tg->set_2byte_int_value(value); 212 | this->_tg->create_checksum(); 213 | return this->send_message(); 214 | } 215 | 216 | bool KnxComponent::group_write_2byte_float(String address, float value) { 217 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, 0); 218 | this->_tg->set_2byte_float_value(value); 219 | this->_tg->create_checksum(); 220 | return this->send_message(); 221 | } 222 | 223 | bool KnxComponent::group_write_3byte_time(String address, int weekday, int hour, int minute, int second) { 224 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, 0); 225 | this->_tg->set_3byte_time(weekday, hour, minute, second); 226 | this->_tg->create_checksum(); 227 | return this->send_message(); 228 | } 229 | 230 | bool KnxComponent::group_write_3byte_date(String address, int day, int month, int year) { 231 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, 0); 232 | this->_tg->set_3byte_date(day, month, year); 233 | this->_tg->create_checksum(); 234 | return this->send_message(); 235 | } 236 | 237 | bool KnxComponent::group_write_4byte_float(String address, float value) { 238 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, 0); 239 | this->_tg->set_4byte_float_value(value); 240 | this->_tg->create_checksum(); 241 | return this->send_message(); 242 | } 243 | 244 | bool KnxComponent::group_write_14byte_text(String address, String value) { 245 | this->create_knx_message_frame(2, KNX_COMMAND_WRITE, address, 0); 246 | this->_tg->set_14byte_value(value); 247 | this->_tg->create_checksum(); 248 | return this->send_message(); 249 | } 250 | 251 | // Command Answer 252 | 253 | bool KnxComponent::group_answer_bool(String address, bool value) { 254 | int valueAsInt = 0; 255 | if (value) { 256 | valueAsInt = B00000001; 257 | } 258 | 259 | create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, valueAsInt); 260 | return this->send_message(); 261 | } 262 | 263 | /* 264 | bool KnxComponent::groupAnswerBitInt(String address, int value) { 265 | int out_value = 0; 266 | if (value) { 267 | out_value = value & B00001111; 268 | } 269 | 270 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, out_value); 271 | return this->send_message(); 272 | } 273 | 274 | bool KnxComponent::group_answer_4bit_dim(String address, bool direction, byte steps) { 275 | int value = 0; 276 | if (direction || steps) { 277 | value = (direction << 3) + (steps & B00000111); 278 | } 279 | 280 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, value); 281 | return this->send_message(); 282 | } 283 | */ 284 | 285 | bool KnxComponent::group_answer_1byte_int(String address, int value) { 286 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, 0); 287 | this->_tg->set_1byte_int_value(value); 288 | this->_tg->create_checksum(); 289 | return this->send_message(); 290 | } 291 | 292 | bool KnxComponent::group_answer_2byte_int(String address, int value) { 293 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, 0); 294 | this->_tg->set_2byte_int_value(value); 295 | this->_tg->create_checksum(); 296 | return this->send_message(); 297 | } 298 | 299 | bool KnxComponent::group_answer_2byte_float(String address, float value) { 300 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, 0); 301 | this->_tg->set_2byte_float_value(value); 302 | this->_tg->create_checksum(); 303 | return this->send_message(); 304 | } 305 | 306 | bool KnxComponent::group_answer_3byte_time(String address, int weekday, int hour, int minute, int second) { 307 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, 0); 308 | this->_tg->set_3byte_time(weekday, hour, minute, second); 309 | this->_tg->create_checksum(); 310 | return this->send_message(); 311 | } 312 | 313 | bool KnxComponent::group_answer_3byte_date(String address, int day, int month, int year) { 314 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, 0); 315 | this->_tg->set_3byte_date(day, month, year); 316 | this->_tg->create_checksum(); 317 | return this->send_message(); 318 | } 319 | bool KnxComponent::group_answer_4byte_float(String address, float value) { 320 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, 0); 321 | this->_tg->set_4byte_float_value(value); 322 | this->_tg->create_checksum(); 323 | return this->send_message(); 324 | } 325 | 326 | bool KnxComponent::group_answer_14byte_text(String address, String value) { 327 | this->create_knx_message_frame(2, KNX_COMMAND_ANSWER, address, 0); 328 | this->_tg->set_14byte_value(value); 329 | this->_tg->create_checksum(); 330 | return this->send_message(); 331 | } 332 | 333 | // Command Read 334 | 335 | bool KnxComponent::group_read(String address) { 336 | this->create_knx_message_frame(2, KNX_COMMAND_READ, address, 0); 337 | this->_tg->create_checksum(); 338 | return this->send_message(); 339 | } 340 | 341 | bool KnxComponent::individual_answer_address() { 342 | this->create_knx_message_frame(2, KNX_COMMAND_INDIVIDUAL_ADDR_RESPONSE, "0/0/0", 0); 343 | this->_tg->create_checksum(); 344 | return this->send_message(); 345 | } 346 | 347 | bool KnxComponent::individual_answer_mask_version(int area, int line, int member) { 348 | this->create_knx_message_frame_individual(4, KNX_COMMAND_MASK_VERSION_RESPONSE, String(area) + "/" + String(line) + "/" + String(member), 0); 349 | this->_tg->set_communication_type(KNX_COMM_NDP); 350 | this->_tg->set_buffer_byte(8, 0x07); // Mask version part 1 for BIM M 112 351 | this->_tg->set_buffer_byte(9, 0x01); // Mask version part 2 for BIM M 112 352 | this->_tg->create_checksum(); 353 | return this->send_message(); 354 | } 355 | 356 | bool KnxComponent::individual_answer_auth(int accessLevel, int sequenceNo, int area, int line, int member) { 357 | this->create_knx_message_frame_individual(3, KNX_COMMAND_ESCAPE, String(area) + "/" + String(line) + "/" + String(member), KNX_EXT_COMMAND_AUTH_RESPONSE); 358 | this->_tg->set_communication_type(KNX_COMM_NDP); 359 | this->_tg->set_sequence_number(sequenceNo); 360 | this->_tg->set_buffer_byte(8, accessLevel); 361 | this->_tg->create_checksum(); 362 | return this->send_message(); 363 | } 364 | 365 | void KnxComponent::create_knx_message_frame(int payloadlength, KnxCommandType command, String address, int firstDataByte) { 366 | int mainGroup = address.substring(0, address.indexOf('/')).toInt(); 367 | int middleGroup = address.substring(address.indexOf('/') + 1, address.length()).substring(0, address.substring(address.indexOf('/') + 1, address.length()).indexOf('/')).toInt(); 368 | int subGroup = address.substring(address.lastIndexOf('/') + 1, address.length()).toInt(); 369 | this->_tg->clear(); 370 | this->_tg->set_source_address(_source_area, _source_line, _source_member); 371 | this->_tg->set_target_group_address(mainGroup, middleGroup, subGroup); 372 | this->_tg->set_first_data_byte(firstDataByte); 373 | this->_tg->set_command(command); 374 | this->_tg->set_payload_length(payloadlength); 375 | this->_tg->create_checksum(); 376 | } 377 | 378 | void KnxComponent::create_knx_message_frame_individual(int payloadlength, KnxCommandType command, String address, int firstDataByte) { 379 | int area = address.substring(0, address.indexOf('/')).toInt(); 380 | int line = address.substring(address.indexOf('/') + 1, address.length()).substring(0, address.substring(address.indexOf('/') + 1, address.length()).indexOf('/')).toInt(); 381 | int member = address.substring(address.lastIndexOf('/') + 1, address.length()).toInt(); 382 | this->_tg->clear(); 383 | this->_tg->set_source_address(_source_area, _source_line, _source_member); 384 | this->_tg->set_target_individual_address(area, line, member); 385 | this->_tg->set_first_data_byte(firstDataByte); 386 | this->_tg->set_command(command); 387 | this->_tg->set_payload_length(payloadlength); 388 | this->_tg->create_checksum(); 389 | } 390 | 391 | bool KnxComponent::send_ncd_pos_confirm(int sequenceNo, int area, int line, int member) { 392 | this->_tg_ptp->clear(); 393 | this->_tg_ptp->set_source_address(_source_area, _source_line, _source_member); 394 | this->_tg_ptp->set_target_individual_address(area, line, member); 395 | this->_tg_ptp->set_sequence_number(sequenceNo); 396 | this->_tg_ptp->set_communication_type(KNX_COMM_NCD); 397 | this->_tg_ptp->set_control_data(KNX_CONTROLDATA_POS_CONFIRM); 398 | this->_tg_ptp->set_payload_length(1); 399 | this->_tg_ptp->create_checksum(); 400 | 401 | 402 | int messageSize = this->_tg_ptp->get_total_length(); 403 | 404 | uint8_t sendbuf[2]; 405 | for (int i = 0; i < messageSize; i++) { 406 | if (i == (messageSize - 1)) { 407 | sendbuf[0] = TPUART_DATA_END; 408 | } 409 | else { 410 | sendbuf[0] = TPUART_DATA_START_CONTINUE; 411 | } 412 | 413 | sendbuf[0] |= i; 414 | sendbuf[1] = this->_tg_ptp->get_buffer_byte(i); 415 | 416 | this->write_array(sendbuf, 2); 417 | } 418 | 419 | 420 | int confirmation; 421 | while (true) { 422 | confirmation = serial_read(); 423 | if (confirmation == B10001011) { 424 | return true; // Sent successfully 425 | } 426 | else if (confirmation == B00001011) { 427 | return false; 428 | } 429 | else if (confirmation == -1) { 430 | // Read timeout 431 | return false; 432 | } 433 | } 434 | 435 | return false; 436 | } 437 | 438 | bool KnxComponent::send_message() { 439 | int messageSize = this->_tg->get_total_length(); 440 | 441 | uint8_t sendbuf[2]; 442 | for (int i = 0; i < messageSize; i++) { 443 | if (i == (messageSize - 1)) { 444 | sendbuf[0] = TPUART_DATA_END; 445 | } 446 | else { 447 | sendbuf[0] = TPUART_DATA_START_CONTINUE; 448 | } 449 | 450 | sendbuf[0] |= i; 451 | sendbuf[1] = this->_tg->get_buffer_byte(i); 452 | 453 | this->write_array(sendbuf, 2); 454 | } 455 | 456 | 457 | int confirmation; 458 | while (true) { 459 | confirmation = this->serial_read(); 460 | if (confirmation == B10001011) { 461 | delay (SERIAL_WRITE_DELAY_MS); 462 | return true; // Sent successfully 463 | } 464 | else if (confirmation == B00001011) { 465 | delay (SERIAL_WRITE_DELAY_MS); 466 | return false; 467 | } 468 | else if (confirmation == -1) { 469 | // Read timeout 470 | ESP_LOGD(TAG, "Serial read timeout !"); 471 | delay (SERIAL_WRITE_DELAY_MS); 472 | return false; 473 | } 474 | } 475 | 476 | return false; 477 | } 478 | 479 | void KnxComponent::send_ack() { 480 | byte sendByte = B00010001; 481 | this->write(sendByte); 482 | delay(SERIAL_WRITE_DELAY_MS); 483 | } 484 | 485 | void KnxComponent::send_not_addressed() { 486 | byte sendByte = B00010000; 487 | this->write(sendByte); 488 | delay(SERIAL_WRITE_DELAY_MS); 489 | } 490 | 491 | int KnxComponent::serial_read() { 492 | unsigned long startTime = millis(); 493 | bool isSerialAvailable = true; 494 | while (! ( this->available() > 0)) { 495 | delay(1); 496 | if(millis() - startTime > this->serial_timeout_){ 497 | ESP_LOGW(TAG, "Serial timeout reached (%d ms) ! Unable to read from serial ! Aborting.", this->serial_timeout_); 498 | isSerialAvailable = false; 499 | break; 500 | } 501 | } 502 | int inByte = -1; 503 | if (isSerialAvailable){ 504 | inByte = this->read(); 505 | this->check_errors(); 506 | this->print_byte(inByte); 507 | } 508 | 509 | return inByte; 510 | } 511 | 512 | void KnxComponent::add_listen_group_address(String address) { 513 | if (_listen_group_address_count >= MAX_LISTEN_GROUP_ADDRESSES) { 514 | ESP_LOGW(TAG, "Already listening to MAX_LISTEN_GROUP_ADDRESSES, cannot listen to another."); 515 | return; 516 | } 517 | this->_listen_group_addresses[this->_listen_group_address_count][0] = address.substring(0, address.indexOf('/')).toInt(); 518 | ; 519 | this->_listen_group_addresses[this->_listen_group_address_count][1] = address.substring(address.indexOf('/') + 1, address.length()).substring(0, address.substring(address.indexOf('/') + 1, address.length()).indexOf('/')).toInt(); 520 | this->_listen_group_addresses[this->_listen_group_address_count][2] = address.substring(address.lastIndexOf('/') + 1, address.length()).toInt(); 521 | 522 | this->_listen_group_address_count++; 523 | } 524 | 525 | bool KnxComponent::is_listening_to_group_address(int main, int middle, int sub) { 526 | for (int i = 0; i < this->_listen_group_address_count; i++) { 527 | if ( (_listen_group_addresses[i][0] == main) 528 | && (_listen_group_addresses[i][1] == middle) 529 | && (_listen_group_addresses[i][2] == sub)) { 530 | return true; 531 | } 532 | } 533 | 534 | return false; 535 | } 536 | 537 | } // namespace knx 538 | } // namespace esphome 539 | -------------------------------------------------------------------------------- /components/knx/knx_component.h: -------------------------------------------------------------------------------- 1 | // Author: Dulgheru Mihaita (Since 2022) 2 | // Last modified: 05.05.2022 3 | 4 | #pragma once 5 | 6 | #include "esphome.h" 7 | #include "esphome/core/component.h" 8 | #include "esphome/components/uart/uart.h" 9 | #include "knx_telegram.h" 10 | 11 | using namespace std; 12 | static const char *const TAG = "knx"; 13 | 14 | namespace esphome { 15 | namespace knx { 16 | 17 | static const int MAX_LISTEN_GROUP_ADDRESSES=15; 18 | static const int SERIAL_WRITE_DELAY_MS=100; 19 | static const byte TPUART_DATA_START_CONTINUE=B10000000; 20 | static const byte TPUART_DATA_END=B01000000; 21 | // Services from TPUART 22 | static const byte TPUART_RESET_INDICATION_BYTE=B11; 23 | 24 | enum KnxComponentserial_eventType { 25 | TPUART_RESET_INDICATION, 26 | KNX_TELEGRAM, 27 | IRRELEVANT_KNX_TELEGRAM, 28 | UNKNOWN 29 | }; 30 | 31 | // Needed for lambda expression 32 | class KnxComponent; 33 | using lambda_writer_t = std::function; 34 | 35 | class KnxComponent : public Component, public uart::UARTDevice { 36 | 37 | public: 38 | KnxComponent(uart::UARTComponent *uart) : uart::UARTDevice(uart) { 39 | _listen_group_address_count = 0; 40 | }; 41 | void loop() override; 42 | void setup() override; 43 | void dump_config() override; 44 | void set_use_address(const std::string &use_address); 45 | void set_serial_timeout(const uint32_t &serial_timeout); 46 | 47 | // KNXTpUART - adapted 48 | void uart_reset(); 49 | void uart_state_request(); 50 | KnxComponentserial_eventType serial_event(); 51 | KnxTelegram* get_received_telegram(); 52 | 53 | void set_individual_address(int, int, int); 54 | 55 | void send_ack(); 56 | void send_not_addressed(); 57 | 58 | bool group_write_bool(String, bool); 59 | bool group_write_4bit_int(String, int); 60 | bool group_write_4Bit_dim(String, bool, byte); 61 | bool group_write_1byte_int(String, int); 62 | bool group_write_2byte_int(String, int); 63 | bool group_write_2byte_float(String, float); 64 | bool group_write_3byte_time(String, int, int, int, int); 65 | bool group_write_3byte_date(String, int, int, int); 66 | bool group_write_4byte_float(String, float); 67 | bool group_write_14byte_text(String, String); 68 | 69 | bool group_answer_bool(String, bool); 70 | /* 71 | bool group_answer_4bit_int(String, int); 72 | bool group_answer_4bit_dim(String, bool, byte); 73 | */ 74 | bool group_answer_1byte_int(String, int); 75 | bool group_answer_2byte_int(String, int); 76 | bool group_answer_2byte_float(String, float); 77 | bool group_answer_3byte_time(String, int, int, int, int); 78 | bool group_answer_3byte_date(String, int, int, int); 79 | bool group_answer_4byte_float(String, float); 80 | bool group_answer_14byte_text(String, String); 81 | 82 | bool group_read(String); 83 | 84 | void add_listen_group_address(String); 85 | bool is_listening_to_group_address(int, int, int); 86 | 87 | bool individual_answer_address(); 88 | bool individual_answer_mask_version(int, int, int); 89 | bool individual_answer_auth(int, int, int, int, int); 90 | 91 | void set_listen_to_broadcasts(bool); 92 | // Needed for lambda expression 93 | void set_lambda_writer(lambda_writer_t &&writer) { this->lambda_writer_ = writer; }; 94 | 95 | 96 | protected: 97 | std::string use_address_; 98 | uint32_t serial_timeout_; 99 | // KNXTpUART - adapted 100 | KnxTelegram* _tg; // for normal communication 101 | KnxTelegram* _tg_ptp; // for PTP sequence confirmation 102 | int _source_area; 103 | int _source_line; 104 | int _source_member; 105 | int _listen_group_addresses[MAX_LISTEN_GROUP_ADDRESSES][3]; 106 | int _listen_group_address_count; 107 | bool _listen_to_broadcasts; 108 | 109 | bool is_knx_control_byte(int); 110 | void check_errors(); 111 | void print_byte(int); 112 | bool read_knx_telegram(); 113 | void create_knx_message_frame(int, KnxCommandType, String, int); 114 | void create_knx_message_frame_individual(int, KnxCommandType, String, int); 115 | bool send_message(); 116 | bool send_ncd_pos_confirm(int, int, int, int); 117 | int serial_read(); 118 | optional lambda_writer_{}; 119 | 120 | }; 121 | } // namespace knx 122 | } // namespace esphome 123 | -------------------------------------------------------------------------------- /components/knx/knx_telegram.cpp: -------------------------------------------------------------------------------- 1 | // File: knx_telegram.cpp 2 | // Author: Daniel Kleine-Albers (Since 2012) 3 | // Modified: Thorsten Gehrig (Since 2014) 4 | // Modified: Michael Werski (Since 2014) 5 | // Modified: Katja Blankenheim (Since 2014) 6 | // Modified: Mag Gyver (Since 2016) 7 | // Modified: Rouven Raudzus (Since 2017) 8 | // Modified: Dulgheru Mihaita (Since 2022) 9 | 10 | // Last modified: 05.05.2022 11 | 12 | #include "knx_telegram.h" 13 | 14 | KnxTelegram::KnxTelegram() { 15 | clear(); 16 | } 17 | 18 | void KnxTelegram::clear() { 19 | for (int i = 0; i < MAX_KNX_TELEGRAM_SIZE; i++) { 20 | buffer[i] = 0; 21 | } 22 | 23 | // Control Field, Normal Priority, No Repeat 24 | buffer[0] = B10111100; 25 | 26 | // Target Group Address, Routing Counter = 6, Length = 1 (= 2 Bytes) 27 | buffer[5] = B11100001; 28 | } 29 | 30 | int KnxTelegram::get_buffer_byte(int index) { 31 | return buffer[index]; 32 | } 33 | 34 | void KnxTelegram::set_buffer_byte(int index, int content) { 35 | buffer[index] = content; 36 | } 37 | 38 | bool KnxTelegram::is_repeated() { 39 | // Parse Repeat Flag 40 | if (buffer[0] & B00100000) { 41 | return false; 42 | } 43 | else { 44 | return true; 45 | } 46 | } 47 | 48 | void KnxTelegram::set_repeated(bool repeat) { 49 | if (repeat) { 50 | buffer[0] = buffer[0] & B11011111; 51 | } 52 | else { 53 | buffer[0] = buffer[0] | B00100000; 54 | } 55 | } 56 | 57 | void KnxTelegram::set_priority(KnxPriorityType prio) { 58 | buffer[0] = buffer[0] & B11110011; 59 | buffer[0] = buffer[0] | (prio << 2); 60 | } 61 | 62 | KnxPriorityType KnxTelegram::get_priority() { 63 | // Priority 64 | return (KnxPriorityType) ((buffer[0] & B00001100) >> 2); 65 | } 66 | 67 | void KnxTelegram::set_source_address(int area, int line, int member) { 68 | buffer[1] = (area << 4) | line; // Source Address 69 | buffer[2] = member; // Source Address 70 | } 71 | 72 | int KnxTelegram::get_source_area() { 73 | return (buffer[1] >> 4); 74 | } 75 | 76 | int KnxTelegram::get_source_line() { 77 | return (buffer[1] & B00001111); 78 | } 79 | 80 | int KnxTelegram::get_source_member() { 81 | return buffer[2]; 82 | } 83 | 84 | void KnxTelegram::set_target_group_address(int main, int middle, int sub) { 85 | buffer[3] = (main << 3) | middle; 86 | buffer[4] = sub; 87 | buffer[5] = buffer[5] | B10000000; 88 | } 89 | 90 | void KnxTelegram::set_target_individual_address(int area, int line, int member) { 91 | buffer[3] = (area << 4) | line; 92 | buffer[4] = member; 93 | buffer[5] = buffer[5] & B01111111; 94 | } 95 | 96 | bool KnxTelegram::is_target_group() { 97 | return buffer[5] & B10000000; 98 | } 99 | 100 | String KnxTelegram::get_target_group(){ 101 | String target = 102 | String(0 + this->get_target_main_group()) + "/" + 103 | String(0 + this->get_target_middle_group()) + "/" + 104 | String(0 + this->get_target_sub_group()); 105 | return target; 106 | } 107 | 108 | int KnxTelegram::get_target_main_group() { 109 | return ((buffer[3] & B01111000) >> 3); 110 | } 111 | 112 | int KnxTelegram::get_target_middle_group() { 113 | return (buffer[3] & B00000111); 114 | } 115 | 116 | int KnxTelegram::get_target_sub_group() { 117 | return buffer[4]; 118 | } 119 | 120 | int KnxTelegram::get_target_area() { 121 | return ((buffer[3] & B11110000) >> 4); 122 | } 123 | 124 | int KnxTelegram::get_target_line() { 125 | return (buffer[3] & B00001111); 126 | } 127 | 128 | int KnxTelegram::get_target_member() { 129 | return buffer[4]; 130 | } 131 | 132 | void KnxTelegram::set_routing_counter(int counter) { 133 | buffer[5] = buffer[5] & B10000000; 134 | buffer[5] = buffer[5] | (counter << 4); 135 | } 136 | 137 | int KnxTelegram::get_routing_counter() { 138 | return ((buffer[5] & B01110000) >> 4); 139 | } 140 | 141 | void KnxTelegram::set_payload_length(int length) { 142 | buffer[5] = buffer[5] & B11110000; 143 | buffer[5] = buffer[5] | (length - 1); 144 | } 145 | 146 | int KnxTelegram::get_payload_length() { 147 | int length = (buffer[5] & B00001111) + 1; 148 | return length; 149 | } 150 | 151 | void KnxTelegram::set_command(KnxCommandType command) { 152 | buffer[6] = buffer[6] & B11111100; 153 | buffer[7] = buffer[7] & B00111111; 154 | 155 | buffer[6] = buffer[6] | (command >> 2); // Command first two bits 156 | buffer[7] = buffer[7] | (command << 6); // Command last two bits 157 | } 158 | 159 | KnxCommandType KnxTelegram::get_command() { 160 | return (KnxCommandType) (((buffer[6] & B00000011) << 2) | ((buffer[7] & B11000000) >> 6)); 161 | } 162 | 163 | void KnxTelegram::set_control_data(KnxControlDataType cd) { 164 | buffer[6] = buffer[6] & B11111100; 165 | buffer[6] = buffer[6] | cd; 166 | } 167 | 168 | KnxControlDataType KnxTelegram::get_control_data() { 169 | return (KnxControlDataType) (buffer[6] & B00000011); 170 | } 171 | 172 | KnxCommunicationType KnxTelegram::get_communication_type() { 173 | return (KnxCommunicationType) ((buffer[6] & B11000000) >> 6); 174 | } 175 | 176 | void KnxTelegram::set_communication_type(KnxCommunicationType type) { 177 | buffer[6] = buffer[6] & B00111111; 178 | buffer[6] = buffer[6] | (type << 6); 179 | } 180 | 181 | int KnxTelegram::get_sequence_number() { 182 | return (buffer[6] & B00111100) >> 2; 183 | } 184 | 185 | void KnxTelegram::set_sequence_number(int number) { 186 | buffer[6] = buffer[6] & B11000011; 187 | buffer[6] = buffer[6] | (number << 2); 188 | } 189 | 190 | void KnxTelegram::create_checksum() { 191 | int checksumPos = get_payload_length() + KNX_TELEGRAM_HEADER_SIZE; 192 | buffer[checksumPos] = calculate_checksum(); 193 | } 194 | 195 | int KnxTelegram::get_checksum() { 196 | int checksumPos = get_payload_length() + KNX_TELEGRAM_HEADER_SIZE; 197 | return buffer[checksumPos]; 198 | } 199 | 200 | bool KnxTelegram::verify_checksum() { 201 | int calculatedChecksum = calculate_checksum(); 202 | return (get_checksum() == calculatedChecksum); 203 | } 204 | 205 | void KnxTelegram::print() { 206 | #if defined(TPUART_DEBUG) 207 | serial->print("Repeated: "); 208 | serial->println(is_repeated()); 209 | 210 | serial->print("Priority: "); 211 | serial->println(get_priority()); 212 | 213 | serial->print("Source: "); 214 | serial->print(get_source_area()); 215 | serial->print("."); 216 | serial->print(get_source_line()); 217 | serial->print("."); 218 | serial->println(get_source_member()); 219 | 220 | if (is_target_group()) { 221 | serial->print("Target Group: "); 222 | serial->print(get_target_main_group()); 223 | serial->print("/"); 224 | serial->print(get_target_middle_group()); 225 | serial->print("/"); 226 | serial->println(get_target_sub_group()); 227 | } 228 | else { 229 | serial->print("Target Physical: "); 230 | serial->print(get_target_area()); 231 | serial->print("."); 232 | serial->print(get_target_line()); 233 | serial->print("."); 234 | serial->println(get_target_member()); 235 | } 236 | 237 | serial->print("Routing Counter: "); 238 | serial->println(get_routing_counter()); 239 | 240 | serial->print("Payload Length: "); 241 | serial->println(get_payload_length()); 242 | 243 | serial->print("Command: "); 244 | serial->println(get_command()); 245 | 246 | serial->print("First Data Byte: "); 247 | serial->println(get_first_data_byte()); 248 | 249 | for (int i = 2; i < get_payload_length(); i++) { 250 | serial->print("Data Byte "); 251 | serial->print(i); 252 | serial->print(": "); 253 | serial->println(buffer[6 + i], BIN); 254 | } 255 | 256 | 257 | if (verify_checksum()) { 258 | serial->println("Checksum matches"); 259 | } 260 | else { 261 | serial->println("Checksum mismatch"); 262 | serial->println(get_checksum(), BIN); 263 | serial->println(calculate_checksum(), BIN); 264 | } 265 | #endif 266 | } 267 | 268 | int KnxTelegram::calculate_checksum() { 269 | int bcc = 0xFF; 270 | int size = get_payload_length() + KNX_TELEGRAM_HEADER_SIZE; 271 | 272 | for (int i = 0; i < size; i++) { 273 | bcc ^= buffer[i]; 274 | } 275 | 276 | return bcc; 277 | } 278 | 279 | int KnxTelegram::get_total_length() { 280 | return KNX_TELEGRAM_HEADER_SIZE + get_payload_length() + 1; 281 | } 282 | 283 | void KnxTelegram::set_first_data_byte(int data) { 284 | buffer[7] = buffer[7] & B11000000; 285 | buffer[7] = buffer[7] | data; 286 | } 287 | 288 | int KnxTelegram::get_first_data_byte() { 289 | return (buffer[7] & B00111111); 290 | } 291 | 292 | bool KnxTelegram::get_bool() { 293 | if (get_payload_length() != 2) { 294 | // Wrong payload length 295 | return 0; 296 | } 297 | 298 | return (get_first_data_byte() & B00000001); 299 | } 300 | 301 | int KnxTelegram::get_4bit_int_value() { 302 | if (get_payload_length() != 2) { 303 | // Wrong payload length 304 | return 0; 305 | } 306 | 307 | return (get_first_data_byte() & B00001111); 308 | } 309 | 310 | bool KnxTelegram::get_4bit_direction_value() { 311 | if (get_payload_length() != 2) { 312 | // Wrong payload length 313 | return 0; 314 | } 315 | 316 | return ((get_first_data_byte() & B00001000)) >> 3; 317 | } 318 | 319 | byte KnxTelegram::get_4bit_steps_value() { 320 | if (get_payload_length() != 2) { 321 | // Wrong payload length 322 | return 0; 323 | } 324 | 325 | return (get_first_data_byte() & B00000111); 326 | } 327 | 328 | void KnxTelegram::set_1byte_int_value(int value) { 329 | set_payload_length(3); 330 | buffer[8] = value; 331 | } 332 | 333 | int KnxTelegram::get_1byte_int_value() { 334 | if (get_payload_length() != 3) { 335 | // Wrong payload length 336 | return 0; 337 | } 338 | 339 | return (buffer[8]); 340 | } 341 | 342 | void KnxTelegram::set_2byte_int_value(int value) { 343 | set_payload_length(4); 344 | 345 | buffer[8] = byte(value >> 8); 346 | buffer[9] = byte(value & 0x00FF); 347 | } 348 | 349 | int KnxTelegram::get_2byte_int_value() { 350 | if (get_payload_length() != 4) { 351 | // Wrong payload length 352 | return 0; 353 | } 354 | int value = int(buffer[8] << 8) + int(buffer[9]); 355 | 356 | return (value); 357 | } 358 | 359 | void KnxTelegram::set_2byte_float_value(float value) { 360 | set_payload_length(4); 361 | 362 | float v = value * 100.0f; 363 | int exponent = 0; 364 | for (; v < -2048.0f; v /= 2) exponent++; 365 | for (; v > 2047.0f; v /= 2) exponent++; 366 | long m = (int)round(v) & 0x7FF; 367 | short msb = (short) (exponent << 3 | m >> 8); 368 | if (value < 0.0f) msb |= 0x80; 369 | buffer[8] = msb; 370 | buffer[9] = (byte)m; 371 | } 372 | 373 | float KnxTelegram::get_2byte_float_value() { 374 | if (get_payload_length() != 4) { 375 | // Wrong payload length 376 | return 0; 377 | } 378 | 379 | int exponent = (buffer[8] & B01111000) >> 3; 380 | int mantissa = ((buffer[8] & B00000111) << 8) | (buffer[9]); 381 | 382 | if (buffer[8] & B10000000) { 383 | return ((-2048 + mantissa) * 0.01) * pow(2.0, exponent); 384 | } 385 | 386 | return (mantissa * 0.01) * pow(2.0, exponent); 387 | } 388 | 389 | void KnxTelegram::set_3byte_time(int weekday, int hour, int minute, int second) { 390 | set_payload_length(5); 391 | 392 | // Move the weekday by 5 bits to the left 393 | weekday = weekday << 5; 394 | 395 | // Buffer [8] bit 5-7 for weekday, bit 0-4 for hour 396 | buffer[8] = (weekday & B11100000) + (hour & B00011111); 397 | 398 | // Buffer [9] bit 6-7 empty, bit 0-5 for minutes 399 | buffer[9] = minute & B00111111; 400 | 401 | // Buffer [10] bit 6-7 empty, bit 0-5 for seconds 402 | buffer[10] = second & B00111111; 403 | } 404 | 405 | int KnxTelegram::get_3byte_weekday_value() { 406 | if (get_payload_length() != 5) { 407 | // Wrong payload length 408 | return 0; 409 | } 410 | return (buffer[8] & B11100000) >> 5; 411 | } 412 | 413 | int KnxTelegram::get_3byte_hour_value() { 414 | if (get_payload_length() != 5) { 415 | // Wrong payload length 416 | return 0; 417 | } 418 | return (buffer[8] & B00011111); 419 | } 420 | 421 | int KnxTelegram::get_3byte_minute_value() { 422 | if (get_payload_length() != 5) { 423 | // Wrong payload length 424 | return 0; 425 | } 426 | return (buffer[9] & B00111111); 427 | } 428 | 429 | int KnxTelegram::get_3byte_second_value() { 430 | if (get_payload_length() != 5) { 431 | // Wrong payload length 432 | return 0; 433 | } 434 | return (buffer[10] & B00111111); 435 | } 436 | 437 | void KnxTelegram::set_3byte_date(int day, int month, int year) { 438 | set_payload_length(5); 439 | 440 | // Buffer [8] bit 5-7 empty, bit 0-4 for month days 441 | buffer[8] = day & B00011111; 442 | 443 | // Buffer [9] bit 4-7 empty, bit 0-3 for months 444 | buffer[9] = month & B00001111; 445 | 446 | // Buffer [10] fill with year 447 | buffer[10] = year; 448 | } 449 | 450 | int KnxTelegram::get_3byte_day_value() { 451 | if (get_payload_length() != 5) { 452 | // Wrong payload length 453 | return 0; 454 | } 455 | return (buffer[8] & B00011111); 456 | } 457 | 458 | int KnxTelegram::get_3byte_month_value() { 459 | if (get_payload_length() != 5) { 460 | // Wrong payload length 461 | return 0; 462 | } 463 | return (buffer[9] & B00001111); 464 | } 465 | 466 | int KnxTelegram::get_3byte_year_value() { 467 | if (get_payload_length() != 5) { 468 | // Wrong payload length 469 | return 0; 470 | } 471 | return (buffer[10]); 472 | } 473 | 474 | void KnxTelegram::set_4byte_float_value(float value) { 475 | set_payload_length(6); 476 | 477 | byte b[4]; 478 | float *f = (float*)(void*) & (b[0]); 479 | *f = value; 480 | 481 | buffer[8 + 3] = b[0]; 482 | buffer[8 + 2] = b[1]; 483 | buffer[8 + 1] = b[2]; 484 | buffer[8 + 0] = b[3]; 485 | } 486 | 487 | float KnxTelegram::get_4byte_float_value() { 488 | if (get_payload_length() != 6) { 489 | // Wrong payload length 490 | return 0; 491 | } 492 | byte b[4]; 493 | b[0] = buffer[8 + 3]; 494 | b[1] = buffer[8 + 2]; 495 | b[2] = buffer[8 + 1]; 496 | b[3] = buffer[8 + 0]; 497 | float *f = (float*)(void*) & (b[0]); 498 | float r = *f; 499 | return r; 500 | } 501 | 502 | void KnxTelegram::set_14byte_value(String value) { 503 | // Define 504 | char _load[15]; 505 | 506 | // Empty/Initialize with space 507 | for (int i = 0; i < 14; ++i) 508 | { 509 | _load[i] = 0; 510 | } 511 | set_payload_length(16); 512 | // Make out of value the Chararray 513 | value.toCharArray(_load, 15); // Must be 15 - because it completes with 0 514 | buffer[8 + 0] = _load [0]; 515 | buffer[8 + 1] = _load [1]; 516 | buffer[8 + 2] = _load [2]; 517 | buffer[8 + 3] = _load [3]; 518 | buffer[8 + 4] = _load [4]; 519 | buffer[8 + 5] = _load [5]; 520 | buffer[8 + 6] = _load [6]; 521 | buffer[8 + 7] = _load [7]; 522 | buffer[8 + 8] = _load [8]; 523 | buffer[8 + 9] = _load [9]; 524 | buffer[8 + 10] = _load [10]; 525 | buffer[8 + 11] = _load [11]; 526 | buffer[8 + 12] = _load [12]; 527 | buffer[8 + 13] = _load [13]; 528 | } 529 | 530 | String KnxTelegram::get_14byte_value() { 531 | if (get_payload_length() != 16) { 532 | // Wrong payload length 533 | return ""; 534 | } 535 | char _load[15]; 536 | _load[0] = buffer[8 + 0]; 537 | _load[1] = buffer[8 + 1]; 538 | _load[2] = buffer[8 + 2]; 539 | _load[3] = buffer[8 + 3]; 540 | _load[4] = buffer[8 + 4]; 541 | _load[5] = buffer[8 + 5]; 542 | _load[6] = buffer[8 + 6]; 543 | _load[7] = buffer[8 + 7]; 544 | _load[8] = buffer[8 + 8]; 545 | _load[9] = buffer[8 + 9]; 546 | _load[10] = buffer[8 + 10]; 547 | _load[11] = buffer[8 + 11]; 548 | _load[12] = buffer[8 + 12]; 549 | _load[13] = buffer[8 + 13]; 550 | return (_load); 551 | } -------------------------------------------------------------------------------- /components/knx/knx_telegram.h: -------------------------------------------------------------------------------- 1 | // File: knx_telegram.h 2 | // Author: Daniel Kleine-Albers (Since 2012) 3 | // Modified: Thorsten Gehrig (Since 2014) 4 | // Modified: Michael Werski (Since 2014) 5 | // Modified: Katja Blankenheim (Since 2014) 6 | // Modified: Mag Gyver (Since 2016) 7 | // Modified: Dulgheru Mihaita (Since 2022) 8 | 9 | // Last modified: 05.05.2022 10 | 11 | #ifndef KnxTelegram_h 12 | #define KnxTelegram_h 13 | 14 | #include "Arduino.h" 15 | 16 | #define MAX_KNX_TELEGRAM_SIZE 23 17 | #define KNX_TELEGRAM_HEADER_SIZE 6 18 | 19 | // KNX priorities 20 | enum KnxPriorityType { 21 | KNX_PRIORITY_SYSTEM = B00, 22 | KNX_PRIORITY_ALARM = B10, 23 | KNX_PRIORITY_HIGH = B01, 24 | KNX_PRIORITY_NORMAL = B11 25 | }; 26 | 27 | // KNX commands / APCI Coding 28 | enum KnxCommandType { 29 | KNX_COMMAND_READ = B0000, 30 | KNX_COMMAND_WRITE = B0010, 31 | KNX_COMMAND_ANSWER = B0001, 32 | KNX_COMMAND_INDIVIDUAL_ADDR_WRITE = B0011, 33 | KNX_COMMAND_INDIVIDUAL_ADDR_REQUEST = B0100, 34 | KNX_COMMAND_INDIVIDUAL_ADDR_RESPONSE = B0101, 35 | KNX_COMMAND_MASK_VERSION_READ = B1100, 36 | KNX_COMMAND_MASK_VERSION_RESPONSE = B1101, 37 | KNX_COMMAND_RESTART = B1110, 38 | KNX_COMMAND_ESCAPE = B1111 39 | }; 40 | 41 | // Extended (escaped) KNX commands 42 | enum KnxExtendedCommandType { 43 | KNX_EXT_COMMAND_AUTH_REQUEST = B010001, 44 | KNX_EXT_COMMAND_AUTH_RESPONSE = B010010 45 | }; 46 | 47 | // KNX Transport Layer Communication Type 48 | enum KnxCommunicationType { 49 | KNX_COMM_UDP = B00, // Unnumbered Data Packet 50 | KNX_COMM_NDP = B01, // Numbered Data Packet 51 | KNX_COMM_UCD = B10, // Unnumbered Control Data 52 | KNX_COMM_NCD = B11 // Numbered Control Data 53 | }; 54 | 55 | // KNX Control Data (for UCD / NCD packets) 56 | enum KnxControlDataType { 57 | KNX_CONTROLDATA_CONNECT = B00, // UCD 58 | KNX_CONTROLDATA_DISCONNECT = B01, // UCD 59 | KNX_CONTROLDATA_POS_CONFIRM = B10, // NCD 60 | KNX_CONTROLDATA_NEG_CONFIRM = B11 // NCD 61 | }; 62 | 63 | class KnxTelegram { 64 | public: 65 | KnxTelegram(); 66 | 67 | void clear(); 68 | void set_buffer_byte(int index, int content); 69 | int get_buffer_byte(int index); 70 | void set_payload_length(int size); 71 | int get_payload_length(); 72 | void set_repeated(bool repeat); 73 | bool is_repeated(); 74 | void set_priority(KnxPriorityType prio); 75 | KnxPriorityType get_priority(); 76 | void set_source_address(int area, int line, int member); 77 | int get_source_area(); 78 | int get_source_line(); 79 | int get_source_member(); 80 | void set_target_group_address(int main, int middle, int sub); 81 | void set_target_individual_address(int area, int line, int member); 82 | bool is_target_group(); 83 | String get_target_group(); 84 | int get_target_main_group(); 85 | int get_target_middle_group(); 86 | int get_target_sub_group(); 87 | int get_target_area(); 88 | int get_target_line(); 89 | int get_target_member(); 90 | void set_routing_counter(int counter); 91 | int get_routing_counter(); 92 | void set_command(KnxCommandType command); 93 | KnxCommandType get_command(); 94 | 95 | void set_first_data_byte(int data); 96 | int get_first_data_byte(); 97 | bool get_bool(); 98 | 99 | int get_4bit_int_value(); 100 | bool get_4bit_direction_value(); 101 | byte get_4bit_steps_value(); 102 | 103 | void set_1byte_int_value(int value); 104 | int get_1byte_int_value(); 105 | 106 | void set_2byte_int_value(int value); 107 | int get_2byte_int_value(); 108 | void set_2byte_float_value(float value); 109 | float get_2byte_float_value(); 110 | 111 | void set_3byte_time(int weekday, int hour, int minute, int second); 112 | int get_3byte_weekday_value(); 113 | int get_3byte_hour_value(); 114 | int get_3byte_minute_value(); 115 | int get_3byte_second_value(); 116 | void set_3byte_date(int day, int month, int year); 117 | int get_3byte_day_value(); 118 | int get_3byte_month_value(); 119 | int get_3byte_year_value(); 120 | 121 | void set_4byte_float_value(float value); 122 | float get_4byte_float_value(); 123 | 124 | void set_14byte_value(String value); 125 | String get_14byte_value(); 126 | 127 | void create_checksum(); 128 | bool verify_checksum(); 129 | int get_checksum(); 130 | void print(); 131 | int get_total_length(); 132 | KnxCommunicationType get_communication_type(); 133 | void set_communication_type(KnxCommunicationType); 134 | int get_sequence_number(); 135 | void set_sequence_number(int); 136 | KnxControlDataType get_control_data(); 137 | void set_control_data(KnxControlDataType); 138 | 139 | private: 140 | int buffer[MAX_KNX_TELEGRAM_SIZE]; 141 | int calculate_checksum(); 142 | 143 | }; 144 | 145 | #endif --------------------------------------------------------------------------------