Merge pull request #241 from firebase/contrib

move modem and things to contrib dir

.gitmodules

@@ -1,6 +1,6 @@
-[submodule "test/googletest"]
-	path = test/googletest
+[submodule "contrib/test/googletest"]
+	path = contrib/test/googletest
 	url = https://github.com/google/googletest.git
-[submodule "test/arduino-mock"]
-	path = test/arduino-mock
+[submodule "contrib/test/arduino-mock"]
+	path = contrib/test/arduino-mock
 	url = https://github.com/ed7coyne/arduino-mock.git

.travis.yml

@@ -25,10 +25,9 @@ before_script:
 - ( cd ${ARDUINO_HOME}/libraries && ln -s ${TRAVIS_BUILD_DIR} firebase-arduino && ln -s ${TRAVIS_BUILD_DIR}/src/third-party/arduino-json-5.6.7 ArduinoJson && ln -s ${HOME}/SoftwareSerial ./ && ln -s ${HOME}/Adafruit_NeoPixel ./ && ln -s ${HOME}/Adafruit-GFX-Library ./ && ln -s ${HOME}/Adafruit_SSD1306 ./)
 script:
 - ${ARDUINO_ROOT}/arduino-builder -verbose  -hardware ${ARDUINO_ROOT}/hardware/ -tools ${ARDUINO_ESP8266_ROOT}/tools/ -tools ${ARDUINO_ROOT}/tools-builder/ -fqbn esp8266com:esp8266:nodemcuv2 -libraries ${ARDUINO_HOME}/libraries/ -prefs build.flash_ld=${ARDUINO_ESP8266_ROOT}/tools/sdk/ld/eagle.flash.4m.ld -prefs build.flash_freq=40 -prefs build.flash_size=4M examples/FirebaseDemo_ESP8266/FirebaseDemo_ESP8266.ino
-- ${ARDUINO_ROOT}/arduino-builder -verbose  -hardware ${ARDUINO_ROOT}/hardware/ -tools ${ARDUINO_ESP8266_ROOT}/tools/ -tools ${ARDUINO_ROOT}/tools-builder/ -fqbn esp8266com:esp8266:nodemcuv2 -libraries ${ARDUINO_HOME}/libraries/ -prefs build.flash_ld=${ARDUINO_ESP8266_ROOT}/tools/sdk/ld/eagle.flash.4m.ld -prefs build.flash_freq=40 -prefs build.flash_size=4M examples/FirebaseSerialHost_ESP8266/FirebaseSerialHost_ESP8266.ino
 - ${ARDUINO_ROOT}/arduino-builder -verbose  -hardware ${ARDUINO_ROOT}/hardware/ -tools ${ARDUINO_ESP8266_ROOT}/tools/ -tools ${ARDUINO_ROOT}/tools-builder/ -fqbn esp8266com:esp8266:nodemcuv2 -libraries ${ARDUINO_HOME}/libraries/ -prefs build.flash_ld=${ARDUINO_ESP8266_ROOT}/tools/sdk/ld/eagle.flash.4m.ld -prefs build.flash_freq=40 -prefs build.flash_size=4M examples/FirebaseNeoPixel_ESP8266/FirebaseNeoPixel_ESP8266.ino
 - ${ARDUINO_ROOT}/arduino-builder -verbose  -hardware ${ARDUINO_ROOT}/hardware/ -tools ${ARDUINO_ESP8266_ROOT}/tools/ -tools ${ARDUINO_ROOT}/tools-builder/ -fqbn esp8266com:esp8266:nodemcuv2 -libraries ${ARDUINO_HOME}/libraries/ -prefs build.flash_ld=${ARDUINO_ESP8266_ROOT}/tools/sdk/ld/eagle.flash.4m.ld -prefs build.flash_freq=40 -prefs build.flash_size=4M examples/FirebaseStream_ESP8266/FirebaseStream_ESP8266.ino
 - ${ARDUINO_ROOT}/arduino-builder -verbose  -hardware ${ARDUINO_ROOT}/hardware/ -tools ${ARDUINO_ESP8266_ROOT}/tools/ -tools ${ARDUINO_ROOT}/tools-builder/ -fqbn esp8266com:esp8266:nodemcuv2 -libraries ${ARDUINO_HOME}/libraries/ -prefs build.flash_ld=${ARDUINO_ESP8266_ROOT}/tools/sdk/ld/eagle.flash.4m.ld -prefs build.flash_freq=40 -prefs build.flash_size=4M examples/FirebaseRoom_ESP8266/FirebaseRoom_ESP8266.ino
-- ( cd test && make check )
-- ( cd test/modem/ && make test )
-- test/travis/check_all_examples_use_standard_init.sh
+- ( cd contrib/test && make check )
+- ( cd contrib/test/modem/ && make test )
+- contrib/test/travis/check_all_examples_use_standard_init.sh

