Update connection examples.

Author: jburhenn

examples/Connections/EthernetShieldW5100/EthernetShieldW5100.ino

@@ -1,40 +1,48 @@
-// This example shows how to connect to Cayenne using an Ethernet W5100 shield and send/receive sample data.
+/*
+This example shows how to connect to Cayenne using an Ethernet W5100 shield and send/receive sample data.
 
-//#define CAYENNE_DEBUG
-#define CAYENNE_PRINT Serial
+The CayenneMQTT Library is required to run this sketch. If you have not already done so you can install it from the Arduino IDE Library Manager.
+
+Steps:
+1. Set the Cayenne authentication info to match the authentication info from the Dashboard.
+2. Compile and upload the sketch.
+3. A temporary widget will be automatically generated in the Cayenne Dashboard. To make the widget permanent click the plus sign on the widget.
+*/
+
+//#define CAYENNE_DEBUG       // Uncomment to show debug messages
+#define CAYENNE_PRINT Serial  // Comment this out to disable prints and save space
 #include <CayenneMQTTEthernet.h>
 
 // Cayenne authentication info. This should be obtained from the Cayenne Dashboard.
 char username[] = "MQTT_USERNAME";
 char password[] = "MQTT_PASSWORD";
 char clientID[] = "CLIENT_ID";
 
-unsigned long lastMillis = 0;
-
 void setup() {
 	Serial.begin(9600);
 	Cayenne.begin(username, password, clientID);
 }
 
 void loop() {
 	Cayenne.loop();
+}
 
-	//Publish data every 10 seconds (10000 milliseconds). Change this value to publish at a different interval.
-	if(millis() - lastMillis > 10000) {
-		lastMillis = millis();
-		//Write data to Cayenne here. This example just sends the current uptime in milliseconds.
-		Cayenne.virtualWrite(0, lastMillis);
-		//Some examples of other functions you can use to send data.
-		//Cayenne.celsiusWrite(1, 22.0);
-		//Cayenne.luxWrite(2, 700);
-		//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
-	}
+// Default function for sending sensor data at intervals to Cayenne.
+// You can also use functions for specific channels, e.g CAYENNE_OUT(1) for sending channel 1 data.
+CAYENNE_OUT_DEFAULT()
+{
+	// Write data to Cayenne here. This example just sends the current uptime in milliseconds on virtual channel 0.
+	Cayenne.virtualWrite(0, millis());
+	// Some examples of other functions you can use to send data.
+	//Cayenne.celsiusWrite(1, 22.0);
+	//Cayenne.luxWrite(2, 700);
+	//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
 }
 
-//Default function for processing actuator commands from the Cayenne Dashboard.
-//You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
+// Default function for processing actuator commands from the Cayenne Dashboard.
+// You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
 CAYENNE_IN_DEFAULT()
 {
-	CAYENNE_LOG("CAYENNE_IN_DEFAULT(%u) - %s, %s", request.channel, getValue.getId(), getValue.asString());
+	CAYENNE_LOG("Channel %u, value %s", request.channel, getValue.asString());
 	//Process message here. If there is an error set an error message using getValue.setError(), e.g getValue.setError("Error message");
 }

examples/Connections/EthernetShieldW5200/EthernetShieldW5200.ino

@@ -1,40 +1,50 @@
-// This example shows how to connect to Cayenne using an Ethernet W5200 shield and send/receive sample data.
+/*
+This example shows how to connect to Cayenne using an Ethernet W5200 shield and send/receive sample data.
 
-//#define CAYENNE_DEBUG
-#define CAYENNE_PRINT Serial
+The CayenneMQTT Library is required to run this sketch. If you have not already done so you can install it from the Arduino IDE Library Manager.
+
+Steps:
+1. Download the Ethernet_Shield_W5200 library (https://github.com/Seeed-Studio/Ethernet_Shield_W5200) as a zip file.
+2. From the Arduino IDE Include Library menu select Add .ZIP Library and add the downloaded Ethernet_Shield_W5200 zip library.
+3. Set the Cayenne authentication info to match the authentication info from the Dashboard.
+4. Compile and upload the sketch.
+5. A temporary widget will be automatically generated in the Cayenne Dashboard. To make the widget permanent click the plus sign on the widget.
+*/
+
+//#define CAYENNE_DEBUG       // Uncomment to show debug messages
+#define CAYENNE_PRINT Serial  // Comment this out to disable prints and save space
 #include <CayenneMQTTEthernetW5200.h>
 
 // Cayenne authentication info. This should be obtained from the Cayenne Dashboard.
 char username[] = "MQTT_USERNAME";
 char password[] = "MQTT_PASSWORD";
 char clientID[] = "CLIENT_ID";
 
