├── .gitattributes ├── LICENSE ├── README.md ├── examples ├── high_low_temperature_alert │ └── high_low_temperature_alert.ino ├── prompt_interpreter │ └── prompt_interpreter.ino ├── simple_test │ └── simple_test.ino └── temperature_callback │ └── temperature_callback.ino ├── keywords.txt ├── library.properties └── src ├── TMP117.cpp └── TMP117.h /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # TMP117-Arduino 2 | 3 | The TMP117 is a high-accuracy, low-power, digital temperature sensor. It can be used for devices that need to meet the NIST traceability like it is often used in medical devices. 4 | This library exposes it's functionality using the wire library for I2C communication. The library is written in C++ to support the Arduino plattform. 5 | 6 | ## Features 7 | 8 | - Meet ASTM E1112 and ISO 80601 requirements 9 | - Serve as a single chip digital alternative to a Platinum RTD (Class AA RTD) 10 | - 100% tested on a production setup that is NIST traceable 11 | - ±0.1°C (Maximum) From –20°C to +50°C 12 | - ±0.15°C (Maximum) From –40°C to +70°C 13 | - ±0.2°C (Maximum) From –40°C to +100°C 14 | - ±0.25°C (Maximum) From –55°C to +125°C 15 | - ±0.3°C (Maximum) From –55°C to +150°C 16 | - Low Power Consumption 3.5-µA, 1-Hz Conversion Cycle 17 | - Programmable temperature alert limits 18 | 19 | 20 | [For more informations see the datasheet](http://www.ti.com/lit/ds/symlink/tmp117.pdf) 21 | 22 | ## Functionality 23 | 24 | - [x] Read measured temperature 25 | - [X] Read from internal EEPROM 26 | - [x] Make configuration accessible 27 | - [x] Implement allert function (HIGH/LOW temperature allerts) 28 | - [x] Read/write from/to internal EEPROM 29 | - [x] Implement temperature offset and calibration function 30 | - [x] Implement software callbacks if new data/temperature is available 31 | -------------------------------------------------------------------------------- /examples/high_low_temperature_alert/high_low_temperature_alert.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * @file high_low_temperature_alert.ino 3 | * @author Nils Minor 4 | * 5 | * @brief This example shows high/low temperature alert 6 | * - read configuration register using >update< 7 | * - use callback for new temperature 8 | * - use callback/ISR pin to get alert for high and low temperature borders 9 | * 10 | * Connect the sensor via I2C pins to the Arduino. If you want an alert signal, 11 | * you have to connect the alert output of the sensor to an interrupt pin 12 | * of the Arduino. 13 | */ 14 | 15 | // Select the correct address setting 16 | uint8_t ADDR_GND = 0x48; // 1001000 17 | uint8_t ADDR_VCC = 0x49; // 1001001 18 | uint8_t ADDR_SDA = 0x4A; // 1001010 19 | uint8_t ADDR_SCL = 0x4B; // 1001011 20 | uint8_t ADDR = ADDR_GND; 21 | 22 | #include "TMP117.h" 23 | 24 | #define ALERT_PIN 7 // low active alert pin 25 | #define LOW_TEMPERATURE_ALERT 20 // low alert at 20°C 26 | #define HIGH_TEMPERATURE_ALERT 28 // highalert at 28°C 27 | 28 | bool alert_flag = false; 29 | TMP117 tmp(ADDR); 30 | void setup() { 31 | 32 | // Initiate wire library and serial communication 33 | Wire.begin(); 34 | Serial.begin(115200); 35 | 36 | tmp.init ( new_temperature ); // set callback function. will be called if there is new sensor data 37 | tmp.setConvMode (TMP117_CMODE::CONTINUOUS); // contious measurement, also ONESHOT or SHUTWDOWN possible 38 | 39 | 40 | tmp.init ( new_temperature ); 41 | tmp.setConvTime (TMP117_CONVT::C15mS5); // 1. setup C125mS+NOAVE = 15.5 mS measurement time 42 | tmp.setAveraging (TMP117_AVE::NOAVE); 43 | 44 | tmp.setAlertMode(TMP117_PMODE::ALERT); // use THERMAL or ALERT to activate alert feature 45 | tmp.setAllertCallback ( temperature_allert, ALERT_PIN ); 46 | tmp.setAllertTemperature (LOW_TEMPERATURE_ALERT, HIGH_TEMPERATURE_ALERT); 47 | } 48 | 49 | /************************* Infinite Loop Function **********************************/ 50 | void loop() { 51 | 52 | tmp.update(); 53 | 54 | if (alert_flag) { 55 | if (tmp.getAlertType () == TMP117_ALERT::HIGHALERT) { 56 | Serial.print("High Temperature allert : "); 57 | Serial.print (tmp.getTemperature()); 58 | Serial.println (" °C"); 59 | } 60 | else if (tmp.getAlertType () == TMP117_ALERT::LOWALERT) { 61 | Serial.print("Low Temperature allert : "); 62 | Serial.print (tmp.getTemperature()); 63 | Serial.println (" °C"); 64 | } 65 | else { 66 | alert_flag = false; 67 | } 68 | } 69 | } 70 | 71 | // calback for new temperature 72 | void new_temperature ( void ) { 73 | if (!alert_flag) { 74 | Serial.print ("Temperature : "); 75 | Serial.print (tmp.getTemperature()); 76 | Serial.println (" °C"); 77 | } 78 | } 79 | 80 | // callback function when an temperature alert occurs 81 | void temperature_allert (void) { 82 | alert_flag = true; 83 | //Serial.println ("Lsssssssssssss "); 84 | 85 | 86 | } 87 | -------------------------------------------------------------------------------- /examples/prompt_interpreter/prompt_interpreter.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * @file prompt_interpreter.ino 3 | * @author Nils Minor 4 | * 5 | * @brief This example shows how to easy control the sensor using a tiny interpreter 6 | * - read user command and parse parameter 7 | * - read EEPROM NIST UUID 8 | * - read actual temperature 9 | * - show offset/calibration function 10 | * 11 | * Connect the sensor via I2C pins to the Arduino. If you want an alert signal, 12 | * you have to connect the alert output of the sensor to an interrupt pin 13 | * of the Arduino. 14 | * 15 | */ 16 | 17 | // Select the correct address setting 18 | uint8_t ADDR_GND = 0x48; // 1001000 19 | uint8_t ADDR_VCC = 0x49; // 1001001 20 | uint8_t ADDR_SDA = 0x4A; // 1001010 21 | uint8_t ADDR_SCL = 0x4B; // 1001011 22 | uint8_t ADDR = ADDR_GND; 23 | 24 | #include "TMP117.h" 25 | 26 | #define ALERT_PIN 7 // low active alert pin 27 | #define LOW_TEMPERATURE_ALERT 20 // low alert at 20°C 28 | #define HIGH_TEMPERATURE_ALERT 28 // highalert at 28°C 29 | 30 | bool alert_flag = false; 31 | TMP117 tmp(ADDR); 32 | float floatnr = 0; 33 | void setup() { 34 | 35 | // Initiate wire library and serial communication 36 | Wire.begin(); 37 | Serial.begin(115200); 38 | 39 | tmp.init ( NULL ); // no callback 40 | tmp.setConvMode (TMP117_CMODE::CONTINUOUS); // contious measurement, also ONESHOT or SHUTWDOWN possible 41 | 42 | tmp.setConvTime (TMP117_CONVT::C15mS5); // 1. setup C125mS+NOAVE = 15.5 mS measurement time 43 | tmp.setAveraging (TMP117_AVE::NOAVE); 44 | } 45 | 46 | /************************* Infinite Loop Function **********************************/ 47 | void loop() { 48 | 49 | tmp.update(); 50 | 51 | /* command parameter description 52 | * 0 X print actual temperature 53 | * 1 X print EEPROM NIST UUID [E1|E2|E3] 54 | * 2 float set temperature offset like "2 20.5" sets the offset to 20.5°C 55 | * 3 float calibrate sensor to target temperature like "3 30.5" will calibrate sensor to 30.5°C 56 | * 57 | */ 58 | if (Serial.available() > 0) { 59 | int inByte = Serial.read(); 60 | 61 | switch (inByte) { 62 | case '0': 63 | Serial.print ("Temperature : "); 64 | Serial.print (tmp.getTemperature()); 65 | Serial.println (" °C"); 66 | break; 67 | case '1': 68 | Serial.print ("EEPROM : "); 69 | Serial.print (tmp.readEEPROM(1),HEX); 70 | Serial.print (tmp.readEEPROM(2),HEX); 71 | Serial.println (tmp.readEEPROM(3),HEX); 72 | break; 73 | case '2': 74 | floatnr = Serial.parseFloat( ); 75 | tmp.setTargetTemperature ( floatnr ); 76 | Serial.print("Calibrate temperature to : "); 77 | Serial.println( floatnr ); 78 | break; 79 | case '3': 80 | floatnr = Serial.parseFloat( ); 81 | tmp.setOffsetTemperature ( floatnr ); 82 | Serial.println("3"); 83 | break; 84 | case '4': 85 | Serial.println("4"); 86 | break; 87 | case '5': 88 | Serial.println("5"); 89 | break; 90 | case '\r': 91 | break; 92 | case '\n': 93 | break; 94 | default: 95 | Serial.println("Wrong number"); 96 | } 97 | inByte = 0; 98 | } 99 | } 100 | 101 | 102 | 103 | -------------------------------------------------------------------------------- /examples/simple_test/simple_test.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * @file simple_test.ino 3 | * @author Nils Minor 4 | * 5 | * @brief This example shows the basic functionality of the driver 6 | * - setup normal mode 7 | * - poll new data by reading the temperature register 8 | * 9 | * Connect the sensor via I2C pins to the Arduino. If you want an alert signal, 10 | * you have to connect the alert output of the sensor to an interrupt pin 11 | * of the Arduino. 12 | * 13 | */ 14 | #include "TMP117.h" 15 | 16 | // Select the correct address setting 17 | uint8_t ADDR_GND = 0x48; // 1001000 18 | uint8_t ADDR_VCC = 0x49; // 1001001 19 | uint8_t ADDR_SDA = 0x4A; // 1001010 20 | uint8_t ADDR_SCL = 0x4B; // 1001011 21 | uint8_t ADDR = ADDR_GND; 22 | 23 | TMP117 tmp(ADDR); 24 | 25 | /************************* Initialization Setup Function **************************/ 26 | void setup() { 27 | // Initiate wire library and serial communication 28 | Wire.begin(); 29 | Serial.begin(115200); 30 | 31 | /* The default setup is : 32 | * Conversion mode = CONTINUOUS ---> continuous 33 | * Conversion time = C125mS -| 34 | * Averaging mode = AVE8 -|-> new data every 125mS 35 | * Alert mode = data ---> alert pin states that new data is available 36 | * 37 | */ 38 | tmp.init ( NULL ); 39 | } 40 | 41 | /************************* Infinite Loop Function **********************************/ 42 | void loop() { 43 | 44 | Serial.print ("Temperature : "); 45 | Serial.print (tmp.getTemperature()); 46 | Serial.println (" °C"); 47 | delay(100); 48 | } 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /examples/temperature_callback/temperature_callback.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * @file temperature_callback.ino 3 | * @author Nils Minor 4 | * 5 | * @brief This example shows the more advanced usability of the driver 6 | * - setup diffrent sensor modes 7 | * - read configuration register using >update< 8 | * - use callback for new temperature 9 | * 10 | * Connect the sensor via I2C pins to the Arduino. If you want an alert signal, 11 | * you have to connect the alert output of the sensor to an interrupt pin 12 | * of the Arduino. 13 | */ 14 | 15 | /* Conversion Cycle Time in CC Mode 16 | AVG 0 1 2 3 17 | CONV averaging (0) (8) (32) (64) 18 | 0 15.5ms 125ms 500ms 1s C15mS5 19 | 1 125ms 125ms 500ms 1s C125mS 20 | 2 250ms 250ms 500ms 1s C250mS 21 | 3 500ms 500ms 500ms 1s C500mS 22 | 4 1s 1s 1s 1s C1S 23 | 5 4s 4s 4s 4s C4S 24 | 6 8s 8s 8s 8s C8S 25 | 7 16s 16s 16s 16s C16S 26 | */ 27 | 28 | // Select the correct address setting 29 | uint8_t ADDR_GND = 0x48; // 1001000 30 | uint8_t ADDR_VCC = 0x49; // 1001001 31 | uint8_t ADDR_SDA = 0x4A; // 1001010 32 | uint8_t ADDR_SCL = 0x4B; // 1001011 33 | uint8_t ADDR = ADDR_GND; 34 | 35 | #include "TMP117.h" 36 | 37 | TMP117 tmp(ADDR); 38 | void setup() { 39 | 40 | // Initiate wire library and serial communication 41 | Wire.begin(); 42 | Serial.begin(115200); 43 | pinMode (LED_BUILTIN, OUTPUT); 44 | 45 | tmp.init ( new_temperature ); // set callback function. will be called if there is new sensor data 46 | tmp.setConvMode (TMP117_CMODE::CONTINUOUS); // contious measurement, also ONESHOT or SHUTWDOWN possible 47 | 48 | uint8_t setup_nr = 3; // select an example setup to see diffrent modes 49 | switch (setup_nr) { 50 | case 1: tmp.setConvTime (TMP117_CONVT::C15mS5); // 1. setup C125mS+NOAVE = 15.5 mS measurement time 51 | tmp.setAveraging (TMP117_AVE::NOAVE); 52 | break; 53 | case 2: tmp.setConvTime (TMP117_CONVT::C125mS); // 2. setup C125mS+AVE8 = 125 mS measurement time 54 | tmp.setAveraging (TMP117_AVE::AVE8); 55 | break; 56 | case 3: tmp.setConvTime (TMP117_CONVT::C125mS); // 3. setup C500mS+AVE32 = 500 mS measurement time 57 | tmp.setAveraging (TMP117_AVE::AVE32); 58 | break; 59 | case 4: tmp.setConvTime (TMP117_CONVT::C4S); // 4. setup C1S+AVE64 = 1000 mS measurement time 60 | tmp.setAveraging (TMP117_AVE::AVE64); 61 | break; 62 | default: setup_nr = 1; 63 | } 64 | } 65 | 66 | /************************* Infinite Loop Function **********************************/ 67 | void loop() { 68 | 69 | tmp.update(); // used to update the sensor/read out configuration register 70 | } 71 | 72 | void new_temperature ( void ) { 73 | digitalWrite (LED_BUILTIN, !digitalRead(LED_BUILTIN)); 74 | Serial.print ("Temperature : "); 75 | Serial.print (tmp.getTemperature()); 76 | Serial.println (" °C"); 77 | } 78 | 79 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Syntax Coloring Map 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | 9 | TMP117 KEYWORD1 10 | 11 | ####################################### 12 | # Methods and Functions (KEYWORD2) 13 | ####################################### 14 | TMP117 KEYWORD2 15 | init KEYWORD2 16 | update KEYWORD2 17 | softReset KEYWORD2 18 | setAlertMode KEYWORD2 19 | setAllertCallback KEYWORD2 20 | setAllertTemperature KEYWORD2 21 | setConvMode KEYWORD2 22 | setConvTime KEYWORD2 23 | setAveraging KEYWORD2 24 | setOffsetTemperature KEYWORD2 25 | setTargetTemperature KEYWORD2 26 | getTemperature KEYWORD2 27 | getDeviceID KEYWORD2 28 | getDeviceRev KEYWORD2 29 | getOffsetTemperature KEYWORD2 30 | getAlertType KEYWORD2 31 | writeEEPROM KEYWORD2 32 | readEEPROM KEYWORD2 33 | readConfig KEYWORD2 34 | 35 | ###################################### 36 | # Constants (LITERAL1) 37 | ####################################### 38 | THERMAL LITERAL1 39 | ALERT LITERAL1 40 | DATA LITERAL1 41 | CONTINUOUS LITERAL1 42 | SHUTDOWN LITERAL1 43 | ONESHOT LITERAL1 44 | C15mS5 LITERAL1 45 | C125mS LITERAL1 46 | C250mS LITERAL1 47 | C500mS LITERAL1 48 | C1S LITERAL1 49 | C4S LITERAL1 50 | C8S LITERAL1 51 | C16S LITERAL1 52 | NOAVE LITERAL1 53 | AVE8 LITERAL1 54 | AVE32 LITERAL1 55 | AVE64 LITERAL1 56 | NOALERT LITERAL1 57 | HIGHALERT LITERAL1 58 | LOWALERT LITERAL1 59 | 60 | 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=TMP117-Arduino 2 | version=1.0.3 3 | author=Nils Minor 4 | maintainer=Nils Minor 5 | sentence=Full-featured Arduino compatible TMP117 driver 6 | paragraph=The TMP117 is a high-precision digital temperature sensor which replaces Platinum RTDs, is NIST traceable and communicates via I2C to Arduino boards 7 | category=Sensors 8 | url=https://github.com/NilsMinor/TMP117-Arduino 9 | architectures=* 10 | -------------------------------------------------------------------------------- /src/TMP117.cpp: -------------------------------------------------------------------------------- 1 | /*! 2 | * @file TMP117.cpp 3 | * @author Nils Minor 4 | * 5 | * @license GNU GENERAL PUBLIC LICENSE (see license.txt) 6 | * 7 | * v1.0.0 - Initial library version 8 | * 9 | * 10 | */ 11 | 12 | #include "TMP117.h" 13 | 14 | /*! 15 | @brief Constructor 16 | @param addr device I2C address [0x48 - 0x4B] 17 | */ 18 | TMP117::TMP117 (uint8_t addr) { 19 | Wire.begin(); 20 | 21 | address = addr; 22 | alert_pin = -1; 23 | alert_type = TMP117_ALERT::NOALERT; 24 | newDataCallback = NULL; 25 | } 26 | 27 | /*! 28 | @brief Initialize in default mode 29 | @param _newDataCallback callback function will be called when new data is available 30 | */ 31 | void TMP117::init ( void (*_newDataCallback) (void) ) { 32 | setConvMode (TMP117_CMODE::CONTINUOUS); 33 | setConvTime (TMP117_CONVT::C125mS); 34 | setAveraging (TMP117_AVE::AVE8); 35 | setAlertMode (TMP117_PMODE::DATA); 36 | setOffsetTemperature(0); 37 | 38 | newDataCallback = _newDataCallback; 39 | } 40 | 41 | /*! 42 | @brief Read configuration register and handle events. 43 | Should be called in loop in order to call callback functions 44 | */ 45 | void TMP117::update (void) { 46 | readConfig (); 47 | } 48 | 49 | /*! 50 | @brief Performs a soft reset. All default values will be loaded to the configuration register 51 | */ 52 | void TMP117::softReset ( void ) { 53 | uint16_t reg_value = 0; 54 | reg_value |= 1UL << 1; 55 | writeConfig ( reg_value ); 56 | } 57 | 58 | /*! 59 | @brief Set alert pin mode 60 | 61 | @param mode TMP117_PMODE [Thermal-Alert-Data] 62 | */ 63 | void TMP117::setAlertMode ( TMP117_PMODE mode) { 64 | uint16_t reg_value = readConfig (); 65 | if (mode == TMP117_PMODE::THERMAL) { 66 | reg_value |= 1UL << 4; // change to thermal mode 67 | reg_value &= ~(1UL << 2); // set pin as alert flag 68 | reg_value &= ~(1UL << 3); // alert pin low active 69 | } 70 | else if (mode == TMP117_PMODE::ALERT) { 71 | reg_value &= ~(1UL << 4); // change to alert mode 72 | reg_value &= ~(1UL << 2); // set pin as alert flag 73 | reg_value &= ~(1UL << 3); // alert pin low active 74 | } 75 | else if (mode ==TMP117_PMODE:: DATA) { 76 | reg_value |= 1UL << 2; // set pin as data ready flag 77 | } 78 | writeConfig ( reg_value ); 79 | } 80 | 81 | /*! 82 | @brief Set alert callback function and ISR pin 83 | @param *allert_callback callback function 84 | @param pin callback pin (INT?) 85 | */ 86 | void TMP117::setAllertCallback (void (*allert_callback)(void), uint8_t pin) { 87 | alert_pin = pin; 88 | pinMode(pin, INPUT_PULLUP); 89 | 90 | attachInterrupt(digitalPinToInterrupt(pin), allert_callback, FALLING ); // Sets up pin 2 to trigger "alert" ISR when pin changes H->L and L->H 91 | } 92 | 93 | /*! 94 | @brief Set alert temperature 95 | 96 | @param lowtemp low boundary alert temperature 97 | @param hightemp high boundary alert temperature 98 | */ 99 | void TMP117::setAllertTemperature (double lowtemp, double hightemp) { 100 | 101 | uint16_t high_temp_value = hightemp / TMP117_RESOLUTION; 102 | uint16_t low_temp_value = lowtemp / TMP117_RESOLUTION; 103 | 104 | i2cWrite2B (TMP117_REG_TEMP_HIGH_LIMIT , high_temp_value); 105 | i2cWrite2B (TMP117_REG_TEMP_LOW_LIMIT , low_temp_value); 106 | } 107 | 108 | /*! 109 | @brief Set conversion mode 110 | 111 | @param cmode ::TMP117_CMODE [CONTINUOUS-SHUTDOWN-ONESHOT] 112 | */ 113 | void TMP117::setConvMode ( TMP117_CMODE cmode) { 114 | uint16_t reg_value = readConfig (); 115 | reg_value &= ~((1UL << 11) | (1UL << 10)); // clear bits 116 | reg_value = reg_value | ( static_cast(cmode) & 0x03 ) << 10; // set bits 117 | writeConfig ( reg_value ); 118 | } 119 | 120 | /*! 121 | @brief Set conversion time 122 | 123 | @param convtime ::TMP117_CONVT [C15mS5-C125mS-C250mS-C500mS-C1S-C4S-C8S-C16S] 124 | */ 125 | void TMP117::setConvTime ( TMP117_CONVT convtime ) { 126 | uint16_t reg_value = readConfig (); 127 | reg_value &= ~((1UL << 9) | (1UL << 8) | (1UL << 7)); // clear bits 128 | reg_value = reg_value | ( static_cast(convtime) & 0x07 ) << 7; // set bits 129 | writeConfig ( reg_value ); 130 | } 131 | /*! 132 | @brief Set averaging mode 133 | 134 | @param ave ::TMP117_AVE [NOAVE-AVE8-AVE32-AVE64] 135 | */ 136 | void TMP117::setAveraging ( TMP117_AVE ave ) { 137 | uint16_t reg_value = readConfig (); 138 | reg_value &= ~((1UL << 6) | (1UL << 5) ); // clear bits 139 | reg_value = reg_value | ( static_cast(ave) & 0x03 ) << 5; // set bits 140 | writeConfig ( reg_value ); 141 | } 142 | 143 | /*! 144 | @brief Set offset temperature 145 | 146 | @param double target offset temperature in the range of ±256°C 147 | */ 148 | void TMP117::setOffsetTemperature ( double offset ) { 149 | int16_t offset_temp_value = offset / TMP117_RESOLUTION; 150 | i2cWrite2B (TMP117_REG_TEMPERATURE_OFFSET , offset_temp_value); 151 | } 152 | 153 | /*! 154 | @brief Set target temperature for calibration purpose 155 | 156 | @param double target temperature to calibrate to in the range of ±256°C 157 | */ 158 | void TMP117::setTargetTemperature ( double target ) { 159 | double actual_temp = getTemperature ( ); 160 | double delta_temp = target - actual_temp; 161 | setOffsetTemperature ( delta_temp ); 162 | } 163 | 164 | /*! 165 | @brief Read configuration register and handle events. 166 | 167 | @return uint16_t read value of the configuration regsiter 168 | */ 169 | uint16_t TMP117::readConfig (void) { 170 | uint16_t reg_value = i2cRead2B ( TMP117_REG_CONFIGURATION ); 171 | bool data_ready = reg_value >> 13 & 1UL; 172 | 173 | // following bits are a comment in order to not create compiler warnings 174 | // but might be used in the future for some purpose 175 | // bool eeprom_busy = reg_value >> 12 & 1UL; 176 | // bool high_alert = reg_value >> 15 & 1UL; 177 | // bool low_alert = reg_value >> 14 & 1UL; 178 | 179 | 180 | if (data_ready && newDataCallback != NULL) 181 | newDataCallback (); 182 | 183 | if (reg_value >> 15 & 1UL) { 184 | alert_type = TMP117_ALERT::HIGHALERT; 185 | } 186 | else if (reg_value >> 14 & 1UL) { 187 | alert_type = TMP117_ALERT::LOWALERT; 188 | } 189 | else { 190 | alert_type = TMP117_ALERT::NOALERT; 191 | } 192 | 193 | //printConfig ( reg_value ); 194 | 195 | return reg_value; 196 | } 197 | 198 | /*! 199 | @brief Returns the recalculated temperature 200 | 201 | @return double temperature in °C 202 | */ 203 | double TMP117::getTemperature (void) { 204 | int16_t temp = i2cRead2B( TMP117_REG_TEMPERATURE ); 205 | return (temp * TMP117_RESOLUTION); 206 | } 207 | /*! 208 | @brief Get Device Revision 209 | 210 | @return uint16_t device revision 211 | */ 212 | uint16_t TMP117::getDeviceRev (void) { 213 | // read bits [15:12] 214 | uint16_t raw = i2cRead2B( TMP117_REG_DEVICE_ID ); 215 | 216 | return ( (raw >> 12) & 0x3); 217 | } 218 | 219 | /*! 220 | @brief Get Device ID (always 0x117) 221 | 222 | @return uint16_t device ID 223 | */ 224 | uint16_t TMP117::getDeviceID (void) { 225 | // read bits [11:0] 226 | uint16_t raw = i2cRead2B( TMP117_REG_DEVICE_ID ); 227 | return (raw & 0x0fff); 228 | } 229 | 230 | /*! 231 | @brief Returns the information which alert type happend 232 | 233 | @return TMP117_ALERT [NoAlert-HighTempAlert-LowTempAlert] 234 | */ 235 | TMP117_ALERT TMP117::getAlertType ( void ) { 236 | return alert_type; 237 | } 238 | 239 | /*! 240 | @brief Returns the content of the offset register in °C 241 | 242 | @return double offset temperature in °C 243 | */ 244 | double TMP117::getOffsetTemperature (void) { 245 | int16_t temp = i2cRead2B( TMP117_REG_TEMPERATURE_OFFSET ); 246 | return (temp * TMP117_RESOLUTION); 247 | } 248 | 249 | /*! 250 | @brief Write data to EEPROM register 251 | 252 | @param data data to write to the EEPROM 253 | 254 | @param eeprom_nr represents the EEPROM number [1 - 3] 255 | */ 256 | void TMP117::writeEEPROM (uint16_t data, uint8_t eeprom_nr) { 257 | if (!EEPROMisBusy()) { 258 | unlockEEPROM(); 259 | switch (eeprom_nr) { 260 | case 1 : i2cWrite2B ( TMP117_REG_EEPROM1, data); break; 261 | case 2 : i2cWrite2B ( TMP117_REG_EEPROM2, data); break; 262 | case 3 : i2cWrite2B ( TMP117_REG_EEPROM3, data); break; 263 | default: Serial.println("EEPROM value must be between 1 and 3"); 264 | } 265 | lockEEPROM(); 266 | } 267 | else { 268 | Serial.println("EEPROM is busy"); 269 | } 270 | } 271 | 272 | /*! 273 | @brief Read data from EEPROM register 274 | 275 | @param eeprom_nr represents the EEPROM number [1 - 3] 276 | 277 | @return uint16_t read EEPROM data 278 | */ 279 | uint16_t TMP117::readEEPROM (uint8_t eeprom_nr) { 280 | // read the 48 bit number from the EEPROM 281 | if (!EEPROMisBusy()) { 282 | uint16_t eeprom_data = 0; 283 | switch (eeprom_nr) { 284 | case 1 : eeprom_data = i2cRead2B( TMP117_REG_EEPROM1 ); break; 285 | case 2 : eeprom_data = i2cRead2B( TMP117_REG_EEPROM2 ); break; 286 | case 3 : eeprom_data = i2cRead2B( TMP117_REG_EEPROM3 ); break; 287 | default: Serial.println("EEPROM value must be between 1 and 3"); 288 | } 289 | return eeprom_data; 290 | } 291 | else { 292 | Serial.println("EEPROM is busy"); 293 | return 0; 294 | } 295 | } 296 | 297 | 298 | /**************************************************************************/ 299 | /* ********************* Library internal functions ******************** */ 300 | /**************************************************************************/ 301 | 302 | /*! 303 | @brief Write two bytes (16 bits) to TMP117 I2C sensor 304 | 305 | @param reg target register 306 | @param data data to write 307 | */ 308 | void TMP117::i2cWrite2B (uint8_t reg, uint16_t data){ 309 | Wire.beginTransmission(address); 310 | Wire.write( reg ); 311 | Wire.write( (data>>8) ); 312 | Wire.write( (data&0xff) ); 313 | Wire.endTransmission( ); 314 | delay(10); 315 | } 316 | 317 | /*! 318 | @brief Read two bytes (16 bits) from TMP117 I2C sensor 319 | 320 | @param reg target register to read from 321 | 322 | @return uint16_t read data 323 | */ 324 | uint16_t TMP117::i2cRead2B (uint8_t reg) { 325 | uint8_t data[2] = {0}; 326 | int16_t datac = 0; 327 | 328 | Wire.beginTransmission(address); 329 | Wire.write(reg); 330 | Wire.endTransmission(); 331 | Wire.requestFrom((uint8_t)address, (uint8_t)2); 332 | if(Wire.available() <= 2){ 333 | data[0] = Wire.read(); 334 | data[1] = Wire.read(); 335 | datac = ((data[0] << 8) | data[1]); 336 | } 337 | return datac; 338 | } 339 | 340 | /*! 341 | @brief Write configuration to config register. Also store it 342 | to the EEPROM so the settings will be used on reboot. 343 | 344 | @param config_data configuration 345 | */ 346 | void TMP117::writeConfig (uint16_t config_data) { 347 | if (!EEPROMisBusy()) { 348 | unlockEEPROM(); 349 | i2cWrite2B (TMP117_REG_CONFIGURATION, config_data); 350 | lockEEPROM(); 351 | } 352 | else { 353 | Serial.println("EEPROM is busy"); 354 | } 355 | } 356 | 357 | /*! 358 | @brief Prints configuration in user readable format 359 | 360 | @param reg_value configuration value 361 | */ 362 | void TMP117::printConfig () { 363 | uint16_t reg_value = i2cRead2B ( TMP117_REG_CONFIGURATION ); 364 | Serial.println(reg_value, BIN); 365 | 366 | Serial.print ("HIGH alert: "); 367 | Serial.println( ( reg_value >> 15) & 0b1 , BIN); 368 | Serial.print ("LOW alert: "); 369 | Serial.println( ( reg_value >> 14) & 0b1 , BIN); 370 | Serial.print ("Data ready: "); 371 | Serial.println( ( reg_value >> 13) & 0b1 , BIN); 372 | Serial.print ("EEPROM busy: "); 373 | Serial.println( ( reg_value >> 12) & 0b1 , BIN); 374 | Serial.print ("MOD[1:0]: "); 375 | Serial.println( ( reg_value >> 10) & 0b11 , BIN); 376 | Serial.print ("CONV[2:0]: "); 377 | Serial.println( ( reg_value >> 7) & 0b111 , BIN); 378 | Serial.print ("AVG[1:0]: "); 379 | Serial.println( ( reg_value >> 5) & 0b11 , BIN); 380 | Serial.print ("T/nA: "); 381 | Serial.println( ( reg_value >> 4) & 0b1 , BIN); 382 | Serial.print ("POL: "); 383 | Serial.println( ( reg_value >> 3) & 0b1 , BIN); 384 | Serial.print ("DR/Alert: "); 385 | Serial.println( ( reg_value >> 2) & 0b1 , BIN); 386 | Serial.print ("Soft_Reset: "); 387 | Serial.println( ( reg_value >> 1) & 0b1 , BIN); 388 | } 389 | /*! 390 | @brief Lock EEPROM, write protection 391 | */ 392 | void TMP117::lockEEPROM (void) { 393 | // clear bit 15 394 | uint16_t code = 0; 395 | code &= ~(1UL << 15); 396 | i2cWrite2B ( TMP117_REG_EEPROM_UNLOCK, code ); 397 | delay(100); 398 | } 399 | 400 | /*! 401 | @brief Unlock EEPROM, remove write protection 402 | */ 403 | void TMP117::unlockEEPROM (void) { 404 | // set bit 15 405 | uint16_t code = 0; 406 | code |= 1UL << 15; 407 | i2cWrite2B ( TMP117_REG_EEPROM_UNLOCK, code ); 408 | delay(100); 409 | } 410 | 411 | /*! 412 | @brief States if the EEPROM is busy 413 | 414 | @return Ture if the EEPROM is busy, fals else 415 | */ 416 | bool TMP117::EEPROMisBusy (void) { 417 | // Bit 14 indicates the busy state of the eeprom 418 | uint16_t code = i2cRead2B ( TMP117_REG_EEPROM_UNLOCK ); 419 | return (bool) ((code >> 14) & 0x01); 420 | } 421 | 422 | 423 | -------------------------------------------------------------------------------- /src/TMP117.h: -------------------------------------------------------------------------------- 1 | 2 | /*! 3 | * @file TMP117.h 4 | * @author Nils Minor 5 | * 6 | * @license GNU GENERAL PUBLIC LICENSE (see license.txt) 7 | * 8 | * v1.0.0 - Initial library version 9 | * 10 | * 11 | * 12 | * Arduino library for TMP117 high-precision digital temperature sensor. 13 | * 14 | * Features: 15 | * - meet ASTM E1112 and ISO 80601 requirements 16 | * - serve as a single chip digital alternative to a Platinum RTD (Class AA RTD) 17 | * - 100% tested on a production setup that is NIST traceable 18 | * - ±0.1°C (Maximum) From –20°C to +50°C 19 | * - ±0.15°C (Maximum) From –40°C to +70°C 20 | * - ±0.2°C (Maximum) From –40°C to +100°C 21 | * - ±0.25°C (Maximum) From –55°C to +125°C 22 | * - ±0.3°C (Maximum) From –55°C to +150°C 23 | * -Low Power Consumption 3.5-µA, 1-Hz Conversion Cycle 24 | * 25 | * Datasheet http://www.ti.com/lit/ds/symlink/tmp117.pdf 26 | * 27 | */ 28 | 29 | #ifndef _TMP117_H_ 30 | #define _TMP117_H_ 31 | 32 | #include 33 | #include 34 | 35 | #define TMP117_REG_TEMPERATURE 0x00 36 | #define TMP117_REG_CONFIGURATION 0x01 37 | #define TMP117_REG_TEMP_HIGH_LIMIT 0x02 38 | #define TMP117_REG_TEMP_LOW_LIMIT 0x03 39 | 40 | #define TMP117_REG_EEPROM_UNLOCK 0x04 41 | #define TMP117_REG_EEPROM1 0x05 42 | #define TMP117_REG_EEPROM2 0x06 43 | #define TMP117_REG_EEPROM3 0x08 44 | 45 | #define TMP117_REG_TEMPERATURE_OFFSET 0x07 46 | #define TMP117_REG_DEVICE_ID 0x0F 47 | 48 | #define TMP117_RESOLUTION (double)0.0078125 49 | 50 | typedef void (*allert_callback)(void); 51 | 52 | 53 | /* Conversion Cycle Time in CC Mode 54 | AVG 0 1 2 3 55 | CONV averaging (0) (8) (32) (64) 56 | 0 15.5ms 125ms 500ms 1s C15mS5 57 | 1 125ms 125ms 500ms 1s C125mS 58 | 2 250ms 250ms 500ms 1s C250mS 59 | 3 500ms 500ms 500ms 1s C500mS 60 | 4 1s 1s 1s 1s C1S 61 | 5 4s 4s 4s 4s C4S 62 | 6 8s 8s 8s 8s C8S 63 | 7 16s 16s 16s 16s C16S 64 | */ 65 | 66 | enum class TMP117_PMODE {THERMAL = 0, ALERT, DATA}; //!< Pin mode 67 | enum class TMP117_CMODE {CONTINUOUS = 0, SHUTDOWN = 1, ONESHOT = 3}; //!< Conversion mode 68 | enum class TMP117_CONVT {C15mS5 = 0, C125mS, C250mS, C500mS, C1S, C4S, C8S, C16S}; //!< Conversion time 69 | enum class TMP117_AVE {NOAVE = 0, AVE8, AVE32, AVE64}; //!< Averaging mode 70 | enum class TMP117_ALERT {NOALERT = 0, HIGHALERT, LOWALERT}; //!< Alert type 71 | 72 | class TMP117 { 73 | 74 | public: 75 | TMP117 (uint8_t addr); 76 | void init ( void (*_newDataCallback) (void) ); 77 | void update (void); 78 | void softReset ( void ); 79 | 80 | void setAlertMode ( TMP117_PMODE mode); 81 | void setAllertCallback ( void (*allert_callback)(void), uint8_t pin ); 82 | void setAllertTemperature ( double lowtemp, double hightemp ); 83 | void setConvMode ( TMP117_CMODE cmode); 84 | void setConvTime ( TMP117_CONVT convtime ); 85 | void setAveraging ( TMP117_AVE ave ); 86 | void setOffsetTemperature ( double offset ); 87 | void setTargetTemperature ( double target ); 88 | 89 | double getTemperature ( void ); 90 | uint16_t getDeviceID ( void ); 91 | uint16_t getDeviceRev ( void ); 92 | double getOffsetTemperature ( void ); 93 | TMP117_ALERT getAlertType ( void ); 94 | 95 | void writeEEPROM ( uint16_t data, uint8_t eeprom_nr ); 96 | uint16_t readEEPROM ( uint8_t eeprom_nr ); 97 | uint16_t readConfig ( void ); 98 | void printConfig ( void ); 99 | 100 | private: 101 | 102 | uint8_t address; 103 | int8_t alert_pin; 104 | TMP117_ALERT alert_type; 105 | 106 | void i2cWrite2B ( uint8_t reg, uint16_t data ); 107 | uint16_t i2cRead2B ( uint8_t reg ); 108 | void writeConfig ( uint16_t config_data ); 109 | void lockEEPROM ( void ); 110 | void unlockEEPROM ( void ); 111 | bool EEPROMisBusy ( void ); 112 | 113 | void (*newDataCallback) ( void ); 114 | 115 | }; 116 | 117 | 118 | 119 | 120 | #endif 121 | --------------------------------------------------------------------------------