Glossaire
Cette page définit les termes produit utilisés dans la documentation de Fundamentum, par ordre alphabétique. Chaque terme renvoie vers la page où vous pouvez en savoir plus.
Action
Requête que vous définissez vous-même et envoyez à un ou plusieurs appareils, avec votre propre charge utile. Fundamentum suit chaque action appareil par appareil, de l'état en attente à envoyée, en cours, puis succès, échec ou expiration, et vous permet de l'annuler ou de la relancer. Une action peut être traduite pour chaque modèle d'appareil par un encodeur. Voir Opérer à distance.
Type d'action
Le modèle d'une action : il définit les délais d'expiration, le nombre de nouvelles tentatives et la priorité de l'action. Les types d'action sont définis par projet ; Fundamentum fournit également des types génériques partagés par tous les projets.
Alerte
Une occurrence d'une règle d'alerte pour un appareil. Une alerte est ouverte tant que toutes les conditions de la règle sont remplies, et prend fin lorsque l'une d'elles n'est plus remplie, lorsque la règle est modifiée ou supprimée, ou lorsqu'un utilisateur la résout. Une seule alerte par règle et par appareil est ouverte à la fois.
Règle d'alerte
Ensemble de une à dix conditions sur les états des appareils, qui déclenche une alerte pour chaque appareil remplissant toutes ces conditions. Une règle possède un niveau de gravité, s'applique à un projet entier ou à un seul registre, peut porter des messages en anglais et en français, et désigne les utilisateurs ou les rôles à notifier par e-mail et dans l'application. Voir Alertes.
Type d'actif
Le nombre qui identifie un type d'appareil, aussi appelé identifiant de type d'actif. Les appareils le fournissent lors de leur provisionnement pour indiquer de quel modèle ils sont. Les valeurs positives sont à votre disposition ; les valeurs négatives sont réservées à Fundamentum.
Lot
Une commande envoyée à de nombreux appareils à la fois, comme une mise à jour du micrologiciel à l'échelle d'un parc. Un lot est suivi appareil par appareil, et vous pouvez annuler ou relancer toutes ses commandes ayant un statut donné.
Balise
Appareil qu'une passerelle détecte par voie hertzienne, sans qu'aucun des deux ne maintienne de connexion. La passerelle rapporte ce que dit la balise dans ses propres états, avec la puissance du signal de la balise. Une balise est un appareil comme les autres, avec son propre numéro de série.
Compte de facturation
Le compte auquel sont facturés les projets d'une organisation. Chaque organisation en possède un par défaut, et peut en ajouter d'autres, par exemple pour séparer les coûts de développement et de production.
Capability
Action nommée qu'un appareil peut effectuer, comme redémarrer ou mettre à jour son micrologiciel. Pour chaque type d'appareil, et éventuellement chaque version de micrologiciel, une capability est liée à l'encodeur qui sait l'envoyer à ce matériel. C'est ainsi que la même action fonctionne sur différents modèles.
Fonction cloud
Votre propre code, écrit en Go, Rust, JavaScript ou Python, que Fundamentum exécute pour vous dans un bac à sable. Une fonction est déclenchée par un appel HTTP ou par un message sur un topic, et peut publier son résultat sur d'autres topics de son projet. Les fonctions cloud décodent, enrichissent et acheminent les données, et servent d'encodeurs. Voir Fonctions cloud.
Commande
Instruction prédéfinie dont la charge utile est définie par la plateforme, comme le redémarrage, la mise à jour du micrologiciel ou la mise à jour de la configuration. Une commande est conservée jusqu'à ce que son appareil soit en ligne pour la recevoir. Pour les instructions que vous définissez vous-même, voir action.
Configuration
Les paramètres qu'un appareil applique, sous forme de JSON libre. Un appareil démarre avec la configuration par défaut de son type d'appareil, et la reçoit lorsqu'il se connecte. La modifier envoie à l'appareil une commande de mise à jour de la configuration.
Connect
Le produit d'identité et d'accès de Fundamentum : la connexion OAuth2 pour tous les utilisateurs et applications, avec l'authentification unique Google et Microsoft, et la gestion des organisations, des projets, des utilisateurs, des rôles, des comptes de service et des licences.
Connecteur
Un lien entre votre projet et l'un de vos propres systèmes : votre broker MQTT (MQTT ou MQTTS, avec TLS mutuel) ou votre point de terminaison HTTPS. Via ses liens, un connecteur transmet les données de vos topics à votre système dès leur arrivée, ou fait entrer dans Fundamentum des données issues de votre système. Voir Connecteurs.
Action personnalisée
Octets bruts, dans le format que votre projet définit, remis à un appareil via le topic des actions personnalisées du registre. Fundamentum les transporte sans les lire, et n'attend aucune réponse.
Appareil
Objet connecté physique enregistré dans un registre. Un appareil est adressé par son projet, sa région, son registre et son numéro de série, appartient à un type d'appareil et s'authentifie avec sa propre paire de clés RSA. Les passerelles, les sous-appareils et les balises sont tous des appareils.
Type d'appareil
Le modèle à partir duquel un appareil est créé. Il porte une configuration par défaut et des métadonnées, la politique de heartbeat, ses versions de micrologiciel et ses capabilities, ainsi que des indicateurs tels que passerelle ou LoRaWAN. Il est identifié par son type d'actif. Fundamentum fournit des types d'appareil génériques partagés par tous les projets ; vous créez les vôtres par projet.
Devices API
L'API REST utilisée par les appareils et les outils d'usine : provisionnement, appareils en stock, et une alternative HTTPS à MQTT pour la télémétrie, les états et les heartbeats. Servie à l'adresse https://devices.fundamentum-iot.com. Voir Devices API v3.
Dimension
Dans Insight, table qui décrit les éléments auxquels les faits font référence, comme un appareil ou l'une de vos propres entités. Insight conserve à la fois l'historique complet de chaque dimension et sa valeur actuelle. Désigne aussi un type de topic qui alimente ces tables.
Edge
Les composants officiels et facultatifs côté appareil : un daemon pour les appareils Linux, une bibliothèque pour les microcontrôleurs et un agent de redirection de ports. Voir Composants Edge.
Encodeur
Une fonction cloud qui transforme une requête de haut niveau en la charge utile qu'un modèle d'appareil donné comprend, ainsi que le protocole utilisé pour la remettre. Les encodeurs sont liés aux capabilities par type d'appareil et par version de micrologiciel. Voir Actions et encodeurs personnalisés.
Fait
Dans Insight, table d'événements ou de mesures, une ligne par occurrence, enrichie de ses dimensions. Désigne aussi un type de topic qui alimente ces tables.
Version de micrologiciel
Une version du micrologiciel d'un type d'appareil, avec ses fichiers. Fundamentum enregistre la version exécutée par chaque appareil, et un appareil peut être mis à jour lorsqu'une version plus récente existe pour son type.
CLI fun
L'outil en ligne de commande de Fundamentum pour macOS, Linux et Windows. Il vous connecte via votre navigateur, expose toute la Public API avec fun api, et fournit des commandes dédiées pour la redirection de ports, les transferts de fichiers et les fonctions cloud. Voir La CLI fun.
Topic Fundamentum
Flux d'événements de la plateforme, comme les alertes ou les changements d'appareils, que vous activez pour votre projet. Une fois activé, il est remis dans un topic de votre projet, où vous le consommez comme les vôtres.
Passerelle
Un appareil qui se connecte à Fundamentum et rapporte pour le compte d'autres : ses sous-appareils et les balises qu'il détecte. Une passerelle est un appareil dont le type d'appareil est marqué comme passerelle. Voir Passerelles et sous-appareils.
Heartbeat
Message périodique par lequel un appareil indique qu'il est en vie, accompagné de son temps de fonctionnement. Les heartbeats, et tout autre trafic de l'appareil, le maintiennent marqué comme connecté ; un appareil silencieux plus longtemps que le délai d'expiration de son type d'appareil devient déconnecté. Le heartbeat d'une passerelle peut inclure ses sous-appareils.
Hub
L'application web de Fundamentum pour la gestion des appareils : registres, appareils et passerelles, états, alertes, mises à jour du micrologiciel, actions, topics, connecteurs et terminal distant. Servie à l'adresse https://hub.fundamentum-iot.com.
Hystérésis
Seuil de libération facultatif sur une condition de règle d'alerte utilisant > ou <. Une fois la condition déclenchée, elle le reste jusqu'à ce que la valeur franchisse le seuil de libération, et non simplement le seuil d'origine. Cela évite qu'une valeur oscillant autour de sa limite ne déclenche et ne lève des alertes à répétition.
Insight
L'entrepôt de données sans code de Fundamentum. Il assemble vos flux de faits et de dimensions en un schéma en étoile dans une base de données dédiée à chaque instance, interrogeable en SQL via le protocole MySQL. Voir Analyser avec Insight.
Instance Insight
Un entrepôt de données Insight : son pipeline, sa base de données et ses utilisateurs SQL, appartenant à un projet. Un projet peut avoir plusieurs instances, chacune avec sa propre base de données et ses propres ressources isolées.
Invitation
La manière dont un rôle est attribué à une personne : un e-mail l'invitant à se connecter, après quoi le rôle est attribué sur le projet, la licence ou le site nommé dans l'invitation.
Licence
Accès à une partie de votre projet, généralement pour l'un de vos propres clients. Une licence est d'un type de licence, possède ses propres valeurs d'options et métadonnées, et a ses propres utilisateurs, qui n'ont pas besoin d'accéder au reste du projet. Les sites appartiennent à une licence. Voir Licences : servir vos propres clients.
Type de licence
Un type de licence défini par un projet, déclarant les options que portent ses licences, comme une capacité ou une adresse, avec leurs types et leurs valeurs par défaut.
Lien
La liaison entre un connecteur et l'un des topics de votre projet : elle indique la destination sur votre système et le sens du flux.
Broker MQTT
Le lien privé et sécurisé de chaque appareil avec Fundamentum : MQTT 5 sur TLS, sur le port 8883. Un appareil ne peut publier et s'abonner qu'à ses propres topics ; il n'y a aucun trafic d'appareil à appareil. Voir Topics MQTT et formats de message.
Organisation
Le sommet de la hiérarchie : votre entreprise. Une organisation contient vos projets et vos comptes de facturation.
Permission
Le droit d'effectuer une action, comme lister, afficher, créer, mettre à jour ou supprimer, sur un type de ressource. Les permissions sont regroupées en rôles.
Projet
L'unité principale d'isolation dans Fundamentum. Les registres et les appareils, les topics, les fonctions cloud, les règles d'alerte, les instances Insight et les comptes de service appartiennent tous à un projet, et la plupart des rôles sont accordés par projet.
Provisionnement
Enregistrement d'un appareil afin qu'il existe dans Fundamentum et puisse s'authentifier, et renvoi de la configuration et des détails de connexion MQTT dont il a besoin. Un appareil peut se provisionner lui-même, être préenregistré comme appareil en stock, ou être créé par sa passerelle. Voir Provisionnement.
Clé de provisionnement
Clé à durée limitée qui autorise les opérations sur les appareils en stock pour un projet, généralement utilisée sur une chaîne de production. Une clé est active de sa date de début jusqu'à sa date de fin.
Secret de provisionnement
Le secret d'un registre qu'un appareil présente pour s'y provisionner lui-même. Il est inclus dans le fichier de jeton du registre.
Fenêtre de provisionnement
La période pendant laquelle un registre accepte de nouveaux appareils. En dehors de celle-ci, l'auto-provisionnement dans le registre est refusé.
Public API
L'API REST unique derrière le Hub, la CLI fun et vos applications, servie à l'adresse https://api.fundamentum-iot.com et décrite par des spécifications OpenAPI publiées. Voir Public API.
Quota
Le nombre maximal d'appareils d'un type d'appareil donné qu'un registre accepte via l'auto-provisionnement.
Région
Élément de l'adresse de chaque appareil, avec le projet, le registre et le numéro de série. Fundamentum utilise actuellement la région 1.
Registre
Conteneur d'appareils au sein d'un projet, utilisé pour segmenter un parc par site, client ou type d'installation. Un registre définit les paramètres de connexion de ses appareils, son secret de provisionnement, sa fenêtre de provisionnement, ses quotas et ses topics.
Rôle
Ensemble nommé de permissions, accordé à un utilisateur ou à un compte de service sur une organisation, un projet, une licence ou un site. Voir Rôles et permissions.
Numéro de série
L'identifiant d'un appareil au sein de son registre. Il est unique dans le registre et insensible à la casse ; dans la Devices API v3, il doit être en minuscules et ne contenir que des lettres, des chiffres, _ et -. Le même numéro de série dans un autre registre correspond à un autre appareil.
Compte de service
Identité non humaine appartenant à un projet, utilisée par vos systèmes back-end et vos scripts. Il détient des rôles comme un utilisateur, et vous lui délivrez des jetons pour appeler la Public API.
Niveau de gravité
La criticité d'une règle d'alerte, portée par ses alertes. Du plus bas au plus élevé : info, advisory, warning, minor, major, critical. Une règle sans niveau est critical.
Appareil en stock
Appareil enregistré avant que sa destination ne soit connue, généralement en usine, avec son numéro de série et sa clé publique. Un appareil en stock ne peut pas se connecter tant qu'il n'est pas affecté à un registre ; il peut être remis en stock puis affecté ailleurs plus tard. Voir Appareils en stock et clés de provisionnement.
Site
Emplacement physique sous une licence, comme un bâtiment ou un parking de l'un de vos clients, avec une adresse et des coordonnées facultatives. Un site est divisé en zones.
État
Observation clé/valeur rapportée par un appareil à un instant donné, comme "temperature": 21.5. La valeur peut être n'importe quelle valeur JSON. Fundamentum conserve l'historique des états de chaque appareil et leurs dernières valeurs. Contrairement à la télémétrie, les états sont stockés par la plateforme.
Sous-appareil
Appareil situé derrière une passerelle, relié à elle par câble ou appairé, avec son propre numéro de série mais sans connexion propre. La passerelle envoie sa télémétrie, ses états et ses heartbeats en son nom.
Télémétrie
Données qu'un appareil envoie dans n'importe quel format, transmises telles quelles au topic de télémétrie de son registre. Fundamentum transporte la télémétrie sans la stocker ni l'interpréter.
Fichier de jeton
Fichier que le Hub génère pour un registre, contenant tout ce dont un appareil a besoin pour s'y provisionner lui-même : l'URL de la Devices API, l'hôte et le port MQTT, le projet, la région et le registre, ainsi que le secret de provisionnement.
Topic
Canal de messages nommé d'un projet sur le bus d'événements de Fundamentum. Chaque projet possède des topics par défaut pour la télémétrie, les états et les actions personnalisées, ainsi que vos propres topics et les topics Fundamentum que vous activez. Les topics alimentent les connecteurs, les fonctions cloud et Insight. Voir Topics.
Temps de fonctionnement
Le nombre de secondes écoulées depuis le dernier démarrage d'un appareil, porté par ses heartbeats. Lorsque le temps de fonctionnement diminue entre deux heartbeats, l'appareil a redémarré.
Zone
Subdivision d'un site, comme un étage, un niveau de parking ou une pièce. Les zones peuvent être imbriquées à n'importe quelle profondeur, et peuvent être affichées sur une carte, par une adresse ou sur un plan d'étage 2D.