annotate service/arduinoNode/arduino-libraries/DallasTemperature/README.md @ 1754:92999dfbf321 default tip

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