diff --git a/LICENSE b/LICENSE index f3c0954..94a9ed0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Copyright (c) 2017 Fredrik Öhrström + 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. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + Preamble -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + The GNU General Public License is a free, copyleft license for +software and other kinds of works. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + 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/Makefile b/Makefile index 096b4d6..0e86d8d 100644 --- a/Makefile +++ b/Makefile @@ -35,6 +35,7 @@ $(BUILD)/%.o: %.cc $(wildcard %.h) METERS_OBJS:=\ $(BUILD)/aes.o \ $(BUILD)/cmdline.o \ + $(BUILD)/dvparser.o \ $(BUILD)/main.o \ $(BUILD)/meters.o \ $(BUILD)/meter_multical21.o \ diff --git a/README.md b/README.md index a46bace..d4a4e6f 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,8 @@ http://www.multical.hu/WiredMBus-water.pdf http://uu.diva-portal.org/smash/get/diva2:847898/FULLTEXT02.pdf +http://projekter.aau.dk/projekter/da/studentthesis/wireless-mbus-based-extremely-low-power-protocol-for-wireless-communication-with-water-meters(6e1139d5-6f24-4b8a-a727-9bc108012bcc).html + The AES source code is copied from: https://github.com/kokke/tiny-AES128-C diff --git a/cmdline.cc b/cmdline.cc index 6896c30..4eae725 100644 --- a/cmdline.cc +++ b/cmdline.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017 Fredrik Öhrström + + 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 . +*/ #include"cmdline.h" #include"meters.h" diff --git a/cmdline.h b/cmdline.h index cc72426..127dd22 100644 --- a/cmdline.h +++ b/cmdline.h @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017 Fredrik Öhrström + + 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 . +*/ #ifndef CMDLINE_H #define CMDLINE_H diff --git a/dvparser.cc b/dvparser.cc new file mode 100644 index 0000000..41f3adc --- /dev/null +++ b/dvparser.cc @@ -0,0 +1,214 @@ +/* + Copyright (C) 2018 Fredrik Öhrström + + 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 . +*/ + +#include"dvparser.h" +#include"util.h" + +using namespace std; + +bool parseDV(Telegram *t, + vector::iterator data, + size_t data_len, + map> *values, + vector::iterator *format, + size_t format_len, + uint16_t *format_hash) +{ + map dv_count; + vector format_bytes; + vector data_bytes; + string dv, key; + size_t parsed_len = t->parsed.size(); + vector::iterator data_start = data; + vector::iterator data_end = data+data_len; + vector::iterator format_end; + bool full_header = false; + + if (format == NULL) { + format = &data; + format_end = data_end; + full_header = true; + } else { + format_end = *format+format_len; + string s = bin2hex(*format, format_len); + debug("(dvparser) using format \"%s\"\n", s.c_str()); + } + + // Data format is: + // DIF byte (defines how the binary data bits should be decoded and how man data bytes there are) + // (sometimes a DIFE byte, not yet implemented) + // VIF byte (defines what the decoded value means, water,energy,power,etc.) + // (sometimes a VIFE byte when VIF=0xff) + // Data bytes + // DIF again... + + // A DifVif(Vife) tuple (triplet) can be for example be 02FF20 for Multical21 vendor specific status bits. + // The parser stores the data bytes under the key "02FF20" for the first occurence of the 02FF20 data. + // The second identical tuple(triplet) stores its data under the key "02FF20_2" + + format_bytes.clear(); + for (;;) { + if (*format == format_end) break; + uchar dif = **format; + int len = difLenBytes(dif); + if (full_header) { + format_bytes.push_back(dif); + t->addExplanation(*format, 1, "%02X dif (%s)", dif, difType(dif).c_str()); + } else { + (*format)++; + } + + if (*format == format_end) { warning("(dvparser) warning: unexpected end of data (vif expected)"); break; } + + uchar vif = **format; + if (full_header) { + format_bytes.push_back(vif); + t->addExplanation(*format, 1, "%02X vif (%s)", vif, vifType(vif).c_str()); + } else { + (*format)++; + } + + strprintf(dv, "%02X%02X", dif, vif); + if ((vif&0x80) == 0x80) { + // vif extension + if (*format == format_end) { warning("(dvparser) warning: unexpected end of data (vife expected)"); break; } + uchar vife = **format; + if (full_header) { + format_bytes.push_back(vife); + t->addExplanation(*format, 1, "%02X vife (%s)", vife, vifeType(vif, vife).c_str()); + } else { + (*format)++; + } + strprintf(dv, "%02X%02X%02X", dif, vif, vife); + } + + int count = ++dv_count[key]; + if (count > 1) { + strprintf(key, "%s_%d", dv.c_str(), count); + } else { + strprintf(key, "%s", dv.c_str()); + } + + string value = bin2hex(data, len); + (*values)[key] = { parsed_len+data-data_start, value }; + t->addExplanation(data, len, "%s", value.c_str()); + } + + string format_string = bin2hex(format_bytes); + uint16_t hash = crc16_EN13757(&format_bytes[0], format_bytes.size()); + + if (full_header) { + debug("(dvparser) found format \"%s\" with hash %x\n", format_string.c_str(), hash); + } + + return true; +} + +void extractDV(string &s, uchar *dif, uchar *vif, uchar *vife) +{ + vector bytes; + hex2bin(s, &bytes); + + *dif = bytes[0]; + *vif = bytes[1]; + if (bytes.size() > 2) { + *vife = bytes[2]; + } else { + *vife = 0; + } +} + +bool extractDVuint16(map> *values, + string key, + int *offset, + uint16_t *value) +{ + if ((*values).count(key) == 0) { + warning("(dvparser) warning: cannot extract uint16 from non-existant key \"%s\"\n", key.c_str()); + *offset = -1; + *value = 0; + return false; + } + uchar dif, vif, vife; + extractDV(key, &dif, &vif, &vife); + + pair& p = (*values)[key]; + *offset = p.first; + vector v; + hex2bin(p.second, &v); + + *value = v[1]<<8 | v[0]; + return true; +} + +bool extractDVfloat(map> *values, + string key, + int *offset, + float *value) +{ + if ((*values).count(key) == 0) { + warning("(dvparser) warning: cannot extract float from non-existant key \"%s\"\n", key.c_str()); + *offset = 0; + *value = 0; + return false; + } + uchar dif, vif, vife; + extractDV(key, &dif, &vif, &vife); + + pair& p = (*values)[key]; + *offset = p.first; + vector v; + hex2bin(p.second, &v); + + int raw = v[3]*256*256*256 + v[2]*256*256 + v[1]*256 + v[0]; + float scale = vifScale(vif); + *value = ((float)raw) / scale; + + return true; +} + +bool extractDVfloatCombined(std::map> *values, + std::string key_high_bits, // Which key to extract high bits from. + std::string key, + int *offset, + float *value) +{ + if ((*values).count(key) == 0 || (*values).count(key_high_bits) == 0) { + warning("(dvparser) warning: cannot extract combined float since at least one key is missing \"%s\" \"%s\"\n", key.c_str(), + key_high_bits.c_str()); + *offset = 0; + *value = 0; + return false; + } + uchar dif, vif, vife; + extractDV(key, &dif, &vif, &vife); + + pair& p = (*values)[key]; + *offset = p.first; + vector v; + hex2bin(p.second, &v); + + pair& pp = (*values)[key]; + vector v_high; + hex2bin(pp.second, &v_high); + + int raw = v_high[3]*256*256*256 + v_high[2]*256*256 + v[1]*256 + v[0]; + float scale = vifScale(vif); + *value = ((float)raw) / scale; + + return true; +} diff --git a/dvparser.h b/dvparser.h new file mode 100644 index 0000000..9b38273 --- /dev/null +++ b/dvparser.h @@ -0,0 +1,56 @@ +/* + Copyright (C) 2018 Fredrik Öhrström + + 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 . +*/ + +#ifndef DVPARSER_H +#define DVPARSER_H + +#include"util.h" +#include"wmbus.h" + +#include +#include +#include +#include + +// DV stands for DIF VIF + +bool parseDV(Telegram *t, + std::vector::iterator data, + size_t data_len, + std::map> *values, + std::vector::iterator *format = NULL, + size_t format_len = 0, + uint16_t *format_hash = NULL); + +bool extractDVuint16(std::map> *values, + std::string key, + int *offset, + uint16_t *value); + +bool extractDVfloat(std::map> *values, + std::string key, + int *offset, + float *value); + +// Extract low bits from primary entry and hight bits from secondary entry. +bool extractDVfloatCombined(std::map> *values, + std::string key_high_bits, // Which key to extract high bits from. + std::string key, + int *offset, + float *value); + +#endif diff --git a/main.cc b/main.cc index e3640e0..6b7e415 100644 --- a/main.cc +++ b/main.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #include"cmdline.h" #include"meters.h" diff --git a/meter_multical21.cc b/meter_multical21.cc index cc17cec..2d90f23 100644 --- a/meter_multical21.cc +++ b/meter_multical21.cc @@ -1,29 +1,29 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + 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 . +*/ + +#include"dvparser.h" #include"meters.h" #include"meters_common_implementation.h" #include"wmbus.h" #include"wmbus_utils.h" #include"util.h" +#include +#include #include #include #include @@ -79,7 +79,7 @@ private: void processContent(Telegram *t); string decodeTime(int time); - int info_codes_ {}; + uint16_t info_codes_ {}; float total_water_consumption_ {}; bool has_total_water_consumption_ {}; float target_volume_ {}; @@ -125,12 +125,13 @@ bool MeterMultical21::hasMaxFlow() return has_max_flow_; } -WaterMeter *createMultical21(WMBus *bus, const char *name, const char *id, const char *key) { +WaterMeter *createMultical21(WMBus *bus, const char *name, const char *id, const char *key) +{ return new MeterMultical21(bus,name,id,key); } -void MeterMultical21::handleTelegram(Telegram *t) { - +void MeterMultical21::handleTelegram(Telegram *t) +{ if (!isTelegramForMe(t)) { // This telegram is not intended for this meter. return; @@ -167,148 +168,102 @@ void MeterMultical21::handleTelegram(Telegram *t) { triggerUpdate(t); } -float getScaleFactor(int vif) { - switch (vif) { - case 0x13: return 1000.0; - case 0x14: return 100.0; - case 0x15: return 10.0; - case 0x16: return 10.0; - } - warning("(multical21) warning: Unknown vif code %d for scale factor, using 1000.0 instead.\n", vif); - return 1000.0; -} - -void MeterMultical21::processContent(Telegram *t) { - vector full_content; - full_content.insert(full_content.end(), t->parsed.begin(), t->parsed.end()); - full_content.insert(full_content.end(), t->content.begin(), t->content.end()); +void MeterMultical21::processContent(Telegram *t) +{ + vector::iterator bytes = t->content.begin(); int crc0 = t->content[0]; int crc1 = t->content[1]; - t->addExplanation(full_content, 2, "%02x%02x payload crc %02x%02x", crc0, crc1); + t->addExplanation(bytes, 2, "%02x%02x payload crc", crc0, crc1); int frame_type = t->content[2]; - t->addExplanation(full_content, 1, "%02x frame type (%s)", frame_type, frameTypeKamstrupC1(frame_type).c_str()); + t->addExplanation(bytes, 1, "%02x frame type (%s)", frame_type, frameTypeKamstrupC1(frame_type).c_str()); - if (frame_type == 0x79) { + if (frame_type == 0x79) + { if (t->content.size() != 15) { warning("(multical21) warning: Unexpected length of short frame %zu. Expected 15 bytes! ", t->content.size()); - padWithZeroesTo(&t->content, 15, &full_content); + padWithZeroesTo(&t->content, 15, &t->content); warning("\n"); } + + // 0,1 = crc for format signature = hash over DRH (Data Record Header) + // The DRH is the dif(dife)vif(vife) bytes for all the records... + // This hash should be used to pick up a suitable format string. + // Below, DRH is hardcoded to 02FF2004134413 int ecrc0 = t->content[3]; int ecrc1 = t->content[4]; + + // 2,3 = crc for payload = hash over both DRH and data bytes. int ecrc2 = t->content[5]; int ecrc3 = t->content[6]; - t->addExplanation(full_content, 4, "%02x%02x%02x%02x ecrc", ecrc0, ecrc1, ecrc2, ecrc3); - int rec1val0 = t->content[7]; - int rec1val1 = t->content[8]; - int rec2val0 = t->content[9]; - int rec2val1 = t->content[10]; - int rec2val2 = t->content[11]; + t->addExplanation(bytes, 4, "%02x%02x%02x%02x ecrc", ecrc0, ecrc1, ecrc2, ecrc3); - int rec2val3 = t->content[12]; - int rec3val0 = t->content[13]; - int rec3val1 = t->content[14]; + vector::iterator data = t->content.begin()+7; + size_t data_len = t->content.size()-7; + map> values; + uint16_t format_hash; + vector format_bytes; + hex2bin("02FF2004134413", &format_bytes); + vector::iterator format = format_bytes.begin(); + parseDV(t, data, data_len, &values, &format, format_bytes.size(), &format_hash); - info_codes_ = rec1val1*256+rec1val0; - t->addExplanation(full_content, 2, "%02x%02x info codes (%s)", rec1val0, rec1val1, statusHumanReadable().c_str()); + int offset; - int consumption_raw = rec2val3*256*256*256 + rec2val2*256*256 + rec2val1*256 + rec2val0; - // The dif=0x04 vif=0x13 means current volume with scale factor .001 - total_water_consumption_ = ((float)consumption_raw) / ((float)1000); - t->addExplanation(full_content, 4, "%02x%02x%02x%02x total consumption (%d)", - rec2val0, rec2val1, rec2val2, rec2val3, consumption_raw); - has_total_water_consumption_ = true; + extractDVuint16(&values, "02FF20", &offset, &info_codes_); + t->addMoreExplanation(offset, " info codes (%s)", statusHumanReadable().c_str()); - // The short frame target volume supplies two low bytes, - // the remaining two hi bytes are >>probably<< picked from rec2! - int target_volume_raw = rec2val3*256*256*256 + rec2val2*256*256 + rec3val1*256 + rec3val0; - target_volume_ = ((float)target_volume_raw) / ((float)1000); - t->addExplanation(full_content, 2, "%02x%02x target volume (%d)", - rec3val0, rec3val1, target_volume_raw); + extractDVfloat(&values, "0413", &offset, &total_water_consumption_); + has_total_water_consumption_ = true; + t->addMoreExplanation(offset, " total consumption (%f m3)", total_water_consumption_); + + extractDVfloatCombined(&values, "0413", "4413", &offset, &target_volume_); has_target_volume_ = true; - } else - if (frame_type == 0x78) { + t->addMoreExplanation(offset, " target consumption (%f m3)", target_volume_); + } + else + if (frame_type == 0x78) + { if (t->content.size() != 22) { warning("(multical21) warning: Unexpected length of long frame %zu. Expected 22 bytes! ", t->content.size()); - padWithZeroesTo(&t->content, 22, &full_content); + padWithZeroesTo(&t->content, 22, &t->content); warning("\n"); } - int rec1dif = t->content[3]; - int rec1vif = t->content[4]; - int rec1vife = t->content[5]; - int rec1val0 = t->content[6]; - int rec1val1 = t->content[7]; - - int rec2dif = t->content[8]; - int rec2vif = t->content[9]; - int rec2val0 = t->content[10]; - int rec2val1 = t->content[11]; - int rec2val2 = t->content[12]; - int rec2val3 = t->content[13]; - - int rec3dif = t->content[14]; - int rec3vif = t->content[15]; - int rec3val0 = t->content[16]; - int rec3val1 = t->content[17]; - int rec3val2 = t->content[18]; - int rec3val3 = t->content[19]; + vector::iterator data = t->content.begin()+3; + size_t data_len = t->content.size()-3-4; // Why this number? + map> values; + uint16_t format_hash; + parseDV(t, data, data_len, &values, NULL, 0, &format_hash); // There are two more bytes in the data. Unknown purpose. - int rec4val0 = t->content[20]; - int rec4val1 = t->content[21]; + int val0 = t->content[20]; + int val1 = t->content[21]; - if (rec1dif != 0x02 || rec1vif != 0xff || rec1vife != 0x20 ) { - warning("(multical21) warning: Unexpected field! Expected info codes\n" - "with dif=0x02 vif=0xff vife=0x20 but got dif=%02x vif=%02x vife=%02x\n", rec1dif, rec1vif, rec1vife); - } - t->addExplanation(full_content, 1, "%02x dif (%s)", rec1dif, difType(rec1dif).c_str()); - t->addExplanation(full_content, 1, "%02x vif (%s)", rec1vif, vifType(rec1vif).c_str()); - t->addExplanation(full_content, 1, "%02x vife (%s)", rec1vife, vifeType(rec1vif, rec1vife).c_str()); + int offset; - info_codes_ = rec1val1*256+rec1val0; - t->addExplanation(full_content, 2, "%02x%02x info codes (%s)", rec1val1, rec1val0, statusHumanReadable().c_str()); + extractDVuint16(&values, "02FF20", &offset, &info_codes_); + t->addMoreExplanation(offset, " info codes (%s)", statusHumanReadable().c_str()); - if (rec2dif != 0x04 || rec2vif != 0x13) { - warning("(multical21) warning: Unexpected field! Expected current volume\n" - "with dif=0x04 vif=0x13 but got dif=%02x vif=%02x\n", rec2dif, rec2vif); - } - t->addExplanation(full_content, 1, "%02x dif (%s)", rec2dif, difType(rec2dif).c_str()); - t->addExplanation(full_content, 1, "%02x vif (%s)", rec2vif, vifType(rec2vif).c_str()); + extractDVfloat(&values, "0413", &offset, &total_water_consumption_); + has_total_water_consumption_ = true; + t->addMoreExplanation(offset, " total consumption (%f m3)", total_water_consumption_); - int consumption_raw = rec2val3*256*256*256 + rec2val2*256*256 + rec2val1*256 + rec2val0; - // The dif=0x04 vif=0x13 means current volume with scale factor .001 - total_water_consumption_ = ((float)consumption_raw) / ((float)1000); - has_total_water_consumption_ = true; - t->addExplanation(full_content, 4, "%02x%02x%02x%02x total consumption (%d)", - rec2val3, rec2val2, rec2val1, rec2val0, consumption_raw); - - if (rec3dif != 0x44 || rec3vif != 0x13) { - warning("(multical21) warning: Unexpected field! Expected target volume (ie volume recorded on first day of month)\n" - "with dif=0x44 vif=0x13 but got dif=%02x vif=%02x\n", rec3dif, rec3vif); - } - t->addExplanation(full_content, 1, "%02x dif (%s)", rec3dif, difType(rec3dif).c_str()); - t->addExplanation(full_content, 1, "%02x vif (%s)", rec3vif, vifType(rec3vif).c_str()); - - int target_volume_raw = rec3val3*256*256*256 + rec3val2*256*256 + rec3val1*256 + rec3val0; - target_volume_ = ((float)target_volume_raw) / ((float)1000); + extractDVfloat(&values, "4413", &offset, &target_volume_); has_target_volume_ = true; - - t->addExplanation(full_content, 4, "%02x%02x%02x%02x target consumption (%d)", - rec3val3, rec3val2, rec3val1, rec3val0, target_volume_raw); + t->addMoreExplanation(offset, " target consumption (%f m3)", target_volume_); // To unknown bytes, seems to be very constant. - t->addExplanation(full_content, 2, "%02x%02x unknown", rec4val0, rec4val1); + t->addExplanation(data, 2, "%02x%02x unknown", val0, val1); } else { warning("(multical21) warning: unknown frame %02x (did you use the correct encryption key?)\n", frame_type); } } -string MeterMultical21::status() { +string MeterMultical21::status() +{ string s; if (info_codes_ & INFO_CODE_DRY) s.append("DRY "); if (info_codes_ & INFO_CODE_REVERSE) s.append("REVERSED "); @@ -321,7 +276,8 @@ string MeterMultical21::status() { return s; } -string MeterMultical21::timeDry() { +string MeterMultical21::timeDry() +{ int time_dry = (info_codes_ >> INFO_CODE_DRY_SHIFT) & 7; if (time_dry) { return decodeTime(time_dry); @@ -329,7 +285,8 @@ string MeterMultical21::timeDry() { return ""; } -string MeterMultical21::timeReversed() { +string MeterMultical21::timeReversed() +{ int time_reversed = (info_codes_ >> INFO_CODE_REVERSE_SHIFT) & 7; if (time_reversed) { return decodeTime(time_reversed); @@ -337,7 +294,8 @@ string MeterMultical21::timeReversed() { return ""; } -string MeterMultical21::timeLeaking() { +string MeterMultical21::timeLeaking() +{ int time_leaking = (info_codes_ >> INFO_CODE_LEAK_SHIFT) & 7; if (time_leaking) { return decodeTime(time_leaking); @@ -345,7 +303,8 @@ string MeterMultical21::timeLeaking() { return ""; } -string MeterMultical21::timeBursting() { +string MeterMultical21::timeBursting() +{ int time_bursting = (info_codes_ >> INFO_CODE_BURST_SHIFT) & 7; if (time_bursting) { return decodeTime(time_bursting); @@ -353,7 +312,8 @@ string MeterMultical21::timeBursting() { return ""; } -string MeterMultical21::statusHumanReadable() { +string MeterMultical21::statusHumanReadable() +{ string s; bool dry = info_codes_ & INFO_CODE_DRY; int time_dry = (info_codes_ >> INFO_CODE_DRY_SHIFT) & 7; @@ -397,7 +357,8 @@ string MeterMultical21::statusHumanReadable() { return "OK"; } -string MeterMultical21::decodeTime(int time) { +string MeterMultical21::decodeTime(int time) +{ if (time>7) { warning("(multical21) warning: Cannot decode time %d should be 0-7.\n", time); } @@ -436,7 +397,7 @@ void MeterMultical21::printMeterHumanReadable(FILE *output) void MeterMultical21::printMeterFields(FILE *output, char separator) { - fprintf(output, "%s%c%s%c%3.3f%c%3.3f%c%s%c%s\n", + fprintf(output, "%s%c%s%c%f%c%f%c%s%c%s\n", name().c_str(), separator, id().c_str(), separator, totalWaterConsumption(), separator, @@ -454,8 +415,8 @@ void MeterMultical21::printMeterJSON(FILE *output) fprintf(output, "{media:\"%s\",meter:\"multical21\"," QS(name,%s) QS(id,%s) - Q(total_m3,%.3f) - Q(target_m3,%.3f) + Q(total_m3,%f) + Q(target_m3,%f) QS(current_status,%s) QS(time_dry,%s) QS(time_reversed,%s) diff --git a/meter_multical302.cc b/meter_multical302.cc index 68bf8c9..0631630 100644 --- a/meter_multical302.cc +++ b/meter_multical302.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2018 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2018 Fredrik Öhrström + + 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 . +*/ #include"meters.h" #include"meters_common_implementation.h" @@ -111,34 +108,34 @@ void MeterMultical302::handleTelegram(Telegram *t) { } void MeterMultical302::processContent(Telegram *t) { - vector full_content; - full_content.insert(full_content.end(), t->parsed.begin(), t->parsed.end()); - full_content.insert(full_content.end(), t->content.begin(), t->content.end()); + vector::iterator bytes = t->content.begin(); int crc0 = t->content[0]; int crc1 = t->content[1]; - t->addExplanation(full_content, 2, "%02x%02x payload crc", crc0, crc1); + t->addExplanation(bytes, 2, "%02x%02x payload crc", crc0, crc1); int frame_type = t->content[2]; - t->addExplanation(full_content, 1, "%02x frame type (%s)", frame_type, frameTypeKamstrupC1(frame_type).c_str()); + t->addExplanation(bytes, 1, "%02x frame type (%s)", frame_type, frameTypeKamstrupC1(frame_type).c_str()); if (frame_type == 0x79) { if (t->content.size() != 17) { fprintf(stderr, "(multical302) warning: Unexpected length of frame %zu. Expected 17 bytes! ", t->content.size()); - padWithZeroesTo(&t->content, 17, &full_content); + padWithZeroesTo(&t->content, 17, &t->content); warning("\n"); } - t->addExplanation(full_content, 4, "%02x%02x%02x%02x unknown", t->content[3], t->content[4], t->content[5], t->content[6]); + // This code should be rewritten to use parseDV see the Multical21 code. + // But I cannot do this without more examples of 302 telegrams. + t->addExplanation(bytes, 4, "%02x%02x%02x%02x unknown", t->content[3], t->content[4], t->content[5], t->content[6]); int rec1val0 = t->content[7]; int rec1val1 = t->content[8]; int rec1val2 = t->content[9]; - t->addExplanation(full_content, 4, "%02x%02x%02x unknown", t->content[10], t->content[11], t->content[12]); + t->addExplanation(bytes, 4, "%02x%02x%02x unknown", t->content[10], t->content[11], t->content[12]); int total_energy_raw = rec1val2*256*256 + rec1val1*256 + rec1val0; total_energy_ = total_energy_raw; - t->addExplanation(full_content, 3, "%02x%02x%02x total power (%d)", + t->addExplanation(bytes, 3, "%02x%02x%02x total power (%d)", rec1val0, rec1val1, rec1val2, total_energy_raw); int rec2val0 = t->content[13]; @@ -147,28 +144,30 @@ void MeterMultical302::processContent(Telegram *t) { int total_volume_raw = rec2val2*256*256 + rec2val1*256 + rec2val0; total_volume_ = total_volume_raw; - t->addExplanation(full_content, 3, "%02x%02x%02x total volume (%d)", + t->addExplanation(bytes, 3, "%02x%02x%02x total volume (%d)", rec2val0, rec2val1, rec2val2, total_volume_raw); } else if (frame_type == 0x78) { if (t->content.size() != 26) { fprintf(stderr, "(multical302) warning: Unexpected length of frame %zu. Expected 26 bytes! ", t->content.size()); - padWithZeroesTo(&t->content, 26, &full_content); + padWithZeroesTo(&t->content, 26, &t->content); warning("\n"); } + // This code should be rewritten to use parseDV see the Multical21 code. + // But I cannot do this without more examples of 302 telegrams. vector unknowns; unknowns.insert(unknowns.end(), t->content.begin()+3, t->content.begin()+24); string hex = bin2hex(unknowns); - t->addExplanation(full_content, 23-2, "%s unknown", hex.c_str()); + t->addExplanation(bytes, 23-2, "%s unknown", hex.c_str()); int rec1val0 = t->content[24]; int rec1val1 = t->content[25]; int current_power_raw = (rec1val1*256 + rec1val0)*100; current_power_ = current_power_raw; - t->addExplanation(full_content, 2, "%02x%02x current power (%d)", + t->addExplanation(bytes, 2, "%02x%02x current power (%d)", rec1val0, rec1val1, current_power_raw); } else { @@ -193,7 +192,7 @@ void MeterMultical302::printMeterHumanReadable(FILE *output) void MeterMultical302::printMeterFields(FILE *output, char separator) { - fprintf(output, "%s%c%s%c%3.3f%c%3.3f%c%3.3f%c%s\n", + fprintf(output, "%s%c%s%c%f%c%f%c%f%c%s\n", name().c_str(), separator, id().c_str(), separator, totalEnergyConsumption(), separator, @@ -211,9 +210,9 @@ void MeterMultical302::printMeterJSON(FILE *output) fprintf(output, "{media:\"heat\",meter:\"multical302\"," QS(name,%s) QS(id,%s) - Q(total_kwh,%.3f) - Q(total_volume_m3,%.3f) - QS(current_kw,%.3f) + Q(total_kwh,%f) + Q(total_volume_m3,%f) + QS(current_kw,%f) QSE(timestamp,%s) "}\n", name().c_str(), diff --git a/meter_omnipower.cc b/meter_omnipower.cc index 22be783..ffdb8e4 100644 --- a/meter_omnipower.cc +++ b/meter_omnipower.cc @@ -1,29 +1,28 @@ -// Copyright (c) 2018 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2018 Fredrik Öhrström + 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 . +*/ + +#include"dvparser.h" #include"meters.h" #include"meters_common_implementation.h" #include"wmbus.h" #include"wmbus_utils.h" #include"util.h" +#include #include #include #include @@ -103,30 +102,23 @@ void MeterOmnipower::handleTelegram(Telegram *t) { triggerUpdate(t); } -void MeterOmnipower::processContent(Telegram *t) { - vector full_content; - full_content.insert(full_content.end(), t->parsed.begin(), t->parsed.end()); - full_content.insert(full_content.end(), t->content.begin(), t->content.end()); +void MeterOmnipower::processContent(Telegram *t) +{ + // Meter record: + // 04 dif (32 Bit Integer/Binary Instantaneous value) + // 83 vif (Energy Wh) + // 3b vife - int rec1dif = t->content[0]; - t->addExplanation(full_content, 1, "%02x dif (%s)", rec1dif, difType(rec1dif).c_str()); - int rec1vif = t->content[1]; - t->addExplanation(full_content, 1, "%02x vif (%s)", rec1vif, vifType(rec1vif).c_str()); - int rec1vife = t->content[2]; - t->addExplanation(full_content, 1, "%02x vife (%s)", rec1vife, vifeType(rec1vif, rec1vife).c_str()); + map> values; + parseDV(t, t->content.begin(), t->content.size(), &values); - int rec1val0 = t->content[3]; - int rec1val1 = t->content[4]; - int rec1val2 = t->content[5]; - int rec1val3 = t->content[6]; - - int total_energy_raw = rec1val3*256*256*256 + rec1val2*256*256 + rec1val1*256 + rec1val0; - total_energy_ = ((float)total_energy_raw)/1000.0; - t->addExplanation(full_content, 4, "%02x%02x%02x%02x total power (%d)", - rec1val0, rec1val1, rec1val2, rec1val3, total_energy_raw); + int offset; + extractDVfloat(&values, "04833B", &offset, &total_energy_); + t->addMoreExplanation(offset, " total power (%d kwh)", total_energy_); } -ElectricityMeter *createOmnipower(WMBus *bus, const char *name, const char *id, const char *key) { +ElectricityMeter *createOmnipower(WMBus *bus, const char *name, const char *id, const char *key) +{ return new MeterOmnipower(bus,name,id,key); } @@ -142,7 +134,7 @@ void MeterOmnipower::printMeterHumanReadable(FILE *output) void MeterOmnipower::printMeterFields(FILE *output, char separator) { - fprintf(output, "%s%c%s%c%3.3f%c%3.3f%c%s\n", + fprintf(output, "%s%c%s%c%f%c%f%c%s\n", name().c_str(), separator, id().c_str(), separator, totalEnergyConsumption(), separator, @@ -159,8 +151,8 @@ void MeterOmnipower::printMeterJSON(FILE *output) fprintf(output, "{media:\"electricity\",meter:\"omnipower\"," QS(name,%s) QS(id,%s) - Q(total_kwh,%.3f) - QS(current_kw,%.3f) + Q(total_kwh,%f) + QS(current_kw,%f) QSE(timestamp,%s) "}\n", name().c_str(), diff --git a/meters.cc b/meters.cc index ddf11fa..2f4c97f 100644 --- a/meters.cc +++ b/meters.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #include"meters.h" #include"meters_common_implementation.h" diff --git a/meters.h b/meters.h index 620495c..a0f6832 100644 --- a/meters.h +++ b/meters.h @@ -1,22 +1,19 @@ -// Copyright (c) 2018 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #ifndef METER_H_ #define METER_H_ diff --git a/meters_common_implementation.h b/meters_common_implementation.h index 1622a6a..a01ffc6 100644 --- a/meters_common_implementation.h +++ b/meters_common_implementation.h @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2018 Fredrik Öhrström + + 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 . +*/ #ifndef METERS_COMMON_IMPLEMENTATION_H_ #define METERS_COMMON_IMPLEMENTATION_H_ diff --git a/printer.cc b/printer.cc index 9b7596b..a7b7d2c 100644 --- a/printer.cc +++ b/printer.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017 Fredrik Öhrström + + 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 . +*/ #include"printer.h" diff --git a/printer.h b/printer.h index 0cd4a4d..9ebccc9 100644 --- a/printer.h +++ b/printer.h @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017 Fredrik Öhrström + + 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 . +*/ #include"cmdline.h" #include"meters.h" diff --git a/serial.cc b/serial.cc index 53e1d2e..3cce39c 100644 --- a/serial.cc +++ b/serial.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #include"util.h" #include"serial.h" diff --git a/serial.h b/serial.h index d23ef71..6d390c9 100644 --- a/serial.h +++ b/serial.h @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #ifndef SERIAL_H_ #define SERIAL_H_ @@ -34,8 +31,8 @@ struct SerialCommunicationManager; struct SerialDevice { virtual bool open(bool fail_if_not_ok) = 0; virtual void close() = 0; - virtual bool send(vector &data) = 0; - virtual int receive(vector *data) = 0; + virtual bool send(std::vector &data) = 0; + virtual int receive(std::vector *data) = 0; virtual int fd() = 0; virtual SerialCommunicationManager *manager() = 0; }; diff --git a/simulation.txt b/simulation.txt index a36ee3e..11c64a8 100644 --- a/simulation.txt +++ b/simulation.txt @@ -2,18 +2,18 @@ # short telegram telegram=|23442D2C998734761B168D2093E13CBA20|967F79EDA8047B7100F4180000E918| -{media:"cold water",meter:"multical21","name":"MyTapWater","id":"76348799","total_m3":6.388,"target_m3":6.377,"current_status":"DRY","time_dry":"22-31 days","time_reversed":"","time_leaking":"","time_bursting":"","timestamp":"1111-11-11T11:11:11Z"} +{media:"cold water",meter:"multical21","name":"MyTapWater","id":"76348799","total_m3":6.388000,"target_m3":6.377000,"current_status":"DRY","time_dry":"22-31 days","time_reversed":"","time_leaking":"","time_bursting":"","timestamp":"1111-11-11T11:11:11Z"} # full telegram telegram=|2A442D2C998734761B168D2049F03FBA20|39A17802FF2071000413F41800004413E9180000615B| -{media:"cold water",meter:"multical21","name":"MyTapWater","id":"76348799","total_m3":6.388,"target_m3":6.377,"current_status":"DRY","time_dry":"22-31 days","time_reversed":"","time_leaking":"","time_bursting":"","timestamp":"1111-11-11T11:11:11Z"} +{media:"cold water",meter:"multical21","name":"MyTapWater","id":"76348799","total_m3":6.388000,"target_m3":6.377000,"current_status":"DRY","time_dry":"22-31 days","time_reversed":"","time_leaking":"","time_bursting":"","timestamp":"1111-11-11T11:11:11Z"} # Test Multical302 C1 telegrams # short telegram, this is not a proper telegram! Please provide the output from --logtelegrams for a Multical302 meter! telegram=|25442D2C785634121b048D2093E13CBA20|0000790000000000000000000000000000| -{media:"heat",meter:"multical302","name":"MyHeater","id":"12345678","total_kwh":0.000,"total_volume_m3":0.000,"current_kw":"0.000","timestamp":"1111-11-11T11:11:11Z"} +{media:"heat",meter:"multical302","name":"MyHeater","id":"12345678","total_kwh":0.000000,"total_volume_m3":0.000000,"current_kw":"0.000000","timestamp":"1111-11-11T11:11:11Z"} # full telegram @@ -22,4 +22,4 @@ telegram=|25442D2C785634121b048D2093E13CBA20|0000790000000000000000000000000000| # Test Omnipower C1 telegrams telegram=|1E442D2C0771941501027A|B300108504833B08340500| -{media:"electricity",meter:"omnipower","name":"MyElectricity","id":"15947107","total_kwh":341.000,"current_kw":"0.000","timestamp":"1111-11-11T11:11:11Z"} +{media:"electricity",meter:"omnipower","name":"MyElectricity","id":"15947107","total_kwh":341.000000,"current_kw":"0.000000","timestamp":"1111-11-11T11:11:11Z"} diff --git a/util.cc b/util.cc index e7830fd..e715ca8 100644 --- a/util.cc +++ b/util.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #include"util.h" #include @@ -92,6 +89,11 @@ bool hex2bin(const char* src, vector *target) return true; } +bool hex2bin(string &src, vector *target) +{ + return hex2bin(src.c_str(), target); +} + char const hex[16] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A','B','C','D','E','F'}; std::string bin2hex(vector &target) { @@ -104,6 +106,27 @@ std::string bin2hex(vector &target) { return str; } +std::string bin2hex(vector::iterator data, int len) { + std::string str; + while (len-- > 0) { + const char ch = *data; + data++; + str.append(&hex[(ch & 0xF0) >> 4], 1); + str.append(&hex[ch & 0xF], 1); + } + return str; +} + +void strprintf(std::string &s, const char* fmt, ...) +{ + char buf[4096]; + va_list args; + va_start(args, fmt); + vsnprintf(buf, 4095, fmt, args); + va_end(args); + s = buf; +} + void xorit(uchar *srca, uchar *srcb, uchar *dest, int len) { for (int i=0; i. +*/ #ifndef UTIL_H #define UTIL_H @@ -34,7 +31,10 @@ typedef unsigned char uchar; #define calll(A,B,T) ([A](T t){A->B(t);}) bool hex2bin(const char* src, std::vector *target); +bool hex2bin(std::string &src, std::vector *target); std::string bin2hex(std::vector &target); +std::string bin2hex(std::vector::iterator data, int len); +void strprintf(std::string &s, const char* fmt, ...); void xorit(uchar *srca, uchar *srcb, uchar *dest, int len); @@ -70,6 +70,6 @@ void padWithZeroesTo(std::vector *content, size_t len, std::vector int parseTime(std::string time); -uint16_t crc_16_EN_13757(uchar *data, size_t len); +uint16_t crc16_EN13757(uchar *data, size_t len); #endif diff --git a/wmbus.cc b/wmbus.cc index ad288e5..ea07eea 100644 --- a/wmbus.cc +++ b/wmbus.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #include"wmbus.h" #include @@ -272,7 +269,22 @@ string ciType(int ci_field) return "?"; } -void Telegram::addExplanation(vector &payload, int len, const char* fmt, ...) +void Telegram::addExplanation(vector::iterator &bytes, int len, const char* fmt, ...) +{ + char buf[1024]; + buf[1023] = 0; + + va_list args; + va_start(args, fmt); + vsnprintf(buf, 1023, fmt, args); + va_end(args); + + explanations.push_back({parsed.size(), buf}); + parsed.insert(parsed.end(), bytes, bytes+len); + bytes += len; +} + +void Telegram::addMoreExplanation(int pos, const char* fmt, ...) { char buf[1024]; @@ -283,36 +295,46 @@ void Telegram::addExplanation(vector &payload, int len, const char* fmt, vsnprintf(buf, 1023, fmt, args); va_end(args); - explanations.push_back({parsed.size(), buf}); - parsed.insert(parsed.end(), payload.begin()+parsed.size(), payload.begin()+parsed.size()+len); + bool found = false; + for (auto& p : explanations) { + if (p.first == pos) { + p.second += buf; + found = true; + } + } + + if (!found) { + error("(wmbus) cannot find offset %d to add more explanation \"%s\"\n", pos, buf); + } } void Telegram::parse(vector &frame) { + vector::iterator bytes = frame.begin(); parsed.clear(); len = frame[0]; - addExplanation(frame, 1, "%02x length (%d bytes)", len, len); + addExplanation(bytes, 1, "%02x length (%d bytes)", len, len); c_field = frame[1]; - addExplanation(frame, 1, "%02x c-field (%s)", c_field, cType(c_field).c_str()); + addExplanation(bytes, 1, "%02x c-field (%s)", c_field, cType(c_field).c_str()); m_field = frame[3]<<8 | frame[2]; string man = manufacturerFlag(m_field); - addExplanation(frame, 2, "%02x%02x m-field (%02x=%s)", frame[2], frame[3], m_field, man.c_str()); + addExplanation(bytes, 2, "%02x%02x m-field (%02x=%s)", frame[2], frame[3], m_field, man.c_str()); a_field.resize(6); a_field_address.resize(4); for (int i=0; i<6; ++i) { a_field[i] = frame[4+i]; if (i<4) { a_field_address[i] = frame[4+3-i]; } } - addExplanation(frame, 4, "%02x%02x%02x%02x a-field-addr (%02x%02x%02x%02x)", frame[4], frame[5], frame[6], frame[7], + addExplanation(bytes, 4, "%02x%02x%02x%02x a-field-addr (%02x%02x%02x%02x)", frame[4], frame[5], frame[6], frame[7], frame[7], frame[6], frame[5], frame[4]); a_field_version = frame[4+4]; a_field_device_type = frame[4+5]; - addExplanation(frame, 1, "%02x a-field-version", frame[8]); - addExplanation(frame, 1, "%02x a-field-type (%s)", frame[9], deviceType(m_field, a_field_device_type).c_str()); + addExplanation(bytes, 1, "%02x a-field-version", frame[8]); + addExplanation(bytes, 1, "%02x a-field-type (%s)", frame[9], deviceType(m_field, a_field_device_type).c_str()); ci_field=frame[10]; - addExplanation(frame, 1, "%02x ci-field (%s)", ci_field, ciType(ci_field).c_str()); + addExplanation(bytes, 1, "%02x ci-field (%s)", ci_field, ciType(ci_field).c_str()); int header_size = 0; if (ci_field == 0x78) { @@ -320,25 +342,25 @@ void Telegram::parse(vector &frame) } else if (ci_field == 0x7a) { acc = frame[11]; - addExplanation(frame, 1, "%02x acc", acc); + addExplanation(bytes, 1, "%02x acc", acc); status = frame[12]; - addExplanation(frame, 1, "%02x status ()", status); + addExplanation(bytes, 1, "%02x status ()", status); configuration = frame[13]<<8 | frame[14]; - addExplanation(frame, 2, "%02x%02x configuration ()", frame[13], frame[14]); + addExplanation(bytes, 2, "%02x%02x configuration ()", frame[13], frame[14]); header_size = 4; } else if (ci_field == 0x8d || ci_field == 0x8c) { cc_field = frame[11]; - addExplanation(frame, 1, "%02x cc-field (%s)", cc_field, ccType(cc_field).c_str()); + addExplanation(bytes, 1, "%02x cc-field (%s)", cc_field, ccType(cc_field).c_str()); acc = frame[12]; - addExplanation(frame, 1, "%02x acc", acc); + addExplanation(bytes, 1, "%02x acc", acc); header_size = 2; if (ci_field == 0x8d) { sn[0] = frame[13]; sn[1] = frame[14]; sn[2] = frame[15]; sn[3] = frame[16]; - addExplanation(frame, 4, "%02x%02x%02x%02x sn", sn[0], sn[1], sn[2], sn[3]); + addExplanation(bytes, 4, "%02x%02x%02x%02x sn", sn[0], sn[1], sn[2], sn[3]); header_size = 6; } } else { @@ -394,6 +416,61 @@ string ccType(int cc_field) return s; } +DIFTYPE difDataType(int dif) +{ + int t = dif & 0x0f; + switch (t) { + case 0x0: return DIF_INTEGER; // No data + case 0x1: return DIF_INTEGER; // 8 Bit Integer/Binary + case 0x2: return DIF_INTEGER; // 16 Bit Integer/Binary + case 0x3: return DIF_INTEGER; // 24 Bit Integer/Binary + case 0x4: return DIF_INTEGER; // 32 Bit Integer/Binary + case 0x5: return DIF_REAL; // 32 Bit Real + case 0x6: return DIF_INTEGER; // 48 Bit Integer/Binary + case 0x7: return DIF_INTEGER; // 64 Bit Integer/Binary + case 0x8: return DIF_INTEGER; // Selection for Readout (I do not know what this is) + case 0x9: return DIF_BCD; // 2 digit BCD + case 0xA: return DIF_BCD; // 4 digit BCD + case 0xB: return DIF_BCD; // 6 digit BCD + case 0xC: return DIF_BCD; // 8 digit BCD + case 0xD: return DIF_INTEGER; // variable length + case 0xE: return DIF_BCD; // 12 digit BCD + case 0xF: return DIF_INTEGER; // Special Functions + } + return DIF_INTEGER; +} + +int difLenBytes(int dif) +{ + if (dif == 0x44) { + // Special functions: 0x0F, 0x1F, 0x2F, 0x7F or dif >= 0x3F and dif <= 0x6F + // 0x44 is used in the Kamstrup Multical21 for the lower 16 bits of data + // to be combined with the upper 16 bits of a previous value. + return 2; + } + + int t = dif & 0x0f; + switch (t) { + case 0x0: return 0; // No data + case 0x1: return 1; // 8 Bit Integer/Binary + case 0x2: return 2; // 16 Bit Integer/Binary + case 0x3: return 3; // 24 Bit Integer/Binary + case 0x4: return 4; // 32 Bit Integer/Binary + case 0x5: return 4; // 32 Bit Real + case 0x6: return 6; // 48 Bit Integer/Binary + case 0x7: return 8; // 64 Bit Integer/Binary + case 0x8: return -1; // Selection for Readout (I do not know what this is) + case 0x9: return 1; // 2 digit BCD + case 0xA: return 2; // 4 digit BCD + case 0xB: return 3; // 6 digit BCD + case 0xC: return 4; // 8 digit BCD + case 0xD: return -1; // variable length + case 0xE: return 6; // 12 digit BCD + case 0xF: return -1; // Special Functions + } + return -1; +} + string difType(int dif) { string s; @@ -422,11 +499,18 @@ string difType(int dif) switch (t) { case 0x00: s += " Instantaneous value"; break; - case 0x10: s += "Maximum value"; break; - case 0x20: s += "Minimum value"; break; - case 0x30: s+= "Value during error state"; break; + case 0x10: s += " Maximum value"; break; + case 0x20: s += " Minimum value"; break; + case 0x30: s+= " Value during error state"; break; default: s += "?"; break; } + + if (dif & 0x40) { + // Kamstrup uses this bit to signal that for the full 32 bits of data + // the lower 16 bits are from this difvif record, the higher 32 bits + // are from a different record. + s += " KamstrupCombined"; + } return s; } @@ -440,6 +524,7 @@ string vifType(int vif) case 0xfb: return "First extension of VIF-codes"; case 0xfd: return "Second extension of VIF-codes"; case 0xef: return "Reserved extension"; + case 0xff: return "Kamstrup extension"; } } @@ -595,6 +680,183 @@ string vifType(int vif) } } +float vifScale(int vif) +{ + int t = vif & 0x7f; + + switch (t) { + // wmbusmeters always returns enery as kwh + case 0x00: return 1000000.0; // Energy mWh + case 0x01: return 100000.0; // Energy 10⁻² Wh + case 0x02: return 10000.0; // Energy 10⁻¹ Wh + case 0x03: return 1000.0; // Energy Wh + case 0x04: return 100.0; // Energy 10¹ Wh + case 0x05: return 10.0; // Energy 10² Wh + case 0x06: return 1.0; // Energy kWh + case 0x07: return 0.1; // Energy 10⁴ Wh + + // or wmbusmeters always returns energy as MJ + case 0x08: return 1000000.0; // Energy J + case 0x09: return 100000.0; // Energy 10¹ J + case 0x0A: return 10000.0; // Energy 10² J + case 0x0B: return 1000.0; // Energy kJ + case 0x0C: return 100.0; // Energy 10⁴ J + case 0x0D: return 10.0; // Energy 10⁵ J + case 0x0E: return 1.0; // Energy MJ + case 0x0F: return 0.1; // Energy 10⁷ J + + // wmbusmeters always returns volume as m3 + case 0x10: return 1000000.0; // Volume cm³ + case 0x11: return 100000.0; // Volume 10⁻⁵ m³ + case 0x12: return 10000.0; // Volume 10⁻⁴ m³ + case 0x13: return 1000.0; // Volume l + case 0x14: return 100.0; // Volume 10⁻² m³ + case 0x15: return 10.0; // Volume 10⁻¹ m³ + case 0x16: return 1.0; // Volume m³ + case 0x17: return 0.1; // Volume 10¹ m³ + + // wmbusmeters always returns weight in kg + case 0x18: return 1000.0; // Mass g + case 0x19: return 100.0; // Mass 10⁻² kg + case 0x1A: return 10.0; // Mass 10⁻¹ kg + case 0x1B: return 1.0; // Mass kg + case 0x1C: return 0.1; // Mass 10¹ kg + case 0x1D: return 0.01; // Mass 10² kg + case 0x1E: return 0.001; // Mass t + case 0x1F: return 0.0001; // Mass 10⁴ kg + + // wmbusmeters always returns time in hours + case 0x20: return 3600.0; // On time seconds + case 0x21: return 60.0; // On time minutes + case 0x22: return 1.0; // On time hours + case 0x23: return (1.0/24.0); // On time days + + case 0x24: return 3600.0; // Operating time seconds + case 0x25: return 60.0; // Operating time minutes + case 0x26: return 1.0; // Operating time hours + case 0x27: return (1.0/24.0); // Operating time days + + // wmbusmeters always returns power in kw + case 0x28: return 1000000.0; // Power mW + case 0x29: return 100000.0; // Power 10⁻² W + case 0x2A: return 10000.0; // Power 10⁻¹ W + case 0x2B: return 1000.0; // Power W + case 0x2C: return 100.0; // Power 10¹ W + case 0x2D: return 10.0; // Power 10² W + case 0x2E: return 1.0; // Power kW + case 0x2F: return 0.1; // Power 10⁴ W + + // or wmbusmeters always returns power in MJh + case 0x30: return 1000000.0; // Power J/h + case 0x31: return 100000.0; // Power 10¹ J/h + case 0x32: return 10000.0; // Power 10² J/h + case 0x33: return 1000.0; // Power kJ/h + case 0x34: return 100.0; // Power 10⁴ J/h + case 0x35: return 10.0; // Power 10⁵ J/h + case 0x36: return 1.0; // Power MJ/h + case 0x37: return 0.1; // Power 10⁷ J/h + + // wmbusmeters always returns volume flow in m3h + case 0x38: return 1000000.0; // Volume flow cm³/h + case 0x39: return 100000.0; // Volume flow 10⁻⁵ m³/h + case 0x3A: return 10000.0; // Volume flow 10⁻⁴ m³/h + case 0x3B: return 1000.0; // Volume flow l/h + case 0x3C: return 100.0; // Volume flow 10⁻² m³/h + case 0x3D: return 10.0; // Volume flow 10⁻¹ m³/h + case 0x3E: return 1.0; // Volume flow m³/h + case 0x3F: return 0.1; // Volume flow 10¹ m³/h + + // wmbusmeters always returns volume flow in m3h + case 0x40: return 600000000.0; // Volume flow ext. 10⁻⁷ m³/min + case 0x41: return 60000000.0; // Volume flow ext. cm³/min + case 0x42: return 6000000.0; // Volume flow ext. 10⁻⁵ m³/min + case 0x43: return 600000.0; // Volume flow ext. 10⁻⁴ m³/min + case 0x44: return 60000.0; // Volume flow ext. l/min + case 0x45: return 6000.0; // Volume flow ext. 10⁻² m³/min + case 0x46: return 600.0; // Volume flow ext. 10⁻¹ m³/min + case 0x47: return 60.0; // Volume flow ext. m³/min + + // this flow numbers will be small in the m3h unit, but it + // does not matter since float stores the scale factor in its exponent. + case 0x48: return 1000000000.0*3600; // Volume flow ext. mm³/s + case 0x49: return 100000000.0*3600; // Volume flow ext. 10⁻⁸ m³/s + case 0x4A: return 10000000.0*3600; // Volume flow ext. 10⁻⁷ m³/s + case 0x4B: return 1000000.0*3600; // Volume flow ext. cm³/s + case 0x4C: return 100000.0*3600; // Volume flow ext. 10⁻⁵ m³/s + case 0x4D: return 10000.0*3600; // Volume flow ext. 10⁻⁴ m³/s + case 0x4E: return 1000.0*3600; // Volume flow ext. l/s + case 0x4F: return 100.0*3600; // Volume flow ext. 10⁻² m³/s + + // wmbusmeters always returns mass flow as kgh + case 0x50: return 1000.0; // Mass g/h + case 0x51: return 100.0; // Mass 10⁻² kg/h + case 0x52: return 10.0; // Mass 10⁻¹ kg/h + case 0x53: return 1.0; // Mass kg/h + case 0x54: return 0.1; // Mass 10¹ kg/h + case 0x55: return 0.01; // Mass 10² kg/h + case 0x56: return 0.001; // Mass t/h + case 0x57: return 0.0001; // Mass 10⁴ kg/h + + // wmbusmeters always returns temperature in °C + case 0x58: return 1000.0; // Flow temperature 10⁻³ °C + case 0x59: return 100.0; // Flow temperature 10⁻² °C + case 0x5A: return 10.0; // Flow temperature 10⁻¹ °C + case 0x5B: return 1.0; // Flow temperature °C + + // wmbusmeters always returns temperature in c + case 0x5C: return 1000.0; // Return temperature 10⁻³ °C + case 0x5D: return 100.0; // Return temperature 10⁻² °C + case 0x5E: return 10.0; // Return temperature 10⁻¹ °C + case 0x5F: return 1.0; // Return temperature °C + + // or if Kelvin is used as a temperature, in K + // what kind of meter cares about -273.15 °C + // a flow pump for liquid helium perhaps? + case 0x60: return 1000.0; // Temperature difference mK + case 0x61: return 100.0; // Temperature difference 10⁻² K + case 0x62: return 10.0; // Temperature difference 10⁻¹ K + case 0x63: return 1.0; // Temperature difference K + + // wmbusmeters always returns temperature in c + case 0x64: return 1000.0; // External temperature 10⁻³ °C + case 0x65: return 100.0; // External temperature 10⁻² °C + case 0x66: return 10.0; // External temperature 10⁻¹ °C + case 0x67: return 1.0; // External temperature °C + + // wmbusmeters always returns pressure in bar + case 0x68: return 1000.0; // Pressure mbar + case 0x69: return 100.0; // Pressure 10⁻² bar + case 0x6A: return 10.0; // Pressure 10⁻1 bar + case 0x6B: return 1.0; // Pressure bar + + case 0x6C: warning("(wmbus) warning: do not scale a date type!\n"); return -1.0; // Date type G + case 0x6E: warning("(wmbus) warning: do not scale a HCA type!\n"); return -1.0; // Units for H.C.A. + case 0x6F: warning("(wmbus) warning: do not scale a reserved type!\n"); return -1.0; // Reserved + + // wmbusmeters always returns time in hours + case 0x70: return 3600.0; // Averaging duration seconds + case 0x71: return 60.0; // Averaging duration minutes + case 0x72: return 1.0; // Averaging duration hours + case 0x73: return (1.0/24.0); // Averaging duration days + + case 0x74: return 3600.0; // Actuality duration seconds + case 0x75: return 60.0; // Actuality duration minutes + case 0x76: return 1.0; // Actuality duration hours + case 0x77: return (1.0/24.0); // Actuality duration days + + case 0x78: // Fabrication no + case 0x79: // Enhanced identification + case 0x80: // Address + + case 0x7C: // VIF in following string (length in first byte) + case 0x7E: // Any VIF + case 0x7F: // Manufacturer specific + + default: warning("(wmbus) warning: type %d cannot be scaled!\n", t); + return -1; + } +} + string vifeType(int vif, int vife) { //int extension = vif & 0x80; diff --git a/wmbus.h b/wmbus.h index 6dc22a4..89dab68 100644 --- a/wmbus.h +++ b/wmbus.h @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #ifndef WMBUS_H #define WMBUS_H @@ -87,7 +84,8 @@ struct Telegram { // A vector of indentations and explanations, to be printed // below the raw data bytes to explain the telegram content. vector> explanations; - void addExplanation(vector &payload, int len, const char* fmt, ...); + void addExplanation(vector::iterator &bytes, int len, const char* fmt, ...); + void addMoreExplanation(int pos, const char* fmt, ...); void explainParse(string intro, int from); }; @@ -126,7 +124,17 @@ string ciType(int ci_field); string cType(int c_field); string ccType(int cc_field); string difType(int dif); +float vifScale(int vif); string vifType(int vif); string vifeType(int vif, int vife); +enum DIFTYPE { + DIF_INTEGER, + DIF_REAL, + DIF_BCD +}; + +int difLenBytes(int dif); +DIFTYPE difDataType(int dif); + #endif diff --git a/wmbus_amb8465.cc b/wmbus_amb8465.cc index a49e62d..36a0885 100644 --- a/wmbus_amb8465.cc +++ b/wmbus_amb8465.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2018 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2018 Fredrik Öhrström + + 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 . +*/ #include"wmbus.h" #include"wmbus_amb8465.h" diff --git a/wmbus_im871a.cc b/wmbus_im871a.cc index ba73de7..b3fc6f7 100644 --- a/wmbus_im871a.cc +++ b/wmbus_im871a.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2017 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2017-2018 Fredrik Öhrström + + 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 . +*/ #include"wmbus.h" #include"wmbus_im871a.h" diff --git a/wmbus_simulator.cc b/wmbus_simulator.cc index aa316e8..abccf5f 100644 --- a/wmbus_simulator.cc +++ b/wmbus_simulator.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2018 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2018 Fredrik Öhrström + + 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 . +*/ #include"wmbus.h" #include"serial.h" diff --git a/wmbus_utils.cc b/wmbus_utils.cc index 5e9b98c..f03080b 100644 --- a/wmbus_utils.cc +++ b/wmbus_utils.cc @@ -1,22 +1,19 @@ -// Copyright (c) 2018 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2018 Fredrik Öhrström + + 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 . +*/ #ifndef WMBUS_UTILS_H #define WMBUS_UTILS_H diff --git a/wmbus_utils.h b/wmbus_utils.h index ed47b8b..8207c09 100644 --- a/wmbus_utils.h +++ b/wmbus_utils.h @@ -1,22 +1,19 @@ -// Copyright (c) 2017-2018 Fredrik Öhrström -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to deal -// in the Software without restriction, including without limitation the rights -// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -// copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in all -// copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -// SOFTWARE. +/* + Copyright (C) 2018 Fredrik Öhrström + + 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 . +*/ #ifndef WMBUS_UTILS_H #define WMBUS_UTILS_H