contrib/README.md

@@ -0,0 +1,8 @@
+# firebase-arduino contrib
+
+The `contrib` features projects around `firebase-arduino` library:
+
+- `modem`: a firmware implementing a `UART` modem for firebase
+- `firethings`: a firmware implementing `GPIO` state syncing with firebase
+- `hardware`: hardware design for `ESP8266` reference boards
+- `test`: test suite and mocks

test/Makefile → contrib/test/Makefile

@@ -14,9 +14,9 @@
 # limitations under the License.
 #
 
-FIREBASE_DIR=..
+FIREBASE_DIR=../..
 GTEST_DIR=googletest/googletest
-ARDUINOJSON_DIR=../src/third-party/arduino-json-5.6.7
+ARDUINOJSON_DIR=../../src/third-party/arduino-json-5.6.7
 
 FIREBASE_SRCS=${FIREBASE_DIR}/src/FirebaseObject.cpp
 GTEST_SRCS=${GTEST_DIR}/src/gtest-all.cpp
@@ -27,7 +27,7 @@ SRCS=FirebaseArduino_test.cpp\
 
 OBJS=${SRCS:.cpp=.o}
 
-CXXFLAGS=-I. -I../src -Igoogletest/googletest/include -Igoogletest/googletest -std=c++11 -g
+CXXFLAGS=-I. -I${FIREBASE_DIR}/src -Igoogletest/googletest/include -Igoogletest/googletest -std=c++11 -g
 LDFLAGS=-lpthread
 
 all: check

test/modem/Makefile → contrib/test/modem/Makefile

@@ -30,8 +30,10 @@ ARDUINO_MOCK_DIR = ../arduino-mock/
 # Where to find user code.
 TEST_DIR = .
 
-PROJECT_ROOT = ../../
+FIREBASE_ROOT = ../../..
+PROJECT_ROOT = ../..
 SRC_ROOT = $(PROJECT_ROOT)/src
+FIREBASE_SRC_ROOT = $(FIREBASE_ROOT)/src
 
 # Flags passed to the preprocessor.
 # Set Google Test and Google Mock's header directories as system
@@ -42,6 +44,7 @@ CPPFLAGS += -isystem $(GTEST_DIR)/include -isystem $(GMOCK_DIR)/include \
 		-I$(ARDUINO_MOCK_DIR)/include/ \
 		-I$(PROJECT_ROOT)/test/dummies \
 		-I$(PROJECT_ROOT)/src \
+		-I$(FIREBASE_ROOT)/src \
 		-I$(PROJECT_ROOT)
 
 # Flags passed to the C++ compiler.
@@ -125,8 +128,8 @@ arduino_mock_all.a : ArduinoMockAll.o
 
 # Builds shared objects.
 
-Firebase.o : $(SRC_ROOT)/Firebase.cpp
-	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(SRC_ROOT)/Firebase.cpp
+Firebase.o : $(FIREBASE_SRC_ROOT)/Firebase.cpp
+	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(FIREBASE_SRC_ROOT)/Firebase.cpp
 
 FirebaseHttpClient_dummy.o : $(PROJECT_ROOT)/test/dummies/FirebaseHttpClient_dummy.cpp
 	$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(PROJECT_ROOT)/test/dummies/FirebaseHttpClient_dummy.cpp

test/travis/check_all_examples_use_standard_init.sh → contrib/test/travis/check_all_examples_use_standard_init.sh

@@ -1,16 +1,16 @@
 #!/bin/bash
-FBASE_SNIPPET=test/travis/firebase_init.cc.snip
-FBASE_NOAUTH_SNIPPET=test/travis/no_firebase_init.cc.snip
-FBASE_NOCONFIG_SNIPPET=test/travis/no_config_init.cc.snip
-for example in `find examples/ -name *.ino`;
+FBASE_SNIPPET=contrib/test/travis/firebase_init.cc.snip
+FBASE_NOAUTH_SNIPPET=contrib/test/travis/no_firebase_init.cc.snip
+FBASE_NOCONFIG_SNIPPET=contrib/test/travis/no_config_init.cc.snip
+for example in `find examples/ contrib/examples/ -name *.ino`;
 do
   echo $example;
   (xxd -p $example | tr -d '\n' | grep -q `xxd -p $FBASE_SNIPPET | tr -d '\n'`) ||
   (xxd -p $example | tr -d '\n' | grep -q `xxd -p $FBASE_NOAUTH_SNIPPET | tr -d '\n'`) ||
   (xxd -p $example | tr -d '\n' | grep -q `xxd -p $FBASE_NOCONFIG_SNIPPET | tr -d '\n'`) ||
   if [ $? -ne 0 ];
   then
-    echo $example does not contain standard defined in test/travis/*_init.cc.snip.
+    echo $example does not contain standard defined in contrib/test/travis/*_init.cc.snip.
     exit 1;
   fi;
 done;