|
1 | | -#firebase-arduino |
| 1 | +#FirebaseArduino |
2 | 2 |
|
3 | 3 | [](https://travis-ci.org/googlesamples/firebase-arduino) |
4 | 4 | [](https://gitter.im/googlesamples/firebase-arduino?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
5 | 5 | [](http://firebase-arduino.readthedocs.io/en/latest/?badge=latest) |
6 | 6 |
|
| 7 | +This repo contains a collection of samples and an Arduino library that show how to call the[Firebase](https://www.firebase.com/) API from the[ESP8266 Arduino core](https://github.com/esp8266/Arduino). |
7 | 8 |
|
8 | | -This sample shows how to call[Firebase](https://www.firebase.com/) from the[ESP8266 Arduino core](https://github.com/esp8266/Arduino). |
| 9 | +The Arduino library is[under heavy development](https://github.com/googlesamples/firebase-arduino/issues),**experimental**,**unversioned** and its API is**not stable**. |
9 | 10 |
|
10 | | -##Requirements |
| 11 | +##Samples |
11 | 12 |
|
12 | | --1[ESP8266 Arduino board](https://www.adafruit.com/products/2821). |
13 | | --[Arduino 1.6.8](https://www.arduino.cc/en/Main/Software) |
14 | | --[stable ESP8266 Arduino board definition](https://github.com/esp8266/Arduino#installing-with-boards-manager) |
| 13 | +-[FirebaseDemo](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseDemo_ESP8266) - shows the FirebaseArduino API methods. |
| 14 | +-[FirebaseRoom](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseRoom_ESP8266) - shows how to push sensor data and trigger actuator from Firebase. |
| 15 | +-[FirebaseStream](https://github.com/googlesamples/firebase-arduino/tree/master/examples/FirebaseStream_ESP8266) - shows the FirebaseArduino streaming API. |
15 | 16 |
|
16 | | -##Setup |
| 17 | +##Documentation |
17 | 18 |
|
18 | | -- Clone the repo in your Arduino libraries directory. |
19 | | -- open the`FirebaseDemo_ESP8266` example. |
20 | | -- Replace`SSID``PASSWORD``example.firebaseio.com``secret_or_token` placeholders. |
21 | | - |
22 | | -##Run |
23 | | - |
24 | | -- Open firebase dashboard on your database |
25 | | -- Power up the arduino board. |
26 | | -- Notice the changes being bad every seconds. |
| 19 | +-[FirebaseArduino API Reference](http://firebase-arduino.readthedocs.io/) |
27 | 20 |
|
28 | 21 | ##Disclaimer |
29 | 22 |
|
|