Merge pull request #41 from mvhconsult/master

milesburton · milesburton · commit c4bb43f00190 · 2015-09-09T12:55:12.000+01:00
Updated some comments and descriptions
diff --git a/examples/Multiple/Multiple.pde b/examples/Multiple/Multiple.pde
@@ -1,3 +1,4 @@
+// Include the libraries we need
 #include <OneWire.h>
 #include <DallasTemperature.h>
 
@@ -34,14 +35,14 @@ void setup(void)
   if (sensors.isParasitePowerMode()) Serial.println("ON");
   else Serial.println("OFF");
 
-  // assign address manually.  the addresses below will beed to be changed
-  // to valid device addresses on your bus.  device address can be retrieved
+  // Assign address manually. The addresses below will beed to be changed
+  // to valid device addresses on your bus. Device address can be retrieved
   // by using either oneWire.search(deviceAddress) or individually via
   // sensors.getAddress(deviceAddress, index)
   //insideThermometer = { 0x28, 0x1D, 0x39, 0x31, 0x2, 0x0, 0x0, 0xF0 };
   //outsideThermometer   = { 0x28, 0x3F, 0x1C, 0x31, 0x2, 0x0, 0x0, 0x2 };
 
-  // search for devices on the bus and assign based on an index.  ideally,
+  // Search for devices on the bus and assign based on an index. Ideally,
   // you would do this to initially discover addresses on the bus and then 
   // use those addresses and manually assign them (see above) once you know 
   // the devices on your bus (and assuming they don't change).
@@ -53,8 +54,8 @@ void setup(void)
   // method 2: search()
   // search() looks for the next device. Returns 1 if a new address has been
   // returned. A zero might mean that the bus is shorted, there are no devices, 
-  // or you have already retrieved all of them.  It might be a good idea to 
-  // check the CRC to make sure you didn't get garbage.  The order is 
+  // or you have already retrieved all of them. It might be a good idea to 
+  // check the CRC to make sure you didn't get garbage. The order is 
   // deterministic. You will always get the same devices in the same order
   //
   // Must be called before search()
@@ -73,7 +74,7 @@ void setup(void)
   printAddress(outsideThermometer);
   Serial.println();
 
-  // set the resolution to 9 bit
+  // set the resolution to 9 bit per device
   sensors.setResolution(insideThermometer, TEMPERATURE_PRECISION);
   sensors.setResolution(outsideThermometer, TEMPERATURE_PRECISION);
 
@@ -125,6 +126,9 @@ void printData(DeviceAddress deviceAddress)
   Serial.println();
 }
 
