Tutoriel de formation Firebase Arduino [Eng]

Tutoriel de formation Firebase Arduino [Eng]

...

FirebaseArduino est une bibliothèque pour simplifier la connexion à la base de données Firebase à partir de clients Arduino.

C'est une abstraction complète de l'API REST de Firebase exposée au travers d'appels C ++ d'une manière qui facilite le câblage. Toutes les analyses Json sont gérées par la bibliothèque et vous pouvez utiliser des types C / Arduino purs.

classe FirebaseArduino

Classe principale permettant aux clients Arduino d’interagir avec Firebase.

Cette implémentation est conçue pour suivre les meilleures pratiques Arduino et privilégier la simplicité. Pour des cas d'utilisation plus compliqués et plus de contrôle, voir la classe Firebase dans Firebase.h. Fonctions publiques

void begin (const String et hôte, const String & auth = â € œâ €) Doit être appelé en premier.

Ceci initialise le client avec l'hôte Firebase et les informations d'identification.

Paramètres

- hôte: votre hôte de base de données Firebase, généralement X.firebaseio.com.

- auth: informations d'identification facultatives pour la base de données, un secret ou un jeton.

String pushInt (const String & path, valeur int)

Ajoute la valeur entière au nœud sur le chemin.

Équivalent au POST de l'API REST. Vous devez vérifier le succès () après avoir appelé.

Retour La clé unique du nouveau noeud enfant.

Paramètres

- chemin: le chemin du noeud parent.

- valeur: valeur entière que vous souhaitez ajouter au nœud.

String pushFloat (const String & path, valeur float) Ajoute la valeur float au nœud situé sur le chemin.

Équivalent au POST de l'API REST. Vous devez vérifier le succès () après avoir appelé.

Retour La clé unique du nouveau noeud enfant.

Paramètres

- chemin: le chemin du noeud parent.

- valeur: valeur flottante que vous souhaitez ajouter au nœud.

String pushBool (const String & path, valeur bool) Ajoute la valeur bool au nœud situé sur le chemin.

Équivalent au POST de l'API REST. Vous devez vérifier le succès () après avoir appelé.

Retour La clé unique du nouveau noeud enfant.

Paramètres

- chemin: le chemin du noeud parent.

- valeur: valeur Bool que vous souhaitez ajouter au nœud.

String pushString (const String et chemin, const String et valeur) Ajoute la valeur String au nœud situé sur le chemin.

Équivalent au POST de l'API REST. Vous devez vérifier le succès () après avoir appelé.

Retour La clé unique du nouveau noeud enfant.

Paramètres

- chemin: le chemin du noeud parent.

- value: valeur de chaîne que vous souhaitez ajouter au nœud.

Chaîne push (const String & path, const JsonVariant & value) Ajoute les données JSON au nœud situé sur le chemin.

Équivalent au POST de l'API REST. Vous devez vérifier le succès () après avoir appelé.

Retour La clé unique du nouveau noeud enfant.

Paramètres

- chemin: le chemin du noeud parent.

- valeur: données JSON que vous souhaitez ajouter au nœud.

void setInt (const String & path, valeur int)

Écrit la valeur entière sur le nœud situé dans un chemin équivalent au PUT de l'API REST.

Vous devez vérifier le succès () après avoir appelé.

Paramètres

- chemin: le chemin à l'intérieur de votre base de données vers le nœud que vous souhaitez mettre à jour.

- valeur: valeur entière que vous souhaitez écrire.

void setFloat (const String & path, valeur float)

Écrit la valeur float sur le noeud situé dans un chemin équivalent au PUT de l'API REST.

Vous devez vérifier le succès () après avoir appelé.

Paramètres

- chemin: le chemin à l'intérieur de votre base de données vers le nœud que vous souhaitez mettre à jour.

- valeur: valeur flottante que vous souhaitez écrire.

void setBool (const String & path, valeur bool)

Écrit la valeur bool sur le nœud situé dans un chemin équivalent au PUT de l'API REST.

Vous devez vérifier le succès () après avoir appelé.

Paramètres

- chemin: le chemin à l'intérieur de votre base de données vers le nœud que vous souhaitez mettre à jour.

- valeur: valeur Bool que vous souhaitez écrire.