-unsigned long lastMillis = 0;
-
 void setup() {
 	Serial.begin(9600);
 	Cayenne.begin(username, password, clientID);
 }
 
 void loop() {
 	Cayenne.loop();
+}
 
-	//Publish data every 10 seconds (10000 milliseconds). Change this value to publish at a different interval.
-	if (millis() - lastMillis > 10000) {
-		lastMillis = millis();
-		//Write data to Cayenne here. This example just sends the current uptime in milliseconds.
-		Cayenne.virtualWrite(0, lastMillis);
-		//Some examples of other functions you can use to send data.
-		//Cayenne.celsiusWrite(1, 22.0);
-		//Cayenne.luxWrite(2, 700);
-		//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
-	}
+// Default function for sending sensor data at intervals to Cayenne.
+// You can also use functions for specific channels, e.g CAYENNE_OUT(1) for sending channel 1 data.
+CAYENNE_OUT_DEFAULT()
+{
+	// Write data to Cayenne here. This example just sends the current uptime in milliseconds on virtual channel 0.
+	Cayenne.virtualWrite(0, millis());
+	// Some examples of other functions you can use to send data.
+	//Cayenne.celsiusWrite(1, 22.0);
+	//Cayenne.luxWrite(2, 700);
+	//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
 }
 
-//Default function for processing actuator commands from the Cayenne Dashboard.
-//You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
+// Default function for processing actuator commands from the Cayenne Dashboard.
+// You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
 CAYENNE_IN_DEFAULT()
 {
-	CAYENNE_LOG("CAYENNE_IN_DEFAULT(%u) - %s, %s", request.channel, getValue.getId(), getValue.asString());
+	CAYENNE_LOG("Channel %u, value %s", request.channel, getValue.asString());
 	//Process message here. If there is an error set an error message using getValue.setError(), e.g getValue.setError("Error message");
-}
+}

examples/Connections/EthernetShieldW5500/EthernetShieldW5500.ino

@@ -1,40 +1,50 @@
-// This example shows how to connect to Cayenne using an Ethernet W5500 shield and send/receive sample data.
+/*
+This example shows how to connect to Cayenne using an Ethernet W5500 shield and send/receive sample data.
 
-//#define CAYENNE_DEBUG
-#define CAYENNE_PRINT Serial
+The CayenneMQTT Library is required to run this sketch. If you have not already done so you can install it from the Arduino IDE Library Manager.
+
+Steps:
+1. Download the Ethernet2 library (https://github.com/adafruit/Ethernet2) as a zip file.
+2. From the Arduino IDE Include Library menu select Add .ZIP Library and add the downloaded Ethernet2 zip library.
+3. Set the Cayenne authentication info to match the authentication info from the Dashboard.
+4. Compile and upload the sketch.
+5. A temporary widget will be automatically generated in the Cayenne Dashboard. To make the widget permanent click the plus sign on the widget.
+*/
+
+//#define CAYENNE_DEBUG       // Uncomment to show debug messages
+#define CAYENNE_PRINT Serial  // Comment this out to disable prints and save space
 #include <CayenneMQTTEthernetW5500.h>
 
 // Cayenne authentication info. This should be obtained from the Cayenne Dashboard.
 char username[] = "MQTT_USERNAME";
 char password[] = "MQTT_PASSWORD";
 char clientID[] = "CLIENT_ID";
 
-unsigned long lastMillis = 0;
-
 void setup() {
 	Serial.begin(9600);
 	Cayenne.begin(username, password, clientID);
 }
 
 void loop() {
 	Cayenne.loop();
+}
 
