Skip to content

Commit dbd2cd7

Browse files
committed
Update readme
1 parent 75f0495 commit dbd2cd7

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ Include the library in your Arduino project. You can download this repository's
9999
#define USER "[email protected]"
100100
#define PASSWORD "password"
101101
#define WEB_API_KEY "yourwebapikey"
102+
#define BOARD_ID 0
102103

103104
// Device ID that was created in the Android app.
104105
// Can be any string if using the library for microcontroller-to-microcontroller communication.
@@ -108,6 +109,7 @@ Include the library in your Arduino project. You can download this repository's
108109
// Initialize the EmberIot instance
109110
EmberIot ember(RTDB_URL,
110111
DEVICE_ID,
112+
BOARD_ID,
111113
USER,
112114
PASSWORD,
113115
WEB_API_KEY);
@@ -170,6 +172,7 @@ Below is a brief overview of the key functions used in the example code:
170172
This is the constructor that initializes the `EmberIot` instance with the provided parameters:
171173
- `RTDB_URL`: The URL of the Firebase Realtime Database.
172174
- `DEVICE_ID`: A unique identifier for the device (it can be any string, or the ID created in the Android app).
175+
- `BOARD_ID`: A number identifying this microcontroller specifically. Used for microcontroller to microcontroller communication, each board should have a unique ID so the library can separate which channel updates are from other boards. Can be any number for normal Android app usage.
173176
- `USER`: The email address used for Firebase Authentication.
174177
- `PASSWORD`: The password for the Firebase Authentication.
175178
- `WEB_API_KEY`: The Firebase Web API key required to authenticate the connection.

0 commit comments

Comments
 (0)