Ajouter un équipement MQTT - Equipements MQTT

2. MANUEL UTILISATEUR DU PORTAIL LIVE OBJECTS

2.4. Gestion du parc d’équipements

2.4.8. Equipements MQTT

2.4.8.1. Ajouter un équipement MQTT

L’ajout d’un équipement MQTT dans Live Objects est automatique. Lors de sa première connexion à Live Objects l’équipement s’enregistre de lui-même et remonte des informations qui lui sont propres (version de firmware, paramètres). Pour cela l’équipement devra avoir été dûment configuré (Voir le guide développeur https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#MQTT_MODE_DEVICE)

Un certain nombre d’attributs peuvent être ajoutés à un équipement pour faciliter sa gestion dans Live Objects (groupes, propriétés, tags). Ces attributs ne sont pas stockés au niveau de l’équipement mais restent au niveau plateforme.

Il est également possible d’ajouter un équipement MQTT dans Live Objects avant sa première connexion à la plateforme. Cela permet par exemple de préparer une flotte en renseignant à l’avance les attributs ci-dessus. Pour cela cliquez sur le bouton « Ajouter un équipement » du

Nom : Le champ nom permet d’attribuer un nom familier à votre équipement

MQTT client Id : Il s’agit du paramètre de connexion MQTT du même nom utilisé l’équipement pour se connecter

ID de l’équipement : Il s’agit de l’identifiant unique de l’équipement dans Live Objects. De la forme URN (Unique Resource Naming). L’espace de nommage (ou « namespace* ») ainsi que l’identifiant de l’équipement à l’intérieur de cet espace de nommage (« id ») peut-être personnalisé.

Stream Id par défaut : Il s’agit de la série temporelle par défaut dans lequel les messages émis par l’équipement seront stockés

Groupe : Le groupe d’équipements auquel ajouter l’objet. Par défaut seul le groupe racine (« root ») est proposé. (Voir la partie « Gestion de groupes »)

Tags : Etiquette en saisie libre. Les tags peuvent être utilisés pour trier facilement les équipements (par exemple « demo »). Vous pouvez saisir jusqu’à 10 tags de 32 caractères par équipement.

Propriétés : couples clé-valeur en saisie libre. Exemple : type d’équipement, fabricant, modèle…

* L'espace de noms fournit une dénomination cohérente pour un ensemble d’équipements. Par

groupe etc). Les données qui auront été remontées par cet équipement ne sont pas supprimées et restent accessibles dans l’onglet « Données ».

Pour supprimer un ou plusieurs équipements, sélectionner les équipements concernés en cochant la case correspondante dans la liste, et cliquer sur l’icône « Supprimer ».

2.4.8.3. Détail d’un équipement MQTT

Pour accéder aux informations détaillées concernant un équipement MQTT, cliquez sur l’équipement désiré dans la liste principale du menu « Parc ».

Le menu Supervision affiche l’état de l’équipement et de ses interfaces de connectivité.

- Date de dernière communication

- Alarme en cours, si une règle d’alarme a été définie pour cet équipement (Voir paragraphe

« Alarmes »)

- Etat de l’interface de connectivité:

o Statut de connectivité (Voir paragraphe « Etat des équipements ») o Paramètres de connexion MQTT

o Capacités de l’équipement concernant les opérations de device management (réception de commandes, mises à jour de configuration, firmware). Voir le guide développeur pour plus de détails sur le fonctionnement des équipements en

MQTT :

https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#MQTT_MODE_DEVICE

Le menu Identité d’afficher et de modifier les informations relatives à l’équipement et ses interfaces de connectivité.

Modification des attributs de l’équipement

2.4.8.4. Mettre à jour les paramètres d’un équipement MQTT

Un équipement peut posséder des paramètres qui lui sont propres comme des paramètres usine, ou applicatifs embarqués directement dans son micro code. Si l’équipement le permet ces paramètres peuvent être gérés dans Live Objects. L’équipement devra avoir préalablement remonté ces paramètres à Live Objects lors de sa connexion en MQTT (voir les topics réservés mentionnés dans le paragraphe précédent). Il est également possible de définir des valeurs cibles sur des paramètres d'un device que celui-ci n’a encore jamais remontés

