Google's Firebase Realtime Database Arduino Library for ESP8266 v 2.8.7
param host - Your Firebase database project host e.g. Your_ProjectID.firebaseio.com.
param auth - Your database secret.
param rootCA - Root CA certificate base64 string (PEM file).
param rootCAFile - Root CA certificate DER file (binary).
param storageType - Type of storage, StorageType::SD and StorageType::SPIFFS.
param GMTOffset - GMT time offset in hour is required to set time in order to make BearSSL
data decryption/encryption to work.
This parameter is only required for ESP8266 Core SDK v2.5.x or later.
Root CA certificate DER file is only supported in Core SDK v2.5.x
void begin(const String &host, const String &auth);
void begin(const String &host, const String &auth, const char *rootCA, float GMTOffset = 0.0);
void begin(const String &host, const String &auth, const String &rootCAFile, uint8_t storageType, float GMTOffset = 0.0);param reconnect - The boolean to set/unset WiFi AP reconnection.
void reconnectWiFi(bool reconnect);param dataObj - Firebase Data Object to hold data and instances.
param millisec - The milliseconds to limit the request (0 - 900,000 ms or 15 min).
void setReadTimeout(FirebaseData &dataObj, int millisec);param dataObj - Firebase Data Object to hold data and instances.
param size - The size identified string e.g. tiny, small, medium, large and unlimited.
Size string and its write timeout e.g. tiny (1s), small (10s), medium (30s) and large (60s).
void setwriteSizeLimit(FirebaseData &dataObj, const String &size);param dataObj - Firebase Data Object to hold data and instances.
return - Boolean type status indicates the success of the operation.
bool getRules(FirebaseData &dataObj);param dataObj - Firebase Data Object to hold data and instances.
param rules - Database rules in jSON String format.
return - Boolean type status indicates the success of the operation.
bool setRules(FirebaseData &dataObj, const String &rules);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path to be checked.
return - Boolean type result indicates whether the defined database
path was existed or not.
bool pathExist(FirebaseData &dataObj, const String &path);return String of unique identifier.
String getETag(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path being read the data.
return - Boolean type status indicates the success of the operation.
Return the child data with its value or JSON object (its values will be truncated to true).
Call [FirebaseData object].dataType to determine what type of data that returned from database.
Call [FirebaseData object].intData to get integer data.
Call [FirebaseData object].floatData to get float data.
Call [FirebaseData object].doubleData to get double data.
Call [FirebaseData object].boolData to get boolean data.
Call [FirebaseData object].stringData to get string data.
Call [FirebaseData object].jsonString to get JSON string data.
Call [FirebaseData object].jsonObject to get FirebaseJson object.
bool getShallowData(FirebaseData &dataObj, const String &path); param dataObj - Firebase Data Object to hold data and instances.
param flag - Boolean value to enable.
This option used to escape the Firewall restriction (if the device is connected through Firewall) that allows only HTTP GET and POST
HTTP PATCH request was sent as PATCH which not affected by this option.
void enableClassicRequest(FirebaseData &dataObj, bool flag);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which to set the priority value.
param priority - The priority value.
return - Boolean type status indicates the success of the operation.
This allows us to set priority to any node other than a priority that set through setJSON, pushJSON, updateNode and updateNodeSilent functions.
The returned priority value from server can read from function [FirebaseData object].priority().
bool setPriority(FirebaseData &dataObj, const String &path, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which to set the priority value.
return - Boolean type status indicates the success of the operation.
The priority value from server can read from function [FirebaseData object].priority().
bool getPriority(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which integer value will be appended.
param intValue - The appended value.
return Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushInt(FirebaseData &dataObj, const String &path, int intValue);
bool push(FirebaseData &dataObj, const String &path, int intValue);bool pushInt(FirebaseData &dataObj, const String &path, int intValue, float priority);
bool push(FirebaseData &dataObj, const String &path, int intValue, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which the float type value will be appended.
param floatValue - The appended value.
return Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushFloat(FirebaseData &dataObj, const String &path, float floatValue);
bool push(FirebaseData &dataObj, const String &path, float floatValue);bool pushFloat(FirebaseData &dataObj, const String &path, float floatValue, float priority);
bool push(FirebaseData &dataObj, const String &path, float floatValue, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which the float value will be appended.
param doubleValue - The appended value.
return Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushDouble(FirebaseData &dataObj, const String &path, double doubleValue);
bool push(FirebaseData &dataObj, const String &path, double doubleValue);bool pushDouble(FirebaseData &dataObj, const String &path, double doubleValue, float priority);
bool push(FirebaseData &dataObj, const String &path, double doubleValue, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which Boolean value will be appended.
param boolValue - The appended value.
return Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushBool(FirebaseData &dataObj, const String &path, bool boolValue);
bool push(FirebaseData &dataObj, const String &path, bool boolValue);bool pushBool(FirebaseData &dataObj, const String &path, bool boolValue, float priority);
bool push(FirebaseData &dataObj, const String &path, bool boolValue, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which string will be appended.
param stringValue - The appended value.
return Boolean type status indicates the success of operation.
The new appended node's key stored in Firebase Data object, which can be accessed via function [FirebaseData object].pushName().
bool pushString(FirebaseData &dataObj, const String &path, const String &stringValue);
bool push(FirebaseData &dataObj, const String &path, const char *stringValue);
bool push(FirebaseData &dataObj, const String &path, const String &stringValue);bool pushString(FirebaseData &dataObj, const String &path, const String &stringValue, float priority);
bool push(FirebaseData &dataObj, const String &path, const char *stringValue, float priority);
bool push(FirebaseData &dataObj, const String &path, const String &stringValue, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which key and value in FirebaseJson object will be appended.
param json - The appended FirebaseJson object.
return Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushJSON(FirebaseData &dataObj, const String &path, FirebaseJson &json);
bool push(FirebaseData &dataObj, const String &path, FirebaseJson &json);Append new child node's key and value (using JSON data or FirebaseJson object) and the virtual child ".priority" to the defined database path.
bool pushJSON(FirebaseData &dataObj, const String &path, FirebaseJson &json, float priority);
bool push(FirebaseData &dataObj, const String &path, FirebaseJson &json, float priority);This will replace any child nodes inside the defined path with array defined in FirebaseJsonArray object.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which key and value in FirebaseJsonArray object will be appended.
param arr - The appended FirebaseJsonArray object.
return Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushArray(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr);
bool push(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr);bool pushArray(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr, float priority);
bool push(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which binary data will be appended.
param blob - Byte array of data.
param size - Size of the byte array.
return Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushBlob(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size);
bool push(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size);bool pushBlob(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size, float priority);
bool push(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size, float priority);param dataObj - Firebase Data Object to hold data and instances.
param storageType - Type of storage to read file data, StorageType::SPIFS or StorageType::SD.
param path - Target database path in which binary data from the file will be appended.
param fileName - File name included its path in SD card/Flash memory.
return Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushFile(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName);
bool push(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName);Append new binary data from the file store on SD card/Flash memory and the virtual child ".priority" to the defined database path.
bool pushFile(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName, float priority);
bool push(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which timestamp will be appended.
return - Boolean type status indicates the success of the operation.
The new appended node's key will be stored in Firebase Data object, which its value can be accessed via function [FirebaseData object].pushName().
bool pushTimestamp(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which integer data will be set.
param intValue - Integer value to set.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].intData will return the integer value of the payload returned from the server.
bool setInt(FirebaseData &dataObj, const String &path, int intValue);
bool set(FirebaseData &dataObj, const String &path, int intValue);bool setInt(FirebaseData &dataObj, const String &path, int intValue, float priority);
bool set(FirebaseData &dataObj, const String &path, int intValue, float priority);Set integer data at the defined database path if defined database path's ETag matched the ETag value.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which integer data will be set.
param intValue - Integer value to set.
param ETag - Known unique identifier string (ETag) of defined database path.
return - Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
If the operation failed due to ETag is not match, call [FirebaseData object].ETag() to get the current ETag value. Also call [FirebaseData object].intData to get the current integer value.
bool setInt(FirebaseData &dataObj, const String &path, int intValue, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, int intValue, const String &ETag);Set integer data and the virtual child ".priority" if defined ETag matches at the defined database path
bool setInt(FirebaseData &dataObj, const String &path, int intValue, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, int intValue, float priority, const String &ETag);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which float data will be set.
param floatValue - Float value to set.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].floatData will return the float value of the payload returned from the server.
bool setFloat(FirebaseData &dataObj, const String &path, float floatValue);
bool set(FirebaseData &dataObj, const String &path, float floatValue);bool setFloat(FirebaseData &dataObj, const String &path, float floatValue, float priority);
bool set(FirebaseData &dataObj, const String &path, float floatValue, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which float data will be set.
param floatValue - Float value to set.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].floatData will return the float value of the payload returned from the server.
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
If the operation failed due to ETag is not match, call [FirebaseData object].ETag() to get the current ETag value. Also call [FirebaseData object].floatData to get the current float value.
bool setFloat(FirebaseData &dataObj, const String &path, float floatValue, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, float floatValue, const String &ETag);Set float data and the virtual child ".priority" if defined ETag matches at the defined database path
bool setFloat(FirebaseData &dataObj, const String &path, float floatValue, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, float floatValue, float priority, const String &ETag);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which float data will be set.
param doubleValue - Double value to set.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].doubleData will return the double value of the payload returned from the server.
Due to bugs in Serial.print in Arduino, to print large double value with zero decimal place, use printf("%.9lf\n", firebaseData.doubleData()); for print the returned double value up to 9 decimal places.
bool setDouble(FirebaseData &dataObj, const String &path, double doubleValue);
bool set(FirebaseData &dataObj, const String &path, double doubleValue);bool setDouble(FirebaseData &dataObj, const String &path, double doubleValue, float priority);
bool set(FirebaseData &dataObj, const String &path, double doubleValue, float priority);Set double data at the defined database path if defined database path's ETag matched the ETag value.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which float data will be set.
param doubleValue - Double value to set.
param ETag - Known unique identifier string (ETag) of defined database path.
return - Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].doubleData will return the double value of payload returned from the server.
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
If the operation failed due to ETag is not match, call [FirebaseData object].ETag() to get the current ETag value. Also call [FirebaseData object].doubeData to get the current double value.
bool setDouble(FirebaseData &dataObj, const String &path, double doubleValue, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, double doubleValue, const String &ETag);Set double data and the virtual child ".priority" if defined ETag matches at the defined database path
bool setDouble(FirebaseData &dataObj, const String &path, double doubleValue, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, double doubleValue, float priority, const String &ETag);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which float data will be set.
param boolValue - Boolean value to set.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].boolData will return the Boolean value of the payload returned from the server.
bool setBool(FirebaseData &dataObj, const String &path, bool boolValue);
bool set(FirebaseData &dataObj, const String &path, bool boolValue);bool setBool(FirebaseData &dataObj, const String &path, bool boolValue, float priority);
bool set(FirebaseData &dataObj, const String &path, bool boolValue, float priority);Set Boolean data at the defined database path if defined database path's ETag matched the ETag value
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which float data will be set.
param boolValue - Boolean value to set.
param ETag - Known unique identifier string (ETag) of defined database path.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].boolData will return the Boolean value of the payload returned from the server.
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
If the operation failed due to ETag is not match, call [FirebaseData object].ETag() to get the current ETag value. Also call [FirebaseData object].doubeData to get the current boolean value.
bool setBool(FirebaseData &dataObj, const String &path, bool boolValue, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, bool boolValue, const String &ETag);Set boolean data and the virtual child ".priority" if defined ETag matches at the defined database path
bool setBool(FirebaseData &dataObj, const String &path, bool boolValue, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, bool boolValue, float priority, const String &ETag);param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which string data will be set.
param stringValue - String or text to set.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].stringData will return the string value of the payload returned from the server.
bool setString(FirebaseData &dataObj, const String &path, const String &stringValue);
bool set(FirebaseData &dataObj, const String &path, const char *stringValue);
bool set(FirebaseData &dataObj, const String &path, const String &stringValue);bool setString(FirebaseData &dataObj, const String &path, const String &stringValue, float priority);
bool set(FirebaseData &dataObj, const String &path, const char *stringValue, float priority);
bool set(FirebaseData &dataObj, const String &path, const String &stringValue, float priority);Set string (text) at the defined database path if defined database path's ETag matched the ETag value
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which string data will be set.
param stringValue - String or text to set.
param ETag - Known unique identifier string (ETag) of defined database path.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].stringData will return the string value of the payload returned from the server.
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
If the operation failed due to ETag is not match, call [FirebaseData object].ETag() to get the current ETag value. Also, call [FirebaseData object].stringData to get the current string value.
bool setString(FirebaseData &dataObj, const String &path, const String &stringValue, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, const char *stringValue, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, const String &stringValue, const String &ETag);Set string data and the virtual child ".priority" if defined ETag matches at the defined database path
bool setString(FirebaseData &dataObj, const String &path, const String &stringValue, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, const char *stringValue, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, const String &stringValue, float priority, const String &ETag);This will replace any child nodes inside the defined path with node' s key and value defined in FirebaseJson object.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which key and value in FirebaseJson object will be replaced or set.
param json - The FirebaseJson object.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonData will return the JSON string value of the payload returned from the server.
Call [FirebaseData object].jsonObject will return the FirebaseJson object of payload returned from server.
bool setJSON(FirebaseData &dataObj, const String &path, FirebaseJson &json);
bool set(FirebaseData &dataObj, const String &path, FirebaseJson &json);bool setJSON(FirebaseData &dataObj, const String &path, FirebaseJson &json, float priority);
bool set(FirebaseData &dataObj, const String &path, FirebaseJson &json, float priority);Set child node's key and value (using JSON data or FirebaseJson object) to the defined database path if defined database path's ETag matched the ETag value
This will replace any child nodes inside the defined path with node' s key and value defined in JSON data or FirebaseJson object.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which key and value in JSON data or FirebaseJson object will be replaced or set.
param jsonString - The JSON string to set (should be valid JSON data).
param json - The FirebaseJson object.
param ETag - Known unique identifier string (ETag) of defined database path.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonData will return the JSON string value of the payload returned from the server.
Call [FirebaseData object].jsonObject will return the FirebaseJson object of payload returned from server.
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
If the operation failed due to ETag is not match, call [FirebaseData object].ETag() to get the current ETag value. Also call [FirebaseData object].jsonData to get the current JSON string value [FirebaseData object].jsonObject to get the FirebaseJson object.
bool setJSON(FirebaseData &dataObj, const String &path, FirebaseJson &json, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, FirebaseJson &json, const String &ETag);Set JSON data or FirebaseJson object and the virtual child ".priority" if defined ETag matches at the defined database path
bool setJSON(FirebaseData &dataObj, const String &path, FirebaseJson &json, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, FirebaseJson &json, float priority, const String &ETag);This will replace any child nodes inside the defined path with array defined in FirebaseJsonArray object.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which key and value in FirebaseJsonArray object will be replaced or set.
param arr - The FirebaseJsonArray object.
return - Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonArray will return pointer to FirebaseJsonArray object contains array payload returned from server, get the array payload using FirebaseJsonArray *arr = firebaseData.jsonArray();
bool setArray(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr);
bool set(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr);bool setArray(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr, float priority);
bool set(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr, float priority);Set array (using JSON data or FirebaseJson object) to the defined database path if defined database path's ETag matched the ETag value.
This will replace any child nodes inside the defined path with array defined in FirebaseJsonArray object.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which key and value in JSON data will be replaced or set.
param arr - The FirebaseJsonArray object.
param ETag - Known unique identifier string (ETag) of defined database path.
return - Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonArray will return pointer to FirebaseJsonArray object contains array payload returned from server, get the array payload using FirebaseJsonArray *arr = firebaseData.jsonArray();
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
If the operation failed due to ETag is not match, call [FirebaseData object].ETag() to get the current ETag value.
Also call [FirebaseData object].jsonArray to get the pointer to FirebaseJsonArray object of current array value.
bool setArray(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr, const String &ETag);Set FirebaseJsonArray object and the virtual child ".priority" if defined ETag matches at the defined database path
bool setArray(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, FirebaseJsonArray &arr, float priority, const String &ETag);This will replace any child nodes inside the defined path with a blob or binary data.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which binary data will be set.
param blob - Byte array of data.
param size - Size of the byte array.
return Boolean type status indicates the success of the operation.
No payload returned from the server.
bool setBlob(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size);
bool set(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size);bool setBlob(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size, float priority);
bool set(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size, float priority);Set blob (binary data) at the defined database path if defined database path's ETag matched the ETag value
This will replace any child nodes inside the defined path with a blob or binary data.
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path in which binary data will be set.
param blob - Byte array of data.
param size - Size of the byte array.
param ETag - Known unique identifier string (ETag) of defined database path.
return Boolean type status indicates the success of the operation.
No payload returned from the server.
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
bool setBlob(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size, const String &ETag);Set blob data and the virtual child ".priority" if defined ETag matches at the defined database path
bool setBlob(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size, float priority, const String &ETag);
bool set(FirebaseData &dataObj, const String &path, uint8_t *blob, size_t size, float priority, const String &ETag);param dataObj - Firebase Data Object to hold data and instances.
param storageType - Type of storage to read file data, StorageType::SPIFS or StorageType::SD.
param path - Target database path in which binary data from the file will be set.
param fileName - File name included its path in SD card/Flash memory.
return Boolean type status indicates the success of the operation.
No payload returned from the server.
bool setFile(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName);
bool set(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName);bool setFile(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName, float priority);
bool set(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName, float priority);Set binary data from a file stored on SD card/Flash memory to the defined database path if defined database path's ETag matched the ETag value
param dataObj - Firebase Data Object to hold data and instances.
param storageType - Type of storage to read file data, StorageType::SPIFS or StorageType::SD.
param path - Target database path in which binary data from the file will be set.
param fileName - File name included its path in SD card/Flash memory.
param ETag - Known unique identifier string (ETag) of defined database path.
return Boolean type status indicates the success of the operation.
No payload returned from the server.
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
bool setFile(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName, const String &ETag);
bool set(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName, const String &ETag);Set binary data from the file and the virtual child ".priority" if defined ETag matches at the defined database path
bool setFile(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName, float priority, const String &ETag);
bool set(FirebaseData &dataObj, uint8_t storageType, const String &path, const String &fileName, float priority, const String &ETag);
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which timestamp will be set.
return - Boolean type status indicates the success of the operation.
Call [FirebaseData object].intData will return the integer value of timestamp in seconds or [FirebaseData object].doubleData to get millisecond timestamp.
Due to bugs in Serial.print in Arduino, to print large double value with zero decimal place, use printf("%.0lf\n", firebaseData.doubleData());.
bool setTimestamp(FirebaseData &dataObj, const String &path);Update child node's key or existing key's value (using FirebaseJson object) under the defined database path
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which key and value in FirebaseJson object will be updated.
param json - The FirebaseJson object used for update.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonData will return the json string value of payload returned from server.
Call [FirebaseData object].jsonObject will return the FirebaseJson object of payload returned from server.
To reduce network data usage, use updateNodeSilent instead.
bool updateNode(FirebaseData &dataObj, const String &path, FirebaseJson &json);Update child node's key or existing key's value and virtual child ".priority" (using JSON data or FirebaseJson object) under the defined database path.
bool updateNode(FirebaseData &dataObj, const String &path, FirebaseJson &json, float priority);Update child node's key or existing key's value (using FirebaseJson object) under the defined database path
param dataObj - Firebase Data Object to hold data and instances.
param path - Target database path which key and value in FirebaseJson object will be updated.
param json - The FirebaseJson object used for update.
return Boolean type status indicates the success of the operation.
Owing to the objective of this function to reduce network data usage, no payload will be returned from the server.
bool updateNodeSilent(FirebaseData &dataObj, const String &path, FirebaseJson &json);
Update child node's key and virtual child ".priority" (using JSON data or FirebaseJson object) under the defined database path.
bool updateNodeSilent(FirebaseData &dataObj, const String &path, FirebaseJson &json, float priority);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the float value is being read.
return - Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].intData, [FirebaseData object].floatData, [FirebaseData object].doubleData, [FirebaseData object].boolData, [FirebaseData object].stringData, [FirebaseData object].jsonObject (pointer), [FirebaseData object].jsonArray (pointer) and [FirebaseData object].blobData corresponded to its type from [FirebaseData object].dataType.
bool get(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the integer value is being read.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].intData will return the integer value of the payload returned from the server.
If the payload returned from server is not integer or float type, the function [FirebaseData object].intData will return zero (0).
If the payload returned from server is float type, the function [FirebaseData object].intData will return rounded integer value.
bool getInt(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the integer value is being read.
param target - The integer type variable to store value.
return Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not an integer, float and double, the target variable's value will be zero (0).
bool getInt(FirebaseData &dataObj, const String &path, int &target);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the float value is being read.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].floatData will return the float value of the payload returned from the server.
If the payload returned from server is not integer or float type, the function [FirebaseData object].intData will return zero (0).
bool getFloat(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the float value is being read.
param target - The float type variable to store value.
return Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not an integer, float and double, the target variable's value will be zero (0).
bool getFloat(FirebaseData &dataObj, const String &path, float &target);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the float value is being rea.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].doubleData will return the double value of the payload returned from the server.
If the payload returned from server is not integer, float and double, the function [FirebaseData object].doubleData will return zero (0).
Due to bugs in Serial.print in Arduino, to print large double value with zero decimal place, use printf("%.9lf\n", firebaseData.doubleData()); for print the returned double value up to 9 decimal places.
bool getDouble(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the float value is being read.
param target - The double type variable to store value.
return Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not an integer, float and double, the target variable's value will be zero (0).
bool getDouble(FirebaseData &dataObj, const String &path, double &target);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the Boolean value is being read.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].boolData will return the Boolean value of the payload returned from the server.
If the payload returned from server is not boolean type, the function [FirebaseData object].boolData will return false.
bool getBool(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the Boolean value is being read.
param target - The boolean type variable to store value.
return Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not Boolean, the target variable's value will be false.
bool getBool(FirebaseData &dataObj, const String &path, bool &target);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the string value is being read.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].stringData will return the string value of the payload returned from the server.
If the payload returned from the server is not string type, the function [FirebaseData object].stringData will return empty string (String object).
bool getString(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the string value is being read.
param target - The String object to store value.
return Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not a string, the target String object's value will be empty.
bool getString(FirebaseData &dataObj, const String &path, String &target);The returned payload JSON string represents the child nodes and their value.
param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the JSON string value is being read.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonData will return the JSON string value of the payload returned from the server.
Call [FirebaseData object].jsonObject will return the FirebaseJson object of payload returned from server.
If the type of payload returned from server is not json, the function [FirebaseData object].jsonObject will contain empty object.
bool getJSON(FirebaseData &dataObj, const String &path);The returned payload JSON string represents the child nodes and their value.
param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the JSON string value is being read.
param target - The FirebaseJson object pointer to get json data
return Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not JSON, the target FirebaseJson object will contain an empty object.
bool getJSON(FirebaseData &dataObj, const String &path, FirebaseJson *target);The returned payload JSON string represents the child nodes and their value.
param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the JSON string value is being read.
param query - QueryFilter class to set query parameters to filter data.
return Boolean type status indicates the success of the operation.
Available query parameters for filtering the data are the following.
QueryFilter.orderBy - Required parameter to specify which data used for data filtering included child key, key, and value.
Use "$key" for filtering data by keys of all nodes at the defined database path.
Use "$value" for filtering data by value of all nodes at the defined database path.
Use "$priority" for filtering data by "virtual child" named .priority of all nodes.
Use any child key to filter by that key.
QueryFilter.limitToFirst - The total children (number) to filter from the first child.
QueryFilter.limitToLast - The total last children (number) to filter.
QueryFilter.startAt - Starting value of range (number or string) of query upon orderBy param.
QueryFilter.endAt - Ending value of range (number or string) of query upon orderBy param.
QueryFilter.equalTo - Value (number or string) matches the orderBy param
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonData will return the JSON string value of the payload returned from the server.
Call [FirebaseData object].jsonObject will return the FirebaseJson object of payload returned from server.
If the type of payload returned from server is not json, the function [FirebaseData object].jsonObject will contain empty object.
bool getJSON(FirebaseData &dataObj, const String &path, QueryFilter &quer);The returned payload JSON string represents the child nodes and their value.
param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the JSON string value is being read.
param target - The FirebaseJson object pointer to get json data.
return Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not JSON, the target FirebaseJson object will contain an empty object.
bool getJSON(FirebaseData &dataObj, const String &path, QueryFilter &query, FirebaseJson *target);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the array is being read.
return - Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonArray will return the pointer to FirebaseJsonArray object contains array value of the payload returned from the the server.
If the type of payload returned from the server is not an array, the array element in [FirebaseData object].jsonArray will be empty.
bool getArray(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the array is being read.
param **`target - The FirebaseJsonArray object pointer to get array value.
return - Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not an array, the target FirebaseJsonArray object will contain an empty array.
bool getArray(FirebaseData &dataObj, const String &path, FirebaseJsonArray *target);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the array is being read.
param query - QueryFilter class to set query parameters to filter data.
return - Boolean type status indicates the success of the operation.
Available query parameters for filtering the data are the following.
QueryFilter.orderBy - Required parameter to specify which data used for data filtering included child key, key, and value. Use "$key" for filtering data by keys of all nodes at the defined database path. Use "$value" for filtering data by value of all nodes at the defined database path. Use "$priority" for filtering data by "virtual child" named .priority of all nodes. Use any child key to filter by that key.
QueryFilter.limitToFirst - The total children (number) to filter from the first child.
QueryFilter.limitToLast - The total last children (number) to filter.
QueryFilter.startAt - Starting value of range (number or string) of query upon orderBy param.
QueryFilter.endAt - Ending value of range (number or string) of query upon orderBy param.
QueryFilter.equalTo - Value (number or string) matches the orderBy param
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].jsonArray will return the pointer to FirebaseJsonArray object contains array of the payload returned from the server.
If the type of payload returned from the server is not an array, the function [FirebaseData object].jsonArray will contain empty array.
bool getArray(FirebaseData &dataObj, const String &path, QueryFilter &query);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the array is being read.
param target - The FirebaseJsonArray object to get array value.
return - Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not an array, the target FirebaseJsonArray object will contain an empty array.
bool getArray(FirebaseData &dataObj, const String &path, QueryFilter &query, FirebaseJsonArray *target);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the binary data is being read.
return Boolean type status indicates the success of the operation.
Call [FirebaseData object].dataType to determine what type of data successfully stores in the database.
Call [FirebaseData object].blobData will return the dynamic array of unsigned 8-bit data (i.e. std::vector<uint8_t>) of
payload returned from server.
If the payload returned from the server is not blob type, the function [FirebaseData object].blobData will return empty array.
bool getBlob(FirebaseData &dataObj, const String &path);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path in which the binary data is being read.
param target - Dynamic array of unsigned 8-bit data (i.e. std::vector<uint8_t>) to store value.
return Boolean type status indicates the success of the operation.
If the type of payload returned from the server is not a blob, the target variable value will be an empty array.
bool getBlob(FirebaseData &dataObj, const String &path, std::vector<uint8_t> &target);The downloaded data will be decoded to binary and save to SD card/Flash memory, then
please make sure that data at the defined database path is the file type.
param dataObj - Firebase Data Object to hold data and instances.
param storageType - Type of storage to write file data, StorageType::SPIFS or StorageType::SD.
param nodePath - Database path that file data will be downloaded.
param fileName - File name included its path in SD card/Flash memory.
return Boolean type status indicates the success of the operation.
bool getFile(FirebaseData &dataObj, uint8_t storageType, const String &nodePath, const String &fileName);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path to be deleted.
return Boolean type status indicates the success of the operation.*
bool deleteNode(FirebaseData &dataObj, const String &path);Delete all child nodes at the defined database path if defined database path's ETag matched the ETag value
param dataObj - Firebase Data Object to hold data and instances.
param path - Database path to be deleted.
param ETag - Known unique identifier string (ETag) of defined database path.
return Boolean type status indicates the success of the operation.*
If ETag at the defined database path does not match the provided ETag parameter, the operation will fail with HTTP code 412, Precondition Failed (ETag is not matched).
bool deleteNode(FirebaseData &dataObj, const String &path, const String &ETag);param dataObj - Firebase Data Object to hold data and instances.
param path - Database path to subscribe.
return Boolean type status indicates the success of the operation.*
bool beginStream(FirebaseData &dataObj, const String &path);Start subscribe to the value changes at the defined parent node path with multiple nodes paths parsing.
param dataObj - Firebase Data Object to hold data and instances.
param parentPath - Database parent node path to subscribe.
param childPath - The string array of child nodes paths for parsing.
param size - The size of string array of child nodes paths for parsing.
return Boolean type status indicates the success of the operation.*
bool beginMultiPathStream(FirebaseData &dataObj, const String &parentPath, const String *childPath, size_t size);Once beginStream was called e.g. in setup(), the readStream function should call inside the loop function.
param dataObj - Firebase Data Object to hold data and instances.
return Boolean type status indicates the success of the operation.
Using the same Firebase Data object for stream read/monitoring associated with reading, store, update, delete will break or quit the current stream connection.
The stream will be resumed or reconnected automatically when calling readStream.
bool readStream(FirebaseData &dataObj);It can be restart again by calling beginStream.
param dataObj - Firebase Data Object to hold data and instances.
return Boolean type status indicates the success of the operation.
bool endStream(FirebaseData &dataObj);param dataObj - Firebase Data Object to hold data and instances.
param storageType - Type of storage to save file, StorageType::SPIFS or StorageType::SD.
param nodePath - Database path to be backup.
param fileName - File name to save.
Only 8.3 DOS format (max. 8 bytes file name and 3 bytes file extension) can be saved to the SD card.
return Boolean type status indicates the success of the operation.
bool backup(FirebaseData &dataObj, uint8_t storageType, const String &nodePath, const String &fileName);param dataObj - Firebase Data Object to hold data and instances.
param storageType - Type of storage to read file, StorageType::SPIFS or StorageType::SD.
param nodePath - Database path to be restored.
param fileName - File name to read.
return Boolean type status indicates the success of the operation.
bool restore(FirebaseData &dataObj, uint8_t storageType const String &nodePath, const String &fileName);setStreamCallback should be called before Firebase.beginStream.
param dataObj - Firebase Data Object to hold data and instances.
param dataAvailablecallback - Callback function that accepts streamData parameter.
param timeoutCallback - Callback function will be called when stream connection was timeout (optional).
dataAvailablecallback will be called When data in the defined path changed or the stream path changed or stream connection was resumed from reading, store, update and delete the node.
The payload returned from the server will be one of these integer, float, string, JSON and blob types.
Call [streamData object].dataType to determine what type of data that successfully store in the database.
Call [streamData object].xxxData will return the appropriate data type of the payload returned from the server.
void setStreamCallback(FirebaseData &dataObj, StreamEventCallback dataAvailablecallback, StreamTimeoutCallback timeoutCallback = NULL);setMultiPathStreamCallback should be called before Firebase.beginMultiPathStream.
param dataObj - Firebase Data Object to hold data and instances.
param multiPathDataCallback - a Callback function that accepts MultiPathStreamData parameter.
param timeoutCallback - a Callback function will be called when stream connection was timeout (optional).
multiPathDataCallback will be called When data in the defined path changed or the stream path changed or stream connection was resumed from getXXX, setXXX, pushXXX, updateNode, deleteNode.
The payload returned from the server will be one of these integer, float, string and JSON.
Call [MultiPathStreamData object].get to get the child node value, type and data path.
The properties [MultiPathStreamData object].value, [MultiPathStreamData object].dataPath, and [MultiPathStreamData object].type will return the value, path of data, and type of data respectively.
These properties will store the result from calling the function [MultiPathStreamData object].get.
void setMultiPathStreamCallback(FirebaseData &dataObj, MultiPathStreamEventCallback multiPathDataCallback, StreamTimeoutCallback timeoutCallback = NULL);param dataObj - Firebase Data Object to hold data and instances.
void removeStreamCallback(FirebaseData &dataObj);param dataObj - Firebase Data Object to hold data and instances.
void removeMultiPathStreamCallback(FirebaseData &dataObj);Set maximum Firebase read/store retry operation (0 - 255) in case of network problems and buffer overflow
param dataObj - Firebase Data Object to hold data and instances.
param num - The maximum retry.
void setMaxRetry(FirebaseData &dataObj, uint8_t num);param dataObj - Firebase Data Object to hold data and instances.
param callback - Callback function that accepts QueueInfo Object as parameter, optional.
The following functions are available from QueueInfo Object accepted by callback.
queueInfo.totalQueues(), get the total Error Queues in Error Queue Collection.
queueInfo.currentQueueID(), get current Error Queue ID that being process.
queueInfo.isQueueFull(), determine whether Error Queue Collection is full or not.
queueInfo.dataType(), get a string of the Firebase call data type that being process of current Error Queue.
queueInfo.method(), get a string of the Firebase call method that being process of current Error Queue.
queueInfo.path(), get a string of the Firebase call path that being process of current Error Queue.
void beginAutoRunErrorQueue(FirebaseData &dataObj, QueueInfoCallback callback = NULL);param dataObj - Firebase Data Object to hold data and instances.
void endAutoRunErrorQueue(FirebaseData &dataObj);Firebase read/store operation causes by network problems and buffer overflow will be added to Firebase Error Queues collection.
param dataObj - Firebase Data Object to hold data and instances.
param num - The maximum Firebase Error Queues.
void setMaxErrorQueue(FirebaseData &dataObj, uint8_t num);Firebase read (get) operation will not be saved.
param dataObj - Firebase Data Object to hold data and instances.
param filename - File name to be saved.
param storageType - Type of storage to save file, StorageType::SPIFS or StorageType::SD.
bool saveErrorQueue(FirebaseData &dataObj, const String &filename, uint8_t storageType);param filename - File name to delete.
param storageType - Type of storage to save file, StorageType::SPIFS or StorageType::SD.
bool deleteStorageFile(const String &filename, uint8_t storageType);param dataObj - Firebase Data Object to hold data and instances.
param filename - Filename to be read and restore queues.
param storageType - Type of storage to read file, StorageType::SPIFS or StorageType::SD.
bool restoreErrorQueue(FirebaseData &dataObj, const String &filename, uint8_t storageType);param dataObj - Firebase Data Object to hold data and instances.
param filename - Filename to be read and count for queues.
param storageType - Type of storage to read file, StorageType::SPIFS or StorageType::SD.
return Number (0-255) of queues store in defined SPIFFS file.
uint8_t errorQueueCount(FirebaseData &dataObj, const String &filename, uint8_t storageType);param dataObj - Firebase Data Object to hold data and instances.
return Number (0-255) of queues in Firebase Data object queue collection.
uint8_t errorQueueCount(FirebaseData &dataObj);param dataObj - Firebase Data Object to hold data and instances.
return Boolean type status indicates whether the Firebase Error Queues collection was full or not.
bool isErrorQueueFull(FirebaseData &dataObj);param dataObj - Firebase Data Object to hold data and instances.
param callback - Callback function that accepts QueueInfo parameter.
void processErrorQueue(FirebaseData &dataObj, QueueInfoCallback callback = NULL);Return 0 if there is no Firebase Error from last operation.
param dataObj - Firebase Data Object to hold data and instances.
return Number of Queue ID.
uint32_t getErrorQueueID(FirebaseData &dataObj);param dataObj - Firebase Data Object to hold data and instances.
param errorQueueID - The Firebase Error Queue ID get from getErrorQueueID.
return - Boolean type status indicates the queue existence.
bool isErrorQueueExisted(FirebaseData &dataObj, uint32_t errorQueueID);param dataObj - Firebase Data Object to hold data and instances.
void clearErrorQueue(FirebaseData &dataObj);Send Firebase Cloud Messaging to device with first registeration token which added by firebaseData.fcm.addDeviceToken
param dataObj - Firebase Data Object to hold data and instances.
param index - The index (starts from 0) of recipient device token which added by firebaseData.fcm.addDeviceToken
return - Boolean type status indicates the success of the operation.
bool sendMessage(FirebaseData &dataObj, uint16_t index);Send Firebase Cloud Messaging to all devices (multicast) which added by firebaseData.fcm.addDeviceToken
param dataObj - Firebase Data Object to hold data and instances.
return - Boolean type status indicates the success of the operation.
bool broadcastMessage(FirebaseData &dataObj);param dataObj - Firebase Data Object to hold data and instances.
return - Boolean type status indicates the success of the operation.
bool sendTopic(FirebaseData &dataObj);param rx - The number of bytes for receive buffer memory for secured mode BearSSL (512 is minimum, 16384 is maximum).
param tx - The number of bytes for transmit buffer memory for secured mode BearSSL (512 is minimum, 16384 is maximum).
Set this option to false to support get large Blob and File operations.
void void setBSSLBufferSize(uint16_t rx, uint16_t tx);param len - The server response buffer size limit.
void setResponseSize(uint16_t len);return WiFi client instance.
WiFiClientSecure *getWiFiClient();param pause True for pause and False for unpause.
return Boolean type status indicates the success of the operation.
bool pauseFirebase(bool pause);return The one of these data type e.g. integer, float, string, JSON and blob.
String dataType();return The one of these event type String e.g. put, patch, cancel, and auth_revoked.
The event type "put" indicated that data at the event path relative to the stream path was completely changed. The event path can be determined by dataPath().
The event type "patch" indicated that data at the event path relative to stream path was updated. The event path can be determined by dataPath().
The event type "cancel" indicated something wrong and cancel by the server.
The event type "auth_revoked" indicated the provided Firebase Authentication Data (Database secret) is no longer valid.
String eventType();return String. of unique identifier.
String ETag();return The database streaming path.
String streamPath();return The database path which belongs to server' s returned payload.
The database path returned from this function in case of stream, also changed upon the child or parent's stream value changes.
String dataPath();return The error description string (String object).
String errorReason();return Integer value.
int intData();return Float value.
float floatData();return Double value.
float doubleData();return Boolean value.
float boolData();return String (String object).
String stringData();return String (String object).
String jsonString();return FirebaseJson object.
FirebaseJson &jsonObject();return **FirebaseJson object **pointer.
FirebaseJson *jsonObjectPtr();return FirebaseJsonArray object.
FirebaseJsonArray &jsonArray();return FirebaseJsonArray object pointer.
FirebaseJsonArray *jsonArrayPtr();return FirebaseJsonData object .
FirebaseJsonData &jsonData();return **FirebaseJsonData object **pointer.
FirebaseJsonData *jsonData();return Dynamic array of 8-bit unsigned integer i.e. std::vector<uint8_t>.
std::vector<uint8_t> blobData();return String (String object).
String pushName();return Boolean type status indicates whether the Firebase Data object is working with the stream or not.
bool isStream();return Boolean type status indicates whether the Firebase Data object is connected to the server or not.
bool httpConnected();Nothing to do when stream connection timeout, the stream connection will be automatically resumed.
return Boolean type status indicates whether the stream was time out or not.
bool streamTimeout();return Boolean type status indicates whether the server returns the new payload or not.
bool dataAvailable();return Boolean type status indicates whether the server returns the stream event-data
payload or not.
bool streamAvailable();Determine the matching between data type that intend to get from/store to database and the server's return payload data type
return Boolean type status indicates whether the type of data being get from/store to database
and the server's returned payload is matched or not.
bool mismatchDataType();return Integer number of HTTP status.
int httpCode();return Boolean of the overflow status.
Total default HTTP response buffer size is 400 bytes which can be set through Firebase.setResponseSize.
bool bufferOverflow();return String (String object) of a file name that stores on SD card/Flash memory after backup operation.
String getBackupFilename();return Number of byte of backup file in byte after backup operation.
size_t getBackupFileSize();void clear();return Error description string* (String object).
String fileTransferError();return Payload string* (String object).
String payload();param serverKey - Server key found on Console: Project settings > Cloud Messaging
void begin(const String &serverKey);param deviceToken - Recipient's device registration token to add that message will be sent to.
void addDeviceToken(const String &deviceToken);param index - Index (start from zero) of recipient's device registration token that added to FCM Data Object of Firebase Data object.
void removeDeviceToken(uint16_t index);void clearDeviceToken();param title - The title text of notification message.
param body - The body text of notification message.
void setNotifyMessage(const String &title, const String &body);param title - The title text of notification message.
param body - The body text of notification message.
param icon - The name and/or included URI/URL of the icon to show on notifying the message.
void setNotifyMessage(const String &title, const String &body, const String &icon);param title - The title text of notification message.
param body - The body text of notification message.
param icon - The name and/or included URI/URL of the icon to show on notifying the message.
param click_action - The URL or intent to accept click event on the notification message.
void setNotifyMessage(const String &title, const String &body, const String &icon, const String &click_action);void clearNotifyMessage();param jsonString - The JSON structured data string.
void setDataMessage(const String &jsonString);param json - The FirebaseJson object.
void setDataMessage(FirebaseJson &json);void clearDataMessage();param priority - The priority string i.e. normal and high.
void setPriority(const String &priority);param key - String of collapse key.
void setCollapseKey(const String &key);param seconds - Number of seconds from 0 to 2,419,200 (4 weeks).
void setTimeToLive(uint32_t seconds);param **`topic - Topic string.
void setTopic(const String &topic);return String of payload returned from the server.
String getSendResult();return instance of an object.
FirebaseJson &clear();param data - The JSON object string.
return instance of an object.
FirebaseJson &setJsonData(const String &data);param key - The new key string that null to be added.
return instance of an object.
FirebaseJson &add(const String &key);param key - The new key string that string value to be added.
param value - The String value for the new specified key.
return instance of an object.
FirebaseJson &add(const String &key, const String &value);param key - The new key string that string (chars array) value to be added.
param value - The char array for the new specified key.
return instance of an object.
FirebaseJson &add(const String &key, const char *value);param key - The new key string that values to be added.
param value - The integer/unsigned short value for new specified key.
return instance of an object.
FirebaseJson &add(const String &key, int value);
FirebaseJson &add(const String &key, unsigned short value);param key - The new key string that double value to be added.
param value - The double value for the new specified key.
return instance of an object.
FirebaseJson &add(const String &key, double value);param key - The new key string that bool value to be added.
param value - The boolean value for the new specified key.
return instance of an object.
FirebaseJson &add(const String &key, bool value);param key - The new key string that FirebaseJson object to be added.
param json - The FirebaseJson object for the new specified key.
return instance of an object.
FirebaseJson &add(const String &key, FirebaseJson &json);param key - The new key string that FirebaseJsonArray object to be added.
param arr - The FirebaseJsonArray for the new specified key.
return instance of an object.
FirebaseJson &add(const String &key, FirebaseJsonArray &arr);param buf - The returning String object.
param prettify - Boolean flag for return the pretty format string i.e. with text indentation and newline.
void toString(String &buf, bool prettify = false);param jsonData - The returning FirebaseJsonData that hold the returned data.
param path - Relative path to the specific node in FirebaseJson object.
param prettify - The bool flag for the prettifying string in FirebaseJsonData's stringValue.
return boolean status of the operation.
The FirebaseJsonData object holds the returned data which can be read from the following properties.
jsonData.stringValue - contains the returned string.
jsonData.intValue - contains the returned integer value.
jsonData.doubleValue - contains the returned double value.
jsonData.boolValue - contains the returned boolean value.
jsonData.success - used to determine the result of get operation.
jsonData.type - used to determine the type of returned value in string represent
the types of value e.g. string, int, double, boolean, array, object, null and undefined.
jsonData.typeNum used to determine the type of returned value is an integer as represented by the following value.
JSON_UNDEFINED = 0
JSON_OBJECT = 1
JSON_ARRAY = 2
JSON_STRING = 3
JSON_INT = 4
JSON_DOUBLE = 5
JSON_BOOL = 6 and
JSON_NULL = 7
bool get(FirebaseJsonData &jsonData, const String &path, bool prettify = false);param data - The JSON data string to parse (optional for replacing the internal buffer with new data).
return number of child/array elements in FirebaseJson object.
size_t iteratorBegin(const char* data = NULL);param index - The element index to get.
param type - The integer which holds the type of data i.e. JSON_OBJECT and JSON_ARR
param key - The string which holds the key/name of an object, can return empty String if the data type is an array.
param value - The string which holds the value for the element key or array.
void iteratorGet(size_t index, int &type, String &key, String &value);void iteratorEnd();param path - The relative path that null to be set.
The relative path can be mixed with array index (number placed inside square brackets) and node names e.g. /myRoot/[2]/Sensor1/myData/[3].
void set(const String &path);param path - The relative path that string value to be set.
param value - The string value to set.
The relative path can be mixed with array index (number placed inside square brackets) and node names e.g. /myRoot/[2]/Sensor1/myData/[3].
void set(const String &path, const String &value);param path - The relative path that string (chars array) to be set.
param value - The char array to set.
The relative path can be mixed with array index (number placed inside square brackets) and node names e.g. /myRoot/[2]/Sensor1/myData/[3].
void set(const String &path, const char *value);param path - The relative path that int value to be set.
param value - The integer/unsigned short value to set.
The relative path can be mixed with array index (number placed inside square brackets) and node names e.g. /myRoot/[2]/Sensor1/myData/[3].
void set(const String &path, int value);
void set(const String &path, unsigned short value);param path - The relative path that double value to be set.
param value - The double value to set.
The relative path can be mixed with array index (number placed inside square brackets) and node names e.g. /myRoot/[2]/Sensor1/myData/[3].
void set(const String &path, double value);param path - The relative path that bool value to be set.
param value - The boolean value to set.
The relative path can be mixed with array index (number placed inside square brackets) and node names e.g. /myRoot/[2]/Sensor1/myData/[3].
void set(const String &path, bool value);param path - The relative path that nested FirebaseJson object to be set.
param json - The FirebaseJson object to set.
The relative path can be mixed with array index (number placed inside square brackets) and node names e.g. /myRoot/[2]/Sensor1/myData/[3].
void set(const String &path, FirebaseJson &json);param path - The relative path that nested FirebaseJsonAtrray object to be set.
param arr - The FirebaseJsonAtrray object to set.
The relative path can be mixed with array index (number placed inside square brackets) and node names e.g. /myRoot/[2]/Sensor1/myData/[3].
void set(const String &path, FirebaseJsonArray &arr);param path - The relative path to remove its contents/children.
return bool value represents the successful operation.
bool remove(const String &path);return instance of an object.
FirebaseJsonArray &add();param value - The String value to add.
return instance of an object.
FirebaseJsonArray &add(const String &value);param value - The chars array to add.
return instance of an object.
FirebaseJsonArray &add(const char *value);param value - The integer/unsigned short value to add.
return instance of an object.
FirebaseJsonArray &add(int value);
FirebaseJsonArray &add(unsigned short value);param value - The double value to add.
return instance of an object.
FirebaseJsonArray &add(double value);param value - The boolean value to add.
return instance of an object.
FirebaseJsonArray &add(bool value);param json - The FirebaseJson object to add.
return instance of an object.
FirebaseJsonArray &add(FirebaseJson &json);param arr - The FirebaseJsonArray object to add.
return instance of an object.
FirebaseJsonArray &add(FirebaseJsonArray &arr);param jsonObj - The returning FirebaseJsonData object that holds data at the specified index.
param index - Index of data in FirebaseJsonArray object.
return boolean status of the operation.
bool get(FirebaseJsonData &jsonObj, int index);
bool get(FirebaseJsonData *jsonData, int index);param jsonObj - The returning FirebaseJsonData object that holds data at the specified path.
param path - Relative path to data in FirebaseJsonArray object.
return boolean status of the operation.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
bool get(FirebaseJsonData &jsonData, const String &path);return length of an array.
size_t size();param buf - The returning String object.
param prettify - Boolean flag for return the pretty format string i.e. with text indentation and newline.
void toString(String &buf, bool prettify = false);return instance of an object.
FirebaseJsonArray &clear();param index - The array index to set null.
void set(int index);param index -The array index that String value to be set.
param value - The String to set.
void set(int index, const String &value);param index - The array index that string (chars array) to be set.
param value - The char array to set.
void set(int index, const char *value);param index - The array index that int/unsigned short to be set.
param value - The integer/unsigned short value to set.
void set(int index, int value);
void set(int index, unsigned short value);param index - The array index that double value to be set.
param value - The double value to set.
void set(int index, double value);param index - The array index that bool value to be set.
param value - The boolean value to set.
void set(int index, bool value);param index - The array index that nested FirebaseJson object to be set.
param value - The FirebaseJson object to set.
void set(int index, FirebaseJson &json);param index - The array index that nested FirebaseJsonArray object to be set.
param value - The FirebaseJsonArray object to set.
void set(int index, FirebaseJsonArray &arr);param path - The relative path that null to be set.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
void set(const String &path);param path - The relative path that string value to be set.
param value - The String to set.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
void set(const String &path, const String &value);param path - The relative path that string (chars array) value to be set.
param value - The char array to set.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
void set(const String &path, const char *value);param path - The relative path that integer/unsigned short value to be set.
param value - The integer value to set.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
void set(const String &path, int value);
void set(const String &path, unsigned short value);param path - The relative path that double value to be set.
param value - The double to set.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
void set(const String &path, double value);param path - The relative path that bool value to be set.
param value - The boolean value to set.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
void set(const String &path, bool value);param path - The relative path that nested FirebaseJson object to be set.
param value - The FirebaseJson object to set.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
void set(const String &path, FirebaseJson &json);param path - The relative path that nested FirebaseJsonArray object to be set.
param value - The FirebaseJsonArray object to set.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
void set(const String &path, FirebaseJsonArray &arr);param index - The array index to be removed.
return bool value represents the successful operation.
bool remove(int index);param path - The relative path to array in FirebaseJsonArray object to be removed.
return bool value represents the successful operation.
The relative path must begin with array index (number placed inside square brackets) followed by other array indexes or node names e.g. /[2]/myData would get the data from myData key inside the array indexes 2.
bool remove(const String &path);param jsonArray -The returning FirebaseJsonArray object.
return bool status for successful operation.
This should call after pares or get functions.
bool getArray(FirebaseJsonArray &jsonArray);param jsonArray - The returning FirebaseJson object.
return bool status for successful operation.
This should call after parse or get function.
bool getJSON(FirebaseJson &json);stringValue The String value of parses data.
intValue The int value of parses data.
doubleValue The double value of parses data.
boolValue The bool value of parses data.
success used to determine the result of Firebase.get operation.
type The type String of parses data e.g. string, int, double, boolean, array, object, null and undefined.
typeNum The type (number) of parses data in form of the following jsonDataType value.
JSON_UNDEFINED = 0
JSON_OBJECT = 1
JSON_ARRAY = 2
JSON_STRING = 3
JSON_INT = 4
JSON_DOUBLE = 5
JSON_BOOL = 6 and
JSON_NULL = 7
success The success flag of parsing data.
The MIT License (MIT)
Copyright (c) 2019 K. Suwatchai (Mobizt)
Permission is hereby granted, free of charge, to any person returning a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.