Merge pull request #181 from ed7coyne/disambiguate-serialhost-examples

Disambiguate serialhost examples

Author: ed7coyne

examples/FirebaseSerialHost_ESP8266/FirebaseSerialHost_ESP8266.ino

@@ -18,17 +18,9 @@
 // A sample that will start our serial transciever listening on a software
 // port and allow debug over the main serial port.
 //
-// A suggested setup for testing this example would be a USB to TTL cable
-// with the green wire connected to pin 5 and the white wire connected to
-// pin 4 (on the huzzah feather esp8266).
-// First edit begin.txt and put in your host and secret.
-// Then run the following commands to setup the serial port in linux:
-// stty -F /dev/ttyUSB0 9600 raw -echo -echoe -echok
-// Then on one console do:
-// cat /dev/ttyUSB0 &
-// This console will now read all responses from the modem. Then do:
-// cat begin.txt > /dev/ttyUSB0
-// You should see +OK and you can now feed in the other example commmands.
+// A suggested setup for testing this example would be to connect a board 
+// with integrated usb and open a serial monitor to see debug messages. 
+// Then connect another board on pin4 and pin5 to communicate over serial.
 
 #include <SoftwareSerial.h>
 #include <ESP8266WiFi.h>

examples/FirebaseSerialTerminal_ESP8266/FirebaseSerialTerminal_ESP8266.ino

@@ -0,0 +1,63 @@
+//
+// Copyright 2015 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+
+// A sample that will start our serial transciever listening on the primary
+// Serial port.
+//
+// A suggested setup for testing this example would be a esp8266 with built
+// in usb connected.
+// First edit begin.txt and put in your host and secret.
+// Then run the following commands to setup the serial port (assuming ttyUSB0)
+// in linux:
+// stty -F /dev/ttyUSB0 9600 raw -echo -echoe -echok
+// Then on one console do:
+// cat /dev/ttyUSB0 &
+// This console will now read all responses from the modem. Then do:
+// cat begin.txt > /dev/ttyUSB0
+// You should see +OK and you can now feed in the other example commmands.
+
+#include <ESP8266WiFi.h>
+
+#include <Firebase.h>
+#include <SerialTransceiver.h>
+
+// Set these to run example.
+#define WIFI_SSID "SSID"
+#define WIFI_PASSWORD "PASSWORD"
+
+firebase::modem::SerialTransceiver transceiver;
+
+void setup() {
+  Serial.begin(9600);
+
+  // connect to wifi.
+  WiFi.begin(WIFI_SSID, WIFI_PASSWORD);
+  Serial.print("connecting");
+  while (WiFi.status() != WL_CONNECTED) {
+    Serial.print(".");
+    delay(500);
+  }
+  Serial.println();
+  Serial.print("connected: ");
+  Serial.println(WiFi.localIP());
+
+  transceiver.begin(&Serial);
+}
+
+void loop() {
+  transceiver.loop();
+}