La visualisation et la mise à jour des paramètres se fait dans le menu « Paramètres »

Désactivation/réactivation de l’interface de connectivité

Pour effectuer une mise à jour d’un paramètre, cliquez sur le paramètre concerné

Saisir les nouvelles valeurs de paramètres et cliquez sur le bouton « Mettre à jour ». Répétez l’opération pour chaque paramètre à modifier.

Les changements à appliquer figurent dans la colonne « Valeur cible ». Pour les envoyer à l’équipement cliquez sur le bouton « Envoyer les changements ».

Tant que vous n’avez pas cliqué sur le bouton « Envoyer les changements » vous pouvez annuler

Le statut passe à l’état « Envoyé » est reste dans cet état tant que l’équipement n’a pas acquitté la demande.

Une fois que l’équipement a répondu à la demande de mise à jour le statut passe à la valeur :

 none : Le paramètre a été créé depuis le portail Live Objects ou remonté par le device mais aucune demande de mise à jour n’a jamais été faite

 pending : Le device n’est pas prêt à recevoir la demande de mise à jour (il n’a pas souscrit au topic dev/cfg/upd (Voir la documentation développeur https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#_summary)

 sent : la demande a été envoyée au device et a été reçue (souscription au topic de mise à jour détectée)

 ok : L’équipement a reçu la demande de mise à jour et a confirmé son traitement en renvoyant à Live Objects des paramètres de valeurs identiques à la demande de mise à jour (publication de la réponse sur le topic dev/cfg)

 failed : L’équipement a reçu la demande mais a répondu à Live Objects en renvoyant des paramètres de valeurs différentes de celles envoyées dans la demande de mise à jour.

Il est également possible de positionner un paramètre à une valeur avant même que l’équipement ne se soit connecté et n’ai donc remonté ce paramètre, par exemple dans le cadre d’une procédure d’initialisation ou de provisioning. Pour cela cliquer sur le bouton « Ajouter un paramètre »

Id est le nom du paramètre. Il ne peut pas contenir les caractères «.» ou «$» et a une longueur maximum de 128 caractères

2.4.8.5. Envoyer une commande à un équipement MQTT

Pour envoyer une commande à un équipement MQTT allez dans les détails de l’équipement et cliquez sur la rubrique « Commandes (Downlink)». L’historique des commandes est affiché.

Pour afficher les détails d’une commande, cliquer dessus :

- Pending: Si l’équipement n’est pas prêt à recevoir la commande (il n’a pas souscrit au topic dev/cmd (Voir la documentation développeur https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#_summary)

- Sent : L’équipement a reçu la commande (souscription sur le topic dev/cmd) mais il ne l’a pas encore acquittée (publication sur dev/cmd/res). Notez que si aucun acquittement applicatif n’a été demandé lors de l’envoi de la commande, celle-ci passe automatiquement à l’état terminé (« processed »)

- Processed : L’envoi de la commande s’est correctement déroulé. L’équipement a reçu la commande et Live Objects a reçu la réponse de l’équipement (si un acquittement a été demandé lors de l’envoi de la commande)

- Replied : Dans ce cas où un acquittement applicatif a été demandé, ce statut indique que le device a répondu en publiant sur le topic dev/cmd/res

- Expired : La commande n’a pu être remise à l’équipement dans le délai spécifié lors de l’envoi de la commande.

NB : Le statut « processed » indique seulement que la commande a été correctement acheminée par Live Objects. Il ne préjuge pas du traitement réalisé sur l’équipement d’un point de vue applicatif. Ce résultat est une information que l’équipement peut toutefois communiquer dans sa réponse à Live Objects dans le cas d’une commande envoyée avec demande de confirmation (publication sur le topic dev/cmd/res)

Les topics MQTT auxquels l’équipement doit souscrire ou recevoir les commandes et sur lesquels il doit publier les réponses sont décrits dans la documentation développeur https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#_summary)

Pour envoyer une nouvelle commande, cliquez sur le bouton « Ajouter une commande » :

Vous pouvez sélectionner une durée d’expiration de la commande. Passé ce délai, si la commande n’a pu être transmise à l’équipement (l’équipement n’a pas souscrit au topic de réception dev/cmd) alors elle passe à l’état « expiré » et ne sera pas retransmise.

Niveaux d’acquittement :

- Aucun : Aucun acquittement (Live Objects publie en qos 0)

- Applicatif : Live Objects attend un message de réponse de l’équipement (publication sur le topic dev/cdm/res). Le message de réponse contient plus d’informations sur le résultat du traitement de la commande par l’équipement. Ce traitement peut tout à fait être une erreur d’un point de vue applicatif. La commande apparaitra elle comme traitée avec succès. Voir le guide développeur pour les détails d’implémentation côté équipement https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#_summary

Vous pouvez configurer le délai maximal dans lequel l’équipement doit donner son acquittement ainsi que le nombre de nouvelles tentatives à effectuer automatiquement en cas de non réception de l’acquittement dans ce délai.

Pour envoyer la commande cliquez sur le bouton « Valider » pour envoyer.

Tant qu’une commande n’a pas été transmise à l’équipement (statut « pending »), il est possible de l’annuler en la sélectionnant dans la liste et en cliquant sur l’icône « Annuler ». Son statut passe alors à « canceled ».

Cette commande pourra être renvoyée ultérieurement, comme n’importe quelle commande de l’historique en la sélectionnant et en cliquant sur l’icône « Répéter ».

Enfin les commandes peuvent être supprimées de l’historique. Pour cela sélectionner la ou les commandes à supprimer et cliquer sur l’icône « Supprimer »

NB : Le fait de supprimer de l’historique une commande en cours d’envoi (état « sent ») n’envoie pas d’ordre d’annulation à l’équipement. Cela entraine la suppression de la commande de l’historique et du Device Manager de Live Objects

2.4.8.6. Mettre à jour le firmware d’un équipement MQTT

Pour mettre à jour le firmware d’un équipement MQTT allez dans les détails de l’équipement et sélectionnez rubrique « Firmware »

L’écran de mise à jour est divisé en deux parties. La première partie présente les firmware que l’équipement a annoncés et si des opérations de mise à jour sont en cours sur ces firmwares. La deuxième partie est l’historique des mises à jour réalisées.

Prérequis : Pour pouvoir mettre à jour le firmware de votre équipement, il faut :

- Que votre équipement supporte cette fonction, et qu’il ait préalablement annoncé à la plateforme le nom de son firmware et sa version courante (voir le guide développeur

https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#MQTT_DEV_RSC)

- Que la ou les versions à mettre à jour aient été préalablement créées dans le gestionnaire de firmwares de Live Objects et les binaires correspondants importés dans la plateforme.

(Voir le menu « Configuration » pour la gestion des firmwares)

Le statut de la demande passe à « pending ». Cela signifie que la demande est en attente de réception par l’équipement.

Une fois reçue par l’équipement la demande passe en « preparing_asset – 0% ». Cela signifie que l’équipement a reçu la demande, mais qu’il n’a pas encore répondu s’il l’acceptait

Si l’équipement répond positivement à la demande, elle passe en attente de transfert.

La plateforme suit automatiquement la progression du téléchargement du binaire par l’équipement

Une fois le transfert effectué, et l’installation effectuée, l’équipement remonte à Live Objects sa nouvelle version. Si elle correspond à la valeur cible de la mise à jour en cours, alors le processus s’achève en succès et le statut passe à « done 100% »

Voir le guide développeur pour les détails d’implémentation côté équipement https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#_summary

2.4.9. Equipements SMS

Vous pouvez connecter à Live Objects des équipements communiquant par SMS sur le réseau GSM d’Orange. Ces équipements doivent impérativement disposer d’une carte SIM Orange France.

Vous pouvez accéder au menu de gestion des équipements SMS à partir du menu « Parc » en sélectionnant « SMS » dans le menu déroulant.

2.4.9.1. Ajouter un équipement SMS

Pour ajouter un nouvel équipement SMS, cliquez sur le bouton « Ajouter un équipement » dans le menu principal « SMS ».

Numéro de téléphone du serveur : c’est le numéro court qui sera utilisé par votre équipement

Décodeur : Sélectionner décodeur dans la liste si la payload doit être décodée.

MSISDN : C’est le numéro de votre équipement suivant le format indiqué dans l’exemple.

Stream Id par défaut : Il s’agit de la série temporelle par défaut dans lequel les messages émis par l’équipement seront stockés

Groupe : Le groupe d’équipements auquel ajouter l’objet. Par défaut seul le groupe racine (« root ») est proposé. (Voir la partie « Gestion de groupes »)

Propriétés : couples clé-valeur en saisie libre. Exemple : type d’équipement, fabricant, modèle…

* L'espace de noms fournit une dénomination cohérente pour un ensemble d’équipements. Par exemple, tous les appareils du même fabricant ou du même type. L’id identifie lui l’équipement dans cet espace de noms.

2.4.9.2. Supprimer un équipement SMS

Pour supprimer un équipement SMS, il suffit de le sélectionner dans la liste et de cliquer sur l’icône « Supprimer ».

2.4.9.3. Envoyer une commande à un équipement SMS

Pour envoyer une commande à un équipement SMS allez dans les détails de l’équipement et cliquez sur la rubrique « Commandes (Downlink)». L’historique des commandes envoyées à l’équipement est affiché par ordre chronologique.

Pour voir le détail d’une commande, cliquez dessus :

La colonne « statut » indique l’état de la commande et peut prendre les valeurs suivantes : - Pending: Non applicable. Dans le cas de la connectivité SMS l’information de connexion

effective de l’équipement au réseau, ainsi que l’accusé de réception des messages par l’équipement ne sont pas disponibles. Aussi, les commandes ne restent jamais en attente dans la plateforme Live Objects elles sont directement transmises au réseau mobile. Pour cette raison il n’est pas possible de définir une durée d’expiration de commande, comme dans le cas des équipements LoRa et MQTT

- Sent : indique que la commande a été transmise au réseau mobile. Il n’y a pas de confirmation de réception par l’équipement. La commande passe automatiquement à l’état terminé (« processed »).

Une commande peut être renvoyée sans avoir à la ressaisir, pour cela, il suffit de la sélectionner dans la liste et de cliquer sur l’icône « Répéter »

Pour envoyer une nouvelle commande, cliquez que le bouton « Ajouter une commande »

Les données à envoyer sont à saisir dans le champ « payload » au format texte ou en hexadécimal pour le format binaire. Le format binaire doit être obligatoirement en hexadécimal et de 140 octets (280 caractères) maximum

NB : Il n’est pas possible de spécifier une durée d’expiration pour une commande en connectivité SMS (voir remarque sur le statut « pending », plus haut dans ce paragraphe)

2.4.9.4. Modifier un équipement SMS

Pour modifier un équipement SMS, affichez ses détails et allez dans le menu « identité ». Vous pouvez modifier les informations propres à un équipement (appartenance de groupe, tags, propriétés), ou les caractéristiques de son interface de connectivité (Numéro de serveur ou décodeur affecté). Pour cela cliquez sur l’icône « modifier »

2.4.10. Connecteur externe

Le connecteur externe permet de rendre la gestion des équipements dans Live Objects totalement agnostique de la connectivité. Grâce au connecteur externe, des équipements gérés par un cloud propriétaire, ou utilisant un protocole de communication spécifique peuvent bénéficier des mêmes fonctionnalités de device management de Live Objects (ex : Gestion de campagne, groupes…) que les autres équipements MQTT, LoRa ou SMS. La gestion de flotte se fait via des interfaces et des API unifiées.

Pour implémenter un connecteur externe, veuillez consulter la documentation ici

https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#MQTT_MODE_CONNECTOR

Le fonctionnement des équipements gérés par un connecteur externe est similaire à celui des équipements MQTT. Pour créer un équipement de type « connecteur externe », il y a deux possibilités comme pour MQTT :

1/ Soit par autoprovisioning : L’équipement est automatiquement créé dans le Device Manager Live Objects dès que l’external connecteur fait un publish status (voit documentation indiquée ci-dessus)

2/ Soit en créant l’équipement dans le Device Manager avant sa première connexion. Pour cela aller dans le menu Parc cet cliquer sur « Ajouter un nouvel équipement »

Le champ « external connector ID » est l’id de l’équipement dans le connecteur externe. Cet id sert à construire l’id de l’équipement dans Live Object.

Les autres champs, « streamId », « tags », « groupes » et « propriétés » sont les mêmes que pour les autres types d’équipements (voir les paragraphes concernés)

La gestion des équipements de type « connecteur externe » est très similaire à celle des équipements MQTT. En particulier l’envoi de commande, qui présente les mêmes caractéristiques et statuts, à la différence près que dans le mode connecteur les états affichés dans Live Objects sont ceux reportés par le connecteur et non par les équipements terminaux.

2.4.11. Groupes

Il vous est possible d’organiser votre parc par groupes d’équipements.

Vous pouvez créer, renommer ou supprimer un groupe, ou un sous-groupe en cliquant à la racine

Pour déplacer un équipement d’un groupe à un autre, aller dans les détails de l’équipement, ou sélectionnez-le dans la liste et cliquez sur l’icône « Déplacer ».

Pour déplacer un groupe et ses groupes (et tous les équipements qu’ils contiennent) vers un autre groupe, sélectionner le groupe à déplacer et cliquez sur Déplacer dans le menu contextuel

2.4.12. Gestion de campagnes

Les campagnes permettent la planification, l’exécution et le suivi d’opérations de Device Management en masse. Les opérations applicables aux équipements sont celles supportées par le type de connectivité utilisé.

2.4.12.1. Créer une campagne

Vous accédez à la gestion des campagnes via le menu « Parc », en cliquant sur la rubrique

« Campagnes »,

puis cliquez sur « Créer une campagne »

La première étape consiste à sélectionner les cibles. Cela peut se faire:

 Soit par import par import d’un fichier CSV : Soit en important une liste d’équipements existant obtenue via l’export csv du parc (voir paragraphe « Exporter ses équipements »), soit en important une liste d’équipements qui n’existent pas encore dans Live Objects ; dans ce cas le fichier d’import ne contiendra que la colonne « Id ».

 Soit en utilisant des filtres avancés

La deuxième étape consiste à indiquer le type d’opération qui sera appliquée aux équipements sélectionnés, et de fournir les paramètres correspondants à l’opération. Les opérations

NB : Le portail Live Objects ne permet de ne choisir qu’une seule et même opération pour l’ensemble des équipements sélectionnés. S’il vous est nécessaire de combiner au sein d’une même campagne plusieurs opérations par équipement (ex : une commande, suivie d’une mise à jour de firmware) vous pouvez le faire en utilisant les API https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html#_campaign_management et https://liveobjects.orange-business.com/swagger-ui/index.html#!/Campaign_management NB : Pour chaque opération il est possible de spécifier un nombre de nouvelles tentatives en cas d’échec (jusqu’à 5)

La troisième étape consiste à planifier la campagne.

2.4.12.2. Suivre une campagne

Les campagnes sont classées en fonction de leur planification : « Planifiées », « En cours » et

« Terminées ». Cliquez sur l’onglet correspondant pour les lister.

Etat de la campagne et nombre de cibles traitées / nombre total

2.4.12.3. Annuler une campagne

Il est possible annuler une campagne cliquant sur l’icône « Annuler ».

Si la campagne est déjà en cours de déroulement, et que l’option « Force l’annulation de la campagne » n’est pas cochée, le statut de la campagne passe en « Annulation » en attendant que les actions en cours se terminent. Les actions non commencées ne démarrent pas.

Si l’option « Force l’annulation de la campagne » est cochée les actions en cours sont annulées et la campagne est immédiatement arrêtée.

Répartition des cibles vert : cibles traitées rouge : cibles en erreur

gris : cibles non traitées Statut final de la campagne

2.4.12.4. Supprimer une campagne

Il est possible de supprimer une campagne en cliquant sur l’icône « Supprimer».

Si la campagne est en cours d’exécution ou d’annulation, il n’est pas possible de la supprimer, sauf en sélectionnant « Forcer la suppression de la campagne ».

Dans ce cas toutes les actions en cours sont annulées. Et la campagne est supprimée de l’historique des campagnes.

2.4.12.5. Statuts d’une campagne

Statut (FR) Statut (EN) Signification

Planifiée Scheduled la date de démarrage n’est pas encore échue

Dans le document Live Objects. Orange. manuel utilisateur. Version 2.15 (Page 53-0)