Merge branch 'master' of https://github.com/MilesBurton/Arduino-Temperature-Control-Library into miles

Author: RobTillaart

DallasTemperature.cpp

@@ -1,4 +1,4 @@
-// This library is free software; you can redistribute it and/or
+// This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
 // version 2.1 of the License, or (at your option) any later version.
@@ -93,6 +93,7 @@ void DallasTemperature::setOneWire(OneWire* _oneWire) {
 bitResolution = 9;
 waitForConversion = true;
 checkForConversion = true;
+ autoSaveScratchPad = true;
 
 }
 
@@ -216,20 +217,10 @@ void DallasTemperature::writeScratchPad(const uint8_t* deviceAddress,
 if (deviceAddress[0] != DS18S20MODEL)
 _wire->write(scratchPad[CONFIGURATION]);
 
-_wire->reset();
-
-// 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)
-
- if (parasite) {
-activateExternalPullup();
-delay(10); // 10ms delay
-deactivateExternalPullup();
-}
+ if (autoSaveScratchPad)
+ saveScratchPad(deviceAddress);
+ else
  _wire->reset();
-
 }
 
 // returns true if parasite mode is used (2 wire)
@@ -474,6 +465,94 @@ int16_t DallasTemperature::millisToWaitForConversion(uint8_t bitResolution) {
 
 }
 
