The Firebase library allows you to easily integrate with Firebase's realtime backend, which includes data storage, user authentication, static hosting, and more.
To add this library to your project, add #require "Firebase.class.nut:2.0.0" to the top of your agent code.
You can view the library’s source code on GitHub.
The Firebase class must be instantiated with an instance name, and optionally an Auth Key, a custom Firebase domain, and a debug flag.
| Parameter | Type | Default | Notes |
|---|---|---|---|
| instance | string | n/a | |
| auth | string | null - (no auth) |
Optional |
| domain | string | firebaseio.com | Optional |
| debug | bool | true |
Optional - set to false to surpress error logging within the Firebase class |
The domain and instance are used to construct the url requests are made against in the following was: https://{instance}.{domain}
#require "Firebase.class.nut:2.0.0"
const FIREBASE_AUTH_KEY = "<-- Your Firebase Auth Key -->"
firebase <- Firebase("myfirebase", FIREBASE_AUTH_KEY)Listens for changes at a particular location (path) or a node below path. When changes are detected, the callback method will be invoked. The callback method takes two parameters: path and data.
The path parameter returns the full path of the node that was modified (this allows you to determin if the root of the path you're tracking changed, or if a node below it changed).
The data parameter contains the modified data.
// Register a callback handler
firebase.on("/settings", function(path, data) {
server.log("Changes detected at: " + path);
server.log("New Data: " + http.jsonencode(data));
// Make sure the data we're looking for exists
if ("color" in data) {
// Send the new settings to the device
device.send("newColor", data.color);
}
});
// Register a callback handler
firebase.on("/current/state", function(state) {
// Send the new state to the device
device.send("newState", state);
});
// Open the stream to begin listening
// (.on handlers will not execute if we don't call .stream)
firebase.stream();NOTE: You must call the .stream method (see below) in order to open a realtime stream with Firebase and have the registered callbacks invoked.
Creates a streaming request using the path as the base address to track. If no path is supplied, the root of the instance ("/") will be used.
An optional table of uriParams can be supplied in order to use Firebase queries.
An optional onErrorCallback parameter can be supplied that will be invoked if errors occur while making streaming requests.
If no onErrorCallback is not supplied, the Firebase class will attempt to silently and automatically reconnect when it encounters an error. If an onErrorCallback is supplied, it is up to the developer to re-initiate the steam() request in the onErrorCallback.
The onErrorCallback takes a single parameter - the HTTP Response Table from the request.
// Setup onError handler
function onStreamError(resp) {
server.error("Firebase encountered and error:");
server.error(resp.statuscode + " - " + resp.body);
imp.wakeup(1, openStream });
}
// Wrap up the process of opening a stream
function openStream() {
firebase.stream("/", onStreamError);
}
openStream();Returns true is the stream is currently open, and false otherwise.
Closes the current stream (if it is open), and takes no action otherwise.
Reads the local/cached copy of the data at the specified path - intended for use in a .on() handler to prevent unnecessary communication with Firebase through the read method.
firebase.on("/settings", function(path, data) {
// Check if the location setting changed
if ("location" in data) {
// if it did, grab the location data from Firebase
// use fromCache instead of read to avoide an unnecessary web request
local location = firebase.fromCache("/locations/" + data.location);
// Send the new location information to the device
device.send("updateLocation", location);
}
});Reads data from the specified path (i.e. performs a GET request).
// Read all the settings:
firebase.read("/settings", null, function(data) {
foreach(setting, value in data) {
server.log(setting + ": " + value);
}
});Query Parameters can also be passed in as a table of arguments to uriParams
fbDino <- Firebase("dinosaur-facts")
// Perform a shallow query to get the list of keys at this location
fbDino.read("/dinosaurs", {"shallow": true}, function(data){
server.log(http.jsonencode(data))
// Logs: { "lambeosaurus": true, "linhenykus": true, "triceratops": true, "stegosaurus": true, "bruhathkayosaurus": true, "pterodactyl": true }
})
// The \uf8ff character used in the query above is a very high code point in the Unicode range.
// Because it is after most regular characters in Unicode, the query matches all values that start with a b.
fbDino.read("/dinosaurs", {"orderBy": "$key", "startAt": "b", "endAt": @"b\uf8ff"}, function(data){
server.log(http.jsonencode(data))
//Logs { "bruhathkayosaurus": { "appeared": -70000000, "vanished": -70000000, "order": "saurischia", "length": 44, "weight": 135000, "height": 25 } }
})Updates data at the specified path (i.e. performs a PUT request).
// When we get a new state
device.on("newState", function(state) {
// Write the state to Firebase
firebase.write("/current/state", state, function(resp) {
// If there was an error during the write, log it
if (resp.statuscode != 200) server.error(resp.body);
});
});NOTE: When you write to a specific path you replace all of the data at that path (and all paths below it).
Updates a subset of data at a particular path (i.e. performs a PATCH request).
device.on("newLocation", function(location) {
// Update the location in the settings:
firebase.update("/settings", { "location": location }, function(resp) {
if (resp.statuscode != 200) server.error(resp.body);
});
});Pushes data to the specified path (i.e. performs a POST request). This function should be used when you're adding an item to a list.
device.on("temps", function(data) {
foreach(temp in data) {
local pushData = {
"deviceId": data.deviceId,
"timestamp": data.ts,
"temp": data.temp
};
firebase.push("/temperatures", pushData);
}
});Deletes data at the specified path (i.e. performs a DELETE request).
// If the user opts out of tracking:
device.on("no-tracking", function(data) {
// Delete the location information from Firebase
firebase.remove("/settings/location", function(resp) {
// If there was an error
if (resp.statuscode != 200) {
// Log it
server.error(resp.body)
// Send a message to the user to indicate it failed
device.send("no-tracking-failed", null);
}
});
});The Firebase class is licensed under MIT License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent