add FirebaseSerial w/ streaming

Author: proppy

Firebase.cpp

@@ -40,10 +40,24 @@ String makeFirebaseURL(const String& path, const String& auth) {
 
 }  // namespace
 
-Firebase::Firebase(const String& host) : host_(host) {
+Firebase::Firebase() {
+}
+
+Firebase::Firebase(const String& host, const String& auth) {
+  begin(host, auth);
+}
+
+void Firebase::begin(const String& host, const String& auth) {
+  host_ = host;
+  auth_ = auth;
   http_.setReuse(true);
 }
 
+Firebase& Firebase::host(const String& host) {
+  host_ = host;
+  return *this;
+}
+
 Firebase& Firebase::auth(const String& auth) {
   auth_ = auth;
   return *this;
@@ -73,7 +87,14 @@ FirebaseStream Firebase::stream(const String& path) {
 // FirebaseCall
 FirebaseCall::FirebaseCall(const String& host, const String& auth,
                            const char* method, const String& path,
-                           const String& data, HTTPClient* http) : http_(http) {
+                           const String& data, HTTPClient* http) {
+  begin(host, auth, method, path, data, http);
+}
+
+void FirebaseCall::begin(const String& host, const String& auth,
+                         const char* method, const String& path,
+                         const String& data, HTTPClient* http) {
+  http_ = http;
   String url = makeFirebaseURL(path, auth);
   http_->setReuse(true);
   http_->begin(host, kFirebasePort, url, true, kFirebaseFingerprint);
@@ -164,6 +185,12 @@ FirebaseStream::FirebaseStream(const String& host, const String& auth,
   : FirebaseCall(host, auth, "STREAM", path, "", http) {
 }
 
+void FirebaseStream::begin(const String& host, const String& auth,
+                           const String& path,
+                           HTTPClient* http) {
+  FirebaseCall::begin(host, auth, "STREAM", path, "", http);
+}
+
 bool FirebaseStream::available() {
   return http_->getStreamPtr()->available();
 }
@@ -183,3 +210,17 @@ FirebaseStream::Event FirebaseStream::read(String& event) {
   client->readStringUntil('\n'); // consume separator
   return type;
 }
+
+void FirebaseSerial::begin(const String& host, const String& auth, const String& path) {
+  stream_.begin(host, auth, path, &httpStream_);
+}
+
+bool FirebaseSerial::available() {
+  return httpStream_.getStreamPtr()->available();
+}
+
+String FirebaseSerial::read() {
+  String event;
+  auto type = stream_.read(event);
+  return event;
+}

Firebase.h

@@ -34,7 +34,11 @@ class FirebaseStream;
 // Firebase REST API client.
 class Firebase {
  public:
-  Firebase(const String& host);
+  Firebase();
+  Firebase(const String& host, const String& auth = "");
+  void begin(const String& host, const String& auth = "");
+
+  Firebase& host(const String& host);
   Firebase& auth(const String& auth);
 
   // Fetch json encoded `value` at `path`.
@@ -62,11 +66,11 @@ class FirebaseError {
  public:
   FirebaseError() {}
   FirebaseError(int code, const String& message) : code_(code), message_(message) {
-  }  
+  }
   operator bool() const { return code_ != 0; }
   int code() const { return code_; }
   const String& message() const { return message_; }
- private:  
+ private:
   int code_ = 0;
   String message_ = "";
 };
@@ -76,8 +80,12 @@ class FirebaseCall {
   FirebaseCall() {}
   FirebaseCall(const String& host, const String& auth,
                const char* method, const String& path,
-               const String& data = "",        
+               const String& data = "",
                HTTPClient* http = NULL);
+  void begin(const String& host, const String& auth,
+             const char* method, const String& path,
+             const String& data = "",
+             HTTPClient* http = NULL);
   const FirebaseError& error() const {
     return error_;
   }
@@ -95,7 +103,7 @@ class FirebaseGet : public FirebaseCall {
   FirebaseGet() {}
   FirebaseGet(const String& host, const String& auth,
               const String& path, HTTPClient* http = NULL);
-  
+
   const String& json() const {
     return json_;
   }
@@ -145,7 +153,9 @@ class FirebaseStream : public FirebaseCall {
   FirebaseStream() {}
   FirebaseStream(const String& host, const String& auth,
                  const String& path, HTTPClient* http = NULL);
-  
+  void begin(const String& host, const String& auth,
+             const String& path, HTTPClient* http = NULL);
+
   // Return if there is any event available to read.
   bool available();
 
@@ -157,14 +167,27 @@ class FirebaseStream : public FirebaseCall {
   };
 
   // Read next json encoded `event` from stream.
-  Event read(String& event);  
+  Event read(String& event);
 
   const FirebaseError& error() const {
     return _error;
   }
-  
+
  private:
   FirebaseError _error;
 };
 
+class FirebaseSerial {
+ public:
+  FirebaseSerial() {}
+  void begin(const String& url, const String& auth = "", const String& path = "/");
+  bool available();
+  String read();
+
+ private:
+  HTTPClient http_;
+  HTTPClient httpStream_;
+  FirebaseStream stream_;
+};
+
 #endif // firebase_h

examples/FirebaseSerial_ESP8266/FirebaseSerial_ESP8266.ino

@@ -0,0 +1,45 @@
+//
+// Copyright 2016 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.
+//
+
+// FirebaseStream_ESP8266 is a sample that stream bitcoin price from a
+// public Firebase and optionally display them on a OLED i2c screen.
+
+#include <Firebase.h>
+
+FirebaseSerial firebaseSerial;
+
+void setup() {
+  Serial.begin(9600);
+  firebaseSerial.begin("example.firebaseio.com", "secret");
+
+  // connect to wifi.
+  WiFi.begin("GoogleGuest", "PASSWORD");
+  Serial.print("connecting");
+  while (WiFi.status() != WL_CONNECTED) {
+    Serial.print(".");
+    delay(500);
+  }
+  Serial.println();
+  Serial.print("connected: ");
+  Serial.println(WiFi.localIP());
+}
+
+
+void loop() {
+  if (firebaseSerial.available()) {
+    Serial.print(firebaseSerial.read());
+  }   
+}