-	//Publish data every 10 seconds (10000 milliseconds). Change this value to publish at a different interval.
-	if (millis() - lastMillis > 10000) {
-		lastMillis = millis();
-		//Write data to Cayenne here. This example just sends the current uptime in milliseconds.
-		Cayenne.virtualWrite(0, lastMillis);
-		//Some examples of other functions you can use to send data.
-		//Cayenne.celsiusWrite(1, 22.0);
-		//Cayenne.luxWrite(2, 700);
-		//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
-	}
+// Default function for sending sensor data at intervals to Cayenne.
+// You can also use functions for specific channels, e.g CAYENNE_OUT(1) for sending channel 1 data.
+CAYENNE_OUT_DEFAULT()
+{
+	// Write data to Cayenne here. This example just sends the current uptime in milliseconds on virtual channel 0.
+	Cayenne.virtualWrite(0, millis());
+	// Some examples of other functions you can use to send data.
+	//Cayenne.celsiusWrite(1, 22.0);
+	//Cayenne.luxWrite(2, 700);
+	//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
 }
 
-//Default function for processing actuator commands from the Cayenne Dashboard.
-//You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
+// Default function for processing actuator commands from the Cayenne Dashboard.
+// You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
 CAYENNE_IN_DEFAULT()
 {
-	CAYENNE_LOG("CAYENNE_IN_DEFAULT(%u) - %s, %s", request.channel, getValue.getId(), getValue.asString());
+	CAYENNE_LOG("Channel %u, value %s", request.channel, getValue.asString());
 	//Process message here. If there is an error set an error message using getValue.setError(), e.g getValue.setError("Error message");
-}
+}

examples/Connections/MKR1000/MKR1000.ino

@@ -1,7 +1,19 @@
-// This example shows how to connect to Cayenne using an Arduino/Genuino MKR1000 and send/receive sample data.
-
-//#define CAYENNE_DEBUG
-#define CAYENNE_PRINT Serial
+/*
+This example shows how to connect to Cayenne using an Arduino/Genuino MKR1000 and send/receive sample data.
+
+The CayenneMQTT Library is required to run this sketch. If you have not already done so you can install it from the Arduino IDE Library Manager.
+
+Steps:
+1. Install the Arduino SAMD Boards from the Arduino IDE Boards Manager if you have not already done so.
+2. Select the MKR1000 board from the Arduino IDE Tools menu.
+3. Set the Cayenne authentication info to match the authentication info from the Dashboard.
+4. Set the network name and password.
+5. Compile and upload the sketch.
+6. A temporary widget will be automatically generated in the Cayenne Dashboard. To make the widget permanent click the plus sign on the widget.
+*/
+
+//#define CAYENNE_DEBUG       // Uncomment to show debug messages
+#define CAYENNE_PRINT Serial  // Comment this out to disable prints and save space
 #include <CayenneMQTTMKR1000.h>
 
 // WiFi network info.
@@ -13,32 +25,31 @@ char username[] = "MQTT_USERNAME";
 char password[] = "MQTT_PASSWORD";
 char clientID[] = "CLIENT_ID";
 
-unsigned long lastMillis = 0;
-
 void setup() {
 	Serial.begin(9600);
 	Cayenne.begin(username, password, clientID, ssid, wifiPassword);
 }
 
 void loop() {
 	Cayenne.loop();
+}
 
-	//Publish data every 10 seconds (10000 milliseconds). Change this value to publish at a different interval.
-	if (millis() - lastMillis > 10000) {
-		lastMillis = millis();
-		//Write data to Cayenne here. This example just sends the current uptime in milliseconds.
-		Cayenne.virtualWrite(0, lastMillis);
-		//Some examples of other functions you can use to send data.
-		//Cayenne.celsiusWrite(1, 22.0);
-		//Cayenne.luxWrite(2, 700);
-		//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
-	}
+// Default function for sending sensor data at intervals to Cayenne.
+// You can also use functions for specific channels, e.g CAYENNE_OUT(1) for sending channel 1 data.
+CAYENNE_OUT_DEFAULT()
+{
+	// Write data to Cayenne here. This example just sends the current uptime in milliseconds on virtual channel 0.
+	Cayenne.virtualWrite(0, millis());
+	// Some examples of other functions you can use to send data.
+	//Cayenne.celsiusWrite(1, 22.0);
+	//Cayenne.luxWrite(2, 700);
+	//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
 }
 
