From 84398fc53ab6263876d3ce7c3c02ec468d2cce00 Mon Sep 17 00:00:00 2001 From: Darell Tan Date: Sun, 23 Apr 2023 23:20:07 +0800 Subject: [PATCH] "Initial" working version, after cleanup. --- LICENSE.md | 675 +++++++++++++++++++++++++++++++++++++++++++ README.md | 47 +++ bridge.go | 505 ++++++++++++++++++++++++++++++++ cmd/hapz2m/main.go | 102 +++++++ go.mod | 24 ++ go.sum | 86 ++++++ hapz2m.conf | 6 + s_battery.go | 34 +++ s_climate_sensors.go | 53 ++++ s_contact_sensor.go | 37 +++ s_switch.go | 51 ++++ z2m.go | 432 +++++++++++++++++++++++++++ z2m_test.go | 217 ++++++++++++++ 13 files changed, 2269 insertions(+) create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 bridge.go create mode 100644 cmd/hapz2m/main.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 hapz2m.conf create mode 100644 s_battery.go create mode 100644 s_climate_sensors.go create mode 100644 s_contact_sensor.go create mode 100644 s_switch.go create mode 100644 z2m.go create mode 100644 z2m_test.go diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/README.md b/README.md new file mode 100644 index 0000000..c955242 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +hap-z2m Bridge +=============== + +A HomeKit <-> Zigbee2MQTT bridge written in Go, so I don't have to install more NodeJS rubbish. +It is essentially a Homebridge + homebride-z2m replacement. +It compiles down to a <10 MB static binary instead of another 200++ MB Docker container. +It uses the [hap library](https://github.com/brutella/hap) for interfacing with HomeKit. + +It is quite barebones, so there is no configuration for the bridge, apart from the MQTT server & credentials. +The bridge configures and exposes devices based on z2m's MQTT messages. + +Currently only supports the types of Zigbee devices I have: + +- Climate sensors (temp, humidity) +- Contact sensors +- Wall switch + +If you do use this software, note that it's in development and may contains bugs, +or may even burn your house down. I offer no warranty, but you are welcome to file bugs. + + +Building +========= + +To compile `hap-z2m`, use: + + go build -v -trimpath -ldflags="-s -w" ./cmd/... + +License +======== + +hap-z2m is licensed under the GNU General Public License v3. + +Copyright (C) 2023 Darell Tan + +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program. If not, see . + diff --git a/bridge.go b/bridge.go new file mode 100644 index 0000000..59b059f --- /dev/null +++ b/bridge.go @@ -0,0 +1,505 @@ +package hapz2m + +import ( + "github.com/brutella/hap" + "github.com/brutella/hap/accessory" + + mqtt "github.com/eclipse/paho.mqtt.golang" + + "context" + "encoding/json" + "fmt" + "log" + "net/http" + "strings" + "sync" + "time" +) + +var ( + ErrDeviceExists = fmt.Errorf("device already exists") + ErrDuplicateExposesMapping = fmt.Errorf("duplicate property name in Exposes mapping") + ErrUpdateTimeout = fmt.Errorf("update timeout") + ErrAlreadyConnected = fmt.Errorf("already connected") +) + +const ( + MQTT_TOPIC_PREFIX = "zigbee2mqtt/" + + // Store name for persisting zigbee2mqtt state + Z2M_STATE_STORE = "z2m_state" + + // timeout for UpdateZ2MState + Z2M_UPDATE_TIMEOUT = 3 * time.Second +) + +const BRIDGE_DEBUG = false + +type Bridge struct { + // MQTT broker and credentials + Server string + Username string + Password string + + ctx context.Context + bridgeAcc *accessory.Bridge + + devices map[string]*BridgeDevice + server *hap.Server + store hap.Store + + // RWMutex protects hap init variables below + hapInitMutex sync.RWMutex + hapInitDone bool + hapInitCh chan struct{} + pendingUpdates sync.Map // queued updates before HAP init + + mqttClient mqtt.Client + + updateListeners sync.Map +} + +type BridgeDevice struct { + Device *Device + Accessory *accessory.A + Mappings map[string]*ExposeMapping +} + +// Creates and initializes a Bridge. +func NewBridge(ctx context.Context, storeDir string) *Bridge { + br := &Bridge{ + ctx: ctx, + store: hap.NewFsStore(storeDir), + + hapInitCh: make(chan struct{}), + devices: make(map[string]*BridgeDevice), + } + + br.bridgeAcc = accessory.NewBridge(accessory.Info{ + Name: "hap-z2m Bridge", + Manufacturer: "geekman", + }) + + return br +} + +// Initializes the hap.Server and calls ListenAndServe(). +// ListenAndServe() will block until the context is cancelled +func (br *Bridge) StartHAP() error { + if br.bridgeAcc == nil { + return fmt.Errorf("bridge accessory not created yet") + } + + br.hapInitMutex.RLock() + if !br.hapInitDone { + br.hapInitMutex.RUnlock() + return fmt.Errorf("HAP accessories not yet initialized") + } + + acc := br.accessories() + br.hapInitMutex.RUnlock() + + var err error + br.server, err = hap.NewServer(br.store, br.bridgeAcc.A, acc...) + if err != nil { + return err + } + + err = br.server.ListenAndServe(br.ctx) + + // disconnect from MQTT + br.mqttClient.Disconnect(1000) + + // flush z2m state to disk + if err := br.saveZ2MState(); err != nil { + log.Printf("cannot persist Z2M state: %s", err) + } + + return err +} + +// Waits until the Bridge has configured itself from Z2M state. +// Once that happens, subsequent calls return immediately. +func (br *Bridge) WaitConfigured() { + for !br.hapInitDone { + <-br.hapInitCh + } +} + +// Connects to the MQTT server. +// Blocks until the connection is established, then auto-reconnect logic takes over +func (br *Bridge) ConnectMQTT() error { + if br.mqttClient != nil && br.mqttClient.IsConnected() { + return ErrAlreadyConnected + } + + opts := mqtt.NewClientOptions(). + AddBroker(br.Server). + SetUsername(br.Username). + SetPassword(br.Password). + SetClientID("hap-z2m"). + SetKeepAlive(60 * time.Second). + SetPingTimeout(2 * time.Second). + SetConnectRetry(true) + + opts.SetOnConnectHandler(func(c mqtt.Client) { + log.Printf("connected to MQTT broker") + + tok := c.Subscribe(MQTT_TOPIC_PREFIX+"#", 0, br.handleMqttMessage) + if tok.Wait() && tok.Error() != nil { + log.Fatal(tok.Error()) + } + + log.Printf("subscribed to MQTT topic") + }) + + br.mqttClient = mqtt.NewClient(opts) + + if tok := br.mqttClient.Connect(); tok.Wait() && tok.Error() != nil { + return tok.Error() + } + + return nil +} + +// Load the Z2M state from hap.Store into the sync.Map. +// If the state was blank or not found, a nil error will be returned. +// Existing state for devices in the Map will not be overwritten. +func (br *Bridge) loadZ2MState(m *sync.Map) error { + state, err := br.store.Get(Z2M_STATE_STORE) + if err != nil || len(state) == 0 { + return nil + } + + var stateMap map[string][]byte + err = json.Unmarshal(state, &stateMap) + if err != nil { + return err + } + + for k, v := range stateMap { + // LoadOrStore retains existing data, only storing if empty + if _, exists := m.LoadOrStore(k, v); exists { + log.Printf("skipping %s, newer data is available", k) + } + } + + return nil +} + +// Persists the Z2M state into hap.Store +// Returns an error if there was a problem with translation, serialization or storing. +func (br *Bridge) saveZ2MState() error { + devices := make(map[string][]byte) + + for name, dev := range br.devices { + devState := make(map[string]any) + + for prop, mapping := range dev.Mappings { + v, err := mapping.ToExposedValue(mapping.Characteristic.Val) + if err != nil { + return err + } + + devState[prop] = v + } + + // serialize into JSON + jsonState, err := json.Marshal(devState) + if err != nil { + return err + } + + devices[name] = jsonState + } + + allJson, err := json.Marshal(devices) + if err != nil { + return err + } + + return br.store.Set(Z2M_STATE_STORE, allJson) +} + +func (br *Bridge) handleMqttMessage(_ mqtt.Client, msg mqtt.Message) { + topic, payload := msg.Topic(), msg.Payload() + + //log.Printf("received %s %s", topic, payload) + + // check for topic prefix and remove it + l := len(MQTT_TOPIC_PREFIX) + if len(topic) <= l || topic[:l] != MQTT_TOPIC_PREFIX { + return + } + topic = topic[l:] + + // strip leading slashes if we have to + if topic[0] == '/' { + topic = topic[1:] + } + + // ignore /set and /get requests, not sent by z2m + l = len(topic) + if l > len("/get") { + topicSuffix := topic[l-4:] + if topicSuffix == "/get" || topicSuffix == "/set" { + return + } + } + + // spawn a goroutine to handle message, since mutex might block + go func() { + br.hapInitMutex.RLock() + defer br.hapInitMutex.RUnlock() + + // check if HAP bridge device has been initialized + if !br.hapInitDone { + if strings.HasPrefix(topic, "bridge/") { + // need to look out for bridge/devices for intiial setup + if topic == "bridge/devices" { + err := br.AddDevicesFromJSON(payload) + if err != nil { + log.Printf("unable to add devices from JSON: %v", err) + } + + // populate initial characteristic values from cache, if available + err = br.loadZ2MState(&br.pendingUpdates) + if err != nil { + log.Printf("cannot load z2m state: %s", err) + } + + // "upgrade" to write lock for modifications + br.hapInitMutex.RUnlock() // unlock now, relock again later + defer br.hapInitMutex.RLock() // ... before defer kicks in + + br.hapInitMutex.Lock() + defer br.hapInitMutex.Unlock() + + // dequeue and apply state updates + log.Print("applying deferred updates...") + br.pendingUpdates.Range(func(k, v any) bool { + devName := k.(string) + br.UpdateAccessoryState(devName, v.([]byte)) + return true // continue + }) + + br.hapInitDone = true + + close(br.hapInitCh) // signal to waiting threads + } + } else { + // queue other messages for state updating after setup + // only keep latest message for each device + log.Printf("queueing updates for %s", topic) + br.pendingUpdates.Store(topic, payload) + } + } else { + br.UpdateAccessoryState(topic, payload) + } + }() +} + +// Gets a list of all added accessories +func (br *Bridge) accessories() []*accessory.A { + var acc []*accessory.A + for _, d := range br.devices { + acc = append(acc, d.Accessory) + } + return acc +} + +// Creates and calls AddDevice() based on the JSON definitions from zigbee2mqtt/bridge/devices. +func (br *Bridge) AddDevicesFromJSON(devJson []byte) error { + var devices []Device + err := json.Unmarshal(devJson, &devices) + if err != nil { + return err + } + + for _, dev := range devices { + dev := dev // make a copy + + acc, exp, err := createAccessory(&dev) + if err != nil { + if err == ErrDeviceSkipped { + continue + } + return err + } + + err = br.AddDevice(&dev, acc, exp) + if err != nil { + return err + } + } + + return nil +} + +// Adds a device to this Bridge +func (br *Bridge) AddDevice(dev *Device, acc *accessory.A, mappings []*ExposeMapping) error { + name := dev.FriendlyName + if _, exists := br.devices[name]; exists { + return ErrDeviceExists + } + + // put ExposeMapping into a map + em := make(map[string]*ExposeMapping) + for _, m := range mappings { + prop := m.ExposesEntry.Property + if _, exists := em[prop]; exists { + return ErrDuplicateExposesMapping + } + em[prop] = m + } + + // wire up accessory's remote value update functions + for _, m := range mappings { + m := m + if m.ExposesEntry.IsSettable() { + m.Characteristic.SetValueRequestFunc = func(newVal any, req *http.Request) (any, int) { + // handle remote value updates only + if req != nil { + updated, err := br.UpdateZ2MState(dev, m, newVal) + if !updated { + log.Printf("error updating z2m for %s: %s", dev.FriendlyName, err) + return nil, hap.JsonStatusServiceCommunicationFailure + } + } + return nil, 0 + } + } + } + + br.devices[name] = &BridgeDevice{dev, acc, em} + return nil +} + +func makeUpdateKey(dev *Device, mapping *ExposeMapping) string { + return dev.FriendlyName + "/" + mapping.ExposesEntry.Property +} + +// Updates zigbee2mqtt device state over MQTT. +// It then waits (with timeout) for zigbee2mqtt to send the updated state via MQTT, +// as acknowledgement of receipt, before returning with an updated status. +// If z2m doesn't respond in time, ErrUpdateTimeout is returned. +func (br *Bridge) UpdateZ2MState(dev *Device, mapping *ExposeMapping, newVal any) (updated bool, err error) { + prop := mapping.ExposesEntry.Property + + // map Characteristic to exposed value + expVal, err := mapping.ToExposedValue(newVal) + if err != nil { + return updated, err + } + + ch := make(chan any, 2) + defer close(ch) + + // only one update should occur at a time + key := makeUpdateKey(dev, mapping) + if _, exists := br.updateListeners.LoadOrStore(key, ch); exists { + return updated, fmt.Errorf("already a pending update on property %s", key) + } + + ctx, cancel := context.WithTimeout(br.ctx, Z2M_UPDATE_TIMEOUT) + defer cancel() + + log.Printf("updating Z2M state %q -> %+v", prop, expVal) + br.PublishState(dev, map[string]any{prop: expVal}) + +wait: + for { + select { + case updatedVal := <-ch: + if BRIDGE_DEBUG { + log.Printf("received value %q (expected %q) for %s", updatedVal, expVal, key) + } + if updatedVal == expVal { + updated = true + break wait + } + + case <-ctx.Done(): + break wait + } + } + + //br.updateListeners.CompareAndDelete(key, ch) // needs go 1.20 + br.updateListeners.Delete(key) + + if !updated { + err = ErrUpdateTimeout + } + return updated, err +} + +// Publish to the MQTT broker for the specific device +func (br *Bridge) PublishState(dev *Device, payload map[string]any) error { + topic := MQTT_TOPIC_PREFIX + dev.FriendlyName + "/set" + jsonPayload, err := json.Marshal(payload) + if err != nil { + return err + } + + if BRIDGE_DEBUG { + log.Printf("publishing %q payload %s", topic, jsonPayload) + } + + br.mqttClient.Publish(topic, 0, false, jsonPayload) + return nil +} + +// Handle MQTT message to update accessory state +func (br *Bridge) UpdateAccessoryState(devName string, payload []byte) { + dev := br.devices[devName] + if dev == nil { + // skip unknown device + //log.Printf("unknown device %q", devName) + return + } + + if BRIDGE_DEBUG { + log.Printf("received update for device %q", devName) + } + + var newState map[string]any + err := json.Unmarshal([]byte(payload), &newState) + if err != nil { + log.Printf("unable to parse JSON payload: %v", err) + return + } + + for prop, mapping := range dev.Mappings { + newVal, exists := newState[prop] + if !exists { + continue + } + + // send updates via channel if requested + if mapping.ExposesEntry.IsSettable() { + updateKey := makeUpdateKey(dev.Device, mapping) + if ch, waiting := br.updateListeners.Load(updateKey); waiting { + if BRIDGE_DEBUG { + log.Printf("sending new value for %q via chan", updateKey) + } + select { + case ch.(chan any) <- newVal: + default: + // couldn't send message + log.Printf("cannot deliver updated value via channel") + } + + continue // next property + } + } + + // update value into Characteristic + if BRIDGE_DEBUG { + log.Printf("updating %q to %+v", prop, newVal) + } + _, errCode := mapping.SetCharacteristicValue(newVal) + if errCode != 0 { + log.Printf("unable to update characteristic value for %q: %d", prop, errCode) + } + } +} diff --git a/cmd/hapz2m/main.go b/cmd/hapz2m/main.go new file mode 100644 index 0000000..8497558 --- /dev/null +++ b/cmd/hapz2m/main.go @@ -0,0 +1,102 @@ +package main + +import ( + "hapz2m" + + "context" + "encoding/json" + "flag" + "fmt" + "log" + "net/http" + "os" + "os/signal" + "regexp" + "syscall" +) + +var ( + // matches whole line comments in config file + CONFIG_COMMENTS_RE = regexp.MustCompile(`(?m)^\s*//.*$`) + + // for MQTT server URI validation + SERVER_URL_RE = regexp.MustCompile(`^[a-z]+://.*:[0-9]{1,5}$`) +) + +var ( + configFile = flag.String("config", "/etc/hapz2m.conf", "config file") + dbPath = flag.String("db", "/var/lib/hapz2m", "db path") +) + +type config struct { + Server, Username, Password string +} + +func parseConfig(fname string) (cfg *config, err error) { + cfgStr, err := os.ReadFile(fname) + if err != nil { + return + } + + // remove line comments, json.Unmarshal can't parse them + cfgStr = CONFIG_COMMENTS_RE.ReplaceAllLiteral(cfgStr, []byte{}) + + cfg = &config{} + if err = json.Unmarshal(cfgStr, cfg); err != nil { + return + } + + // sanity check + if cfg.Server == "" { + err = fmt.Errorf("MQTT server not specified") + } else if !SERVER_URL_RE.MatchString(cfg.Server) { + err = fmt.Errorf("invalid MQTT server: needs to be in URL format with port") + } + + return +} + +func main() { + flag.Parse() + + cfg, err := parseConfig(*configFile) + if err != nil { + log.Fatalf("config file error: %v", err) + } + + ctx, shutdown := context.WithCancel(context.Background()) + + br := hapz2m.NewBridge(ctx, *dbPath) + br.Server = cfg.Server + br.Username = cfg.Username + br.Password = cfg.Password + + err = br.ConnectMQTT() + if err != nil { + log.Printf("cannot connect to MQTT: %s", err) + return + } + + // listen for termination signals + c := make(chan os.Signal, 1) // use `1` here to appear go vet: https://github.com/golang/go/issues/45604 + signal.Notify(c, os.Interrupt) + signal.Notify(c, syscall.SIGTERM) + go func() { + <-c + signal.Stop(c) + shutdown() + }() + + br.WaitConfigured() + + log.Println("hapz2m configured. starting HAP server...") + + err = br.StartHAP() + if err != nil { + if err == http.ErrServerClosed { + log.Printf("HAP server was shutdown") + } else { + log.Printf("error starting server: %v", err) + } + } +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..e9adf66 --- /dev/null +++ b/go.mod @@ -0,0 +1,24 @@ +module hapz2m + +go 1.20 + +require ( + github.com/brutella/hap v0.0.26-0.20230413145315-4d1fbc179bbb + github.com/eclipse/paho.mqtt.golang v1.4.2 +) + +require ( + github.com/brutella/dnssd v1.2.6 // indirect + github.com/go-chi/chi v1.5.4 // indirect + github.com/gorilla/websocket v1.4.2 // indirect + github.com/miekg/dns v1.1.53 // indirect + github.com/tadglines/go-pkgs v0.0.0-20210623144937-b983b20f54f9 // indirect + github.com/xiam/to v0.0.0-20200126224905-d60d31e03561 // indirect + golang.org/x/crypto v0.8.0 // indirect + golang.org/x/mod v0.10.0 // indirect + golang.org/x/net v0.9.0 // indirect + golang.org/x/sync v0.1.0 // indirect + golang.org/x/sys v0.7.0 // indirect + golang.org/x/text v0.9.0 // indirect + golang.org/x/tools v0.8.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..6d40869 --- /dev/null +++ b/go.sum @@ -0,0 +1,86 @@ +github.com/brutella/dnssd v1.2.6 h1:/0P13JkHLRzeLQkWRPEn4hJCr4T3NfknIFw3aNPIC34= +github.com/brutella/dnssd v1.2.6/go.mod h1:JoW2sJUrmVIef25G6lrLj7HS6Xdwh6q8WUIvMkkBYXs= +github.com/brutella/hap v0.0.26-0.20230413145315-4d1fbc179bbb h1:Pfh+FPHinTvHjGjvf3xW+IrJl+FL1tAZOlW2l2sWQ2g= +github.com/brutella/hap v0.0.26-0.20230413145315-4d1fbc179bbb/go.mod h1:jq5zNqV0/sUSWnYQ9hBUDDXGfBiZJm1TtnptNw02PfI= +github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/eclipse/paho.mqtt.golang v1.4.2 h1:66wOzfUHSSI1zamx7jR6yMEI5EuHnT1G6rNA5PM12m4= +github.com/eclipse/paho.mqtt.golang v1.4.2/go.mod h1:JGt0RsEwEX+Xa/agj90YJ9d9DH2b7upDZMK9HRbFvCA= +github.com/go-chi/chi v1.5.4 h1:QHdzF2szwjqVV4wmByUnTcsbIg7UGaQ0tPF2t5GcAIs= +github.com/go-chi/chi v1.5.4/go.mod h1:uaf8YgoFazUOkPBG7fxPftUylNumIev9awIWOENIuEg= +github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc= +github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/miekg/dns v1.1.50/go.mod h1:e3IlAVfNqAllflbibAZEWOXOQ+Ynzk/dDozDxY7XnME= +github.com/miekg/dns v1.1.53 h1:ZBkuHr5dxHtB1caEOlZTLPo7D3L3TWckgUUs/RHfDxw= +github.com/miekg/dns v1.1.53/go.mod h1:uInx36IzPl7FYnDcMeVWxj9byh7DutNykX4G9Sj60FY= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/tadglines/go-pkgs v0.0.0-20210623144937-b983b20f54f9 h1:aeN+ghOV0b2VCmKKO3gqnDQ8mLbpABZgRR2FVYx4ouI= +github.com/tadglines/go-pkgs v0.0.0-20210623144937-b983b20f54f9/go.mod h1:roo6cZ/uqpwKMuvPG0YmzI5+AmUiMWfjCBZpGXqbTxE= +github.com/xiam/to v0.0.0-20200126224905-d60d31e03561 h1:SVoNK97S6JlaYlHcaC+79tg3JUlQABcc0dH2VQ4Y+9s= +github.com/xiam/to v0.0.0-20200126224905-d60d31e03561/go.mod h1:cqbG7phSzrbdg3aj+Kn63bpVruzwDZi58CpxlZkjwzw= +github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.0.0-20220131195533-30dcbda58838/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.8.0 h1:pd9TJtTueMTVQXzk8E2XESSMQDj/U7OUu0PqJqPXQjQ= +golang.org/x/crypto v0.8.0/go.mod h1:mRqEX+O9/h5TFCrQhkgjo2yKi0yYA+9ecGkdQoHrywE= +golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.10.0 h1:lFO9qtOdlre5W1jxS3r/4szv2/6iXxScdzjoBMXNhYk= +golang.org/x/mod v0.10.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20200425230154-ff2c4b7c35a0/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= +golang.org/x/net v0.0.0-20210726213435-c6fcb2dbf985/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.9.0 h1:aWJ/m6xSmxWBx+V0XRHTlrYrPG56jKsLdTFmsSsCzOM= +golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.7.0 h1:3jlCCIQZPdOYu1h8BkNvLz8Kgwtae2cagcG/VamtZRU= +golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= +golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.6-0.20210726203631-07bc1bf47fb2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.8.0 h1:vSDcovVPld282ceKgDimkRSC8kpaH1dgyc9UMzlt84Y= +golang.org/x/tools v0.8.0/go.mod h1:JxBZ99ISMI5ViVkT1tr6tdNmXeTrcpVSD3vZ1RsRdN4= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/hapz2m.conf b/hapz2m.conf new file mode 100644 index 0000000..f868ec0 --- /dev/null +++ b/hapz2m.conf @@ -0,0 +1,6 @@ +{ + // MQTT server credentials + "Server": "tcp://localhost:1883", + "Username": "hapz2m", + "Password": "my_s3cr3t_PasSw0rd" +} diff --git a/s_battery.go b/s_battery.go new file mode 100644 index 0000000..ed21b92 --- /dev/null +++ b/s_battery.go @@ -0,0 +1,34 @@ +package hapz2m + +import ( + "github.com/brutella/hap/accessory" + "github.com/brutella/hap/characteristic" + "github.com/brutella/hap/service" +) + +func createBatteryServices(dev *Device) (byte, []*service.S, []*ExposeMapping, error) { + var svcs []*service.S + var exposes []*ExposeMapping + + for _, exp := range dev.Definition.Exposes { + if exp.Ignored() { + continue + } + + switch { + case exp.Type == "numeric" && exp.Name == "battery": + exp := exp // create a copy + batt := service.NewBatteryService() + batt.ChargingState.SetValue(characteristic.ChargingStateNotChargeable) + + svcs = append(svcs, batt.S) + exposes = append(exposes, &ExposeMapping{&exp, batt.BatteryLevel.C, nil}) + } + } + + return accessory.TypeUnknown, svcs, exposes, nil +} + +func init() { + RegisterCreateServiceHandler(createBatteryServices) +} diff --git a/s_climate_sensors.go b/s_climate_sensors.go new file mode 100644 index 0000000..fdb4f59 --- /dev/null +++ b/s_climate_sensors.go @@ -0,0 +1,53 @@ +package hapz2m + +import ( + "github.com/brutella/hap/accessory" + "github.com/brutella/hap/service" +) + +func createClimateServices(dev *Device) (byte, []*service.S, []*ExposeMapping, error) { + var svcs []*service.S + var exposes []*ExposeMapping + + for _, exp := range dev.Definition.Exposes { + if exp.Ignored() { + continue + } + + // climate sensors are numeric only + if exp.Type != "numeric" { + continue + } + + exp := exp // create a copy + + switch { + case exp.Name == "temperature": + s := service.NewTemperatureSensor() + + // doesn't do anything, since the Home app seem to round values to 0.25 increments regardless + // https://developer.apple.com/forums/thread/674461 + // https://github.com/home-assistant/core/issues/45332 + s.CurrentTemperature.SetStepValue(0.01) + + svcs = append(svcs, s.S) + exposes = append(exposes, &ExposeMapping{&exp, s.CurrentTemperature.C, nil}) + + case exp.Name == "humidity": + s := service.NewHumiditySensor() + s.CurrentRelativeHumidity.SetStepValue(0.01) // ditto, but 1% increments + svcs = append(svcs, s.S) + exposes = append(exposes, &ExposeMapping{&exp, s.CurrentRelativeHumidity.C, nil}) + + case exp.Name == "pressure": + // TODO looks like pressure is not standard in HomeKit + // Eve has custom UUIDs: https://gist.github.com/simont77/3f4d4330fa55b83f8ca96388d9004e7d + } + } + + return accessory.TypeSensor, svcs, exposes, nil +} + +func init() { + RegisterCreateServiceHandler(createClimateServices) +} diff --git a/s_contact_sensor.go b/s_contact_sensor.go new file mode 100644 index 0000000..bec083b --- /dev/null +++ b/s_contact_sensor.go @@ -0,0 +1,37 @@ +package hapz2m + +import ( + "github.com/brutella/hap/accessory" + "github.com/brutella/hap/characteristic" + "github.com/brutella/hap/service" +) + +func createContactServices(dev *Device) (byte, []*service.S, []*ExposeMapping, error) { + var svcs []*service.S + var exposes []*ExposeMapping + + for _, exp := range dev.Definition.Exposes { + if exp.Ignored() { + continue + } + + switch { + case exp.Type == "binary" && exp.Name == "contact": + exp := exp // create a copy + + s := service.NewContactSensor() + + svcs = append(svcs, s.S) + exposes = append(exposes, &ExposeMapping{&exp, s.ContactSensorState.C, + &BoolTranslator{ + characteristic.ContactSensorStateContactNotDetected, + characteristic.ContactSensorStateContactDetected}}) + } + } + + return accessory.TypeSensor, svcs, exposes, nil +} + +func init() { + RegisterCreateServiceHandler(createContactServices) +} diff --git a/s_switch.go b/s_switch.go new file mode 100644 index 0000000..75434b6 --- /dev/null +++ b/s_switch.go @@ -0,0 +1,51 @@ +package hapz2m + +import ( + "github.com/brutella/hap/accessory" + "github.com/brutella/hap/characteristic" + "github.com/brutella/hap/service" + + "regexp" +) + +var outletRegex = regexp.MustCompile(`(?i)\boutlet\b`) + +func createSwitchServices(dev *Device) (byte, []*service.S, []*ExposeMapping, error) { + var svcs []*service.S + var exposes []*ExposeMapping + + for _, exp := range dev.Definition.Exposes { + if exp.Ignored() { + continue + } + + switch { + case exp.Type == "switch" && len(exp.Features) > 0: + exp := exp // create a copy + + f := exp.Features[0] + if f.Name == "state" && f.Type == "binary" && f.IsStateSetGet() { + sw := service.NewSwitch() + + // add a name/label for this switch + n := characteristic.NewName() + n.SetValue(f.Endpoint) + sw.AddC(n.C) + + svcs = append(svcs, sw.S) + exposes = append(exposes, &ExposeMapping{&f, sw.On.C, nil}) + } + } + } + + accTyp := accessory.TypeSwitch + if outletRegex.MatchString(dev.Definition.Description) { + accTyp = accessory.TypeOutlet + } + + return accTyp, svcs, exposes, nil +} + +func init() { + RegisterCreateServiceHandler(createSwitchServices) +} diff --git a/z2m.go b/z2m.go new file mode 100644 index 0000000..a43e99c --- /dev/null +++ b/z2m.go @@ -0,0 +1,432 @@ +package hapz2m + +import ( + "encoding/json" + "fmt" + "regexp" + + "reflect" + "runtime" + + "github.com/brutella/hap/accessory" + "github.com/brutella/hap/characteristic" + "github.com/brutella/hap/service" +) + +const Z2M_DEBUG = false + +// exposed properties to ignore +var IgnoreProperties = map[string]bool{ + "linkquality": true, + "device_temperature": true, +} + +var ( + ErrDeviceSkipped = fmt.Errorf("device is skipped") + ErrMalfomedDevice = fmt.Errorf("device is malformed") + + ErrNotNumericCharacteristic = fmt.Errorf("characteristic is non-numeric") +) + +// Creates a HAP Accessory from a Z2M Device +// It may return ErrDeviceSkipped if the device is not supported or still being interviewed. +func createAccessory(dev *Device) (*accessory.A, []*ExposeMapping, error) { + if dev.Disabled || + !dev.Supported || + !dev.InterviewCompleted { + return nil, nil, ErrDeviceSkipped + } + + if dev.Definition == nil { + return nil, nil, ErrMalfomedDevice + } + + // check that network address is not zero + // we use this for accessory ID + if dev.NetworkAddress == 0 { + return nil, nil, ErrMalfomedDevice + } + + if Z2M_DEBUG { + fmt.Printf("%s %s %d\n", dev.Definition.Model, dev.Definition.Vendor, dev.NetworkAddress) + for _, exp := range dev.Definition.Exposes { + ignored := "" + if exp.Ignored() { + ignored = " [ignored]" + } + + fmt.Printf(" - %s: %d %s %s%s\n", exp.Type, exp.Access, exp.Name, exp.Property, ignored) + if exp.Type == "enum" { + fmt.Printf(" %+v\n", exp.Values) + } + } + } + + // remove "0x" prefix of address for serial number + serialNum := dev.IEEEAddress + if len(serialNum) > 5 && serialNum[0] == '0' && serialNum[1] == 'x' { + serialNum = serialNum[2:] + } + + // create accessory first, then see if any handler wants to modify it + acc := accessory.New(accessory.Info{ + Name: dev.Definition.Description, + SerialNumber: serialNum, + Manufacturer: dev.Manufacturer, + Model: dev.Definition.Model, + Firmware: dev.SoftwareBuildId, + }, accessory.TypeUnknown) + + // use network address as accessory ID + acc.Id = uint64(dev.NetworkAddress) + + var guessedAccTypes []byte + var allSvcs []*service.S + var allExposes []*ExposeMapping + + for _, createFunc := range createServiceHandlers { + accType, svcs, exposes, err := createFunc(dev) + if err != nil { + panic(err) + } + + if Z2M_DEBUG { + f := runtime.FuncForPC(reflect.ValueOf(createFunc).Pointer()) + fmt.Printf("----- %s -----\n", f.Name()) + + if accType != accessory.TypeUnknown { + fmt.Printf("typ: %#v\n", accType) + } + fmt.Print("svc: [") + for _, s := range svcs { + fmt.Printf("%+v", s) + } + fmt.Println("]") + + fmt.Print("exp: [") + for _, e := range exposes { + fmt.Printf("%+v", e) + } + fmt.Println("]") + } + + if accType != accessory.TypeUnknown && len(svcs) > 0 && len(exposes) > 0 { + guessedAccTypes = append(guessedAccTypes, accType) + } + + allSvcs = append(allSvcs, svcs...) + allExposes = append(allExposes, exposes...) + } + + // copy value ranges + for _, e := range allExposes { + if e.ExposesEntry.Type != "numeric" { + continue + } + + err := e.ExposesEntry.CopyValueRanges(e.Characteristic) + if err != nil { + return nil, nil, fmt.Errorf("cant copy value ranges for %s to cfmt %s: %s", + e.ExposesEntry.Property, e.Characteristic.Type, err) + } + } + + // guess main accessory type + // XXX in case of tie? + uniqAccTypes := uniq(guessedAccTypes) + if len(uniqAccTypes) == 1 { + acc.Type = uniqAccTypes[0] + } + + // add services to accessory + for _, s := range allSvcs { + acc.AddS(s) + } + + return acc, allExposes, nil +} + +var ( + accPermsFormattingRE = regexp.MustCompile(`(?isU)"perms":\s*\[.*\]`) + accPermsWhitespaceRE = regexp.MustCompile(`( \[|,)?\s*(\S)(\])?`) +) + +// Dumps the Accessory structure +func dumpAccessory(acc *accessory.A) error { + s, err := json.MarshalIndent(acc, "", " ") + if err != nil { + return err + } + + // performs some formatting to keep "perms" on a single-line to reduce space + s = accPermsFormattingRE.ReplaceAllFunc(s, func(s []byte) []byte { + return accPermsWhitespaceRE.ReplaceAll(s, []byte("$1$2$3")) + }) + + fmt.Println(string(s)) + return nil +} + +// Returns unique items from the slice +func uniq[T comparable](items []T) []T { + m := make(map[T]bool) + for _, e := range items { + m[e] = true + } + u := make([]T, len(m)) + i := 0 + for k := range m { + u[i] = k + i++ + } + return u +} + +// Implements a translator between the exposed property and Characteristic +type MappingTranslator interface { + ToCharacteristicValue(exposedValue any) (cValue any, err error) + ToExposedValue(cValue any) (exposedValue any, err error) +} + +// Default pass-through "translator", where both exposed and Characteristic +// values are of the same or similar types. +type PassthruTranslator struct{} + +var defaultTranslator = &PassthruTranslator{} + +func (p *PassthruTranslator) ToExposedValue(v any) (any, error) { return v, nil } +func (p *PassthruTranslator) ToCharacteristicValue(v any) (any, error) { return v, nil } + +var ErrTranslationError = fmt.Errorf("cannot translate value") + +// Translates a "binary" type exposed value to arbitrary Characteristic values +type BoolTranslator struct{ TrueValue, FalseValue any } + +func (t *BoolTranslator) ToExposedValue(cVal any) (any, error) { + switch cVal { + case t.TrueValue: + return true, nil + + case t.FalseValue: + return false, nil + } + return nil, ErrTranslationError +} + +func (t *BoolTranslator) ToCharacteristicValue(eVal any) (any, error) { + bVal, ok := eVal.(bool) + if !ok { + return nil, ErrTranslationError + } else if bVal { + return t.TrueValue, nil + } + return t.FalseValue, nil +} + +////////////////////////////// + +// Maps a zigbee2mqtt device property into a HAP characteristic. +// Contains convenience methods to translate values between the two systems. +// z2m "binary" types are inherently translated to bool using the ValueOn/Off properties defined, +// so no translator is required for that. +// A MappingTranslator is required if the values are not pass-through (like float to float, or float to int). +// An example is the ContactSensor, where HAP defines contact as [0, 1] instead of a bool ("binary"). +// The BoolTranslator assists with this by providing true & false values that correspond to a bool. +type ExposeMapping struct { + ExposesEntry *ExposesEntry + Characteristic *characteristic.C + + Translator MappingTranslator +} + +func (m *ExposeMapping) String() string { + return fmt.Sprintf("{%q,%s -> ctyp %s}", + m.ExposesEntry.Name, m.ExposesEntry.Type, m.Characteristic.Type) +} + +// Converts a Characteristic value to its corresponding z2m value +func (m *ExposeMapping) ToExposedValue(v any) (any, error) { + t := m.Translator + if t == nil { + t = defaultTranslator + } + + expVal, err := t.ToExposedValue(v) + if err != nil { + return expVal, err + } + + // additional mapping is required for "binary" types to ValueOn/Off + if m.ExposesEntry.Type == "binary" { + b, isbool := expVal.(bool) + if !isbool { + return expVal, fmt.Errorf("translated value for binary type is not bool: %[1]T %[1]v", expVal) + } + + expVal = m.ExposesEntry.ValueOff + if b { + expVal = m.ExposesEntry.ValueOn + } + } + return expVal, err +} + +// Calls c.SetValueRequest() with the translated exposed value +// if the error code is -1, there was a translation error. +// Otherwise it's a HAP error code +func (m *ExposeMapping) SetCharacteristicValue(v any) (any, int) { + t := m.Translator + if t == nil { + t = defaultTranslator + } + + // mapping for "binary" types to bool + if m.ExposesEntry.Type == "binary" { + switch v { + case m.ExposesEntry.ValueOn: + v = true + case m.ExposesEntry.ValueOff: + v = false + default: + return v, -1 + } + } + + cv, err := t.ToCharacteristicValue(v) + if err != nil { + return v, -1 + } + + return m.Characteristic.SetValueRequest(cv, nil) +} + +////////////////////////////// + +// Function that creates services from a z2m Device, invoked by createAccessory() +// These functions are registered using RegisterCreateServiceHandler() +type CreateServiceFunc func(dev *Device) (byte, []*service.S, []*ExposeMapping, error) + +// Registers a CreateServiceFunc for use by createAccessory() +func RegisterCreateServiceHandler(f CreateServiceFunc) { + createServiceHandlers = append(createServiceHandlers, f) +} + +// registered createService handlers +var createServiceHandlers []CreateServiceFunc + +////////////////////////////// + +type Device struct { + FriendlyName string `json:"friendly_name"` + IEEEAddress string `json:"ieee_address"` + InterviewCompleted bool `json:"interview_completed"` + Interviewing bool `json:"interviewing"` + Manufacturer string `json:"manufacturer"` + ModelId string `json:"model_id"` + NetworkAddress int `json:"network_address"` + PowerSource string `json:"power_source"` + SoftwareBuildId string `json:"software_build_id"` + DateCode string `json:"date_code"` + + Definition *DevDefinition `json:"definition"` + + Disabled bool `json:"disabled"` + Supported bool `json:"supported"` + Type string `json:"type"` +} + +type DevDefinition struct { + Description string `json:"description"` + Model string `json:"model"` + Vendor string `json:"vendor"` + Exposes []ExposesEntry `json:"exposes"` +} + +type ExposesEntry struct { + Access int `json:"access"` + Description string `json:"description"` + Name string `json:"name"` + Property string `json:"property"` + Type string `json:"type"` + Unit string `json:"unit"` + Endpoint string `json:"endpoint"` + + Features []ExposesEntry `json:"features"` + + // values + Values []string `json:"values"` + + ValueOn any `json:"value_on"` + ValueOff any `json:"value_off"` + + ValueMax *float64 `json:"value_max"` + ValueMin *float64 `json:"value_min"` + ValueStep *float64 `json:"value_step"` +} + +func (e *ExposesEntry) Ignored() bool { return IgnoreProperties[e.Name] } + +// https://github.com/Koenkk/zigbee-herdsman-converters/blob/v15.0.0/lib/exposes.js#L458-L486 +func (e *ExposesEntry) IsStateSetGet() bool { return e.Access == 0b111 } +func (e *ExposesEntry) IsSettable() bool { return e.Access&0b10 == 0b10 } + +// Updates MinVal, MaxVal and StepVal for the Characteristic +func (e *ExposesEntry) CopyValueRanges(c *characteristic.C) error { + // ensure characteristic has a numeric type + switch c.Format { + case characteristic.FormatFloat, characteristic.FormatUInt8, + characteristic.FormatUInt16, characteristic.FormatUInt32, + characteristic.FormatUInt64, characteristic.FormatInt32: + break + + default: + return ErrNotNumericCharacteristic + } + + if err := copyToCVal(e.ValueMin, &c.MinVal, c.Format); err != nil { + return err + } + + if err := copyToCVal(e.ValueMax, &c.MaxVal, c.Format); err != nil { + return err + } + + if err := copyToCVal(e.ValueStep, &c.StepVal, c.Format); err != nil { + return err + } + + return nil +} + +func floatToCVal(v float64, cfmt string) (any, error) { + switch cfmt { + case characteristic.FormatFloat: + return v, nil + + case characteristic.FormatInt32: + return int(v), nil + + case characteristic.FormatUInt8, characteristic.FormatUInt16, + characteristic.FormatUInt32, characteristic.FormatUInt64: + if v < 0 { + return 0, fmt.Errorf("cant convert %v to %s", v, cfmt) + } + return int(v), nil + + default: + return 0, fmt.Errorf("unknown C value type %s\n", cfmt) + } +} + +func copyToCVal(v *float64, targetCVal *any, cfmt string) error { + if v == nil { + return nil + } + + cv, err := floatToCVal(*v, cfmt) + if err == nil { + *targetCVal = cv + } + + return err +} diff --git a/z2m_test.go b/z2m_test.go new file mode 100644 index 0000000..78fa57d --- /dev/null +++ b/z2m_test.go @@ -0,0 +1,217 @@ +package hapz2m + +import ( + "encoding/json" + "testing" + + "github.com/brutella/hap/characteristic" + "github.com/brutella/hap/service" +) + +const ContactSensor = `{ + "date_code": "20161128", + "definition": { + "description": "Aqara door & window contact sensor", + "exposes": [ + { + "access": 1, + "description": "Remaining battery in %, can take up to 24 hours before reported.", + "name": "battery", + "property": "battery", + "type": "numeric", + "unit": "%", + "value_max": 100, + "value_min": 0 + }, + { + "access": 1, + "description": "Indicates if the contact is closed (= true) or open (= false)", + "name": "contact", + "property": "contact", + "type": "binary", + "value_off": true, + "value_on": false + }, + { + "access": 1, + "description": "Temperature of the device", + "name": "device_temperature", + "property": "device_temperature", + "type": "numeric", + "unit": "°C" + }, + { + "access": 1, + "description": "Voltage of the battery in millivolts", + "name": "voltage", + "property": "voltage", + "type": "numeric", + "unit": "mV" + }, + { + "access": 1, + "description": "Number of power outages", + "name": "power_outage_count", + "property": "power_outage_count", + "type": "numeric" + }, + { + "access": 1, + "description": "Link quality (signal strength)", + "name": "linkquality", + "property": "linkquality", + "type": "numeric", + "unit": "lqi", + "value_max": 255, + "value_min": 0 + } + ], + "model": "MCCGQ11LM", + "options": [ + { + "access": 2, + "description": "Calibrates the device_temperature value (absolute offset), takes into effect on next report of device.", + "name": "device_temperature_calibration", + "property": "device_temperature_calibration", + "type": "numeric" + } + ], + "supports_ota": false, + "vendor": "Xiaomi" + }, + "disabled": false, + "endpoints": { + "1": { + "bindings": [], + "clusters": { + "input": [ + "genBasic", + "genIdentify", + "65535", + "genOnOff" + ], + "output": [ + "genBasic", + "genGroups", + "65535" + ] + }, + "configured_reportings": [], + "scenes": [] + } + }, + "friendly_name": "0x00158d00aabbccdd", + "ieee_address": "0x00158d00aabbccdd", + "interview_completed": true, + "interviewing": false, + "manufacturer": "LUMI", + "model_id": "lumi.sensor_magnet.aq2", + "network_address": 18350, + "power_source": "Battery", + "software_build_id": "3000-0001", + "supported": true, + "type": "EndDevice" + }` + +func TestCreateAccessory(t *testing.T) { + var dev Device + err := json.Unmarshal([]byte(ContactSensor), &dev) + if err != nil { + panic(err) + } + + acc, exp, err := createAccessory(&dev) + if err != nil { + t.Fatal(err) + } + dumpAccessory(acc) + _ = exp +} + +func exposeMappingFromJson(jstr string) *ExposesEntry { + exp := &ExposesEntry{} + err := json.Unmarshal([]byte(jstr), &exp) + if err != nil { + panic(err) + } + return exp +} + +func TestMappingTranslation(t *testing.T) { + exp := exposeMappingFromJson(`{ + "access": 1, + "name": "contact", + "property": "contact", + "type": "binary", + "value_off": "NO_CONTACT", + "value_on": "CONTACT" + }`) + + s := service.NewContactSensor() + m := &ExposeMapping{exp, s.ContactSensorState.C, + &BoolTranslator{ + characteristic.ContactSensorStateContactDetected, + characteristic.ContactSensorStateContactNotDetected}} + + for _, test := range []struct{ e, c any }{ + {"CONTACT", characteristic.ContactSensorStateContactDetected}, + {"NO_CONTACT", characteristic.ContactSensorStateContactNotDetected}, + } { + v, errCode := m.SetCharacteristicValue(test.e) + t.Logf("exposed = %+v, v = %+v", test.e, v) + if errCode != 0 { + t.Fatalf("cant set cvalue, err %d", errCode) + } + + newV := m.Characteristic.Val + if newV != test.c { + t.Fatalf("characteristic value was wrong. wanted %v got %v", test.c, v) + } + } + if _, errCode := m.SetCharacteristicValue("NO_CONTACTSS"); errCode != -1 { + t.Fatalf("expected translation error, but errCode was %d", errCode) + } +} + +func TestMappingNumeric(t *testing.T) { + exp := exposeMappingFromJson(`{ + "access": 1, + "name": "Temperature", + "property": "temperature", + "type": "numeric", + "unit": "°C" + }`) + + s := service.NewTemperatureSensor() + m := &ExposeMapping{exp, s.CurrentTemperature.C, nil} + + for _, test := range []struct { + v any + desc string + }{ + {10.0, "temp 10.0"}, + {10.5, "temp 10.5"}, + {0.5, "temp 0.5"}, + {0., "temp 0"}, + } { + _, errCode := m.SetCharacteristicValue(test.v) + if errCode != 0 { + t.Fatalf("errCode for %s: %d", test.desc, errCode) + } + cv := s.CurrentTemperature.Value() + t.Logf("%s: ctemp %f", test.desc, cv) + + if test.v != cv { + t.Fatalf("%s mismatch. want %f, got %f", test.desc, test.v, cv) + } + + ev, err := m.ToExposedValue(cv) + if err != nil { + t.Fatalf("err converting back %s: %v", test.desc, err) + } + + if ev != test.v { + t.Fatalf("%s reverse: want %f, got %f", test.desc, test.v, ev) + } + } +}