├── .gitignore ├── .vscode └── settings.json ├── LICENSE ├── README.md ├── homescript └── __init__.py ├── homescript_apps ├── hs-blink │ ├── README.md │ ├── blink.py │ └── blink.service ├── hs-tplink │ ├── hs110_state.py │ └── tplink.py └── hs-xiaomi │ ├── temp_hum.py │ └── xiaomi.py ├── hs.py ├── pyvenv.cfg └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | HS_DeploymentHandler.sh 3 | node_modules 4 | homescript_exception* 5 | homescript_debug* 6 | acc* 7 | debug* 8 | bin 9 | include 10 | lib 11 | __pycache__ 12 | *.egg-info 13 | dist 14 | build -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "python.pythonPath": "bin/python3.9" 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 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # HomeScript 2 | [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/menahishayan) 3 | 4 | Python script for command line control of [HomeBridge](https://github.com/nfarina/homebridge) (HomeKit) 5 | 6 | Used to toggle Homebridge accessories On or Off via python script, no Home app required. You can set up a cronjob to enable automation, scripting and mimic other HomeKit functionalities 7 | 8 | **Note:** as of HomeScript 4.1 the minimum requirement is Python3+ and HomeBridge 1.x.x+ 9 | 10 | ## Examples 11 | `hs.py -s MainLight 0` | Switch off 12 | `hs.py -s MainLight 1` | Switch on 13 | `hs.py -s MainLight` | Toggle 14 | `hs.py -s lifx -hue 140` | RGB Lights Support (brightness, hue, saturation, temperature) 15 | `hs.py -s desk -b +10` | Increment/Decrement values 16 | 17 | ## Easy Match 18 | The script doesn't require full names of the accessories. 19 | 20 | **For example**, if your light is called "MainLight", you can run: 21 | `hs.py -s MainLight 0` or 22 | `hs.py -s main 0` 23 | The script will automatically search for matching substrings and set the accessory value 24 | 25 | ## Group Actions 26 | You can set multiple accessories (of the same type) in a single command: 27 | `hs.py -s all lights 1` 28 | `hs.py -s all switches 0` 29 | 30 | **Looking for maintainers: If you are interested in maintaining this project, feel free to reach out.** 31 | 32 | ## Setup 33 | Important: HomeBridge **must** be run in insecure mode for this script to work! 34 | 35 | #### Running HomeBridge in Insecure Mode 36 | - via Command Line 37 | ``` 38 | homebridge -I 39 | ``` 40 | 41 | - via Systemd 42 | ``` 43 | HOMEBRIDGE_OPTS=-U /var/lib/homebridge -I 44 | ``` 45 | 46 | - via pm2 47 | ``` 48 | pm2 stop homebridge; pm2 delete homebridge; pm2 start homebridge -- -I 49 | ``` 50 | 51 | ## Installation 52 | - Install the HomeScript API `pip install homescript` or `pip3 install homescript` 53 | - On your client computer: Download **hs.py** and move it to a convenient location 54 | - Edit the script to include your homebridge URL, port and authorization key 55 | - Change permissions `chmod +x /path/to/hs.py` (on linux) 56 | 57 | ## Usage 58 | Usage: `hs.py [option] [value]` 59 | ### Options: 60 | - -l, --list : Lists all available HomeKit accessories 61 | - Usage: `hs.py -l [argument]` 62 | - Arguments: 63 | - \ : lists accessory names 64 | - aid : lists accessory names with AID value 65 | - iid : lists accessory names with IID value 66 | - id : lists accessory names with AID and IID 67 | - type : lists accessory names with type 68 | - value : lists accessory names current state 69 | - -g, --get : [EasyMatch] gets current value of accessory 70 | - Usage: `hs.py -g ` 71 | - -s, --set : [EasyMatch] toggles the accessory On or Off, or sets to the specified value 72 | - Usage: `hs.py -s [value]` 73 | - Arguments: 74 | - \ : accessory that you want to change 75 | - -b : adjusts accessory brightness 76 | - -hue : adjusts accessory hue 77 | - -sat : adjusts accessory saturation 78 | - -t : adjusts accessory color temperature 79 | - [value] : value that you want to set it to. Prefix +/- to inc/dec 80 | - all : Gets or sets value of multiple HomeKit accessories 81 | - Usage: `hs.py -g all ` 82 | hs.py -s all \ value 83 | - -d, --debug : generates debug log file. 84 | - Usage: `hs.py -d ` 85 | - Eg: `hs.py -d -s all lights 0` 86 | - -h, --help : prints usage info 87 | - -v, --version : prints HomeScript version 88 | 89 | ## API 90 | As of v5.1+ HomeScript is now a fully importable API 91 | ```python 92 | import homescript 93 | 94 | # Initialize with hostname, port and auth code. Debug and sys.argv are optional 95 | hs = homescript.HomeScript(hostname, port, auth, [debug], [sys.argv]) 96 | 97 | # Select an accessory or group of accessories. Any get/set/print operation requires accessories to be selected first. 98 | hs.selectAccessory('mainlight') 99 | hs.selectGroup('lights') 100 | 101 | hs.printSelectedItems() 102 | 103 | # Operates on all selected items 104 | hs.setStates(1) 105 | hs.setValues('Brightness',250) 106 | ``` 107 | | Function | Description | 108 | | ----- | ----------------| 109 | | HomeScript( hostname: str, port: str, auth: str, debug: Boolean, argv: list ) | Constructor to initialize HomeBridge Connection. Debug: Set to `True` if you want to create debug and exception logfile. Default: None. argv: Only required if debug is `True` | 110 | | getAccessories() | Returns raw list of all available accessories on the Bridge | 111 | | selectAccessories( searchString: str ) | Saves matching accessory into selectedAccessories and returns them | 112 | | selectGroup( searchString: str ) | Saves all matching accessories into selectedAccessories and returns them | 113 | | printAccessories() | Prints all available accessories on the Bridge | 114 | | printSelectedItems() | Prints selectedAccessories | 115 | | getSelectedItems() | Returns selectedAccessories | 116 | | setStates(state: Boolean) | Sets `state` as the on/off value of all item(s) in selectedAccessories. If no argument is specified it toggles the state of all selectedAccessories | 117 | | setValues(attribute: str, value: int) | Sets numeric `value` to attribute of the item(s) in selectedAccessories. Attrubute: Brightness/Hue/Saturation/Color Temperature | 118 | | getVersion() | Does what it says on the can... | 119 | 120 | ## Troubleshooting/Error Reporting/Contributing 121 | The `debug` option helps generate a logfile for troubleshooting and error detection. 122 | - If you face an error, open a new issue on this repo prefixed by [Error] describing the error and attach your **both** your debug log and your exception log, along with any other outputs you receive. 123 | - If you would like to help improve the tool or request features, open an issue prefixed by [Feature Request] describing the functionality. 124 | - You **must** attach your debug log or else your issue will be closed. A simple debug log can be obtained from `hs.py -d -l` 125 | 126 | ## PRs and Commit Template 127 | PRs and commits that you make to this repo must include the following: 128 | - Type: bug-fix or enhancement 129 | - Description: Brief description about what the commit achieves 130 | - Notes: (heads ups/pointers to other developers if necessary) 131 | 132 |
133 | 134 | ## To Do 135 | ☑️ Color control for RGB and Hue Lights 136 | ⬜️ Control for PositionOpeners, GarageDoorOpener, LockMechanism 137 | ⬜️ WebColors 138 | ☑️ Increment/Decrement values 139 | ☑️ Querying API interface to return status of devices to `stdout` 140 | ☑️ Automation creation, viewing and monitoring without Home Hub 141 | 142 |
143 | 144 | ## Changelog 145 | ### v5.2 146 | - Added support for Increment/Decrement values 147 | - HS Automations and HS Apps are now deprecated 148 | 149 | ### v5.1.1 150 | - Fixed import bug 151 | 152 | ### v5.1 153 | - Rewritten from the ground up to be object oriented 154 | - Now features an importable API 155 | 156 | ### v5.0 157 | - Support for RGB lights! Now lets you control brightness, hue, saturation and color temperature of your lights! 158 | - Added additional value format recognition 159 | - Device type detection 160 | - Updated accessory structure 161 | - Added smart toggle support for integer values 162 | - Added validity checks for integer values 163 | - Ignore bridge in accessory list 164 | - Updated listing format 165 | - Finer control over listing parameters for devices with multiple interfaces 166 | - Updated exclusive value-only listing for easier interfacing in programs 167 | - Cleaned up accessory name recognition 168 | - Backward compatibility with v4.x syntax for all devices 169 | 170 | ### v4.1 171 | - Update to python 3 172 | - Update to support HomeBridge v1.0+ 173 | 174 | ### v4.0 175 | - Syntax update to be POSIX compliant 176 | - Get option to return item status 177 | - Introducing Automation and scripting support 178 | - Modularity and Third-party HomeScript Apps 179 | - Version logging 180 | - Improved Debugging 181 | Note: Some parts of release withheld until the next minor release 182 | 183 | ### v3.0.2 184 | - Bug fix: HomeBridge was displayed as "0" 185 | 186 | ### v3.0.1 187 | - Added debug support 188 | 189 | ### v3.0 190 | - Added group actions. You can now set values for all matching accessory types 191 | 192 | ### v2.2 193 | - Added json listing support 194 | 195 | ### v2.1 196 | - Added type support to identify accessory type 197 | - Updated help doc 198 | 199 | ### v2.0 200 | - List of accessories are now automatically fetched from the homebridge, instead of having to manually set them up in the script 201 | 202 | ### v1.3 203 | - Added easy name matching 204 | 205 | ### v1.2 206 | - Added help doc 207 | - Added listing 208 | 209 | ### v1.1 210 | - Added toggling 211 | 212 | ### v1.0 213 | - Initial release 214 | 215 |
216 | -------------------------------------------------------------------------------- /homescript/__init__.py: -------------------------------------------------------------------------------- 1 | # HomeScript - Python script to control homebridge devices using the command line 2 | # v5.1 3 | # Created by Menahi Shayan. 2019. 4 | # https://github.com/menahishayan/HomeScript 5 | 6 | import requests 7 | import json 8 | import logging 9 | from datetime import date 10 | # to add webcolors 11 | 12 | __version__ = "5.2" 13 | 14 | class HomeScript: 15 | def __init__(self,hostname,port, auth, debug=None, argv=None): 16 | self.__version__ = '5.2' 17 | self.url = 'http://' + hostname + ':' + str(port) + '/' 18 | self.headers = {'Content-Type': 'Application/json', 'authorization': auth} 19 | 20 | self.accessories={} 21 | self.selectedAccessories=[] 22 | self.selectedAccessoryNames={} 23 | 24 | self.getAccessories() 25 | 26 | self.debug = debug 27 | self.exceptionFile='homescript_exception_' + date.today().strftime("%Y.%m.%d") + '.log' 28 | if self.debug: 29 | self.debugHandler('init',argv) 30 | 31 | def getAccessories(self): 32 | global getAcc 33 | try: 34 | getAcc = requests.get(self.url + 'accessories', headers=self.headers) 35 | if getAcc.status_code == 200: 36 | getAcc = getAcc.json() 37 | # load sample data for debugging 38 | # with open('acc.json') as f: 39 | # data = json.load(f) 40 | for item in getAcc['accessories']: 41 | if getAcc['accessories'].index(item) != 0: 42 | interfaces = [] 43 | for i in item['services'][1]['characteristics'][1:]: 44 | if i['format'] not in ['bool','string','tlv8','uint8','float']: 45 | interfaces.append({'iid':i['iid'],'description': i['description'],'maxValue': i['maxValue'],'minValue': i['minValue'],'minStep': i['minStep'], 'value': i['value']}) 46 | else: 47 | interfaces.append({'iid':i['iid'],'description': i['description'],'value': i['value']}) 48 | self.accessories.update({str(item['services'][0]['characteristics'][3]['value']).replace(' ','_') : {'aid':item['aid'],'iid':10,'type':item['services'][0]['characteristics'][2]['value'],'value':interfaces}}) 49 | 50 | except: 51 | if self.debug: 52 | logging.error(Exception, exc_info=True) 53 | print('Exception logged: ' + self.exceptionFile) 54 | return self.accessories 55 | 56 | def selectAccessory(self,inputName): 57 | try: 58 | for key in self.accessories: 59 | if inputName in key.lower(): 60 | self.selectedAccessoryNames.update({self.accessories[key]['aid']:{'name':key}}) 61 | self.selectedAccessories.append({'aid':self.accessories[key]['aid'], 'value':self.accessories[key]['value']}) 62 | return self.selectedAccessories 63 | except: 64 | if self.debug: 65 | logging.error(Exception, exc_info=True) 66 | print('Exception logged: ' + self.exceptionFile) 67 | 68 | def selectGroup(self,inputName): 69 | try: 70 | for key in self.accessories: 71 | if self.accessories[key]['type'].lower().startswith(inputName[:len(inputName)-2]): 72 | self.selectedAccessoryNames.update({self.accessories[key]['aid']:{'name':key}}) 73 | self.selectedAccessories.append({'aid':self.accessories[key]['aid'], 'iid':self.accessories[key]['iid'], 'value':self.accessories[key]['value']}) 74 | return self.selectedAccessories 75 | except: 76 | if self.debug: 77 | logging.error(Exception, exc_info=True) 78 | print('Exception logged: ' + self.exceptionFile) 79 | 80 | def printAccessories(self,param=''): 81 | try: 82 | if param == 'json': 83 | print(json.dumps(self.accessories)) 84 | return 85 | for key in self.accessories: 86 | if param == 'aid': 87 | print(str(self.accessories[key]['aid']) + ' ', end='') 88 | print(key, end=' ') 89 | if param == 'type' or param == 'all': 90 | print(str(self.accessories[key]['type']) + ' ', end='') 91 | if param in ['value','iid','all']: 92 | # print(str(self.accessories[key]['value']), end='') 93 | for i in self.accessories[key]['value']: 94 | print('\n ', end='') 95 | if param == 'iid' or param == 'all': 96 | print(str(i['iid']) + ' ' + str(i['value']), end=' ') 97 | if param == 'value' or param == 'all': 98 | print(str(i['description']) + ' ' + str(i['value']), end='') 99 | print('') 100 | except: 101 | if self.debug: 102 | # debugHandler(json.dumps(sys.exc_info())) 103 | logging.error(Exception, exc_info=True) 104 | print('Exception logged: ' + self.exceptionFile) 105 | 106 | def getVersion(self): 107 | return self.__version__ 108 | 109 | def getSelectedItems(self): 110 | return self.selectedAccessories 111 | 112 | def printSelectedItems(self): 113 | for item in self.selectedAccessories: 114 | print(self.selectedAccessoryNames[item['aid']]['name'] + ' ' + str(item['value'])) 115 | 116 | def setStates(self,value): 117 | setData = [] 118 | valueIndex = 0 119 | 120 | for item in self.selectedAccessories: 121 | if value.isdigit(): 122 | item['value'][0]['value'] = int(value) 123 | elif item['value'][0]['value'] == 0 or item['value'][0]['value'] == False: 124 | item['value'][0]['value'] = 1 125 | else: 126 | item['value'][0]['value'] = 0 127 | 128 | self.selectedAccessoryNames[item['aid']].update({'iid': item['value'][valueIndex]['iid'], 'value': item['value'][valueIndex]['value']}) 129 | setData.append({'aid': item['aid'],'iid': item['value'][valueIndex]['iid'], 'value': item['value'][valueIndex]['value']}) 130 | setReq = requests.put(self.url + 'characteristics', headers=self.headers, data='{"characteristics":' + str(setData).replace('\'','\"') + '}') 131 | 132 | if self.debug: 133 | self.debugHandler('Set characteristics response:\n'+setReq.text) 134 | self.debugHandler('End set characteristics response') 135 | 136 | try: 137 | if setReq.status_code != 204: 138 | print(setReq) 139 | for item in setReq.json()['characteristics']: 140 | print(self.selectedAccessoryNames[item['aid']]['name'] + ' Error: ' + str(item['status'])) 141 | return item['status'] 142 | except: 143 | if self.debug: 144 | logging.error(Exception, exc_info=True) 145 | print('Exception logged: ' + self.exceptionFile) 146 | 147 | def setValues(self, attribute, value): 148 | setData = [] 149 | valueIndex = 0 150 | 151 | for item in self.selectedAccessories: 152 | valueIndex = next((item['value'].index(v) for v in item['value'] if v['description'] == attribute), 0) 153 | 154 | if value.isdigit(): 155 | if (int(value) <= item['value'][valueIndex]['maxValue']) and (int(value) >= item['value'][valueIndex]['minValue']) and (int(value)%item['value'][valueIndex]['minStep'] == 0): 156 | item['value'][valueIndex]['value'] = int(value) 157 | else: 158 | print('Error:\n Max Value: ' + str(item['value'][valueIndex]['maxValue']) + '\n Min Value: ' + str(item['value'][valueIndex]['minValue']) + '\n Min Step: ' + str(item['value'][valueIndex]['minStep'])) 159 | # Increment/Decrement 160 | elif value.startswith('+') or value.startswith('-'): 161 | if int(value[1:])%item['value'][valueIndex]['minStep'] == 0: 162 | item['value'][valueIndex]['value'] += int(value[1:]) if value[0] == '+' else -int(value[1:]) 163 | else: 164 | print('Error:\n Max Value: ' + str(item['value'][valueIndex]['maxValue']) + '\n Min Value: ' + str(item['value'][valueIndex]['minValue']) + '\n Min Step: ' + str(item['value'][valueIndex]['minStep'])) 165 | elif item['value'][valueIndex]['value'] >= ((item['value'][valueIndex]['maxValue']-item['value'][valueIndex]['minValue'])/2) - (((item['value'][valueIndex]['maxValue']-item['value'][valueIndex]['minValue'])/2)%item['value'][valueIndex]['minStep']): 166 | item['value'][valueIndex]['value'] = item['value'][valueIndex]['maxValue'] 167 | else: 168 | item['value'][valueIndex]['value'] = item['value'][valueIndex]['minValue'] 169 | 170 | self.selectedAccessoryNames[item['aid']].update({'iid': item['value'][valueIndex]['iid'], 'value': item['value'][valueIndex]['value']}) 171 | setData.append({'aid': item['aid'],'iid': item['value'][valueIndex]['iid'], 'value': item['value'][valueIndex]['value']}) 172 | setReq = requests.put(self.url + 'characteristics', headers=self.headers, data='{"characteristics":' + str(setData).replace('\'','\"') + '}') 173 | 174 | if self.debug: 175 | self.debugHandler('Set characteristics response:\n'+setReq.text) 176 | self.debugHandler('End set characteristics response') 177 | 178 | try: 179 | if setReq.status_code != 204: 180 | print(setReq) 181 | for item in setReq.json()['characteristics']: 182 | print(self.selectedAccessoryNames[item['aid']]['name'] + ' Error: ' + str(item['status'])) 183 | return item['status'] 184 | except: 185 | if self.debug: 186 | logging.error(Exception, exc_info=True) 187 | print('Exception logged: ' + self.exceptionFile) 188 | 189 | def debugHandler(self,content='init',argv=''): 190 | if content=='init': 191 | logging.basicConfig(filename=self.exceptionFile,filemode = 'a',encoding='utf-8', level=logging.DEBUG) 192 | debugFile=open('homescript_debug_' + date.today().strftime("%Y.%m.%d") + '.log', "w") 193 | debugFile.write('HSDB: homescript_debug_' + date.today().strftime("%Y.%m.%d") + '.log\nHSDB: HomeScript version: ' + self.__version__) 194 | debugFile.write('\nHSDB: URL: ' + self.url + '\nHSDB: Headers: ' + json.dumps(self.headers)) 195 | debugFile.write('\nHSDB: Accessories: ' + json.dumps(self.accessories)) 196 | debugFile.write('\nHSDB: Selected accessories: ' + json.dumps(self.selectedAccessories)) 197 | debugFile.write('\nHSDB: Selected accessory names: ' + json.dumps(self.selectedAccessoryNames)) 198 | debugFile.write('\nHSDB: Arguments: ' + json.dumps(argv)) 199 | debugFile.write('\nHSDB: Get accessories response:\n' + str(getAcc) + '\nHSDB: End get accessories response\n') 200 | elif content=='end': 201 | debugFile=open('homescript_debug_' + date.today().strftime("%Y.%m.%d") + '.log', "a") 202 | debugFile.write('HSDB: End homeScript debug file') 203 | print('Debug logged: homescript_debug_' + date.today().strftime("%Y.%m.%d") + '.log') 204 | else: 205 | debugFile=open('homescript_debug_' + date.today().strftime("%Y.%m.%d") + '.log', "a") 206 | debugFile.write('HSDB: ' + str(content) + '\n') 207 | debugFile.close() 208 | 209 | def __del__(self): 210 | try: 211 | if self.debug: 212 | self.debugHandler('end') 213 | except: 214 | None 215 | -------------------------------------------------------------------------------- /homescript_apps/hs-blink/README.md: -------------------------------------------------------------------------------- 1 | # hs-blink 2 | 3 | Automation script to Blink an accessory for example a light or smart plug. 4 | 5 | The script is executed on an infinite loop to exit, CTRL + C. 6 | 7 | ### Setup a python script as a service through systemctl/systemd 8 | 9 | **sudo nano /etc/systemd/system/blink.service** 10 | 11 | ``` 12 | [Unit] 13 | Description=Blink Accessory Aervice 14 | After=multi-user.target 15 | [Service] 16 | Type=simple 17 | Restart=always 18 | ExecStart=/usr/bin/python3 /home/pi/HomeScript/blink.py 19 | [Install] 20 | WantedBy=multi-user.target 21 | ``` 22 | 23 | Reload the daemon. 24 | 25 | ``` 26 | sudo systemctl daemon-reload 27 | ``` 28 | 29 | Enable the service so that it doesn’t get disabled if the server restarts. 30 | 31 | ``` 32 | sudo systemctl enable blink.service 33 | ``` 34 | 35 | Start service. 36 | 37 | ``` 38 | sudo systemctl start blink.service 39 | ``` 40 | 41 | Now the service is up and running. 42 | 43 | There are several commands to start, stop, restart, and check status. 44 | 45 | To stop the service. 46 | 47 | ``` 48 | sudo systemctl stop blink 49 | ``` 50 | 51 | To restart. 52 | 53 | ``` 54 | sudo systemctl restart blink 55 | ``` 56 | 57 | To check status. 58 | 59 | ``` 60 | sudo systemctl status blink 61 | ``` 62 | 63 | -------------------------------------------------------------------------------- /homescript_apps/hs-blink/blink.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | """ Automation Rule to Blink an accessory for example a light or smart plug 4 | The script is executed on an infinite loop to exit, CTRL + C. 5 | """ 6 | 7 | import argparse 8 | import time 9 | import os 10 | import sys 11 | import inspect 12 | 13 | # Import homescript that is 2 folders before. 14 | sys.path.append('..\..\..\homescript') 15 | import homescript 16 | 17 | __HOSTNAME__='192.168.0.106' 18 | __PORT__='51826' 19 | __AUTH__='043-14-615' 20 | 21 | # Name of the acessory to control - CHANGE WITH YOUR ACESSORY NAME. 22 | accessory="Smart_Plug_" 23 | 24 | def blink_accessory(name, time_sec): 25 | """ Blinks an accessory for example a light or a Smart Plug. 26 | 27 | Parameters 28 | ---------- 29 | name : string 30 | Acessory name. 31 | time_sec : integer 32 | Seconds between change the state. ON->OFF->ON. 33 | """ 34 | 35 | try: 36 | # Select an accessory or group of accessories. Any get/set/print operation requires accessories to be selected first. 37 | hs.selectAccessory(name.lower()) 38 | 39 | while True: 40 | hs.setStates("1") 41 | time.sleep(time_sec) 42 | hs.setStates("0") 43 | time.sleep(time_sec) 44 | 45 | except KeyboardInterrupt: 46 | print("Exiting...") 47 | 48 | parser = argparse.ArgumentParser(description='Command line blink accessory', add_help=True) 49 | parser.add_argument('-t', '--time', type=int, required=True, help='Time in seconds between state ON and OFF') 50 | args = parser.parse_args() 51 | 52 | start = False 53 | 54 | # To wait to Homebridge to start 55 | while False == start: 56 | try: 57 | # Initialize with hostname, port and auth code. Debug and sys.argv are optional 58 | hs = homescript.HomeScript(__HOSTNAME__, __PORT__, __AUTH__, True) 59 | start = True 60 | except Exception as e: 61 | print("An exception occurred!") 62 | print(e) 63 | 64 | blink_accessory(accessory, args.time) 65 | -------------------------------------------------------------------------------- /homescript_apps/hs-blink/blink.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Blink Accessory Service 3 | After=multi-user.target 4 | [Service] 5 | Type=simple 6 | Restart=always 7 | ExecStart=/usr/bin/python3 /home/pi/HomeScript/hs-blink/blink.py 8 | [Install] 9 | WantedBy=multi-user.target -------------------------------------------------------------------------------- /homescript_apps/hs-tplink/hs110_state.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | """ Reads the state of the realy from a TP-Link Smart Plug. 4 | """ 5 | import sys 6 | 7 | # Import homescript that is 2 folders before. 8 | sys.path.append('..\..\..\homescript') 9 | import homescript 10 | 11 | # import tplink 12 | from tplink import * 13 | 14 | __HOSTNAME__='192.168.0.106' 15 | __PORT__='51826' 16 | __AUTH__='043-14-615' 17 | 18 | # Name of the acessory to control - CHANGE WITH YOUR ACESSORY NAME. 19 | accessory="Smart_Plug_" 20 | 21 | start = False 22 | 23 | # To wait to Homebridge to start 24 | while False == start: 25 | try: 26 | # Initialize with hostname, port and auth code. Debug and sys.argv are optional 27 | hs = homescript.HomeScript(__HOSTNAME__, __PORT__, __AUTH__, True) 28 | start = True 29 | except Exception as e: 30 | print("An exception occurred!") 31 | print(e) 32 | 33 | hs.selectAccessory(accessory.lower()) 34 | 35 | # Get data 36 | relay_state = get_state(hs) 37 | print(relay_state) 38 | -------------------------------------------------------------------------------- /homescript_apps/hs-tplink/tplink.py: -------------------------------------------------------------------------------- 1 | """ Reads the state of the realy from a TP-Link Smart Plug. 2 | """ 3 | 4 | def get_state(hs): 5 | """ Reads the state of the realy from a TP-Link Smart Plug. 6 | 7 | Parameters 8 | ---------- 9 | hs : HomeScript 10 | HomeBridge Connection. 11 | """ 12 | hs_print_output = hs.getSelectedItems() 13 | for item in hs_print_output: 14 | if item["value"][0]["description"] == 'On': 15 | state = item["value"][0]["value"] 16 | return state 17 | print("Smart Plug Sensor Not Found!") -------------------------------------------------------------------------------- /homescript_apps/hs-xiaomi/temp_hum.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | """ Read the temperature and humidity from a Xiaomi Aqara Temperature and Humidity Sensor 4 | through a Aqara Air Conditioning Companion Gateway. 5 | """ 6 | import sys 7 | 8 | # Import homescript that is 3 folders before. 9 | sys.path.append('..\..\..\homescript') 10 | import homescript 11 | 12 | # import xiaomi 13 | from xiaomi import * 14 | 15 | __HOSTNAME__='192.168.0.106' 16 | __PORT__='51826' 17 | __AUTH__='043-14-615' 18 | 19 | # Name of the acessories to access - CHANGE WITH YOUR ACESSORY NAME. 20 | # Name of the temperature sensor. 21 | temp_sensor_name = "TemperatureAndHumiditySensor2_TemperatureSensor_7aaf" 22 | # Name of the humidity sensor. 23 | hum_sensor_name = "TemperatureAndHumiditySensor2_HumiditySensor_7aaf" 24 | 25 | list_of_accessories = [temp_sensor_name, hum_sensor_name] 26 | 27 | start = False 28 | 29 | # To wait to Homebridge to start 30 | while False == start: 31 | try: 32 | # Initialize with hostname, port and auth code. Debug and sys.argv are optional 33 | hs = homescript.HomeScript(__HOSTNAME__, __PORT__, __AUTH__) 34 | start = True 35 | except Exception as e: 36 | print("An exception occurred!") 37 | print(e) 38 | 39 | # Select all accessories 40 | for accessory in list_of_accessories: 41 | hs.selectAccessory(accessory.lower()) 42 | 43 | # Get data 44 | temp = get_temperature(hs) 45 | print(temp) 46 | 47 | hum = get_humidity(hs) 48 | print(hum) 49 | -------------------------------------------------------------------------------- /homescript_apps/hs-xiaomi/xiaomi.py: -------------------------------------------------------------------------------- 1 | def get_temperature(hs): 2 | hs_print_output = hs.getSelectedItems() 3 | for item in hs_print_output: 4 | if item["value"][0]["description"] == 'Current Temperature': 5 | temperature = item["value"][0]["value"] 6 | return temperature # °C 7 | print("Temperature Sensor Not Found!") 8 | 9 | def get_humidity(hs): 10 | hs_print_output = hs.getSelectedItems() 11 | for item in hs_print_output: 12 | if item["value"][0]["description"] == 'Current Relative Humidity': 13 | humidity = item["value"][0]["value"] 14 | return humidity # % 15 | print("Humidity Sensor Not Found!") -------------------------------------------------------------------------------- /hs.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | import argparse 4 | import sys 5 | import homescript 6 | 7 | __HOSTNAME__='192.168.0.106' 8 | __PORT__='51826' 9 | __AUTH__='043-14-615' 10 | 11 | argumentLength = len(sys.argv) 12 | 13 | def printHelp(): 14 | print('Usage: hs.py [option] [value]') 15 | print('Options:') 16 | print(' -l, --list : Lists all available HomeKit accessories') 17 | print(' Usage: hs.py -l [argument]') 18 | print(' Arguments:') 19 | print(' : lists accessory names') 20 | print(' aid : lists accessory names with AID value') 21 | print(' iid : lists accessory names with IID value') 22 | print(' id : lists accessory names with AID and IID') 23 | print(' type : lists accessory names with type') 24 | print(' value : lists accessory names current state\n') 25 | print(' -g, --get : [EasyMatch] gets current value of accessory') 26 | print(' Usage: hs.py -g \n') 27 | print(' -s, --set : [EasyMatch] toggles the accessory On or Off, or sets to value') 28 | print(' Usage: hs.py -s [value]\n') 29 | print(' all : Gets or sets value of multiple HomeKit accessories') 30 | print(' Usage: hs.py -g all ') 31 | print(' hs.py -s all value\n') 32 | print(' : Sets value of accessory attribute') 33 | print(' Usage: hs.py -s [+-]value') 34 | print(' hs.py -s lifx -hue 250\n') 35 | print(' -d, --debug : generates debug log file.') 36 | print(' Usage: hs.py -d ') 37 | print(' Eg: hs.py -d -s all lights 0\n') 38 | print(' -h, --help : prints usage info\n') 39 | print(' -v, --version : prints HomeScript version\n') 40 | print('\nEg: hs.py -s MainLight') 41 | print(' hs.py -s bedlight 0') 42 | print(' hs.py -g all lights') 43 | print(' hs.py -s all switches 1') 44 | print('\nCreated by Menahi Shayan.\n') 45 | sys.exit() 46 | 47 | parser = argparse.ArgumentParser(description='Command line control of HomeBridge',add_help=False) 48 | parser.add_argument('-d', '--debug', action='store_true') 49 | parser.add_argument('-h', '--help', action='store_true') 50 | parser.add_argument('-l', '--list', action='store',nargs='*') 51 | parser.add_argument('-s', '--set', action='store', nargs=argparse.REMAINDER) 52 | parser.add_argument('-g', '--get', action='store', nargs=argparse.REMAINDER) 53 | parser.add_argument('-v', '--version', action='store_true') 54 | args = parser.parse_args() 55 | 56 | hs = homescript.HomeScript(__HOSTNAME__,__PORT__,__AUTH__, args.debug, sys.argv) 57 | 58 | if argumentLength==1 or args.help: 59 | printHelp() 60 | 61 | if args.version: 62 | hs.getVersion() 63 | sys.exit() 64 | 65 | if args.list and len(args.list)>=0: 66 | hs.printAccessories(args.list[0] if len(args.list)>0 else '') 67 | if args.debug: 68 | hs.debugHandler('end') 69 | sys.exit() 70 | elif args.get and len(args.get)>=0: 71 | if args.get[0] == 'all': 72 | hs.selectGroup(args.get[1].lower()) 73 | else: 74 | hs.selectAccessory(args.get[0].lower()) 75 | elif args.set and len(args.set)>=0: 76 | if args.set[0] == 'all': 77 | hs.selectGroup(args.set[1].lower()) 78 | else: 79 | hs.selectAccessory(args.set[0].lower()) 80 | 81 | if len(hs.selectedAccessories) == 0: 82 | print('Accessory/Group not found.\nHere are a list of accessories:\n') 83 | hs.printAccessories('type') 84 | print('\nFor usage info type \'hs.py -h\'') 85 | if args.debug: 86 | hs.debugHandler('end') 87 | sys.exit(-1) 88 | else: 89 | if args.set: 90 | if '-b' not in args.set and '-hue' not in args.set and '-sat' not in args.set and '-t' not in args.set: 91 | hs.setStates(sys.argv[argumentLength-1] or None) 92 | else: 93 | if '-b' in args.set: 94 | hs.setValues('Brightness',sys.argv[argumentLength-1]) 95 | elif '-hue' in args.set: 96 | hs.setValues('Hue',sys.argv[argumentLength-1]) 97 | elif '-sat' in args.set: 98 | hs.setValues('Saturation',sys.argv[argumentLength-1]) 99 | elif '-t' in args.set: 100 | hs.setValues('Color Temperature',sys.argv[argumentLength-1]) 101 | 102 | elif args.get: 103 | hs.printSelectedItems() 104 | 105 | else: 106 | printHelp() 107 | 108 | if args.debug: 109 | hs.debugHandler('end') 110 | -------------------------------------------------------------------------------- /pyvenv.cfg: -------------------------------------------------------------------------------- 1 | home = /usr/local/bin 2 | include-system-site-packages = false 3 | version = 3.9.1 4 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | with open("README.md", "r") as fh: 4 | long_description = fh.read() 5 | 6 | setuptools.setup( 7 | name="homescript", 8 | version="5.2", 9 | author="Menahi Shayan", 10 | author_email="menahi.shayan@gmail.com", 11 | description="HomeScript CLI: Command Line Control of HomeBridge", 12 | long_description=long_description, 13 | long_description_content_type="text/markdown", 14 | url="https://github.com/menahishayan/HomeScript", 15 | packages=setuptools.find_packages(), 16 | classifiers=[ 17 | "Programming Language :: Python :: 3", 18 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 19 | "Operating System :: OS Independent", 20 | ], 21 | python_requires='>=3.7', 22 | install_requires=["requests"] 23 | ) --------------------------------------------------------------------------------