+/*
+ * Main function, calls the temperatures in a loop.
+ */
 void loop(void)
 { 
   // call sensors.requestTemperatures() to issue a global temperature 
diff --git a/examples/Simple/Simple.pde b/examples/Simple/Simple.pde
@@ -1,3 +1,4 @@
+// Include the libraries we need
 #include <OneWire.h>
 #include <DallasTemperature.h>
 
@@ -10,6 +11,9 @@ OneWire oneWire(ONE_WIRE_BUS);
 // Pass our oneWire reference to Dallas Temperature. 
 DallasTemperature sensors(&oneWire);
 
+/*
+ * The setup function. We only start the sensors here
+ */
 void setup(void)
 {
   // start serial port
@@ -20,14 +24,18 @@ void setup(void)
   sensors.begin();
 }
 
+/*
+ * Main function, get and show the temperature
+ */
 void loop(void)
 { 
   // call sensors.requestTemperatures() to issue a global temperature 
   // request to all devices on the bus
   Serial.print("Requesting temperatures...");
   sensors.requestTemperatures(); // Send the command to get temperatures
   Serial.println("DONE");
-  
+  // After we got the temperatures, we can print them here.
+  // We use the function ByIndex, and as an example get the temperature from the first sensor only.
   Serial.print("Temperature for the device 1 (index 0) is: ");
   Serial.println(sensors.getTempCByIndex(0));  
 }
diff --git a/examples/Single/Single.pde b/examples/Single/Single.pde
@@ -1,3 +1,4 @@
+// Include the libraries we need
 #include <OneWire.h>
 #include <DallasTemperature.h>
 
@@ -13,6 +14,9 @@ DallasTemperature sensors(&oneWire);
 // arrays to hold device address
 DeviceAddress insideThermometer;
 
+/*
+ * Setup function. Here we do the basics
+ */
 void setup(void)
 {
   // start serial port
@@ -31,14 +35,15 @@ void setup(void)
   if (sensors.isParasitePowerMode()) Serial.println("ON");
   else Serial.println("OFF");
   
-  // assign address manually.  the addresses below will beed to be changed
-  // to valid device addresses on your bus.  device address can be retrieved
+  // Assign address manually. The addresses below will beed to be changed
+  // to valid device addresses on your bus. Device address can be retrieved
   // by using either oneWire.search(deviceAddress) or individually via
   // sensors.getAddress(deviceAddress, index)
+  // Note that you will need to use your specific address here
   //insideThermometer = { 0x28, 0x1D, 0x39, 0x31, 0x2, 0x0, 0x0, 0xF0 };
 
   // Method 1:
-  // search for devices on the bus and assign based on an index.  ideally,
+  // Search for devices on the bus and assign based on an index. Ideally,
   // you would do this to initially discover addresses on the bus and then 
   // use those addresses and manually assign them (see above) once you know 
   // the devices on your bus (and assuming they don't change).
@@ -47,8 +52,8 @@ void setup(void)
   // method 2: search()
   // search() looks for the next device. Returns 1 if a new address has been
   // returned. A zero might mean that the bus is shorted, there are no devices, 
-  // or you have already retrieved all of them.  It might be a good idea to 
-  // check the CRC to make sure you didn't get garbage.  The order is 
+  // or you have already retrieved all of them. It might be a good idea to 
+  // check the CRC to make sure you didn't get garbage. The order is 
   // deterministic. You will always get the same devices in the same order
   //
   // Must be called before search()
@@ -85,7 +90,9 @@ void printTemperature(DeviceAddress deviceAddress)
   Serial.print(" Temp F: ");
   Serial.println(DallasTemperature::toFahrenheit(tempC)); // Converts tempC to Fahrenheit
 }
-
+/*
+ * Main function. It will request the tempC from the sensors and display on Serial.
+ */
 void loop(void)
 { 
   // call sensors.requestTemperatures() to issue a global temperature 
diff --git a/examples/Tester/Tester.pde b/examples/Tester/Tester.pde
@@ -3,7 +3,7 @@
 
 // Data wire is plugged into port 2 on the Arduino
 #define ONE_WIRE_BUS 2
-#define TEMPERATURE_PRECISION 9
+#define TEMPERATURE_PRECISION 9 // Lower resolution
 
 // Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
 OneWire oneWire(ONE_WIRE_BUS);
diff --git a/keywords.txt b/keywords.txt
@@ -1,51 +1,51 @@
 #######################################
-# Syntax Coloring Map For Ultrasound
+# Syntax Coloring Map For DallasTemperature
 #######################################
 
 #######################################
 # Datatypes (KEYWORD1)
 #######################################
-DallasTemperature	KEYWORD1
-OneWire	KEYWORD1
-AlarmHandler	KEYWORD1
-DeviceAddress	KEYWORD1
+DallasTemperature		KEYWORD1
+OneWire					KEYWORD1
+AlarmHandler			KEYWORD1
+DeviceAddress			KEYWORD1
 
 #######################################
 # Methods and Functions (KEYWORD2)
 #######################################
 
-setResolution	KEYWORD2
-getResolution	KEYWORD2
-getTempC	KEYWORD2
-toFahrenheit	KEYWORD2
-getTempF	KEYWORD2
-getTempCByIndex 	KEYWORD2
-getTempFByIndex		KEYWORD2
+setResolution			KEYWORD2
+getResolution			KEYWORD2
+getTempC				KEYWORD2
+toFahrenheit			KEYWORD2
+getTempF				KEYWORD2
+getTempCByIndex 		KEYWORD2
+getTempFByIndex			KEYWORD2
 setWaitForConversion	KEYWORD2
 getWaitForConversion	KEYWORD2
-requestTemperatures	KEYWORD2
+requestTemperatures		KEYWORD2
 requestTemperaturesByAddress	KEYWORD2
 requestTemperaturesByIndex	KEYWORD2
-isParasitePowerMode	KEYWORD2
-begin	KEYWORD2
-getDeviceCount	KEYWORD2
-getAddress	KEYWORD2
-validAddress	KEYWORD2
-isConnected	KEYWORD2
-readScratchPad	KEYWORD2
-writeScratchPad	KEYWORD2
-readPowerSupply	KEYWORD2
-setHighAlarmTemp	KEYWORD2
-setLowAlarmTemp	KEYWORD2
-getHighAlarmTemp	KEYWORD2
-getLowAlarmTemp	KEYWORD2
-resetAlarmSearch	KEYWORD2
-alarmSearch	KEYWORD2
-hasAlarm	KEYWORD2
-toCelsius	KEYWORD2
-processAlarmss	KEYWORD2
-setAlarmHandlers	KEYWORD2
-defaultAlarmHandler	KEYWORD2
+isParasitePowerMode		KEYWORD2
+begin					KEYWORD2
+getDeviceCount			KEYWORD2
+getAddress				KEYWORD2
+validAddress			KEYWORD2
+isConnected				KEYWORD2
+readScratchPad			KEYWORD2
+writeScratchPad			KEYWORD2
+readPowerSupply			KEYWORD2
+setHighAlarmTemp		KEYWORD2
+setLowAlarmTemp			KEYWORD2
+getHighAlarmTemp		KEYWORD2
+getLowAlarmTemp			KEYWORD2
+resetAlarmSearch		KEYWORD2
+alarmSearch				KEYWORD2
+hasAlarm				KEYWORD2
+toCelsius				KEYWORD2
+processAlarmss			KEYWORD2
+setAlarmHandlers		KEYWORD2
+defaultAlarmHandler		KEYWORD2
 calculateTemperature	KEYWORD2
 
 #######################################
