Mercurial > code > home > repos > homeauto

annotate service/arduinoNode/arduino-libraries/DallasTemperature/README.md @ 1414:1a277dba4cdc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
oneShot can send to a dev instance Ignore-this: 37dfe0f67c01c221b861d2b3e3900051 darcs-hash:85955653cb2158901ccdc4bd204c78a2b0cf54c2
author drewp <drewp@bigasterisk.com>
date Wed, 24 Jul 2019 01:03:21 -0700
parents 4f5825a9fc47
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
970
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
1 Arduino Library for Dallas Temperature ICs
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
2 ==========================================
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
3
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
4 Usage
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
5 -----
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
6
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
7 This library supports the following devices :
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
8
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
9
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
10 * DS18B20
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
11 * DS18S20 - Please note there appears to be an issue with this series.
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
12 * DS1822
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
13 * DS1820
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
14
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
15
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
16 You will need a pull-up resistor of about 5 KOhm between the 1-Wire data line
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
17 and your 5V power. If you are using the DS18B20, ground pins 1 and 3. The
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
18 centre pin is the data line '1-wire'.
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
19
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
20 We have included a "REQUIRESNEW" and "REQUIRESALARMS" definition. If you
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
21 want to slim down the code feel free to use either of these by including
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
22
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
23
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
24
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
25 #define REQUIRESNEW
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
26
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
27 or
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
28
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
29 #define REQUIRESALARMS
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
30
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
31
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
32 at the top of DallasTemperature.h
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
33
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
34
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
35 Credits
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
36 -------
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
37
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
38 The OneWire code has been derived from
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
39 http://www.arduino.cc/playground/Learning/OneWire.
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
40 Miles Burton <miles@mnetcs.com> originally developed this library.
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
41 Tim Newsome <nuisance@casualhacker.net> added support for multiple sensors on
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
42 the same bus.
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
43 Guil Barros [gfbarros@bappos.com] added getTempByAddress (v3.5)
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
44 Rob Tillaart [rob.tillaart@gmail.com] added async modus (v3.7.0)
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
45
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
46
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
47 Website
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
48 -------
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
49
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
50 You can find the latest version of the library at
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
51 http://milesburton.com/index.php?title=Dallas_Temperature_Control_Library
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
52
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
53 License
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
54 -------
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
55
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
56 This library is free software; you can redistribute it and/or
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
57 modify it under the terms of the GNU Lesser General Public
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
58 License as published by the Free Software Foundation; either
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
59 version 2.1 of the License, or (at your option) any later version.
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
60
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
61 This library is distributed in the hope that it will be useful,
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
62 but WITHOUT ANY WARRANTY; without even the implied warranty of
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
63 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
64 Lesser General Public License for more details.
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
65
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
66 You should have received a copy of the GNU Lesser General Public
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
67 License along with this library; if not, write to the Free Software
4f5825a9fc47 some external arduino libs, minus examples and docs
drewp <drewp@bigasterisk.com>
parents:
diff changeset
68 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA