Merge pull request #129 from roboprint/master

Non-blocking Dallas sensors temperature conversion

Author: henrikekblad

libraries/DallasTemperature/DallasTemperature.cpp

@@ -1,6 +1,8 @@
 #ifndef DallasTemperature_h
 #define DallasTemperature_h
 
+#define DALLASTEMPLIBVERSION "3.7.2"
+
 // 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
@@ -20,9 +22,10 @@
 #include <OneWire.h>
 
 // Model IDs
-#define DS18S20MODEL 0x10
+#define DS18S20MODEL 0x10  // also DS1820
 #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
@@ -51,7 +54,9 @@
 #define TEMP_12_BIT 0x7F // 12 bit
 
 // Error Codes
-#define DEVICE_DISCONNECTED -127
+#define DEVICE_DISCONNECTED_C -127
+#define DEVICE_DISCONNECTED_F -196.6
+#define DEVICE_DISCONNECTED_RAW -7040
 
 typedef uint8_t DeviceAddress[8];
 
@@ -61,54 +66,74 @@ class DallasTemperature
 
   DallasTemperature(OneWire*);
 
-  // initalize bus
+  // initialise bus
   void begin(void);
 
   // returns the number of devices found on the bus
   uint8_t getDeviceCount(void);
 
   // returns true if address is valid
-  bool validAddress(uint8_t*);
+  bool validAddress(const uint8_t*);
 
   // finds an address at a given index on the bus 
-  bool getAddress(uint8_t*, const uint8_t);
+  bool getAddress(uint8_t*, uint8_t);
 
   // attempt to determine if the device at the given address is connected to the bus
-  bool isConnected(uint8_t*);
+  bool isConnected(const uint8_t*);
 
   // attempt to determine if the device at the given address is connected to the bus
   // also allows for updating the read scratchpad
-  bool isConnected(uint8_t*, uint8_t*);
+  bool isConnected(const uint8_t*, uint8_t*);
 
   // read device's scratchpad
-  void readScratchPad(uint8_t*, uint8_t*);
+  void readScratchPad(const uint8_t*, uint8_t*);
 
   // write device's scratchpad
-  void writeScratchPad(uint8_t*, const uint8_t*);
+  void writeScratchPad(const uint8_t*, const uint8_t*);
 
   // read device's power requirements
-  bool readPowerSupply(uint8_t*);
+  bool readPowerSupply(const uint8_t*);
 
-  // returns the current resolution, 9-12
-  uint8_t getResolution(uint8_t*);
+  // get global resolution
+  uint8_t getResolution();
+  
+  // set global resolution to 9, 10, 11, or 12 bits
+  void setResolution(uint8_t);
 
-  // set resolution of a device to 9, 10, 11, or 12 bits
-  void setResolution(uint8_t*, uint8_t);
+  // returns the device resolution: 9, 10, 11, or 12 bits
+  uint8_t getResolution(const uint8_t*);
 
-  // sends command for all devices on the bus to perform a temperature conversion
+  // set resolution of a device to 9, 10, 11, or 12 bits
+  bool setResolution(const uint8_t*, uint8_t);
+  
+  // sets/gets the waitForConversion flag
+  void setWaitForConversion(bool);
+  bool getWaitForConversion(void);
+  
+  // sets/gets the checkForConversion flag
+  void setCheckForConversion(bool);
+  bool getCheckForConversion(void);
+  
+  // sends command for all devices on the bus to perform a temperature conversion 
   void requestTemperatures(void);
-   
+
+  // returns time to wait for a temperature conversion based on given resolution 
+  int16_t millisToWaitForConversion(uint8_t);
+
   // sends command for one device to perform a temperature conversion by address
-  void requestTemperaturesByAddress(uint8_t*);
+  bool requestTemperaturesByAddress(const uint8_t*);
 
   // sends command for one device to perform a temperature conversion by index
-  void requestTemperaturesByIndex(uint8_t);
+  bool requestTemperaturesByIndex(uint8_t);
+
+  // returns temperature raw value (12 bit integer of 1/16 degrees C)
+  int16_t getTemp(const uint8_t*);
 
   // returns temperature in degrees C
-  float getTempC(uint8_t*);
+  float getTempC(const uint8_t*);
 
   // returns temperature in degrees F
-  float getTempF(uint8_t*);
+  float getTempF(const uint8_t*);
 
   // Get temperature for device index (slow)
   float getTempCByIndex(uint8_t);
@@ -118,26 +143,28 @@ class DallasTemperature
 
   // returns true if the bus requires parasite power
   bool isParasitePowerMode(void);
+  
+  bool isConversionAvailable(const uint8_t*);
 
   #if REQUIRESALARMS
 