+// Sends command to one device to save values from scratchpad to EEPROM by index
+// Returns true if no errors were encountered, false indicates failure
+bool DallasTemperature::saveScratchPadByIndex(uint8_t deviceIndex) {
+ 
+ DeviceAddress deviceAddress;
+ if (!getAddress(deviceAddress, deviceIndex)) return false;
+ 
+ return saveScratchPad(deviceAddress);
+ 
+}
+
+// Sends command to one or more devices to save values from scratchpad to EEPROM
+// If optional argument deviceAddress is omitted the command is send to all devices
+// Returns true if no errors were encountered, false indicates failure
+bool DallasTemperature::saveScratchPad(const uint8_t* deviceAddress) {
+ 
+ if (_wire->reset() == 0)
+ return false;
+ 
+ if (deviceAddress == nullptr)
+ _wire->skip();
+ else
+ _wire->select(deviceAddress);
+ 
+ _wire->write(COPYSCRATCH,parasite);
+
+ // Specification: NV Write Cycle Time is typically 2ms, max 10ms
+ // Waiting 20ms to allow for sensors that take longer in practice
+ if (!parasite) {
+ delay(20);
+ } else {
+ activateExternalPullup();
+ delay(20);
+ deactivateExternalPullup();
+ }
+ 
+ return _wire->reset() == 1;
+ 
+}
+
+// Sends command to one device to recall values from EEPROM to scratchpad by index
+// Returns true if no errors were encountered, false indicates failure
+bool DallasTemperature::recallScratchPadByIndex(uint8_t deviceIndex) {
+
+ DeviceAddress deviceAddress;
+ if (!getAddress(deviceAddress, deviceIndex)) return false;
+ 
+ return recallScratchPad(deviceAddress);
+
+}
+
+// Sends command to one or more devices to recall values from EEPROM to scratchpad
+// If optional argument deviceAddress is omitted the command is send to all devices
+// Returns true if no errors were encountered, false indicates failure
+bool DallasTemperature::recallScratchPad(const uint8_t* deviceAddress) {
+ 
+ if (_wire->reset() == 0)
+ return false;
+ 
+ if (deviceAddress == nullptr)
+ _wire->skip();
+ else
+ _wire->select(deviceAddress);
+ 
+ _wire->write(RECALLSCRATCH,parasite);
+
+ // Specification: Strong pullup only needed when writing to EEPROM (and temp conversion)
+ unsigned long start = millis();
+ while (_wire->read_bit() == 0) {
+ // Datasheet doesn't specify typical/max duration, testing reveals typically within 1ms
+ if (millis() - start > 20) return false;
+ yield();
+ }
+ 
+ return _wire->reset() == 1;
+ 
+}
+
+// Sets the autoSaveScratchPad flag
+void DallasTemperature::setAutoSaveScratchPad(bool flag) {
+ autoSaveScratchPad = flag;
+}
+
+// Gets the autoSaveScratchPad flag
+bool DallasTemperature::getAutoSaveScratchPad() {
+ return autoSaveScratchPad;
+}
+
 void DallasTemperature::activateExternalPullup() {
 if(useExternalPullup)
 digitalWrite(pullupPin, LOW);

DallasTemperature.h

@@ -27,7 +27,7 @@
 
 // Model IDs
 #define DS18S20MODEL 0x10 // also DS1820
-#define DS18B20MODEL 0x28
+#define DS18B20MODEL 0x28 // also MAX31820
 #define DS1822MODEL 0x22
 #define DS1825MODEL 0x3B
 #define DS28EA00MODEL 0x42
@@ -140,7 +140,29 @@ class DallasTemperature {
 // Is a conversion complete on the wire? Only applies to the first sensor on the wire.
 bool isConversionComplete(void);
 
- int16_t millisToWaitForConversion(uint8_t);
+ int16_t millisToWaitForConversion(uint8_t);
+ 
+ // Sends command to one device to save values from scratchpad to EEPROM by index
+ // Returns true if no errors were encountered, false indicates failure
+ bool saveScratchPadByIndex(uint8_t);
+ 
+ // Sends command to one or more devices to save values from scratchpad to EEPROM
+ // Returns true if no errors were encountered, false indicates failure
+ bool saveScratchPad(const uint8_t* = nullptr);
+ 
+ // Sends command to one device to recall values from EEPROM to scratchpad by index
+ // Returns true if no errors were encountered, false indicates failure
+ bool recallScratchPadByIndex(uint8_t);
+ 
+ // Sends command to one or more devices to recall values from EEPROM to scratchpad
+ // Returns true if no errors were encountered, false indicates failure
+ bool recallScratchPad(const uint8_t* = nullptr);
+ 
+ // Sets the autoSaveScratchPad flag
+ void setAutoSaveScratchPad(bool);
+ 
+ // Gets the autoSaveScratchPad flag
+ bool getAutoSaveScratchPad(void);
 
 #if REQUIRESALARMS
 
@@ -237,6 +259,9 @@ class DallasTemperature {
 // used to requestTemperature to dynamically check if a conversion is complete
 bool checkForConversion;
 
+ // used to determine if values will be saved from scratchpad to EEPROM on every scratchpad write
+ bool autoSaveScratchPad;
+
 // count of devices on the bus
 uint8_t devices;
 

examples/SaveRecallScratchPad/SaveRecallScratchPad.ino

@@ -0,0 +1,106 @@
+//
+// FILE: SaveRecallScratchPad.ino
+// AUTHOR: GitKomodo
+// VERSION: 0.0.1
+// PURPOSE: Show DallasTemperature lib functionality to
+// save/recall ScratchPad values to/from EEPROM
+//
+// HISTORY:
+// 0.0.1 = 2020-02-18 initial version
+//
+
+#include <OneWire.h>
+#include <DallasTemperature.h>
+
+#define ONE_WIRE_BUS 2
+
+OneWire oneWire(ONE_WIRE_BUS);
+DallasTemperature sensors(&oneWire);
+DeviceAddress deviceAddress;
+
+void setup()
+{
+ Serial.begin(9600);
+ Serial.println(__FILE__);
+ Serial.println("Dallas Temperature Demo");
+ 
+ sensors.begin();
+ 
+ // Get ID of first sensor (at index 0)
+ sensors.getAddress(deviceAddress,0);
+
+ // By default configuration and alarm/userdata registers are also saved to EEPROM
+ // when they're changed. Sensors recall these values automatically when powered up.
+ 
+ // Turn OFF automatic saving of configuration and alarm/userdata registers to EEPROM
+ sensors.setAutoSaveScratchPad(false);
+ 
+ // Change configuration and alarm/userdata registers on the scratchpad
+ int8_t resolution = 12;
+ sensors.setResolution(deviceAddress,resolution);
+ int16_t userdata = 24680;
+ sensors.setUserData(deviceAddress,userdata);
+
+ // Save configuration and alarm/userdata registers to EEPROM
+ sensors.saveScratchPad(deviceAddress);
+
+ // saveScratchPad can also be used without a parameter to save the configuration
+ // and alarm/userdata registers of ALL connected sensors to EEPROM:
+ //
+ // sensors.saveScratchPad();
+ //
+ // Or the configuration and alarm/userdata registers of a sensor can be saved to
+ // EEPROM by index:
+ //
+ // sensors.saveScratchPadByIndex(0);
+ 
+ // Print current values on the scratchpad (resolution = 12, userdata = 24680)
+ printValues();
+ 
+}
+
+void loop(){
+ 
+ // Change configuration and alarm/userdata registers on the scratchpad
+ int8_t resolution = 10;
+ sensors.setResolution(deviceAddress,resolution);
+ int16_t userdata = 12345;
+ sensors.setUserData(deviceAddress,userdata);
+ 
+ // Print current values on the scratchpad (resolution = 10, userdata = 12345)
+ printValues();
+ 
+ delay(2000);
+ 
+ // Recall configuration and alarm/userdata registers from EEPROM
+ sensors.recallScratchPad(deviceAddress);
+ 
+ // recallScratchPad can also be used without a parameter to recall the configuration
+ // and alarm/userdata registers of ALL connected sensors from EEPROM:
+ //
+ // sensors.recallScratchPad();
+ //
+ // Or the configuration and alarm/userdata registers of a sensor can be recalled
+ // from EEPROM by index:
+ //
+ // sensors.recallScratchPadByIndex(0);
+ 
+ // Print current values on the scratchpad (resolution = 12, userdata = 24680)
+ printValues();
+ 
+ delay(2000);
+ 
+}
+
+void printValues() {
+ 
+ Serial.println();
+ Serial.println("Current values on the scratchpad:");
+ 
+ Serial.print("Resolution:\t");
+ Serial.println(sensors.getResolution(deviceAddress));
+ 
+ Serial.print("User data:\t");
+ Serial.println(sensors.getUserData(deviceAddress));
+ 
+}

keywords.txt

@@ -14,27 +14,44 @@ DeviceAddress	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
+setOneWire	KEYWORD2
+setPullupPin	KEYWORD2
 setResolution	KEYWORD2
 getResolution	KEYWORD2
+getTemp	KEYWORD2
 getTempC	KEYWORD2
 toFahrenheit	KEYWORD2
 getTempF	KEYWORD2
 getTempCByIndex	KEYWORD2
 getTempFByIndex	KEYWORD2
+rawToCelsius	KEYWORD2
+rawToFahrenheit	KEYWORD2
 setWaitForConversion	KEYWORD2
 getWaitForConversion	KEYWORD2
 requestTemperatures	KEYWORD2
 requestTemperaturesByAddress	KEYWORD2
 requestTemperaturesByIndex	KEYWORD2
+setCheckForConversion	KEYWORD2
+getCheckForConversion	KEYWORD2
+isConversionComplete	KEYWORD2
+millisToWaitForConversion	KEYWORD2
 isParasitePowerMode	KEYWORD2
 begin	KEYWORD2
 getDeviceCount	KEYWORD2
+getDS18Count	KEYWORD2
 getAddress	KEYWORD2
 validAddress	KEYWORD2
+validFamily	KEYWORD2
 isConnected	KEYWORD2
 readScratchPad	KEYWORD2
 writeScratchPad	KEYWORD2
 readPowerSupply	KEYWORD2
+saveScratchPadByIndex	KEYWORD2
+saveScratchPad	KEYWORD2
+recallScratchPadByIndex	KEYWORD2
+recallScratchPad	KEYWORD2
+setAutoSaveScratchPad	KEYWORD2
+getAutoSaveScratchPad	KEYWORD2
 setHighAlarmTemp	KEYWORD2
 setLowAlarmTemp	KEYWORD2
 getHighAlarmTemp	KEYWORD2
@@ -43,12 +60,19 @@ resetAlarmSearch	KEYWORD2
 alarmSearch	KEYWORD2
 hasAlarm	KEYWORD2
 toCelsius	KEYWORD2
-processAlarmss	KEYWORD2
-setAlarmHandlers	KEYWORD2
-defaultAlarmHandler	KEYWORD2
+processAlarms	KEYWORD2
+setAlarmHandler	KEYWORD2
+hasAlarmHandler	KEYWORD2
+setUserData	KEYWORD2
+setUserDataByIndex	KEYWORD2
+getUserData	KEYWORD2
+getUserDataByIndex	KEYWORD2
 calculateTemperature	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)
 #######################################
 
+DEVICE_DISCONNECTED_C	LITERAL1
+DEVICE_DISCONNECTED_F	LITERAL1
+DEVICE_DISCONNECTED_RAW	LITERAL1