diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + haskell-obd + Copyright (C) 2016 Henri Verroken + + 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: + + haskell-obd Copyright (C) 2016 Henri Verroken + 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/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/app/Terminal.hs b/app/Terminal.hs new file mode 100644 --- /dev/null +++ b/app/Terminal.hs @@ -0,0 +1,89 @@ +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +module Main where + +import Control.Exception (bracket) +import Control.Monad (join) +import Control.Monad.IO.Class (MonadIO, liftIO) +import Control.Monad.Reader (MonadReader, ReaderT, runReaderT, ask) +import Control.Monad.Trans.Class (lift) +import Data.List (isSuffixOf) +import qualified Data.ByteString.Char8 as Char8 + +import Options.Applicative (Parser, execParser, + flag, strOption, + help, long, value, + info, progDesc, + (<>)) +import Options.Applicative.Extra (helper) + +import System.Console.Haskeline (InputT, MonadException, RunIO(..), + controlIO, runInputT, + defaultSettings, getInputLine) + +import System.Hardware.ELM327.Connection (Con, recv, sendString) +import System.Hardware.ELM327.Simulator (defaultSimulator) +import System.Hardware.ELM327.Simulator.OBDBus.VWPolo2007 (stoppedCarBus) +import qualified System.Hardware.ELM327.Connection as Connection +import qualified System.Hardware.ELM327 as ELM327 +import qualified System.Hardware.ELM327.Simulator as Simulator + + +newtype Term a = Term { runTerm :: ReaderT Con IO a } + deriving (Functor, Applicative, Monad, MonadIO, MonadReader Con) + +instance MonadException Term where + controlIO f = join . liftIO $ f (RunIO return) + +data ConnectionType = ConnectionTypeActualDevice FilePath + | ConnectionTypeSimulator + +connectionType :: Parser ConnectionType +connectionType = flag ConnectionTypeActualDevice (const ConnectionTypeSimulator) m <*> serialPort + where m = long "simulator" <> help "Connect to the simulator instead of a serial port" + +serialPort :: Parser FilePath +serialPort = strOption m + where m = long "port" <> value "/dev/ttyUSB0" <> help "The serial port to connect to" + +main :: IO () +main = execParser i >>= runTerminal + where i = info p $ progDesc "Connect a terminal to an ELM327 device or simulator." + p = helper <*> connectionType + +connect :: ConnectionType -> IO Con +connect ConnectionTypeSimulator = Simulator.connect $ defaultSimulator stoppedCarBus +connect (ConnectionTypeActualDevice dev) = ELM327.connect dev + +runTerminal :: ConnectionType -> IO () +runTerminal ct = bracket (connect ct) + (\c -> putStrLn "Closing connection..." >> Connection.close c) + (liftIO . runTerminalWithConnection) + +runTerminalWithConnection :: Con -> IO () +runTerminalWithConnection = runReaderT (runTerm readEvalPrint) + +readEvalPrint :: Term () +readEvalPrint = runInputT defaultSettings loop + where + loop :: InputT Term () + loop = do + maybeLine <- getInputLine "% " + case maybeLine of Nothing -> return () + Just ":exit" -> return () + Just x -> handleLine x >> loop + +handleLine :: String -> InputT Term () +handleLine cmd = do + con <- lift ask + liftIO $ sendString con $ cmd ++ "\r" + printAll + +printAll :: InputT Term () +printAll = do + maybeBS <- lift ask >>= liftIO . recv + case maybeBS of Nothing -> return () + Just b -> liftIO . putStrLn $ convertResponse b + where + convertResponse = stripPrompt . filter (/= '\0') . Char8.unpack + stripPrompt :: String -> String + stripPrompt x = if "\n>" `isSuffixOf` x then take (length x - 1) x else x diff --git a/obd.cabal b/obd.cabal new file mode 100644 --- /dev/null +++ b/obd.cabal @@ -0,0 +1,76 @@ +name: obd +version: 0.1.0.0 +synopsis: Communicate to OBD interfaces over ELM327 +description: + Haskell library to communicate with OBD-II over ELM327, + with terminal and simulator included. + +homepage: https://github.com/hverr/haskell-obd#readme +license: GPL-3 +license-file: LICENSE +author: Henri Verroken +maintainer: henriverroken@gmail.com +copyright: 2016 Henri Verroken +category: Hardware +build-type: Simple +cabal-version: >=1.10 +tested-with: GHC == 7.10.3, GHC == 8.0.1 + +library + hs-source-dirs: src + exposed-modules: System.Hardware.ELM327 + , System.Hardware.ELM327.Car + , System.Hardware.ELM327.Car.MAP + , System.Hardware.ELM327.Commands + , System.Hardware.ELM327.Connection + , System.Hardware.ELM327.Connection.OBD + , System.Hardware.ELM327.Errors + , System.Hardware.ELM327.OBD.Conversion + , System.Hardware.ELM327.Simulator + , System.Hardware.ELM327.Simulator.OBDBus + , System.Hardware.ELM327.Simulator.OBDBus.VWPolo2007 + other-modules: System.Hardware.ELM327.Utils.Hex + , System.Hardware.ELM327.Utils.Monad + , System.Hardware.ELM327.Utils.Units + build-depends: base >= 4.7 && < 5 + , bytestring >= 0.10.6 && < 0.11 + , dimensional >= 1.0.1.2 && < 1.2 + , either >= 4.4.1.1 && < 4.5 + , io-streams >= 1.3.5.0 && < 1.4 + , lens >= 4.13 && < 4.14 + , mtl >= 2.2.1 && < 2.3 + , serialport >= 0.4.7 && < 0.5 + , split >= 0.2.3.1 && < 0.2.4 + , stm >= 2.4.4.1 && < 2.5 + , stm-chans >= 3.0.0.4 && < 3.1 + , transformers >= 0.4.2.0 && < 0.5 + ghc-options: -Wall + default-language: Haskell2010 + default-extensions: OverloadedStrings + +executable obd-terminal + hs-source-dirs: app + main-is: Terminal.hs + ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall + build-depends: base + , obd + , bytestring >= 0.10.6 && < 0.11 + , haskeline >= 0.7.2.3 && < 0.8 + , mtl >= 2.2.1 && < 2.3 + , optparse-applicative >= 0.12.1.0 && < 0.13 + , transformers >= 0.4.2.0 && < 0.5 + default-language: Haskell2010 + default-extensions: OverloadedStrings + +test-suite obd-test + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: Spec.hs + build-depends: base + , obd + ghc-options: -threaded -rtsopts -with-rtsopts=-N + default-language: Haskell2010 + +source-repository head + type: git + location: https://github.com/hverr/haskell-obd diff --git a/src/System/Hardware/ELM327.hs b/src/System/Hardware/ELM327.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327.hs @@ -0,0 +1,46 @@ +-- | Basic interface for communication with the ELM327. +module System.Hardware.ELM327 where + +import qualified Data.ByteString.Char8 as Char8 + +import System.IO.Streams (makeInputStream, makeOutputStream) + +import System.Hardware.Serialport (CommSpeed(..), + FlowControl(..), + Parity(..), + SerialPortSettings(..), + StopBits(..), + closeSerial, + openSerial) +import qualified System.Hardware.Serialport as Port + +import System.Hardware.ELM327.Commands (AT(..)) +import System.Hardware.ELM327.Connection (Con(..), at) + +-- | Connect to an ELM327 device. +connect :: FilePath -> IO Con +connect fp = do + let s = SerialPortSettings { commSpeed = CS38400 + , bitsPerWord = 8 + , stopb = One + , parity = NoParity + , flowControl = NoFlowControl + , timeout = 2 } + port <- openSerial fp s + is <- makeInputStream (produce port) + os <- makeOutputStream (consume port) + initialize $ Con is os (closeSerial port) + where + produce port = Just <$> Port.recv port 8 + consume _ Nothing = return () + consume port (Just x) = sendAll port x + + sendAll port bs + | Char8.null bs = return () + | otherwise = do sent <- Port.send port bs + sendAll port $ Char8.drop sent bs + + initialize con = do + _ <- at con ATResetAll + _ <- at con ATEchoOff + return con diff --git a/src/System/Hardware/ELM327/Car.hs b/src/System/Hardware/ELM327/Car.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Car.hs @@ -0,0 +1,45 @@ +{-# LANGUAGE NoImplicitPrelude #-} +-- | A generic car data type +module System.Hardware.ELM327.Car where + +import Control.Monad.IO.Class (MonadIO, liftIO) +import Control.Monad.Trans.Either (EitherT(..), runEitherT) + +import Numeric.Units.Dimensional.Prelude + +import System.Hardware.ELM327.Connection (Con) +import System.Hardware.ELM327.Errors (OBDError) +import qualified System.Hardware.ELM327.Connection.OBD as OBD + +-- | Some info about the car. +type I m a = m (Either OBDError a) + +-- | A monad transform for information about the car. +infoT :: I m a -> EitherT OBDError m a +infoT = EitherT + +-- | Run the monad transform for inforamtion about the ar. +runInfoT :: EitherT OBDError m a -> I m a +runInfoT = runEitherT + +-- | A car that has some properties. +data Car m = Car { engineCoolantTemperature :: I m (ThermodynamicTemperature Double) + , engineFuelRate :: I m (VolumeFlow Double) + , engineRPM :: I m (Frequency Double) + , intakeAirTemperature :: I m (ThermodynamicTemperature Double) + , intakeManifoldAbsolutePressure :: I m (Pressure Double) + , massAirFlowRate :: I m (MassFlow Double) + , throttlePosition :: I m Double + , vehicleSpeed :: I m (Velocity Double) } + +-- | The default car, that uses straight forward OBD commands to get +-- most of the data. +defaultCar :: MonadIO m => Con -> Car m +defaultCar c = Car { engineCoolantTemperature = liftIO $ OBD.engineCoolantTemperature c + , engineFuelRate = liftIO $ OBD.engineFuelRate c + , engineRPM = liftIO $ OBD.engineRPM c + , intakeAirTemperature = liftIO $ OBD.intakeAirTemperature c + , intakeManifoldAbsolutePressure = liftIO $ OBD.intakeManifoldAbsolutePressure c + , massAirFlowRate = liftIO $ OBD.massAirFlowRate c + , throttlePosition = liftIO $ OBD.throttlePosition c + , vehicleSpeed = liftIO $ OBD.vehicleSpeed c } diff --git a/src/System/Hardware/ELM327/Car/MAP.hs b/src/System/Hardware/ELM327/Car/MAP.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Car/MAP.hs @@ -0,0 +1,58 @@ +{-# LANGUAGE NoImplicitPrelude #-} +-- | A car that uses the intake manifold absolute pressure (MAP) to +-- calculate fuel consumption. +module System.Hardware.ELM327.Car.MAP ( + MAPProperties +, defaultProperties +, mapCar +) where + +import Control.Monad.IO.Class (MonadIO) + +import Numeric.Units.Dimensional.Prelude + +import System.Hardware.ELM327.Connection (Con) +import System.Hardware.ELM327.Car (Car(..), I, infoT, runInfoT, defaultCar) + + +-- | Some fixed values needed to implement a MAP car. +data MAPProperties = MAPProperties { volumetricEfficiency :: Dimensionless Double + , engineDisplacement :: Volume Double + , airFuelRatio :: Dimensionless Double + , fuelMassDensity :: MassDensity Double } + +-- | The default MAP properties +defaultProperties :: MAPProperties +defaultProperties = MAPProperties { volumetricEfficiency = 0.75 *~ one -- consumer engine + , engineDisplacement = 1198 *~ cubic (centi meter) -- 1.2l + , airFuelRatio = 14.7 *~ one -- chemically ideal + , fuelMassDensity = 750 *~ (kilo gram / cubic meter) -- EUROSUPER 95 + } + +-- | Create a car that uses the intake manifold absolute pressure (MAP) +-- to calculate fuel consumption. +mapCar :: MonadIO m => Con -> MAPProperties ->Car m +mapCar con p = let c = defaultCar con in + c { engineFuelRate = engineFuelRate' p c + , massAirFlowRate = massAirFlowRate' p c} + +-- | Calculate MAF from RPM, MAP and IAT +-- +-- See https://web.archive.org/web/20160323073219/http://www.lightner.net/obd2guru/IMAP_AFcalc.html +massAirFlowRate' :: Monad m => MAPProperties -> Car m -> I m (MassFlow Double) +massAirFlowRate' p c = runInfoT $ do + rpm <- infoT $ engineRPM c + map' <- infoT $ intakeManifoldAbsolutePressure c + iat <- infoT $ intakeAirTemperature c + let imap = rpm * map' / iat / (2 *~ one) + let voleff = volumetricEfficiency p + let displ = engineDisplacement p + let mm = 28.97 *~ (gram / mole) + let r = 8.314 *~ (joule / kelvin / mole) + return $ imap * voleff * displ * mm / r + +-- | Calculate the engine fuel rate from MAF +engineFuelRate' :: Monad m => MAPProperties -> Car m -> I m (VolumeFlow Double) +engineFuelRate' p c = runInfoT $ do + maf <- infoT $ massAirFlowRate' p c + return $ maf / airFuelRatio p / fuelMassDensity p diff --git a/src/System/Hardware/ELM327/Commands.hs b/src/System/Hardware/ELM327/Commands.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Commands.hs @@ -0,0 +1,176 @@ +-- | A list of supported ELM327 commands (incomplete). +module System.Hardware.ELM327.Commands where + +import Control.Lens (Prism', prism', re, (^.), (^?)) +import Data.Bits (shiftR, (.&.), (.|.)) +import Data.Word (Word8, Word16) +import Numeric (readHex) +import Text.Printf (printf) + +-- | A generic command, that can be sent to an ELM327. +data Command = AT AT + | OBD OBD + deriving (Eq, Show) + +-- | A prism between 'String' and 'Command' +command :: Prism' String Command +command = prism' conv mConv + where + conv (AT x) = "AT" ++ x ^. re at + conv (OBD x) = x ^. re obd + + mConv ('A':'T':xs) = AT <$> xs ^? at + mConv xs = OBD <$> xs ^? obd + +-- | An AT command, to configure the ELM327. +data AT = ATDescribeProtocolNumber + | ATEchoOff + | ATReadVoltage + | ATResetAll + | ATSelectProtocol Protocol + | ATVersionID + deriving (Eq, Show) + +-- | A prism between 'String' and 'AT'. +at :: Prism' String AT +at = prism' conv mConv + where + conv ATDescribeProtocolNumber = "DPN" + conv ATEchoOff = "E0" + conv ATReadVoltage = "RV" + conv ATResetAll = "Z" + conv (ATSelectProtocol p) = "SP" ++ p ^. re protocol + conv ATVersionID = "I" + + mConv "DPN" = Just ATDescribeProtocolNumber + mConv "E0" = Just ATEchoOff + mConv "RV" = Just ATReadVoltage + mConv "Z" = Just ATResetAll + mConv ('S':'P':p) = ATSelectProtocol <$> p ^? protocol + mConv "I" = Just ATVersionID + mConv _ = Nothing + +-- | An OBD command, to talk to the vehicle. +-- +-- Every OBD command can be one of several modes. +data OBD = CurrentData CurrentData + deriving (Eq, Show) + +-- | Return the mode of an 'OBD' command. +obdMode :: OBD -> Word8 +obdMode cmd = word16Mode $ cmd ^. re obdWord16 + +-- | Return the PID of an 'OBD' command. +obdPID :: OBD -> Word8 +obdPID cmd = word16PID $ cmd ^. re obdWord16 + +-- | Return the mode of an 'OBD' command represented as a 'Word16'. +word16Mode :: Word16 -> Word8 +word16Mode x = fromIntegral $ shiftR x 8 .&. 0xFF + +-- | Return the PID of an 'OBD' command represented as a 'Word16'. +word16PID :: Word16 -> Word8 +word16PID x = fromIntegral $ x .&. 0xFF + +-- | A prism between 'OBD' and 'Word16' +obdWord16 :: Prism' Word16 OBD +obdWord16 = prism' conv mConv + where + conv (CurrentData x) = 0x0100 .|. fromIntegral (x ^. re currentData) + + mConv x | word16Mode x == 0x01 = CurrentData <$> word16PID x ^? currentData + | otherwise = Nothing + +-- | A prism between 'OBD' and 'String' +obd :: Prism' String OBD +obd = prism' conv mConv + where + conv x = printf "%04X" (x ^. re obdWord16) + mConv s | [(x, "")] <- readHex s = x ^? obdWord16 + | otherwise = Nothing + +-- | An OBD command requesting current vehicle data (mode 0x01). +data CurrentData = OBDEngineCoolantTemperature + | OBDEngineFuelRate + | OBDEngineRPM + | OBDIntakeAirTemperature + | OBDIntakeManifoldAbsolutePressure + | OBDMassAirFlowRate + | OBDSupported01PIDs + | OBDThrottlePosition + | OBDVehicleSpeed + deriving (Eq, Show) + +-- | A prism between 'Word8' and 'CurrentData'. +currentData :: Prism' Word8 CurrentData +currentData = prism' conv mConv + where + conv OBDEngineCoolantTemperature = 0x05 + conv OBDEngineFuelRate = 0x5E + conv OBDEngineRPM = 0x0C + conv OBDIntakeAirTemperature = 0x0F + conv OBDIntakeManifoldAbsolutePressure = 0x0B + conv OBDMassAirFlowRate = 0x10 + conv OBDSupported01PIDs = 0x00 + conv OBDThrottlePosition = 0x11 + conv OBDVehicleSpeed = 0x0D + + mConv 0x05 = Just OBDEngineCoolantTemperature + mConv 0x5E = Just OBDEngineFuelRate + mConv 0x0C = Just OBDEngineRPM + mConv 0x0F = Just OBDIntakeAirTemperature + mConv 0x0B = Just OBDIntakeManifoldAbsolutePressure + mConv 0x10 = Just OBDMassAirFlowRate + mConv 0x00 = Just OBDSupported01PIDs + mConv 0x11 = Just OBDThrottlePosition + mConv 0x0D = Just OBDVehicleSpeed + mConv _ = Nothing + +-- | The protocol used by the ELM327 to connect to your car. +data Protocol = AutomaticProtocol + | SAE_J1850_PWM + | SAE_J1850_VPW + | ISO_9141_2 + | ISO_14230_4_KWP + | ISO_14230_4_KWP_Fast + | ISO_15765_4_CAN_11_Bit_ID_500_KBaud + | ISO_15765_4_CAN_29_Bit_ID_500_KBaud + | ISO_15765_4_CAN_11_Bit_ID_250_KBaud + | ISO_15765_4_CAN_29_Bit_ID_250_KBaud + | SAE_J1939_CAN + | USER1_CAN + | USER2_CAN + deriving (Eq, Show) + +-- | A prism between 'String' and 'Protocol'. +protocol :: Prism' String Protocol +protocol = prism' conv mConv + where + conv AutomaticProtocol = "0" + conv SAE_J1850_PWM = "1" + conv SAE_J1850_VPW = "2" + conv ISO_9141_2 = "3" + conv ISO_14230_4_KWP = "4" + conv ISO_14230_4_KWP_Fast = "5" + conv ISO_15765_4_CAN_11_Bit_ID_500_KBaud = "6" + conv ISO_15765_4_CAN_29_Bit_ID_500_KBaud = "7" + conv ISO_15765_4_CAN_11_Bit_ID_250_KBaud = "8" + conv ISO_15765_4_CAN_29_Bit_ID_250_KBaud = "9" + conv SAE_J1939_CAN = "A" + conv USER1_CAN = "B" + conv USER2_CAN = "C" + + mConv "0" = Just AutomaticProtocol + mConv "1" = Just SAE_J1850_PWM + mConv "2" = Just SAE_J1850_VPW + mConv "3" = Just ISO_9141_2 + mConv "4" = Just ISO_14230_4_KWP + mConv "5" = Just ISO_14230_4_KWP_Fast + mConv "6" = Just ISO_15765_4_CAN_11_Bit_ID_500_KBaud + mConv "7" = Just ISO_15765_4_CAN_29_Bit_ID_500_KBaud + mConv "8" = Just ISO_15765_4_CAN_11_Bit_ID_250_KBaud + mConv "9" = Just ISO_15765_4_CAN_29_Bit_ID_250_KBaud + mConv "A" = Just SAE_J1939_CAN + mConv "B" = Just USER1_CAN + mConv "C" = Just USER2_CAN + mConv _ = Nothing diff --git a/src/System/Hardware/ELM327/Connection.hs b/src/System/Hardware/ELM327/Connection.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Connection.hs @@ -0,0 +1,96 @@ +-- | Basic interface for communication with the ELM327. +module System.Hardware.ELM327.Connection where + +import Control.Lens (re, (^.), (^?)) +import Data.ByteString.Char8 (ByteString) +import Data.Char (isHexDigit) +import Data.List (stripPrefix) +import Data.Maybe (fromMaybe) +import Data.Word (Word8) +import qualified Data.ByteString.Char8 as Char8 + +import System.IO.Streams (InputStream, OutputStream) +import qualified System.IO.Streams as Streams + +import System.Hardware.ELM327.Commands (AT, + Command(..), + OBD, + command, + obdMode, + obdPID) +import System.Hardware.ELM327.Errors (OBDError(..), + OBDDecodeError(..), + obdErrorMessage) +import System.Hardware.ELM327.Utils.Hex (hexToBytes) +import System.Hardware.ELM327.Utils.Monad (maybeToLeft, maybeToRight) + +-- | A connection to an ELM327 device that can be closed. +data Con = Con (InputStream ByteString) (OutputStream ByteString) (IO ()) + +-- | Close the connection +close :: Con -> IO () +close (Con _ _ c) = c + +-- | Send an ELM327 command. +send :: Con -> Command -> IO () +send con cmd = do + sendString con $ cmd ^. re command + sendString con "\r" + flushOutputStream con + +-- | Send all bytes to the ELM327. +sendBytes :: Con -> ByteString -> IO () +sendBytes (Con _ os _) x = Streams.write (Just x) os + +-- | Send a string to the ELM327. +sendString :: Con -> String -> IO () +sendString con = sendBytes con . Char8.pack + +-- | Receive available ELM327 caracters as a byte string +recvRaw :: Con -> IO (Maybe ByteString) +recvRaw (Con is _ _) = Streams.read is + +-- | Receive an ELM327 response as a byte string. +recv :: Con -> IO (Maybe ByteString) +recv (Con is _ _) = do + s <- Char8.concat . reverse <$> recv' [] + if Char8.null s then return Nothing else return (Just s) + where + recv' xs = do + bs <- Streams.read is + case bs of Nothing -> recv' xs + Just bs' -> handle' xs bs' + handle' xs bs = + let (pref, suf) = Char8.break (== '>') . Char8.filter (not . ignored) $ bs in + if Char8.null suf then recv' (pref:xs) + else Streams.unRead (Char8.tail suf) is >> return (pref:xs) + + ignored x = x == '\r' || x == '\0' + +-- | Flush the output stream of a connection. +flushOutputStream :: Con -> IO () +flushOutputStream (Con _ os _) = Streams.write (Just "") os + +-- | Send an 'AT' command and expect a response. +at :: Con -> AT -> IO (Maybe ByteString) +at con cmd = send con (AT cmd) >> recv con + +-- | Send an 'OBD' comand and expect a response. +obd :: Con -> OBD -> IO (Either OBDError [Word8]) +obd con cmd = do + send con (OBD cmd) + mbs <- recv con + case mbs of + Nothing -> return $ Left (OBDDecodeError EmptyResponseError) + Just bs -> return . decode $ Char8.unpack bs + where + decode bs = Right (removeStatusPrefixes bs) + >>= \x -> maybeToLeft x (OBDErrorMessage <$> x ^? obdErrorMessage) + >>= Right . filter isHexDigit + >>= maybeToRight (OBDDecodeError NotEnoughBytesError) . hexToBytes + >>= maybeToRight (OBDDecodeError NoResponseHeaderError) . stripHeader + + statusPrefixes = ["SEARCHING..."] + removeStatusPrefixes x = foldl stripPrefix' x statusPrefixes + stripPrefix' x pref = fromMaybe x (stripPrefix pref x) + stripHeader = stripPrefix [0x40 + obdMode cmd, obdPID cmd] diff --git a/src/System/Hardware/ELM327/Connection/OBD.hs b/src/System/Hardware/ELM327/Connection/OBD.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Connection/OBD.hs @@ -0,0 +1,65 @@ +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE Rank2Types #-} +-- | Send OBD requests to the connection and return a quantity. +module System.Hardware.ELM327.Connection.OBD where + +import Control.Lens (Iso', re, (^.)) +import Control.Monad.Trans.Either (EitherT(..), left) + +import Numeric.Units.Dimensional.Prelude + +import System.Hardware.ELM327.Commands (OBD(..), CurrentData(..)) +import System.Hardware.ELM327.Connection (Con) +import System.Hardware.ELM327.Errors (OBDError(..), OBDDecodeError(..)) +import qualified System.Hardware.ELM327.Connection as Connection +import qualified System.Hardware.ELM327.OBD.Conversion as C + + +-- | Type alias for a request. +type Request a = Con -> IO (Either OBDError a) + +-- | Get the engine coolant temperature. +engineCoolantTemperature :: Request (ThermodynamicTemperature Double) +engineCoolantTemperature = getOneByte OBDEngineCoolantTemperature C.engineCoolantTemperature + +-- | Get the engine fuel rate. +engineFuelRate :: Request (VolumeFlow Double) +engineFuelRate = getTwoBytes OBDEngineFuelRate C.engineFuelRate + +-- | Get the engine RPM. +engineRPM :: Request (Frequency Double) +engineRPM = getTwoBytes OBDEngineRPM C.engineRPM + +-- | Get the intake air temperature. +intakeAirTemperature :: Request (ThermodynamicTemperature Double) +intakeAirTemperature = getOneByte OBDIntakeAirTemperature C.intakeAirTemperature + +-- | Get the intake manifold absolute pressure +intakeManifoldAbsolutePressure :: Request (Pressure Double) +intakeManifoldAbsolutePressure = getOneByte OBDIntakeManifoldAbsolutePressure C.intakeManifoldAbsolutePressure + +-- | Get mass air flow rate. +massAirFlowRate :: Request (MassFlow Double) +massAirFlowRate = getTwoBytes OBDMassAirFlowRate C.massAirFlowRate + +-- | Get throttle position. +throttlePosition :: Request Double +throttlePosition = getOneByte OBDThrottlePosition C.throttlePosition + +-- | Get vehicle speed. +vehicleSpeed :: Request (Velocity Double) +vehicleSpeed = getOneByte OBDVehicleSpeed C.vehicleSpeed + +-- | Get one byte of data and convert it. +getOneByte :: CurrentData -> Iso' a C.OneByte -> Request a +getOneByte cmd conv con = runEitherT $ (^. re conv) <$> (oneByte =<< obd) + where obd = EitherT $ Connection.obd con (CurrentData cmd) + oneByte [x] = return x + oneByte _ = left $ OBDDecodeError NotEnoughBytesError + +-- | Get two bytes of data and convert it. +getTwoBytes :: CurrentData -> Iso' a C.TwoBytes -> Request a +getTwoBytes cmd conv con = runEitherT $ (^. re conv) <$> (twoBytes =<< obd) + where obd = EitherT $ Connection.obd con (CurrentData cmd) + twoBytes [x, y] = return (x, y) + twoBytes _ = left $ OBDDecodeError NotEnoughBytesError diff --git a/src/System/Hardware/ELM327/Errors.hs b/src/System/Hardware/ELM327/Errors.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Errors.hs @@ -0,0 +1,32 @@ +-- | A collection of error types. +module System.Hardware.ELM327.Errors where + +import Control.Lens (Prism', prism') + +-- | Possible errors when issuing OBD commands. +data OBDError = OBDErrorMessage OBDErrorMessage + | OBDDecodeError OBDDecodeError + deriving (Eq, Show) + +-- | Error messages sent by the ELM327 when issuing OBD commands +data OBDErrorMessage = UnableToConnect + | NoData + deriving (Eq, Show) + +-- | A prism between 'String' and 'ELM327Error'. +obdErrorMessage :: Prism' String OBDErrorMessage +obdErrorMessage = prism' conv mConv + where + conv UnableToConnect = "UNABLE TO CONNECT" + conv NoData = "NO DATA" + + mConv "UNABLE TO CONNECT" = Just UnableToConnect + mConv "NO DATA" = Just NoData + mConv _ = Nothing + +-- | Possible decode errors when issuing OBD commands. +data OBDDecodeError = NotEnoughBytesError + | HexDecodeError + | NoResponseHeaderError + | EmptyResponseError + deriving (Eq, Show) diff --git a/src/System/Hardware/ELM327/OBD/Conversion.hs b/src/System/Hardware/ELM327/OBD/Conversion.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/OBD/Conversion.hs @@ -0,0 +1,104 @@ +{-# LANGUAGE NoImplicitPrelude #-} +-- | This module contains structures to convert measurements and +-- values from and to OBD bytes. +module System.Hardware.ELM327.OBD.Conversion where + +import qualified Prelude as P + +import Control.Lens (Iso', iso, re, (^.)) +import Data.Bits (shiftL, shiftR, (.&.)) +import Data.Word (Word8) + +import Numeric.Units.Dimensional.Prelude + +import System.Hardware.ELM327.Utils.Units (rpm) + +-- | Type alias for a tuple of two bytes. +type TwoBytes = (Word8, Word8) + +-- | Convert 'TwoBytes' to a byte array +twoBytes :: TwoBytes -> [Word8] +twoBytes (a, b) = [a, b] + +-- | Type alias for one byte +type OneByte = Word8 + +-- | Convert 'OneByte' to a byte array +oneByte :: OneByte -> [Word8] +oneByte x = [x] + +-- | Convert engine coolant temperature. +engineCoolantTemperature :: Iso' (ThermodynamicTemperature Double) OneByte +engineCoolantTemperature = iso conv mConv + where conv = (^. doubleOneByte) . (P.+ 40) . toDegreeCelsiusAbsolute + mConv = fromDegreeCelsiusAbsolute . (P.- 40) . (^. re doubleOneByte) + +-- | Convert engine fuel rate. +engineFuelRate :: Iso' (VolumeFlow Double) TwoBytes +engineFuelRate = iso conv mConv + where conv = (^. doubleTwoBytes) . (P.* 20) . (/~ (liter / hour)) + mConv = (*~ (liter / hour)) . (P./ 20) . (^. re doubleTwoBytes) + +-- | Convert engine RPM. +engineRPM :: Iso' (Frequency Double) TwoBytes +engineRPM = iso conv mConv + where conv = (^. doubleTwoBytes) . (P.* 4) . (/~ rpm) + mConv = (*~ rpm) . (P./ 4) . (^. re doubleTwoBytes) + +-- | Convert intake air temperature. +intakeAirTemperature :: Iso' (ThermodynamicTemperature Double) OneByte +intakeAirTemperature = iso conv mConv + where conv = (^. doubleOneByte) . (P.+ 40) . toDegreeCelsiusAbsolute + mConv = fromDegreeCelsiusAbsolute . (P.- 40) . (^. re doubleOneByte) + +-- | Convert intake manifold absolute pressure. +intakeManifoldAbsolutePressure :: Iso' (Pressure Double) OneByte +intakeManifoldAbsolutePressure = iso conv mConv + where conv = (^. doubleOneByte) . (/~ kilo pascal) + mConv = (*~ kilo pascal) . (^. re doubleOneByte) + +-- | Convert mass air flow rate. +massAirFlowRate :: Iso' (MassFlow Double) TwoBytes +massAirFlowRate = iso conv mConv + where conv = (^. doubleTwoBytes) . (P.* 100) . (/~ (gram / second)) + mConv = (*~ (gram / second)) . (P./ 100) . (^. re doubleTwoBytes) + +-- | Convert throttle position +throttlePosition :: Iso' Double OneByte +throttlePosition = iso conv mConv + where conv = (^. doubleOneByte) . (P.* 255) + mConv = (P./ 255) . (^. re doubleOneByte) + +-- | Convert vehicle speed +vehicleSpeed :: Iso' (Velocity Double) OneByte +vehicleSpeed = iso conv mConv + where conv = (^. doubleOneByte) . (/~ (kilo meter / second)) + mConv = (*~ (kilo meter / second)) . (^. re doubleOneByte) + +-- | Convert between 'Double' and two bytes. +doubleTwoBytes :: Iso' Double TwoBytes +doubleTwoBytes = iso conv mConv + where conv = (^. integerTwoBytes) . round + mConv = realToFrac . (^. re integerTwoBytes) + +-- | Convert between 'Double' and one byte. +doubleOneByte :: Iso' Double OneByte +doubleOneByte = iso conv mConv + where conv = (^. integerOneByte) . round + mConv = realToFrac + +-- | Convert between 'Int' and two bytes. +integerTwoBytes :: Iso' Int TwoBytes +integerTwoBytes = iso conv mConv + where conv x | x <= 0x0000 = (0x00, 0x00) + | x >= 0xFFFF = (0xFF, 0xFF) + | otherwise = (fromIntegral $ shiftR x 8 .&. 0xFF, fromIntegral $ x .&. 0xFF) + mConv (a, b) = shiftL (fromIntegral a) 8 P.+ fromIntegral b + +-- | Conver between 'Int' and one byte. +integerOneByte :: Iso' Int OneByte +integerOneByte = iso conv mConv + where conv x | x <= 0x00 = 0x00 + | x >= 0xFF = 0xFF + | otherwise = fromIntegral x + mConv = fromIntegral diff --git a/src/System/Hardware/ELM327/Simulator.hs b/src/System/Hardware/ELM327/Simulator.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Simulator.hs @@ -0,0 +1,230 @@ +-- | Module that simulates an ELM327 device. +module System.Hardware.ELM327.Simulator ( + -- * Initializing the simulator + Simulator(..) +, defaultSimulator + + -- * Interacting with the simulator +, connect +, handle + + -- * Attributes of the simulator +, ConnectedProtocol(..) +, Echo(..) +, obdBus +, chosenProtocol +, connectedProtocol +, echo +, pin2Voltage +, versionID +) where + +import Control.Concurrent (forkIO) +import Control.Concurrent.STM (TMVar, atomically, newTMVarIO, takeTMVar, putTMVar) +import Control.Concurrent.STM.TMChan (TMChan, newTMChanIO, closeTMChan, readTMChan, writeTMChan) +import Control.Lens (Lens', lens, (^.), (^?), (.~), re) +import Control.Monad (void) +import Control.Monad.State (StateT, runState, runStateT, get, put) +import Control.Monad.IO.Class (liftIO) +import Data.ByteString.Char8 (ByteString) +import Data.Char (isHexDigit, toUpper) +import Text.Printf (printf) +import qualified Data.ByteString.Char8 as Char8 + +import Numeric.Units.Dimensional.Prelude (ElectricPotential, volt, (*~), (/~)) + +import System.IO.Streams (makeInputStream, makeOutputStream) + +import System.Hardware.ELM327.Commands (AT(..), Command(..), command, + Protocol(..), protocol, + obdMode, obdPID) +import System.Hardware.ELM327.Connection (Con(..)) +import System.Hardware.ELM327.Simulator.OBDBus (OBDBus) +import System.Hardware.ELM327.Utils.Hex (bytesToHex) +import qualified System.Hardware.ELM327.Simulator.OBDBus as OBDBus + +-- | An actual simulator, with underlying bus, that holds all state. +data Simulator bus = Simulator { _obdBus :: bus + , _chosenProtocol :: Protocol + , _connectedProtocol :: ConnectedProtocol + , _echo :: Echo + , _pin2Voltage :: ElectricPotential Double + , _versionID :: String } + deriving (Show) + +-- | The default simulator, initialized with a given protocol +defaultSimulator :: OBDBus bus => bus -> Simulator bus +defaultSimulator b = Simulator { _obdBus = b + , _chosenProtocol = AutomaticProtocol + , _connectedProtocol = NotConnected + , _echo = EchoOff + , _pin2Voltage = 12.3 *~ volt + , _versionID = "ELM327 v2.1" } + +-- | Private data declaration that represents a connection to the simulator. +data SimCon bus = SimCon { _conInputBuffer :: TMChan ByteString + , _conOutputBuffer :: TMChan ByteString + , _unhandledInput :: TMVar ByteString } + +-- | Initialize a 'SimulatorCon' +simCon :: IO (SimCon bus) +simCon = do + ib <- newTMChanIO + ob <- newTMChanIO + ui <- newTMVarIO "" + return SimCon { _conInputBuffer = ib + , _conOutputBuffer = ob + , _unhandledInput = ui } + +-- | Connect to the simulator. +connect :: OBDBus bus => Simulator bus -> IO Con +connect s = do + c <- simCon + is <- makeInputStream (produce c) + os <- makeOutputStream (consume c) + _ <- forkIO . void $ runStateT (runSimulator c) s + return $ Con is os (atomically $ closeTMChan (_conInputBuffer c)) + where + produce = atomically . readTMChan . _conOutputBuffer + consume _ Nothing = return () + consume c (Just x) = atomically $ writeTMChan (_conInputBuffer c) x + + runSimulator :: OBDBus bus => SimCon bus -> StateT (Simulator bus) IO () + runSimulator c = do + next <- liftIO $ recv c + case next of + Nothing -> liftIO . atomically $ closeTMChan (_conOutputBuffer c) + Just cmd -> do response <- handle (Char8.unpack cmd) + liftIO . atomically $ writeTMChan (_conOutputBuffer c) (Char8.pack response) + runSimulator c + + recv c = atomically $ recv' c =<< takeTMVar (_unhandledInput c) + recv' c bs = do + let (pref, suf) = Char8.break (== '\r') bs + if Char8.null suf then do next <- readTMChan (_conInputBuffer c) + case next of Nothing -> return Nothing + Just x -> recv' c (Char8.append bs x) + else do putTMVar (_unhandledInput c) (Char8.tail suf) + return $ Just pref + +-- | Private data declaration that represents a parsed command (used in 'handle') +data ParsedCommand = InvalidCommand + | KnownCommand Command + | UnknownOBD String + +-- | Parse a command from a serial line +parsedCommand :: String -> ParsedCommand +parsedCommand = parsedCommand' . map toUpper . filter (/= ' ') + where + parsedCommand' c@('A':'T':_) = maybe InvalidCommand KnownCommand (c ^? command) + parsedCommand' c | all isHexDigit c = maybe (UnknownOBD c) KnownCommand (c ^? command) + | otherwise = InvalidCommand + +-- | Make the simulator handle a command. +handle :: (Monad m, OBDBus bus) => String -> StateT (Simulator bus) m String +handle cmd = handle' $ parsedCommand cmd + where + handle' :: (Monad m, OBDBus bus) => ParsedCommand -> StateT (Simulator bus) m String + handle' InvalidCommand = return "?" + handle' (UnknownOBD _) = reply . either id (++ "NO DATA") <$> connectToBus + handle' (KnownCommand x) = handle'' x + handle'' (OBD x) = do + connectStatus <- connectToBus + case connectStatus of + Left errMsg -> return $ reply errMsg + Right conMsg -> do + bus <- (^. obdBus) <$> get + let (resp, bus') = runState (OBDBus.request x) bus + (obdBus .~ bus') <$> get >>= put + case resp of + Nothing -> return . reply $ conMsg ++ "NO DATA" + Just v -> return . reply . (conMsg ++) . bytesToHex " " $ [obdMode x + 0x40, obdPID x] ++ v + handle'' (AT ATDescribeProtocolNumber) = reply <$> describeProtocolNumber + handle'' (AT ATEchoOff) = reply <$> echoOff + handle'' (AT ATReadVoltage) = reply <$> readVoltage + handle'' (AT ATResetAll) = reply <$> resetAll + handle'' (AT (ATSelectProtocol p)) = reply <$> selectProtocol p + handle'' (AT ATVersionID) = reply . (^. versionID) <$> get + + reply = (++ "\r>") + +-- | The protocol the ELM327 simulator is setup to use. +data ConnectedProtocol = NotConnected + | ManuallyChosen Protocol + | AutomaticallyChosen Protocol + deriving (Eq, Show) + +-- | The echo settings of the ELM327. +data Echo = EchoOn | EchoOff deriving (Eq, Show) + +-- | The actual underlying simulated bus of the simulator. +obdBus :: OBDBus bus => Lens' (Simulator bus) bus +obdBus = lens _obdBus $ \s x -> s { _obdBus = x } + +-- | The protocol the simulator should try to connect with. +chosenProtocol :: Lens' (Simulator bus) Protocol +chosenProtocol = lens _chosenProtocol $ \s x -> s { _chosenProtocol = x } + +-- | The protocol the ELM327 simulator is connected with. +connectedProtocol :: Lens' (Simulator bus) ConnectedProtocol +connectedProtocol = lens _connectedProtocol $ \s x -> s { _connectedProtocol = x } + +-- | The echo settings of the ELM327. +echo :: Lens' (Simulator bus) Echo +echo = lens _echo $ \s x -> s { _echo = x } + +-- | The voltage on pin 2 (most likely the battery voltage) +pin2Voltage :: Lens' (Simulator bus) (ElectricPotential Double) +pin2Voltage = lens _pin2Voltage $ \s x -> s { _pin2Voltage = x } + +-- | The version ID of the ELM327. +versionID :: Lens' (Simulator bus) String +versionID = lens _versionID $ \s x -> s { _versionID = x } + +-- | If the command is just a setting change, the ELM327 will reply with OK. +replyOK :: Monad m => StateT (Simulator bus) m String +replyOK = return "OK" + +-- | Connect to the underlying bus +-- +-- If the connection fails, the result will be 'Left errorMessage', otherwise +-- the result will be 'Right statusMessage'. +connectToBus :: (Monad m, OBDBus bus) => StateT (Simulator bus) m (Either String String) +connectToBus = do + cp <- (^. connectedProtocol) <$> get + bus <- OBDBus.protocol . (^. obdBus) <$> get + chosen <- (^. chosenProtocol) <$> get + case (cp, chosen) of + (NotConnected, AutomaticProtocol) -> do + (connectedProtocol .~ AutomaticallyChosen bus) <$> get >>= put + return $ Right "SEARCHING..." + (NotConnected, _) -> + if bus /= chosen + then return $ Left "UNABLE TO CONNECT" + else do (connectedProtocol .~ ManuallyChosen bus) <$> get >>= put + return $ Right "" + (_, _) -> return $ Right "" + +-- | Describe the protocol number +describeProtocolNumber :: Monad m => StateT (Simulator bus) m String +describeProtocolNumber = do + cp <- (^. connectedProtocol) <$> get + case cp of NotConnected -> return $ "A" ++ AutomaticProtocol ^. re protocol + ManuallyChosen p -> return $ p ^. re protocol + AutomaticallyChosen p -> return $ "A" ++ p ^. re protocol + +-- | Turn echo off +echoOff :: Monad m => StateT (Simulator bus) m String +echoOff = (echo .~ EchoOff) <$> get >>= put >> replyOK + +-- | Read the battery voltage +readVoltage :: Monad m => StateT (Simulator bus) m String +readVoltage = printf "%.1f" . (/~ volt) . (^. pin2Voltage) <$> get + +-- | Fully reset the device +resetAll :: (Monad m, OBDBus bus) => StateT (Simulator bus) m String +resetAll = defaultSimulator . (^. obdBus) <$> get >>= put >> return "" + +-- | Select a protocol +selectProtocol :: Monad m => Protocol -> StateT (Simulator bus) m String +selectProtocol p = (chosenProtocol .~ p) <$> get >>= put >> replyOK diff --git a/src/System/Hardware/ELM327/Simulator/OBDBus.hs b/src/System/Hardware/ELM327/Simulator/OBDBus.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Simulator/OBDBus.hs @@ -0,0 +1,14 @@ +{-# LANGUAGE GADTs #-} +-- | Generic interface for an OBD bus that is supported by the ELM327 'Simulator'. +module System.Hardware.ELM327.Simulator.OBDBus where + +import Control.Monad.State (State) +import Data.Word (Word8) + +import System.Hardware.ELM327.Commands (Protocol) +import qualified System.Hardware.ELM327.Commands as Commands + +-- | An underlying bus that is supported by the ELM327 'Simulator'. +class OBDBus bus where + protocol :: bus -> Protocol + request :: Commands.OBD -> State bus (Maybe [Word8]) diff --git a/src/System/Hardware/ELM327/Simulator/OBDBus/VWPolo2007.hs b/src/System/Hardware/ELM327/Simulator/OBDBus/VWPolo2007.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Simulator/OBDBus/VWPolo2007.hs @@ -0,0 +1,85 @@ +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE FlexibleContexts #-} +-- | Simulated bus of a Volkswagen Polo 2007. +module System.Hardware.ELM327.Simulator.OBDBus.VWPolo2007 where + +import Control.Lens (Lens', lens, (^.)) +import Control.Monad.State (get) +import Data.Word (Word8) + +import Numeric.Units.Dimensional.Prelude + +import System.Hardware.ELM327.Commands (CurrentData(..), OBD(..), Protocol(ISO_14230_4_KWP)) +import System.Hardware.ELM327.Simulator.OBDBus (OBDBus, protocol, request) + +import qualified System.Hardware.ELM327.OBD.Conversion as C + +-- | State of the simulated bus. +data VWPolo2007Bus = Bus { _engineCoolantTemperature :: ThermodynamicTemperature Double + , _engineRPM :: Frequency Double + , _intakeAirTemperature :: ThermodynamicTemperature Double + , _intakeManifoldAbsolutePressure :: Pressure Double + , _massAirFlowRate :: MassFlow Double + , _throttlePosition :: Double + , _vehicleSpeed :: Velocity Double } + deriving (Show) + +-- | Supported mode 0x01 PIDs of the bus +supported01PIDs :: [Word8] +supported01PIDs = [0xBE, 0x3E, 0xB8, 0x11] + +-- | The 'VWPolo2007Bus' is an instance of 'OBDBus'. +instance OBDBus VWPolo2007Bus where + protocol _ = ISO_14230_4_KWP + request (CurrentData x) = reqCD x + where + reqCD OBDEngineCoolantTemperature = oneByte engineCoolantTemperature C.engineCoolantTemperature <$> get + reqCD OBDEngineFuelRate = return Nothing + reqCD OBDEngineRPM = twoBytes engineRPM C.engineRPM <$> get + reqCD OBDIntakeAirTemperature = oneByte intakeAirTemperature C.intakeAirTemperature <$> get + reqCD OBDIntakeManifoldAbsolutePressure = oneByte intakeManifoldAbsolutePressure C.intakeManifoldAbsolutePressure <$> get + reqCD OBDMassAirFlowRate = twoBytes massAirFlowRate C.massAirFlowRate <$> get + reqCD OBDSupported01PIDs = return $ Just supported01PIDs + reqCD OBDThrottlePosition = oneByte throttlePosition C.throttlePosition <$> get + reqCD OBDVehicleSpeed = oneByte vehicleSpeed C.vehicleSpeed <$> get + + oneByte getter isomorph = Just . C.oneByte . (^. (getter . isomorph)) + twoBytes getter isomorph = Just . C.twoBytes . (^. (getter . isomorph)) + +-- | The bus of a stopped car +stoppedCarBus :: VWPolo2007Bus +stoppedCarBus = Bus { _engineCoolantTemperature = fromDegreeCelsiusAbsolute 20 + , _engineRPM = _0 + , _intakeAirTemperature = fromDegreeCelsiusAbsolute 20 + , _intakeManifoldAbsolutePressure = _0 + , _massAirFlowRate = _0 + , _throttlePosition = 0 + , _vehicleSpeed = _0 } + +-- | The engine coolant temperature. +engineCoolantTemperature :: Lens' VWPolo2007Bus (ThermodynamicTemperature Double) +engineCoolantTemperature = lens _engineCoolantTemperature $ \b x -> b { _engineCoolantTemperature = x } + +-- | The engine RPM. +engineRPM :: Lens' VWPolo2007Bus (Frequency Double) +engineRPM = lens _engineRPM $ \b x -> b { _engineRPM = x } + +-- | The intake air temperature. +intakeAirTemperature :: Lens' VWPolo2007Bus (ThermodynamicTemperature Double) +intakeAirTemperature = lens _intakeAirTemperature $ \b x -> b { _intakeAirTemperature = x } + +-- | The intake manifold absolute pressure. +intakeManifoldAbsolutePressure :: Lens' VWPolo2007Bus (Pressure Double) +intakeManifoldAbsolutePressure = lens _intakeManifoldAbsolutePressure $ \b x -> b { _intakeManifoldAbsolutePressure = x } + +-- | The mass air flow rate. +massAirFlowRate :: Lens' VWPolo2007Bus (MassFlow Double) +massAirFlowRate = lens _massAirFlowRate $ \b x -> b { _massAirFlowRate = x } + +-- | The mass air flow rate. +throttlePosition :: Lens' VWPolo2007Bus Double +throttlePosition = lens _throttlePosition $ \b x -> b { _throttlePosition = x } + +-- | The speed of the vehicle. +vehicleSpeed :: Lens' VWPolo2007Bus (Velocity Double) +vehicleSpeed = lens _vehicleSpeed $ \b x -> b { _vehicleSpeed = x } diff --git a/src/System/Hardware/ELM327/Utils/Hex.hs b/src/System/Hardware/ELM327/Utils/Hex.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Utils/Hex.hs @@ -0,0 +1,25 @@ +-- | Collection of functions to deal with hexadecimal encoding. +module System.Hardware.ELM327.Utils.Hex where + +import Data.List (intercalate) +import Data.List.Split (chunksOf) +import Data.Word (Word8) +import Numeric (readHex) +import Text.Printf (printf) + +-- | Convert an even list of hexadecimal characters to a list of Word8 values. +-- +-- If the list is not even, or the string contains a non-hexadecimal +-- character, 'Nothing' is returned. +hexToBytes :: String -> Maybe [Word8] +hexToBytes = mapM pairToWord8 . chunksOf 2 + where + pairToWord8 s@[_, _] | [(x, "")] <- readHex s = Just x + | otherwise = Nothing + pairToWord8 _ = Nothing + +-- | Convert a list of bytes to a hexadecimal string. +-- +-- Use seperator as a seperator between each byte in the resulting string. +bytesToHex :: String -> [Word8] -> String +bytesToHex sep = intercalate sep . map (printf "%02X") diff --git a/src/System/Hardware/ELM327/Utils/Monad.hs b/src/System/Hardware/ELM327/Utils/Monad.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Utils/Monad.hs @@ -0,0 +1,12 @@ +-- | Collection of helper functions to deal with monads. +module System.Hardware.ELM327.Utils.Monad where + +-- | Convert 'Maybe a' to 'Either a b'. +maybeToLeft :: b -> Maybe a -> Either a b +maybeToLeft _ (Just x) = Left x +maybeToLeft x Nothing = Right x + +-- | Convert 'Maybe a' to 'Either b a'. +maybeToRight :: b -> Maybe a -> Either b a +maybeToRight _ (Just x) = Right x +maybeToRight x Nothing = Left x diff --git a/src/System/Hardware/ELM327/Utils/Units.hs b/src/System/Hardware/ELM327/Utils/Units.hs new file mode 100644 --- /dev/null +++ b/src/System/Hardware/ELM327/Utils/Units.hs @@ -0,0 +1,16 @@ +{-# LANGUAGE DataKinds #-} +-- | Helper functions to work with dimensions. +module System.Hardware.ELM327.Utils.Units where + +import Data.Ratio ((%)) + +import Numeric.Units.Dimensional.Prelude (DFrequency, + Metricality(NonMetric), + Unit, + hertz, + mkUnitQ) +import Numeric.Units.Dimensional.UnitNames (atom) + +-- | Declare rounds per minute +rpm :: Fractional a => Unit 'NonMetric DFrequency a +rpm = mkUnitQ (atom "rpm" "rpm" "rpm") (1 % 60) hertz diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,2 @@ +main :: IO () +main = putStrLn "Test suite not yet implemented"