-  typedef void AlarmHandler(uint8_t*);
+  typedef void AlarmHandler(const uint8_t*);
 
   // sets the high alarm temperature for a device
   // accepts a char.  valid range is -55C - 125C
-  void setHighAlarmTemp(uint8_t*, const char);
+  void setHighAlarmTemp(const uint8_t*, char);
 
   // sets the low alarm temperature for a device
   // accepts a char.  valid range is -55C - 125C
-  void setLowAlarmTemp(uint8_t*, const char);
+  void setLowAlarmTemp(const uint8_t*, char);
 
   // returns a signed char with the current high alarm temperature for a device
   // in the range -55C - 125C
-  char getHighAlarmTemp(uint8_t*);
+  char getHighAlarmTemp(const uint8_t*);
 
   // returns a signed char with the current low alarm temperature for a device
   // in the range -55C - 125C
-  char getLowAlarmTemp(uint8_t*);
+  char getLowAlarmTemp(const uint8_t*);
 
   // resets internal variables used for the alarm search
   void resetAlarmSearch(void);
@@ -146,7 +173,7 @@ class DallasTemperature
   bool alarmSearch(uint8_t*);
 
   // returns true if ia specific device has an alarm
-  bool hasAlarm(uint8_t*);
+  bool hasAlarm(const uint8_t*);
 
   // returns true if any device is reporting an alarm on the bus
   bool hasAlarm(void);
@@ -155,22 +182,28 @@ class DallasTemperature
   void processAlarms(void);
 
   // sets the alarm handler
-  void setAlarmHandler(AlarmHandler *);
+  void setAlarmHandler(const AlarmHandler *);
 
   // The default alarm handler
-  static void defaultAlarmHandler(uint8_t*);
+  static void defaultAlarmHandler(const uint8_t*);
 
   #endif
 
-  // convert from celcius to farenheit
-  static float toFahrenheit(const float);
+  // convert from Celsius to Fahrenheit
+  static float toFahrenheit(float);
+
+  // convert from Fahrenheit to Celsius
+  static float toCelsius(float);
 
-  // convert from farenheit to celsius
-  static float toCelsius(const float);
+  // convert from raw to Celsius
+  static float rawToCelsius(int16_t);
+
+  // convert from raw to Fahrenheit
+  static float rawToFahrenheit(int16_t);
 
   #if REQUIRESNEW
 
-  // initalize memory area
+  // initialize memory area
   void* operator new (unsigned int);
 
   // delete memory reference
@@ -186,16 +219,24 @@ class DallasTemperature
 
   // used to determine the delay amount needed to allow for the
   // temperature conversion to take place
-  int conversionDelay;
-
+  uint8_t bitResolution;
+  
+  // used to requestTemperature with or without delay
+  bool waitForConversion;
+  
+  // used to requestTemperature to dynamically check if a conversion is complete
+  bool checkForConversion;
+  
   // count of devices on the bus
   uint8_t devices;
 
   // Take a pointer to one wire instance
   OneWire* _wire;
 
-  // reads scratchpad and returns the temperature in degrees C
-  float calculateTemperature(uint8_t*, uint8_t*);
+  // reads scratchpad and returns the raw temperature
+  int16_t calculateTemperature(const uint8_t*, uint8_t*);
+  
+  void	blockTillConversionComplete(uint8_t, const uint8_t*);
 
   #if REQUIRESALARMS
 

libraries/DallasTemperature/DallasTemperature.h

@@ -4,18 +4,33 @@ Arduino Library for Dallas Temperature ICs
 Usage
 -----
 
-This library supports the following devices:
-    DS18B20
-    DS18S20 - Please note there appears to be an issue with this series.
-    DS1822
+This library supports the following devices :
+
+
+* DS18B20
+* DS18S20 - Please note there appears to be an issue with this series.
+* DS1822
+* DS1820
+
 
 You will need a pull-up resistor of about 5 KOhm between the 1-Wire data line
 and your 5V power. If you are using the DS18B20, ground pins 1 and 3. The
 centre pin is the data line '1-wire'.
 
 We have included a "REQUIRESNEW" and "REQUIRESALARMS" definition. If you 
 want to slim down the code feel free to use either of these by including
-#define REQUIRESNEW or #define REQUIRESALARMS a the top of DallasTemperature.h
+
+
+
+	#define REQUIRESNEW 
+
+or 
+
+	#define REQUIRESALARMS
+
+
+at the top of DallasTemperature.h
+
 
 Credits
 -------
@@ -26,6 +41,8 @@ Miles Burton <[email protected]> originally developed this library.
 Tim Newsome <[email protected]> added support for multiple sensors on
 the same bus.
 Guil Barros [[email protected]] added getTempByAddress (v3.5)
+Rob Tillaart [[email protected]] added async modus (v3.7.0)
+
 
 Website
 -------

