├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── MANIFEST.in ├── README.md ├── init.d └── lumimqtt ├── lumimqtt.json.sample ├── lumimqtt ├── __init__.py ├── __main__.py ├── button.py ├── commands.py ├── device.py ├── light.py ├── lumimqtt.py ├── platform.py └── sensors.py ├── requirements.txt ├── setup.cfg └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | .idea 3 | lumimqtt.json 4 | build 5 | dist 6 | *.egg-info 7 | #auto-generated version file 8 | lumimqtt/__version__.py 9 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Lumi MQTT changelog 2 | 3 | ## 1.0.2: 4 | 5 | Add threshold and debounce period settings to reduce sending data to MQTT 6 | 7 | ## 1.0.1: 8 | 9 | Avoid sending to MQTT if a sensor wasn't changed 10 | 11 | ## 1.0.0: 12 | 13 | Initial release 14 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.md 3 | include CHANGELOG.md 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MQTT agent for Xiaomi Lumi gateway 2 | 3 | ## Description 4 | 5 | The service allow controlling gateway LEDs, button, and illuminance 6 | sensor over MQTT 7 | 8 | Default config should be located in `/etc/lumimqtt.json` or 9 | can be overridden with `LUMIMQTT_CONFIG` environment variable. 10 | 11 | 12 | ## Interaction 13 | 14 | ### Default devices 15 | 16 | | Action | Topic | Payload | Expected values | 17 | |:----------------:|:---------------------:|:-------------------------------------:|:---------------------------------------------------------------------------------:| 18 | | Read light state | lumi/<ID>/light | | {"state": "ON", "brightness": 255, "color": {"r": 255, "g": 0, "b": 0}} | 19 | | Switch light | lumi/<ID>/light/set | {"state": "ON"} | | 20 | | Set light color | lumi/<ID>/light/set | {"color": {"r": 255, "g": 0, "b": 0}} | | 21 | | Set brightness | lumi/<ID>/light/set | {"brightness": 255} | | 22 | | Set color or brigthness with 10 seconds transition | lumi/<ID>/light/set | {"color": {"r": 255, "g": 0, "b": 0}, "brightness": 100, "transition": 10} | | 23 | | Read illuminance | lumi/<ID>/illuminance | | 0-1000 | 24 | | Button | lumi/<ID>/btn0/action | | single, double, triple, quadruple, many,
hold, double_hold, triple_hold, quadruple_hold, many_hold,
release | 25 | 26 | 27 | 28 | ### Binary sensors (soldered to GPIO points) 29 | 30 | | Action | Topic | Expected values | 31 | |:----------------:|:-----------------------:|:---------------:| 32 | | Read GPIO sensor | lumi/<ID>/ | ON/OFF | 33 | 34 | 35 | ## Run application 36 | Example run command: 37 | 38 | ```sh 39 | LUMIMQTT_CONFIG=./lumimqtt.json python3 -m lumimqtt 40 | ``` 41 | 42 | The configuration file is a JSON with the following content: 43 | 44 | ```json 45 | { 46 | "mqtt_host": "localhost", 47 | "mqtt_port": 1883, 48 | "mqtt_user": "", 49 | "mqtt_password": "", 50 | "topic_root": "lumi/{device_id}", 51 | "auto_discovery": true, 52 | "sensor_retain": false, 53 | "sensor_threshold": 50, 54 | "sensor_debounce_period": 60, 55 | "legacy_color_mode": true, 56 | "light_transition_period": 1.0 57 | } 58 | ``` 59 | Every line is optional. By default, LumiMQTT will use the connection 60 | to localhost with the anonymous login. 61 | 62 | `device_id` **if not provided** will be automatically replaced by a hex number 63 | representing a MAC address of the first network interface. 64 | 65 | `auto_discovery` set to `false` to disable creating autodiscovery topics that 66 | are user by Home Assistant to discover entities. 67 | 68 | `sensor_retain` is option to enable storing last sensor value on the broker 69 | 70 | `sensor_threshold` is a threshold to avoid sending data to MQTT on small 71 | changes 72 | 73 | `sensor_debounce_period` value in seconds to send data despite the threshold 74 | 75 | `light_transition_period` value in seconds to set default transition for light 76 | switching or light change. Use `0` to remove the transition. 77 | 78 | `legacy_color_mode` set to `false` to use with Home Assistant 2024.4 or newer 79 | 80 | ### SSL connection 81 | 82 | To use SSL connection, you need to set `mqtt_cert` and `mqtt_key`, and optional `mqtt_ca` with corresponding paths to files. 83 | 84 | ### Custom sensors 85 | 86 | You can also use GPIO(s) as binary sensor(s). Add this to configuration: 87 | 88 | ```json 89 | { 90 | , 91 | "binary_sensors": { 92 | "": { 93 | "gpio": "", 94 | "device_class": "", 95 | "topic": "" 96 | } 97 | } 98 | } 99 | ``` 100 | 101 | Values in `<>` must be replaced. 102 | 103 | `gpio` is required, `device_class` and `topic` are optional. By default `topic` is sensor's name. 104 | 105 | [List of GPIOs.](https://github.com/openlumi/xiaomi-gateway-openwrt#gpio) 106 | [List of device classes.](https://www.home-assistant.io/integrations/binary_sensor/#device-class) 107 | 108 | ### Custom commands 109 | 110 | You can add an extra section with custom commands that are executed with 111 | mqtt topics. Every command is exported as a switch entity in Home Assistant. 112 | If json is passed to the set topic, the command will be interpolated with 113 | the values. Plain text is passed as {text} variable 114 | ```json 115 | { 116 | , 117 | "custom_commands": { 118 | "blink": "for i in 0 255 0 255 0 255 0; do echo $i > /sys/class/leds/{color}/brightness; sleep 1; done", 119 | "tts": "echo \"Test TTS without MPD component for home assistant\" | python3 -c 'from urllib.parse import quote_plus;from sys import stdin;print(\"wget -O /tmp/tts.mp3 -U Mozilla \\\"http://translate.google.com/translate_tts?q=\"+quote_plus(stdin.read()[:100])+\"&ie=UTF-8&tl=en&total=1&idx=0&client=tw-ob&prev=input&ttsspeed=1\\\" && amixer set Master 200 && mpg123 /tmp/tts.mp3\")' | sh 2> /dev/null", 120 | "tts_interpolate": "echo \"{text}\" | python3 -c 'from urllib.parse import quote_plus;from sys import stdin;print(\"wget -O /tmp/tts.mp3 -U Mozilla \\\"http://translate.google.com/translate_tts?q=\"+quote_plus(stdin.read()[:100])+\"&ie=UTF-8&tl=en&total=1&idx=0&client=tw-ob&prev=input&ttsspeed=1\\\" && amixer set Master {volume} && mpg123 /tmp/tts.mp3\")' | sh 2> /dev/null", 121 | "restart_lumimqtt": "/etc/init.d/lumimqtt restart", 122 | "reboot": "/sbin/reboot" 123 | } 124 | } 125 | ``` 126 | 127 | #### Usage examples 128 | 129 | | Action | Topic | Payload | 130 | |:------------------------------:|:------------------------------:|:-------------------------------------------------:| 131 | | Run command "blink" | lumi/<ID>/blink/set | {"color": "red"} | 132 | | Run command "tts" | lumi/<ID>/tts/set | <ANYTHING> | 133 | | Run command "tts_interpolate" | lumi/<ID>/tts_interpolate/set | {"text": "Hi, it is a test", "volume": 200} | 134 | | Run command "restart_lumimqtt" | lumi/<ID>/restart_lumimqtt/set | <ANYTHING> | 135 | | Run command "reboot" | lumi/<ID>/reboot/set | <ANYTHING> | 136 | 137 | ## OpenWrt installation 138 | 139 | ```sh 140 | opkg update 141 | opkg install python3-pip python3-asyncio python3-evdev 142 | pip3 install -U lumimqtt 143 | ``` 144 | 145 | To upgrade you can just run 146 | 147 | ```sh 148 | pip3 install -U lumimqtt 149 | ``` 150 | 151 | ## Example run command: 152 | 153 | ```sh 154 | lumimqtt 155 | ``` 156 | 157 | ### or (in background): 158 | 159 | ```sh 160 | lumimqtt & 161 | ``` 162 | 163 | ### Autorun: 164 | To run lumimqtt on start you need a file 165 | **/etc/init.d/lumimqtt** with the following content: 166 | 167 | ```sh 168 | #!/bin/sh /etc/rc.common 169 | START=98 170 | USE_PROCD=1 171 | start_service() 172 | { 173 | procd_open_instance 174 | 175 | procd_set_param env LUMIMQTT_CONFIG=/etc/lumimqtt.json 176 | procd_set_param command lumimqtt 177 | procd_set_param respawn 178 | procd_set_param stdout 1 179 | procd_set_param stderr 1 180 | procd_close_instance 181 | } 182 | ``` 183 | 184 | To install this file on the gateway you can run 185 | 186 | ```sh 187 | wget https://raw.githubusercontent.com/openlumi/lumimqtt/main/init.d/lumimqtt -O /etc/init.d/lumimqtt 188 | chmod +x /etc/init.d/lumimqtt 189 | /etc/init.d/lumimqtt enable 190 | /etc/init.d/lumimqtt start 191 | ``` 192 | -------------------------------------------------------------------------------- /init.d/lumimqtt: -------------------------------------------------------------------------------- 1 | #!/bin/sh /etc/rc.common 2 | 3 | START=98 4 | USE_PROCD=1 5 | 6 | start_service() 7 | { 8 | procd_open_instance 9 | 10 | procd_set_param env LUMIMQTT_CONFIG=/etc/lumimqtt.json 11 | procd_set_param command lumimqtt 12 | procd_set_param respawn 13 | procd_set_param stdout 1 14 | procd_set_param stderr 1 15 | procd_close_instance 16 | } 17 | -------------------------------------------------------------------------------- /lumimqtt.json.sample: -------------------------------------------------------------------------------- 1 | { 2 | "mqtt_host": "localhost", 3 | "mqtt_user": "", 4 | "mqtt_password": "" 5 | } 6 | -------------------------------------------------------------------------------- /lumimqtt/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openlumi/lumimqtt/dfe260be22f759dbbf9462615e3374d4a12e8bcf/lumimqtt/__init__.py -------------------------------------------------------------------------------- /lumimqtt/__main__.py: -------------------------------------------------------------------------------- 1 | import asyncio as aio 2 | import json 3 | import logging 4 | import os 5 | import signal 6 | from uuid import getnode as get_mac 7 | 8 | from .__version__ import version 9 | from .lumimqtt import LumiMqtt 10 | from .platform import devices 11 | 12 | logger = logging.getLogger(__name__) 13 | 14 | 15 | def read_mac(): 16 | # We try to read mac address from first interface at first 17 | # if the file is absent or empty, use generic uuid.getnode() 18 | ifaces = [x for x in sorted(os.listdir('/sys/class/net/')) if x != 'lo'] 19 | if ifaces: 20 | addr_file = f'/sys/class/net/{ifaces[0]}/address' 21 | try: 22 | with open(addr_file, 'r') as f: 23 | mac = f.readline().strip('\n') 24 | except FileNotFoundError: 25 | pass 26 | else: 27 | return f"0x{mac.replace(':', '')}" 28 | 29 | mac = get_mac() 30 | if (mac >> 40) % 2: 31 | logger.error("Can't get a valid mac, use randomly generated one") 32 | mac = hex(mac) 33 | 34 | return mac 35 | 36 | 37 | def signal_handler(): 38 | raise KeyboardInterrupt() 39 | 40 | 41 | async def amain(): 42 | logging.basicConfig(level='INFO') 43 | 44 | os.environ.setdefault('LUMIMQTT_CONFIG', '/etc/lumimqtt.json') 45 | config = {} 46 | if os.path.exists(os.environ['LUMIMQTT_CONFIG']): 47 | try: 48 | with open(os.environ['LUMIMQTT_CONFIG'], 'r') as f: 49 | config = json.load(f) 50 | except FileNotFoundError: 51 | pass 52 | 53 | device_id = read_mac() 54 | config = { 55 | 'device_id': device_id, 56 | 'topic_root': 'lumi/{device_id}', 57 | 'mqtt_host': 'localhost', 58 | 'mqtt_port': 1883, 59 | 'auto_discovery': True, # create homeassistant discovery topics 60 | 'sensor_threshold': 50, # 5% of illuminance sensor 61 | 'sensor_debounce_period': 60, # 1 minute 62 | 'light_transition_period': 1.0, # second 63 | 'light_notification_period': 60, # 1 minute 64 | 'legacy_color_mode': True, # for HA < 2024.4 65 | **config, 66 | } 67 | 68 | topic_root = \ 69 | config['topic_root'].\ 70 | replace('{device_id}', device_id).\ 71 | replace('{MAC}', device_id) # support old configs 72 | server = LumiMqtt( 73 | reconnection_interval=10, 74 | device_id=config['device_id'], 75 | topic_root=topic_root, 76 | host=config['mqtt_host'], 77 | port=config['mqtt_port'], 78 | user=config.get('mqtt_user'), 79 | password=config.get('mqtt_password'), 80 | ca=config.get('mqtt_ca'), 81 | cert=config.get('mqtt_cert'), 82 | key=config.get('mqtt_key'), 83 | auto_discovery=config['auto_discovery'], 84 | sensor_retain=config.get('sensor_retain', False), 85 | sensor_threshold=int(config['sensor_threshold']), 86 | sensor_debounce_period=int(config['sensor_debounce_period']), 87 | light_transition_period=float(config['light_transition_period']), 88 | light_notification_period=float(config['light_notification_period']), 89 | legacy_color_mode=bool(config['legacy_color_mode']), 90 | ) 91 | 92 | for device in devices( 93 | binary_sensors=config.get('binary_sensors', {}), 94 | custom_commands=config.get('custom_commands', {}), 95 | ): 96 | server.register(device) 97 | 98 | loop = aio.get_running_loop() 99 | for _signal in (signal.SIGTERM, signal.SIGQUIT, signal.SIGHUP): 100 | loop.add_signal_handler(_signal, signal_handler) 101 | 102 | try: 103 | logger.info(f'Start lumimqtt {version}') 104 | await server.start() 105 | finally: 106 | await server.close() 107 | 108 | 109 | def main(): 110 | try: 111 | aio.run(amain()) 112 | except KeyboardInterrupt: 113 | pass 114 | 115 | 116 | if __name__ == '__main__': 117 | main() 118 | -------------------------------------------------------------------------------- /lumimqtt/button.py: -------------------------------------------------------------------------------- 1 | """ 2 | LUMI button input 3 | """ 4 | 5 | import asyncio as aio 6 | 7 | from evdev import InputDevice, KeyEvent, categorize, ecodes 8 | 9 | from .device import Device 10 | 11 | 12 | class ButtonAction: 13 | SINGLE = 'single' 14 | DOUBLE = 'double' 15 | TRIPLE = 'triple' 16 | QUADRUPLE = 'quadruple' 17 | MANY = 'many' 18 | HOLD = 'hold' 19 | DOUBLE_HOLD = 'double_hold' 20 | TRIPLE_HOLD = 'triple_hold' 21 | QUADRUPLE_HOLD = 'quadruple_hold' 22 | MANY_HOLD = 'many_hold' 23 | RELEASE = 'release' 24 | 25 | 26 | class Button(Device): 27 | """ 28 | Button 29 | """ 30 | MQTT_VALUES = { 31 | 'icon': 'mdi:gesture-double-tap', 32 | } 33 | THRESHOLD = 0.3 34 | PROVIDE_EVENTS = [ 35 | getattr(ButtonAction, x) 36 | for x in dir(ButtonAction) if not x.startswith('__') 37 | ] 38 | 39 | def __init__(self, name, device_file, topic, scancodes): 40 | super().__init__(name, device_file, topic) 41 | self.ev_device = InputDevice(self.device_file) 42 | self.scancodes = [ecodes.ecodes[scancode] for scancode in scancodes] 43 | 44 | self.event_queue = None 45 | self.is_pressed = False 46 | self.is_sent = False 47 | self.clicks_done = 0 48 | 49 | async def handle_events(self): 50 | async for event in self.ev_device.async_read_loop(): 51 | event = categorize(event) 52 | if isinstance(event, KeyEvent) and ( 53 | not self.scancodes or event.scancode in self.scancodes 54 | ): 55 | if event.keystate in [KeyEvent.key_up, KeyEvent.key_down]: 56 | await self.event_queue.put(event.keystate) 57 | 58 | async def handle_queue(self, on_click): 59 | while True: 60 | if self.is_pressed and not self.is_sent or self.clicks_done: 61 | try: 62 | event = await aio.wait_for( 63 | self.event_queue.get(), 64 | timeout=self.THRESHOLD, 65 | ) 66 | except aio.TimeoutError: 67 | action = { 68 | (False, 1): ButtonAction.SINGLE, 69 | (False, 2): ButtonAction.DOUBLE, 70 | (False, 3): ButtonAction.TRIPLE, 71 | (False, 4): ButtonAction.QUADRUPLE, 72 | (True, 0): ButtonAction.HOLD, 73 | (True, 1): ButtonAction.DOUBLE_HOLD, 74 | (True, 2): ButtonAction.TRIPLE_HOLD, 75 | (True, 3): ButtonAction.QUADRUPLE_HOLD, 76 | }.get((self.is_pressed, self.clicks_done)) 77 | if action is None: 78 | if self.clicks_done > 3 and self.is_pressed: 79 | action = ButtonAction.MANY_HOLD 80 | elif self.clicks_done > 4 and not self.is_pressed: 81 | action = ButtonAction.MANY 82 | else: 83 | raise NotImplementedError('Unknown button state') 84 | 85 | await on_click(self, action) 86 | self.is_sent = self.is_pressed 87 | self.clicks_done = 0 88 | else: 89 | if event == KeyEvent.key_up: 90 | self.clicks_done += 1 91 | self.is_pressed = False 92 | elif event == KeyEvent.key_down: 93 | self.is_pressed = True 94 | else: 95 | event = await self.event_queue.get() 96 | if event == KeyEvent.key_up: 97 | self.is_pressed = False 98 | await on_click(self, ButtonAction.RELEASE) 99 | elif event == KeyEvent.key_down: 100 | self.is_pressed = True 101 | self.is_sent = False 102 | 103 | async def handle(self, on_click): 104 | self.event_queue = aio.Queue() 105 | await aio.gather( 106 | self.handle_events(), 107 | self.handle_queue(on_click), 108 | ) 109 | -------------------------------------------------------------------------------- /lumimqtt/commands.py: -------------------------------------------------------------------------------- 1 | """ 2 | LUMI light control 3 | """ 4 | import asyncio as aio 5 | import contextlib 6 | import logging 7 | import subprocess 8 | import sys 9 | from collections import defaultdict 10 | 11 | from .device import Device 12 | 13 | logger = logging.getLogger(__name__) 14 | 15 | 16 | class Command(Device): 17 | """ 18 | Custom command control 19 | """ 20 | 21 | def __init__(self, name, device_file, topic): 22 | super().__init__(name, device_file, topic) 23 | self.command = device_file 24 | 25 | @property 26 | def topic_set(self): 27 | return f'{self.topic}/set' 28 | 29 | @contextlib.contextmanager 30 | def fix_watcher(self): 31 | if sys.version_info < (3, 8, 0): 32 | # https://github.com/aio-libs/aiohttp/pull/2075/files#diff-70599d14cae2351e35e46867bce26e325e84f3b84ce218718239c4bfeac4dcf5R445-R448 33 | loop = aio.get_event_loop() 34 | policy = aio.get_event_loop_policy() 35 | watcher = policy.get_child_watcher() 36 | watcher.attach_loop(loop) 37 | yield 38 | 39 | @staticmethod 40 | def quote(s): 41 | try: 42 | return str(s).replace('"', '\\"').replace("'", "\\'"). \ 43 | replace('$', '') 44 | except Exception: 45 | logger.exception('Error on escaping command') 46 | return "" 47 | 48 | async def run_command(self, value): 49 | if isinstance(value, dict): 50 | value = { 51 | k: self.quote(v) 52 | for k, v in value.items() 53 | } 54 | command = self.command.format_map(defaultdict(str, **value)) 55 | else: 56 | command = self.command.format_map(defaultdict(str, text=value)) 57 | 58 | with self.fix_watcher(): 59 | proc = await aio.create_subprocess_shell( 60 | command, 61 | stdout=subprocess.PIPE, 62 | stderr=subprocess.PIPE, 63 | ) 64 | await proc.wait() 65 | 66 | async def set(self, value): 67 | logger.info(f'{self.name}: run command with params: {value}.') 68 | await self.run_command(value) 69 | logger.info(f'{self.name} is done.') 70 | -------------------------------------------------------------------------------- /lumimqtt/device.py: -------------------------------------------------------------------------------- 1 | """ 2 | Basic Device class 3 | """ 4 | import os 5 | import typing as ty 6 | 7 | 8 | class Device: 9 | MQTT_VALUES: ty.Optional[ty.Dict] = None 10 | 11 | def __init__(self, name, device_file, topic=None): 12 | self.name = name 13 | self.device_file = device_file 14 | self.topic = topic or name 15 | 16 | def read_raw(self, device_file=None): 17 | if not device_file: 18 | device_file = self.device_file 19 | if os.path.exists(device_file): 20 | with open(device_file, 'r') as f: 21 | return f.read().strip() 22 | return None 23 | -------------------------------------------------------------------------------- /lumimqtt/light.py: -------------------------------------------------------------------------------- 1 | """ 2 | LUMI light control 3 | """ 4 | import asyncio as aio 5 | import logging 6 | import os 7 | import typing as ty 8 | 9 | from .device import Device 10 | 11 | logger = logging.getLogger(__name__) 12 | 13 | 14 | class LED(Device): 15 | """ 16 | LED control 17 | """ 18 | def __init__(self, name, device_dir): 19 | brightness_dev = os.path.join(device_dir, 'brightness') 20 | super().__init__(name, brightness_dev) 21 | self.brightness = int(self.read_raw(self.device_file)) 22 | max_brightness_dev = os.path.join(device_dir, 'max_brightness') 23 | self.max_brightness = int(self.read_raw(max_brightness_dev)) 24 | 25 | async def write(self, value: int): 26 | with open(self.device_file, 'w') as f: 27 | f.write(f'{value}\n') 28 | 29 | 30 | class Light(Device): 31 | """ 32 | Light control 33 | """ 34 | COLOR_MODE = 'rgb' 35 | BRIGHTNESS = True 36 | 37 | def __init__(self, name, devices: dict, topic): 38 | super().__init__(name, None, topic) 39 | self.red = LED(f'{name}_red', devices['red']) 40 | self.green = LED(f'{name}_green', devices['green']) 41 | self.blue = LED(f'{name}_blue', devices['blue']) 42 | 43 | self.leds = { 44 | 'r': self.red, 45 | 'g': self.green, 46 | 'b': self.blue, 47 | } 48 | 49 | self.state: ty.Dict[str, ty.Any] = { 50 | 'state': 'ON' if any((self.red.brightness, 51 | self.green.brightness, 52 | self.blue.brightness)) else 'OFF', 53 | 'brightness': 255, 54 | 'color': {}, 55 | 'color_mode': self.COLOR_MODE, 56 | } 57 | for c, led in self.leds.items(): 58 | self.state['color'][c] = int( 59 | led.brightness / led.max_brightness * 255) 60 | 61 | @property 62 | def topic_set(self): 63 | return f'{self.topic}/set' 64 | 65 | async def set(self, value: dict, transition_period: float): 66 | state = value.get('state', self.state['state']) 67 | color = value.get('color', self.state['color']) 68 | # have to save to separate variable, to keep it after off 69 | target_brightness = \ 70 | brightness = value.get('brightness', self.state['brightness']) 71 | transition = value.get('transition', transition_period) # seconds 72 | start_brightness = self.state['brightness'] 73 | start_color = self.state['color'] 74 | 75 | # workaround for openhab light switch 76 | if color['r'] == color['g'] == color['b'] == 0: 77 | color = self.state['color'] 78 | state = 'OFF' 79 | 80 | if self.state['state'].lower() == 'off': 81 | start_brightness = 0 82 | if color['r'] == 0 and color['g'] == 0 and color['b'] == 0: 83 | color['r'] = color['g'] = color['b'] = 255 84 | if state.lower() == 'off': 85 | brightness = 0 86 | 87 | def color_repr(color: dict): 88 | return f'#{color["r"]:02x}{color["g"]:02x}{color["b"]:02x}' 89 | 90 | logger.info(f'Change light from {self.state["state"]} ' 91 | f'{start_brightness} {color_repr(start_color)} ' 92 | f'to {state} {brightness} {color_repr(start_color)}') 93 | 94 | if transition: 95 | steps = int(12 * transition) 96 | if steps < 1: 97 | steps = 1 98 | delay = transition / steps / 3 99 | for step_num in range(1, steps): 100 | for c, led in self.leds.items(): 101 | step = (color[c] * brightness / 255 - 102 | start_color[c] * start_brightness / 255) / steps 103 | next_value = (start_color[c] * start_brightness / 255 + 104 | step * step_num) / 255 * led.max_brightness 105 | next_value = int(min(max(next_value, 0), 106 | led.max_brightness)) # normalize 107 | await led.write(next_value) 108 | await aio.sleep(delay) 109 | 110 | for c, led in self.leds.items(): 111 | next_value = color[c] / 255 * led.max_brightness * brightness / 255 112 | next_value = int(min(max(next_value, 0), 113 | led.max_brightness)) # normalize 114 | await led.write(next_value) 115 | 116 | self.state = { 117 | 'state': state, 118 | 'brightness': target_brightness, 119 | 'color': color, 120 | 'color_mode': self.COLOR_MODE, 121 | } 122 | -------------------------------------------------------------------------------- /lumimqtt/lumimqtt.py: -------------------------------------------------------------------------------- 1 | """ 2 | LUMI MQTT handler 3 | """ 4 | 5 | import asyncio as aio 6 | import json 7 | import logging 8 | import typing as ty 9 | from dataclasses import dataclass 10 | from datetime import datetime 11 | 12 | import aio_mqtt 13 | 14 | from .__version__ import version 15 | from .button import Button 16 | from .commands import Command 17 | from .device import Device 18 | from .light import Light 19 | from .sensors import BinarySensor, Sensor 20 | 21 | logger = logging.getLogger(__name__) 22 | 23 | 24 | RECONNECTION_LIMIT = 5 25 | 26 | 27 | @dataclass 28 | class DebounceSensor: 29 | value: ty.Any 30 | last_sent: datetime 31 | 32 | 33 | class LumiMqtt: 34 | def __init__( 35 | self, 36 | device_id: str, 37 | topic_root: str, 38 | host: str, 39 | port: int = None, 40 | user: ty.Optional[str] = None, 41 | password: ty.Optional[str] = None, 42 | ca: ty.Optional[str] = None, 43 | cert: ty.Optional[str] = None, 44 | key: ty.Optional[str] = None, 45 | reconnection_interval: int = 10, 46 | *, 47 | auto_discovery: bool, 48 | sensor_retain: bool, 49 | sensor_threshold: int, 50 | sensor_debounce_period: int, 51 | light_transition_period: float, 52 | light_notification_period: float, 53 | legacy_color_mode: bool, 54 | ) -> None: 55 | self.dev_id = device_id 56 | self._topic_root = topic_root 57 | self._topic_lwt = f'{topic_root}/status' 58 | self._mqtt_host = host 59 | self._mqtt_port = port 60 | self._mqtt_user = user 61 | self._mqtt_password = password 62 | self._mqtt_ca = ca 63 | self._mqtt_cert = cert 64 | self._mqtt_key = key 65 | self._legacy_color_mode = legacy_color_mode 66 | 67 | self._will_message = aio_mqtt.PublishableMessage( 68 | topic_name=self._topic_lwt, 69 | payload='offline', 70 | qos=aio_mqtt.QOSLevel.QOS_1, 71 | retain=True, 72 | ) 73 | 74 | self._auto_discovery = auto_discovery 75 | self._sensor_retain = sensor_retain 76 | self._sensor_threshold = sensor_threshold 77 | self._sensor_debounce_period = sensor_debounce_period 78 | self._light_transition_period = light_transition_period 79 | self._light_notification_period = light_notification_period 80 | self._light_last_sent = None 81 | self._reconnection_interval = reconnection_interval 82 | self._client = aio_mqtt.Client( 83 | loop=aio.get_running_loop(), 84 | client_id_prefix='lumimqtt_', 85 | ) 86 | self._tasks: ty.List[aio.Future] = [] 87 | 88 | self.sensors: ty.List[Sensor] = [] 89 | self.lights: ty.List[Light] = [] 90 | self.buttons: ty.List[Button] = [] 91 | self.custom_commands: ty.List[Command] = [] 92 | 93 | self._debounce_sensors: ty.Dict[Sensor, DebounceSensor] = {} 94 | 95 | async def start(self): 96 | self._tasks = [ 97 | aio.create_task(self._connect_forever()), 98 | aio.create_task(self._handle_messages()), 99 | aio.create_task(self._periodic_publish()), 100 | aio.create_task(self._handle_buttons()), 101 | ] 102 | finished, _ = await aio.wait( 103 | self._tasks, 104 | return_when=aio.FIRST_COMPLETED, 105 | ) 106 | for t in finished: 107 | t.result() 108 | 109 | async def close(self) -> None: 110 | if self._client.is_connected(): 111 | await self._client.disconnect() 112 | 113 | def register(self, device: Device): 114 | if not device: 115 | return 116 | mapping: dict[type, list] = { 117 | Sensor: self.sensors, 118 | Button: self.buttons, 119 | Light: self.lights, 120 | Command: self.custom_commands, 121 | } 122 | for typ, array in mapping.items(): 123 | if isinstance(device, typ): 124 | array.append(device) 125 | break 126 | else: 127 | raise NotImplementedError() 128 | 129 | def _get_topic(self, subtopic): 130 | return f'{self._topic_root}/{subtopic}' 131 | 132 | @property 133 | def subscribed_topics(self): 134 | # TODO: add SOUND/TTS topics ? 135 | return [self._get_topic(light.topic_set) for light in self.lights] + \ 136 | [self._get_topic(cmd.topic_set) for cmd in self.custom_commands] 137 | 138 | async def _command_handler(self, command: Command, value): 139 | await command.set(value) 140 | reconnection_counter = 0 141 | while True: 142 | try: 143 | await self._client.publish( 144 | aio_mqtt.PublishableMessage( 145 | topic_name=self._get_topic(command.topic), 146 | payload='OFF', 147 | qos=aio_mqtt.QOSLevel.QOS_1, 148 | ), 149 | ) 150 | return 151 | except aio_mqtt.ConnectionClosedError: 152 | logger.exception("Connection closed") 153 | reconnection_counter += 1 154 | if reconnection_counter >= RECONNECTION_LIMIT: 155 | raise 156 | await self._client.wait_for_connect() 157 | 158 | async def _light_handler(self, light: Light, value): 159 | await light.set(value, self._light_transition_period) 160 | reconnection_counter = 0 161 | while True: 162 | try: 163 | await self._publish_light(light) 164 | return 165 | except aio_mqtt.ConnectionClosedError: 166 | logger.exception("Connection closed") 167 | reconnection_counter += 1 168 | if reconnection_counter >= RECONNECTION_LIMIT: 169 | raise 170 | await self._client.wait_for_connect() 171 | 172 | async def _handle_messages(self) -> None: 173 | running_message_tasks: list[aio.Task] = [] 174 | try: 175 | async for message in self._client.delivered_messages( 176 | f'{self._topic_root}/#', 177 | ): 178 | for task in running_message_tasks: 179 | if task.done(): 180 | try: 181 | task.result() 182 | except Exception: 183 | logger.exception( 184 | "Unhandled exception during echo " 185 | "message publishing", 186 | ) 187 | finally: 188 | running_message_tasks.remove(task) 189 | if message.topic_name not in self.subscribed_topics: 190 | logger.error("Invalid topic for light") 191 | continue 192 | light: ty.Optional[Light] = None 193 | for _light in self.lights: 194 | if message.topic_name == self._get_topic(_light.topic_set): 195 | light = _light 196 | if light: 197 | try: 198 | value = json.loads(message.payload) 199 | except ValueError as e: 200 | logger.exception(str(e)) 201 | continue 202 | new_light_task = aio.create_task( 203 | self._light_handler(light, value), 204 | ) 205 | running_message_tasks.append(new_light_task) 206 | continue 207 | command: ty.Optional[Command] = None 208 | for _command in self.custom_commands: 209 | if message.topic_name == self._get_topic( 210 | _command.topic_set, 211 | ): 212 | command = _command 213 | if command: 214 | try: 215 | value = json.loads(message.payload) 216 | except ValueError: 217 | value = message.payload.decode() 218 | new_command_task = aio.create_task( 219 | self._command_handler(command, value), 220 | ) 221 | running_message_tasks.append(new_command_task) 222 | except aio.CancelledError: 223 | for task in running_message_tasks: 224 | if task.done(): 225 | try: 226 | task.result() 227 | except Exception: 228 | pass 229 | else: 230 | task.cancel() 231 | try: 232 | await task 233 | except (Exception, aio.CancelledError): 234 | pass 235 | 236 | async def send_config(self): 237 | device = { 238 | 'identifiers': [ 239 | f'xiaomi_gateway_{self.dev_id}', 240 | ], 241 | 'name': f'xiaomi_gateway_{self.dev_id}', 242 | 'sw_version': version, 243 | 'model': 'Xiaomi Gateway', 244 | 'manufacturer': 'Xiaomi', 245 | } 246 | 247 | def get_generic_vals(name): 248 | return { 249 | 'name': f'{name}_{self.dev_id}', 250 | 'unique_id': f'{name}_{self.dev_id}', 251 | 'device': device, 252 | 'availability_topic': self._topic_lwt, 253 | } 254 | 255 | # set sensors config 256 | for sensor in self.sensors: 257 | await self._client.publish( 258 | aio_mqtt.PublishableMessage( 259 | topic_name=( 260 | f'homeassistant/' 261 | f"{'binary_' if self._is_binary(sensor) else ''}sensor" 262 | f'/{self.dev_id}/{sensor.topic}/config' 263 | ), 264 | payload=json.dumps({ 265 | **get_generic_vals(sensor.name), 266 | **(sensor.MQTT_VALUES or {}), 267 | 'state_topic': self._get_topic(sensor.topic), 268 | }), 269 | qos=aio_mqtt.QOSLevel.QOS_1, 270 | retain=True, 271 | ), 272 | ) 273 | 274 | # set buttons config 275 | for button in self.buttons: 276 | base_topic = self._get_topic(button.topic) 277 | messages = [ 278 | aio_mqtt.PublishableMessage( 279 | topic_name=( 280 | f'homeassistant/sensor/{self.dev_id}/' 281 | f'{button.topic}/config' 282 | ), 283 | payload=json.dumps({ 284 | **get_generic_vals(button.name), 285 | **(button.MQTT_VALUES or {}), 286 | 'json_attributes_topic': base_topic, 287 | 'state_topic': base_topic, 288 | 'value_template': '{{ value_json.action }}', 289 | }), 290 | qos=aio_mqtt.QOSLevel.QOS_1, 291 | retain=True, 292 | ), 293 | ] 294 | for event in button.PROVIDE_EVENTS: 295 | messages.append( 296 | aio_mqtt.PublishableMessage( 297 | topic_name=( 298 | f'homeassistant/device_automation/' 299 | f'{button.name}_{self.dev_id}/action_{event}/config' 300 | ), 301 | payload=json.dumps({ 302 | # device_automation should not have 303 | # name and unique_id 304 | 'device': device, 305 | 'automation_type': 'trigger', 306 | 'topic': f'{base_topic}/action', 307 | 'subtype': event, 308 | 'payload': event, 309 | 'type': 'action', 310 | }), 311 | qos=aio_mqtt.QOSLevel.QOS_1, 312 | retain=True, 313 | ), 314 | ) 315 | await aio.gather(*[self._client.publish(m) for m in messages]) 316 | 317 | # set LED lights config 318 | for light in self.lights: 319 | await self._client.publish( 320 | aio_mqtt.PublishableMessage( 321 | topic_name=f'homeassistant/light/{self.dev_id}/' 322 | f'{light.topic}/config', 323 | payload=json.dumps({ 324 | **get_generic_vals(light.name), 325 | 'schema': 'json', 326 | **( 327 | {'color_mode': bool(light.COLOR_MODE)} 328 | if self._legacy_color_mode else {} 329 | ), 330 | 'supported_color_modes': [light.COLOR_MODE], 331 | 'brightness': light.BRIGHTNESS, 332 | 'state_topic': self._get_topic(light.topic), 333 | 'command_topic': self._get_topic(light.topic_set), 334 | }), 335 | qos=aio_mqtt.QOSLevel.QOS_1, 336 | retain=True, 337 | ), 338 | ) 339 | for command in self.custom_commands: 340 | await self._client.publish( 341 | aio_mqtt.PublishableMessage( 342 | topic_name=f'homeassistant/switch/' 343 | f'{self.dev_id}_{command.name}/config', 344 | payload=json.dumps({ 345 | **get_generic_vals(command.name), 346 | 'state_topic': self._get_topic(command.topic), 347 | 'command_topic': self._get_topic(command.topic_set), 348 | }), 349 | qos=aio_mqtt.QOSLevel.QOS_1, 350 | retain=True, 351 | ), 352 | ) 353 | 354 | async def _periodic_publish(self, period=1): 355 | while True: 356 | if not self._client.is_connected(): 357 | await aio.sleep(1) 358 | continue 359 | try: 360 | for sensor in self.sensors: 361 | value = sensor.get_value() 362 | debounce_val = self._debounce_sensors.get(sensor) 363 | if self._is_binary(sensor): 364 | should_send = ( 365 | debounce_val is None or value != debounce_val.value 366 | ) 367 | else: 368 | should_send = ( 369 | debounce_val is None or 370 | abs(value - debounce_val.value) >= 371 | self._sensor_threshold or 372 | ( 373 | datetime.now() - debounce_val.last_sent 374 | ).seconds >= self._sensor_debounce_period 375 | ) 376 | 377 | if should_send: 378 | self._debounce_sensors[sensor] = DebounceSensor( 379 | value=value, 380 | last_sent=datetime.now(), 381 | ) 382 | await self._publish_sensor(sensor, value) 383 | 384 | for light in self.lights: 385 | now = datetime.now() 386 | should_send = ( 387 | self._light_last_sent is None or 388 | (now - self._light_last_sent).seconds >= 389 | self._light_notification_period 390 | ) 391 | if should_send: 392 | await self._publish_light(light) 393 | self._light_last_sent = datetime.now() 394 | except ( 395 | aio_mqtt.ConnectionClosedError, 396 | aio_mqtt.ServerDiedError, 397 | ) as e: 398 | logger.error("Connection closed", exc_info=e) 399 | await self._client.wait_for_connect() 400 | continue 401 | 402 | await aio.sleep(period) 403 | 404 | async def _publish_sensor(self, sensor: Sensor, value=None): 405 | if value is None: 406 | value = sensor.get_value() 407 | await self._client.publish( 408 | aio_mqtt.PublishableMessage( 409 | topic_name=self._get_topic(sensor.topic), 410 | payload=value, 411 | qos=aio_mqtt.QOSLevel.QOS_1, 412 | retain=self._sensor_retain, 413 | ), 414 | ) 415 | 416 | async def _publish_light(self, light: Light): 417 | await self._client.publish( 418 | aio_mqtt.PublishableMessage( 419 | topic_name=self._get_topic(light.topic), 420 | payload=json.dumps(light.state), 421 | qos=aio_mqtt.QOSLevel.QOS_1, 422 | ), 423 | ) 424 | 425 | async def _handle_buttons(self): 426 | tasks = [ 427 | aio.create_task(button.handle(self._handle_click)) 428 | for button in self.buttons 429 | ] 430 | try: 431 | finished, unfinished = await aio.wait( 432 | tasks, 433 | return_when=aio.FIRST_COMPLETED, 434 | ) 435 | except aio.CancelledError: 436 | for t in tasks: 437 | t.cancel() 438 | try: 439 | await t 440 | except aio.CancelledError: 441 | pass 442 | raise 443 | 444 | for t in unfinished: 445 | t.cancel() 446 | try: 447 | await t 448 | except aio.CancelledError: 449 | pass 450 | for t in finished: 451 | t.result() 452 | 453 | async def _handle_click(self, button: Button, action: str): 454 | logger.debug(f'{button} sent "{action}" event') 455 | await aio.gather( 456 | self._client.publish( 457 | aio_mqtt.PublishableMessage( 458 | topic_name=self._get_topic(button.topic), 459 | payload=json.dumps({'action': action}), 460 | qos=aio_mqtt.QOSLevel.QOS_1, 461 | ), 462 | ), 463 | self._client.publish( 464 | aio_mqtt.PublishableMessage( 465 | topic_name=self._get_topic(f'{button.topic}/action'), 466 | payload=action, 467 | qos=aio_mqtt.QOSLevel.QOS_1, 468 | ), 469 | ), 470 | ) 471 | await self._client.publish( 472 | aio_mqtt.PublishableMessage( 473 | topic_name=self._get_topic(button.topic), 474 | payload=json.dumps({'action': ''}), 475 | qos=aio_mqtt.QOSLevel.QOS_1, 476 | ), 477 | ) 478 | 479 | async def _connect_forever(self) -> None: 480 | while True: 481 | try: 482 | client_id = f'lumimqtt_{self.dev_id}' 483 | context = None 484 | if self._mqtt_cert is not None and self._mqtt_key is not None: 485 | import ssl 486 | 487 | context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2) 488 | if self._mqtt_ca is not None: 489 | context.load_verify_locations(self._mqtt_ca) 490 | context.load_cert_chain(self._mqtt_cert, self._mqtt_key) 491 | connect_result = await self._client.connect( 492 | host=self._mqtt_host, 493 | port=self._mqtt_port, 494 | ssl=context, 495 | username=self._mqtt_user, 496 | password=self._mqtt_password, 497 | client_id=client_id, 498 | will_message=self._will_message, 499 | ) 500 | logger.info( 501 | f"Connected to {self._mqtt_host} with client id " 502 | f"'{client_id}'", 503 | ) 504 | 505 | await self._client.publish( 506 | aio_mqtt.PublishableMessage( 507 | topic_name=self._topic_lwt, 508 | payload='online', 509 | qos=aio_mqtt.QOSLevel.QOS_1, 510 | retain=True, 511 | ), 512 | ) 513 | topics = self.subscribed_topics 514 | if topics: 515 | await self._client.subscribe(*[ 516 | (t, aio_mqtt.QOSLevel.QOS_1) 517 | for t in topics 518 | ]) 519 | if self._auto_discovery: 520 | await self.send_config() 521 | 522 | for light in self.lights: 523 | await self._publish_light(light) 524 | 525 | for sensor in self.sensors: 526 | await self._publish_sensor(sensor) 527 | 528 | logger.info("Wait for network interruptions...") 529 | await connect_result.disconnect_reason 530 | except aio.CancelledError: 531 | raise 532 | 533 | except aio_mqtt.AccessRefusedError as e: 534 | logger.error("Access refused", exc_info=e) 535 | raise 536 | except ( 537 | aio_mqtt.ConnectionLostError, 538 | aio_mqtt.ConnectFailedError, 539 | aio_mqtt.ServerDiedError, 540 | ): 541 | logger.error( 542 | "Connection lost. Will retry in %d seconds", 543 | self._reconnection_interval, 544 | ) 545 | await aio.sleep(self._reconnection_interval) 546 | 547 | except aio_mqtt.ConnectionCloseForcedError as e: 548 | logger.error("Connection close forced", exc_info=e) 549 | return 550 | 551 | except Exception as e: 552 | logger.error( 553 | "Unhandled exception during connecting", 554 | exc_info=e, 555 | ) 556 | return 557 | 558 | else: 559 | logger.info("Disconnected") 560 | return 561 | 562 | @staticmethod 563 | def _is_binary(sensor): 564 | return isinstance(sensor, BinarySensor) 565 | -------------------------------------------------------------------------------- /lumimqtt/platform.py: -------------------------------------------------------------------------------- 1 | """ 2 | LUMI platform specification 3 | """ 4 | import logging 5 | import os 6 | import typing as ty 7 | 8 | from .button import Button 9 | from .commands import Command 10 | from .device import Device 11 | from .light import Light 12 | from .sensors import BinarySensor, IlluminanceSensor 13 | 14 | logger = logging.getLogger(__name__) 15 | 16 | 17 | def sensors(binary_sensors: dict) -> ty.List[Device]: 18 | sensors_: ty.List[Device] = [] 19 | for name, device_file in ( 20 | ('illuminance', '/sys/bus/iio/devices/iio:device0/in_voltage5_raw'), 21 | ): 22 | if os.path.exists(device_file): 23 | sensors_.append(IlluminanceSensor( 24 | name=name, 25 | device_file=device_file, 26 | topic=name, 27 | )) 28 | 29 | for binary_sensor, sensor_options in binary_sensors.items(): 30 | sensor_config = { 31 | 'name': binary_sensor, 32 | 'topic': binary_sensor, 33 | **sensor_options, 34 | } 35 | if 'gpio' in sensor_config: 36 | sensors_.append(BinarySensor(**sensor_config)) 37 | else: 38 | logger.error(f'GPIO number is not set for {binary_sensor} sensor!') 39 | return sensors_ 40 | 41 | 42 | def buttons() -> ty.List[Device]: 43 | buttons_: ty.List[Device] = [] 44 | for name, device_file, scancodes in ( 45 | ('btn0', '/dev/input/event0', ['BTN_0']), 46 | ): 47 | if os.path.exists(device_file): 48 | buttons_.append(Button( 49 | name=name, 50 | device_file=device_file, 51 | topic=name, 52 | scancodes=scancodes, 53 | )) 54 | return buttons_ 55 | 56 | 57 | def lights() -> ty.List[Device]: 58 | led_r = '/sys/class/leds/red' 59 | led_g = '/sys/class/leds/green' 60 | led_b = '/sys/class/leds/blue' 61 | 62 | led_r_legacy = '/sys/class/backlight/lumi_r' 63 | led_g_legacy = '/sys/class/backlight/lumi_g' 64 | led_b_legacy = '/sys/class/backlight/lumi_b' 65 | if os.path.exists(led_r_legacy): 66 | leds = { 67 | 'red': led_r_legacy, 68 | 'green': led_g_legacy, 69 | 'blue': led_b_legacy, 70 | } 71 | else: 72 | leds = { 73 | 'red': led_r, 74 | 'green': led_g, 75 | 'blue': led_b, 76 | } 77 | lights_: ty.List[Device] = [] 78 | for name, device_dirs in ( 79 | ('light', leds), 80 | ): 81 | if all(os.path.exists(f) for f in device_dirs.values()): 82 | lights_.append(Light(name=name, devices=device_dirs, topic=name)) 83 | return lights_ 84 | 85 | 86 | def commands(params) -> ty.List[Device]: 87 | commands_: ty.List[Device] = [] 88 | for topic, command in params.items(): 89 | cmd_config = { 90 | 'name': topic, 91 | 'topic': topic, 92 | 'device_file': command, 93 | } 94 | commands_.append(Command(**cmd_config)) 95 | return commands_ 96 | 97 | 98 | def devices(binary_sensors: dict, custom_commands: dict): 99 | return sensors(binary_sensors) + buttons() + lights() + \ 100 | commands(custom_commands) 101 | -------------------------------------------------------------------------------- /lumimqtt/sensors.py: -------------------------------------------------------------------------------- 1 | """ 2 | LUMI sensor devices (GPIO, illuminance) 3 | """ 4 | 5 | import logging 6 | import os 7 | 8 | from .device import Device 9 | 10 | logger = logging.getLogger(__name__) 11 | 12 | 13 | class Sensor(Device): 14 | """ 15 | Base sensor class 16 | """ 17 | def get_value(self): 18 | raise NotImplementedError() 19 | 20 | 21 | class BinarySensor(Sensor): 22 | """ 23 | Binary sensor (GPIO) 24 | """ 25 | MQTT_VALUES: dict = {} 26 | 27 | def __init__(self, name, gpio, topic, device_class=None): 28 | device_file = f"/sys/class/gpio/gpio{gpio}/value" 29 | super().__init__(name, device_file, topic) 30 | if device_class: 31 | self.MQTT_VALUES['device_class'] = device_class 32 | if not os.path.exists(device_file): 33 | try: 34 | with open('/sys/class/gpio/export', 'w') as f: 35 | f.write(str(gpio)) 36 | with open(f'/sys/class/gpio/gpio{gpio}/direction', 'w') as f: 37 | f.write('in') 38 | except OSError as err: 39 | logger.error(f"Can not setup {name} sensor: {err}") 40 | 41 | def get_value(self): 42 | return 'OFF' if self.read_raw() == '0' else 'ON' 43 | 44 | 45 | class IlluminanceSensor(Sensor): 46 | """ 47 | Illuminance sensor 48 | """ 49 | COEFFICIENT = 0.25 50 | MQTT_VALUES = { 51 | 'device_class': 'illuminance', 52 | 'unit_of_measurement': 'lx', 53 | } 54 | 55 | def get_value(self): 56 | raw_value = self.read_raw() 57 | return int(int(raw_value) * self.COEFFICIENT) 58 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | setuptools_scm 2 | aio-mqtt-mod>=0.3.2 3 | evdev>=1.0.0 4 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | exclude = setup.py 3 | max-line-length = 80 4 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from setuptools import setup 4 | 5 | with open("README.md", "r") as fh: 6 | long_description = fh.read() 7 | 8 | setup( 9 | name='lumimqtt', 10 | use_scm_version={ 11 | 'write_to': 'lumimqtt/__version__.py', 12 | }, 13 | setup_requires=['setuptools_scm'], 14 | description='Xiaomi Lumi Gateway MQTT integration', 15 | long_description=long_description, 16 | long_description_content_type="text/markdown", 17 | author='Ivan Belokobylskiy', 18 | author_email='belokobylskij@gmail.com', 19 | url='https://github.com/openlumi/lumimqtt/', 20 | install_requires=[ 21 | 'evdev>=1.0.0', 22 | 'aio-mqtt-mod>=0.3.2', 23 | ], 24 | packages=['lumimqtt'], 25 | entry_points={ 26 | 'console_scripts': ['lumimqtt=lumimqtt.__main__:main'], 27 | }, 28 | classifiers=[ 29 | 'Programming Language :: Python :: 3.7', 30 | 'Programming Language :: Python :: 3.8', 31 | 'Programming Language :: Python :: 3.9', 32 | 'Programming Language :: Python :: 3.10', 33 | 'Programming Language :: Python :: 3.11', 34 | 'Programming Language :: Python :: 3 :: Only', 35 | 'Topic :: Utilities', 36 | ], 37 | ) 38 | --------------------------------------------------------------------------------