Merge pull request #4 from milesburton/master

test-merge  to get latest from miles burton

Author: RobTillaart

.gitignore

@@ -13,4 +13,4 @@ build
 .classpath
 .settings
 .gradle
-
+.vscode

DallasTemperature.cpp

@@ -3,10 +3,6 @@
 // License as published by the Free Software Foundation; either
 // version 2.1 of the License, or (at your option) any later version.
 
-// Version 3.7.2 modified on Dec 6, 2011 to support Arduino 1.0
-// See Includes...
-// Modified by Jordan Hochenbaum
-
 #include "DallasTemperature.h"
 
 
@@ -18,6 +14,32 @@ extern "C" {
 }
 #endif
 
+// OneWire commands
+#define STARTCONVO      0x44  // Tells device to take a temperature reading and put it on the scratchpad
+#define COPYSCRATCH     0x48  // Copy EEPROM
+#define READSCRATCH     0xBE  // Read EEPROM
+#define WRITESCRATCH    0x4E  // Write to EEPROM
+#define RECALLSCRATCH   0xB8  // Reload from last known
+#define READPOWERSUPPLY 0xB4  // Determine if device needs parasite power
+#define ALARMSEARCH     0xEC  // Query bus for devices with an alarm condition
+
+// Scratchpad locations
+#define TEMP_LSB        0
+#define TEMP_MSB        1
+#define HIGH_ALARM_TEMP 2
+#define LOW_ALARM_TEMP  3
+#define CONFIGURATION   4
+#define INTERNAL_BYTE   5
+#define COUNT_REMAIN    6
+#define COUNT_PER_C     7
+#define SCRATCHPAD_CRC  8
+
+// Device resolution
+#define TEMP_9_BIT  0x1F //  9 bit
+#define TEMP_10_BIT 0x3F // 10 bit
+#define TEMP_11_BIT 0x5F // 11 bit
+#define TEMP_12_BIT 0x7F // 12 bit
+
 DallasTemperature::DallasTemperature() {}
 DallasTemperature::DallasTemperature(OneWire* _oneWire)
 
@@ -28,6 +50,19 @@ DallasTemperature::DallasTemperature(OneWire* _oneWire)
     setOneWire(_oneWire);
 }
 