libraries/DallasTemperature/README renamed to libraries/DallasTemperature/README.md

@@ -0,0 +1,85 @@
+
+This file contains the change history of the Dallas Temperature Control Library.
+
+VERSION 3.7.2 BETA
+===================
+DATE: 6 DEC  2011
+
+- Jordan Hochenbaum [[email protected]] updated library for compatibility with Arduino 1.0.
+
+VERSION 3.7.0 BETA
+===================
+DATE: 11 JAN  2011
+
+- Rob Tillaart [[email protected]] added async modus (v3.7.0)
+  The library is backwards compatible with version 3.6.0
+
+  MAJOR: async modus
+  ------------------
+- Added - private bool waitForConversion. 
+This boolean is default set to true in the Constructor to keep the library backwards compatible. If this flag is true calls to requestTemperatures(), requestTemperaturesByAddress() et al, will be blocking with the appropiate time specified (in datasheet) for the resolution used. If the flag is set to false, requestTemperatures() et al, will return immediately after the conversion command is send over the 1-wire interface. The programmer is responsible to wait long enough before reading the temperature values. This enables the application to do other things while waiting for a new reading, like calculations, update LCD, read/write other IO lines etc. See examples.
+
+- Added - void setWaitForConversion(bool); 
+To set the flag to true or false, depending on the modus needed.
+
+- Added - bool getWaitForConversion(void); 
+To get the current value of the flag.
+
+- Changed - void requestTemperatures(void);
+Added a test (false == waitForConversion) to return immediately after the conversion command instead of waiting until the conversion is ready.
+ 
+- Changed - bool requestTemperaturesByAddress(uint8_t*); 
+Added a test (false == waitForConversion) to return immediately after the conversion command instead of waiting until the conversion is ready.
+
+
+  MINOR version number
+  --------------------
+- Added - #define DALLASTEMPLIBVERSION "3.7.0" 
+To indicate the version number in .h file 
+  
+  
+  MINOR internal var bitResolution
+  ----------------------------
+- Changed - private int conversionDelay - is renamed to - private int bitResolution
+As this variable holds the resolution. The delay for the conversion is derived from it.
+
+- Changed - uint8_t getResolution(uint8_t* deviceAddress);
+If the device is not connected, it returns 0, otherwise it returns the resolution of the device.
+
+- Changed - bool setResolution(uint8_t* deviceAddress, uint8_t newResolution);
+If the device is not connected, it returns FALSE (fail), otherwise it returns TRUE (succes).
+
+- Added - uint8_t getResolution();
+Returns bitResolution.
+
+- Added - void setResolution(uint8_t newResolution)
+Sets the internal variable bitResolution, and all devices to this value
+
+
+  MINOR check connected state
+  ----------------------------
+- Changed - bool requestTemperaturesByIndex(deviceIndex) 
+Changed return type from void to bool. The function returns false if the device identified with [deviceIndex] is not found on the bus and true otherwise.
+
+- Changed - bool requestTemperaturesByAddress(deviceAddress)
+Changed return type from void to bool. The function returns false if the device identified with [deviceAddress] is not found on the bus and true otherwise.
+Added code to handle the DS18S20 which has a 9 bit resolution separately.
+Changed code so the blocking delay matches the bitResolution set in the device with deviceAddress.
+
+- Changed - bool requestTemperaturesByIndex(uint8_t deviceIndex)
+Changed return type from void to bool. The function returns false if the device identified with [deviceIndex] is not found on the bus and true otherwise.
+
+
+
+VERSION 3.6.0
+==============
+DATE: 2010-10-10
+
+- no detailed change history known except:
+
+- The OneWire code has been derived from
+http://www.arduino.cc/playground/Learning/OneWire.
+- Miles Burton <[email protected]> originally developed this library.
+- Tim Newsome <[email protected]> added support for multiple sensors on
+the same bus.
+- Guil Barros [[email protected]] added getTempByAddress (v3.5)

libraries/DallasTemperature/change.txt

@@ -2,7 +2,7 @@
 #include <DallasTemperature.h>
 
 // Data wire is plugged into port 2 on the Arduino
-#define ONE_WIRE_BUS 3
+#define ONE_WIRE_BUS 2
 
 // Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
 OneWire oneWire(ONE_WIRE_BUS);

libraries/DallasTemperature/examples/Alarm/Alarm.pde

@@ -2,8 +2,7 @@
 #include <DallasTemperature.h>
 
 // Data wire is plugged into port 2 on the Arduino
-#define ONE_WIRE_BUS 3
-#define TEMPERATURE_PRECISION 9
+#define ONE_WIRE_BUS 2
 
 // Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
 OneWire oneWire(ONE_WIRE_BUS);