Skip to content
This repository was archived by the owner on Mar 17, 2025. It is now read-only.

Commit ebb04ee

Browse files
committed
Updates README
1 parent bddb5eb commit ebb04ee

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

examples/FirebaseNeoPixel_ESP8266/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# FirebaseNeoPixel
22

3-
FirebaseNeoPixel is a sample that shows how to set pixel data from Firebase web app.
3+
FirebaseNeoPixel is a sample that shows how to set pixel data from a Firebase web app.
44

55
## Hardware setup
66

@@ -25,23 +25,24 @@ FirebaseNeoPixel is a sample that shows how to set pixel data from Firebase web
2525
## Configuration
2626

2727
1. Start Arduino
28-
1. Open `File > Examples > FirebaseArduino > FirebaseRoom_ESP8266`
29-
1. In `FirebaseRoom_ESP8266`: Replace `WIFI_SSID` and `WIFI_PASSWORD` with WiFi credentials
28+
1. Open `File > Examples > FirebaseArduino > FirebaseNeoPixel_ESP8266`
29+
1. In `FirebaseNeoPixel_ESP8266`: Replace `WIFI_SSID` and `WIFI_PASSWORD` with WiFi credentials
3030
1. Go to https://firebase.google.com/console/ and create a new Firebase Project
3131
1. Go to `Database`
3232
1. Copy the `Database hostname` (Database URL without `https://` and trailing `/`)
33-
1. In `FirebaseRoom_ESP8266`: replace `FIREBASE_HOST` with the `Database Hostname`
33+
1. In `FirebaseNeoPixel_ESP8266`: replace `FIREBASE_HOST` with the `Database Hostname`
3434
1. Go to `⚙ > Project Settings > Database > Database secrets`
3535
1. Click `Firebase Secrets > Show`
3636
1. Copy the `Database Secret`
37-
1. In `FirebaseRoom_ESP8266`: Replace `FIREBASE_AUTH` with `Database Secret`
37+
1. In `FirebaseNeoPixel_ESP8266`: Replace `FIREBASE_AUTH` with `Database Secret`
3838
1. Select the board `Board > ESP8266 Modules > NodeMCU 1.0`
3939
1. Select the serial port `Port > /dev/tty...`
4040
1. Select the upload speed `Upload Speed > 115200`
4141
1. Click `Sketch > Upload`
4242
1. Open `public/index.html` with a text editor
43-
1. Replace `example.firebaseio.com` with the `Firebase Hostname` from step `2.`
44-
1. Replace `secret_or_token` with `Firebase Secret` from step `5.`
43+
1. Replace `yourproject.firebaseio.com` with the `Firebase Hostname` used for configuring the Arduino project.
44+
1. Replace `yourproject.firebaseapp.com` with the `Firebase Domain` from hosting tab of the Firebase Console.
45+
1. Replace `secret_or_token` with the `Firebase Secret` used to configure the Arduino project.
4546
1. Deploy the `public` directory to Firebase hosting
4647
```
4748
npm install -g firebase-tools bower
@@ -53,6 +54,7 @@ firebase deploy
5354

5455
## Play
5556

56-
1. Go to the firebase hosting URL: `firebase-name.firebaseapp.com`
57-
1. Use the color picker and paint the NeoPixel table
58-
1. Watch the NeoPixel being updated to the matching color
57+
1. Go to the firebase hosting URL: `firebase-name.firebaseapp.com`.
58+
1. Initialize the pixel data by copying / pasting example pixel data from the page and clicking **Update**.
59+
1. Use the color picker and paint the NeoPixel table.
60+
1. Watch the NeoPixel being updated to the matching color.

0 commit comments

Comments
 (0)