void setString (const String et chemin d'accès, const String et valeur)

Écrit la valeur String sur le nœud situé dans le chemin correspondant à PUT de l'API REST.

Vous devez vérifier le succès () après avoir appelé.

Paramètres

- chemin: le chemin à l'intérieur de votre base de données vers le nœud que vous souhaitez mettre à jour.

- value: valeur de chaîne que vous souhaitez écrire.

void set (const String & path, const JsonVariant & value) Écrit les données JSON sur le nœud situé sur le chemin.

Équivalent au PUT de l'API REST. Vous devez vérifier le succès () après avoir appelé.

Paramètres

- chemin: le chemin à l'intérieur de votre base de données vers le nœud que vous souhaitez mettre à jour.

- valeur: données JSON que vous souhaitez écrire.

int getInt (const String & path) Obtient la valeur entière située dans chemin.

Vous devez vérifier le succès () après avoir appelé.

Retour La valeur entière située sur ce chemin. Ne sera rempli que si success () est vrai.

Paramètres

- path: le chemin du nœud que vous souhaitez récupérer.

float getFloat (const String & path) Obtient la valeur float située dans path.

Vous devez vérifier le succès () après avoir appelé.

Retour La valeur float située sur ce chemin. Ne sera rempli que si success () est vrai.

Paramètres

- path: le chemin du nœud que vous souhaitez récupérer.

String getString (const String & path) Obtient la valeur de chaîne située dans chemin.

Vous devez vérifier le succès () après avoir appelé.

Retour La valeur de chaîne située sur ce chemin. Ne sera rempli que si success () est vrai.

Paramètres

- path: le chemin du nœud que vous souhaitez récupérer.

bool getBool (const String & path)

Obtient la valeur booléenne située au chemin.

Vous devez vérifier le succès () après avoir appelé.

Retour La valeur booléenne située sur ce chemin. Ne sera rempli que si success () est vrai.

Paramètres

- path: le chemin du nœud que vous souhaitez récupérer.

FirebaseObject get (const String & path) Obtient la valeur de l'objet json située dans chemin.

Vous devez vérifier le succès () après avoir appelé.

Renvoie une valeur FirebaseObject située sur ce chemin. Ne sera rempli que si success () est vrai.

Paramètres

- path: le chemin du nœud que vous souhaitez récupérer.

void remove (const String & path)

Supprimez le nœud et éventuellement l’arborescence complète située dans le chemin.

Vous devez vérifier le succès () après avoir appelé.

Paramètres

- chemin: chemin d'accès au noeud que vous souhaitez supprimer, y compris tous ses enfants.

flux vide (const String & path)

Démarre la diffusion en continu des modifications apportées au nœud situé dans chemin, y compris l’un de ses enfants.

Vous devez vérifier le succès () après avoir appelé. Cela change l'état de cet objet. Une fois que cela est appelé, vous pouvez commencer à surveiller available () et à appeler readEvent () pour obtenir de nouveaux événements.

Paramètres

- chemin: le chemin à l'intérieur de votre base de données vers le nœud que vous souhaitez surveiller.

bool disponible ()

Vérifie si de nouveaux événements sont disponibles.

Cela n'a de sens qu'une fois que stream () a été appelé.

Retour Si un nouvel événement est prêt.

ReadEvent () de FirebaseObject

Lit le prochain événement dans un flux.

Cela n'a de sens qu'une fois que stream () a été appelé.

Return FirebaseObject aura ["type"] qui décrit le type d'événement, ["chemin" qui décrit le chemin effectué et les "données" qui ont été mis à jour.

succès bool ()

Retourne si la dernière commande a réussi.

bool failed ()

Retourne si la dernière commande a échoué.

const Chaîne et erreur ()

Renvoie le message d'erreur de la dernière commande si échec () est vrai.

classe FirebaseObject

Représente la valeur stockée dans firebase, peut être une valeur singulière (nœud feuille) ou une structure arborescente.

Fonctions publiques

FirebaseObject (const char * data) Construit à partir de json.

Paramètres

- data: chaîne au format JSON.

bool getBool (const String & path = “â € œ”) const Retourne la valeur sous la forme d'un booléen.

Retourne le résultat sous forme de bool.

Paramètres

- optionnel: chemin dans l'objet JSON.

int getInt (const String & path = â € œ ») const Retourne la valeur sous la forme d'un entier.

Renvoie le résultat sous forme d'entier.

Paramètres

- optionnel: chemin dans l'objet JSON.

float getFloat (const String & path = â € œ) const Retourne la valeur sous forme de float.

Renvoie le résultat sous forme de float.

Paramètres

- optionnel: chemin dans l'objet JSON.

String getString (const String & path = â € œ) const Retourne la valeur sous forme de chaîne.

Renvoie le résultat sous forme de chaîne.

Paramètres

- optionnel: chemin dans l'objet JSON.

JsonVariant getJsonVariant (const String & path = «â ») const Renvoie la valeur sous la forme d'un JsonVariant.

Renvoie le résultat en tant que JsonVariant.

Paramètres

- optionnel: chemin dans l'objet JSON.

bool success () const

Retour Indique s'il y a eu une erreur de décodage ou d'accès à l'objet JSON.

bool failed () const

Retour Indique s'il y a eu une erreur de décodage ou d'accès à l'objet JSON.

const String & error () const Retourne un message d'erreur en cas d'échec () est vrai.