Connectez Home Assistant, une balance ESP32 ou un script Python à un compte TigerTag.
Ce dépôt décrit comment n'importe quel client se connecte avec les identifiants TigerTag de l'utilisateur, lit ses bobines de filament et ses racks dans Firestore, et y réécrit le poids des bobines. Ce qui est documenté ici est ce qui est déployé, et chaque modification est consignée dans le changelog.
users/{uid}/inventoryTous les clients suivent les mêmes quatre étapes : récupérer la configuration Firebase publique, se connecter en tant qu'utilisateur, appeler l'API REST de Firestore avec le jeton de l'utilisateur, et garder ce jeton à jour.
Un seul GET renvoie la configuration du projet Firebase. L'apiKey est publique par conception : elle identifie le projet, pas l'appelant. Mettez-la en cache ; un rafraîchissement hebdomadaire suffit.
01-firebase-config.mdL'e-mail et le mot de passe de l'utilisateur renvoient un UID, un idToken valable 1 heure et un refreshToken. Google Sign-In exige un navigateur : les clients sans interface utilisent donc un mot de passe.
02-authentication.mdEnvoyez l'idToken comme jeton Bearer. Les bobines se trouvent dans users/{uid}/inventory, les racks dans users/{uid}/racks ; les poids sont en grammes nets, les dates en millisecondes Unix.
03-data-model.mdRafraîchissez l'idToken avant la fin de l'heure et remplacez les deux jetons stockés. En cas de permission-denied, rafraîchissez une fois et relancez la lecture une fois.
Rafraîchir l'idTokenGET https://tigertag-cdn.web.app/__/firebase/init.json
POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key={apiKey}
{ "email": "user@example.com", "password": "…", "returnSecureToken": true }
GET https://firestore.googleapis.com/v1/projects/{projectId}/databases/(default)/documents/users/{uid}/inventory
Authorization: Bearer {idToken}Les valeurs entre accolades proviennent de l'appel précédent : apiKey et projectId de la configuration, uid et idToken de la connexion.
Chaque guide de docs/clients couvre l'authentification, les données lues ou écrites, la correspondance des champs et le code. Les extraits ci-dessous sont copiés des guides.
Un composant personnalisé Home Assistant qui expose un capteur par bobine, dont l'état est le poids restant en grammes. Le guide couvre aussi les inventaires des amis, la pagination et le stockage des jetons ; le config flow et le capteur sont des squelettes, et un composant entièrement fonctionnel reste à écrire.
{
"domain": "tigertag",
"name": "TigerTag",
"version": "0.1.0",
"requirements": ["pyrebase4>=4.5.0"],
"config_flow": true,
"iot_class": "cloud_polling"
}Pour une balance ou un appareil NFC : retrouver une bobine à partir de l'UID RFID scanné (uid, puis twin_uid), calculer le poids net et écrire weight_available et last_update avec un masque de mise à jour. Le guide se termine par un sketch ESP32 complet (WiFi, ArduinoJson).
weight_available = max(0, measured_raw_weight - container_weight)Un client Python minimal basé sur Pyrebase4 : il se connecte, liste vos bobines et affiche le nombre de bobines de chaque ami. Le guide contient le script entier et un exemple d'exécution.
pip install -r requirements.txt
python tigertag_client.pyUne passerelle à sens unique de TigerTag vers une instance Spoolman : les marques deviennent des fournisseurs, chaque combinaison marque, matériau et couleur devient un filament, et chaque document d'inventaire devient une bobine, créée ou mise à jour via l'API REST de Spoolman. À lancer depuis cron, systemd ou Docker.
pip install -r requirements.txt
export TIGERTAG_EMAIL=you@example.com
export TIGERTAG_PASSWORD=yourpassword
export SPOOLMAN_URL=http://192.168.1.10:7912
export DRY_RUN=1 # dry-run mode
python3 sync.pyLe contrat que suit une TigerScale ou une balance compatible pour apparaître en ligne dans Tiger Studio Manager et l'application mobile TigerTag : un document de heartbeat toutes les 30 secondes, une mise à jour du poids à chaque mesure stable, et des tags jumeaux écrits en un seul lot atomique.
users/{uid}/scales/{mac} ← heartbeat, every 30 s
users/{uid}/inventory/{spoolId} ← weight_available + last_updateVous développez pour une autre plateforme ? Un nouveau guide va dans docs/clients, un exemple exécutable facultatif dans examples/. CONTRIBUTING.md
Aucune clé partagée à protéger, aucun jeton maître susceptible de fuir : un client peut faire exactement ce que son utilisateur peut faire, et Firestore l'impose côté serveur.
Chaque client se connecte avec les identifiants de l'utilisateur final. N'embarquez jamais le SDK firebase-admin ni aucune clé d'administration dans un client tiers.
Les Firestore Security Rules vérifient chaque requête par rapport à request.auth.uid : les propriétaires lisent et écrivent leurs propres documents, les amis peuvent lire l'inventaire et les racks, et tout ce qui n'est pas autorisé est refusé. La copie publique des règles se trouve dans rules/firestore.rules.
Accepter une demande d'ami écrit un document de chaque côté. Tant que users/{friend}/friends/{you} existe, vous pouvez lire l'inventaire et les racks de cet ami, en lecture seule ; le supprimer coupe l'accès immédiatement.
04-friend-system.mdInterrogez au plus toutes les 5 minutes, jamais en dessous de 30 secondes, n'écrivez que lorsqu'une valeur change, et passez une limite aux lectures de listes (200 bobines, 50 racks). Firebase App Check n'est pas imposé.
05-rate-limiting.mdLe dépôt est traité comme un contrat public : les changements qui touchent les clients arrivent dans ce dépôt dans la même version, et le changelog consigne chacun d'eux sous Added, Changed, Deprecated, Removed, Fixed ou Security.
Les documents de base sur lesquels repose toute intégration, dans l'ordre où un client en a besoin.
Ce guide couvre le compte cloud. Les puces, les applications et les SDK ont leurs propres dépôts.
Le format ouvert de puce NFC pour les bobines de filament et les flacons de résine, sa spécification et la base de données de référence.
OuvrirL'application de bureau (Electron) qui gère le même inventaire ; la documentation est vérifiée par rapport à ses versions.
DépôtLire, vérifier, créer et modifier des puces TigerTag hors ligne, en JavaScript ou en Python, sous Apache-2.0.
Non. Chaque client se connecte avec l'e-mail et le mot de passe TigerTag de l'utilisateur final, et les Firestore Security Rules décident de ce que cet utilisateur peut lire ou écrire. Il n'existe aucune clé d'administration partagée, et le SDK firebase-admin ne doit jamais être utilisé dans un client tiers.
L'apiKey identifie le projet Firebase de TigerTag, pas l'appelant. Sans idToken valide, obtenu en se connectant en tant qu'utilisateur réel, elle ne donne accès à rien ; le contrôle d'accès repose sur l'authentification et sur les Security Rules.
Pas directement : Google Sign-In nécessite une redirection dans un navigateur. Un utilisateur qui n'a jamais utilisé que Google définit d'abord un mot de passe sur son compte, via la procédure de mot de passe oublié de l'application de bureau ou mobile, puis se connecte avec son e-mail et son mot de passe.
Au plus toutes les 5 minutes pour un capteur, toutes les 15 minutes pour une vue d'ensemble des racks, et jamais en dessous de 30 secondes. Une balance n'écrit que lorsqu'un poids change. Les lectures de listes doivent passer une limite : 200 pour l'inventaire, 50 pour les racks.
Oui, en lecture seule. Lorsque deux utilisateurs sont amis, chacun possède un document pour l'autre sous users/{uid}/friends, et les règles permettent à un ami de lire l'inventaire et les racks. Chacun des deux peut mettre fin à l'amitié à tout moment, ce qui coupe l'accès immédiatement.
La documentation fait foi : un écart signifie qu'une régression a été livrée. Ouvrez une issue sur le dépôt avec la page, le chemin lu ou écrit et la réponse, en retirant les jetons et les clés privées.
Les Security Rules et tous les extraits de code de la documentation sont sous Apache-2.0, et l'attribution n'est pas exigée pour les extraits collés dans votre propre projet. La documentation elle-même est sous CC-BY-4.0. Le nom, le logo et le service TigerTag ne sont pas couverts par ces licences.
Choisissez le guide de votre plateforme dans les liens rapides du README, et suivez-le de la connexion jusqu'à votre première lecture.