Skip to content

Commit 4116385

Browse files
committed
examples: update READMEs
1 parent 7d3a128 commit 4116385

File tree

3 files changed

+21
-11
lines changed

3 files changed

+21
-11
lines changed

examples/FirebaseDemo_ESP8266/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,13 @@ FirebaseDemo is a sample that shows basic usage of the `FirebaseArduino` API.
1919
1. Click `Firebase Secrets > Show`
2020
1. Copy the `Firebase Secret`
2121
1. Start Arduino
22-
1. Click `File > Examples > FirebaseArduino > FirebaseRoom_ESP8266`
23-
1. Replace `SSID` and `PASSWORD` with WiFi credentials
24-
1. Replace `example.firebaseio.com` with the `Firebase Hostname` from step `2.`
25-
1. Replace `secret_or_token` with `Firebase Secret` from step `5.`
22+
1. Open `File > Examples > FirebaseArduino > FirebaseDemo_ESP8266`
23+
1. Replace `WIFI_SSID` and `WIFI_PASSWORD` with WiFi credentials
24+
1. Replace `FIREBASE_HOST` with the `Firebase Hostname` from step `2.`
25+
1. Replace `FIREBASE_AUTH` with `Firebase Secret` from step `5.`
26+
1. Select the board `Board > ESP8266 Modules > NodeMCU 1.0`
27+
1. Select the serial port `Port > /dev/tty...`
28+
1. Select the upload speed `Upload Speed > 115200`
2629
1. Click `Sketch > Upload`
2730

2831
## Play

examples/FirebaseRoom_ESP8266/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,13 @@ sensor data to Firebase, and trigger actuators from Firebase.
3030
1. Click `Firebase Secrets > Show`
3131
1. Copy the `Firebase Secret`
3232
1. Start Arduino
33-
1. Click `File > Examples > FirebaseArduino > FirebaseRoom_ESP8266`
34-
1. Replace `SSID` and `PASSWORD` with WiFi credentials
35-
1. Replace `example.firebaseio.com` with the `Firebase Hostname` from step `2.`
36-
1. Replace `secret_or_token` with `Firebase Secret` from step `5.`
33+
1. Open `File > Examples > FirebaseArduino > FirebaseRoom_ESP8266`
34+
1. Replace `WIFI_SSID` and `WIFI_PASSWORD` with WiFi credentials
35+
1. Replace `FIREBASE_HOST` with the `Firebase Hostname` from step `2.`
36+
1. Replace `FIREBASE_AUTH` with `Firebase Secret` from step `5.`
37+
1. Select the board `Board > ESP8266 Modules > NodeMCU 1.0`
38+
1. Select the serial port `Port > /dev/tty...`
39+
1. Select the upload speed `Upload Speed > 115200`
3740
1. Click `Sketch > Upload`
3841

3942
## Play
@@ -50,9 +53,10 @@ sensor data to Firebase, and trigger actuators from Firebase.
5053
## Homeworks
5154

5255
- Build a [Firebase web app](https://www.firebase.com/docs/web/) that interacts with the room.
56+
- Add Grove modules to modules interactions.
5357
- Connect other Grove modules to the room and submit new [PRs](https://github.com/googlesamples/firebase-arduino/pulls)
5458
- Reduce the number of Firebase API calls using `FirebaseObject` or `FirebaseStream`.
5559
- Watch or star the [GitHub repo repo](https://github.com/googlesamples/firebase-arduino)
56-
- Give [feedback](gitter.im/googlesamples/firebase-arduino)
60+
- Give [feedback](https://gitter.im/googlesamples/firebase-arduino)
5761
- Report [bugs](https://github.com/googlesamples/firebase-arduino/issues/new)
5862
- [Fork](https://github.com/googlesamples/firebase-arduino#fork-destination-box) and [contribute](https://github.com/googlesamples/firebase-arduino/blob/master/CONTRIBUTING.md)

examples/FirebaseStream_ESP8266/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,11 @@ https://publicdata-cryptocurrency.firebaseio.com.
2929
## Configuration
3030

3131
1. Start Arduino
32-
1. Click `File > Examples > FirebaseArduino > FirebaseStream_ESP8266`
33-
1. Replace `SSID` and `PASSWORD` with WiFi credentials
32+
1. Open `File > Examples > FirebaseArduino > FirebaseStream_ESP8266`
33+
1. Replace `WIFI_SSID` and `WIFI_PASSWORD` with WiFi credentials
34+
1. Select the board `Board > ESP8266 Modules > NodeMCU 1.0`
35+
1. Select the serial port `Port > /dev/tty...`
36+
1. Select the upload speed `Upload Speed > 115200`
3437
1. Click `Sketch > Upload`
3538

3639
## Play

0 commit comments

Comments
 (0)