├── .gitattributes ├── .github └── workflows │ └── add_issue_to_project.yml ├── ISSUE_TEMPLATE.md ├── LICENSE.md ├── README.md ├── examples ├── Example1_BasicReadings │ └── Example1_BasicReadings.ino ├── Example2_VerifyChecksums │ └── Example2_VerifyChecksums.ino ├── Example3_ChangingOptions │ └── Example3_ChangingOptions.ino └── Example4_UsingCallback │ └── Example4_UsingCallback.ino ├── keywords.txt ├── library.properties └── src ├── SparkFun_SHTC3.cpp └── SparkFun_SHTC3.h /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.github/workflows/add_issue_to_project.yml: -------------------------------------------------------------------------------- 1 | name: Add new issue to our main project 2 | 3 | on: 4 | issues: 5 | types: 6 | - opened 7 | 8 | jobs: 9 | add-to-project: 10 | name: Add issue to project 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/add-to-project@main 14 | with: 15 | # You can target a project in a different organization 16 | # to the issue 17 | project-url: https://github.com/orgs/sparkfun/projects/19 18 | github-token: ${{ secrets.DEFECT_ADD_TO_PROJECT }} 19 | -------------------------------------------------------------------------------- /ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### Subject of the issue 2 | Describe your issue here. 3 | 4 | ### Your workbench 5 | * What platform are you using? 6 | * What version of the device are you using? Is there a firmware version? 7 | * How is the device wired to your platform? 8 | * How is everything being powered? 9 | * Are there any additional details that may help us help you? 10 | 11 | ### Steps to reproduce 12 | Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue to a gist. 13 | 14 | ### Expected behaviour 15 | Tell us what should happen 16 | 17 | ### Actual behaviour 18 | Tell us what happens instead 19 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | SparkFun License Information 2 | ============================ 3 | 4 | SparkFun uses two different licenses for our files — one for hardware and one for code. 5 | 6 | Hardware 7 | --------- 8 | 9 | **SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).** 10 | 11 | Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode). 12 | 13 | You are free to: 14 | 15 | Share — copy and redistribute the material in any medium or format 16 | Adapt — remix, transform, and build upon the material 17 | for any purpose, even commercially. 18 | The licensor cannot revoke these freedoms as long as you follow the license terms. 19 | Under the following terms: 20 | 21 | Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. 22 | ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original. 23 | No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. 24 | Notices: 25 | 26 | You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation. 27 | No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material. 28 | 29 | 30 | Code 31 | -------- 32 | 33 | **SparkFun code, firmware, and software is released under the GPL v3.** 34 | 35 | -------- 36 | 37 | GNU GENERAL PUBLIC LICENSE 38 | Version 3, 29 June 2007 39 | 40 | Copyright (C) 2007 Free Software Foundation, Inc. 41 | Everyone is permitted to copy and distribute verbatim copies 42 | of this license document, but changing it is not allowed. 43 | 44 | Preamble 45 | 46 | The GNU General Public License is a free, copyleft license for 47 | software and other kinds of works. 48 | 49 | The licenses for most software and other practical works are designed 50 | to take away your freedom to share and change the works. By contrast, 51 | the GNU General Public License is intended to guarantee your freedom to 52 | share and change all versions of a program--to make sure it remains free 53 | software for all its users. We, the Free Software Foundation, use the 54 | GNU General Public License for most of our software; it applies also to 55 | any other work released this way by its authors. You can apply it to 56 | your programs, too. 57 | 58 | When we speak of free software, we are referring to freedom, not 59 | price. Our General Public Licenses are designed to make sure that you 60 | have the freedom to distribute copies of free software (and charge for 61 | them if you wish), that you receive source code or can get it if you 62 | want it, that you can change the software or use pieces of it in new 63 | free programs, and that you know you can do these things. 64 | 65 | To protect your rights, we need to prevent others from denying you 66 | these rights or asking you to surrender the rights. Therefore, you have 67 | certain responsibilities if you distribute copies of the software, or if 68 | you modify it: responsibilities to respect the freedom of others. 69 | 70 | For example, if you distribute copies of such a program, whether 71 | gratis or for a fee, you must pass on to the recipients the same 72 | freedoms that you received. You must make sure that they, too, receive 73 | or can get the source code. And you must show them these terms so they 74 | know their rights. 75 | 76 | Developers that use the GNU GPL protect your rights with two steps: 77 | (1) assert copyright on the software, and (2) offer you this License 78 | giving you legal permission to copy, distribute and/or modify it. 79 | 80 | For the developers' and authors' protection, the GPL clearly explains 81 | that there is no warranty for this free software. For both users' and 82 | authors' sake, the GPL requires that modified versions be marked as 83 | changed, so that their problems will not be attributed erroneously to 84 | authors of previous versions. 85 | 86 | Some devices are designed to deny users access to install or run 87 | modified versions of the software inside them, although the manufacturer 88 | can do so. This is fundamentally incompatible with the aim of 89 | protecting users' freedom to change the software. The systematic 90 | pattern of such abuse occurs in the area of products for individuals to 91 | use, which is precisely where it is most unacceptable. Therefore, we 92 | have designed this version of the GPL to prohibit the practice for those 93 | products. If such problems arise substantially in other domains, we 94 | stand ready to extend this provision to those domains in future versions 95 | of the GPL, as needed to protect the freedom of users. 96 | 97 | Finally, every program is threatened constantly by software patents. 98 | States should not allow patents to restrict development and use of 99 | software on general-purpose computers, but in those that do, we wish to 100 | avoid the special danger that patents applied to a free program could 101 | make it effectively proprietary. To prevent this, the GPL assures that 102 | patents cannot be used to render the program non-free. 103 | 104 | The precise terms and conditions for copying, distribution and 105 | modification follow. 106 | 107 | TERMS AND CONDITIONS 108 | 109 | 0. Definitions. 110 | 111 | "This License" refers to version 3 of the GNU General Public License. 112 | 113 | "Copyright" also means copyright-like laws that apply to other kinds of 114 | works, such as semiconductor masks. 115 | 116 | "The Program" refers to any copyrightable work licensed under this 117 | License. Each licensee is addressed as "you". "Licensees" and 118 | "recipients" may be individuals or organizations. 119 | 120 | To "modify" a work means to copy from or adapt all or part of the work 121 | in a fashion requiring copyright permission, other than the making of an 122 | exact copy. The resulting work is called a "modified version" of the 123 | earlier work or a work "based on" the earlier work. 124 | 125 | A "covered work" means either the unmodified Program or a work based 126 | on the Program. 127 | 128 | To "propagate" a work means to do anything with it that, without 129 | permission, would make you directly or secondarily liable for 130 | infringement under applicable copyright law, except executing it on a 131 | computer or modifying a private copy. Propagation includes copying, 132 | distribution (with or without modification), making available to the 133 | public, and in some countries other activities as well. 134 | 135 | To "convey" a work means any kind of propagation that enables other 136 | parties to make or receive copies. Mere interaction with a user through 137 | a computer network, with no transfer of a copy, is not conveying. 138 | 139 | An interactive user interface displays "Appropriate Legal Notices" 140 | to the extent that it includes a convenient and prominently visible 141 | feature that (1) displays an appropriate copyright notice, and (2) 142 | tells the user that there is no warranty for the work (except to the 143 | extent that warranties are provided), that licensees may convey the 144 | work under this License, and how to view a copy of this License. If 145 | the interface presents a list of user commands or options, such as a 146 | menu, a prominent item in the list meets this criterion. 147 | 148 | 1. Source Code. 149 | 150 | The "source code" for a work means the preferred form of the work 151 | for making modifications to it. "Object code" means any non-source 152 | form of a work. 153 | 154 | A "Standard Interface" means an interface that either is an official 155 | standard defined by a recognized standards body, or, in the case of 156 | interfaces specified for a particular programming language, one that 157 | is widely used among developers working in that language. 158 | 159 | The "System Libraries" of an executable work include anything, other 160 | than the work as a whole, that (a) is included in the normal form of 161 | packaging a Major Component, but which is not part of that Major 162 | Component, and (b) serves only to enable use of the work with that 163 | Major Component, or to implement a Standard Interface for which an 164 | implementation is available to the public in source code form. A 165 | "Major Component", in this context, means a major essential component 166 | (kernel, window system, and so on) of the specific operating system 167 | (if any) on which the executable work runs, or a compiler used to 168 | produce the work, or an object code interpreter used to run it. 169 | 170 | The "Corresponding Source" for a work in object code form means all 171 | the source code needed to generate, install, and (for an executable 172 | work) run the object code and to modify the work, including scripts to 173 | control those activities. However, it does not include the work's 174 | System Libraries, or general-purpose tools or generally available free 175 | programs which are used unmodified in performing those activities but 176 | which are not part of the work. For example, Corresponding Source 177 | includes interface definition files associated with source files for 178 | the work, and the source code for shared libraries and dynamically 179 | linked subprograms that the work is specifically designed to require, 180 | such as by intimate data communication or control flow between those 181 | subprograms and other parts of the work. 182 | 183 | The Corresponding Source need not include anything that users 184 | can regenerate automatically from other parts of the Corresponding 185 | Source. 186 | 187 | The Corresponding Source for a work in source code form is that 188 | same work. 189 | 190 | 2. Basic Permissions. 191 | 192 | All rights granted under this License are granted for the term of 193 | copyright on the Program, and are irrevocable provided the stated 194 | conditions are met. This License explicitly affirms your unlimited 195 | permission to run the unmodified Program. The output from running a 196 | covered work is covered by this License only if the output, given its 197 | content, constitutes a covered work. This License acknowledges your 198 | rights of fair use or other equivalent, as provided by copyright law. 199 | 200 | You may make, run and propagate covered works that you do not 201 | convey, without conditions so long as your license otherwise remains 202 | in force. You may convey covered works to others for the sole purpose 203 | of having them make modifications exclusively for you, or provide you 204 | with facilities for running those works, provided that you comply with 205 | the terms of this License in conveying all material for which you do 206 | not control copyright. Those thus making or running the covered works 207 | for you must do so exclusively on your behalf, under your direction 208 | and control, on terms that prohibit them from making any copies of 209 | your copyrighted material outside their relationship with you. 210 | 211 | Conveying under any other circumstances is permitted solely under 212 | the conditions stated below. Sublicensing is not allowed; section 10 213 | makes it unnecessary. 214 | 215 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 216 | 217 | No covered work shall be deemed part of an effective technological 218 | measure under any applicable law fulfilling obligations under article 219 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 220 | similar laws prohibiting or restricting circumvention of such 221 | measures. 222 | 223 | When you convey a covered work, you waive any legal power to forbid 224 | circumvention of technological measures to the extent such circumvention 225 | is effected by exercising rights under this License with respect to 226 | the covered work, and you disclaim any intention to limit operation or 227 | modification of the work as a means of enforcing, against the work's 228 | users, your or third parties' legal rights to forbid circumvention of 229 | technological measures. 230 | 231 | 4. Conveying Verbatim Copies. 232 | 233 | You may convey verbatim copies of the Program's source code as you 234 | receive it, in any medium, provided that you conspicuously and 235 | appropriately publish on each copy an appropriate copyright notice; 236 | keep intact all notices stating that this License and any 237 | non-permissive terms added in accord with section 7 apply to the code; 238 | keep intact all notices of the absence of any warranty; and give all 239 | recipients a copy of this License along with the Program. 240 | 241 | You may charge any price or no price for each copy that you convey, 242 | and you may offer support or warranty protection for a fee. 243 | 244 | 5. Conveying Modified Source Versions. 245 | 246 | You may convey a work based on the Program, or the modifications to 247 | produce it from the Program, in the form of source code under the 248 | terms of section 4, provided that you also meet all of these conditions: 249 | 250 | a) The work must carry prominent notices stating that you modified 251 | it, and giving a relevant date. 252 | 253 | b) The work must carry prominent notices stating that it is 254 | released under this License and any conditions added under section 255 | 7. This requirement modifies the requirement in section 4 to 256 | "keep intact all notices". 257 | 258 | c) You must license the entire work, as a whole, under this 259 | License to anyone who comes into possession of a copy. This 260 | License will therefore apply, along with any applicable section 7 261 | additional terms, to the whole of the work, and all its parts, 262 | regardless of how they are packaged. This License gives no 263 | permission to license the work in any other way, but it does not 264 | invalidate such permission if you have separately received it. 265 | 266 | d) If the work has interactive user interfaces, each must display 267 | Appropriate Legal Notices; however, if the Program has interactive 268 | interfaces that do not display Appropriate Legal Notices, your 269 | work need not make them do so. 270 | 271 | A compilation of a covered work with other separate and independent 272 | works, which are not by their nature extensions of the covered work, 273 | and which are not combined with it such as to form a larger program, 274 | in or on a volume of a storage or distribution medium, is called an 275 | "aggregate" if the compilation and its resulting copyright are not 276 | used to limit the access or legal rights of the compilation's users 277 | beyond what the individual works permit. Inclusion of a covered work 278 | in an aggregate does not cause this License to apply to the other 279 | parts of the aggregate. 280 | 281 | 6. Conveying Non-Source Forms. 282 | 283 | You may convey a covered work in object code form under the terms 284 | of sections 4 and 5, provided that you also convey the 285 | machine-readable Corresponding Source under the terms of this License, 286 | in one of these ways: 287 | 288 | a) Convey the object code in, or embodied in, a physical product 289 | (including a physical distribution medium), accompanied by the 290 | Corresponding Source fixed on a durable physical medium 291 | customarily used for software interchange. 292 | 293 | b) Convey the object code in, or embodied in, a physical product 294 | (including a physical distribution medium), accompanied by a 295 | written offer, valid for at least three years and valid for as 296 | long as you offer spare parts or customer support for that product 297 | model, to give anyone who possesses the object code either (1) a 298 | copy of the Corresponding Source for all the software in the 299 | product that is covered by this License, on a durable physical 300 | medium customarily used for software interchange, for a price no 301 | more than your reasonable cost of physically performing this 302 | conveying of source, or (2) access to copy the 303 | Corresponding Source from a network server at no charge. 304 | 305 | c) Convey individual copies of the object code with a copy of the 306 | written offer to provide the Corresponding Source. This 307 | alternative is allowed only occasionally and noncommercially, and 308 | only if you received the object code with such an offer, in accord 309 | with subsection 6b. 310 | 311 | d) Convey the object code by offering access from a designated 312 | place (gratis or for a charge), and offer equivalent access to the 313 | Corresponding Source in the same way through the same place at no 314 | further charge. You need not require recipients to copy the 315 | Corresponding Source along with the object code. If the place to 316 | copy the object code is a network server, the Corresponding Source 317 | may be on a different server (operated by you or a third party) 318 | that supports equivalent copying facilities, provided you maintain 319 | clear directions next to the object code saying where to find the 320 | Corresponding Source. Regardless of what server hosts the 321 | Corresponding Source, you remain obligated to ensure that it is 322 | available for as long as needed to satisfy these requirements. 323 | 324 | e) Convey the object code using peer-to-peer transmission, provided 325 | you inform other peers where the object code and Corresponding 326 | Source of the work are being offered to the general public at no 327 | charge under subsection 6d. 328 | 329 | A separable portion of the object code, whose source code is excluded 330 | from the Corresponding Source as a System Library, need not be 331 | included in conveying the object code work. 332 | 333 | A "User Product" is either (1) a "consumer product", which means any 334 | tangible personal property which is normally used for personal, family, 335 | or household purposes, or (2) anything designed or sold for incorporation 336 | into a dwelling. In determining whether a product is a consumer product, 337 | doubtful cases shall be resolved in favor of coverage. For a particular 338 | product received by a particular user, "normally used" refers to a 339 | typical or common use of that class of product, regardless of the status 340 | of the particular user or of the way in which the particular user 341 | actually uses, or expects or is expected to use, the product. A product 342 | is a consumer product regardless of whether the product has substantial 343 | commercial, industrial or non-consumer uses, unless such uses represent 344 | the only significant mode of use of the product. 345 | 346 | "Installation Information" for a User Product means any methods, 347 | procedures, authorization keys, or other information required to install 348 | and execute modified versions of a covered work in that User Product from 349 | a modified version of its Corresponding Source. The information must 350 | suffice to ensure that the continued functioning of the modified object 351 | code is in no case prevented or interfered with solely because 352 | modification has been made. 353 | 354 | If you convey an object code work under this section in, or with, or 355 | specifically for use in, a User Product, and the conveying occurs as 356 | part of a transaction in which the right of possession and use of the 357 | User Product is transferred to the recipient in perpetuity or for a 358 | fixed term (regardless of how the transaction is characterized), the 359 | Corresponding Source conveyed under this section must be accompanied 360 | by the Installation Information. But this requirement does not apply 361 | if neither you nor any third party retains the ability to install 362 | modified object code on the User Product (for example, the work has 363 | been installed in ROM). 364 | 365 | The requirement to provide Installation Information does not include a 366 | requirement to continue to provide support service, warranty, or updates 367 | for a work that has been modified or installed by the recipient, or for 368 | the User Product in which it has been modified or installed. Access to a 369 | network may be denied when the modification itself materially and 370 | adversely affects the operation of the network or violates the rules and 371 | protocols for communication across the network. 372 | 373 | Corresponding Source conveyed, and Installation Information provided, 374 | in accord with this section must be in a format that is publicly 375 | documented (and with an implementation available to the public in 376 | source code form), and must require no special password or key for 377 | unpacking, reading or copying. 378 | 379 | 7. Additional Terms. 380 | 381 | "Additional permissions" are terms that supplement the terms of this 382 | License by making exceptions from one or more of its conditions. 383 | Additional permissions that are applicable to the entire Program shall 384 | be treated as though they were included in this License, to the extent 385 | that they are valid under applicable law. If additional permissions 386 | apply only to part of the Program, that part may be used separately 387 | under those permissions, but the entire Program remains governed by 388 | this License without regard to the additional permissions. 389 | 390 | When you convey a copy of a covered work, you may at your option 391 | remove any additional permissions from that copy, or from any part of 392 | it. (Additional permissions may be written to require their own 393 | removal in certain cases when you modify the work.) You may place 394 | additional permissions on material, added by you to a covered work, 395 | for which you have or can give appropriate copyright permission. 396 | 397 | Notwithstanding any other provision of this License, for material you 398 | add to a covered work, you may (if authorized by the copyright holders of 399 | that material) supplement the terms of this License with terms: 400 | 401 | a) Disclaiming warranty or limiting liability differently from the 402 | terms of sections 15 and 16 of this License; or 403 | 404 | b) Requiring preservation of specified reasonable legal notices or 405 | author attributions in that material or in the Appropriate Legal 406 | Notices displayed by works containing it; or 407 | 408 | c) Prohibiting misrepresentation of the origin of that material, or 409 | requiring that modified versions of such material be marked in 410 | reasonable ways as different from the original version; or 411 | 412 | d) Limiting the use for publicity purposes of names of licensors or 413 | authors of the material; or 414 | 415 | e) Declining to grant rights under trademark law for use of some 416 | trade names, trademarks, or service marks; or 417 | 418 | f) Requiring indemnification of licensors and authors of that 419 | material by anyone who conveys the material (or modified versions of 420 | it) with contractual assumptions of liability to the recipient, for 421 | any liability that these contractual assumptions directly impose on 422 | those licensors and authors. 423 | 424 | All other non-permissive additional terms are considered "further 425 | restrictions" within the meaning of section 10. If the Program as you 426 | received it, or any part of it, contains a notice stating that it is 427 | governed by this License along with a term that is a further 428 | restriction, you may remove that term. If a license document contains 429 | a further restriction but permits relicensing or conveying under this 430 | License, you may add to a covered work material governed by the terms 431 | of that license document, provided that the further restriction does 432 | not survive such relicensing or conveying. 433 | 434 | If you add terms to a covered work in accord with this section, you 435 | must place, in the relevant source files, a statement of the 436 | additional terms that apply to those files, or a notice indicating 437 | where to find the applicable terms. 438 | 439 | Additional terms, permissive or non-permissive, may be stated in the 440 | form of a separately written license, or stated as exceptions; 441 | the above requirements apply either way. 442 | 443 | 8. Termination. 444 | 445 | You may not propagate or modify a covered work except as expressly 446 | provided under this License. Any attempt otherwise to propagate or 447 | modify it is void, and will automatically terminate your rights under 448 | this License (including any patent licenses granted under the third 449 | paragraph of section 11). 450 | 451 | However, if you cease all violation of this License, then your 452 | license from a particular copyright holder is reinstated (a) 453 | provisionally, unless and until the copyright holder explicitly and 454 | finally terminates your license, and (b) permanently, if the copyright 455 | holder fails to notify you of the violation by some reasonable means 456 | prior to 60 days after the cessation. 457 | 458 | Moreover, your license from a particular copyright holder is 459 | reinstated permanently if the copyright holder notifies you of the 460 | violation by some reasonable means, this is the first time you have 461 | received notice of violation of this License (for any work) from that 462 | copyright holder, and you cure the violation prior to 30 days after 463 | your receipt of the notice. 464 | 465 | Termination of your rights under this section does not terminate the 466 | licenses of parties who have received copies or rights from you under 467 | this License. If your rights have been terminated and not permanently 468 | reinstated, you do not qualify to receive new licenses for the same 469 | material under section 10. 470 | 471 | 9. Acceptance Not Required for Having Copies. 472 | 473 | You are not required to accept this License in order to receive or 474 | run a copy of the Program. Ancillary propagation of a covered work 475 | occurring solely as a consequence of using peer-to-peer transmission 476 | to receive a copy likewise does not require acceptance. However, 477 | nothing other than this License grants you permission to propagate or 478 | modify any covered work. These actions infringe copyright if you do 479 | not accept this License. Therefore, by modifying or propagating a 480 | covered work, you indicate your acceptance of this License to do so. 481 | 482 | 10. Automatic Licensing of Downstream Recipients. 483 | 484 | Each time you convey a covered work, the recipient automatically 485 | receives a license from the original licensors, to run, modify and 486 | propagate that work, subject to this License. You are not responsible 487 | for enforcing compliance by third parties with this License. 488 | 489 | An "entity transaction" is a transaction transferring control of an 490 | organization, or substantially all assets of one, or subdividing an 491 | organization, or merging organizations. If propagation of a covered 492 | work results from an entity transaction, each party to that 493 | transaction who receives a copy of the work also receives whatever 494 | licenses to the work the party's predecessor in interest had or could 495 | give under the previous paragraph, plus a right to possession of the 496 | Corresponding Source of the work from the predecessor in interest, if 497 | the predecessor has it or can get it with reasonable efforts. 498 | 499 | You may not impose any further restrictions on the exercise of the 500 | rights granted or affirmed under this License. For example, you may 501 | not impose a license fee, royalty, or other charge for exercise of 502 | rights granted under this License, and you may not initiate litigation 503 | (including a cross-claim or counterclaim in a lawsuit) alleging that 504 | any patent claim is infringed by making, using, selling, offering for 505 | sale, or importing the Program or any portion of it. 506 | 507 | 11. Patents. 508 | 509 | A "contributor" is a copyright holder who authorizes use under this 510 | License of the Program or a work on which the Program is based. The 511 | work thus licensed is called the contributor's "contributor version". 512 | 513 | A contributor's "essential patent claims" are all patent claims 514 | owned or controlled by the contributor, whether already acquired or 515 | hereafter acquired, that would be infringed by some manner, permitted 516 | by this License, of making, using, or selling its contributor version, 517 | but do not include claims that would be infringed only as a 518 | consequence of further modification of the contributor version. For 519 | purposes of this definition, "control" includes the right to grant 520 | patent sublicenses in a manner consistent with the requirements of 521 | this License. 522 | 523 | Each contributor grants you a non-exclusive, worldwide, royalty-free 524 | patent license under the contributor's essential patent claims, to 525 | make, use, sell, offer for sale, import and otherwise run, modify and 526 | propagate the contents of its contributor version. 527 | 528 | In the following three paragraphs, a "patent license" is any express 529 | agreement or commitment, however denominated, not to enforce a patent 530 | (such as an express permission to practice a patent or covenant not to 531 | sue for patent infringement). To "grant" such a patent license to a 532 | party means to make such an agreement or commitment not to enforce a 533 | patent against the party. 534 | 535 | If you convey a covered work, knowingly relying on a patent license, 536 | and the Corresponding Source of the work is not available for anyone 537 | to copy, free of charge and under the terms of this License, through a 538 | publicly available network server or other readily accessible means, 539 | then you must either (1) cause the Corresponding Source to be so 540 | available, or (2) arrange to deprive yourself of the benefit of the 541 | patent license for this particular work, or (3) arrange, in a manner 542 | consistent with the requirements of this License, to extend the patent 543 | license to downstream recipients. "Knowingly relying" means you have 544 | actual knowledge that, but for the patent license, your conveying the 545 | covered work in a country, or your recipient's use of the covered work 546 | in a country, would infringe one or more identifiable patents in that 547 | country that you have reason to believe are valid. 548 | 549 | If, pursuant to or in connection with a single transaction or 550 | arrangement, you convey, or propagate by procuring conveyance of, a 551 | covered work, and grant a patent license to some of the parties 552 | receiving the covered work authorizing them to use, propagate, modify 553 | or convey a specific copy of the covered work, then the patent license 554 | you grant is automatically extended to all recipients of the covered 555 | work and works based on it. 556 | 557 | A patent license is "discriminatory" if it does not include within 558 | the scope of its coverage, prohibits the exercise of, or is 559 | conditioned on the non-exercise of one or more of the rights that are 560 | specifically granted under this License. You may not convey a covered 561 | work if you are a party to an arrangement with a third party that is 562 | in the business of distributing software, under which you make payment 563 | to the third party based on the extent of your activity of conveying 564 | the work, and under which the third party grants, to any of the 565 | parties who would receive the covered work from you, a discriminatory 566 | patent license (a) in connection with copies of the covered work 567 | conveyed by you (or copies made from those copies), or (b) primarily 568 | for and in connection with specific products or compilations that 569 | contain the covered work, unless you entered into that arrangement, 570 | or that patent license was granted, prior to 28 March 2007. 571 | 572 | Nothing in this License shall be construed as excluding or limiting 573 | any implied license or other defenses to infringement that may 574 | otherwise be available to you under applicable patent law. 575 | 576 | 12. No Surrender of Others' Freedom. 577 | 578 | If conditions are imposed on you (whether by court order, agreement or 579 | otherwise) that contradict the conditions of this License, they do not 580 | excuse you from the conditions of this License. If you cannot convey a 581 | covered work so as to satisfy simultaneously your obligations under this 582 | License and any other pertinent obligations, then as a consequence you may 583 | not convey it at all. For example, if you agree to terms that obligate you 584 | to collect a royalty for further conveying from those to whom you convey 585 | the Program, the only way you could satisfy both those terms and this 586 | License would be to refrain entirely from conveying the Program. 587 | 588 | 13. Use with the GNU Affero General Public License. 589 | 590 | Notwithstanding any other provision of this License, you have 591 | permission to link or combine any covered work with a work licensed 592 | under version 3 of the GNU Affero General Public License into a single 593 | combined work, and to convey the resulting work. The terms of this 594 | License will continue to apply to the part which is the covered work, 595 | but the special requirements of the GNU Affero General Public License, 596 | section 13, concerning interaction through a network will apply to the 597 | combination as such. 598 | 599 | 14. Revised Versions of this License. 600 | 601 | The Free Software Foundation may publish revised and/or new versions of 602 | the GNU General Public License from time to time. Such new versions will 603 | be similar in spirit to the present version, but may differ in detail to 604 | address new problems or concerns. 605 | 606 | Each version is given a distinguishing version number. If the 607 | Program specifies that a certain numbered version of the GNU General 608 | Public License "or any later version" applies to it, you have the 609 | option of following the terms and conditions either of that numbered 610 | version or of any later version published by the Free Software 611 | Foundation. If the Program does not specify a version number of the 612 | GNU General Public License, you may choose any version ever published 613 | by the Free Software Foundation. 614 | 615 | If the Program specifies that a proxy can decide which future 616 | versions of the GNU General Public License can be used, that proxy's 617 | public statement of acceptance of a version permanently authorizes you 618 | to choose that version for the Program. 619 | 620 | Later license versions may give you additional or different 621 | permissions. However, no additional obligations are imposed on any 622 | author or copyright holder as a result of your choosing to follow a 623 | later version. 624 | 625 | 15. Disclaimer of Warranty. 626 | 627 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 628 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 629 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 630 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 631 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 632 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 633 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 634 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 635 | 636 | 16. Limitation of Liability. 637 | 638 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 639 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 640 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 641 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 642 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 643 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 644 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 645 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 646 | SUCH DAMAGES. 647 | 648 | 17. Interpretation of Sections 15 and 16. 649 | 650 | If the disclaimer of warranty and limitation of liability provided 651 | above cannot be given local legal effect according to their terms, 652 | reviewing courts shall apply local law that most closely approximates 653 | an absolute waiver of all civil liability in connection with the 654 | Program, unless a warranty or assumption of liability accompanies a 655 | copy of the Program in return for a fee. 656 | 657 | END OF TERMS AND CONDITIONS 658 | 659 | How to Apply These Terms to Your New Programs 660 | 661 | If you develop a new program, and you want it to be of the greatest 662 | possible use to the public, the best way to achieve this is to make it 663 | free software which everyone can redistribute and change under these terms. 664 | 665 | To do so, attach the following notices to the program. It is safest 666 | to attach them to the start of each source file to most effectively 667 | state the exclusion of warranty; and each file should have at least 668 | the "copyright" line and a pointer to where the full notice is found. 669 | 670 | 671 | Copyright (C) 672 | 673 | This program is free software: you can redistribute it and/or modify 674 | it under the terms of the GNU General Public License as published by 675 | the Free Software Foundation, either version 3 of the License, or 676 | (at your option) any later version. 677 | 678 | This program is distributed in the hope that it will be useful, 679 | but WITHOUT ANY WARRANTY; without even the implied warranty of 680 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 681 | GNU General Public License for more details. 682 | 683 | You should have received a copy of the GNU General Public License 684 | along with this program. If not, see . 685 | 686 | Also add information on how to contact you by electronic and paper mail. 687 | 688 | If the program does terminal interaction, make it output a short 689 | notice like this when it starts in an interactive mode: 690 | 691 | Copyright (C) 692 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 693 | This is free software, and you are welcome to redistribute it 694 | under certain conditions; type `show c' for details. 695 | 696 | The hypothetical commands `show w' and `show c' should show the appropriate 697 | parts of the General Public License. Of course, your program's commands 698 | might be different; for a GUI interface, you would use an "about box". 699 | 700 | You should also get your employer (if you work as a programmer) or school, 701 | if any, to sign a "copyright disclaimer" for the program, if necessary. 702 | For more information on this, and how to apply and follow the GNU GPL, see 703 | . 704 | 705 | The GNU General Public License does not permit incorporating your program 706 | into proprietary programs. If your program is a subroutine library, you 707 | may consider it more useful to permit linking proprietary applications with 708 | the library. If this is what you want to do, use the GNU Lesser General 709 | Public License instead of this License. But first, please read 710 | . 711 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | SparkFun SHTC3 Humidity and Temperature Sensor Library 2 | ======================================== 3 | 4 | [![SparkFun Humidity Sensor - SHTC3 (Qwiic)](https://cdn.sparkfun.com/assets/parts/1/5/3/3/0/16467-SparkFun_Humidity_Sensor_Breakout_-_SHTC3__Qwiic_-01.jpg)](https://www.sparkfun.com/products/16467) 5 | 6 | [*SparkFun Humidity Sensor - SHTC3 (Qwiic)*](https://www.sparkfun.com/products/16467) 7 | 8 | 9 | This Arduino library allows you to take Humidity and Temperature readings using the SHTC3 sensor from Sensirion using the standard Wire (I2C) library built into Arduino. This means the library is compatible with any Arduino-compatible board that has I2C hardware. Key features of the library include the ability to return either raw ADC values or flaoting point values in %RH and deg C/deg F, data validity indicators based on CRC checking, and a unified return status format for easy error checking. For advanced users an on-return callback is implemented to illuminate the order of program execution. 10 | 11 | Repository Contents 12 | ------------------- 13 | 14 | * **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. 15 | * **/src** - Source files for the library (.cpp, .h). 16 | * **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. 17 | * **library.properties** - General library properties for the Arduino package manager. 18 | 19 | Documentation 20 | -------------- 21 | 22 | * **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library. 23 | * **[Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-humidity-sensor-breakout---shtc3-qwiic-hookup-guide)** - Basic hookup guide for the Humidity Sensor - SHTC3 (Qwiic). 24 | 25 | Products that use this Library 26 | --------------------------------- 27 | 28 | * [SEN-18632](https://www.sparkfun.com/products/18632) - SparkFun MicroMod Environmental Function Board with SGP40, STC31, and SHTC3 29 | * [SEN-16467](https://www.sparkfun.com/products/16467) - SparkFun Humidity Sensor - SHTC3 (Qwiic) 30 | * [SPX-15074](https://www.sparkfun.com/products/15074) - SparkX Humidity Sensor Breakout SHTC3 (Qwiic) 31 | * [RAK1901](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1901/Overview/) - RAKwireless WisBlock Temperature and Humidity Sensor 32 | 33 | 34 | Version History 35 | --------------- 36 | **1.0.0** - Initial release 37 | 38 | License Information 39 | ------------------- 40 | 41 | This product is _**open source**_! 42 | 43 | The **code** is released under the GPL v3 license. See the included LICENSE.md for more information. 44 | 45 | Distributed as-is; no warranty is given. 46 | 47 | \- Your friends at SparkFun. 48 | -------------------------------------------------------------------------------- /examples/Example1_BasicReadings/Example1_BasicReadings.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Take humidity and temperature readings with the SHTC3 using I2C 3 | By: Owen Lyke 4 | SparkFun Electronics 5 | Date: August 24 2018 6 | License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license). 7 | Example1_BasicReadings 8 | To connect the sensor to an Arduino: 9 | This library supports the sensor using the I2C protocol 10 | On Qwiic enabled boards simply connnect the sensor with a Qwiic cable and it is set to go 11 | On non-qwiic boards you will need to connect 4 wires between the sensor and the host board 12 | (Arduino pin) = (Display pin) 13 | SCL = SCL on display carrier 14 | SDA = SDA 15 | GND = GND 16 | 3.3V = 3.3V 17 | */ 18 | 19 | #include "SparkFun_SHTC3.h" // Click here to get the library: http://librarymanager/All#SparkFun_SHTC3 20 | 21 | SHTC3 mySHTC3; // Declare an instance of the SHTC3 class 22 | 23 | void setup() { 24 | 25 | Serial.begin(115200); // Begin Serial 26 | while(Serial == false){}; // Wait for the serial connection to start up 27 | Serial.println("SHTC3 Example 1 - Basic Readings"); // Title 28 | Wire.begin(); 29 | Serial.print("Beginning sensor. Result = "); // Most SHTC3 functions return a variable of the type "SHTC3_Status_TypeDef" to indicate the status of their execution 30 | errorDecoder(mySHTC3.begin()); // To start the sensor you must call "begin()", the default settings use Wire (default Arduino I2C port) 31 | Serial.println(); 32 | Serial.println("\n\n"); 33 | Serial.println("Waiting for 5 seconds so you can read this info ^^^"); 34 | 35 | delay(5000); // Give time to read the welcome message and device ID. 36 | } 37 | 38 | void loop() { 39 | SHTC3_Status_TypeDef result = mySHTC3.update(); // Call "update()" to command a measurement, wait for measurement to complete, and update the RH and T members of the object 40 | printInfo(); // This function is used to print a nice little line of info to the serial port 41 | delay(190); // Delay for the data rate you want - note that measurements take ~10 ms so the fastest data rate is 100 Hz (when no delay is used) 42 | } 43 | 44 | 45 | 46 | /////////////////////// 47 | // Utility Functions // 48 | /////////////////////// 49 | void printInfo() 50 | { 51 | if(mySHTC3.lastStatus == SHTC3_Status_Nominal) // You can also assess the status of the last command by checking the ".lastStatus" member of the object 52 | { 53 | Serial.print("RH = "); 54 | Serial.print(mySHTC3.toPercent()); // "toPercent" returns the percent humidity as a floating point number 55 | Serial.print("%, T = "); 56 | Serial.print(mySHTC3.toDegF()); // "toDegF" and "toDegC" return the temperature as a flaoting point number in deg F and deg C respectively 57 | Serial.println(" deg F"); 58 | } 59 | else 60 | { 61 | Serial.print("Update failed, error: "); 62 | errorDecoder(mySHTC3.lastStatus); 63 | Serial.println(); 64 | } 65 | } 66 | 67 | void errorDecoder(SHTC3_Status_TypeDef message) // The errorDecoder function prints "SHTC3_Status_TypeDef" resultsin a human-friendly way 68 | { 69 | switch(message) 70 | { 71 | case SHTC3_Status_Nominal : Serial.print("Nominal"); break; 72 | case SHTC3_Status_Error : Serial.print("Error"); break; 73 | case SHTC3_Status_CRC_Fail : Serial.print("CRC Fail"); break; 74 | default : Serial.print("Unknown return code"); break; 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /examples/Example2_VerifyChecksums/Example2_VerifyChecksums.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Take humidity and temperature readings with the SHTC3 using I2C 3 | By: Owen Lyke 4 | SparkFun Electronics 5 | Date: August 24 2018 6 | License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license). 7 | Example1_BasicReadings 8 | To connect the sensor to an Arduino: 9 | This library supports the sensor using the I2C protocol 10 | On Qwiic enabled boards simply connnect the sensor with a Qwiic cable and it is set to go 11 | On non-qwiic boards you will need to connect 4 wires between the sensor and the host board 12 | (Arduino pin) = (Display pin) 13 | SCL = SCL on display carrier 14 | SDA = SDA 15 | GND = GND 16 | 3.3V = 3.3V 17 | */ 18 | 19 | #include "SparkFun_SHTC3.h" // Click here to get the library: http://librarymanager/All#SparkFun_SHTC3 20 | 21 | #define Serial Serial // #define-ing the Serial allows you to easily change your target port - for example if you are using a SAMD21 board you can change "Serial" to "SerialUSB" 22 | 23 | SHTC3 mySHTC3; // Declare an instance of the SHTC3 class 24 | 25 | void setup() { 26 | 27 | Serial.begin(115200); // Begin Serial 28 | while(Serial == false){}; // Wait for the serial connection to start up 29 | Serial.println("SHTC3 Example 2 - Verify Checksums"); // Title 30 | Wire.begin(); 31 | Serial.print("Beginning sensor. Result = "); // Most SHTC3 functions return a variable of the type "SHTC3_Status_TypeDef" to indicate the status of their execution 32 | errorDecoder(mySHTC3.begin()); // To start the sensor you must call "begin()", the default settings use Wire (default Arduino I2C port) 33 | Serial.println(); 34 | 35 | if(mySHTC3.passIDcrc) // Whenever data is received the associated checksum is calculated and verified so you can be sure the data is true 36 | { // The checksum pass indicators are: passIDcrc, passRHcrc, and passTcrc for the ID, RH, and T readings respectively 37 | Serial.print("ID Passed Checksum. "); 38 | Serial.print("Device ID: 0b"); 39 | Serial.print(mySHTC3.ID, BIN); // The 16-bit device ID can be accessed as a member variable of the object 40 | } 41 | else 42 | { 43 | Serial.print("ID Checksum Failed. "); 44 | } 45 | Serial.println("\n\n"); 46 | Serial.println("Waiting for 5 seconds so you can read this info ^^^"); 47 | 48 | delay(5000); // Give time to read the welcome message and device ID. 49 | } 50 | 51 | void loop() { 52 | SHTC3_Status_TypeDef result = mySHTC3.update(); // Call "update()" to command a measurement, wait for measurement to complete, and update the RH and T members of the object 53 | printInfo(); // This function is used to print a nice little line of info to the serial port 54 | delay(190); // Delay for the data rate you want - note that measurements take ~10 ms so the fastest data rate is 100 Hz (when no delay is used) 55 | } 56 | 57 | 58 | 59 | /////////////////////// 60 | // Utility Functions // 61 | /////////////////////// 62 | void printInfo() 63 | { 64 | if(mySHTC3.lastStatus == SHTC3_Status_Nominal) // You can also assess the status of the last command by checking the ".lastStatus" member of the object 65 | { 66 | Serial.print("RH = "); 67 | Serial.print(mySHTC3.toPercent()); // "toPercent" returns the percent humidity as a floating point number 68 | Serial.print("% (checksum: "); 69 | if(mySHTC3.passRHcrc) // Like "passIDcrc" this is true when the RH value is valid from the sensor (but not necessarily up-to-date in terms of time) 70 | { 71 | Serial.print("pass"); 72 | } 73 | else 74 | { 75 | Serial.print("fail"); 76 | } 77 | Serial.print("), T = "); 78 | Serial.print(mySHTC3.toDegF()); // "toDegF" and "toDegC" return the temperature as a flaoting point number in deg F and deg C respectively 79 | Serial.print(" deg F (checksum: "); 80 | if(mySHTC3.passTcrc) // Like "passIDcrc" this is true when the T value is valid from the sensor (but not necessarily up-to-date in terms of time) 81 | { 82 | Serial.print("pass"); 83 | } 84 | else 85 | { 86 | Serial.print("fail"); 87 | } 88 | Serial.println(")"); 89 | } 90 | else 91 | { 92 | Serial.print("Update failed, error: "); 93 | errorDecoder(mySHTC3.lastStatus); 94 | Serial.println(); 95 | } 96 | } 97 | 98 | void errorDecoder(SHTC3_Status_TypeDef message) // The errorDecoder function prints "SHTC3_Status_TypeDef" resultsin a human-friendly way 99 | { 100 | switch(message) 101 | { 102 | case SHTC3_Status_Nominal : Serial.print("Nominal"); break; 103 | case SHTC3_Status_Error : Serial.print("Error"); break; 104 | case SHTC3_Status_CRC_Fail : Serial.print("CRC Fail"); break; 105 | default : Serial.print("Unknown return code"); break; 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /examples/Example3_ChangingOptions/Example3_ChangingOptions.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Use different settings and ports with your SHTC3 - then take humidity and temperature readings using I2C 3 | By: Owen Lyke 4 | SparkFun Electronics 5 | Date: August 24 2018 6 | License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license). 7 | Example1_BasicReadings 8 | To connect the sensor to an Arduino: 9 | This library supports the sensor using the I2C protocol 10 | On Qwiic enabled boards simply connnect the sensor with a Qwiic cable and it is set to go 11 | On non-qwiic boards you will need to connect 4 wires between the sensor and the host board 12 | (Arduino pin) = (Display pin) 13 | SCL = SCL on display carrier 14 | SDA = SDA 15 | GND = GND 16 | 3.3V = 3.3V 17 | */ 18 | 19 | #include "SparkFun_SHTC3.h" // Click here to get the library: http://librarymanager/All#SparkFun_SHTC3 20 | 21 | #define WIRE_PORT Wire // This allows you to choose another Wire port (as long as your board supports more than one) 22 | #define WIRE_SPEED 800000 // 800 kHz is the fastest speed that worked on the Uno, but the sensor is rated for up to 1 MHz 23 | //#define WIRE_SPEED SHTC3_MAX_CLOCK_FREQ // This is just to show you that there is a defined constant for the maximum rated speed. You might be able to use this speed depending on the microcontroller you use 24 | SHTC3 mySHTC3; // Declare an instance of the SHTC3 class 25 | 26 | void setup() { 27 | Serial.begin(115200); // Begin Serial 28 | while(Serial == false){}; // Wait for the serial connection to start up 29 | Serial.println("SHTC3 Example 3 - Changing Options"); // Title 30 | Serial.println(); 31 | WIRE_PORT.begin(); 32 | #if(WIRE_SPEED <= SHTC3_MAX_CLOCK_FREQ) // You can boost the speed of the I2C interface, but keep in mind that other I2C sensors may not support as high a speed! 33 | WIRE_PORT.setClock(WIRE_SPEED); 34 | #else 35 | WIRE_PORT.setClock(SHTC3_MAX_CLOCK_FREQ); 36 | #endif 37 | 38 | Serial.print("Beginning sensor. Result = "); // Most SHTC3 functions return a variable of the type "SHTC3_Status_TypeDef" to indicate the status of their execution 39 | errorDecoder(mySHTC3.begin(WIRE_PORT)); // Calling "begin()" with the port argument allows you to reassign the interface to the sensor 40 | Serial.println(); 41 | 42 | if(mySHTC3.passIDcrc) // Whenever data is received the associated checksum is calculated and verified so you can be sure the data is true 43 | { // The checksum pass indicators are: passIDcrc, passRHcrc, and passTcrc for the ID, RH, and T readings respectively 44 | Serial.print("ID Passed Checksum. "); 45 | Serial.print("Device ID: 0b"); 46 | Serial.print(mySHTC3.ID, BIN); // The 16-bit device ID can be accessed as a member variable of the object 47 | } 48 | else 49 | { 50 | Serial.print("ID Checksum Failed. "); 51 | } 52 | Serial.println("\n"); 53 | 54 | /* 55 | * Using "setMode" specifies how the measurements will be taken. Options are: 56 | * 57 | SHTC3_CMD_CSE_RHF_NPM = 0x5C24, // Clock stretching, RH first, Normal power mode 58 | SHTC3_CMD_CSE_RHF_LPM = 0x44DE, // Clock stretching, RH first, Low power mode 59 | SHTC3_CMD_CSE_TF_NPM = 0x7CA2, // Clock stretching, T first, Normal power mode 60 | SHTC3_CMD_CSE_TF_LPM = 0x6458, // Clock stretching, T first, Low power mode 61 | 62 | SHTC3_CMD_CSD_RHF_NPM = 0x58E0, // Polling, RH first, Normal power mode 63 | SHTC3_CMD_CSD_RHF_LPM = 0x401A, // Polling, RH first, Low power mode 64 | SHTC3_CMD_CSD_TF_NPM = 0x7866, // Polling, T first, Normal power mode 65 | SHTC3_CMD_CSD_TF_LPM = 0x609C // Polling, T first, Low power mode 66 | 67 | Note that the order (RH or T first) only affects the order in which the sensor 68 | sends the data out. The library will correctly handle either direction and provide 69 | you with RH and T in the corresponding member variables of your sensor 70 | */ 71 | Serial.print("Choosing low-power measurements with T first: "); 72 | if(mySHTC3.setMode(SHTC3_CMD_CSE_TF_LPM) == SHTC3_Status_Nominal) 73 | { 74 | Serial.print(" successful"); 75 | } 76 | else 77 | { 78 | Serial.print(" failed"); 79 | } 80 | Serial.println("\n"); 81 | 82 | 83 | /* 84 | Using "wake()" or "sleep()" without arguments will only send the corresponding command to the sensor. 85 | if you specify the argument like "sleep(true)" or "wake(1)" then the library will send the command 86 | as well as record a preference. So "sleep(true)" will make it so that the sensor is always put to sleep 87 | after commands while "wake(true)" will keep the sensor awake until another "sleep()" or "sleep(true)" 88 | 89 | The sensor begins in the sleep(true) state. 90 | */ 91 | Serial.print("Setting the sensor to stay awake at all times: "); 92 | if(mySHTC3.wake(true) == SHTC3_Status_Nominal) 93 | { 94 | Serial.print(" successful"); 95 | } 96 | else 97 | { 98 | Serial.print(" failed"); 99 | } 100 | Serial.println("\n\n"); 101 | 102 | Serial.println("Waiting for 5 seconds so you can read this info ^^^ \n"); 103 | 104 | delay(5000); // Give time to read the welcome message and device ID. 105 | } 106 | 107 | void loop() { 108 | SHTC3_Status_TypeDef result = mySHTC3.update(); // Call "update()" to command a measurement, wait for measurement to complete, and update the RH and T members of the object 109 | printInfo(); // This function is used to print a nice little line of info to the serial port 110 | delay(190); // Delay for the data rate you want - note that measurements take ~10 ms so the fastest data rate is 100 Hz (when no delay is used) 111 | } 112 | 113 | /////////////////////// 114 | // Utility Functions // 115 | /////////////////////// 116 | void printInfo() 117 | { 118 | if(mySHTC3.lastStatus == SHTC3_Status_Nominal) // You can also assess the status of the last command by checking the ".lastStatus" member of the object 119 | { 120 | Serial.print("RH = "); 121 | Serial.print(mySHTC3.toPercent()); // "toPercent" returns the percent humidity as a floating point number 122 | Serial.print("% (checksum: "); 123 | if(mySHTC3.passRHcrc) // Like "passIDcrc" this is true when the RH value is valid from the sensor (but not necessarily up-to-date in terms of time) 124 | { 125 | Serial.print("pass"); 126 | } 127 | else 128 | { 129 | Serial.print("fail"); 130 | } 131 | Serial.print("), T = "); 132 | Serial.print(mySHTC3.toDegF()); // "toDegF" and "toDegC" return the temperature as a flaoting point number in deg F and deg C respectively 133 | Serial.print(" deg F (checksum: "); 134 | if(mySHTC3.passTcrc) // Like "passIDcrc" this is true when the T value is valid from the sensor (but not necessarily up-to-date in terms of time) 135 | { 136 | Serial.print("pass"); 137 | } 138 | else 139 | { 140 | Serial.print("fail"); 141 | } 142 | Serial.println(")"); 143 | } 144 | else 145 | { 146 | Serial.print("Update failed, error: "); 147 | errorDecoder(mySHTC3.lastStatus); 148 | Serial.println(); 149 | } 150 | } 151 | 152 | void errorDecoder(SHTC3_Status_TypeDef message) // The errorDecoder function prints "SHTC3_Status_TypeDef" resultsin a human-friendly way 153 | { 154 | switch(message) 155 | { 156 | case SHTC3_Status_Nominal : Serial.print("Nominal"); break; 157 | case SHTC3_Status_Error : Serial.print("Error"); break; 158 | case SHTC3_Status_CRC_Fail : Serial.print("CRC Fail"); break; 159 | default : Serial.print("Unknown return code"); break; 160 | } 161 | } 162 | -------------------------------------------------------------------------------- /examples/Example4_UsingCallback/Example4_UsingCallback.ino: -------------------------------------------------------------------------------- 1 | /* 2 | Use a callback function to trace the program execution (and maybe find problems!) 3 | By: Owen Lyke 4 | SparkFun Electronics 5 | Date: August 24 2018 6 | License: This code is public domain but you buy me a beer if you use this and we meet someday (Beerware license). 7 | Example1_BasicReadings 8 | To connect the sensor to an Arduino: 9 | This library supports the sensor using the I2C protocol 10 | On Qwiic enabled boards simply connnect the sensor with a Qwiic cable and it is set to go 11 | On non-qwiic boards you will need to connect 4 wires between the sensor and the host board 12 | (Arduino pin) = (Display pin) 13 | SCL = SCL on display carrier 14 | SDA = SDA 15 | GND = GND 16 | 3.3V = 3.3V 17 | */ 18 | 19 | #include "SparkFun_SHTC3.h" // Click here to get the library: http://librarymanager/All#SparkFun_SHTC3 20 | 21 | #define WIRE_PORT Wire // This allows you to choose another Wire port (as long as your board supports more than one) 22 | #define WIRE_SPEED 800000 // 800 kHz is the fastest speed that worked on the Uno, but the sensor is rated for up to 1 MHz 23 | 24 | SHTC3 mySHTC3; // Declare an instance of the SHTC3 class 25 | 26 | void errorDecoder(SHTC3_Status_TypeDef message); // Declaration of errorDecoder() so that we can use it in the callback 27 | 28 | /* 29 | 30 | What is a callback? It is a way that a library can provide a place for the user to do something. 31 | What is the SHTC3 callback? The library was written with a function that is called (nearly) every time a function is exited. 32 | How is that useful? You can overwrite the function with your own definition that allows you to do things like debug or watch the program execute 33 | 34 | How do you do it? 35 | Make a function with this signature: 36 | 37 | void SHTC3_exitOp_Callback(SHTC3_Status_TypeDef status, bool inProcess, char * file, uint16_t line) 38 | 39 | Then write in it some code that might help you. 40 | 41 | The example below helps us watch the code execute by displaying the line number, file, and status every time that a function finishes. 42 | This is useful for debugging, but can add a lot of overhead. For the fastest code execution just don't declare this function and it 43 | should be optimized out by the compiler. 44 | */ 45 | #define DEBUG 1 // Change to 0 to (hopefully) optimize out the callback function 46 | #if DEBUG 47 | void SHTC3_exitOp_Callback(SHTC3_Status_TypeDef status, bool inProcess, char * file, uint16_t line) 48 | { 49 | Serial.print("Exited with status '"); 50 | errorDecoder(status); 51 | Serial.print("' in line "); 52 | Serial.print(line); 53 | Serial.print(" of file '"); 54 | Serial.print(file); 55 | Serial.print("'. In process: "); 56 | Serial.print(inProcess); 57 | Serial.println(); 58 | } 59 | #endif /* DEBUG */ 60 | 61 | 62 | 63 | void setup() { 64 | Serial.begin(115200); // Begin Serial 65 | while(Serial == false){}; // Wait for the serial connection to start up 66 | Serial.println("SHTC3 Example 4 - Using Callback"); // Title 67 | Serial.println(); 68 | 69 | Serial.print("Beginning sensor. Result = "); // Most SHTC3 functions return a variable of the type "SHTC3_Status_TypeDef" to indicate the status of their execution 70 | errorDecoder(mySHTC3.begin(WIRE_PORT)); // Calling "begin()" with port and speed arguments allows you to reassign the interface to the sensor 71 | #if(WIRE_SPEED <= SHTC3_MAX_CLOCK_FREQ) // You can boost the speed of the I2C interface, but keep in mind that other I2C sensors may not support as high a speed! 72 | WIRE_PORT.setClock(WIRE_SPEED); 73 | #else 74 | WIRE_PORT.setClock(SHTC3_MAX_CLOCK_FREQ); 75 | #endif 76 | Serial.println(); 77 | 78 | if(mySHTC3.passIDcrc) // Whenever data is received the associated checksum is calculated and verified so you can be sure the data is true 79 | { // The checksum pass indicators are: passIDcrc, passRHcrc, and passTcrc for the ID, RH, and T readings respectively 80 | Serial.print("ID Passed Checksum. "); 81 | Serial.print("Device ID: 0b"); 82 | Serial.print(mySHTC3.ID, BIN); // The 16-bit device ID can be accessed as a member variable of the object 83 | } 84 | else 85 | { 86 | Serial.print("ID Checksum Failed. "); 87 | } 88 | Serial.println("\n\n"); 89 | 90 | Serial.println("Waiting for 5 seconds so you can read this info ^^^ \n"); 91 | 92 | delay(5000); // Give time to read the welcome message and device ID. 93 | } 94 | 95 | void loop() { 96 | SHTC3_Status_TypeDef result = mySHTC3.update(); // Call "update()" to command a measurement, wait for measurement to complete, and update the RH and T members of the object 97 | printInfo(); // This function is used to print a nice little line of info to the serial port 98 | delay(1990); // Delay for the data rate you want - note that measurements take ~10 ms so the fastest data rate is 100 Hz (when no delay is used) 99 | } 100 | 101 | 102 | 103 | /////////////////////// 104 | // Utility Functions // 105 | /////////////////////// 106 | void printInfo() 107 | { 108 | if(mySHTC3.lastStatus == SHTC3_Status_Nominal) // You can also assess the status of the last command by checking the ".lastStatus" member of the object 109 | { 110 | Serial.print("RH = "); 111 | Serial.print(mySHTC3.toPercent()); // "toPercent" returns the percent humidity as a floating point number 112 | Serial.print("% (checksum: "); 113 | if(mySHTC3.passRHcrc) // Like "passIDcrc" this is true when the RH value is valid from the sensor (but not necessarily up-to-date in terms of time) 114 | { 115 | Serial.print("pass"); 116 | } 117 | else 118 | { 119 | Serial.print("fail"); 120 | } 121 | Serial.print("), T = "); 122 | Serial.print(mySHTC3.toDegF()); // "toDegF" and "toDegC" return the temperature as a flaoting point number in deg F and deg C respectively 123 | Serial.print(" deg F (checksum: "); 124 | if(mySHTC3.passTcrc) // Like "passIDcrc" this is true when the T value is valid from the sensor (but not necessarily up-to-date in terms of time) 125 | { 126 | Serial.print("pass"); 127 | } 128 | else 129 | { 130 | Serial.print("fail"); 131 | } 132 | Serial.println(")"); 133 | } 134 | else 135 | { 136 | Serial.print("Update failed, error: "); 137 | errorDecoder(mySHTC3.lastStatus); 138 | Serial.println(); 139 | } 140 | } 141 | 142 | void errorDecoder(SHTC3_Status_TypeDef message) // The errorDecoder function prints "SHTC3_Status_TypeDef" resultsin a human-friendly way 143 | { 144 | switch(message) 145 | { 146 | case SHTC3_Status_Nominal : Serial.print("Nominal"); break; 147 | case SHTC3_Status_Error : Serial.print("Error"); break; 148 | case SHTC3_Status_CRC_Fail : Serial.print("CRC Fail"); break; 149 | default : Serial.print("Unknown return code"); break; 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Syntax Coloring Map 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | 9 | SHTC3 KEYWORD1 10 | 11 | ####################################### 12 | # Methods and Functions (KEYWORD2) 13 | ####################################### 14 | 15 | SHTC3 KEYWORD2 16 | toDegC KEYWORD2 17 | toDegF KEYWORD2 18 | toPercent KEYWORD2 19 | begin KEYWORD2 20 | softReset KEYWORD2 21 | checkID KEYWORD2 22 | sleep KEYWORD2 23 | wake KEYWORD2 24 | setMode KEYWORD2 25 | getMode KEYWORD2 26 | update KEYWORD2 27 | checkCRC KEYWORD2 28 | 29 | ####################################### 30 | # Constants (LITERAL1) 31 | ####################################### 32 | 33 | SHTC3_ADDR_7BIT LITERAL1 34 | SHTC3_ADDR_WRITE LITERAL1 35 | SHTC3_ADDR_READ LITERAL1 36 | SHTC3_MAX_CLOCK_FREQ LITERAL1 37 | SHTC3_CMD_WAKE LITERAL1 38 | SHTC3_CMD_SLEEP LITERAL1 39 | SHTC3_CMD_SFT_RST LITERAL1 40 | SHTC3_CMD_READ_ID LITERAL1 41 | SHTC3_CMD_CSE_RHF_NPM LITERAL1 42 | SHTC3_CMD_CSE_RHF_LPM LITERAL1 43 | SHTC3_CMD_CSE_TF_NPM LITERAL1 44 | SHTC3_CMD_CSE_TF_LPM LITERAL1 45 | SHTC3_CMD_CSD_RHF_NPM LITERAL1 46 | SHTC3_CMD_CSD_RHF_LPM LITERAL1 47 | SHTC3_CMD_CSD_TF_NPM LITERAL1 48 | SHTC3_CMD_CSD_TF_LPM LITERAL1 49 | SHTC3_Status_Nominal LITERAL1 50 | SHTC3_Status_Error LITERAL1 51 | SHTC3_Status_CRC_Fail LITERAL1 52 | SHTC3_Status_ID_Fail LITERAL1 -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=SparkFun SHTC3 Humidity and Temperature Sensor Library 2 | version=1.1.4 3 | author=SparkFun Electronics 4 | maintainer=SparkFun Electronics 5 | sentence=Library for the SHTC3 humidity and temperature sensor by Sensirion 6 | paragraph=Library for the SHTC3 humidity and temperature sensor by Sensirion. Read values raw or converted to floating point numbers with units. Enable/disable sleep mode while not being used 7 | category=Sensors 8 | url=https://github.com/sparkfun/SparkFun_SHTC3_Arduino_Library 9 | architectures=* 10 | -------------------------------------------------------------------------------- /src/SparkFun_SHTC3.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | An Arduino library for the Sensirion SHTC3 humidity and temerature sensor 4 | 5 | */ 6 | 7 | #include "SparkFun_SHTC3.h" 8 | 9 | SHTC3_Status_TypeDef SHTC3::sendCommand(SHTC3_Commands_TypeDef cmd) 10 | { 11 | uint8_t res = 0; 12 | 13 | _wire->beginTransmission(SHTC3_ADDR_7BIT); 14 | _wire->write((((uint16_t)cmd) >> 8)); 15 | _wire->write((((uint16_t)cmd) & 0x00FF)); 16 | res = _wire->endTransmission(); 17 | 18 | if (res) 19 | { 20 | return SHTC3_Status_Error; 21 | } 22 | 23 | return SHTC3_Status_Nominal; 24 | } 25 | 26 | SHTC3_Status_TypeDef SHTC3::sendCommand(SHTC3_MeasurementModes_TypeDef cmd) 27 | { 28 | return sendCommand((SHTC3_Commands_TypeDef)cmd); 29 | } 30 | 31 | SHTC3_Status_TypeDef SHTC3::abortUpdate(SHTC3_Status_TypeDef status, const char *file, uint16_t line) // Sets the values to a known error state 32 | { 33 | passRHcrc = false; 34 | passTcrc = false; 35 | passIDcrc = false; 36 | 37 | RH = 0x00; 38 | T = 0x00; 39 | ID = 0x00; 40 | 41 | return exitOp(status, file, line); 42 | } 43 | 44 | SHTC3_Status_TypeDef SHTC3::exitOp(SHTC3_Status_TypeDef status, const char *file, uint16_t line) 45 | { 46 | lastStatus = status; 47 | SHTC3_exitOp_Callback(status, _inProcess, file, line); 48 | return status; 49 | } 50 | 51 | SHTC3_Status_TypeDef SHTC3::startProcess(void) 52 | { 53 | SHTC3_Status_TypeDef retval = SHTC3_Status_Nominal; 54 | _inProcess = true; 55 | if (_isAsleep) 56 | { 57 | retval = wake(); 58 | } 59 | if (retval == SHTC3_Status_Nominal) 60 | { 61 | _isAsleep = false; 62 | } 63 | return exitOp(retval, __FILE__, __LINE__); 64 | } 65 | 66 | SHTC3_Status_TypeDef SHTC3::endProcess(void) 67 | { 68 | SHTC3_Status_TypeDef retval = SHTC3_Status_Nominal; 69 | _inProcess = false; 70 | if (_staySleeping) 71 | { 72 | retval = sleep(); 73 | } 74 | if (retval == SHTC3_Status_Nominal) 75 | { 76 | _isAsleep = true; 77 | } 78 | return exitOp(retval, __FILE__, __LINE__); 79 | } 80 | 81 | SHTC3::SHTC3() 82 | { 83 | _mode = SHTC3_CMD_CSE_RHF_NPM; // My default pick 84 | 85 | _inProcess = false; // Definitely not doing anything when the object is intantiated 86 | _staySleeping = true; // Default to storing the sensor in low-power mode 87 | _isAsleep = true; // Assume the sensor is asleep to begin (there won't be any harm in waking it up if it is already awake) 88 | 89 | passRHcrc = false; 90 | passTcrc = false; 91 | passIDcrc = false; 92 | 93 | RH = 0x00; 94 | T = 0x00; 95 | ID = 0x00; 96 | } 97 | 98 | float SHTC3::toDegC() 99 | { 100 | return SHTC3_raw2DegC(T); 101 | } 102 | 103 | float SHTC3::toDegF() 104 | { 105 | return SHTC3_raw2DegF(T); 106 | } 107 | 108 | float SHTC3::toPercent() 109 | { 110 | return SHTC3_raw2Percent(RH); 111 | } 112 | 113 | SHTC3_Status_TypeDef SHTC3::begin(TwoWire &wirePort) 114 | { 115 | SHTC3_Status_TypeDef retval = SHTC3_Status_Nominal; 116 | ; 117 | 118 | _wire = &wirePort; // Associate the I2C port 119 | // _clkFreq = speed; // Associate the desired speed 120 | 121 | // if(_clkFreq > SHTC3_MAX_CLOCK_FREQ) // Throttle the clock speen 122 | // { 123 | // _clkFreq = SHTC3_MAX_CLOCK_FREQ; 124 | // } 125 | 126 | retval = startProcess(); // Multiple commands will go to the sensor before sleeping 127 | if (retval != SHTC3_Status_Nominal) 128 | { 129 | return exitOp(retval, __FILE__, __LINE__); 130 | } 131 | 132 | retval = wake(); // Wake up the sensor 133 | if (retval != SHTC3_Status_Nominal) 134 | { 135 | return exitOp(retval, __FILE__, __LINE__); 136 | } 137 | 138 | retval = checkID(); // Verify that the sensor is actually an SHTC3 139 | if (retval != SHTC3_Status_Nominal) 140 | { 141 | return exitOp(retval, __FILE__, __LINE__); 142 | } 143 | 144 | retval = endProcess(); // We are about to return to user-land 145 | if (retval != SHTC3_Status_Nominal) 146 | { 147 | return exitOp(retval, __FILE__, __LINE__); 148 | } 149 | 150 | return exitOp(retval, __FILE__, __LINE__); 151 | } 152 | 153 | SHTC3_Status_TypeDef SHTC3::softReset() 154 | { 155 | return exitOp(sendCommand(SHTC3_CMD_SFT_RST), __FILE__, __LINE__); 156 | delayMicroseconds(500); 157 | } 158 | 159 | SHTC3_Status_TypeDef SHTC3::checkID() 160 | { 161 | 162 | SHTC3_Status_TypeDef retval = SHTC3_Status_Nominal; 163 | const uint8_t numBytesRequest = 3; 164 | uint8_t numBytesRx = 0x00; 165 | 166 | retval = startProcess(); // There will be several commands sent before returning control to the user 167 | if (retval != SHTC3_Status_Nominal) 168 | { 169 | return abortUpdate(retval, __FILE__, __LINE__); 170 | } 171 | 172 | retval = wake(); 173 | if (retval != SHTC3_Status_Nominal) 174 | { 175 | return exitOp(retval, __FILE__, __LINE__); 176 | } 177 | 178 | retval = sendCommand(SHTC3_CMD_READ_ID); 179 | if (retval != SHTC3_Status_Nominal) 180 | { 181 | return exitOp(retval, __FILE__, __LINE__); 182 | } 183 | 184 | numBytesRx = _wire->requestFrom((uint8_t)SHTC3_ADDR_7BIT, numBytesRequest); 185 | if (numBytesRx != numBytesRequest) 186 | { 187 | exitOp(SHTC3_Status_Error, __FILE__, __LINE__); 188 | return SHTC3_Status_Error; 189 | } 190 | 191 | uint8_t IDhb = _wire->read(); 192 | uint8_t IDlb = _wire->read(); 193 | uint8_t IDcs = _wire->read(); 194 | 195 | ID = (((uint16_t)IDhb << 8) | ((uint16_t)IDlb)); 196 | 197 | passIDcrc = false; 198 | 199 | if (checkCRC(ID, IDcs) == SHTC3_Status_Nominal) 200 | { 201 | passIDcrc = true; 202 | } 203 | 204 | if ((ID & 0b0000100000111111) != 0b0000100000000111) // Checking the form of the ID 205 | { // Bits 11 and 5-0 must match 206 | return exitOp(SHTC3_Status_ID_Fail, __FILE__, __LINE__); // to identify an SHTC3 207 | } 208 | 209 | retval = endProcess(); // We are about to return to user-land 210 | if (retval != SHTC3_Status_Nominal) 211 | { 212 | return exitOp(retval, __FILE__, __LINE__); 213 | } 214 | 215 | return exitOp(retval, __FILE__, __LINE__); 216 | } 217 | 218 | SHTC3_Status_TypeDef SHTC3::sleep(bool hold) 219 | { 220 | _isAsleep = true; // It is fail-safe to always assume the sensor is asleep (whether or not the sleep command actually took effect) 221 | if (hold) 222 | { 223 | _staySleeping = true; 224 | } 225 | return exitOp(sendCommand(SHTC3_CMD_SLEEP), __FILE__, __LINE__); 226 | } 227 | 228 | SHTC3_Status_TypeDef SHTC3::wake(bool hold) 229 | { 230 | SHTC3_Status_TypeDef retval = sendCommand(SHTC3_CMD_WAKE); 231 | if (retval == SHTC3_Status_Nominal) 232 | { 233 | _isAsleep = false; // Only when the wake command was sent successfully can you assume the sensor is awake 234 | } 235 | if (hold) 236 | { 237 | 238 | _staySleeping = false; 239 | } 240 | delayMicroseconds(240); 241 | return exitOp(retval, __FILE__, __LINE__); 242 | } 243 | 244 | SHTC3_Status_TypeDef SHTC3::setMode(SHTC3_MeasurementModes_TypeDef mode) 245 | { 246 | SHTC3_Status_TypeDef retval = SHTC3_Status_Nominal; 247 | switch (mode) // Switch used to disallow unknown types 248 | { 249 | case SHTC3_CMD_CSE_RHF_NPM: 250 | _mode = SHTC3_CMD_CSE_RHF_NPM; 251 | break; 252 | case SHTC3_CMD_CSE_RHF_LPM: 253 | _mode = SHTC3_CMD_CSE_RHF_LPM; 254 | break; 255 | case SHTC3_CMD_CSE_TF_NPM: 256 | _mode = SHTC3_CMD_CSE_TF_NPM; 257 | break; 258 | case SHTC3_CMD_CSE_TF_LPM: 259 | _mode = SHTC3_CMD_CSE_TF_LPM; 260 | break; 261 | 262 | // case SHTC3_CMD_CSD_RHF_NPM : _mode = SHTC3_CMD_CSD_RHF_NPM; break; // Currently clock stretching must be used because of the Arduino API's 263 | // case SHTC3_CMD_CSD_RHF_LPM : _mode = SHTC3_CMD_CSD_RHF_LPM; break; 264 | // case SHTC3_CMD_CSD_TF_NPM : _mode = SHTC3_CMD_CSD_TF_NPM; break; 265 | // case SHTC3_CMD_CSD_TF_LPM : _mode = SHTC3_CMD_CSD_TF_LPM; break; 266 | default: 267 | retval = SHTC3_Status_Error; 268 | break; 269 | } 270 | return exitOp(retval, __FILE__, __LINE__); 271 | } 272 | 273 | SHTC3_MeasurementModes_TypeDef SHTC3::getMode(void) 274 | { 275 | return _mode; 276 | } 277 | 278 | SHTC3_Status_TypeDef SHTC3::update() 279 | { 280 | SHTC3_Status_TypeDef retval = SHTC3_Status_Nominal; 281 | 282 | const uint8_t numBytesRequest = 6; 283 | uint8_t numBytesRx = 0; 284 | 285 | uint8_t RHhb = 0x00; 286 | uint8_t RHlb = 0x00; 287 | uint8_t RHcs = 0x00; 288 | 289 | uint8_t Thb = 0x00; 290 | uint8_t Tlb = 0x00; 291 | uint8_t Tcs = 0x00; 292 | 293 | retval = startProcess(); 294 | if (retval != SHTC3_Status_Nominal) 295 | { 296 | return abortUpdate(retval, __FILE__, __LINE__); 297 | } 298 | 299 | // retval = wake(); // Always send wake() to be sure the sensor will respond 300 | // if(retval != SHTC3_Status_Nominal){ return abortUpdate(retval, __FILE__, __LINE__); } 301 | 302 | retval = sendCommand(_mode); // Send the appropriate command - Note: incorrect commands are excluded by the 'setMode' command and _mode is a protected variable 303 | if (retval != SHTC3_Status_Nominal) 304 | { 305 | return abortUpdate(retval, __FILE__, __LINE__); 306 | } 307 | 308 | switch (_mode) // Handle the two different ways of waiting for a measurement (polling or clock stretching) 309 | { 310 | case SHTC3_CMD_CSE_RHF_NPM: 311 | case SHTC3_CMD_CSE_RHF_LPM: 312 | case SHTC3_CMD_CSE_TF_NPM: 313 | case SHTC3_CMD_CSE_TF_LPM: // Address+read will yield an ACK and then clock stretching will occur 314 | numBytesRx = _wire->requestFrom((uint8_t)SHTC3_ADDR_7BIT, numBytesRequest); 315 | break; 316 | 317 | case SHTC3_CMD_CSD_RHF_NPM: 318 | case SHTC3_CMD_CSD_RHF_LPM: 319 | case SHTC3_CMD_CSD_TF_NPM: 320 | case SHTC3_CMD_CSD_TF_LPM: // These modes not yet supported (polling - need to figure out how to repeatedly send just address+read and look for ACK) 321 | default: 322 | return abortUpdate(SHTC3_Status_Error, __FILE__, __LINE__); // You really should never get to this code because setMode disallows non-approved values of _mode (type SHTC3_MeasurementModes_TypeDef) 323 | break; 324 | } 325 | 326 | // Now handle the received data 327 | if (numBytesRx != numBytesRequest) 328 | { 329 | return abortUpdate(SHTC3_Status_Error, __FILE__, __LINE__); 330 | } // Hopefully we got the right number of bytes 331 | 332 | switch (_mode) // Switch for the order of the returned results 333 | { 334 | case SHTC3_CMD_CSE_RHF_NPM: 335 | case SHTC3_CMD_CSE_RHF_LPM: 336 | case SHTC3_CMD_CSD_RHF_NPM: 337 | case SHTC3_CMD_CSD_RHF_LPM: 338 | // RH First 339 | RHhb = _wire->read(); 340 | RHlb = _wire->read(); 341 | RHcs = _wire->read(); 342 | 343 | Thb = _wire->read(); 344 | Tlb = _wire->read(); 345 | Tcs = _wire->read(); 346 | break; 347 | 348 | case SHTC3_CMD_CSE_TF_NPM: 349 | case SHTC3_CMD_CSE_TF_LPM: 350 | case SHTC3_CMD_CSD_TF_NPM: 351 | case SHTC3_CMD_CSD_TF_LPM: 352 | // T First 353 | Thb = _wire->read(); 354 | Tlb = _wire->read(); 355 | Tcs = _wire->read(); 356 | 357 | RHhb = _wire->read(); 358 | RHlb = _wire->read(); 359 | RHcs = _wire->read(); 360 | break; 361 | 362 | default: 363 | return abortUpdate(SHTC3_Status_Error, __FILE__, __LINE__); // Again, you should never experience this section of code 364 | break; 365 | } 366 | 367 | // Update values 368 | RH = ((uint16_t)RHhb << 8) | ((uint16_t)RHlb << 0); 369 | T = ((uint16_t)Thb << 8) | ((uint16_t)Tlb << 0); 370 | 371 | passRHcrc = false; 372 | passTcrc = false; 373 | 374 | if (checkCRC(RH, RHcs) == SHTC3_Status_Nominal) 375 | { 376 | passRHcrc = true; 377 | } 378 | if (checkCRC(T, Tcs) == SHTC3_Status_Nominal) 379 | { 380 | passTcrc = true; 381 | } 382 | 383 | // retval = sleep(); 384 | // if(retval != SHTC3_Status_Nominal){ return exitOp(retval, __FILE__, __LINE__); } 385 | 386 | retval = endProcess(); // We are about to return to user-land 387 | if (retval != SHTC3_Status_Nominal) 388 | { 389 | return exitOp(retval, __FILE__, __LINE__); 390 | } 391 | 392 | return exitOp(retval, __FILE__, __LINE__); 393 | } 394 | 395 | SHTC3_Status_TypeDef SHTC3::checkCRC(uint16_t packet, uint8_t cs) 396 | { 397 | uint8_t upper = packet >> 8; 398 | uint8_t lower = packet & 0x00FF; 399 | uint8_t data[2] = {upper, lower}; 400 | uint8_t crc = 0xFF; 401 | uint8_t poly = 0x31; 402 | 403 | for (uint8_t indi = 0; indi < 2; indi++) 404 | { 405 | crc ^= data[indi]; 406 | 407 | for (uint8_t indj = 0; indj < 8; indj++) 408 | { 409 | if (crc & 0x80) 410 | { 411 | crc = (uint8_t)((crc << 1) ^ poly); 412 | } 413 | else 414 | { 415 | crc <<= 1; 416 | } 417 | } 418 | } 419 | 420 | if (cs ^ crc) 421 | { 422 | return exitOp(SHTC3_Status_CRC_Fail, __FILE__, __LINE__); 423 | } 424 | return exitOp(SHTC3_Status_Nominal, __FILE__, __LINE__); 425 | } 426 | 427 | float SHTC3_raw2DegC(uint16_t T) 428 | { 429 | return -45 + 175 * ((float)T / 65535); 430 | } 431 | 432 | float SHTC3_raw2DegF(uint16_t T) 433 | { 434 | return SHTC3_raw2DegC(T) * (9.0 / 5) + 32.0; 435 | } 436 | 437 | float SHTC3_raw2Percent(uint16_t RH) 438 | { 439 | return 100 * ((float)RH / 65535); 440 | } 441 | 442 | void SHTC3_exitOp_Callback(SHTC3_Status_TypeDef status, bool inProcess, const char *file, uint16_t line) {} // Empty implementation. You can make your own implementation 443 | -------------------------------------------------------------------------------- /src/SparkFun_SHTC3.h: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | An Arduino library for the Sensirion SHTC3 humidity and temerature sensor 4 | 5 | */ 6 | 7 | #ifndef SF_SHTC3 8 | #define SF_SHTC3 9 | 10 | #include 11 | #include 12 | 13 | #define SHTC3_ADDR_7BIT 0b1110000 14 | #define SHTC3_ADDR_WRITE 0b11100000 15 | #define SHTC3_ADDR_READ 0b11100001 16 | 17 | #define SHTC3_MAX_CLOCK_FREQ 1000000 18 | 19 | typedef enum 20 | { 21 | SHTC3_CMD_WAKE = 0x3517, 22 | SHTC3_CMD_SLEEP = 0xB098, 23 | 24 | SHTC3_CMD_SFT_RST = 0x805D, 25 | 26 | SHTC3_CMD_READ_ID = 0xEFC8, 27 | } SHTC3_Commands_TypeDef; 28 | 29 | typedef enum 30 | { 31 | SHTC3_CMD_CSE_RHF_NPM = 0x5C24, // Clock stretching, RH first, Normal power mode 32 | SHTC3_CMD_CSE_RHF_LPM = 0x44DE, // Clock stretching, RH first, Low power mode 33 | SHTC3_CMD_CSE_TF_NPM = 0x7CA2, // Clock stretching, T first, Normal power mode 34 | SHTC3_CMD_CSE_TF_LPM = 0x6458, // Clock stretching, T first, Low power mode 35 | 36 | SHTC3_CMD_CSD_RHF_NPM = 0x58E0, // Polling, RH first, Normal power mode 37 | SHTC3_CMD_CSD_RHF_LPM = 0x401A, // Polling, RH first, Low power mode 38 | SHTC3_CMD_CSD_TF_NPM = 0x7866, // Polling, T first, Normal power mode 39 | SHTC3_CMD_CSD_TF_LPM = 0x609C // Polling, T first, Low power mode 40 | } SHTC3_MeasurementModes_TypeDef; 41 | 42 | typedef enum 43 | { 44 | SHTC3_Status_Nominal = 0, // The one and only "all is good" return value 45 | SHTC3_Status_Error, // The most general of error values - can mean anything depending on the context 46 | SHTC3_Status_CRC_Fail, // This return value means the computed checksum did not match the provided value 47 | SHTC3_Status_ID_Fail // This status means that the ID of the device did not match the format for SHTC3 48 | } SHTC3_Status_TypeDef; 49 | 50 | class SHTC3 51 | { 52 | private: 53 | protected: 54 | TwoWire *_wire; 55 | 56 | SHTC3_MeasurementModes_TypeDef _mode; 57 | 58 | bool _inProcess; // True when a macro-scale function is in progress in the library - blocks small functions from messing with sleep functions 59 | bool _staySleeping; // Used to indicate if the sensor should be kept in sleep mode 60 | bool _isAsleep; // Used to indicate if a wake() command is needed before talking 61 | 62 | SHTC3_Status_TypeDef sendCommand(SHTC3_Commands_TypeDef cmd); 63 | SHTC3_Status_TypeDef sendCommand(SHTC3_MeasurementModes_TypeDef cmd); // Overloaded version of send command to support the "measurement type" commands 64 | SHTC3_Status_TypeDef abortUpdate(SHTC3_Status_TypeDef status, const char *file, uint16_t line); // Used to bail from an update. Sets reading values to known fail state 65 | SHTC3_Status_TypeDef exitOp(SHTC3_Status_TypeDef status, const char *file, uint16_t line); // Used to bail from any other operation - puts the sensor back to sleep 66 | 67 | SHTC3_Status_TypeDef startProcess(void); // Used to wake up the sensor and set the _inProcess variable to true 68 | SHTC3_Status_TypeDef endProcess(void); // Used to end processes as the user desires 69 | 70 | public: 71 | SHTC3(); // Constructor 72 | 73 | SHTC3_Status_TypeDef lastStatus; // Stores the most recent status result for access by the user 74 | 75 | bool passRHcrc; // Indicates if the current value of RH has passed the CRC check 76 | bool passTcrc; // Indicates if the current value of T has passed the CRC check 77 | bool passIDcrc; // Indicates if the current value of ID has passed the CRC check 78 | 79 | uint16_t RH; // Current raw RH data from the sensor 80 | uint16_t T; // Current raw T data from the sensor 81 | uint16_t ID; // Current raw ID data from the sensor 82 | 83 | float toDegC(); // Returns the floating point value of T in deg C 84 | float toDegF(); // Returns the floating point value of T in deg F 85 | float toPercent(); // Returns the floating point value of RH in % RH 86 | 87 | SHTC3_Status_TypeDef begin(TwoWire &wirePort = Wire); // Initializes the sensor 88 | SHTC3_Status_TypeDef softReset(); // Resets the sensor into a known state through software 89 | SHTC3_Status_TypeDef checkID(); // Asks the sensor for the ID and checks that value against a CRC checksum 90 | SHTC3_Status_TypeDef sleep(bool hold = false); // Wakes up the sensor. If hold is true then sets _staySleeping to false 91 | SHTC3_Status_TypeDef wake(bool hold = false); // Sleeps the sensor. If hold is true then sets _staySleeping to true 92 | SHTC3_Status_TypeDef setMode(SHTC3_MeasurementModes_TypeDef mode = SHTC3_CMD_CSD_RHF_NPM); // Sets the desired measurement mode from the options in the typedef "SHTC3_MeasurementModes_TypeDef" 93 | SHTC3_MeasurementModes_TypeDef getMode(void); 94 | 95 | SHTC3_Status_TypeDef update(); // Tells the sensor to take a measurement and updates the member variables of the object 96 | 97 | SHTC3_Status_TypeDef checkCRC(uint16_t packet, uint8_t cs); // Checks CRC values 98 | }; 99 | 100 | float SHTC3_raw2DegC(uint16_t T); // Converts SHTC3 T data to deg C 101 | float SHTC3_raw2DegF(uint16_t T); // Converts SHTC3 T data to deg F 102 | float SHTC3_raw2Percent(uint16_t RH); // Converts SHTC3 RH data to % RH 103 | 104 | void SHTC3_exitOp_Callback(SHTC3_Status_TypeDef status, bool inProcess, const char *file, uint16_t line) __attribute__((weak)); // Called whenever exitOp is called, which is on most return statements 105 | 106 | #endif /* SF_SHTC3 */ --------------------------------------------------------------------------------