jack zen / OneWire

DS18B20

Dependents:   DS1820_HelloWorld

OneWireCRC.h@0:a47e8ec71a4e, 2017-09-06 (annotated)

Committer:
jack__zen
Date:
Wed Sep 06 05:35:15 2017 +0000
Revision:
0:a47e8ec71a4e
onewire

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jack__zen 0:a47e8ec71a4e 1 /*
jack__zen 0:a47e8ec71a4e 2 * OneWireCRC. This is a port to mbed of Jim Studt's Adruino One Wire
jack__zen 0:a47e8ec71a4e 3 * library. Please see additional copyrights below this one, including
jack__zen 0:a47e8ec71a4e 4 * references to other copyrights.
jack__zen 0:a47e8ec71a4e 5 *
jack__zen 0:a47e8ec71a4e 6 * Copyright (C) <2009> Petras Saduikis <petras@petras.co.uk>
jack__zen 0:a47e8ec71a4e 7 *
jack__zen 0:a47e8ec71a4e 8 * This file is part of OneWireCRC.
jack__zen 0:a47e8ec71a4e 9 *
jack__zen 0:a47e8ec71a4e 10 * OneWireCRC is free software: you can redistribute it and/or modify
jack__zen 0:a47e8ec71a4e 11 * it under the terms of the GNU General Public License as published by
jack__zen 0:a47e8ec71a4e 12 * the Free Software Foundation, either version 3 of the License, or
jack__zen 0:a47e8ec71a4e 13 * (at your option) any later version.
jack__zen 0:a47e8ec71a4e 14 *
jack__zen 0:a47e8ec71a4e 15 * OneWireCRC is distributed in the hope that it will be useful,
jack__zen 0:a47e8ec71a4e 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
jack__zen 0:a47e8ec71a4e 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
jack__zen 0:a47e8ec71a4e 18 * GNU General Public License for more details.
jack__zen 0:a47e8ec71a4e 19 *
jack__zen 0:a47e8ec71a4e 20 * You should have received a copy of the GNU General Public License
jack__zen 0:a47e8ec71a4e 21 * along with OneWireCRC. If not, see <http://www.gnu.org/licenses/>.
jack__zen 0:a47e8ec71a4e 22 */
jack__zen 0:a47e8ec71a4e 23 /*
jack__zen 0:a47e8ec71a4e 24 Copyright (c) 2007, Jim Studt
jack__zen 0:a47e8ec71a4e 25
jack__zen 0:a47e8ec71a4e 26 Updated to work with arduino-0008 and to include skip() as of
jack__zen 0:a47e8ec71a4e 27 2007/07/06. --RJL20
jack__zen 0:a47e8ec71a4e 28
jack__zen 0:a47e8ec71a4e 29 Modified to calculate the 8-bit CRC directly, avoiding the need for
jack__zen 0:a47e8ec71a4e 30 the 256-byte lookup table to be loaded in RAM. Tested in arduino-0010
jack__zen 0:a47e8ec71a4e 31 -- Tom Pollard, Jan 23, 2008
jack__zen 0:a47e8ec71a4e 32
jack__zen 0:a47e8ec71a4e 33 Permission is hereby granted, free of charge, to any person obtaining
jack__zen 0:a47e8ec71a4e 34 a copy of this software and associated documentation files (the
jack__zen 0:a47e8ec71a4e 35 "Software"), to deal in the Software without restriction, including
jack__zen 0:a47e8ec71a4e 36 without limitation the rights to use, copy, modify, merge, publish,
jack__zen 0:a47e8ec71a4e 37 distribute, sublicense, and/or sell copies of the Software, and to
jack__zen 0:a47e8ec71a4e 38 permit persons to whom the Software is furnished to do so, subject to
jack__zen 0:a47e8ec71a4e 39 the following conditions:
jack__zen 0:a47e8ec71a4e 40
jack__zen 0:a47e8ec71a4e 41 The above copyright notice and this permission notice shall be
jack__zen 0:a47e8ec71a4e 42 included in all copies or substantial portions of the Software.
jack__zen 0:a47e8ec71a4e 43
jack__zen 0:a47e8ec71a4e 44 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
jack__zen 0:a47e8ec71a4e 45 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
jack__zen 0:a47e8ec71a4e 46 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
jack__zen 0:a47e8ec71a4e 47 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
jack__zen 0:a47e8ec71a4e 48 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
jack__zen 0:a47e8ec71a4e 49 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
jack__zen 0:a47e8ec71a4e 50 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
jack__zen 0:a47e8ec71a4e 51
jack__zen 0:a47e8ec71a4e 52 Much of the code was inspired by Derek Yerger's code, though I don't
jack__zen 0:a47e8ec71a4e 53 think much of that remains. In any event that was..
jack__zen 0:a47e8ec71a4e 54 (copyleft) 2006 by Derek Yerger - Free to distribute freely.
jack__zen 0:a47e8ec71a4e 55
jack__zen 0:a47e8ec71a4e 56 The CRC code was excerpted and inspired by the Dallas Semiconductor
jack__zen 0:a47e8ec71a4e 57 sample code bearing this copyright.
jack__zen 0:a47e8ec71a4e 58 */
jack__zen 0:a47e8ec71a4e 59 //---------------------------------------------------------------------------
jack__zen 0:a47e8ec71a4e 60 // Copyright (C) 2000 Dallas Semiconductor Corporation, All Rights Reserved.
jack__zen 0:a47e8ec71a4e 61 //
jack__zen 0:a47e8ec71a4e 62 // Permission is hereby granted, free of charge, to any person obtaining a
jack__zen 0:a47e8ec71a4e 63 // copy of this software and associated documentation files (the "Software"),
jack__zen 0:a47e8ec71a4e 64 // to deal in the Software without restriction, including without limitation
jack__zen 0:a47e8ec71a4e 65 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
jack__zen 0:a47e8ec71a4e 66 // and/or sell copies of the Software, and to permit persons to whom the
jack__zen 0:a47e8ec71a4e 67 // Software is furnished to do so, subject to the following conditions:
jack__zen 0:a47e8ec71a4e 68 //
jack__zen 0:a47e8ec71a4e 69 // The above copyright notice and this permission notice shall be included
jack__zen 0:a47e8ec71a4e 70 // in all copies or substantial portions of the Software.
jack__zen 0:a47e8ec71a4e 71 //
jack__zen 0:a47e8ec71a4e 72 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
jack__zen 0:a47e8ec71a4e 73 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
jack__zen 0:a47e8ec71a4e 74 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
jack__zen 0:a47e8ec71a4e 75 // IN NO EVENT SHALL DALLAS SEMICONDUCTOR BE LIABLE FOR ANY CLAIM, DAMAGES
jack__zen 0:a47e8ec71a4e 76 // OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
jack__zen 0:a47e8ec71a4e 77 // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
jack__zen 0:a47e8ec71a4e 78 // OTHER DEALINGS IN THE SOFTWARE.
jack__zen 0:a47e8ec71a4e 79 //
jack__zen 0:a47e8ec71a4e 80 // Except as contained in this notice, the name of Dallas Semiconductor
jack__zen 0:a47e8ec71a4e 81 // shall not be used except as stated in the Dallas Semiconductor
jack__zen 0:a47e8ec71a4e 82 // Branding Policy.
jack__zen 0:a47e8ec71a4e 83 //--------------------------------------------------------------------------
jack__zen 0:a47e8ec71a4e 84
jack__zen 0:a47e8ec71a4e 85 #ifndef SNATCH59_ONEWIRECRC_H
jack__zen 0:a47e8ec71a4e 86 #define SNATCH59_ONEWIRECRC_H
jack__zen 0:a47e8ec71a4e 87
jack__zen 0:a47e8ec71a4e 88 #include <mbed.h>
jack__zen 0:a47e8ec71a4e 89
jack__zen 0:a47e8ec71a4e 90 // Select the table-lookup method of computing the 8-bit CRC by setting this to 1
jack__zen 0:a47e8ec71a4e 91 #ifndef ONEWIRE_CRC8_TABLE
jack__zen 0:a47e8ec71a4e 92 #define ONEWIRE_CRC8_TABLE 1
jack__zen 0:a47e8ec71a4e 93 #endif
jack__zen 0:a47e8ec71a4e 94
jack__zen 0:a47e8ec71a4e 95 typedef unsigned char BYTE; // used to be uint8_t : something a byte wide, whatever ....
jack__zen 0:a47e8ec71a4e 96
jack__zen 0:a47e8ec71a4e 97 enum eSpeed {OVERDRIVE, STANDARD};
jack__zen 0:a47e8ec71a4e 98
jack__zen 0:a47e8ec71a4e 99 class OneWireCRC
jack__zen 0:a47e8ec71a4e 100 {
jack__zen 0:a47e8ec71a4e 101 public:
jack__zen 0:a47e8ec71a4e 102 OneWireCRC(PinName oneWire, eSpeed);
jack__zen 0:a47e8ec71a4e 103
jack__zen 0:a47e8ec71a4e 104 // reset, read, write functions
jack__zen 0:a47e8ec71a4e 105 int reset();
jack__zen 0:a47e8ec71a4e 106 void writeByte(int data);
jack__zen 0:a47e8ec71a4e 107 int readByte();
jack__zen 0:a47e8ec71a4e 108 int touchByte(int data);
jack__zen 0:a47e8ec71a4e 109 void block(BYTE* data, int data_len);
jack__zen 0:a47e8ec71a4e 110 int overdriveSkip(BYTE* data, int data_len);
jack__zen 0:a47e8ec71a4e 111
jack__zen 0:a47e8ec71a4e 112 // address functions
jack__zen 0:a47e8ec71a4e 113 void matchROM(BYTE rom[8]);
jack__zen 0:a47e8ec71a4e 114 void skipROM();
jack__zen 0:a47e8ec71a4e 115
jack__zen 0:a47e8ec71a4e 116 // address search functions
jack__zen 0:a47e8ec71a4e 117 void resetSearch();
jack__zen 0:a47e8ec71a4e 118 BYTE search(BYTE* newAddr);
jack__zen 0:a47e8ec71a4e 119
jack__zen 0:a47e8ec71a4e 120 // CRC check functions
jack__zen 0:a47e8ec71a4e 121 static BYTE crc8(BYTE* addr, BYTE len);
jack__zen 0:a47e8ec71a4e 122 static unsigned short crc16(unsigned short* data, unsigned short len);
jack__zen 0:a47e8ec71a4e 123
jack__zen 0:a47e8ec71a4e 124 private:
jack__zen 0:a47e8ec71a4e 125 const int* timing;
jack__zen 0:a47e8ec71a4e 126
jack__zen 0:a47e8ec71a4e 127 BYTE address[8];
jack__zen 0:a47e8ec71a4e 128 int searchJunction; // so we can set to it -1 somewhere
jack__zen 0:a47e8ec71a4e 129 bool searchExhausted;
jack__zen 0:a47e8ec71a4e 130
jack__zen 0:a47e8ec71a4e 131 DigitalInOut oneWirePort;
jack__zen 0:a47e8ec71a4e 132
jack__zen 0:a47e8ec71a4e 133 // read/write bit functions
jack__zen 0:a47e8ec71a4e 134 void writeBit(int bit);
jack__zen 0:a47e8ec71a4e 135 int readBit();
jack__zen 0:a47e8ec71a4e 136 };
jack__zen 0:a47e8ec71a4e 137
jack__zen 0:a47e8ec71a4e 138 #endif