├── .gitignore ├── LICENSE ├── README.md ├── VERSION ├── generate_img.sh ├── update_script ├── xml-api └── xmlapi ├── DEVDB.tcl ├── cgi.tcl ├── checkuptodate.cgi ├── common.tcl ├── devicelist.cgi ├── devicetypelist.cgi ├── exec.cgi ├── favoritelist.cgi ├── functionlist.cgi ├── index.cgi ├── mastervalue.cgi ├── mastervaluechange.cgi ├── once.tcl ├── programactions.cgi ├── programlist.cgi ├── protocol.cgi ├── roomlist.cgi ├── rssilist.cgi ├── runprogram.cgi ├── scripterrors.cgi ├── session.tcl ├── state.cgi ├── statechange.cgi ├── statelist.cgi ├── systemNotification.cgi ├── systemNotificationClear.cgi ├── sysvar.cgi ├── sysvarlist.cgi ├── tokenlist.cgi ├── tokenregister.cgi ├── tokenrevoke.cgi ├── update-check.cgi ├── update.cgi ├── version.cgi └── xml.tcl /.gitignore: -------------------------------------------------------------------------------- 1 | /*.tar.gz 2 | /*.img 3 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | # XML-API CCU Addon 2 | 3 | [![Release](https://img.shields.io/github/release/homematic-community/XML-API.svg)](https://github.com/homematic-community/XML-API/releases/latest) 4 | [![Downloads](https://img.shields.io/github/downloads/homematic-community/XML-API/latest/total.svg)](https://github.com/homematic-community/XML-API/releases/latest) 5 | [![Issues](https://img.shields.io/github/issues/homematic-community/XML-API.svg)](https://github.com/homematic-community/XML-API/issues) 6 | [![License](https://img.shields.io/badge/license-GPL%203.0-green.svg)](https://opensource.org/licenses/GPL-3.0) 7 | 8 | A HomeMatic CCU Addon implementing a xml request functionality as an interface to all homematic deviced available to a CCU device. This addon provides useful scripts that can be accessed via a HTTP request to a CCU device and allows to query and set all e.g. room- and devicetype names. 9 | 10 | ## Supported CCU models 11 | * [HomeMatic CCU3](https://www.eq-3.de/produkte/homematic/zentralen-und-gateways/smart-home-zentrale-ccu3.html) / [RaspberryMatic](https://raspberrymatic.de/) 12 | * [HomeMatic CCU2](https://www.eq-3.de/produkt-detail-zentralen-und-gateways/items/homematic-zentrale-ccu-2.html) 13 | * HomeMatic CCU1 14 | 15 | ## Installation 16 | This addon can be added like a usual CCU addon package via the WebUI provided functionality by selecting "System-Konfiguration » Systemsteuerung » Zusatzsoftware", to upload the addon package as a tar.gz and the use »Installieren« to actually install the addon. After a restart of the CCU the xml-api interface can then be selected from the »Zusatzsoftware« tab in the CCU settings. 17 | 18 | ## Use 19 | After installation the XML-API should be avilable via the following URL call: 20 | ``` 21 | https://[CCU_IP]/addons/xmlapi/[ScriptName]?sid=[TOKEN_ID] 22 | ``` 23 | where [TOKEN_ID] corresponds to a stateless token-based authentication id a user can register using the `tokenregister.cgi` script listed below. In addition, [CCU_IP] corresponds to the IP address or hostname of your CCU device and [ScriptName] being one of the following scripts: 24 | 25 | | ScriptName | Description / Parameters 26 | | ----------------------------- |------------------------- 27 | | `checkuptodate.cgi` | ??? 28 | | `devicelist.cgi`             | Lists all devices with channels. Contain names, serial number, device type and ids.
`device_id=list` - returns values of specified devices (e.g. "1234,5678") (optional)
`show_internal=0/1` - adds internal channels also (default=0)
`show_remote=0/1` - adds output of virtual remote channels (default=0) 29 | | `devicetypelist.cgi` | Lists all possible device types with their possible meta data. 30 | | `exec.cgi` | Allows to execute arbitrary ReGaHss script commands (as POST data). 31 | | `favoritelist.cgi`           | Lists all favorites and users.
`show_datapoint=0/1` - outputs datapoint_id and datapoint_type also (default=0)
`show_internal=0/1` - adds internal channels also (default=0) 32 | | `functionlist.cgi`           | Lists all functions including channels. 33 | | `mastervalue.cgi`             | Outputs a single or several '1234,5678' devices with their names and master values.
`device_id=list` - returns master values of specified devices (e.g. "1234,5678")
`requested_names=list` - returns only master values of selected types (e.g. "TEMPERATURE_COMFORT,TEMPERATURE_LOWERING") 34 | | `mastervaluechange.cgi`       | Sets one or more master values for a list of devices.
`device_id=list` - sets master values of specified devices (e.g. "1234,5678")
`name=list` - sets only master values of selected types (e.g. "TEMPERATURE_LOWERING,TEMPERATURE_COMFORT")
`value=list` - sets master values to specified values (e.g. "17.0,22.5") 35 | | `programactions.cgi` | Allows to change active and visible program options.
`program_id=int` - id of program to modify (e.g. "1234")
`active=true/false` - sets active status of program to true/false
`visible=true/false` - sets visible status of program to true/false 36 | | `programlist.cgi`             | Lists all programs. 37 | | `protocol.cgi`               | Outputs the system protocol.
`start=int` - start of the protocol
`show=int` - number of entries to output
`clear=0/1` - allows to clear the system protocol 38 | | `roomlist.cgi`               | Lists all configured rooms including channels. 39 | | `rssilist.cgi` | Lists RSSI values of all RF devices. 40 | | `runprogram.cgi`             | Starts a program with the specified id.
`program_id=int` - id of program to modify (e.g. "1234")
`cond_check=0/1` - execute program with normal condition checks or not (only first "then" is executed) (default=0) 41 | | `scripterrors.cgi`           | Searches for the last 10 lines in `/var/log/messages` containing script runtime errors and outputs them. 42 | | `state.cgi`                   | Outputs one or more devices with their channels and current values.
`device_id=list` - returns values of specified devices (e.g. "1234,5678")
`channel_id=list` - returns values of specified channels (e.g. "1234,5678")
`datapoint_id=list` - returns Value() for datapoint with id (e.g. "1234,5678") 43 | | `statechange.cgi`             | Allows to change the state of one or more devices.
`ise_id=list` - selects the devices with the specified ids (e.g. "1234,5678")
`new_value=list` - new values for device states (e.g. "0.20,1.45") 44 | | `statelist.cgi`               | Outputs all devices with channels and their current values.
`ise_id=int` - output only channels and values of device with specified id (e.g. "1234")
`show_internal=0/1` - adds internal channels also (default=0)
`show_remote=0/1` - adds output of virtual remote channels (default=0) 45 | | `systemNotification.cgi`     | Outputs the currently existing system notifications. 46 | | `systemNotificationClear.cgi` | Clears the current active system notifications (if not sticky). 47 | | `sysvar.cgi`                 | Outputs a single system variable with its corresponding values.
`ise_id=int` - the id of the system variable to output (e.g. "1234")
`text=true/false` - outputs or suppressed the text for string variables (default=true) 48 | | `sysvarlist.cgi`             | Outputs all system variables with their corresponding values.
`text=true/false` - outputs or suppressed the text for string variables (default=false) 49 | | `tokenlist.cgi` | Lists all registered security access tokens. 50 | | `tokenregister.cgi` | Registers a new security access token.
`desc=string` - description for new token id 51 | | `tokenrevoke.cgi` | Revokes an existing security access token.
`sid=string` - security access token id 52 | | `update.cgi` | ????
`checkupdate=list` - ???
`maxdurchlaeufe=int` - ??? (default=7) 53 | | `version.cgi` | Outputs version of XML-API. 54 | 55 | All of these scripts, in addition to the listed parameters require a security access token id to be specified via a mandatory `?sid=[TOKEN_ID]` URL parameter with an adequate token ID specified. Such a security token can be generated using `tokenregister.cgi` from within the standard CCU addon webui page (`Settings -> Control panel -> Additional software -> XML-API -> Set`) or by using an already registered security token. Furthermore, already registered tokens can be listed via `tokenlist.cgi` and revoked via `tokenrevoke.cgi` with the token id supplied. 56 | 57 | If a script will be correctly called, it generates a xml structured output that can then be used by third-party applications to display or modify certain information. 58 | 59 | In addition many of these scripts rely on additional URL parameter to be specifeid (e.g. `ise_id` device or channel identifier). And example of such script executing URL can be seen here: 60 | ``` 61 | https:///addons/xmlapi/statechange.cgi?sid=[TOKEN_ID]&ise_id=12345&new_value=0.20 62 | ``` 63 | This call, if executed with a registered [TOKEN_ID] and the right ise_id and IP address would then e.g. set a dimmer to 20%. 64 | 65 | ## Support 66 | https://homematic-forum.de/forum/viewtopic.php?f=26&t=10098&p=75959#p75959 67 | 68 | ## Authors 69 | * jens-maus, Maik (Monty1979), Philipp (ultrah), hobbyquaker, dirch, Uwe (uwe111) 70 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 2.3 2 | -------------------------------------------------------------------------------- /generate_img.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | mkdir -p tmp/xmlapi 3 | cp -a xmlapi/* tmp/xmlapi 4 | cp update_script tmp/ 5 | cp xml-api tmp/ 6 | cp VERSION tmp/ 7 | cd tmp 8 | tar --owner=root --group=root --exclude=.DS_Store -czvf ../xmlapi_addon-$(cat ../VERSION).tar.gz * 9 | cd .. 10 | rm -rf tmp 11 | -------------------------------------------------------------------------------- /update_script: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | ADDON_DIR=/usr/local/etc/config/addons/www/xmlapi 4 | RCD_DIR=/usr/local/etc/config/rc.d 5 | CONFIG_DIR=/usr/local/etc/config/addons/xmlapi 6 | 7 | # check for unsupported platforms 8 | if grep -qim1 busmatic /www/api/methods/ccu/downloadFirmware.tcl; then 9 | exit 13 10 | fi 11 | 12 | if [ "$1" = "" ]; then 13 | echo "CCU1" 14 | lcdtool "installing XML-API " 15 | mount -t yaffs /dev/mtdblock3 /usr/local 16 | elif [ "$1" = "CCU2" ]; then 17 | echo "CCU2" 18 | mount -t ubifs ubi1:user /usr/local 19 | elif [ "$1" = "HM-RASPBERRYMATIC" ]; then 20 | echo "HM-RASPBERRYMATIC" 21 | mount /usr/local 22 | fi 23 | 24 | mkdir -p $ADDON_DIR 25 | chmod 755 $ADDON_DIR 26 | mkdir -p $RCD_DIR 27 | chmod 755 $RCD_DIR 28 | mkdir -p $CONFIG_DIR 29 | chmod 755 $CONFIG_DIR 30 | 31 | # remove old stuff 32 | rm -f $ADDON_DIR/* 33 | 34 | # copy all stuff and setup rc.d 35 | cp -R xmlapi/* $ADDON_DIR/ 36 | cp VERSION $ADDON_DIR/ 37 | cp xml-api $RCD_DIR/ 38 | chmod +x $RCD_DIR/xml-api 39 | 40 | # sync filesystem to make sure all changes are written to disk 41 | sync 42 | 43 | if [ "$1" = "" ]; then 44 | echo "CCU1" 45 | lcdtool "Reboot... " 46 | lcdtool -a 0x40 -t bin 00 47 | echo "x" > /dev/watchdog 48 | reboot 49 | while true ; do true ; done 50 | elif [ "$1" = "CCU2" ]; then 51 | echo "CCU2" 52 | # CCU2 always reboots after Addon/Firmware Update 53 | elif [ "$1" = "HM-RASPBERRYMATIC" ]; then 54 | echo "HM-RASPBERRYMATIC" 55 | # RASPBERRYMATIC always reboots after Addon/Firmware Update 56 | fi 57 | -------------------------------------------------------------------------------- /xml-api: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | WWW_DIR=/etc/config/addons/www/xmlapi 4 | CONFIG_URL=/addons/xmlapi/ 5 | 6 | # check for unsupported platforms 7 | if grep -qim1 busmatic /www/api/methods/ccu/downloadFirmware.tcl; then 8 | exit 13 9 | fi 10 | 11 | case "$1" in 12 | ""|start) 13 | if [ ! -e /www/config/xmlapi ]; then 14 | mount -o remount,rw / 15 | ln -s $WWW_DIR /www/config/xmlapi 16 | mount -o remount,ro / 17 | fi 18 | ;; 19 | info) 20 | VER=`cat ${WWW_DIR}/VERSION` 21 | echo "Info: XML-API CCU Addon
" 22 | echo "Info: https://github.com/homematic-community/XML-API" 23 | echo "Version: $(cat ${WWW_DIR}/VERSION)" 24 | echo "Name: XML-API" 25 | echo "Operations: uninstall" 26 | echo "Config-Url: ${CONFIG_URL}" 27 | echo "Update: ${CONFIG_URL}/update-check.cgi" 28 | ;; 29 | uninstall) 30 | if [ -e /www/config/xmlapi ]; then 31 | mount -o remount,rw / 32 | rm -f /www/config/xmlapi 33 | mount -o remount,ro / 34 | fi 35 | rm -rf $WWW_DIR 36 | ;; 37 | esac 38 | -------------------------------------------------------------------------------- /xmlapi/DEVDB.tcl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/homematic-community/XML-API/d13c53f7850388bcffc5e3bc26f3f6145ef96be3/xmlapi/DEVDB.tcl -------------------------------------------------------------------------------- /xmlapi/cgi.tcl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/homematic-community/XML-API/d13c53f7850388bcffc5e3bc26f3f6145ef96be3/xmlapi/cgi.tcl -------------------------------------------------------------------------------- /xmlapi/checkuptodate.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set SysVarId 0 11 | set SysVarCount 0 12 | set SysVarLastupdate 0 13 | set DeviceId 0 14 | set DeviceCount 0 15 | set DeviceTypeCount 0 16 | catch { 17 | set input $env(QUERY_STRING) 18 | set pairs [split $input &] 19 | foreach pair $pairs { 20 | if {0 != [regexp "^SysVarId=(.*)$" $pair dummy val]} { 21 | set SysVarId $val 22 | continue 23 | } 24 | if {0 != [regexp "^SysVarCount=(.*)$" $pair dummy val]} { 25 | set SysVarCount $val 26 | continue 27 | } 28 | if {0 != [regexp "^SysVarLastupdate=(.*)$" $pair dummy val]} { 29 | set SysVarLastupdate $val 30 | continue 31 | } 32 | if {0 != [regexp "^DeviceId=(.*)$" $pair dummy val]} { 33 | set DeviceId $val 34 | continue 35 | } 36 | if {0 != [regexp "^DeviceCount=(.*)$" $pair dummy val]} { 37 | set DeviceCount $val 38 | continue 39 | } 40 | if {0 != [regexp "^DeviceTypeCount=(.*)$" $pair dummy val]} { 41 | set DeviceTypeCount $val 42 | continue 43 | } 44 | } 45 | } 46 | 47 | set script "string DeviceId=\"$DeviceId\";\nstring DeviceCount=\"$DeviceCount\";\n" 48 | append script "string SysVarId=\"$SysVarId\";\nstring SysVarCount=\"$SysVarCount\";\n" 49 | append script "string SysVarLastupdate=\"$SysVarLastupdate\";\nstring DeviceTypeCount=\"$DeviceTypeCount\";\n" 50 | 51 | append script { 52 | 53 | string sDeviceId; 54 | string sSysVarId; 55 | 56 | boolean refreshDevices = false; 57 | boolean refreshSysVars = false; 58 | 59 | if ( (DeviceId.ToInteger() == 0) || (DeviceCount.ToInteger() == 0) ) { 60 | refreshDevices = true; 61 | } else { 62 | if((DeviceCount.ToInteger()+3) != dom.GetObject(ID_DEVICES).Count().ToInteger()) { 63 | refreshDevices = true; 64 | } else { 65 | foreach (sDeviceId, dom.GetObject(ID_DEVICES).EnumUsedIDs()) { 66 | if(sDeviceId.ToInteger() > DeviceId.ToInteger()) { refreshDevices = true; } 67 | } 68 | } 69 | } 70 | 71 | if ( (SysVarId.ToInteger() == 0) || (SysVarCount.ToInteger() == 0) || (SysVarLastupdate.ToInteger() == 0) ) { 72 | refreshSysVars = true; 73 | } else { 74 | if((SysVarCount.ToInteger()+2) != dom.GetObject(ID_SYSTEM_VARIABLES).Count().ToInteger()) { 75 | refreshSysVars = true; 76 | } else { 77 | foreach (sSysVarId, dom.GetObject(ID_SYSTEM_VARIABLES).EnumUsedIDs()) { 78 | if(sSysVarId.ToInteger() > SysVarId.ToInteger()) { refreshSysVars = true; } 79 | if(dom.GetObject(sSysVarId).Timestamp().ToInteger() > SysVarLastupdate.ToInteger()) { refreshSysVars = true; } 80 | } 81 | } 82 | } 83 | if( refreshDevices ) { Write(""); } 84 | if( refreshSysVars ) { Write(""); } 85 | if( DeviceTypeCount < 20 ) { Write(""); } 86 | } 87 | 88 | array set res [rega_script $script] 89 | 90 | if { $res(STDOUT) != "" } { 91 | puts -nonewline $res(STDOUT) 92 | puts -nonewline {} 93 | } 94 | } else { 95 | puts -nonewline {} 96 | } 97 | puts "" 98 | -------------------------------------------------------------------------------- /xmlapi/common.tcl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/homematic-community/XML-API/d13c53f7850388bcffc5e3bc26f3f6145ef96be3/xmlapi/common.tcl -------------------------------------------------------------------------------- /xmlapi/devicelist.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set show_internal 0 11 | set show_remote 0 12 | set device_id 0 13 | catch { 14 | set input $env(QUERY_STRING) 15 | set pairs [split $input &] 16 | foreach pair $pairs { 17 | if {0 != [regexp "^show_internal=(.*)$" $pair dummy val]} { 18 | set show_internal $val 19 | continue 20 | } 21 | if {0 != [regexp "^show_remote=(.*)$" $pair dummy val]} { 22 | set show_remote $val 23 | continue 24 | } 25 | if {0 != [regexp "^device_id=(.*)$" $pair dummy val]} { 26 | set device_id $val 27 | continue 28 | } 29 | } 30 | } 31 | 32 | array set res [rega_script { 33 | 34 | integer show_internal = "} $show_internal {"; 35 | integer show_remote = "} $show_remote {"; 36 | string device_id = "} $device_id {"; 37 | 38 | integer DIR_SENDER = 1; 39 | integer DIR_RECEIVER = 2; 40 | ! string TYPE_VIRTUAL = "29"; 41 | string PARTNER_INVALID = "65535"; 42 | 43 | string sDevIdList; 44 | string sDevId; 45 | string sChnId; 46 | string sDPId; 47 | 48 | if( (device_id == 0) ) { 49 | sDevIdList = root.Devices().EnumUsedIDs(); 50 | } else { 51 | sDevIdList = device_id.Split(","); 52 | } 53 | 54 | foreach (sDevId, sDevIdList) 55 | { 56 | object oDevice = dom.GetObject(sDevId); 57 | integer iDevInterfaceId = oDevice.Interface(); 58 | object oDeviceInterface = dom.GetObject(iDevInterfaceId); 59 | 60 | boolean bDevReady = oDevice.ReadyConfig(); 61 | boolean isRemote = ( ("HMW-RCV-50" == oDevice.HssType()) || ("HM-RCV-50" == oDevice.HssType()) || ("HmIP-RCV-50" == oDevice.HssType()) ); 62 | 63 | if( (oDeviceInterface) && (true == bDevReady) && ( ( isRemote == false ) || ( show_remote == 1 ) ) ) 64 | { 65 | string sDevInterface = oDeviceInterface.Name(); 66 | string sDevType = oDevice.HssType(); 67 | 68 | Write(""); 76 | 77 | foreach(sChnId, oDevice.Channels()) 78 | { 79 | object oChannel = dom.GetObject(sChnId); 80 | 81 | boolean show = false; 82 | 83 | if (false == oChannel.Internal() ) { 84 | show = true; 85 | } 86 | 87 | if ( show_internal == 1){ 88 | show = true; 89 | } 90 | 91 | if (show == true){ 92 | integer iChnDir = oChannel.ChnDirection(); 93 | string sChnDir = "UNKNOWN"; 94 | if (DIR_SENDER == iChnDir) { sChnDir = "SENDER"; } 95 | if (DIR_RECEIVER == iChnDir) { sChnDir = "RECEIVER"; } 96 | string sChnPartnerId = oChannel.ChnGroupPartnerId(); 97 | if (PARTNER_INVALID == sChnPartnerId) { sChnPartnerId = ""; } 98 | boolean bChnAESAvailable = false; 99 | if (0 != oChannel.ChnAESOperation()) { bChnAESAvailable = true; } 100 | string sChnMode = "DEFAULT"; 101 | if (true == oChannel.ChnAESActive()) { sChnMode = "AES"; } 102 | 103 | ! boolean bChnReady = oChannel.ReadyConfig(); 104 | ! integer iChnLinkCount = oChannel.ChnLinkCount(); 105 | ! integer iChnProgramCount = oChannel.DPUsageCount(); 106 | ! if (ID_ERROR == iChnProgramCount) { iChnProgramCount = 0; } 107 | ! boolean bChnVirtual = false; 108 | ! if (TYPE_VIRTUAL == sChnType) { bChnVirtual = true; } 109 | ! boolean bChnReadable = false; 110 | ! boolean bChnWritable = false; 111 | ! boolean bChnEventable = false; 112 | ! foreach (sDPId, oChannel.DPs()) 113 | ! { 114 | ! object oDP = dom.GetObject(sDPId); 115 | ! if (false == oDP.Internal()) 116 | ! { 117 | ! integer iDPOperations = oDP.Operations(); 118 | ! if (OPERATION_READ & iDPOperations) { bChnReadable = true; } 119 | ! if (OPERATION_WRITE & iDPOperations) { bChnWritable = true; } 120 | ! if (OPERATION_EVENT & iDPOperations) { bChnEventable = true; } 121 | ! } 122 | ! } 123 | ! 124 | Write(""); 162 | } 163 | } 164 | 165 | Write(""); 166 | } 167 | } 168 | }] 169 | 170 | if { $res(STDOUT) != "" } { 171 | puts -nonewline $res(STDOUT) 172 | } 173 | } else { 174 | puts -nonewline {} 175 | } 176 | puts "" 177 | -------------------------------------------------------------------------------- /xmlapi/devicetypelist.cgi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/homematic-community/XML-API/d13c53f7850388bcffc5e3bc26f3f6145ef96be3/xmlapi/devicetypelist.cgi -------------------------------------------------------------------------------- /xmlapi/exec.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | 3 | source session.tcl 4 | 5 | proc toString { str } { 6 | set map { 7 | "\"" "\\\"" 8 | "\\" "\\\\" 9 | "\{" "\\\{" 10 | "\[" "\\\[" 11 | "/" "\\/" 12 | "\b" "\\b" 13 | "\f" "\\f" 14 | "\n" "\\n" 15 | "\r" "\\r" 16 | "\t" "\\t" 17 | "\ä" "\\ä" 18 | "\Ä" "\\Ä" 19 | "\ö" "\\ö" 20 | "\Ö" "\\Ö" 21 | "\ü" "\\ü" 22 | "\Ü" "\\Ü" 23 | } 24 | return "\"[string map $map $str]\"" 25 | } 26 | 27 | puts "Content-Type: text/plain; charset=iso-8859-1" 28 | puts "" 29 | 30 | if {[info exists sid] && [check_session $sid]} { 31 | if { [catch { 32 | set content [read stdin] 33 | array set script_result [rega_script $content] 34 | 35 | set first 1 36 | set result "\{\n" 37 | foreach name [array names script_result] { 38 | if { 1 != $first } { 39 | append result ",\n" 40 | } 41 | set first 0 42 | set value $script_result($name) 43 | append result " [toString $name]: [toString $value]" 44 | } 45 | append result "\n\}" 46 | 47 | puts $result 48 | 49 | } errorMessage] } { 50 | puts $errorMessage 51 | } 52 | } else { 53 | puts "{error: not authenticated}" 54 | } 55 | -------------------------------------------------------------------------------- /xmlapi/favoritelist.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set show_datapoint 0 11 | set show_internal 0 12 | catch { 13 | set input $env(QUERY_STRING) 14 | set pairs [split $input &] 15 | foreach pair $pairs { 16 | if {0 != [regexp "^show_datapoint=(.*)$" $pair dummy val]} { 17 | set show_datapoint $val 18 | continue 19 | } 20 | if {0 != [regexp "^show_internal=(.*)$" $pair dummy val]} { 21 | set show_internal $val 22 | continue 23 | } 24 | } 25 | } 26 | 27 | set hm_script "var show_datapoint=$show_datapoint;\n" 28 | append hm_script "var show_internal=$show_internal;\n" 29 | 30 | append hm_script { 31 | 32 | object oFavorite; 33 | string sFavoriteId; 34 | string sFavoriteName; 35 | string sChannelId; 36 | 37 | foreach (sFavoriteId, dom.GetObject(ID_FAVORITES).EnumUsedIDs()) { 38 | oFavorite = dom.GetObject(sFavoriteId); 39 | 40 | Write(""); 42 | 43 | foreach(sChannelId, oFavorite.EnumUsedIDs()) { 44 | object fav = dom.GetObject(sChannelId); 45 | Write(""); 65 | if (favType == "CHANNEL") { 66 | string sDPId; 67 | foreach (sDPId, fav.DPs().EnumUsedIDs()) { 68 | object oDP = dom.GetObject(sDPId); 69 | if (oDP) { 70 | string dp = oDP.Name().StrValueByIndex(".", 2); 71 | 72 | if ((dp != "ON_TIME") && (dp != "INHIBIT")) { 73 | Write(""); 85 | } 86 | } 87 | } 88 | 89 | 90 | } 91 | 92 | if (favType == "SYSVAR") { 93 | Write(""); 122 | } 123 | Write(""); 124 | } else { 125 | Write ("'/>"); 126 | } 127 | } 128 | Write(""); 129 | } 130 | } 131 | 132 | array set res [rega_script "$hm_script"] 133 | 134 | if { $res(STDOUT) != "" } { 135 | puts -nonewline $res(STDOUT) 136 | } 137 | } else { 138 | puts -nonewline {} 139 | } 140 | puts "" 141 | -------------------------------------------------------------------------------- /xmlapi/functionlist.cgi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/homematic-community/XML-API/d13c53f7850388bcffc5e3bc26f3f6145ef96be3/xmlapi/functionlist.cgi -------------------------------------------------------------------------------- /xmlapi/index.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/html; charset=iso-8859-1" 5 | puts "" 6 | puts "" 7 | puts "" 8 | puts "" 9 | puts "XML-API" 10 | puts "" 11 | puts "" 16 | puts "" 17 | puts "" 18 | 19 | if {[info exists sid] && [check_session $sid]} { 20 | puts "" 21 | 22 | set filename "/www/addons/xmlapi/VERSION" 23 | set fd [open $filename r] 24 | set version "" 25 | if { $fd >=0 } { 26 | gets $fd version 27 | close $fd 28 | } 29 | 30 | puts [subst { 31 | 32 | 33 | 39 | 42 | 45 | 50 | 53 | 58 | 64 | 70 | 73 | 79 | 82 | 85 | 90 | 93 | 99 | 104 | 110 | 113 | 116 | 121 | 125 | 128 | 132 | 135 | 140 | 142 | }] 143 | } else { 144 | puts "not authenticated" 145 | } 146 | puts "" 147 | puts "" 148 | -------------------------------------------------------------------------------- /xmlapi/mastervalue.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | load tclrpc.so 3 | source session.tcl 4 | source common.tcl 5 | 6 | puts "Content-Type: text/xml; charset=iso-8859-1" 7 | puts "" 8 | puts -nonewline "" 9 | 10 | if {[info exists sid] && [check_session $sid]} { 11 | 12 | set device_id "" 13 | set requested_names "" 14 | catch { 15 | set input $env(QUERY_STRING) 16 | set pairs [split $input &] 17 | foreach pair $pairs { 18 | if {0 != [regexp "^device_id=(.*)$" $pair dummy val]} { 19 | set device_id $val 20 | continue 21 | } 22 | if {0 != [regexp "^requested_names=(.*)$" $pair dummy val]} { 23 | set requested_names $val 24 | continue 25 | } 26 | } 27 | } 28 | 29 | read_interfaces 30 | 31 | set devids [split $device_id ,] 32 | if { $requested_names == "" } { 33 | set allMasterValues "*" 34 | } else { 35 | set allMasterValues "" 36 | set requestedNames [split $requested_names ,] 37 | } 38 | 39 | foreach devid $devids { 40 | array set values [rega_script { 41 | integer iseId = "} $devid {"; 42 | var oDevice = dom.GetObject(iseId); 43 | var address = oDevice.Address(); 44 | integer ifId = oDevice.Interface(); 45 | object oDeviceInterface = dom.GetObject(ifId); 46 | if(oDeviceInterface) 47 | { 48 | string deviceInterface = oDeviceInterface.Name(); 49 | var deviceType = oDevice.HssType(); 50 | Write(""); 59 | } 60 | }] 61 | set deviceAddress $values(address) 62 | set deviceType $values(deviceType) 63 | set deviceInterface $values(deviceInterface) 64 | 65 | puts -nonewline $values(STDOUT) 66 | 67 | # simple check against unknown device id 68 | if { $deviceType == "null" } { 69 | puts -nonewline {DEVICE NOT FOUND} 72 | } else { 73 | # initialize variable, could fail in catch block below 74 | set channel "" 75 | if {[string compare -nocase -length 4 "HmIP" "$deviceInterface"] == 0 || 76 | [string compare -nocase -length 4 "HmIP" "$deviceType"] == 0 } { 77 | # HmIP requires to add :0 to deviceAddress 78 | set channel ":0" 79 | } 80 | 81 | # call xmlrpc to get the MASTER paramset 82 | set ausgabe "" 83 | catch {set ausgabe [xmlrpc $interfaces($deviceInterface) getParamset [list string "$deviceAddress$channel"] [list string "MASTER"] ] } 84 | 85 | foreach { bezeichnung wert } $ausgabe { 86 | if { ($allMasterValues == "*" || [lsearch $requestedNames $bezeichnung] >= 0) } { 87 | puts -nonewline {} 92 | } 93 | } 94 | 95 | puts -nonewline {} 96 | } 97 | } 98 | } else { 99 | puts -nonewline {} 100 | } 101 | puts "" 102 | -------------------------------------------------------------------------------- /xmlapi/mastervaluechange.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | load tclrpc.so 3 | source session.tcl 4 | source common.tcl 5 | 6 | puts "Content-Type: text/xml; charset=iso-8859-1" 7 | puts "" 8 | puts -nonewline "" 9 | 10 | if {[info exists sid] && [check_session $sid]} { 11 | 12 | set device_id "" 13 | set name "" 14 | set value "" 15 | catch { 16 | set input $env(QUERY_STRING) 17 | set pairs [split $input &] 18 | foreach pair $pairs { 19 | if {0 != [regexp "^device_id=(.*)$" $pair dummy val]} { 20 | set device_id $val 21 | continue 22 | } 23 | if {0 != [regexp "^name=(.*)$" $pair dummy val]} { 24 | set name $val 25 | continue 26 | } 27 | if {0 != [regexp "^value=(.*)$" $pair dummy val]} { 28 | set value $val 29 | continue 30 | } 31 | } 32 | } 33 | 34 | read_interfaces 35 | 36 | set rec_devids [split $device_id "\,"] 37 | set rec_mvaluename [split $name "\,"] 38 | set rec_mvaluevalue [split $value "\,"] 39 | 40 | for {set counter 0} {$counter<[llength $rec_devids]} {incr counter} { 41 | set devid [lindex $rec_devids $counter] 42 | 43 | set item [lindex $rec_mvaluename $counter] 44 | set val [lindex $rec_mvaluevalue $counter] 45 | set cmd "{$item {string $val}}" 46 | 47 | array set values [rega_script { 48 | integer iseId = "} $devid {"; 49 | var oDevice = dom.GetObject(iseId); 50 | var address = oDevice.Address(); 51 | integer ifId = oDevice.Interface(); 52 | object oDeviceInterface = dom.GetObject(ifId); 53 | if(oDeviceInterface) 54 | { 55 | string deviceInterface = oDeviceInterface.Name(); 56 | var deviceType = oDevice.HssType(); 57 | Write(""); 66 | } 67 | }] 68 | set deviceAddress $values(address) 69 | set deviceType $values(deviceType) 70 | set deviceInterface $values(deviceInterface) 71 | 72 | puts -nonewline $values(STDOUT) 73 | 74 | # simple check against unknown device id 75 | if { $deviceType == "null" } { 76 | puts -nonewline {DEVICE NOT FOUND} 79 | } else { 80 | # initialize variable, could fail in catch block below 81 | set channel "" 82 | if {[string compare -nocase -length 4 "HmIP" "$deviceInterface"] == 0 || 83 | [string compare -nocase -length 4 "HmIP" "$deviceType"] == 0 } { 84 | # HmIP requires to add :0 to deviceAddress 85 | set channel ":0" 86 | } 87 | 88 | # call xmlrpc to set the MASTER paramset 89 | set ausgabe "" 90 | catch {set ausgabe [xmlrpc $interfaces($deviceInterface) putParamset [list string "$deviceAddress$channel"] [list string "MASTER"] [list struct $cmd] ] } 91 | 92 | puts -nonewline {} 97 | puts -nonewline {} 98 | } 99 | } 100 | } else { 101 | puts -nonewline {} 102 | } 103 | puts "" 104 | -------------------------------------------------------------------------------- /xmlapi/once.tcl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/homematic-community/XML-API/d13c53f7850388bcffc5e3bc26f3f6145ef96be3/xmlapi/once.tcl -------------------------------------------------------------------------------- /xmlapi/programactions.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set program_id "-1" 11 | set active "" 12 | set visible "" 13 | catch { 14 | set input $env(QUERY_STRING) 15 | set pairs [split $input &] 16 | foreach pair $pairs { 17 | if {0 != [regexp "^program_id=(.*)$" $pair dummy val]} { 18 | set program_id $val 19 | continue 20 | } 21 | if {0 != [regexp "^active=(.*)$" $pair dummy val]} { 22 | set active $val 23 | continue 24 | } 25 | if {0 != [regexp "^visible=(.*)$" $pair dummy val]} { 26 | set visible $val 27 | continue 28 | } 29 | } 30 | } 31 | 32 | array set res [rega_script { 33 | integer prgId = } $program_id {; 34 | string active = "} $active {"; 35 | string visible = "} $visible {"; 36 | if (prgId > 0) { 37 | object obj = dom.GetObject(prgId); 38 | if (obj && obj.IsTypeOf(OT_PROGRAM)) { 39 | if ((active == "false") || (active == "true")){ 40 | obj.Active(active == "true"); 41 | } 42 | if ((visible == "false") || (visible == "true")){ 43 | obj.Visible(visible == "true"); 44 | } 45 | Write(obj); 46 | } 47 | } 48 | }] 49 | 50 | if { $res(STDOUT) != "" } { 51 | puts -nonewline "" 52 | } else { 53 | puts -nonewline {} 54 | } 55 | } else { 56 | puts -nonewline {} 57 | } 58 | puts "" 59 | -------------------------------------------------------------------------------- /xmlapi/programlist.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | array set res [rega_script { 11 | 12 | string sProgramId; 13 | object oProgram; 14 | foreach (sProgramId, dom.GetObject(ID_PROGRAMS).EnumUsedIDs()) 15 | { 16 | oProgram = dom.GetObject(sProgramId); 17 | if(oProgram != null) 18 | { 19 | Write(""); 37 | } 38 | } 39 | 40 | }] 41 | 42 | if { $res(STDOUT) != "" } { 43 | puts -nonewline $res(STDOUT) 44 | } 45 | } else { 46 | puts -nonewline {} 47 | } 48 | puts "" 49 | -------------------------------------------------------------------------------- /xmlapi/protocol.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set start "0" 11 | set show "0" 12 | set clear "0" 13 | catch { 14 | set input $env(QUERY_STRING) 15 | set pairs [split $input &] 16 | foreach pair $pairs { 17 | if {0 != [regexp "^start=(.*)$" $pair dummy val]} { 18 | set start $val 19 | continue 20 | } 21 | if {0 != [regexp "^show=(.*)$" $pair dummy val]} { 22 | set show $val 23 | continue 24 | } 25 | if {0 != [regexp "^clear=(.*)$" $pair dummy val]} { 26 | set clear $val 27 | continue 28 | } 29 | } 30 | } 31 | 32 | set hm_script { 33 | integer iLastGroupIndex = 1; 34 | string sCollectedNames = ""; 35 | string sCollectedValues = ""; 36 | string sCollectedDateTimes = ""; 37 | string sCollectedTimestamp = ""; 38 | string s; 39 | integer iStart = } 40 | 41 | append hm_script $start 42 | 43 | append hm_script {; 44 | integer iCount = } 45 | 46 | append hm_script $show 47 | 48 | append hm_script {; 49 | integer eCount = dom.GetHistoryDataCount(); 50 | integer clear = } 51 | 52 | append hm_script $clear 53 | 54 | append hm_script {; 55 | integer rCount; 56 | if (iCount == "0") { 57 | iCount = eCount; 58 | } 59 | Write(""); 64 | } 65 | 66 | append hm_script { 67 | 68 | if (clear == "1") { 69 | var clearHistory = dom.ClearHistoryData(); 70 | WriteLine(""); 71 | } else { 72 | 73 | foreach( s, dom.GetHistoryData( iStart, iCount, &rCount ) ) 74 | { 75 | integer iGroupIndex = s.StrValueByIndex(";",0).ToInteger(); 76 | string sDatapointId = s.StrValueByIndex(";",1); 77 | string sRecordedValue = s.StrValueByIndex(";",2); 78 | string sDateTime = s.StrValueByIndex(";",3); 79 | string sTimestamp = s.StrValueByIndex(";",3).ToTime().ToInteger(); 80 | string sDatapointName = ""; 81 | object oHistDP = dom.GetObject( sDatapointId ); 82 | if( oHistDP ) 83 | { 84 | object oDP = dom.GetObject( oHistDP.ArchiveDP() ); 85 | if( oDP ) 86 | { 87 | sDatapointName = oDP.Name(); 88 | boolean bSysVar = (oDP.IsTypeOf(OT_VARDP) || oDP.IsTypeOf(OT_ALARMDP)); 89 | if( !bSysVar ) 90 | { 91 | object oCH = dom.GetObject( oDP.Channel() ); 92 | if( oCH ) 93 | { 94 | sDatapointName = oCH.Name(); 95 | } 96 | } 97 | 98 | if( iLastGroupIndex != iGroupIndex ) 99 | { 100 | Write(""); 106 | sCollectedNames = ""; 107 | sCollectedValues = ""; 108 | iLastGroupIndex = iGroupIndex; 109 | } 110 | 111 | string id = oDP.ID(); 112 | string sRet = ""; 113 | string sValue = sRecordedValue; 114 | Call("/esp/functions.fn::WriteDPText()"); 115 | sRecordedValue = system.GetVar("sRet"); 116 | 117 | sCollectedNames = sDatapointName; 118 | sCollectedDateTimes = sDateTime; 119 | sCollectedTimestamp = sTimestamp; 120 | 121 | if( !sCollectedValues.Length() ) 122 | { 123 | sCollectedValues = sRecordedValue; 124 | } 125 | else 126 | { 127 | sCollectedValues = sCollectedValues#", "#sRecordedValue; 128 | } 129 | 130 | } 131 | } 132 | 133 | } 134 | if( sCollectedValues.Length() ) 135 | { 136 | Write(""); 142 | } 143 | } 144 | } 145 | 146 | array set res [rega_script $hm_script] 147 | 148 | if { $res(STDOUT) != "" } { 149 | puts -nonewline $res(STDOUT) 150 | } 151 | } else { 152 | puts -nonewline {} 153 | } 154 | puts "" 155 | -------------------------------------------------------------------------------- /xmlapi/roomlist.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | array set res [rega_script { 10 | 11 | object oRoom; 12 | string sRoomId; 13 | string sRoomName; 14 | string sChannelId; 15 | 16 | foreach (sRoomId, dom.GetObject(ID_ROOMS).EnumUsedIDs()) 17 | { 18 | oRoom = dom.GetObject(sRoomId); 19 | 20 | Write(""); 22 | 23 | foreach(sChannelId, oRoom.EnumUsedIDs()) 24 | { 25 | Write(""); 26 | } 27 | 28 | Write(""); 29 | } 30 | 31 | }] 32 | 33 | if { $res(STDOUT) != "" } { 34 | puts -nonewline $res(STDOUT) 35 | } 36 | } else { 37 | puts -nonewline {} 38 | } 39 | puts "" 40 | -------------------------------------------------------------------------------- /xmlapi/rssilist.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | # !***************************************************************************** 3 | # !* rssilist.cgi 4 | # !* Signalqualitaet aller funk komponenten 5 | # !* Autor: Dirk Szymanski 6 | # !***************************************************************************** 7 | source session.tcl 8 | 9 | puts "Content-Type: text/xml; charset=iso-8859-1" 10 | puts "" 11 | puts -nonewline "" 12 | 13 | if {[info exists sid] && [check_session $sid]} { 14 | 15 | load tclrpc.so 16 | source common.tcl 17 | 18 | set RSSI_BAD -120.0 19 | set RSSI_MEDIUM -100.0 20 | set RSSI_GOOD -20.0 21 | 22 | read_interfaces 23 | 24 | set url $interfaces(BidCos-RF) 25 | 26 | if { [ catch { 27 | #check if the interface supports rssi 28 | #failure of this call will throw us out of here 29 | xmlrpc $url system.methodHelp rssiInfo 30 | } ] } { continue } 31 | 32 | array_clear rssi_map 33 | set rssi_list [xmlrpc $url rssiInfo ] 34 | array set rssi_map $rssi_list 35 | 36 | foreach dev [lsort [array names rssi_map]] { 37 | puts -nonewline "" 38 | } 39 | 40 | } else { 41 | puts -nonewline {} 42 | } 43 | puts "" 44 | -------------------------------------------------------------------------------- /xmlapi/runprogram.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set program_id "-1" 11 | set cond_check 0 12 | catch { 13 | set input $env(QUERY_STRING) 14 | set pairs [split $input &] 15 | foreach pair $pairs { 16 | if {0 != [regexp "^program_id=(.*)$" $pair dummy val]} { 17 | set program_id $val 18 | continue 19 | } 20 | if {0 != [regexp "^cond_check=(.*)$" $pair dummy val]} { 21 | set cond_check $val 22 | continue 23 | } 24 | } 25 | } 26 | 27 | # execut with condition check or without 28 | if { $cond_check == 1 } { 29 | array set res [rega_script "if ($program_id > 0) { object obj = dom.GetObject($program_id); if (obj && obj.IsTypeOf(OT_PROGRAM)) { obj.State(1); Write(obj); }}"] 30 | } else { 31 | array set res [rega_script "if ($program_id > 0) { object obj = dom.GetObject($program_id); if (obj && obj.IsTypeOf(OT_PROGRAM)) { obj.ProgramExecute(); Write(obj); }}"] 32 | } 33 | 34 | if { $res(STDOUT) != "" } { 35 | puts -nonewline "" 36 | } else { 37 | puts -nonewline {} 38 | } 39 | } else { 40 | puts -nonewline {} 41 | } 42 | puts "" 43 | -------------------------------------------------------------------------------- /xmlapi/scripterrors.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | # Sucht in den letzten 10 Zeilen von /var/log/messages nach Homematic-Script Fehlermeldungen 3 | # 11'2012 - hobbyquaker https://github.com/hobbyquaker 4 | source session.tcl 5 | 6 | puts "Content-Type: text/xml; charset=iso-8859-1" 7 | puts "" 8 | puts -nonewline "" 9 | 10 | if {[info exists sid] && [check_session $sid]} { 11 | 12 | set Datei [open "|/usr/bin/tail -n 10 /var/log/messages" r] 13 | while {[gets $Datei Zeile] >= 0} { 14 | if { [regexp Error.*near $Zeile] } { 15 | regexp {([a-zA-Z]+ [0-9]+ [0-9\:]+) .+ local0.err ReGaHss: ERROR: SyntaxError\: Error ([0-9]+) at row ([0-9]+) col ([0-9]+)} $Zeile line time code row col 16 | puts -nonewline "" 22 | } 23 | } 24 | } else { 25 | puts -nonewline {} 26 | } 27 | puts "" 28 | -------------------------------------------------------------------------------- /xmlapi/session.tcl: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | load tclrega.so 3 | 4 | catch { 5 | set raddr $env(REMOTE_ADDR) 6 | set input $env(QUERY_STRING) 7 | set pairs [split $input &] 8 | set sid "" 9 | foreach pair $pairs { 10 | if {0 != [regexp "^sid=(.*)$" $pair dummy val]} { 11 | set sid $val 12 | break 13 | } 14 | } 15 | } 16 | 17 | proc get_tokens {} { 18 | set filename "/etc/config/addons/xmlapi/token.list" 19 | 20 | array set tokens {} 21 | if {! [catch {set fd [open $filename r] } errmsg]} { 22 | array set tokens [read $fd] 23 | close $fd 24 | } 25 | 26 | return [array get tokens] 27 | } 28 | 29 | proc save_tokens tokenlist { 30 | set filename "/etc/config/addons/xmlapi/token.list" 31 | 32 | array set tokens $tokenlist 33 | if {! [catch {set fd [open $filename w] } errmsg]} { 34 | puts $fd [array get tokens] 35 | close $fd 36 | } 37 | } 38 | 39 | proc register_token descr { 40 | # get tokens 41 | array set tokens [get_tokens] 42 | 43 | # function to generate a random string of 16 characters 44 | # cf. https://wiki.tcl-lang.org/page/Generating+random+strings 45 | set newToken [subst [string repeat {[format %c [expr {int(rand() * 26) + (rand() > .5 ? 97 : 65)}]]} 16]] 46 | 47 | # add token to array 48 | set tokens($newToken) $descr 49 | 50 | # save tokens 51 | save_tokens [array get tokens] 52 | 53 | return $newToken 54 | } 55 | 56 | proc revoke_token tid { 57 | # get tokens 58 | array set tokens [get_tokens] 59 | 60 | if {[info exists tokens($tid)]} { 61 | # remove token from array 62 | unset tokens($tid) 63 | 64 | # write out new token list 65 | save_tokens [array get tokens] 66 | return 1 67 | } 68 | 69 | return 0 70 | } 71 | 72 | proc check_session session_id { 73 | global raddr 74 | # check for api tokens first and then check 75 | # for webui session ids as well as a fallback 76 | if {[regexp {^([0-9a-zA-Z]{16})$} $session_id all sidnr]} { 77 | # get tokens 78 | array set tokens [get_tokens] 79 | 80 | # check if sid exists in token array 81 | if {[info exists tokens($session_id)]} { 82 | return 1 83 | } 84 | } elseif {[regexp {^@([0-9a-zA-Z]{10})@$} $session_id all sidnr]} { 85 | set res [lindex [rega_script "Write(system.GetSessionVarStr('$sidnr'));"] 1] 86 | if {$res != ""} { 87 | return 1 88 | } 89 | } elseif {$raddr == "127.0.0.1"} { 90 | # allow all xmlapi requests from localhost without 91 | # any sid 92 | return 1 93 | } 94 | return 0 95 | } 96 | -------------------------------------------------------------------------------- /xmlapi/state.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set device_id "" 11 | set channel_id "" 12 | set datapoint_id "" 13 | catch { 14 | set input $env(QUERY_STRING) 15 | set pairs [split $input &] 16 | foreach pair $pairs { 17 | if {0 != [regexp "^device_id=(.*)$" $pair dummy val]} { 18 | set device_id $val 19 | continue 20 | } 21 | if {0 != [regexp "^channel_id=(.*)$" $pair dummy val]} { 22 | set channel_id $val 23 | continue 24 | } 25 | if {0 != [regexp "^datapoint_id=(.*)$" $pair dummy val]} { 26 | set datapoint_id $val 27 | continue 28 | } 29 | } 30 | } 31 | 32 | array set res [rega_script { 33 | 34 | string sDevIds = "} $device_id {"; 35 | string sChannelIds = "} $channel_id {"; 36 | string sDatapointIds = "} $datapoint_id {"; 37 | string sChnId; 38 | string sDPId; 39 | 40 | if (sDatapointIds.Length() > 0 ) { 41 | 42 | string sDatapointId; 43 | foreach(sDatapointId, sDatapointIds.Split(",")) { 44 | 45 | object oDatapoint = dom.GetObject(sDatapointId); 46 | if (oDatapoint.IsTypeOf(OT_DP)) { 47 | Write(""); 52 | } 53 | } 54 | 55 | } else { 56 | 57 | if (sChannelIds.Length() > 0 ) { 58 | 59 | string sChannelId; 60 | foreach(sChannelId, sChannelIds.Split(",")) { 61 | object oChannel2 = dom.GetObject(sChannelId); 62 | 63 | if (sDevIds.Length() > 0 ) { 64 | sDevIds = sDevIds # "," # oChannel2.Device().ToString(); 65 | } else { 66 | sDevIds = oChannel2.Device().ToString(); 67 | } 68 | } 69 | } 70 | 71 | string sDevId; 72 | foreach(sDevId, sDevIds.Split(",")) { 73 | 74 | object oDevice = dom.GetObject(sDevId); 75 | integer iDevInterfaceId = oDevice.Interface(); 76 | object oDeviceInterface = dom.GetObject(iDevInterfaceId); 77 | 78 | if( (oDeviceInterface) && (oDevice.ReadyConfig()) && (oDevice.Name() != "Zentrale") && (oDevice.Name() != "HMW-RCV-50 BidCoS-Wir") && (oDevice.IsTypeOf(OT_DEVICE)) ) { 79 | Write(""); ! device tag schliessen 92 | 93 | foreach(sChnId, oDevice.Channels()) { 94 | object oChannel = dom.GetObject(sChnId); 95 | if ((!oChannel.Internal()) || oChannel.Internal()) { 96 | 97 | Write(""); 102 | 103 | 104 | foreach(sDPId, oChannel.DPs().EnumUsedIDs()) { 105 | object oDP = dom.GetObject(sDPId); 106 | if(oDP) { 107 | string dp = oDP.Name().StrValueByIndex(".", 2); 108 | 109 | if( (dp != "ON_TIME") && (dp != "INHIBIT") && (dp != "CMD_RETS") && (dp != "CMD_RETL") && (dp != "CMD_SETS") && (dp != "CMD_SETL") ) { 110 | Write(""); 123 | } 124 | } 125 | } 126 | Write(""); 127 | } 128 | } 129 | Write(""); 130 | } 131 | } 132 | } 133 | }] 134 | 135 | if { $res(STDOUT) != "" } { 136 | puts -nonewline $res(STDOUT) 137 | } 138 | } else { 139 | puts -nonewline {} 140 | } 141 | puts "" 142 | -------------------------------------------------------------------------------- /xmlapi/statechange.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set ise_id "" 11 | set new_value "" 12 | catch { 13 | set input $env(QUERY_STRING) 14 | set pairs [split $input &] 15 | foreach pair $pairs { 16 | if {0 != [regexp "^ise_id=(.*)$" $pair dummy val]} { 17 | set ise_id $val 18 | continue 19 | } 20 | if {0 != [regexp "^new_value=(.*)$" $pair dummy val]} { 21 | set new_value $val 22 | continue 23 | } 24 | } 25 | } 26 | 27 | regsub -all {%20} $new_value { } new_value 28 | regsub -all {%21} $new_value {!} new_value 29 | regsub -all {%23} $new_value {#} new_value 30 | regsub -all {%25} $new_value {%} new_value 31 | regsub -all {%2A} $new_value * new_value 32 | regsub -all {%2F} $new_value {/} new_value 33 | regsub -all {%3C} $new_value {<} new_value 34 | regsub -all {%3E} $new_value {>} new_value 35 | regsub -all {%3F} $new_value {?} new_value 36 | regsub -all {%5E} $new_value {^} new_value 37 | regsub -all {%3D} $new_value {=} new_value 38 | regsub -all {%2C} $new_value {,} new_value 39 | 40 | if { [string match "rgb*" $new_value ] || [string match "*=*" $new_value ] } { 41 | array set res [rega_script "Write(dom.GetObject($ise_id).State('$new_value'));"] 42 | 43 | if {$res(STDOUT) != "null"} { 44 | if {$res(STDOUT) == "true"} { 45 | set success "true" 46 | } else { 47 | set success "false" 48 | } 49 | puts -nonewline ""; 50 | } else { 51 | puts -nonewline ""; 52 | } 53 | 54 | } else { 55 | 56 | set rec_ise_id [split $ise_id "\,"] 57 | 58 | # only split new_value in case we have more ise_id 59 | if { [llength $rec_ise_id] > 1 } { 60 | set rec_new_value [split $new_value "\,"] 61 | } else { 62 | set rec_new_value [list $new_value] 63 | } 64 | 65 | for {set x 0} {$x<[llength $rec_ise_id]} {incr x} { 66 | 67 | array set res [rega_script "Write(dom.GetObject([lindex $rec_ise_id $x]).State('[lindex $rec_new_value $x]'));"] 68 | 69 | if {$res(STDOUT) != "null"} { 70 | if {$res(STDOUT) == "true"} { 71 | set success "true" 72 | } else { 73 | set success "false" 74 | } 75 | puts -nonewline ""; 76 | } else { 77 | puts -nonewline ""; 78 | } 79 | } 80 | } 81 | } else { 82 | puts -nonewline {} 83 | } 84 | puts "" 85 | -------------------------------------------------------------------------------- /xmlapi/statelist.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set ise_id 0 11 | set show_internal 0 12 | set show_remote 0 13 | catch { 14 | set input $env(QUERY_STRING) 15 | set pairs [split $input &] 16 | foreach pair $pairs { 17 | if {0 != [regexp "^ise_id=(.*)$" $pair dummy val]} { 18 | set ise_id $val 19 | continue 20 | } 21 | if {0 != [regexp "^show_internal=(.*)$" $pair dummy val]} { 22 | set show_internal $val 23 | continue 24 | } 25 | if {0 != [regexp "^show_remote=(.*)$" $pair dummy val]} { 26 | set show_remote $val 27 | continue 28 | } 29 | } 30 | } 31 | 32 | set comm "var ise_id=$ise_id;\n" 33 | append comm "var show_internal=$show_internal;\n" 34 | append comm "var show_remote=$show_remote;\n" 35 | 36 | if { $ise_id != 0 } then { 37 | 38 | append comm { 39 | object obj = dom.GetObject(ise_id); 40 | if(obj.TypeName() == "HSSDP") 41 | { 42 | object oDP = obj; 43 | string dp = oDP.Name().StrValueByIndex(".", 2); 44 | 45 | Write(""); 58 | } 59 | } 60 | 61 | } else { 62 | 63 | append comm { 64 | 65 | string sDevId; 66 | string sChnId; 67 | string sDPId; 68 | 69 | foreach (sDevId, root.Devices().EnumUsedIDs()) 70 | { 71 | object oDevice = dom.GetObject(sDevId); 72 | integer iDevInterfaceId = oDevice.Interface(); 73 | object oDeviceInterface = dom.GetObject(iDevInterfaceId); 74 | 75 | boolean isRemote = ( ("HMW-RCV-50" == oDevice.HssType()) || ("HM-RCV-50" == oDevice.HssType()) || ("HmIP-RCV-50" == oDevice.HssType()) ); 76 | 77 | if( ( oDeviceInterface ) && ( oDevice.ReadyConfig() ) && ( ( isRemote == false ) || ( show_remote == 1 ) ) ) 78 | { 79 | Write(""); ! device tag schliessen 92 | 93 | foreach(sChnId, oDevice.Channels()) 94 | { 95 | object oChannel = dom.GetObject(sChnId); 96 | if ( (! oChannel.Internal()) || oChannel.Internal() ) 97 | { 98 | Write(""); 120 | 121 | foreach(sDPId, oChannel.DPs().EnumUsedIDs()) 122 | { 123 | object oDP = dom.GetObject(sDPId); 124 | if(oDP) 125 | { 126 | string dp = oDP.Name().StrValueByIndex(".", 2); 127 | 128 | if( (dp != "ON_TIME") && (dp != "INHIBIT") && (dp != "CMD_RETS") && (dp != "CMD_RETL") && (dp != "CMD_SETS") && (dp != "CMD_SETL") ) 129 | { 130 | Write(""); 147 | } 148 | } 149 | } 150 | Write(""); 151 | } 152 | } 153 | Write(""); 154 | } 155 | } 156 | } 157 | 158 | array set res [rega_script $comm] 159 | 160 | if { $res(STDOUT) != "" } { 161 | puts -nonewline $res(STDOUT) 162 | } 163 | } 164 | } else { 165 | puts -nonewline {} 166 | } 167 | puts "" 168 | -------------------------------------------------------------------------------- /xmlapi/systemNotification.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set hm_script { 11 | object oTmpArray = dom.GetObject(ID_SERVICES); 12 | 13 | if( oTmpArray ) { 14 | string sTmp; 15 | 16 | foreach(sTmp, oTmpArray.EnumIDs()){ 17 | 18 | object oTmp = dom.GetObject( sTmp ); 19 | 20 | if( oTmp ){ 21 | if( oTmp.IsTypeOf( OT_ALARMDP ) && ( oTmp.AlState() == asOncoming ) ){ 22 | 23 | var trigDP = dom.GetObject(oTmp.AlTriggerDP()); 24 | if( trigDP ) { 25 | Write(""); 35 | } 36 | } 37 | } 38 | } 39 | } 40 | } 41 | 42 | array set res [rega_script $hm_script] 43 | 44 | if { $res(STDOUT) != "" } { 45 | puts -nonewline $res(STDOUT) 46 | } 47 | } else { 48 | puts -nonewline {} 49 | } 50 | puts "" 51 | -------------------------------------------------------------------------------- /xmlapi/systemNotificationClear.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set hm_script { 11 | string itemID; 12 | string address; 13 | object aldp_obj; 14 | 15 | foreach(itemID, dom.GetObject(ID_DEVICES).EnumUsedIDs()) { 16 | address = dom.GetObject(itemID).Address(); 17 | aldp_obj = dom.GetObject("AL-" # address # ":0.STICKY_UNREACH"); 18 | if (aldp_obj) { 19 | if (aldp_obj.Value()) { 20 | aldp_obj.AlReceipt(); 21 | } 22 | } 23 | } 24 | } 25 | 26 | array set res [rega_script $hm_script] 27 | 28 | if { $res(STDOUT) != "" } { 29 | puts -nonewline $res(STDOUT) 30 | } 31 | } else { 32 | puts -nonewline {} 33 | } 34 | puts "" 35 | -------------------------------------------------------------------------------- /xmlapi/sysvar.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set text "true" 11 | set ise_id "-1" 12 | catch { 13 | set input $env(QUERY_STRING) 14 | set pairs [split $input &] 15 | foreach pair $pairs { 16 | if {0 != [regexp "^text=(.*)$" $pair dummy val]} { 17 | set text $val 18 | continue 19 | } 20 | if {0 != [regexp "^ise_id=(.*)$" $pair dummy val]} { 21 | set ise_id $val 22 | continue 23 | } 24 | } 25 | } 26 | 27 | set hm_script { 28 | object oSysVar; 29 | string sSysVarId; 30 | string sShowText= 31 | } 32 | 33 | append hm_script $text 34 | 35 | append hm_script {; 36 | string iSysVarId=} 37 | 38 | append hm_script $ise_id 39 | 40 | append hm_script {; 41 | 42 | foreach (sSysVarId, dom.GetObject(ID_SYSTEM_VARIABLES).EnumUsedIDs()){ 43 | 44 | oSysVar = dom.GetObject(sSysVarId); 45 | 46 | if (oSysVar.ID() == iSysVarId) { 47 | 48 | Write(""); 83 | } 84 | } 85 | } 86 | 87 | array set res [rega_script $hm_script] 88 | 89 | if { $res(STDOUT) != "" } { 90 | puts -nonewline $res(STDOUT) 91 | } 92 | } else { 93 | puts -nonewline {} 94 | } 95 | puts "" 96 | -------------------------------------------------------------------------------- /xmlapi/sysvarlist.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set text "false" 11 | catch { 12 | set input $env(QUERY_STRING) 13 | set pairs [split $input &] 14 | foreach pair $pairs { 15 | if {0 != [regexp "^text=(.*)$" $pair dummy val]} { 16 | set text $val 17 | continue 18 | } 19 | } 20 | } 21 | 22 | set hm_script { 23 | object oSysVar; 24 | string sSysVarId; 25 | string sShowText= 26 | } 27 | 28 | append hm_script $text 29 | 30 | append hm_script {; 31 | 32 | foreach (sSysVarId, dom.GetObject(ID_SYSTEM_VARIABLES).EnumUsedIDs()) { 33 | oSysVar = dom.GetObject(sSysVarId); 34 | Write(""); 75 | } 76 | 77 | } 78 | 79 | array set res [rega_script $hm_script] 80 | 81 | if { $res(STDOUT) != "" } { 82 | puts -nonewline $res(STDOUT) 83 | } 84 | } else { 85 | puts -nonewline {} 86 | } 87 | puts "" 88 | -------------------------------------------------------------------------------- /xmlapi/tokenlist.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | # 3 | # script to list all currently registred API tokens 4 | # 5 | # parameters: none 6 | # return: list of currently active API tokens 7 | # 8 | 9 | source session.tcl 10 | 11 | puts "Content-Type: text/xml; charset=iso-8859-1" 12 | puts "" 13 | puts -nonewline "" 14 | 15 | if {[info exists sid] && [check_session $sid]} { 16 | 17 | # get tokens 18 | array set tokens [get_tokens] 19 | 20 | foreach {token desc} [array get tokens] { 21 | puts "$token" 22 | } 23 | 24 | } else { 25 | puts -nonewline {} 26 | } 27 | puts "" 28 | -------------------------------------------------------------------------------- /xmlapi/tokenregister.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set desc "" 11 | set ise_id "-1" 12 | catch { 13 | set input $env(QUERY_STRING) 14 | set pairs [split $input &] 15 | foreach pair $pairs { 16 | if {0 != [regexp "^desc=(.*)$" $pair dummy val]} { 17 | set desc $val 18 | 19 | # replace URL encoded parts 20 | regsub -all {%20} $desc { } desc 21 | regsub -all {%21} $desc {!} desc 22 | regsub -all {%23} $desc {#} desc 23 | regsub -all {%25} $desc {%} desc 24 | regsub -all {%25} $desc {%} desc 25 | regsub -all {%2A} $desc * desc 26 | regsub -all {%2F} $desc {/} desc 27 | regsub -all {%3F} $desc {?} desc 28 | regsub -all {%5E} $desc {^} desc 29 | regsub -all {%3D} $desc {=} desc 30 | regsub -all {%2C} $desc {,} desc 31 | 32 | # disable certain invalid chars 33 | regsub -all {%3C} $desc {_} desc 34 | regsub -all {<} $desc {_} desc 35 | regsub -all {%3E} $desc {_} desc 36 | regsub -all {>} $desc {_} desc 37 | regsub -all {%27} $desc {_} desc 38 | regsub -all {'} $desc {_} desc 39 | break 40 | } 41 | } 42 | } 43 | 44 | set newToken [register_token $desc] 45 | if { $newToken != "" } { 46 | puts "$newToken" 47 | } else { 48 | puts "" 49 | } 50 | 51 | } else { 52 | puts -nonewline {} 53 | } 54 | puts "" 55 | -------------------------------------------------------------------------------- /xmlapi/tokenrevoke.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set result [revoke_token $sid] 11 | if { $result == 1 } { 12 | puts "" 13 | } else { 14 | puts "" 15 | } 16 | 17 | } else { 18 | puts -nonewline {} 19 | } 20 | puts "" 21 | -------------------------------------------------------------------------------- /xmlapi/update-check.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | 3 | set checkURL "https://raw.githubusercontent.com/homematic-community/XML-API/master/VERSION" 4 | set downloadURL "https://github.com/homematic-community/XML-API/releases" 5 | 6 | catch { 7 | set input $env(QUERY_STRING) 8 | set pairs [split $input &] 9 | foreach pair $pairs { 10 | if {$pair == "cmd=download"} { 11 | set cmd "download" 12 | break 13 | } 14 | } 15 | } 16 | 17 | if { [info exists cmd ] && $cmd == "download"} { 18 | puts -nonewline "Content-Type: text/html; charset=utf-8\r\n\r\n" 19 | puts -nonewline "" 20 | } else { 21 | puts -nonewline "Content-Type: text/plain; charset=utf-8\r\n\r\n" 22 | catch { 23 | set newversion [ exec /usr/bin/wget -qO- --no-check-certificate $checkURL ] 24 | } 25 | if { [info exists newversion] } { 26 | puts $newversion 27 | } else { 28 | puts "n/a" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /xmlapi/update.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | source session.tcl 3 | 4 | puts "Content-Type: text/xml; charset=iso-8859-1" 5 | puts "" 6 | puts -nonewline "" 7 | 8 | if {[info exists sid] && [check_session $sid]} { 9 | 10 | set checkupdate "" 11 | set maxdurchlaeufe 7 12 | catch { 13 | set input $env(QUERY_STRING) 14 | set pairs [split $input &] 15 | foreach pair $pairs { 16 | if {0 != [regexp "^checkupdate=(.*)$" $pair dummy val]} { 17 | set checkupdate $val 18 | continue 19 | } 20 | if {0 != [regexp "^maxdurchlaeufe=(.*)$" $pair dummy val]} { 21 | set maxdurchlaeufe $val 22 | continue 23 | } 24 | } 25 | } 26 | 27 | catch { 28 | set idlist [split [string trim $checkupdate] ";"] 29 | set resultids "" 30 | set zaehler 0 31 | while { ([llength $resultids] < 1) && ($zaehler < $maxdurchlaeufe) } { 32 | foreach pair $idlist { 33 | if {$pair != {} } then { 34 | set vp [split $pair "="] 35 | 36 | set id [lindex $vp 0] 37 | set timestamp [lindex $vp 1] 38 | 39 | set res [rega "dom.GetObject($id).Timestamp().ToInteger();"] 40 | 41 | if { $res == $timestamp } { 42 | continue 43 | } 44 | 45 | # unterschiedlich, also id merken 46 | array set res_arr [rega_script "object o=dom.GetObject($id);\nvar value=o.Value();\nvar lastupdate=o.Timestamp().ToInteger();\nvar type=o.TypeName();"] 47 | # puts -nonewline $res_arr(STDOUT) 48 | puts -nonewline "" 49 | lappend resultids $id 50 | } 51 | } 52 | if { [llength $resultids] < 1 } { 53 | after 500 54 | incr zaehler 55 | } 56 | } 57 | } 58 | } else { 59 | puts -nonewline {} 60 | } 61 | puts "" 62 | 63 | 64 | -------------------------------------------------------------------------------- /xmlapi/version.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/tclsh 2 | set filename "/www/addons/xmlapi/VERSION" 3 | set fd [open $filename r] 4 | set version "" 5 | if { $fd >=0 } { 6 | gets $fd version 7 | close $fd 8 | } 9 | 10 | puts "Content-Type: text/xml; charset=iso-8859-1" 11 | puts "" 12 | puts -nonewline "" 13 | 14 | puts -nonewline $version 15 | 16 | puts "" 17 | -------------------------------------------------------------------------------- /xmlapi/xml.tcl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/homematic-community/XML-API/d13c53f7850388bcffc5e3bc26f3f6145ef96be3/xmlapi/xml.tcl --------------------------------------------------------------------------------
XML-API $version
checkuptodate.cgi????
devicelist.cgiLists all devices with channels. Contain names, serial number, device type and ids.
34 | sid=string - security access token id
35 | device_id=list - returns values of specified devices (e.g. "1234,5678") (optional)
36 | show_internal=0/1 - adds internal channels also (default=0)
37 | show_remote=0/1 - adds output of virtual remote channels (default=0) 38 |
devicetypelist.cgiLists all possible device types with their possible meta data.
40 | sid=string - security access token id
41 |
exec.cgiAllows to execute arbitrary ReGaHss script commands (as POST data).
43 | sid=string - security access token id
44 |
favoritelist.cgiLists all favorites and users.
46 | sid=string - security access token id
47 | show_datapoint=0/1 - outputs datapoint_id and datapoint_type also (default=0)
48 | show_internal=0/1 - adds internal channels also (default=0) 49 |
functionlist.cgiLists all functions including channels.
51 | sid=string - security access token id
52 |
mastervalue.cgiOutputs a single or several '1234,5678' devices with their names and master values.
54 | sid=string - security access token id
55 | device_id=list - returns master values of specified devices (e.g. "1234,5678")
56 | requested_names=list - returns only master values of selected types (e.g. "TEMPERATURE_COMFORT,TEMPERATURE_LOWERING") 57 |
mastervaluechange.cgiSets one or more master values for a list of devices.
59 | sid=string - security access token id
60 | device_id=list - sets master values of specified devices (e.g. "1234,5678")
61 | name=list - sets only master values of selected types (e.g. "TEMPERATURE_LOWERING,TEMPERATURE_COMFORT")
62 | value=list - sets master values to specified values (e.g. "17.0,22.5") 63 |
programactions.cgiAllows to change active and visible program options.
65 | sid=string - security access token id
66 | program_id=int - id of program to modify (e.g. "1234")
67 | active=true/false - sets active status of program to true/false
68 | visible=true/false - sets visible status of program to true/false 69 |
programlist.cgiLists all programs.
71 | sid=string - security access token id
72 |
protocol.cgiOutputs the system protocol.
74 | sid=string - security access token id
75 | start=int - start of the protocol
76 | show=int - number of entries to output
77 | clear=0/1 - allows to clear the system protocol 78 |
roomlist.cgiLists all configured rooms including channels.
80 | sid=string - security access token id
81 |
rssilist.cgiLists RSSI values of all RF devices.
83 | sid=string - security access token id
84 |
runprogram.cgiStarts a program with the specified id.
86 | sid=string - security access token id
87 | program_id=int - id of program to modify (e.g. "1234")
88 | cond_check=0/1 - execute program with normal condition checks or not (only first "then" is executed) (default=0) 89 |
scripterrors.cgiSearches for the last 10 lines in /var/log/messages containing script runtime errors and outputs them.
91 | sid=string - security access token id
92 |
state.cgiOutputs one or more devices with their channels and current values.
94 | sid=string - security access token id
95 | device_id=list - returns values of specified devices (e.g. "1234,5678")
96 | channel_id=list - returns values of specified channels (e.g. "1234,5678")
97 | datapoint_id=list - returns Value() for datapoint with id (e.g. "1234,5678") 98 |
statechange.cgiAllows to change the state of one or more devices.
100 | sid=string - security access token id
101 | ise_id=list - selects the devices with the specified ids (e.g. "1234,5678")
102 | new_value=list - new values for device states (e.g. "0.20,1.45") 103 |
statelist.cgiOutputs all devices with channels and their current values.
105 | sid=string - security access token id
106 | ise_id=int - output only channels and values of device with specified id (e.g. "1234")
107 | show_internal=0/1 - adds internal channels also (default=0)
108 | show_remote=0/1 - adds output of virtual remote channels (default=0) 109 |
systemNotification.cgiOutputs the currently existing system notifications.
111 | sid=string - security access token id
112 |
systemNotificationClear.cgiClears the current active system notifications (if not sticky).
114 | sid=string - security access token id
115 |
sysvar.cgiOutputs a single system variable with its corresponding values.
117 | sid=string - security access token id
118 | ise_id=int - the id of the system variable to output (e.g. "1234")
119 | text=true/false - outputs or suppressed the text for string variables (default=true)
120 |
sysvarlist.cgiOutputs all system variables with their corresponding values.
122 | sid=string - security access token id
123 | text=true/false - outputs or suppressed the text for string variables (default=false)
124 |
tokenlist.cgiLists all registered security access tokens
126 | sid=string - security access token id
127 |
tokenregister.cgiRegisters a new security access token
129 | sid=string - security access token id
130 | desc=string - description for new token id
131 |
tokenrevoke.cgiRevokes an existing security access token
133 | sid=string - security access token id
134 |
update.cgi???
136 | sid=string - security access token id
137 | checkupdate=list - ???
138 | maxdurchlaeufe=int - ??? (default=7)
139 |
version.cgiOutputs version of XML-API.
141 |