+bool DallasTemperature::validFamily(const uint8_t* deviceAddress){
+    switch (deviceAddress[0]){
+        case DS18S20MODEL:
+        case DS18B20MODEL:
+        case DS1822MODEL:
+        case DS1825MODEL:
+        case DS28EA00MODEL:
+            return true;
+        default:
+            return false;
+    }
+}
+
 void DallasTemperature::setOneWire(OneWire* _oneWire){
 
     _wire = _oneWire;
@@ -53,10 +88,6 @@ void DallasTemperature::begin(void){
 
             if (!parasite && readPowerSupply(deviceAddress)) parasite = true;
 
-            ScratchPad scratchPad;
-
-            readScratchPad(deviceAddress, scratchPad);
-
             bitResolution = max(bitResolution, getResolution(deviceAddress));
 
             devices++;
@@ -151,9 +182,9 @@ void DallasTemperature::writeScratchPad(const uint8_t* deviceAddress, const uint
     if (deviceAddress[0] != DS18S20MODEL) _wire->write(scratchPad[CONFIGURATION]);
 
     _wire->reset();
-    _wire->select(deviceAddress);
 
     // save the newly written values to eeprom
+    _wire->select(deviceAddress);
     _wire->write(COPYSCRATCH, parasite);
     delay(20);  // <--- added 20ms delay to allow 10ms long EEPROM write operation (as specified by datasheet)
 
@@ -184,14 +215,20 @@ void DallasTemperature::setResolution(uint8_t newResolution){
     for (int i=0; i<devices; i++)
     {
         getAddress(deviceAddress, i);
-        setResolution(deviceAddress, bitResolution);
+        setResolution(deviceAddress, bitResolution, true);
     }
 
 }
 
 // set resolution of a device to 9, 10, 11, or 12 bits
 // if new resolution is out of range, 9 bits is used.
-bool DallasTemperature::setResolution(const uint8_t* deviceAddress, uint8_t newResolution){
+bool DallasTemperature::setResolution(const uint8_t* deviceAddress, uint8_t newResolution, bool skipGlobalBitResolutionCalculation){
+
+	// ensure same behavior as setResolution(uint8_t newResolution)
+	newResolution = constrain(newResolution, 9, 12);
+
+    // return when stored value == new value
+    if(getResolution(deviceAddress) == newResolution) return true;
 
     ScratchPad scratchPad;
     if (isConnected(deviceAddress, scratchPad)){
@@ -215,6 +252,19 @@ bool DallasTemperature::setResolution(const uint8_t* deviceAddress, uint8_t newR
                 break;
             }
             writeScratchPad(deviceAddress, scratchPad);
+
+            // without calculation we can always set it to max
+			bitResolution = max(bitResolution, newResolution);
+
+			if(!skipGlobalBitResolutionCalculation && (bitResolution > newResolution)){
+				bitResolution = newResolution;
+				DeviceAddress deviceAddr;
+				for (int i=0; i<devices; i++)
+				{
+					getAddress(deviceAddr, i);
+					bitResolution = max(bitResolution, getResolution(deviceAddr));
+				}
+			}
         }
         return true;  // new value set
     }
@@ -285,13 +335,10 @@ bool DallasTemperature::getCheckForConversion(){
     return checkForConversion;
 }
 
-bool DallasTemperature::isConversionAvailable(const uint8_t* deviceAddress){
-
-    // Check if the clock has been raised indicating the conversion is complete
-    ScratchPad scratchPad;
-    readScratchPad(deviceAddress, scratchPad);
-    return scratchPad[0];
-
+bool DallasTemperature::isConversionComplete()
+{
+   uint8_t b = _wire->read_bit();
+   return (b == 1);
 }
 
 // sends command for all devices on the bus to perform a temperature conversion
@@ -303,7 +350,7 @@ void DallasTemperature::requestTemperatures(){
 
     // ASYNC mode?
     if (!waitForConversion) return;
-    blockTillConversionComplete(bitResolution, NULL);
+    blockTillConversionComplete(bitResolution);
 
 }
 
@@ -317,35 +364,31 @@ bool DallasTemperature::requestTemperaturesByAddress(const uint8_t* deviceAddres
      return false; //Device disconnected
     }
 
-    if (_wire->reset() == 0){
-        return false;
-    }
-
+    _wire->reset();
     _wire->select(deviceAddress);
     _wire->write(STARTCONVO, parasite);
 
-
     // ASYNC mode?
     if (!waitForConversion) return true;
 
-    blockTillConversionComplete(getResolution(deviceAddress), deviceAddress);
+    blockTillConversionComplete(bitResolution);
 
     return true;
 
 }
 
 
 // Continue to check if the IC has responded with a temperature
-void DallasTemperature::blockTillConversionComplete(uint8_t bitResolution, const uint8_t* deviceAddress){
-    
+void DallasTemperature::blockTillConversionComplete(uint8_t bitResolution){
+
     int delms = millisToWaitForConversion(bitResolution);
-    if (deviceAddress != NULL && checkForConversion && !parasite){
+    if (checkForConversion && !parasite){
         unsigned long now = millis();
-        while(!isConversionAvailable(deviceAddress) && (millis() - delms < now));
+        while(!isConversionComplete() && (millis() - delms < now));
     } else {
         delay(delms);
     }
-    
+
 }
 
 // returns number of milliseconds to wait till conversion is complete (based on IC datasheet)
@@ -488,6 +531,9 @@ bool DallasTemperature::isParasitePowerMode(void){
 // note if device is not connected it will fail writing the data.
 void DallasTemperature::setUserData(const uint8_t* deviceAddress, int16_t data)
 {
+    // return when stored value == new value
+    if(getUserData(deviceAddress) == data) return;
+
     ScratchPad scratchPad;
     if (isConnected(deviceAddress, scratchPad))
     {
@@ -583,6 +629,9 @@ the next temperature conversion.
 // after a decimal point.  valid range is -55C - 125C
 void DallasTemperature::setHighAlarmTemp(const uint8_t* deviceAddress, char celsius){
 
+    // return when stored value == new value
+    if(getHighAlarmTemp(deviceAddress) == celsius) return;
+
     // make sure the alarm temperature is within the device's range
     if (celsius > 125) celsius = 125;
     else if (celsius < -55) celsius = -55;
@@ -599,6 +648,10 @@ void DallasTemperature::setHighAlarmTemp(const uint8_t* deviceAddress, char cels
 // accepts a float, but the alarm resolution will ignore anything
 // after a decimal point.  valid range is -55C - 125C
 void DallasTemperature::setLowAlarmTemp(const uint8_t* deviceAddress, char celsius){
+
+    // return when stored value == new value
+    if(getLowAlarmTemp(deviceAddress) == celsius) return;
+
     // make sure the alarm temperature is within the device's range
     if (celsius > 125) celsius = 125;
     else if (celsius < -55) celsius = -55;

DallasTemperature.h

@@ -1,7 +1,7 @@
 #ifndef DallasTemperature_h
 #define DallasTemperature_h
 
-#define DALLASTEMPLIBVERSION "3.7.3"
+#define DALLASTEMPLIBVERSION "3.7.7" // To be deprecated
 
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
@@ -26,32 +26,7 @@
 #define DS18B20MODEL 0x28
 #define DS1822MODEL  0x22
 #define DS1825MODEL  0x3B
-
-// OneWire commands
-#define STARTCONVO      0x44  // Tells device to take a temperature reading and put it on the scratchpad
-#define COPYSCRATCH     0x48  // Copy EEPROM
-#define READSCRATCH     0xBE  // Read EEPROM
-#define WRITESCRATCH    0x4E  // Write to EEPROM
-#define RECALLSCRATCH   0xB8  // Reload from last known
-#define READPOWERSUPPLY 0xB4  // Determine if device needs parasite power
-#define ALARMSEARCH     0xEC  // Query bus for devices with an alarm condition
-
-// Scratchpad locations
-#define TEMP_LSB        0
-#define TEMP_MSB        1
-#define HIGH_ALARM_TEMP 2
-#define LOW_ALARM_TEMP  3
-#define CONFIGURATION   4
-#define INTERNAL_BYTE   5
-#define COUNT_REMAIN    6
-#define COUNT_PER_C     7
-#define SCRATCHPAD_CRC  8
-
-// Device resolution
-#define TEMP_9_BIT  0x1F //  9 bit
-#define TEMP_10_BIT 0x3F // 10 bit
-#define TEMP_11_BIT 0x5F // 11 bit
-#define TEMP_12_BIT 0x7F // 12 bit
+#define DS28EA00MODEL 0x42
 
 // Error Codes
 #define DEVICE_DISCONNECTED_C -127
@@ -78,6 +53,9 @@ class DallasTemperature
     // returns true if address is valid
     bool validAddress(const uint8_t*);
 
+    // returns true if address is of the family of sensors the lib supports.
+    bool validFamily(const uint8_t* deviceAddress);
+
     // finds an address at a given index on the bus
     bool getAddress(uint8_t*, uint8_t);
 
@@ -107,7 +85,7 @@ class DallasTemperature
     uint8_t getResolution(const uint8_t*);
 
     // set resolution of a device to 9, 10, 11, or 12 bits
-    bool setResolution(const uint8_t*, uint8_t);
+    bool setResolution(const uint8_t*, uint8_t, bool skipGlobalBitResolutionCalculation = false);
 
     // sets/gets the waitForConversion flag
     void setWaitForConversion(bool);
@@ -126,7 +104,7 @@ class DallasTemperature
     // sends command for one device to perform a temperature conversion by index
     bool requestTemperaturesByIndex(uint8_t);
 
-    // returns temperature raw value (12 bit integer of 1/16 degrees C)
+    // returns temperature raw value (12 bit integer of 1/128 degrees C)
     int16_t getTemp(const uint8_t*);
 
     // returns temperature in degrees C
@@ -144,7 +122,10 @@ class DallasTemperature
     // returns true if the bus requires parasite power
     bool isParasitePowerMode(void);
 
-    bool isConversionAvailable(const uint8_t*);
+     // Is a conversion complete on the wire?
+    bool isConversionComplete(void);
+
+    int16_t millisToWaitForConversion(uint8_t);
 
 #if REQUIRESALARMS
 
@@ -246,9 +227,7 @@ class DallasTemperature
     // reads scratchpad and returns the raw temperature
     int16_t calculateTemperature(const uint8_t*, uint8_t*);
 
-    int16_t millisToWaitForConversion(uint8_t);
-
-    void	blockTillConversionComplete(uint8_t, const uint8_t*);
+    void	blockTillConversionComplete(uint8_t);
 
 #if REQUIRESALARMS
 
@@ -263,4 +242,4 @@ class DallasTemperature
 #endif
 
 };
-#endif
+#endif

README.md

@@ -9,6 +9,7 @@ This library supports the following devices :
 * DS18S20 - Please note there appears to be an issue with this series.
 * DS1822
 * DS1820
+* MAX31820
 
 
 You will need a pull-up resistor of about 5 KOhm between the 1-Wire data line