Zoltan Hudak / OneWire

Dallas' 1-Wire bus protocol library

Dependents:   DS1825 DISCO-F746-Dessiccateur-V1 watersenor_and_temp_code DS1820 ... more

OneWire.cpp@14:12b783661ff4, 2020-07-19 (annotated)

Committer:
hudakz
Date:
Sun Jul 19 19:27:09 2020 +0000
Revision:
14:12b783661ff4
Parent:
12:27a1b359b95c
Child:
15:7f7759008807
Dallas' 1-Wire bus protocol library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hudakz 0:acf75feb0947 1 /*
hudakz 0:acf75feb0947 2 Copyright (c) 2007, Jim Studt (original old version - many contributors since)
hudakz 0:acf75feb0947 3
hudakz 0:acf75feb0947 4 The latest version of this library may be found at:
hudakz 9:4af0015b0f47 5 http://www.pjrc.com/teensy/td_libs_Onehtml
hudakz 0:acf75feb0947 6
hudakz 0:acf75feb0947 7 OneWire has been maintained by Paul Stoffregen (paul@pjrc.com) since
hudakz 0:acf75feb0947 8 January 2010. At the time, it was in need of many bug fixes, but had
hudakz 0:acf75feb0947 9 been abandoned the original author (Jim Studt). None of the known
hudakz 9:4af0015b0f47 10 contributors were interested in maintaining One Paul typically
hudakz 0:acf75feb0947 11 works on OneWire every 6 to 12 months. Patches usually wait that
hudakz 0:acf75feb0947 12 long. If anyone is interested in more actively maintaining OneWire,
hudakz 0:acf75feb0947 13 please contact Paul.
hudakz 0:acf75feb0947 14
hudakz 0:acf75feb0947 15 Version 2.2:
hudakz 0:acf75feb0947 16 Teensy 3.0 compatibility, Paul Stoffregen, paul@pjrc.com
hudakz 0:acf75feb0947 17 Arduino Due compatibility, http://arduino.cc/forum/index.php?topic=141030
hudakz 0:acf75feb0947 18 Fix DS18B20 example negative temperature
hudakz 0:acf75feb0947 19 Fix DS18B20 example's low res modes, Ken Butcher
hudakz 0:acf75feb0947 20 Improve reset timing, Mark Tillotson
hudakz 0:acf75feb0947 21 Add const qualifiers, Bertrik Sikken
hudakz 0:acf75feb0947 22 Add initial value input to crc16, Bertrik Sikken
hudakz 0:acf75feb0947 23 Add target_search() function, Scott Roberts
hudakz 0:acf75feb0947 24
hudakz 0:acf75feb0947 25 Version 2.1:
hudakz 0:acf75feb0947 26 Arduino 1.0 compatibility, Paul Stoffregen
hudakz 0:acf75feb0947 27 Improve temperature example, Paul Stoffregen
hudakz 0:acf75feb0947 28 DS250x_PROM example, Guillermo Lovato
hudakz 0:acf75feb0947 29 PIC32 (chipKit) compatibility, Jason Dangel, dangel.jason AT gmail.com
hudakz 0:acf75feb0947 30 Improvements from Glenn Trewitt:
hudakz 0:acf75feb0947 31 - crc16() now works
hudakz 0:acf75feb0947 32 - check_crc16() does all of calculation/checking work.
hudakz 0:acf75feb0947 33 - Added read_bytes() and write_bytes(), to reduce tedious loops.
hudakz 0:acf75feb0947 34 - Added ds2408 example.
hudakz 0:acf75feb0947 35 Delete very old, out-of-date readme file (info is here)
hudakz 0:acf75feb0947 36
hudakz 0:acf75feb0947 37 Version 2.0: Modifications by Paul Stoffregen, January 2010:
hudakz 9:4af0015b0f47 38 http://www.pjrc.com/teensy/td_libs_Onehtml
hudakz 0:acf75feb0947 39 Search fix from Robin James
hudakz 0:acf75feb0947 40 http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1238032295/27#27
hudakz 0:acf75feb0947 41 Use direct optimized I/O in all cases
hudakz 0:acf75feb0947 42 Disable interrupts during timing critical sections
hudakz 0:acf75feb0947 43 (this solves many random communication errors)
hudakz 0:acf75feb0947 44 Disable interrupts during read-modify-write I/O
hudakz 0:acf75feb0947 45 Reduce RAM consumption by eliminating unnecessary
hudakz 0:acf75feb0947 46 variables and trimming many to 8 bits
hudakz 0:acf75feb0947 47 Optimize both crc8 - table version moved to flash
hudakz 0:acf75feb0947 48
hudakz 0:acf75feb0947 49 Modified to work with larger numbers of devices - avoids loop.
hudakz 0:acf75feb0947 50 Tested in Arduino 11 alpha with 12 sensors.
hudakz 0:acf75feb0947 51 26 Sept 2008 -- Robin James
hudakz 0:acf75feb0947 52 http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1238032295/27#27
hudakz 0:acf75feb0947 53
hudakz 0:acf75feb0947 54 Updated to work with arduino-0008 and to include skip() as of
hudakz 0:acf75feb0947 55 2007/07/06. --RJL20
hudakz 0:acf75feb0947 56
hudakz 0:acf75feb0947 57 Modified to calculate the 8-bit CRC directly, avoiding the need for
hudakz 0:acf75feb0947 58 the 256-byte lookup table to be loaded in RAM. Tested in arduino-0010
hudakz 0:acf75feb0947 59 -- Tom Pollard, Jan 23, 2008
hudakz 0:acf75feb0947 60
hudakz 0:acf75feb0947 61 Jim Studt's original library was modified by Josh Larios.
hudakz 0:acf75feb0947 62
hudakz 0:acf75feb0947 63 Tom Pollard, pollard@alum.mit.edu, contributed around May 20, 2008
hudakz 0:acf75feb0947 64
hudakz 0:acf75feb0947 65 Permission is hereby granted, free of charge, to any person obtaining
hudakz 0:acf75feb0947 66 a copy of this software and associated documentation files (the
hudakz 0:acf75feb0947 67 "Software"), to deal in the Software without restriction, including
hudakz 0:acf75feb0947 68 without limitation the rights to use, copy, modify, merge, publish,
hudakz 0:acf75feb0947 69 distribute, sublicense, and/or sell copies of the Software, and to
hudakz 0:acf75feb0947 70 permit persons to whom the Software is furnished to do so, subject to
hudakz 0:acf75feb0947 71 the following conditions:
hudakz 0:acf75feb0947 72
hudakz 0:acf75feb0947 73 The above copyright notice and this permission notice shall be
hudakz 0:acf75feb0947 74 included in all copies or substantial portions of the Software.
hudakz 0:acf75feb0947 75
hudakz 0:acf75feb0947 76 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
hudakz 0:acf75feb0947 77 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
hudakz 0:acf75feb0947 78 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
hudakz 0:acf75feb0947 79 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
hudakz 0:acf75feb0947 80 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
hudakz 0:acf75feb0947 81 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
hudakz 0:acf75feb0947 82 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
hudakz 0:acf75feb0947 83
hudakz 0:acf75feb0947 84 Much of the code was inspired by Derek Yerger's code, though I don't
hudakz 0:acf75feb0947 85 think much of that remains. In any event that was..
hudakz 0:acf75feb0947 86 (copyleft) 2006 by Derek Yerger - Free to distribute freely.
hudakz 0:acf75feb0947 87
hudakz 0:acf75feb0947 88 The CRC code was excerpted and inspired by the Dallas Semiconductor
hudakz 0:acf75feb0947 89 sample code bearing this copyright.
hudakz 0:acf75feb0947 90 //---------------------------------------------------------------------------
hudakz 0:acf75feb0947 91 // Copyright (C) 2000 Dallas Semiconductor Corporation, All Rights Reserved.
hudakz 0:acf75feb0947 92 //
hudakz 0:acf75feb0947 93 // Permission is hereby granted, free of charge, to any person obtaining a
hudakz 0:acf75feb0947 94 // copy of this software and associated documentation files (the "Software"),
hudakz 0:acf75feb0947 95 // to deal in the Software without restriction, including without limitation
hudakz 0:acf75feb0947 96 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
hudakz 0:acf75feb0947 97 // and/or sell copies of the Software, and to permit persons to whom the
hudakz 0:acf75feb0947 98 // Software is furnished to do so, subject to the following conditions:
hudakz 0:acf75feb0947 99 //
hudakz 0:acf75feb0947 100 // The above copyright notice and this permission notice shall be included
hudakz 0:acf75feb0947 101 // in all copies or substantial portions of the Software.
hudakz 0:acf75feb0947 102 //
hudakz 0:acf75feb0947 103 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
hudakz 0:acf75feb0947 104 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
hudakz 0:acf75feb0947 105 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
hudakz 0:acf75feb0947 106 // IN NO EVENT SHALL DALLAS SEMICONDUCTOR BE LIABLE FOR ANY CLAIM, DAMAGES
hudakz 0:acf75feb0947 107 // OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
hudakz 0:acf75feb0947 108 // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
hudakz 0:acf75feb0947 109 // OTHER DEALINGS IN THE SOFTWARE.
hudakz 0:acf75feb0947 110 //
hudakz 0:acf75feb0947 111 // Except as contained in this notice, the name of Dallas Semiconductor
hudakz 0:acf75feb0947 112 // shall not be used except as stated in the Dallas Semiconductor
hudakz 0:acf75feb0947 113 // Branding Policy.
hudakz 0:acf75feb0947 114 //--------------------------------------------------------------------------
hudakz 0:acf75feb0947 115 */
hudakz 0:acf75feb0947 116 #include "OneWire.h"
hudakz 0:acf75feb0947 117
hudakz 12:27a1b359b95c 118
hudakz 8:87fbdaba5535 119 /**
hudakz 10:c89b9ad6097c 120 * @brief Constructs a OneWire object.
hudakz 10:c89b9ad6097c 121 * @note GPIO is configured as output and an internal pull up resistor is connected.
hudakz 10:c89b9ad6097c 122 * But because for STM chips it takes very long time to change from output
hudakz 10:c89b9ad6097c 123 * to input an open drain mode is used rather and the GPIO remains output forever.
hudakz 8:87fbdaba5535 124 * @param
hudakz 8:87fbdaba5535 125 * @retval
hudakz 8:87fbdaba5535 126 */
hudakz 8:87fbdaba5535 127 OneWire::OneWire(PinName pin) :
hudakz 9:4af0015b0f47 128 DigitalInOut(pin)
hudakz 7:acf3f0ee66d2 129 {
hudakz 12:27a1b359b95c 130 MODE(); // set mode to either OpenDrain for STM or PullUp for others
hudakz 12:27a1b359b95c 131 INIT_WAIT;
hudakz 0:acf75feb0947 132 #if ONEWIRE_SEARCH
hudakz 0:acf75feb0947 133 reset_search();
hudakz 0:acf75feb0947 134 #endif
hudakz 0:acf75feb0947 135 }
hudakz 0:acf75feb0947 136
hudakz 10:c89b9ad6097c 137 /**
hudakz 10:c89b9ad6097c 138 * @brief Performs the onewire reset function.
hudakz 10:c89b9ad6097c 139 * @note We will wait up to 250uS for the bus to come high,
hudakz 10:c89b9ad6097c 140 * if it doesn't then it is broken or shorted and we return a 0;
hudakz 10:c89b9ad6097c 141 * @param
hudakz 10:c89b9ad6097c 142 * @retval 1 if a device asserted a presence pulse, 0 otherwise.
hudakz 10:c89b9ad6097c 143 */
hudakz 0:acf75feb0947 144 uint8_t OneWire::reset(void)
hudakz 0:acf75feb0947 145 {
hudakz 12:27a1b359b95c 146 uint8_t present;
hudakz 0:acf75feb0947 147
hudakz 9:4af0015b0f47 148 OUTPUT();
hudakz 12:27a1b359b95c 149 WRITE(0); // pull down the 1-wire bus do create reset pulse
hudakz 12:27a1b359b95c 150 WAIT_US(500); // wait at least 480 us
hudakz 12:27a1b359b95c 151 INPUT(); // release the 1-wire bus and go into receive mode
hudakz 12:27a1b359b95c 152 WAIT_US(90); // DS1820 waits about 15 to 60 us and generates a 60 to 240 us presence pulse
hudakz 12:27a1b359b95c 153 present = !READ(); // read the presence pulse
hudakz 12:27a1b359b95c 154 WAIT_US(420);
hudakz 12:27a1b359b95c 155
hudakz 12:27a1b359b95c 156 return present;
hudakz 0:acf75feb0947 157 }
hudakz 0:acf75feb0947 158
hudakz 10:c89b9ad6097c 159 /**
hudakz 10:c89b9ad6097c 160 * @brief Writes a bit.
hudakz 10:c89b9ad6097c 161 * @note GPIO registers are used for STM chips to cut time.
hudakz 10:c89b9ad6097c 162 * @param
hudakz 10:c89b9ad6097c 163 * @retval
hudakz 10:c89b9ad6097c 164 */
hudakz 0:acf75feb0947 165 void OneWire::write_bit(uint8_t v)
hudakz 0:acf75feb0947 166 {
hudakz 9:4af0015b0f47 167 OUTPUT();
hudakz 0:acf75feb0947 168 if (v & 1) {
hudakz 9:4af0015b0f47 169 WRITE(0); // drive output low
hudakz 12:27a1b359b95c 170 WAIT_US(1);
hudakz 9:4af0015b0f47 171 WRITE(1); // drive output high
hudakz 12:27a1b359b95c 172 WAIT_US(60);
hudakz 8:87fbdaba5535 173 }
hudakz 8:87fbdaba5535 174 else {
hudakz 9:4af0015b0f47 175 WRITE(0); // drive output low
hudakz 12:27a1b359b95c 176 WAIT_US(60);
hudakz 9:4af0015b0f47 177 WRITE(1); // drive output high
hudakz 12:27a1b359b95c 178 WAIT_US(1);
hudakz 0:acf75feb0947 179 }
hudakz 0:acf75feb0947 180 }
hudakz 0:acf75feb0947 181
hudakz 10:c89b9ad6097c 182 /**
hudakz 10:c89b9ad6097c 183 * @brief Reads a bit.
hudakz 10:c89b9ad6097c 184 * @note GPIO registers are used for STM chips to cut time.
hudakz 10:c89b9ad6097c 185 * @param
hudakz 10:c89b9ad6097c 186 * @retval
hudakz 10:c89b9ad6097c 187 */
hudakz 0:acf75feb0947 188 uint8_t OneWire::read_bit(void)
hudakz 0:acf75feb0947 189 {
hudakz 12:27a1b359b95c 190 const int SAMPLE_POINT = 10;
hudakz 0:acf75feb0947 191 uint8_t r;
hudakz 7:acf3f0ee66d2 192 int t;
hudakz 0:acf75feb0947 193
hudakz 9:4af0015b0f47 194 OUTPUT();
hudakz 12:27a1b359b95c 195 WRITE(0);
hudakz 10:c89b9ad6097c 196 timer.start();
hudakz 9:4af0015b0f47 197 INPUT();
hudakz 7:acf3f0ee66d2 198 t = timer.read_us();
hudakz 12:27a1b359b95c 199 if (t < SAMPLE_POINT)
hudakz 12:27a1b359b95c 200 WAIT_US(SAMPLE_POINT - t);
hudakz 9:4af0015b0f47 201 r = READ();
hudakz 6:d6e084297fb9 202 timer.stop();
hudakz 14:12b783661ff4 203 WAIT_US(55);
hudakz 14:12b783661ff4 204 //printf("t = %d\r\n", t);
hudakz 14:12b783661ff4 205 //printf("t1 = %d\r\n", timer.read_us() - t);
hudakz 6:d6e084297fb9 206 timer.reset();
hudakz 0:acf75feb0947 207 return r;
hudakz 0:acf75feb0947 208 }
hudakz 0:acf75feb0947 209
hudakz 10:c89b9ad6097c 210 /**
hudakz 10:c89b9ad6097c 211 * @brief Writes a byte.
hudakz 10:c89b9ad6097c 212 * @note The writing code uses the active drivers to raise the
hudakz 10:c89b9ad6097c 213 pin high, if you need power after the write (e.g. DS18S20 in
hudakz 10:c89b9ad6097c 214 parasite power mode) then set 'power' to 1, otherwise the pin will
hudakz 10:c89b9ad6097c 215 go tri-state at the end of the write to avoid heating in a short or
hudakz 10:c89b9ad6097c 216 other mishap.
hudakz 10:c89b9ad6097c 217 * @param
hudakz 10:c89b9ad6097c 218 * @retval
hudakz 10:c89b9ad6097c 219 */
hudakz 9:4af0015b0f47 220 void OneWire::write_byte(uint8_t v, uint8_t power /* = 0 */ )
hudakz 8:87fbdaba5535 221 {
hudakz 0:acf75feb0947 222 uint8_t bitMask;
hudakz 0:acf75feb0947 223
hudakz 9:4af0015b0f47 224 for (bitMask = 0x01; bitMask; bitMask <<= 1)
hudakz 9:4af0015b0f47 225 write_bit((bitMask & v) ? 1 : 0);
hudakz 8:87fbdaba5535 226 if (!power)
hudakz 9:4af0015b0f47 227 INPUT();
hudakz 0:acf75feb0947 228 }
hudakz 0:acf75feb0947 229
hudakz 8:87fbdaba5535 230 /**
hudakz 10:c89b9ad6097c 231 * @brief Writes bytes.
hudakz 8:87fbdaba5535 232 * @note
hudakz 8:87fbdaba5535 233 * @param
hudakz 8:87fbdaba5535 234 * @retval
hudakz 8:87fbdaba5535 235 */
hudakz 8:87fbdaba5535 236 void OneWire::write_bytes(const uint8_t* buf, uint16_t count, bool power /* = 0 */ )
hudakz 8:87fbdaba5535 237 {
hudakz 8:87fbdaba5535 238 for (uint16_t i = 0; i < count; i++)
hudakz 9:4af0015b0f47 239 write_byte(buf[i]);
hudakz 8:87fbdaba5535 240 if (!power)
hudakz 9:4af0015b0f47 241 INPUT();
hudakz 0:acf75feb0947 242 }
hudakz 0:acf75feb0947 243
hudakz 10:c89b9ad6097c 244 /**
hudakz 10:c89b9ad6097c 245 * @brief Reads a byte.
hudakz 10:c89b9ad6097c 246 * @note
hudakz 10:c89b9ad6097c 247 * @param
hudakz 10:c89b9ad6097c 248 * @retval
hudakz 10:c89b9ad6097c 249 */
hudakz 9:4af0015b0f47 250 uint8_t OneWire::read_byte()
hudakz 8:87fbdaba5535 251 {
hudakz 0:acf75feb0947 252 uint8_t bitMask;
hudakz 0:acf75feb0947 253 uint8_t r = 0;
hudakz 0:acf75feb0947 254
hudakz 0:acf75feb0947 255 for (bitMask = 0x01; bitMask; bitMask <<= 1) {
hudakz 9:4af0015b0f47 256 if (read_bit())
hudakz 8:87fbdaba5535 257 r |= bitMask;
hudakz 0:acf75feb0947 258 }
hudakz 8:87fbdaba5535 259
hudakz 0:acf75feb0947 260 return r;
hudakz 0:acf75feb0947 261 }
hudakz 0:acf75feb0947 262
hudakz 8:87fbdaba5535 263 /**
hudakz 10:c89b9ad6097c 264 * @brief Reads bytes.
hudakz 8:87fbdaba5535 265 * @note
hudakz 8:87fbdaba5535 266 * @param
hudakz 8:87fbdaba5535 267 * @retval
hudakz 8:87fbdaba5535 268 */
hudakz 8:87fbdaba5535 269 void OneWire::read_bytes(uint8_t* buf, uint16_t count)
hudakz 8:87fbdaba5535 270 {
hudakz 8:87fbdaba5535 271 for (uint16_t i = 0; i < count; i++)
hudakz 9:4af0015b0f47 272 buf[i] = read_byte();
hudakz 0:acf75feb0947 273 }
hudakz 0:acf75feb0947 274
hudakz 10:c89b9ad6097c 275 /**
hudakz 10:c89b9ad6097c 276 * @brief Selects ROM.
hudakz 10:c89b9ad6097c 277 * @note
hudakz 10:c89b9ad6097c 278 * @param
hudakz 10:c89b9ad6097c 279 * @retval
hudakz 10:c89b9ad6097c 280 */
hudakz 0:acf75feb0947 281 void OneWire::select(const uint8_t rom[8])
hudakz 0:acf75feb0947 282 {
hudakz 0:acf75feb0947 283 uint8_t i;
hudakz 0:acf75feb0947 284
hudakz 10:c89b9ad6097c 285 write_byte(0x55); // Choose ROM
hudakz 8:87fbdaba5535 286 for (i = 0; i < 8; i++)
hudakz 9:4af0015b0f47 287 write_byte(rom[i]);
hudakz 0:acf75feb0947 288 }
hudakz 0:acf75feb0947 289
hudakz 10:c89b9ad6097c 290 /**
hudakz 10:c89b9ad6097c 291 * @brief Skips ROM select.
hudakz 10:c89b9ad6097c 292 * @note
hudakz 10:c89b9ad6097c 293 * @param
hudakz 10:c89b9ad6097c 294 * @retval
hudakz 10:c89b9ad6097c 295 */
hudakz 0:acf75feb0947 296 void OneWire::skip()
hudakz 0:acf75feb0947 297 {
hudakz 10:c89b9ad6097c 298 write_byte(0xCC); // Skip ROM
hudakz 0:acf75feb0947 299 }
hudakz 0:acf75feb0947 300
hudakz 8:87fbdaba5535 301 /**
hudakz 10:c89b9ad6097c 302 * @brief Unpowers the chip.
hudakz 8:87fbdaba5535 303 * @note
hudakz 8:87fbdaba5535 304 * @param
hudakz 8:87fbdaba5535 305 * @retval
hudakz 8:87fbdaba5535 306 */
hudakz 0:acf75feb0947 307 void OneWire::depower()
hudakz 0:acf75feb0947 308 {
hudakz 9:4af0015b0f47 309 INPUT();
hudakz 0:acf75feb0947 310 }
hudakz 0:acf75feb0947 311
hudakz 0:acf75feb0947 312 #if ONEWIRE_SEARCH
hudakz 8:87fbdaba5535 313 //
hudakz 0:acf75feb0947 314
hudakz 10:c89b9ad6097c 315 /**
hudakz 10:c89b9ad6097c 316 * @brief Resets the search state.
hudakz 10:c89b9ad6097c 317 * @note We need to use this function to start a search again from the beginning.
hudakz 10:c89b9ad6097c 318 * We do not need to do it for the first search, though we could.
hudakz 10:c89b9ad6097c 319 * @param
hudakz 10:c89b9ad6097c 320 * @retval
hudakz 10:c89b9ad6097c 321 */
hudakz 0:acf75feb0947 322 void OneWire::reset_search()
hudakz 0:acf75feb0947 323 {
hudakz 8:87fbdaba5535 324 // reset the search state
hudakz 8:87fbdaba5535 325 LastDiscrepancy = 0;
hudakz 8:87fbdaba5535 326 LastDeviceFlag = false;
hudakz 8:87fbdaba5535 327 LastFamilyDiscrepancy = 0;
hudakz 8:87fbdaba5535 328 for (int i = 7;; i--) {
hudakz 8:87fbdaba5535 329 ROM_NO[i] = 0;
hudakz 8:87fbdaba5535 330 if (i == 0)
hudakz 8:87fbdaba5535 331 break;
hudakz 8:87fbdaba5535 332 }
hudakz 0:acf75feb0947 333 }
hudakz 0:acf75feb0947 334
hudakz 10:c89b9ad6097c 335 /**
hudakz 10:c89b9ad6097c 336 * @brief Sets the search state to find SearchFamily type devices.
hudakz 10:c89b9ad6097c 337 * @note
hudakz 10:c89b9ad6097c 338 * @param
hudakz 10:c89b9ad6097c 339 * @retval
hudakz 10:c89b9ad6097c 340 */
hudakz 0:acf75feb0947 341 void OneWire::target_search(uint8_t family_code)
hudakz 0:acf75feb0947 342 {
hudakz 8:87fbdaba5535 343 // set the search state to find SearchFamily type devices
hudakz 8:87fbdaba5535 344 ROM_NO[0] = family_code;
hudakz 8:87fbdaba5535 345 for (uint8_t i = 1; i < 8; i++)
hudakz 8:87fbdaba5535 346 ROM_NO[i] = 0;
hudakz 8:87fbdaba5535 347 LastDiscrepancy = 64;
hudakz 8:87fbdaba5535 348 LastFamilyDiscrepancy = 0;
hudakz 8:87fbdaba5535 349 LastDeviceFlag = false;
hudakz 0:acf75feb0947 350 }
hudakz 0:acf75feb0947 351
hudakz 10:c89b9ad6097c 352 /**
hudakz 10:c89b9ad6097c 353 * @brief Performs a search.
hudakz 10:c89b9ad6097c 354 * @note Perform a search. If this function returns a '1' then it has
hudakz 10:c89b9ad6097c 355 enumerated the next device and you may retrieve the ROM from the
hudakz 10:c89b9ad6097c 356 OneWire::address variable. If there are no devices, no further
hudakz 10:c89b9ad6097c 357 devices, or something horrible happens in the middle of the
hudakz 10:c89b9ad6097c 358 enumeration then a 0 is returned. If a new device is found then
hudakz 10:c89b9ad6097c 359 its address is copied to newAddr. Use OneWire::reset_search() to
hudakz 10:c89b9ad6097c 360 start over.
hudakz 10:c89b9ad6097c 361
hudakz 10:c89b9ad6097c 362 --- Replaced by the one from the Dallas Semiconductor web site ---
hudakz 10:c89b9ad6097c 363 -------------------------------------------------------------------------
hudakz 10:c89b9ad6097c 364 Perform the 1-Wire Search Algorithm on the 1-Wire bus using the existing
hudakz 10:c89b9ad6097c 365 search state.
hudakz 10:c89b9ad6097c 366 * @param
hudakz 10:c89b9ad6097c 367 * @retval true : device found, ROM number in ROM_NO buffer
hudakz 10:c89b9ad6097c 368 * false : device not found, end of search
hudakz 10:c89b9ad6097c 369 */
hudakz 8:87fbdaba5535 370 uint8_t OneWire::search(uint8_t* newAddr)
hudakz 0:acf75feb0947 371 {
hudakz 8:87fbdaba5535 372 uint8_t id_bit_number;
hudakz 8:87fbdaba5535 373 uint8_t last_zero, rom_byte_number, search_result;
hudakz 8:87fbdaba5535 374 uint8_t id_bit, cmp_id_bit;
hudakz 0:acf75feb0947 375
hudakz 8:87fbdaba5535 376 unsigned char rom_byte_mask, search_direction;
hudakz 0:acf75feb0947 377
hudakz 8:87fbdaba5535 378 // initialize for search
hudakz 8:87fbdaba5535 379 id_bit_number = 1;
hudakz 8:87fbdaba5535 380 last_zero = 0;
hudakz 8:87fbdaba5535 381 rom_byte_number = 0;
hudakz 8:87fbdaba5535 382 rom_byte_mask = 1;
hudakz 8:87fbdaba5535 383 search_result = 0;
hudakz 12:27a1b359b95c 384
hudakz 8:87fbdaba5535 385 // if the last call was not the last one
hudakz 8:87fbdaba5535 386 if (!LastDeviceFlag) {
hudakz 8:87fbdaba5535 387 // 1-Wire reset
hudakz 8:87fbdaba5535 388 if (!reset()) {
hudakz 8:87fbdaba5535 389 // reset the search
hudakz 8:87fbdaba5535 390 LastDiscrepancy = 0;
hudakz 8:87fbdaba5535 391 LastDeviceFlag = false;
hudakz 8:87fbdaba5535 392 LastFamilyDiscrepancy = 0;
hudakz 8:87fbdaba5535 393 return false;
hudakz 8:87fbdaba5535 394 }
hudakz 0:acf75feb0947 395
hudakz 8:87fbdaba5535 396 // issue the search command
hudakz 9:4af0015b0f47 397 write_byte(0xF0);
hudakz 0:acf75feb0947 398
hudakz 8:87fbdaba5535 399 // loop to do the search
hudakz 8:87fbdaba5535 400 do {
hudakz 8:87fbdaba5535 401 // read a bit and its complement
hudakz 8:87fbdaba5535 402 id_bit = read_bit();
hudakz 8:87fbdaba5535 403 cmp_id_bit = read_bit();
hudakz 0:acf75feb0947 404
hudakz 8:87fbdaba5535 405 // check for no devices on 1-wire
hudakz 8:87fbdaba5535 406 if ((id_bit == 1) && (cmp_id_bit == 1))
hudakz 8:87fbdaba5535 407 break;
hudakz 8:87fbdaba5535 408 else {
hudakz 8:87fbdaba5535 409 // all devices coupled have 0 or 1
hudakz 8:87fbdaba5535 410 if (id_bit != cmp_id_bit)
hudakz 8:87fbdaba5535 411 search_direction = id_bit; // bit write value for search
hudakz 8:87fbdaba5535 412 else {
hudakz 8:87fbdaba5535 413 // if this discrepancy if before the Last Discrepancy
hudakz 8:87fbdaba5535 414 // on a previous next then pick the same as last time
hudakz 8:87fbdaba5535 415 if (id_bit_number < LastDiscrepancy)
hudakz 8:87fbdaba5535 416 search_direction = ((ROM_NO[rom_byte_number] & rom_byte_mask) > 0);
hudakz 8:87fbdaba5535 417 else
hudakz 8:87fbdaba5535 418 // if equal to last pick 1, if not then pick 0
hudakz 8:87fbdaba5535 419 search_direction = (id_bit_number == LastDiscrepancy);
hudakz 0:acf75feb0947 420
hudakz 8:87fbdaba5535 421 // if 0 was picked then record its position in LastZero
hudakz 8:87fbdaba5535 422 if (search_direction == 0) {
hudakz 8:87fbdaba5535 423 last_zero = id_bit_number;
hudakz 0:acf75feb0947 424
hudakz 8:87fbdaba5535 425 // check for Last discrepancy in family
hudakz 8:87fbdaba5535 426 if (last_zero < 9)
hudakz 8:87fbdaba5535 427 LastFamilyDiscrepancy = last_zero;
hudakz 8:87fbdaba5535 428 }
hudakz 8:87fbdaba5535 429 }
hudakz 0:acf75feb0947 430
hudakz 8:87fbdaba5535 431 // set or clear the bit in the ROM byte rom_byte_number
hudakz 8:87fbdaba5535 432 // with mask rom_byte_mask
hudakz 8:87fbdaba5535 433 if (search_direction == 1)
hudakz 8:87fbdaba5535 434 ROM_NO[rom_byte_number] |= rom_byte_mask;
hudakz 8:87fbdaba5535 435 else
hudakz 8:87fbdaba5535 436 ROM_NO[rom_byte_number] &= ~rom_byte_mask;
hudakz 0:acf75feb0947 437
hudakz 8:87fbdaba5535 438 // serial number search direction write bit
hudakz 8:87fbdaba5535 439 write_bit(search_direction);
hudakz 0:acf75feb0947 440
hudakz 8:87fbdaba5535 441 // increment the byte counter id_bit_number
hudakz 8:87fbdaba5535 442 // and shift the mask rom_byte_mask
hudakz 8:87fbdaba5535 443 id_bit_number++;
hudakz 8:87fbdaba5535 444 rom_byte_mask <<= 1;
hudakz 0:acf75feb0947 445
hudakz 8:87fbdaba5535 446 // if the mask is 0 then go to new SerialNum byte rom_byte_number and reset mask
hudakz 8:87fbdaba5535 447 if (rom_byte_mask == 0) {
hudakz 8:87fbdaba5535 448 rom_byte_number++;
hudakz 8:87fbdaba5535 449 rom_byte_mask = 1;
hudakz 8:87fbdaba5535 450 }
hudakz 0:acf75feb0947 451 }
hudakz 8:87fbdaba5535 452 } while (rom_byte_number < 8);
hudakz 8:87fbdaba5535 453 // loop until through all ROM bytes 0-7
hudakz 8:87fbdaba5535 454 // if the search was successful then
hudakz 8:87fbdaba5535 455 if (!(id_bit_number < 65)) {
hudakz 8:87fbdaba5535 456 // search successful so set LastDiscrepancy,LastDeviceFlag,search_result
hudakz 8:87fbdaba5535 457 LastDiscrepancy = last_zero;
hudakz 0:acf75feb0947 458
hudakz 8:87fbdaba5535 459 // check for last device
hudakz 8:87fbdaba5535 460 if (LastDiscrepancy == 0)
hudakz 8:87fbdaba5535 461 LastDeviceFlag = true;
hudakz 0:acf75feb0947 462
hudakz 8:87fbdaba5535 463 search_result = true;
hudakz 8:87fbdaba5535 464 }
hudakz 8:87fbdaba5535 465 }
hudakz 0:acf75feb0947 466
hudakz 8:87fbdaba5535 467 // if no device found then reset counters so next 'search' will be like a first
hudakz 8:87fbdaba5535 468 if (!search_result || !ROM_NO[0]) {
hudakz 8:87fbdaba5535 469 LastDiscrepancy = 0;
hudakz 8:87fbdaba5535 470 LastDeviceFlag = false;
hudakz 8:87fbdaba5535 471 LastFamilyDiscrepancy = 0;
hudakz 8:87fbdaba5535 472 search_result = false;
hudakz 8:87fbdaba5535 473 }
hudakz 0:acf75feb0947 474
hudakz 8:87fbdaba5535 475 for (int i = 0; i < 8; i++)
hudakz 8:87fbdaba5535 476 newAddr[i] = ROM_NO[i];
hudakz 8:87fbdaba5535 477 return search_result;
hudakz 8:87fbdaba5535 478 }
hudakz 0:acf75feb0947 479 #endif
hudakz 10:c89b9ad6097c 480 //
hudakz 0:acf75feb0947 481 #if ONEWIRE_CRC
hudakz 0:acf75feb0947 482 //
hudakz 10:c89b9ad6097c 483 /**
hudakz 10:c89b9ad6097c 484 * @brief Computes a Dallas Semiconductor 8 bit CRC directly.
hudakz 10:c89b9ad6097c 485 * @note The 1-Wire CRC scheme is described in Maxim Application Note 27:
hudakz 10:c89b9ad6097c 486 "Understanding and Using Cyclic Redundancy Checks with Maxim iButton Products"
hudakz 10:c89b9ad6097c 487 * @param
hudakz 10:c89b9ad6097c 488 * @retval
hudakz 10:c89b9ad6097c 489 */
hudakz 8:87fbdaba5535 490 uint8_t OneWire::crc8(const uint8_t* addr, uint8_t len)
hudakz 0:acf75feb0947 491 {
hudakz 0:acf75feb0947 492 uint8_t crc = 0;
hudakz 8:87fbdaba5535 493
hudakz 0:acf75feb0947 494 while (len--) {
hudakz 0:acf75feb0947 495 uint8_t inbyte = *addr++;
hudakz 0:acf75feb0947 496 for (uint8_t i = 8; i; i--) {
hudakz 0:acf75feb0947 497 uint8_t mix = (crc ^ inbyte) & 0x01;
hudakz 0:acf75feb0947 498 crc >>= 1;
hudakz 8:87fbdaba5535 499 if (mix)
hudakz 8:87fbdaba5535 500 crc ^= 0x8C;
hudakz 0:acf75feb0947 501 inbyte >>= 1;
hudakz 0:acf75feb0947 502 }
hudakz 0:acf75feb0947 503 }
hudakz 8:87fbdaba5535 504
hudakz 0:acf75feb0947 505 return crc;
hudakz 0:acf75feb0947 506 }
hudakz 0:acf75feb0947 507 #endif