-//Default function for processing actuator commands from the Cayenne Dashboard.
-//You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
+// Default function for processing actuator commands from the Cayenne Dashboard.
+// You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
 CAYENNE_IN_DEFAULT()
 {
-	CAYENNE_LOG("CAYENNE_IN_DEFAULT(%u) - %s, %s", request.channel, getValue.getId(), getValue.asString());
+	CAYENNE_LOG("Channel %u, value %s", request.channel, getValue.asString());
 	//Process message here. If there is an error set an error message using getValue.setError(), e.g getValue.setError("Error message");
 }

examples/Connections/ManualConnection/ManualConnection.ino

@@ -1,7 +1,16 @@
-// This example shows how to connect to Cayenne using a manually specified Ethernet connection and send/receive sample data.
+/*
+This example shows how to connect to Cayenne using a manually specified Ethernet connection and send/receive sample data.
 
-//#define CAYENNE_DEBUG
-#define CAYENNE_PRINT Serial
+The CayenneMQTT Library is required to run this sketch. If you have not already done so you can install it from the Arduino IDE Library Manager.
+
+Steps:
+1. Set the Cayenne authentication info to match the authentication info from the Dashboard.
+2. Compile and upload the sketch.
+3. A temporary widget will be automatically generated in the Cayenne Dashboard. To make the widget permanent click the plus sign on the widget.
+*/
+
+//#define CAYENNE_DEBUG       // Uncomment to show debug messages
+#define CAYENNE_PRINT Serial  // Comment this out to disable prints and save space
 #include <CayenneMQTTEthernet.h>
 //#include <CayenneMQTTEthernetW5500.h> // Uncomment this and comment out CayenneMQTTEthernet.h to use an Ethernet 2 shield or other Ethernet W5500 shield.
                                         // You will need the Ethernet2 library installed. See the ArduinoEthernetW5500 example sketch for more info.
@@ -20,32 +29,31 @@ IPAddress dns_ip(8, 8, 8, 8);
 IPAddress gateway_ip(10, 0, 0, 1);
 IPAddress subnet_mask(255, 255, 255, 0);
 
-unsigned long lastMillis = 0;
-
 void setup() {
 	Serial.begin(9600);
 	Cayenne.begin(username, password, clientID, arduino_ip, dns_ip, gateway_ip, subnet_mask, arduino_mac);
 }
 
 void loop() {
 	Cayenne.loop();
+}
 
-	//Publish data every 10 seconds (10000 milliseconds). Change this value to publish at a different interval.
-	if (millis() - lastMillis > 10000) {
-		lastMillis = millis();
-		//Write data to Cayenne here. This example just sends the current uptime in milliseconds.
-		Cayenne.virtualWrite(0, lastMillis);
-		//Some examples of other functions you can use to send data.
-		//Cayenne.celsiusWrite(1, 22.0);
-		//Cayenne.luxWrite(2, 700);
-		//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
-	}
+// Default function for sending sensor data at intervals to Cayenne.
+// You can also use functions for specific channels, e.g CAYENNE_OUT(1) for sending channel 1 data.
+CAYENNE_OUT_DEFAULT()
+{
+	// Write data to Cayenne here. This example just sends the current uptime in milliseconds on virtual channel 0.
+	Cayenne.virtualWrite(0, millis());
+	// Some examples of other functions you can use to send data.
+	//Cayenne.celsiusWrite(1, 22.0);
+	//Cayenne.luxWrite(2, 700);
+	//Cayenne.virtualWrite(3, 50, TYPE_PROXIMITY, UNIT_CENTIMETER);
 }
 
-//Default function for processing actuator commands from the Cayenne Dashboard.
-//You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
+// Default function for processing actuator commands from the Cayenne Dashboard.
+// You can also use functions for specific channels, e.g CAYENNE_IN(1) for channel 1 commands.
 CAYENNE_IN_DEFAULT()
 {
-	CAYENNE_LOG("CAYENNE_IN_DEFAULT(%u) - %s, %s", request.channel, getValue.getId(), getValue.asString());
+	CAYENNE_LOG("Channel %u, value %s", request.channel, getValue.asString());
 	//Process message here. If there is an error set an error message using getValue.setError(), e.g getValue.setError("Error message");
 }