From d49373aa2792bb0dc20400d9a25089e87809b30f Mon Sep 17 00:00:00 2001 From: Wolfgang Kracht Date: Sat, 27 Feb 2021 16:57:47 +0100 Subject: [PATCH] Initial commit --- .gitattributes | 2 + .gitignore | 2 + LICENSE | 674 +++++++++++++ README.md | 20 + lib/BME280_driver/bme280.c | 1589 +++++++++++++++++++++++++++++++ lib/BME280_driver/bme280.h | 395 ++++++++ lib/BME280_driver/bme280_defs.h | 470 +++++++++ platformio.ini | 16 + src/BME280wrapper.cpp | 156 +++ src/BME280wrapper.h | 32 + src/main.cpp | 67 ++ 11 files changed, 3423 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 lib/BME280_driver/bme280.c create mode 100644 lib/BME280_driver/bme280.h create mode 100644 lib/BME280_driver/bme280_defs.h create mode 100644 platformio.ini create mode 100644 src/BME280wrapper.cpp create mode 100644 src/BME280wrapper.h create mode 100644 src/main.cpp diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3b8da3a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.pio +.vscode \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e62ec04 --- /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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..62761a1 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# ESP8266-BME280_driver_wrapper + +There are several approaches for a BME280 interface class, this is one of them. I had issues with high noise. +Imho, triggering the ESP8266 watchdog reset when the I2C setup of the BME280 device fails is a bad design, but copied often. + +The data sheet of the BME280 strongly recommends to use the original driver from Bosch. Therfore I gave it a try. +Refer to: https://github.com/BoschSensortec/BME280_driver The original source code is somewhat old fashioned c language, but VS-Code/platform.io compiles it with no issues. + +This BME280wrapper class is just a c++ wrapper class for the original Bosch source located in the lib folder. +The structure of this repository complies to a pattform.io project. + +Using an Arduino IDE you may need to move the source files of the lib folder to the main folder. I'm not using the Arduino IDE anymore. The VS-Code/platform.io IDE is much more confortable and I recommend to use it instead. + +To change the oversampling and filter coefficients of the BME280 device, please edit the parameters in the BME280wrapper::setup function directly. My approach was to achieve the higest precision available against lowest power consumption possible. + +To minimize the power consumption when battery powered you may supply the BME280 by a switchable GPIO output of the ESP8266. +This means a hard reset for the BME280 in every deep sleep loop and may result in slightly higher noise. + +If you wannt to run the ESP8266 in deep sleep loop just uncomment the line "#define ESP_DEEP_SLEEP" in main.cpp. +Please note that a functional deep sleep loop requires D8 (GPIO16) to be connectet to RST pin of the ESP8266. diff --git a/lib/BME280_driver/bme280.c b/lib/BME280_driver/bme280.c new file mode 100644 index 0000000..df31bea --- /dev/null +++ b/lib/BME280_driver/bme280.c @@ -0,0 +1,1589 @@ +/** +* Copyright (c) 2020 Bosch Sensortec GmbH. All rights reserved. +* +* BSD-3-Clause +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions are met: +* +* 1. Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* +* 2. Redistributions in binary form must reproduce the above copyright +* notice, this list of conditions and the following disclaimer in the +* documentation and/or other materials provided with the distribution. +* +* 3. Neither the name of the copyright holder nor the names of its +* contributors may be used to endorse or promote products derived from +* this software without specific prior written permission. +* +* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +* POSSIBILITY OF SUCH DAMAGE. +* +* @file bme280.c +* @date 2020-03-28 +* @version v3.5.0 +* +*/ + +/*! @file bme280.c + * @brief Sensor driver for BME280 sensor + */ +#include "bme280.h" + +/**\name Internal macros */ +/* To identify osr settings selected by user */ +#define OVERSAMPLING_SETTINGS UINT8_C(0x07) + +/* To identify filter and standby settings selected by user */ +#define FILTER_STANDBY_SETTINGS UINT8_C(0x18) + +/*! + * @brief This internal API puts the device to sleep mode. + * + * @param[in] dev : Structure instance of bme280_dev. + * + * @return Result of API execution status. + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t put_device_to_sleep(struct bme280_dev *dev); + +/*! + * @brief This internal API writes the power mode in the sensor. + * + * @param[in] dev : Structure instance of bme280_dev. + * @param[in] sensor_mode : Variable which contains the power mode to be set. + * + * @return Result of API execution status. + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t write_power_mode(uint8_t sensor_mode, struct bme280_dev *dev); + +/*! + * @brief This internal API is used to validate the device pointer for + * null conditions. + * + * @param[in] dev : Structure instance of bme280_dev. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t null_ptr_check(const struct bme280_dev *dev); + +/*! + * @brief This internal API interleaves the register address between the + * register data buffer for burst write operation. + * + * @param[in] reg_addr : Contains the register address array. + * @param[out] temp_buff : Contains the temporary buffer to store the + * register data and register address. + * @param[in] reg_data : Contains the register data to be written in the + * temporary buffer. + * @param[in] len : No of bytes of data to be written for burst write. + * + */ +static void interleave_reg_addr(const uint8_t *reg_addr, uint8_t *temp_buff, const uint8_t *reg_data, uint8_t len); + +/*! + * @brief This internal API reads the calibration data from the sensor, parse + * it and store in the device structure. + * + * @param[in] dev : Structure instance of bme280_dev. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t get_calib_data(struct bme280_dev *dev); + +/*! + * @brief This internal API is used to parse the temperature and + * pressure calibration data and store it in the device structure. + * + * @param[out] dev : Structure instance of bme280_dev to store the calib data. + * @param[in] reg_data : Contains the calibration data to be parsed. + * + */ +static void parse_temp_press_calib_data(const uint8_t *reg_data, struct bme280_dev *dev); + +/*! + * @brief This internal API is used to parse the humidity calibration data + * and store it in device structure. + * + * @param[out] dev : Structure instance of bme280_dev to store the calib data. + * @param[in] reg_data : Contains calibration data to be parsed. + * + */ +static void parse_humidity_calib_data(const uint8_t *reg_data, struct bme280_dev *dev); + +#ifdef BME280_FLOAT_ENABLE + +/*! + * @brief This internal API is used to compensate the raw pressure data and + * return the compensated pressure data in double data type. + * + * @param[in] uncomp_data : Contains the uncompensated pressure data. + * @param[in] calib_data : Pointer to the calibration data structure. + * + * @return Compensated pressure data in double. + * + */ +static double compensate_pressure(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data); + +/*! + * @brief This internal API is used to compensate the raw humidity data and + * return the compensated humidity data in double data type. + * + * @param[in] uncomp_data : Contains the uncompensated humidity data. + * @param[in] calib_data : Pointer to the calibration data structure. + * + * @return Compensated humidity data in double. + * + */ +static double compensate_humidity(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data); + +/*! + * @brief This internal API is used to compensate the raw temperature data and + * return the compensated temperature data in double data type. + * + * @param[in] uncomp_data : Contains the uncompensated temperature data. + * @param[in] calib_data : Pointer to calibration data structure. + * + * @return Compensated temperature data in double. + * + */ +static double compensate_temperature(const struct bme280_uncomp_data *uncomp_data, + struct bme280_calib_data *calib_data); + +#else + +/*! + * @brief This internal API is used to compensate the raw temperature data and + * return the compensated temperature data in integer data type. + * + * @param[in] uncomp_data : Contains the uncompensated temperature data. + * @param[in] calib_data : Pointer to calibration data structure. + * + * @return Compensated temperature data in integer. + * + */ +static int32_t compensate_temperature(const struct bme280_uncomp_data *uncomp_data, + struct bme280_calib_data *calib_data); + +/*! + * @brief This internal API is used to compensate the raw pressure data and + * return the compensated pressure data in integer data type. + * + * @param[in] uncomp_data : Contains the uncompensated pressure data. + * @param[in] calib_data : Pointer to the calibration data structure. + * + * @return Compensated pressure data in integer. + * + */ +static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data); + +/*! + * @brief This internal API is used to compensate the raw humidity data and + * return the compensated humidity data in integer data type. + * + * @param[in] uncomp_data : Contains the uncompensated humidity data. + * @param[in] calib_data : Pointer to the calibration data structure. + * + * @return Compensated humidity data in integer. + * + */ +static uint32_t compensate_humidity(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data); + +#endif + +/*! + * @brief This internal API is used to identify the settings which the user + * wants to modify in the sensor. + * + * @param[in] sub_settings : Contains the settings subset to identify particular + * group of settings which the user is interested to change. + * @param[in] desired_settings : Contains the user specified settings. + * + * @return Indicates whether user is interested to modify the settings which + * are related to sub_settings. + * @return True -> User wants to modify this group of settings + * @return False -> User does not want to modify this group of settings + * + */ +static uint8_t are_settings_changed(uint8_t sub_settings, uint8_t desired_settings); + +/*! + * @brief This API sets the humidity over sampling settings of the sensor. + * + * @param[in] dev : Structure instance of bme280_dev. + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t set_osr_humidity_settings(const struct bme280_settings *settings, struct bme280_dev *dev); + +/*! + * @brief This internal API sets the oversampling settings for pressure, + * temperature and humidity in the sensor. + * + * @param[in] desired_settings : Variable used to select the settings which + * are to be set. + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * @param[in] dev : Structure instance of bme280_dev. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t set_osr_settings(uint8_t desired_settings, const struct bme280_settings *settings, + struct bme280_dev *dev); + +/*! + * @brief This API sets the pressure and/or temperature oversampling settings + * in the sensor according to the settings selected by the user. + * + * @param[in] dev : Structure instance of bme280_dev. + * @param[in] desired_settings: variable to select the pressure and/or + * temperature oversampling settings. + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t set_osr_press_temp_settings(uint8_t desired_settings, + const struct bme280_settings *settings, + struct bme280_dev *dev); + +/*! + * @brief This internal API fills the pressure oversampling settings provided by + * the user in the data buffer so as to write in the sensor. + * + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * @param[out] reg_data : Variable which is filled according to the pressure + * oversampling data provided by the user. + * + */ +static void fill_osr_press_settings(uint8_t *reg_data, const struct bme280_settings *settings); + +/*! + * @brief This internal API fills the temperature oversampling settings provided + * by the user in the data buffer so as to write in the sensor. + * + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * @param[out] reg_data : Variable which is filled according to the temperature + * oversampling data provided by the user. + * + */ +static void fill_osr_temp_settings(uint8_t *reg_data, const struct bme280_settings *settings); + +/*! + * @brief This internal API sets the filter and/or standby duration settings + * in the sensor according to the settings selected by the user. + * + * @param[in] dev : Structure instance of bme280_dev. + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * @param[in] settings : Structure instance of bme280_settings. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t set_filter_standby_settings(uint8_t desired_settings, + const struct bme280_settings *settings, + struct bme280_dev *dev); + +/*! + * @brief This internal API fills the filter settings provided by the user + * in the data buffer so as to write in the sensor. + * + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * @param[out] reg_data : Variable which is filled according to the filter + * settings data provided by the user. + * + */ +static void fill_filter_settings(uint8_t *reg_data, const struct bme280_settings *settings); + +/*! + * @brief This internal API fills the standby duration settings provided by the + * user in the data buffer so as to write in the sensor. + * + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * @param[out] reg_data : Variable which is filled according to the standby + * settings data provided by the user. + * + */ +static void fill_standby_settings(uint8_t *reg_data, const struct bme280_settings *settings); + +/*! + * @brief This internal API parse the oversampling(pressure, temperature + * and humidity), filter and standby duration settings and store in the + * device structure. + * + * @param[in] settings : Pointer variable which contains the settings to + * be get in the sensor. + * @param[in] reg_data : Register data to be parsed. + * + */ +static void parse_device_settings(const uint8_t *reg_data, struct bme280_settings *settings); + +/*! + * @brief This internal API reloads the already existing device settings in the + * sensor after soft reset. + * + * @param[in] dev : Structure instance of bme280_dev. + * @param[in] settings : Pointer variable which contains the settings to + * be set in the sensor. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +static int8_t reload_device_settings(const struct bme280_settings *settings, struct bme280_dev *dev); + +/****************** Global Function Definitions *******************************/ + +/*! + * @brief This API is the entry point. + * It reads the chip-id and calibration data from the sensor. + */ +int8_t bme280_init(struct bme280_dev *dev) +{ + int8_t rslt; + + /* chip id read try count */ + uint8_t try_count = 5; + uint8_t chip_id = 0; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + /* Proceed if null check is fine */ + if (rslt == BME280_OK) + { + while (try_count) + { + /* Read the chip-id of bme280 sensor */ + rslt = bme280_get_regs(BME280_CHIP_ID_ADDR, &chip_id, 1, dev); + + /* Check for chip id validity */ + if ((rslt == BME280_OK) && (chip_id == BME280_CHIP_ID)) + { + dev->chip_id = chip_id; + + /* Reset the sensor */ + rslt = bme280_soft_reset(dev); + + if (rslt == BME280_OK) + { + /* Read the calibration data */ + rslt = get_calib_data(dev); + } + + break; + } + + /* Wait for 1 ms */ + dev->delay_us(1000, dev->intf_ptr); + --try_count; + } + + /* Chip id check failed */ + if (!try_count) + { + rslt = BME280_E_DEV_NOT_FOUND; + } + } + + return rslt; +} + +/*! + * @brief This API reads the data from the given register address of the sensor. + */ +int8_t bme280_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, struct bme280_dev *dev) +{ + int8_t rslt; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + /* Proceed if null check is fine */ + if ((rslt == BME280_OK) && (reg_data != NULL)) + { + /* If interface selected is SPI */ + if (dev->intf != BME280_I2C_INTF) + { + reg_addr = reg_addr | 0x80; + } + + /* Read the data */ + dev->intf_rslt = dev->read(reg_addr, reg_data, len, dev->intf_ptr); + + /* Check for communication error */ + if (dev->intf_rslt != BME280_INTF_RET_SUCCESS) + { + rslt = BME280_E_COMM_FAIL; + } + } + else + { + rslt = BME280_E_NULL_PTR; + } + + return rslt; +} + +/*! + * @brief This API writes the given data to the register address + * of the sensor. + */ +int8_t bme280_set_regs(uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t temp_buff[20]; /* Typically not to write more than 10 registers */ + + if (len > 10) + { + len = 10; + } + + uint16_t temp_len; + uint8_t reg_addr_cnt; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + /* Check for arguments validity */ + if ((rslt == BME280_OK) && (reg_addr != NULL) && (reg_data != NULL)) + { + if (len != 0) + { + temp_buff[0] = reg_data[0]; + + /* If interface selected is SPI */ + if (dev->intf != BME280_I2C_INTF) + { + for (reg_addr_cnt = 0; reg_addr_cnt < len; reg_addr_cnt++) + { + reg_addr[reg_addr_cnt] = reg_addr[reg_addr_cnt] & 0x7F; + } + } + + /* Burst write mode */ + if (len > 1) + { + /* Interleave register address w.r.t data for + * burst write + */ + interleave_reg_addr(reg_addr, temp_buff, reg_data, len); + temp_len = ((len * 2) - 1); + } + else + { + temp_len = len; + } + + dev->intf_rslt = dev->write(reg_addr[0], temp_buff, temp_len, dev->intf_ptr); + + /* Check for communication error */ + if (dev->intf_rslt != BME280_INTF_RET_SUCCESS) + { + rslt = BME280_E_COMM_FAIL; + } + } + else + { + rslt = BME280_E_INVALID_LEN; + } + } + else + { + rslt = BME280_E_NULL_PTR; + } + + return rslt; +} + +/*! + * @brief This API sets the oversampling, filter and standby duration + * (normal mode) settings in the sensor. + */ +int8_t bme280_set_sensor_settings(uint8_t desired_settings, struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t sensor_mode; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + /* Proceed if null check is fine */ + if (rslt == BME280_OK) + { + rslt = bme280_get_sensor_mode(&sensor_mode, dev); + + if ((rslt == BME280_OK) && (sensor_mode != BME280_SLEEP_MODE)) + { + rslt = put_device_to_sleep(dev); + } + + if (rslt == BME280_OK) + { + /* Check if user wants to change oversampling + * settings + */ + if (are_settings_changed(OVERSAMPLING_SETTINGS, desired_settings)) + { + rslt = set_osr_settings(desired_settings, &dev->settings, dev); + } + + /* Check if user wants to change filter and/or + * standby settings + */ + if ((rslt == BME280_OK) && are_settings_changed(FILTER_STANDBY_SETTINGS, desired_settings)) + { + rslt = set_filter_standby_settings(desired_settings, &dev->settings, dev); + } + } + } + + return rslt; +} + +/*! + * @brief This API gets the oversampling, filter and standby duration + * (normal mode) settings from the sensor. + */ +int8_t bme280_get_sensor_settings(struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t reg_data[4]; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + /* Proceed if null check is fine */ + if (rslt == BME280_OK) + { + rslt = bme280_get_regs(BME280_CTRL_HUM_ADDR, reg_data, 4, dev); + + if (rslt == BME280_OK) + { + parse_device_settings(reg_data, &dev->settings); + } + } + + return rslt; +} + +/*! + * @brief This API sets the power mode of the sensor. + */ +int8_t bme280_set_sensor_mode(uint8_t sensor_mode, struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t last_set_mode; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + if (rslt == BME280_OK) + { + rslt = bme280_get_sensor_mode(&last_set_mode, dev); + + /* If the sensor is not in sleep mode put the device to sleep + * mode + */ + if ((rslt == BME280_OK) && (last_set_mode != BME280_SLEEP_MODE)) + { + rslt = put_device_to_sleep(dev); + } + + /* Set the power mode */ + if (rslt == BME280_OK) + { + rslt = write_power_mode(sensor_mode, dev); + } + } + + return rslt; +} + +/*! + * @brief This API gets the power mode of the sensor. + */ +int8_t bme280_get_sensor_mode(uint8_t *sensor_mode, struct bme280_dev *dev) +{ + int8_t rslt; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + if ((rslt == BME280_OK) && (sensor_mode != NULL)) + { + /* Read the power mode register */ + rslt = bme280_get_regs(BME280_PWR_CTRL_ADDR, sensor_mode, 1, dev); + + /* Assign the power mode in the device structure */ + *sensor_mode = BME280_GET_BITS_POS_0(*sensor_mode, BME280_SENSOR_MODE); + } + else + { + rslt = BME280_E_NULL_PTR; + } + + return rslt; +} + +/*! + * @brief This API performs the soft reset of the sensor. + */ +int8_t bme280_soft_reset(struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t reg_addr = BME280_RESET_ADDR; + uint8_t status_reg = 0; + uint8_t try_run = 5; + + /* 0xB6 is the soft reset command */ + uint8_t soft_rst_cmd = BME280_SOFT_RESET_COMMAND; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + /* Proceed if null check is fine */ + if (rslt == BME280_OK) + { + /* Write the soft reset command in the sensor */ + rslt = bme280_set_regs(®_addr, &soft_rst_cmd, 1, dev); + + if (rslt == BME280_OK) + { + /* If NVM not copied yet, Wait for NVM to copy */ + do + { + /* As per data sheet - Table 1, startup time is 2 ms. */ + dev->delay_us(2000, dev->intf_ptr); + rslt = bme280_get_regs(BME280_STATUS_REG_ADDR, &status_reg, 1, dev); + + } while ((rslt == BME280_OK) && (try_run--) && (status_reg & BME280_STATUS_IM_UPDATE)); + + if (status_reg & BME280_STATUS_IM_UPDATE) + { + rslt = BME280_E_NVM_COPY_FAILED; + } + } + } + + return rslt; +} + +/*! + * @brief This API reads the pressure, temperature and humidity data from the + * sensor, compensates the data and store it in the bme280_data structure + * instance passed by the user. + */ +int8_t bme280_get_sensor_data(uint8_t sensor_comp, struct bme280_data *comp_data, struct bme280_dev *dev) +{ + int8_t rslt; + + /* Array to store the pressure, temperature and humidity data read from + * the sensor + */ + uint8_t reg_data[BME280_P_T_H_DATA_LEN] = { 0 }; + struct bme280_uncomp_data uncomp_data = { 0 }; + + /* Check for null pointer in the device structure*/ + rslt = null_ptr_check(dev); + + if ((rslt == BME280_OK) && (comp_data != NULL)) + { + /* Read the pressure and temperature data from the sensor */ + rslt = bme280_get_regs(BME280_DATA_ADDR, reg_data, BME280_P_T_H_DATA_LEN, dev); + + if (rslt == BME280_OK) + { + /* Parse the read data from the sensor */ + bme280_parse_sensor_data(reg_data, &uncomp_data); + + /* Compensate the pressure and/or temperature and/or + * humidity data from the sensor + */ + rslt = bme280_compensate_data(sensor_comp, &uncomp_data, comp_data, &dev->calib_data); + } + } + else + { + rslt = BME280_E_NULL_PTR; + } + + return rslt; +} + +/*! + * @brief This API is used to parse the pressure, temperature and + * humidity data and store it in the bme280_uncomp_data structure instance. + */ +void bme280_parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data) +{ + /* Variables to store the sensor data */ + uint32_t data_xlsb; + uint32_t data_lsb; + uint32_t data_msb; + + /* Store the parsed register values for pressure data */ + data_msb = (uint32_t)reg_data[0] << 12; + data_lsb = (uint32_t)reg_data[1] << 4; + data_xlsb = (uint32_t)reg_data[2] >> 4; + uncomp_data->pressure = data_msb | data_lsb | data_xlsb; + + /* Store the parsed register values for temperature data */ + data_msb = (uint32_t)reg_data[3] << 12; + data_lsb = (uint32_t)reg_data[4] << 4; + data_xlsb = (uint32_t)reg_data[5] >> 4; + uncomp_data->temperature = data_msb | data_lsb | data_xlsb; + + /* Store the parsed register values for humidity data */ + data_msb = (uint32_t)reg_data[6] << 8; + data_lsb = (uint32_t)reg_data[7]; + uncomp_data->humidity = data_msb | data_lsb; +} + +/*! + * @brief This API is used to compensate the pressure and/or + * temperature and/or humidity data according to the component selected + * by the user. + */ +int8_t bme280_compensate_data(uint8_t sensor_comp, + const struct bme280_uncomp_data *uncomp_data, + struct bme280_data *comp_data, + struct bme280_calib_data *calib_data) +{ + int8_t rslt = BME280_OK; + + if ((uncomp_data != NULL) && (comp_data != NULL) && (calib_data != NULL)) + { + /* Initialize to zero */ + comp_data->temperature = 0; + comp_data->pressure = 0; + comp_data->humidity = 0; + + /* If pressure or temperature component is selected */ + if (sensor_comp & (BME280_PRESS | BME280_TEMP | BME280_HUM)) + { + /* Compensate the temperature data */ + comp_data->temperature = compensate_temperature(uncomp_data, calib_data); + } + + if (sensor_comp & BME280_PRESS) + { + /* Compensate the pressure data */ + comp_data->pressure = compensate_pressure(uncomp_data, calib_data); + } + + if (sensor_comp & BME280_HUM) + { + /* Compensate the humidity data */ + comp_data->humidity = compensate_humidity(uncomp_data, calib_data); + } + } + else + { + rslt = BME280_E_NULL_PTR; + } + + return rslt; +} + +/*! + * @brief This API is used to calculate the maximum delay in milliseconds required for the + * temperature/pressure/humidity(which ever at enabled) measurement to complete. + */ +uint32_t bme280_cal_meas_delay(const struct bme280_settings *settings) +{ + uint32_t max_delay; + uint8_t temp_osr; + uint8_t pres_osr; + uint8_t hum_osr; + + /*Array to map OSR config register value to actual OSR */ + uint8_t osr_sett_to_act_osr[] = { 0, 1, 2, 4, 8, 16 }; + + /* Mapping osr settings to the actual osr values e.g. 0b101 -> osr X16 */ + if (settings->osr_t <= 5) + { + temp_osr = osr_sett_to_act_osr[settings->osr_t]; + } + else + { + temp_osr = 16; + } + + if (settings->osr_p <= 5) + { + pres_osr = osr_sett_to_act_osr[settings->osr_p]; + } + else + { + pres_osr = 16; + } + + if (settings->osr_h <= 5) + { + hum_osr = osr_sett_to_act_osr[settings->osr_h]; + } + else + { + hum_osr = 16; + } + + max_delay = + (uint32_t)((BME280_MEAS_OFFSET + (BME280_MEAS_DUR * temp_osr) + + ((BME280_MEAS_DUR * pres_osr) + BME280_PRES_HUM_MEAS_OFFSET) + + ((BME280_MEAS_DUR * hum_osr) + BME280_PRES_HUM_MEAS_OFFSET)) / BME280_MEAS_SCALING_FACTOR); + + return max_delay; +} + +/*! + * @brief This internal API sets the oversampling settings for pressure, + * temperature and humidity in the sensor. + */ +static int8_t set_osr_settings(uint8_t desired_settings, const struct bme280_settings *settings, struct bme280_dev *dev) +{ + int8_t rslt = BME280_W_INVALID_OSR_MACRO; + + if (desired_settings & BME280_OSR_HUM_SEL) + { + rslt = set_osr_humidity_settings(settings, dev); + } + + if (desired_settings & (BME280_OSR_PRESS_SEL | BME280_OSR_TEMP_SEL)) + { + rslt = set_osr_press_temp_settings(desired_settings, settings, dev); + } + + return rslt; +} + +/*! + * @brief This API sets the humidity oversampling settings of the sensor. + */ +static int8_t set_osr_humidity_settings(const struct bme280_settings *settings, struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t ctrl_hum; + uint8_t ctrl_meas; + uint8_t reg_addr = BME280_CTRL_HUM_ADDR; + + ctrl_hum = settings->osr_h & BME280_CTRL_HUM_MSK; + + /* Write the humidity control value in the register */ + rslt = bme280_set_regs(®_addr, &ctrl_hum, 1, dev); + + /* Humidity related changes will be only effective after a + * write operation to ctrl_meas register + */ + if (rslt == BME280_OK) + { + reg_addr = BME280_CTRL_MEAS_ADDR; + rslt = bme280_get_regs(reg_addr, &ctrl_meas, 1, dev); + + if (rslt == BME280_OK) + { + rslt = bme280_set_regs(®_addr, &ctrl_meas, 1, dev); + } + } + + return rslt; +} + +/*! + * @brief This API sets the pressure and/or temperature oversampling settings + * in the sensor according to the settings selected by the user. + */ +static int8_t set_osr_press_temp_settings(uint8_t desired_settings, + const struct bme280_settings *settings, + struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t reg_addr = BME280_CTRL_MEAS_ADDR; + uint8_t reg_data; + + rslt = bme280_get_regs(reg_addr, ®_data, 1, dev); + + if (rslt == BME280_OK) + { + if (desired_settings & BME280_OSR_PRESS_SEL) + { + fill_osr_press_settings(®_data, settings); + } + + if (desired_settings & BME280_OSR_TEMP_SEL) + { + fill_osr_temp_settings(®_data, settings); + } + + /* Write the oversampling settings in the register */ + rslt = bme280_set_regs(®_addr, ®_data, 1, dev); + } + + return rslt; +} + +/*! + * @brief This internal API sets the filter and/or standby duration settings + * in the sensor according to the settings selected by the user. + */ +static int8_t set_filter_standby_settings(uint8_t desired_settings, + const struct bme280_settings *settings, + struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t reg_addr = BME280_CONFIG_ADDR; + uint8_t reg_data; + + rslt = bme280_get_regs(reg_addr, ®_data, 1, dev); + + if (rslt == BME280_OK) + { + if (desired_settings & BME280_FILTER_SEL) + { + fill_filter_settings(®_data, settings); + } + + if (desired_settings & BME280_STANDBY_SEL) + { + fill_standby_settings(®_data, settings); + } + + /* Write the oversampling settings in the register */ + rslt = bme280_set_regs(®_addr, ®_data, 1, dev); + } + + return rslt; +} + +/*! + * @brief This internal API fills the filter settings provided by the user + * in the data buffer so as to write in the sensor. + */ +static void fill_filter_settings(uint8_t *reg_data, const struct bme280_settings *settings) +{ + *reg_data = BME280_SET_BITS(*reg_data, BME280_FILTER, settings->filter); +} + +/*! + * @brief This internal API fills the standby duration settings provided by + * the user in the data buffer so as to write in the sensor. + */ +static void fill_standby_settings(uint8_t *reg_data, const struct bme280_settings *settings) +{ + *reg_data = BME280_SET_BITS(*reg_data, BME280_STANDBY, settings->standby_time); +} + +/*! + * @brief This internal API fills the pressure oversampling settings provided by + * the user in the data buffer so as to write in the sensor. + */ +static void fill_osr_press_settings(uint8_t *reg_data, const struct bme280_settings *settings) +{ + *reg_data = BME280_SET_BITS(*reg_data, BME280_CTRL_PRESS, settings->osr_p); +} + +/*! + * @brief This internal API fills the temperature oversampling settings + * provided by the user in the data buffer so as to write in the sensor. + */ +static void fill_osr_temp_settings(uint8_t *reg_data, const struct bme280_settings *settings) +{ + *reg_data = BME280_SET_BITS(*reg_data, BME280_CTRL_TEMP, settings->osr_t); +} + +/*! + * @brief This internal API parse the oversampling(pressure, temperature + * and humidity), filter and standby duration settings and store in the + * device structure. + */ +static void parse_device_settings(const uint8_t *reg_data, struct bme280_settings *settings) +{ + settings->osr_h = BME280_GET_BITS_POS_0(reg_data[0], BME280_CTRL_HUM); + settings->osr_p = BME280_GET_BITS(reg_data[2], BME280_CTRL_PRESS); + settings->osr_t = BME280_GET_BITS(reg_data[2], BME280_CTRL_TEMP); + settings->filter = BME280_GET_BITS(reg_data[3], BME280_FILTER); + settings->standby_time = BME280_GET_BITS(reg_data[3], BME280_STANDBY); +} + +/*! + * @brief This internal API writes the power mode in the sensor. + */ +static int8_t write_power_mode(uint8_t sensor_mode, struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t reg_addr = BME280_PWR_CTRL_ADDR; + + /* Variable to store the value read from power mode register */ + uint8_t sensor_mode_reg_val; + + /* Read the power mode register */ + rslt = bme280_get_regs(reg_addr, &sensor_mode_reg_val, 1, dev); + + /* Set the power mode */ + if (rslt == BME280_OK) + { + sensor_mode_reg_val = BME280_SET_BITS_POS_0(sensor_mode_reg_val, BME280_SENSOR_MODE, sensor_mode); + + /* Write the power mode in the register */ + rslt = bme280_set_regs(®_addr, &sensor_mode_reg_val, 1, dev); + } + + return rslt; +} + +/*! + * @brief This internal API puts the device to sleep mode. + */ +static int8_t put_device_to_sleep(struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t reg_data[4]; + struct bme280_settings settings; + + rslt = bme280_get_regs(BME280_CTRL_HUM_ADDR, reg_data, 4, dev); + + if (rslt == BME280_OK) + { + parse_device_settings(reg_data, &settings); + rslt = bme280_soft_reset(dev); + + if (rslt == BME280_OK) + { + rslt = reload_device_settings(&settings, dev); + } + } + + return rslt; +} + +/*! + * @brief This internal API reloads the already existing device settings in + * the sensor after soft reset. + */ +static int8_t reload_device_settings(const struct bme280_settings *settings, struct bme280_dev *dev) +{ + int8_t rslt; + + rslt = set_osr_settings(BME280_ALL_SETTINGS_SEL, settings, dev); + + if (rslt == BME280_OK) + { + rslt = set_filter_standby_settings(BME280_ALL_SETTINGS_SEL, settings, dev); + } + + return rslt; +} + +#ifdef BME280_FLOAT_ENABLE + +/*! + * @brief This internal API is used to compensate the raw temperature data and + * return the compensated temperature data in double data type. + */ +static double compensate_temperature(const struct bme280_uncomp_data *uncomp_data, struct bme280_calib_data *calib_data) +{ + double var1; + double var2; + double temperature; + double temperature_min = -40; + double temperature_max = 85; + + var1 = ((double)uncomp_data->temperature) / 16384.0 - ((double)calib_data->dig_t1) / 1024.0; + var1 = var1 * ((double)calib_data->dig_t2); + var2 = (((double)uncomp_data->temperature) / 131072.0 - ((double)calib_data->dig_t1) / 8192.0); + var2 = (var2 * var2) * ((double)calib_data->dig_t3); + calib_data->t_fine = (int32_t)(var1 + var2); + temperature = (var1 + var2) / 5120.0; + + if (temperature < temperature_min) + { + temperature = temperature_min; + } + else if (temperature > temperature_max) + { + temperature = temperature_max; + } + + return temperature; +} + +/*! + * @brief This internal API is used to compensate the raw pressure data and + * return the compensated pressure data in double data type. + */ +static double compensate_pressure(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data) +{ + double var1; + double var2; + double var3; + double pressure; + double pressure_min = 30000.0; + double pressure_max = 110000.0; + + var1 = ((double)calib_data->t_fine / 2.0) - 64000.0; + var2 = var1 * var1 * ((double)calib_data->dig_p6) / 32768.0; + var2 = var2 + var1 * ((double)calib_data->dig_p5) * 2.0; + var2 = (var2 / 4.0) + (((double)calib_data->dig_p4) * 65536.0); + var3 = ((double)calib_data->dig_p3) * var1 * var1 / 524288.0; + var1 = (var3 + ((double)calib_data->dig_p2) * var1) / 524288.0; + var1 = (1.0 + var1 / 32768.0) * ((double)calib_data->dig_p1); + + /* avoid exception caused by division by zero */ + if (var1 > (0.0)) + { + pressure = 1048576.0 - (double) uncomp_data->pressure; + pressure = (pressure - (var2 / 4096.0)) * 6250.0 / var1; + var1 = ((double)calib_data->dig_p9) * pressure * pressure / 2147483648.0; + var2 = pressure * ((double)calib_data->dig_p8) / 32768.0; + pressure = pressure + (var1 + var2 + ((double)calib_data->dig_p7)) / 16.0; + + if (pressure < pressure_min) + { + pressure = pressure_min; + } + else if (pressure > pressure_max) + { + pressure = pressure_max; + } + } + else /* Invalid case */ + { + pressure = pressure_min; + } + + return pressure; +} + +/*! + * @brief This internal API is used to compensate the raw humidity data and + * return the compensated humidity data in double data type. + */ +static double compensate_humidity(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data) +{ + double humidity; + double humidity_min = 0.0; + double humidity_max = 100.0; + double var1; + double var2; + double var3; + double var4; + double var5; + double var6; + + var1 = ((double)calib_data->t_fine) - 76800.0; + var2 = (((double)calib_data->dig_h4) * 64.0 + (((double)calib_data->dig_h5) / 16384.0) * var1); + var3 = uncomp_data->humidity - var2; + var4 = ((double)calib_data->dig_h2) / 65536.0; + var5 = (1.0 + (((double)calib_data->dig_h3) / 67108864.0) * var1); + var6 = 1.0 + (((double)calib_data->dig_h6) / 67108864.0) * var1 * var5; + var6 = var3 * var4 * (var5 * var6); + humidity = var6 * (1.0 - ((double)calib_data->dig_h1) * var6 / 524288.0); + + if (humidity > humidity_max) + { + humidity = humidity_max; + } + else if (humidity < humidity_min) + { + humidity = humidity_min; + } + + return humidity; +} + +#else + +/*! + * @brief This internal API is used to compensate the raw temperature data and + * return the compensated temperature data in integer data type. + */ +static int32_t compensate_temperature(const struct bme280_uncomp_data *uncomp_data, + struct bme280_calib_data *calib_data) +{ + int32_t var1; + int32_t var2; + int32_t temperature; + int32_t temperature_min = -4000; + int32_t temperature_max = 8500; + + var1 = (int32_t)((uncomp_data->temperature / 8) - ((int32_t)calib_data->dig_t1 * 2)); + var1 = (var1 * ((int32_t)calib_data->dig_t2)) / 2048; + var2 = (int32_t)((uncomp_data->temperature / 16) - ((int32_t)calib_data->dig_t1)); + var2 = (((var2 * var2) / 4096) * ((int32_t)calib_data->dig_t3)) / 16384; + calib_data->t_fine = var1 + var2; + temperature = (calib_data->t_fine * 5 + 128) / 256; + + if (temperature < temperature_min) + { + temperature = temperature_min; + } + else if (temperature > temperature_max) + { + temperature = temperature_max; + } + + return temperature; +} +#ifndef BME280_32BIT_ENABLE /* 64 bit compensation for pressure data */ + +/*! + * @brief This internal API is used to compensate the raw pressure data and + * return the compensated pressure data in integer data type with higher + * accuracy. + */ +static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data) +{ + int64_t var1; + int64_t var2; + int64_t var3; + int64_t var4; + uint32_t pressure; + uint32_t pressure_min = 3000000; + uint32_t pressure_max = 11000000; + + var1 = ((int64_t)calib_data->t_fine) - 128000; + var2 = var1 * var1 * (int64_t)calib_data->dig_p6; + var2 = var2 + ((var1 * (int64_t)calib_data->dig_p5) * 131072); + var2 = var2 + (((int64_t)calib_data->dig_p4) * 34359738368); + var1 = ((var1 * var1 * (int64_t)calib_data->dig_p3) / 256) + ((var1 * ((int64_t)calib_data->dig_p2) * 4096)); + var3 = ((int64_t)1) * 140737488355328; + var1 = (var3 + var1) * ((int64_t)calib_data->dig_p1) / 8589934592; + + /* To avoid divide by zero exception */ + if (var1 != 0) + { + var4 = 1048576 - uncomp_data->pressure; + var4 = (((var4 * INT64_C(2147483648)) - var2) * 3125) / var1; + var1 = (((int64_t)calib_data->dig_p9) * (var4 / 8192) * (var4 / 8192)) / 33554432; + var2 = (((int64_t)calib_data->dig_p8) * var4) / 524288; + var4 = ((var4 + var1 + var2) / 256) + (((int64_t)calib_data->dig_p7) * 16); + pressure = (uint32_t)(((var4 / 2) * 100) / 128); + + if (pressure < pressure_min) + { + pressure = pressure_min; + } + else if (pressure > pressure_max) + { + pressure = pressure_max; + } + } + else + { + pressure = pressure_min; + } + + return pressure; +} +#else /* 32 bit compensation for pressure data */ + +/*! + * @brief This internal API is used to compensate the raw pressure data and + * return the compensated pressure data in integer data type. + */ +static uint32_t compensate_pressure(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data) +{ + int32_t var1; + int32_t var2; + int32_t var3; + int32_t var4; + uint32_t var5; + uint32_t pressure; + uint32_t pressure_min = 30000; + uint32_t pressure_max = 110000; + + var1 = (((int32_t)calib_data->t_fine) / 2) - (int32_t)64000; + var2 = (((var1 / 4) * (var1 / 4)) / 2048) * ((int32_t)calib_data->dig_p6); + var2 = var2 + ((var1 * ((int32_t)calib_data->dig_p5)) * 2); + var2 = (var2 / 4) + (((int32_t)calib_data->dig_p4) * 65536); + var3 = (calib_data->dig_p3 * (((var1 / 4) * (var1 / 4)) / 8192)) / 8; + var4 = (((int32_t)calib_data->dig_p2) * var1) / 2; + var1 = (var3 + var4) / 262144; + var1 = (((32768 + var1)) * ((int32_t)calib_data->dig_p1)) / 32768; + + /* avoid exception caused by division by zero */ + if (var1) + { + var5 = (uint32_t)((uint32_t)1048576) - uncomp_data->pressure; + pressure = ((uint32_t)(var5 - (uint32_t)(var2 / 4096))) * 3125; + + if (pressure < 0x80000000) + { + pressure = (pressure << 1) / ((uint32_t)var1); + } + else + { + pressure = (pressure / (uint32_t)var1) * 2; + } + + var1 = (((int32_t)calib_data->dig_p9) * ((int32_t)(((pressure / 8) * (pressure / 8)) / 8192))) / 4096; + var2 = (((int32_t)(pressure / 4)) * ((int32_t)calib_data->dig_p8)) / 8192; + pressure = (uint32_t)((int32_t)pressure + ((var1 + var2 + calib_data->dig_p7) / 16)); + + if (pressure < pressure_min) + { + pressure = pressure_min; + } + else if (pressure > pressure_max) + { + pressure = pressure_max; + } + } + else + { + pressure = pressure_min; + } + + return pressure; +} +#endif + +/*! + * @brief This internal API is used to compensate the raw humidity data and + * return the compensated humidity data in integer data type. + */ +static uint32_t compensate_humidity(const struct bme280_uncomp_data *uncomp_data, + const struct bme280_calib_data *calib_data) +{ + int32_t var1; + int32_t var2; + int32_t var3; + int32_t var4; + int32_t var5; + uint32_t humidity; + uint32_t humidity_max = 102400; + + var1 = calib_data->t_fine - ((int32_t)76800); + var2 = (int32_t)(uncomp_data->humidity * 16384); + var3 = (int32_t)(((int32_t)calib_data->dig_h4) * 1048576); + var4 = ((int32_t)calib_data->dig_h5) * var1; + var5 = (((var2 - var3) - var4) + (int32_t)16384) / 32768; + var2 = (var1 * ((int32_t)calib_data->dig_h6)) / 1024; + var3 = (var1 * ((int32_t)calib_data->dig_h3)) / 2048; + var4 = ((var2 * (var3 + (int32_t)32768)) / 1024) + (int32_t)2097152; + var2 = ((var4 * ((int32_t)calib_data->dig_h2)) + 8192) / 16384; + var3 = var5 * var2; + var4 = ((var3 / 32768) * (var3 / 32768)) / 128; + var5 = var3 - ((var4 * ((int32_t)calib_data->dig_h1)) / 16); + var5 = (var5 < 0 ? 0 : var5); + var5 = (var5 > 419430400 ? 419430400 : var5); + humidity = (uint32_t)(var5 / 4096); + + if (humidity > humidity_max) + { + humidity = humidity_max; + } + + return humidity; +} +#endif + +/*! + * @brief This internal API reads the calibration data from the sensor, parse + * it and store in the device structure. + */ +static int8_t get_calib_data(struct bme280_dev *dev) +{ + int8_t rslt; + uint8_t reg_addr = BME280_TEMP_PRESS_CALIB_DATA_ADDR; + + /* Array to store calibration data */ + uint8_t calib_data[BME280_TEMP_PRESS_CALIB_DATA_LEN] = { 0 }; + + /* Read the calibration data from the sensor */ + rslt = bme280_get_regs(reg_addr, calib_data, BME280_TEMP_PRESS_CALIB_DATA_LEN, dev); + + if (rslt == BME280_OK) + { + /* Parse temperature and pressure calibration data and store + * it in device structure + */ + parse_temp_press_calib_data(calib_data, dev); + reg_addr = BME280_HUMIDITY_CALIB_DATA_ADDR; + + /* Read the humidity calibration data from the sensor */ + rslt = bme280_get_regs(reg_addr, calib_data, BME280_HUMIDITY_CALIB_DATA_LEN, dev); + + if (rslt == BME280_OK) + { + /* Parse humidity calibration data and store it in + * device structure + */ + parse_humidity_calib_data(calib_data, dev); + } + } + + return rslt; +} + +/*! + * @brief This internal API interleaves the register address between the + * register data buffer for burst write operation. + */ +static void interleave_reg_addr(const uint8_t *reg_addr, uint8_t *temp_buff, const uint8_t *reg_data, uint8_t len) +{ + uint8_t index; + + for (index = 1; index < len; index++) + { + temp_buff[(index * 2) - 1] = reg_addr[index]; + temp_buff[index * 2] = reg_data[index]; + } +} + +/*! + * @brief This internal API is used to parse the temperature and + * pressure calibration data and store it in device structure. + */ +static void parse_temp_press_calib_data(const uint8_t *reg_data, struct bme280_dev *dev) +{ + struct bme280_calib_data *calib_data = &dev->calib_data; + + calib_data->dig_t1 = BME280_CONCAT_BYTES(reg_data[1], reg_data[0]); + calib_data->dig_t2 = (int16_t)BME280_CONCAT_BYTES(reg_data[3], reg_data[2]); + calib_data->dig_t3 = (int16_t)BME280_CONCAT_BYTES(reg_data[5], reg_data[4]); + calib_data->dig_p1 = BME280_CONCAT_BYTES(reg_data[7], reg_data[6]); + calib_data->dig_p2 = (int16_t)BME280_CONCAT_BYTES(reg_data[9], reg_data[8]); + calib_data->dig_p3 = (int16_t)BME280_CONCAT_BYTES(reg_data[11], reg_data[10]); + calib_data->dig_p4 = (int16_t)BME280_CONCAT_BYTES(reg_data[13], reg_data[12]); + calib_data->dig_p5 = (int16_t)BME280_CONCAT_BYTES(reg_data[15], reg_data[14]); + calib_data->dig_p6 = (int16_t)BME280_CONCAT_BYTES(reg_data[17], reg_data[16]); + calib_data->dig_p7 = (int16_t)BME280_CONCAT_BYTES(reg_data[19], reg_data[18]); + calib_data->dig_p8 = (int16_t)BME280_CONCAT_BYTES(reg_data[21], reg_data[20]); + calib_data->dig_p9 = (int16_t)BME280_CONCAT_BYTES(reg_data[23], reg_data[22]); + calib_data->dig_h1 = reg_data[25]; +} + +/*! + * @brief This internal API is used to parse the humidity calibration data + * and store it in device structure. + */ +static void parse_humidity_calib_data(const uint8_t *reg_data, struct bme280_dev *dev) +{ + struct bme280_calib_data *calib_data = &dev->calib_data; + int16_t dig_h4_lsb; + int16_t dig_h4_msb; + int16_t dig_h5_lsb; + int16_t dig_h5_msb; + + calib_data->dig_h2 = (int16_t)BME280_CONCAT_BYTES(reg_data[1], reg_data[0]); + calib_data->dig_h3 = reg_data[2]; + dig_h4_msb = (int16_t)(int8_t)reg_data[3] * 16; + dig_h4_lsb = (int16_t)(reg_data[4] & 0x0F); + calib_data->dig_h4 = dig_h4_msb | dig_h4_lsb; + dig_h5_msb = (int16_t)(int8_t)reg_data[5] * 16; + dig_h5_lsb = (int16_t)(reg_data[4] >> 4); + calib_data->dig_h5 = dig_h5_msb | dig_h5_lsb; + calib_data->dig_h6 = (int8_t)reg_data[6]; +} + +/*! + * @brief This internal API is used to identify the settings which the user + * wants to modify in the sensor. + */ +static uint8_t are_settings_changed(uint8_t sub_settings, uint8_t desired_settings) +{ + uint8_t settings_changed = FALSE; + + if (sub_settings & desired_settings) + { + /* User wants to modify this particular settings */ + settings_changed = TRUE; + } + else + { + /* User don't want to modify this particular settings */ + settings_changed = FALSE; + } + + return settings_changed; +} + +/*! + * @brief This internal API is used to validate the device structure pointer for + * null conditions. + */ +static int8_t null_ptr_check(const struct bme280_dev *dev) +{ + int8_t rslt; + + if ((dev == NULL) || (dev->read == NULL) || (dev->write == NULL) || (dev->delay_us == NULL)) + { + /* Device structure pointer is not valid */ + rslt = BME280_E_NULL_PTR; + } + else + { + /* Device structure is fine */ + rslt = BME280_OK; + } + + return rslt; +} diff --git a/lib/BME280_driver/bme280.h b/lib/BME280_driver/bme280.h new file mode 100644 index 0000000..55b90b8 --- /dev/null +++ b/lib/BME280_driver/bme280.h @@ -0,0 +1,395 @@ +/** +* Copyright (c) 2020 Bosch Sensortec GmbH. All rights reserved. +* +* BSD-3-Clause +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions are met: +* +* 1. Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* +* 2. Redistributions in binary form must reproduce the above copyright +* notice, this list of conditions and the following disclaimer in the +* documentation and/or other materials provided with the distribution. +* +* 3. Neither the name of the copyright holder nor the names of its +* contributors may be used to endorse or promote products derived from +* this software without specific prior written permission. +* +* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +* POSSIBILITY OF SUCH DAMAGE. +* +* @file bme280.h +* @date 2020-03-28 +* @version v3.5.0 +* +*/ + +/*! @file bme280.h + * @brief Sensor driver for BME280 sensor + */ + +/*! + * @defgroup bme280 BME280 + * @brief Product Overview + * and Sensor API Source Code + */ + +#ifndef BME280_H_ +#define BME280_H_ + +/*! CPP guard */ +#ifdef __cplusplus +extern "C" { +#endif + +/* Header includes */ +#include "bme280_defs.h" + +/** + * \ingroup bme280 + * \defgroup bme280ApiInit Initialization + * @brief Initialize the sensor and device structure + */ + +/*! + * \ingroup bme280ApiInit + * \page bme280_api_bme280_init bme280_init + * \code + * int8_t bme280_init(struct bme280_dev *dev); + * \endcode + * @details This API reads the chip-id of the sensor which is the first step to + * verify the sensor and also calibrates the sensor + * As this API is the entry point, call this API before using other APIs. + * + * @param[in,out] dev : Structure instance of bme280_dev + * + * @return Result of API execution status. + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_init(struct bme280_dev *dev); + +/** + * \ingroup bme280 + * \defgroup bme280ApiRegister Registers + * @brief Generic API for accessing sensor registers + */ + +/*! + * \ingroup bme280ApiRegister + * \page bme280_api_bme280_set_regs bme280_set_regs + * \code + * int8_t bme280_set_regs(const uint8_t reg_addr, const uint8_t *reg_data, uint8_t len, struct bme280_dev *dev); + * \endcode + * @details This API writes the given data to the register address of the sensor + * + * @param[in] reg_addr : Register addresses to where the data is to be written + * @param[in] reg_data : Pointer to data buffer which is to be written + * in the reg_addr of sensor. + * @param[in] len : No of bytes of data to write + * @param[in,out] dev : Structure instance of bme280_dev + * + * @return Result of API execution status. + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_set_regs(uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, struct bme280_dev *dev); + +/*! + * \ingroup bme280ApiRegister + * \page bme280_api_bme280_get_regs bme280_get_regs + * \code + * int8_t bme280_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint8_t len, struct bme280_dev *dev); + * \endcode + * @details This API reads the data from the given register address of sensor. + * + * @param[in] reg_addr : Register address from where the data to be read + * @param[out] reg_data : Pointer to data buffer to store the read data. + * @param[in] len : No of bytes of data to be read. + * @param[in,out] dev : Structure instance of bme280_dev. + * + * @return Result of API execution status. + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, struct bme280_dev *dev); + +/** + * \ingroup bme280 + * \defgroup bme280ApiSensorSettings Sensor Settings + * @brief Generic API for accessing sensor settings + */ + +/*! + * \ingroup bme280ApiSensorSettings + * \page bme280_api_bme280_set_sensor_settings bme280_set_sensor_settings + * \code + * int8_t bme280_set_sensor_settings(uint8_t desired_settings, const struct bme280_dev *dev); + * \endcode + * @details This API sets the oversampling, filter and standby duration + * (normal mode) settings in the sensor. + * + * @param[in] dev : Structure instance of bme280_dev. + * @param[in] desired_settings : Variable used to select the settings which + * are to be set in the sensor. + * + * @note : Below are the macros to be used by the user for selecting the + * desired settings. User can do OR operation of these macros for configuring + * multiple settings. + * + * Macros | Functionality + * -----------------------|---------------------------------------------- + * BME280_OSR_PRESS_SEL | To set pressure oversampling. + * BME280_OSR_TEMP_SEL | To set temperature oversampling. + * BME280_OSR_HUM_SEL | To set humidity oversampling. + * BME280_FILTER_SEL | To set filter setting. + * BME280_STANDBY_SEL | To set standby duration setting. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_set_sensor_settings(uint8_t desired_settings, struct bme280_dev *dev); + +/*! + * \ingroup bme280ApiSensorSettings + * \page bme280_api_bme280_get_sensor_settings bme280_get_sensor_settings + * \code + * int8_t bme280_get_sensor_settings(struct bme280_dev *dev); + * \endcode + * @details This API gets the oversampling, filter and standby duration + * (normal mode) settings from the sensor. + * + * @param[in,out] dev : Structure instance of bme280_dev. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_get_sensor_settings(struct bme280_dev *dev); + +/** + * \ingroup bme280 + * \defgroup bme280ApiSensorMode Sensor Mode + * @brief Generic API for configuring sensor power mode + */ + +/*! + * \ingroup bme280ApiSensorMode + * \page bme280_api_bme280_set_sensor_mode bme280_set_sensor_mode + * \code + * int8_t bme280_set_sensor_mode(uint8_t sensor_mode, const struct bme280_dev *dev); + * \endcode + * @details This API sets the power mode of the sensor. + * + * @param[in] dev : Structure instance of bme280_dev. + * @param[in] sensor_mode : Variable which contains the power mode to be set. + * + * sensor_mode | Macros + * ---------------------|------------------- + * 0 | BME280_SLEEP_MODE + * 1 | BME280_FORCED_MODE + * 3 | BME280_NORMAL_MODE + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_set_sensor_mode(uint8_t sensor_mode, struct bme280_dev *dev); + +/*! + * \ingroup bme280ApiSensorMode + * \page bme280_api_bme280_get_sensor_mode bme280_get_sensor_mode + * \code + * int8_t bme280_get_sensor_mode(uint8_t *sensor_mode, const struct bme280_dev *dev); + * \endcode + * @details This API gets the power mode of the sensor. + * + * @param[in] dev : Structure instance of bme280_dev. + * @param[out] sensor_mode : Pointer variable to store the power mode. + * + * sensor_mode | Macros + * ---------------------|------------------- + * 0 | BME280_SLEEP_MODE + * 1 | BME280_FORCED_MODE + * 3 | BME280_NORMAL_MODE + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_get_sensor_mode(uint8_t *sensor_mode, struct bme280_dev *dev); + +/** + * \ingroup bme280 + * \defgroup bme280ApiSystem System + * @brief API that performs system-level operations + */ + +/*! + * \ingroup bme280ApiSystem + * \page bme280_api_bme280_soft_reset bme280_soft_reset + * \code + * int8_t bme280_soft_reset(struct bme280_dev *dev); + * \endcode + * @details This API soft-resets the sensor. + * + * @param[in,out] dev : Structure instance of bme280_dev. + * + * @return Result of API execution status. + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_soft_reset(struct bme280_dev *dev); + +/** + * \ingroup bme280 + * \defgroup bme280ApiSensorData Sensor Data + * @brief Data processing of sensor + */ + +/*! + * \ingroup bme280ApiSensorData + * \page bme280_api_bme280_get_sensor_data bme280_get_sensor_data + * \code + * int8_t bme280_get_sensor_data(uint8_t sensor_comp, struct bme280_data *comp_data, struct bme280_dev *dev); + * \endcode + * @details This API reads the pressure, temperature and humidity data from the + * sensor, compensates the data and store it in the bme280_data structure + * instance passed by the user. + * + * @param[in] sensor_comp : Variable which selects which data to be read from + * the sensor. + * + * sensor_comp | Macros + * ------------|------------------- + * 1 | BME280_PRESS + * 2 | BME280_TEMP + * 4 | BME280_HUM + * 7 | BME280_ALL + * + * @param[out] comp_data : Structure instance of bme280_data. + * @param[in] dev : Structure instance of bme280_dev. + * + * @return Result of API execution status + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_get_sensor_data(uint8_t sensor_comp, struct bme280_data *comp_data, struct bme280_dev *dev); + +/*! + * \ingroup bme280ApiSensorData + * \page bme280_api_bme280_parse_sensor_data bme280_parse_sensor_data + * \code + * void bme280_parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data); + * \endcode + * @details This API is used to parse the pressure, temperature and + * humidity data and store it in the bme280_uncomp_data structure instance. + * + * @param[in] reg_data : Contains register data which needs to be parsed + * @param[out] uncomp_data : Contains the uncompensated pressure, temperature + * and humidity data. + * + */ +void bme280_parse_sensor_data(const uint8_t *reg_data, struct bme280_uncomp_data *uncomp_data); + +/*! + * \ingroup bme280ApiSensorData + * \page bme280_api_bme280_compensate_data bme280_compensate_data + * \code + * int8_t bme280_compensate_data(uint8_t sensor_comp, + * const struct bme280_uncomp_data *uncomp_data, + * struct bme280_data *comp_data, + * struct bme280_calib_data *calib_data); + * \endcode + * @details This API is used to compensate the pressure and/or + * temperature and/or humidity data according to the component selected by the + * user. + * + * @param[in] sensor_comp : Used to select pressure and/or temperature and/or + * humidity. + * @param[in] uncomp_data : Contains the uncompensated pressure, temperature and + * humidity data. + * @param[out] comp_data : Contains the compensated pressure and/or temperature + * and/or humidity data. + * @param[in] calib_data : Pointer to the calibration data structure. + * + * @return Result of API execution status. + * + * @retval 0 -> Success. + * @retval > 0 -> Warning. + * @retval < 0 -> Fail. + * + */ +int8_t bme280_compensate_data(uint8_t sensor_comp, + const struct bme280_uncomp_data *uncomp_data, + struct bme280_data *comp_data, + struct bme280_calib_data *calib_data); + +/** + * \ingroup bme280 + * \defgroup bme280ApiSensorDelay Sensor Delay + * @brief Generic API for measuring sensor delay + */ + +/*! + * \ingroup bme280ApiSensorDelay + * \page bme280_api_bme280_cal_meas_delay bme280_cal_meas_delay + * \code + * uint32_t bme280_cal_meas_delay(const struct bme280_settings *settings); + * \endcode + * @brief This API is used to calculate the maximum delay in milliseconds required for the + * temperature/pressure/humidity(which ever are enabled) measurement to complete. + * The delay depends upon the number of sensors enabled and their oversampling configuration. + * + * @param[in] settings : contains the oversampling configurations. + * + * @return delay required in milliseconds. + * + */ +uint32_t bme280_cal_meas_delay(const struct bme280_settings *settings); + +#ifdef __cplusplus +} +#endif /* End of CPP guard */ +#endif /* BME280_H_ */ +/** @}*/ diff --git a/lib/BME280_driver/bme280_defs.h b/lib/BME280_driver/bme280_defs.h new file mode 100644 index 0000000..695e4d9 --- /dev/null +++ b/lib/BME280_driver/bme280_defs.h @@ -0,0 +1,470 @@ +/** +* Copyright (c) 2020 Bosch Sensortec GmbH. All rights reserved. +* +* BSD-3-Clause +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions are met: +* +* 1. Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* +* 2. Redistributions in binary form must reproduce the above copyright +* notice, this list of conditions and the following disclaimer in the +* documentation and/or other materials provided with the distribution. +* +* 3. Neither the name of the copyright holder nor the names of its +* contributors may be used to endorse or promote products derived from +* this software without specific prior written permission. +* +* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +* POSSIBILITY OF SUCH DAMAGE. +* +* @file bme280_defs.h +* @date 2020-03-28 +* @version v3.5.0 +* +*/ + +#ifndef BME280_DEFS_H_ +#define BME280_DEFS_H_ + +/********************************************************/ +/* header includes */ +#ifdef __KERNEL__ +#include +#include +#else +#include +#include +#endif + +/********************************************************/ +/*! @name Common macros */ +/********************************************************/ + +#if !defined(UINT8_C) && !defined(INT8_C) +#define INT8_C(x) S8_C(x) +#define UINT8_C(x) U8_C(x) +#endif + +#if !defined(UINT16_C) && !defined(INT16_C) +#define INT16_C(x) S16_C(x) +#define UINT16_C(x) U16_C(x) +#endif + +#if !defined(INT32_C) && !defined(UINT32_C) +#define INT32_C(x) S32_C(x) +#define UINT32_C(x) U32_C(x) +#endif + +#if !defined(INT64_C) && !defined(UINT64_C) +#define INT64_C(x) S64_C(x) +#define UINT64_C(x) U64_C(x) +#endif + +/**@}*/ +/**\name C standard macros */ +#ifndef NULL +#ifdef __cplusplus +#define NULL 0 +#else +#define NULL ((void *) 0) +#endif +#endif + +/********************************************************/ + +#ifndef BME280_64BIT_ENABLE /*< Check if 64-bit integer (using BME280_64BIT_ENABLE) is enabled */ +#ifndef BME280_32BIT_ENABLE /*< Check if 32-bit integer (using BME280_32BIT_ENABLE) is enabled */ +#ifndef BME280_FLOAT_ENABLE /*< If any of the integer data types not enabled then enable BME280_FLOAT_ENABLE */ +#define BME280_FLOAT_ENABLE +#endif +#endif +#endif + +#ifndef TRUE +#define TRUE UINT8_C(1) +#endif +#ifndef FALSE +#define FALSE UINT8_C(0) +#endif + +/** + * BME280_INTF_RET_TYPE is the read/write interface return type which can be overwritten by the build system. + */ +#ifndef BME280_INTF_RET_TYPE +#define BME280_INTF_RET_TYPE int8_t +#endif + +/** + * The last error code from read/write interface is stored in the device structure as intf_rslt. + */ +#ifndef BME280_INTF_RET_SUCCESS +#define BME280_INTF_RET_SUCCESS INT8_C(0) +#endif + +/**\name I2C addresses */ +#define BME280_I2C_ADDR_PRIM UINT8_C(0x76) +#define BME280_I2C_ADDR_SEC UINT8_C(0x77) + +/**\name BME280 chip identifier */ +#define BME280_CHIP_ID UINT8_C(0x60) + +/**\name Register Address */ +#define BME280_CHIP_ID_ADDR UINT8_C(0xD0) +#define BME280_RESET_ADDR UINT8_C(0xE0) +#define BME280_TEMP_PRESS_CALIB_DATA_ADDR UINT8_C(0x88) +#define BME280_HUMIDITY_CALIB_DATA_ADDR UINT8_C(0xE1) +#define BME280_PWR_CTRL_ADDR UINT8_C(0xF4) +#define BME280_CTRL_HUM_ADDR UINT8_C(0xF2) +#define BME280_CTRL_MEAS_ADDR UINT8_C(0xF4) +#define BME280_CONFIG_ADDR UINT8_C(0xF5) +#define BME280_DATA_ADDR UINT8_C(0xF7) + +/**\name API success code */ +#define BME280_OK INT8_C(0) + +/**\name API error codes */ +#define BME280_E_NULL_PTR INT8_C(-1) +#define BME280_E_DEV_NOT_FOUND INT8_C(-2) +#define BME280_E_INVALID_LEN INT8_C(-3) +#define BME280_E_COMM_FAIL INT8_C(-4) +#define BME280_E_SLEEP_MODE_FAIL INT8_C(-5) +#define BME280_E_NVM_COPY_FAILED INT8_C(-6) + +/**\name API warning codes */ +#define BME280_W_INVALID_OSR_MACRO INT8_C(1) + +/**\name Macros related to size */ +#define BME280_TEMP_PRESS_CALIB_DATA_LEN UINT8_C(26) +#define BME280_HUMIDITY_CALIB_DATA_LEN UINT8_C(7) +#define BME280_P_T_H_DATA_LEN UINT8_C(8) + +/**\name Sensor power modes */ +#define BME280_SLEEP_MODE UINT8_C(0x00) +#define BME280_FORCED_MODE UINT8_C(0x01) +#define BME280_NORMAL_MODE UINT8_C(0x03) + +/**\name Macro to combine two 8 bit data's to form a 16 bit data */ +#define BME280_CONCAT_BYTES(msb, lsb) (((uint16_t)msb << 8) | (uint16_t)lsb) + +#define BME280_SET_BITS(reg_data, bitname, data) \ + ((reg_data & ~(bitname##_MSK)) | \ + ((data << bitname##_POS) & bitname##_MSK)) +#define BME280_SET_BITS_POS_0(reg_data, bitname, data) \ + ((reg_data & ~(bitname##_MSK)) | \ + (data & bitname##_MSK)) + +#define BME280_GET_BITS(reg_data, bitname) ((reg_data & (bitname##_MSK)) >> \ + (bitname##_POS)) +#define BME280_GET_BITS_POS_0(reg_data, bitname) (reg_data & (bitname##_MSK)) + +/**\name Macros for bit masking */ +#define BME280_SENSOR_MODE_MSK UINT8_C(0x03) +#define BME280_SENSOR_MODE_POS UINT8_C(0x00) + +#define BME280_CTRL_HUM_MSK UINT8_C(0x07) +#define BME280_CTRL_HUM_POS UINT8_C(0x00) + +#define BME280_CTRL_PRESS_MSK UINT8_C(0x1C) +#define BME280_CTRL_PRESS_POS UINT8_C(0x02) + +#define BME280_CTRL_TEMP_MSK UINT8_C(0xE0) +#define BME280_CTRL_TEMP_POS UINT8_C(0x05) + +#define BME280_FILTER_MSK UINT8_C(0x1C) +#define BME280_FILTER_POS UINT8_C(0x02) + +#define BME280_STANDBY_MSK UINT8_C(0xE0) +#define BME280_STANDBY_POS UINT8_C(0x05) + +/**\name Sensor component selection macros + * These values are internal for API implementation. Don't relate this to + * data sheet. + */ +#define BME280_PRESS UINT8_C(1) +#define BME280_TEMP UINT8_C(1 << 1) +#define BME280_HUM UINT8_C(1 << 2) +#define BME280_ALL UINT8_C(0x07) + +/**\name Settings selection macros */ +#define BME280_OSR_PRESS_SEL UINT8_C(1) +#define BME280_OSR_TEMP_SEL UINT8_C(1 << 1) +#define BME280_OSR_HUM_SEL UINT8_C(1 << 2) +#define BME280_FILTER_SEL UINT8_C(1 << 3) +#define BME280_STANDBY_SEL UINT8_C(1 << 4) +#define BME280_ALL_SETTINGS_SEL UINT8_C(0x1F) + +/**\name Oversampling macros */ +#define BME280_NO_OVERSAMPLING UINT8_C(0x00) +#define BME280_OVERSAMPLING_1X UINT8_C(0x01) +#define BME280_OVERSAMPLING_2X UINT8_C(0x02) +#define BME280_OVERSAMPLING_4X UINT8_C(0x03) +#define BME280_OVERSAMPLING_8X UINT8_C(0x04) +#define BME280_OVERSAMPLING_16X UINT8_C(0x05) + +/**\name Measurement delay calculation macros */ +#define BME280_MEAS_OFFSET UINT16_C(1250) +#define BME280_MEAS_DUR UINT16_C(2300) +#define BME280_PRES_HUM_MEAS_OFFSET UINT16_C(575) +#define BME280_MEAS_SCALING_FACTOR UINT16_C(1000) + +/**\name Standby duration selection macros */ +#define BME280_STANDBY_TIME_0_5_MS (0x00) +#define BME280_STANDBY_TIME_62_5_MS (0x01) +#define BME280_STANDBY_TIME_125_MS (0x02) +#define BME280_STANDBY_TIME_250_MS (0x03) +#define BME280_STANDBY_TIME_500_MS (0x04) +#define BME280_STANDBY_TIME_1000_MS (0x05) +#define BME280_STANDBY_TIME_10_MS (0x06) +#define BME280_STANDBY_TIME_20_MS (0x07) + +/**\name Filter coefficient selection macros */ +#define BME280_FILTER_COEFF_OFF (0x00) +#define BME280_FILTER_COEFF_2 (0x01) +#define BME280_FILTER_COEFF_4 (0x02) +#define BME280_FILTER_COEFF_8 (0x03) +#define BME280_FILTER_COEFF_16 (0x04) + +#define BME280_STATUS_REG_ADDR (0xF3) +#define BME280_SOFT_RESET_COMMAND (0xB6) +#define BME280_STATUS_IM_UPDATE (0x01) + +/*! + * @brief Interface selection Enums + */ +enum bme280_intf { + /*< SPI interface */ + BME280_SPI_INTF, + /*< I2C interface */ + BME280_I2C_INTF +}; + +/*! + * @brief Type definitions + */ + +/*! + * @brief Bus communication function pointer which should be mapped to + * the platform specific read functions of the user + * + * @param[in] reg_addr : Register address from which data is read. + * @param[out] reg_data : Pointer to data buffer where read data is stored. + * @param[in] len : Number of bytes of data to be read. + * @param[in, out] intf_ptr : Void pointer that can enable the linking of descriptors + * for interface related call backs. + * + * @retval 0 -> Success. + * @retval Non zero value -> Fail. + * + */ +typedef BME280_INTF_RET_TYPE (*bme280_read_fptr_t)(uint8_t reg_addr, uint8_t *reg_data, uint32_t len, void *intf_ptr); + +/*! + * @brief Bus communication function pointer which should be mapped to + * the platform specific write functions of the user + * + * @param[in] reg_addr : Register address to which the data is written. + * @param[in] reg_data : Pointer to data buffer in which data to be written + * is stored. + * @param[in] len : Number of bytes of data to be written. + * @param[in, out] intf_ptr : Void pointer that can enable the linking of descriptors + * for interface related call backs + * + * @retval 0 -> Success. + * @retval Non zero value -> Fail. + * + */ +typedef BME280_INTF_RET_TYPE (*bme280_write_fptr_t)(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len, + void *intf_ptr); + +/*! + * @brief Delay function pointer which should be mapped to + * delay function of the user + * + * @param[in] period : Delay in microseconds. + * @param[in, out] intf_ptr : Void pointer that can enable the linking of descriptors + * for interface related call backs + * + */ +typedef void (*bme280_delay_us_fptr_t)(uint32_t period, void *intf_ptr); + +/*! + * @brief Calibration data + */ +struct bme280_calib_data +{ + /*< Calibration coefficient for the temperature sensor */ + uint16_t dig_t1; + + /*< Calibration coefficient for the temperature sensor */ + int16_t dig_t2; + + /*< Calibration coefficient for the temperature sensor */ + int16_t dig_t3; + + /*< Calibration coefficient for the pressure sensor */ + uint16_t dig_p1; + + /*< Calibration coefficient for the pressure sensor */ + int16_t dig_p2; + + /*< Calibration coefficient for the pressure sensor */ + int16_t dig_p3; + + /*< Calibration coefficient for the pressure sensor */ + int16_t dig_p4; + + /*< Calibration coefficient for the pressure sensor */ + int16_t dig_p5; + + /*< Calibration coefficient for the pressure sensor */ + int16_t dig_p6; + + /*< Calibration coefficient for the pressure sensor */ + int16_t dig_p7; + + /*< Calibration coefficient for the pressure sensor */ + int16_t dig_p8; + + /*< Calibration coefficient for the pressure sensor */ + int16_t dig_p9; + + /*< Calibration coefficient for the humidity sensor */ + uint8_t dig_h1; + + /*< Calibration coefficient for the humidity sensor */ + int16_t dig_h2; + + /*< Calibration coefficient for the humidity sensor */ + uint8_t dig_h3; + + /*< Calibration coefficient for the humidity sensor */ + int16_t dig_h4; + + /*< Calibration coefficient for the humidity sensor */ + int16_t dig_h5; + + /*< Calibration coefficient for the humidity sensor */ + int8_t dig_h6; + + /*< Variable to store the intermediate temperature coefficient */ + int32_t t_fine; +}; + +/*! + * @brief bme280 sensor structure which comprises of temperature, pressure and + * humidity data + */ +#ifdef BME280_FLOAT_ENABLE +struct bme280_data +{ + /*< Compensated pressure */ + double pressure; + + /*< Compensated temperature */ + double temperature; + + /*< Compensated humidity */ + double humidity; +}; +#else +struct bme280_data +{ + /*< Compensated pressure */ + uint32_t pressure; + + /*< Compensated temperature */ + int32_t temperature; + + /*< Compensated humidity */ + uint32_t humidity; +}; +#endif /*! BME280_USE_FLOATING_POINT */ + +/*! + * @brief bme280 sensor structure which comprises of uncompensated temperature, + * pressure and humidity data + */ +struct bme280_uncomp_data +{ + /*< un-compensated pressure */ + uint32_t pressure; + + /*< un-compensated temperature */ + uint32_t temperature; + + /*< un-compensated humidity */ + uint32_t humidity; +}; + +/*! + * @brief bme280 sensor settings structure which comprises of mode, + * oversampling and filter settings. + */ +struct bme280_settings +{ + /*< pressure oversampling */ + uint8_t osr_p; + + /*< temperature oversampling */ + uint8_t osr_t; + + /*< humidity oversampling */ + uint8_t osr_h; + + /*< filter coefficient */ + uint8_t filter; + + /*< standby time */ + uint8_t standby_time; +}; + +/*! + * @brief bme280 device structure + */ +struct bme280_dev +{ + /*< Chip Id */ + uint8_t chip_id; + + /*< Interface function pointer used to enable the device address for I2C and chip selection for SPI */ + void *intf_ptr; + + /*< Interface Selection + * For SPI, intf = BME280_SPI_INTF + * For I2C, intf = BME280_I2C_INTF + * */ + enum bme280_intf intf; + + /*< Read function pointer */ + bme280_read_fptr_t read; + + /*< Write function pointer */ + bme280_write_fptr_t write; + + /*< Delay function pointer */ + bme280_delay_us_fptr_t delay_us; + + /*< Trim data */ + struct bme280_calib_data calib_data; + + /*< Sensor settings */ + struct bme280_settings settings; + + /*< Variable to store result of read/write function */ + BME280_INTF_RET_TYPE intf_rslt; +}; + +#endif /* BME280_DEFS_H_ */ diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..f65431a --- /dev/null +++ b/platformio.ini @@ -0,0 +1,16 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:d1_mini] +platform = espressif8266 +board = d1_mini +framework = arduino +board_build.filesystem = littlefs +monitor_speed = 115200 \ No newline at end of file diff --git a/src/BME280wrapper.cpp b/src/BME280wrapper.cpp new file mode 100644 index 0000000..71e41aa --- /dev/null +++ b/src/BME280wrapper.cpp @@ -0,0 +1,156 @@ +/* + * Bosch BME280_driver wrapper class + * Author: Wolfgang Kracht + * Created: 27.02.2021 + */ + +#include "BME280wrapper.h" +#include + +void user_delay_us(uint32_t period, void *intf_ptr) { + delayMicroseconds(period); +} + +int8_t user_i2c_read(uint8_t reg_addr, uint8_t *reg_data, uint32_t len, void *intf_ptr) +{ + int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */ + + /* + * The parameter intf_ptr can be used as a variable to store the I2C address of the device + */ + + /* + * Data on the bus should be like + * |------------+---------------------| + * | I2C action | Data | + * |------------+---------------------| + * | Start | - | + * | Write | (reg_addr) | + * | Stop | - | + * | Start | - | + * | Read | (reg_data[0]) | + * | Read | (....) | + * | Read | (reg_data[len - 1]) | + * | Stop | - | + * |------------+---------------------| + */ + + Wire.beginTransmission(*(int*)intf_ptr); // burst read + Wire.write(reg_addr); // reg_addr is start address of the data + rslt = Wire.endTransmission(); + if (rslt == 0) { + Wire.requestFrom(*(int*)intf_ptr, len); // request "length" bytes of data + uint32_t byteCount; + while ((byteCount = Wire.available()) == 0) delay(1); + if (byteCount == len) { // correct answer + for (int i = 0; i < (int) byteCount; i++) { // read bytes to array + reg_data[i] = Wire.read(); + } + } + } + return rslt; +} + +int8_t user_i2c_write(uint8_t reg_addr, const uint8_t *reg_data, uint32_t len, void *intf_ptr) +{ + int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */ + + /* + * The parameter intf_ptr can be used as a variable to store the I2C address of the device + */ + + /* + * Data on the bus should be like + * |------------+---------------------| + * | I2C action | Data | + * |------------+---------------------| + * | Start | - | + * | Write | (reg_addr) | + * | Write | (reg_data[0]) | + * | Write | (....) | + * | Write | (reg_data[len - 1]) | + * | Stop | - | + * |------------+---------------------| + */ + + Wire.beginTransmission(*(int*)intf_ptr); + Wire.write(reg_addr); + for (int i = 0; i < (int)len; i++) { // read bytes to array + Wire.write(reg_data[i]); + } + rslt = Wire.endTransmission(); + return rslt; +} + +double BME280wrapper::getPressureAtSeaLevel(double pressure, double temperature, double altitude) { + double alti = 0.0065 * altitude; + return pressure * pow(1 - (alti / (temperature + alti + 273.15)), -5.257); +} + +double BME280wrapper::getDewPoint(double temperature, double humidity) { + // a and b are coefficients. For Sonntag90 constant set, a = 17.62°C and b = 243.12°C; + double a = 17.62; + double b = 243.12; + double alpha = log(humidity / 100) + a * temperature / (temperature + b); + return b * alpha / (a - alpha); +} + +bool BME280wrapper::readSensorData() { + return bme280_get_sensor_data(BME280_ALL, &comp_data, &dev) == 0; +} + +bool BME280wrapper::startMeasure() { + uint8_t stat = 0; + int8_t rslt = bme280_set_sensor_mode(BME280_NORMAL_MODE, &dev); + do { + dev.delay_us(measure_delay, &dev.intf_ptr); // wait for the measurement to complete + rslt = bme280_get_regs(BME280_STATUS_REG_ADDR, &stat, 1, &dev); + } while (rslt == 0 && (stat & 0x08) != 0); + return rslt == 0; +} + +bool BME280wrapper::forceMeasure() { + uint8_t stat = 0; + int8_t rslt = bme280_set_sensor_mode(BME280_FORCED_MODE, &dev); + do { + dev.delay_us(measure_delay, &dev.intf_ptr); // wait for the measurement to complete + rslt = bme280_get_regs(BME280_STATUS_REG_ADDR, &stat, 1, &dev); + } while (rslt == 0 && (stat & 0x08) != 0); + if (rslt == 0) { + rslt = bme280_get_sensor_data(BME280_ALL, &comp_data, &dev); + }; + return rslt == 0 && comp_data.pressure > 90000.0; +} + +bool BME280wrapper::begin(int addr) { + dev_addr = addr; + + dev.intf_ptr = &dev_addr; + dev.intf = BME280_I2C_INTF; + dev.read = user_i2c_read; + dev.write = user_i2c_write; + dev.delay_us = user_delay_us; + + dev.intf_rslt = bme280_init(&dev); + return dev.intf_rslt == 0; +} + +bool BME280wrapper::setup(int addr) { + Wire.begin(); + bool ret = begin(addr); + + if (ret) { + /* Recommended mode of operation: Indoor navigation */ + dev.settings.osr_h = BME280_OVERSAMPLING_16X; + dev.settings.osr_p = BME280_OVERSAMPLING_16X; + dev.settings.osr_t = BME280_OVERSAMPLING_16X; + dev.settings.filter = BME280_FILTER_COEFF_16; + + uint8_t settings_sel = BME280_OSR_PRESS_SEL | BME280_OSR_TEMP_SEL | BME280_OSR_HUM_SEL | BME280_FILTER_SEL; + + bme280_set_sensor_settings(settings_sel, &dev); + // Calculate the minimum delay required between consecutive measurement based upon the sensor enabled and the oversampling configuration. + measure_delay = bme280_cal_meas_delay(&dev.settings); + } + return ret; +} diff --git a/src/BME280wrapper.h b/src/BME280wrapper.h new file mode 100644 index 0000000..2a2253c --- /dev/null +++ b/src/BME280wrapper.h @@ -0,0 +1,32 @@ +#pragma once + +#include +#include +#include "bme280.h" + +class BME280wrapper +{ +public: + BME280wrapper() = default; + virtual ~BME280wrapper() = default; + + bool setup(int i2c_addr); + bool forceMeasure(); + bool startMeasure(); + bool readSensorData(); + double getTemperature() { return comp_data.temperature; }; + double getHumidity() { return comp_data.humidity; }; + double getPressure() { return comp_data.pressure / 100.0; }; + double getPressureAtSeaLevel(double altitude = 0.0) { return getPressureAtSeaLevel(getPressure(), getTemperature(), altitude); } + double getPressureAtSeaLevel(double pressure, double temperature, double altitude = 0.0); + double getDewPoint() { return getDewPoint(getTemperature(), getHumidity()); }; + double getDewPoint(double temperature, double humidity); + +private: + bool begin(int i2c_addr); + + uint8_t dev_addr; + uint32_t measure_delay; + struct bme280_dev dev; + struct bme280_data comp_data; +}; diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..deff5e9 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,67 @@ +/* + * Example for Bosch BME280_driver wrapper class + * Author: Wolfgang Kracht + * Created: 27.02.2021 + * + * NOTE: Running in ESP.deepSleep loop requires D0 (GPIO16) to be connected to RST of the ESP8266. + */ + +#include "BME280wrapper.h" + +#define CONSOLE Serial +//#define ESP_DEEP_SLEEP + +BME280wrapper bme280; + +// some BME280 parameters +struct { + int I2C_Addr = 0x76; // i2c address of BME280 device + uint32_t TimeSecs = 15; // measuring interval time in [s] + double Altitude = 60.0; // altitude of device in [m] + int PowerPin = -15; // positive means D8 (GPIO15) used as 3.3V Vcc source for device +} BME; + + +void setup() { + Serial.begin(115200); + CONSOLE.println("\nbooting..."); + + if (BME.PowerPin >= 0) { + pinMode(BME.PowerPin, OUTPUT); + digitalWrite(BME.PowerPin, HIGH); + } + + if (!bme280.setup(BME.I2C_Addr)) { + CONSOLE.println("BME280 setup failed!"); + } +} + + +void loop() { + static uint32_t timestamp = BME.TimeSecs * 1000; + uint32_t time_ms = millis(); + + if (time_ms - timestamp >= BME.TimeSecs * 1000) { + timestamp = time_ms; + + if (bme280.forceMeasure()) { + CONSOLE.print("Time="); CONSOLE.println(time_ms); + CONSOLE.print("Temp="); CONSOLE.println(bme280.getTemperature()); + CONSOLE.print("Humi="); CONSOLE.println(bme280.getHumidity()); + CONSOLE.print("Pres="); CONSOLE.println(bme280.getPressure()); + CONSOLE.print("PSea="); CONSOLE.println(bme280.getPressureAtSeaLevel(BME.Altitude)); + CONSOLE.print("DewP="); CONSOLE.println(bme280.getDewPoint()); + CONSOLE.println(); + } + else { + CONSOLE.println("BME280 measurement failed!"); + } + +#ifdef ESP_DEEP_SLEEP + CONSOLE.print("execution time: "); CONSOLE.print(micros()); + CONSOLE.println("us\ngoing to deep sleep..."); + if (BME.PowerPin >= 0) digitalWrite(BME.PowerPin, LOW); + ESP.deepSleep(BME.TimeSecs * 1000000 - micros()); +#endif + } +}