Live Objects

Orange

manuel utilisateur

2 / 114

Table des matières

1. INTRODUCTION ......................................................................................................................... 5

1.1. Contexte .............................................................................................................................................. 5

1.2. Objet du document .............................................................................................................................. 5

1.3. Documents de référence ..................................................................................................................... 5

2. MANUEL UTILISATEUR DU PORTAIL LIVE OBJECTS ..................................................... 6

2.1. Accès à l’application ............................................................................................................................ 6 2.1.1. Obtenir un compte Live Objects........................................................................................................ 6 2.1.2. Réception de vos identifiants de connexion ..................................................................................... 6 2.1.3. Connexion au portail Live Objects ..................................................................................................... 7

2.1.3.1. Navigateurs supportés .................................................................................................................. 7 2.1.3.2. Connexion/authentification .......................................................................................................... 7

2.2. Principes de navigation ........................................................................................................................ 8 2.2.1. Bandeau de navigation ...................................................................................................................... 8

2.3. Tableau de bord................................................................................................................................. 10 2.3.1. Nombre total d’équipements répartis par connectivité : ............................................................... 11 2.3.2. Utilisation des quotas ...................................................................................................................... 11 2.3.3. Activité du parc ............................................................................................................................... 12 2.3.4. Activité détaillée ............................................................................................................................. 13 2.3.5. Tableaux de bord personnalisés ...................................................................................................... 14

2.3.5.1. Création d’un widget de type valeur .......................................................................................... 15 2.3.5.2. Création d’un widget de type courbe ......................................................................................... 16 2.3.5.3. Création d’un widget de type carte ............................................................................................ 16 2.3.5.4. Création d’un widget de type jauge ............................................................................................ 17 2.3.5.5. Création d’un widget de type histogramme ............................................................................... 19

2.4. Gestion du parc d’équipements ......................................................................................................... 21 2.4.1. Afficher son parc d’équipements par type de connectivité ............................................................ 22 2.4.2. Etats des équipements .................................................................................................................... 22 2.4.3. Etat des commandes (downlink) ..................................................................................................... 23 2.4.4. Propriétés des équipements et notion d’interface ......................................................................... 26 2.4.5. Importer en masse des équipements.............................................................................................. 28 2.4.6. Exporter la liste de ses équipements .............................................................................................. 31 2.4.7. Equipements LoRa ........................................................................................................................... 32

2.4.7.1. Ajouter un équipement LoRa ...................................................................................................... 32 2.4.7.2. Désactiver et réactiver un équipement LoRa ............................................................................. 34 2.4.7.3. Supprimer un équipement LoRa ................................................................................................. 34 2.4.7.4. Détail d’un équipement LoRa ..................................................................................................... 35 2.4.7.5. Modifier un équipement LoRa .................................................................................................... 36 2.4.7.6. Ajouter une option de connectivité ............................................................................................ 38 2.4.7.7. Consulter les données remontées par un équipement LoRa (uplink) ........................................ 40 2.4.7.8. Envoi de commande à un équipement LoRa (downlink) ............................................................ 41 2.4.7.9. Antennes LoRa ............................................................................................................................ 42

2.4.8. Equipements MQTT ......................................................................................................................... 45 2.4.8.1. Ajouter un équipement MQTT .................................................................................................... 45

3 / 114

2.4.8.2. Supprimer un équipement MQTT ............................................................................................... 46 2.4.8.3. Détail d’un équipement MQTT ................................................................................................... 47 2.4.8.4. Mettre à jour les paramètres d’un équipement MQTT .............................................................. 49 2.4.8.5. Envoyer une commande à un équipement MQTT ...................................................................... 51 2.4.8.6. Mettre à jour le firmware d’un équipement MQTT .................................................................... 54

2.4.9. Equipements SMS ........................................................................................................................... 56 2.4.9.1. Ajouter un équipement SMS....................................................................................................... 57 2.4.9.2. Supprimer un équipement SMS .................................................................................................. 58 2.4.9.3. Envoyer une commande à un équipement SMS ......................................................................... 58 2.4.9.4. Modifier un équipement SMS ..................................................................................................... 59

2.4.10. Groupes ........................................................................................................................................... 60 2.4.11. Gestion de campagnes .................................................................................................................... 62

2.4.11.1. Créer une campagne .............................................................................................................. 62 2.4.11.2. Suivre une campagne ............................................................................................................. 65 2.4.11.3. Annuler une campagne .......................................................................................................... 66 2.4.11.4. Supprimer une campagne ...................................................................................................... 67 2.4.11.5. Statuts d’une campagne ......................................................................................................... 67

2.4.11.5.1. Statuts des équipements cibles .......................................................................................... 67 2.4.11.6. Rapport campagne ................................................................................................................. 69

2.5. Données ............................................................................................................................................ 70 2.5.1. Export des données ......................................................................................................................... 72 2.5.2. Visualisation avancée ...................................................................................................................... 73 2.5.3. Files de messages (fifo) ................................................................................................................... 74 2.5.4. Routage des données ...................................................................................................................... 76

2.5.4.1. Créer une règle de routage ......................................................................................................... 76 2.5.4.2. Routage vers des fifo .................................................................................................................. 78 2.5.4.3. Push http ..................................................................................................................................... 79 2.5.4.4. Suspendre / réactiver une règle ................................................................................................. 80

2.5.5. Consommation des données par les applications ........................................................................... 81 2.5.5.1. Explorer les données ................................................................................................................... 81 2.5.5.2. Consommer les données en temps réel ..................................................................................... 81

2.5.5.2.1. Consommation via MQTT ..................................................................................................... 81 2.5.5.2.2. Consommation via push HTTP .............................................................................................. 82

2.5.6. Journal d’activité ............................................................................................................................. 83 2.5.6.1. Connectivité LoRa ....................................................................................................................... 83 2.5.6.2. Connectivité MQTT ..................................................................................................................... 84 2.5.6.3. Stockage ...................................................................................................................................... 84 2.5.6.4. Notification ................................................................................................................................. 84 2.5.6.5. Limitations .................................................................................................................................. 85

2.6. Configuration ..................................................................................................................................... 85 2.6.1. Identification du compte ................................................................................................................. 85 2.6.2. Identification de l’utilisateur connecté ........................................................................................... 86 2.6.3. Limites de trafic ............................................................................................................................... 86 2.6.4. Rôles et droits dans Live Objects ..................................................................................................... 86 2.6.5. Gérer les utilisateurs ....................................................................................................................... 87

2.6.5.1. Créer d’un utilisateur .................................................................................................................. 89 2.6.5.2. Suspendre / réactiver un utilisateur ........................................................................................... 90 2.6.5.3. Supprimer un utilisateur ............................................................................................................. 90

2.6.6. Gérer les clés d’API .......................................................................................................................... 90 2.6.6.1. Créer une clé d’API...................................................................................................................... 91 2.6.6.2. Hiérarchie des clés d’API ............................................................................................................. 93 2.6.6.3. Régénérer une clé d’API .............................................................................................................. 94 2.6.6.4. Désactiver/ réactiver une clé d’API ............................................................................................. 94

4 / 114

2.6.6.5. Supprimer une clé d’API ............................................................................................................. 95 2.6.6.6. Passer une clé d’API en mode debug .......................................................................................... 95

2.6.7. Gérer les firmwares ......................................................................................................................... 97 2.6.8. Gérer les décodeurs ...................................................................................................................... 100

2.6.8.1. Type des décodeurs .................................................................................................................. 100 2.6.8.2. Visibilité des décodeurs ............................................................................................................ 100 2.6.8.3. Modèle de données et Indexation ............................................................................................ 101 2.6.8.4. Créer un décodeur paramétrable binaire ................................................................................. 102 2.6.8.5. Créer un décodeur paramétrable csv ....................................................................................... 107 2.6.8.6. Créer un décodeur programmable ........................................................................................... 108 2.6.8.7. Désactiver/réactiver un décodeur paramétrable ..................................................................... 108 2.6.8.8. Affecter un décodeur à un équipement ................................................................................... 109

2.7. Alarmes ........................................................................................................................................... 110 2.7.1. Visualiser les alarmes .................................................................................................................... 110 2.7.2. Paramétrer une règle de « Silent machine » ................................................................................. 111

3. RESSOURCES .......................................................................................................................... 114

5 / 114

1. Introduction

1.1. Contexte

Live Objects est une solution en mode SaaS (Software as a Service) qui fournit un ensemble

d’outils dans les domaines Machine To Machine (M2M) et l’internet des Objets (IoT).

Les principales fonctionnalités offertes par Live Object sont les suivantes :

gestion avancée des objets communicants (ajout, suspension, supervision,

configuration, mise à jour de micro programmes…)

interfaces programmatiques (API) pour collecter les données des objets, leur envoyer

des commandes et gérer les notifications associées (http, mqtt)

routage des messages entre les objets et les applications métier

stockage des données et fonctionnalités avancées de recherche

Important : En fonction des offres souscrites (LoRa, Discover, Express, Advanced, Premium)

certaines fonctionnalités peuvent être présentes ou non. Dans ce document sont présentées

toutes les fonctions disponibles.

1.2. Objet du document

Le manuel utilisateur a pour but d’être un support à l’utilisation du portail Web Live Objects

d’Orange. Une documentation api est également disponible et référencée ci-dessous.

1.3. Documents de référence

N° titre référence

documents Orange

1 Guide développeur Live Objects (API) https://liveobjects.orange-

business.com/doc/html/lo_manual.html

2 Support de formation Live Objects https://www.slideshare.net/EricCombe/live-

objects-concepts-and-apis-training-129691537

3 Swagger (API reference) https://liveobjects.orange-

business.com/#/swagger

6 / 114

2. Manuel utilisateur du portail Live Objects

2.1. Accès à l’application

2.1.1. Obtenir un compte Live Objects

Vous pouvez obtenir un compte d’essai Discover disponible immédiatement en souscrivant en

ligne à l’adresse https://liveobjects.orange-business.com/#/request_account.

Si vous souhaitez disposer d’un compte Live Objects avec connectivité LoRa incluse, cocher la

case correspondante. Dans ce cas la création du compte ne sera pas immédiate, néanmoins

vous serez notifié par email de sa création.

Enfin vous avez la possibilité de contacter un interlocuteur commercial à l’adresse

liveobjects.contact@orange.com

2.1.2. Réception de vos identifiants de connexion

La création de votre compte s’accompagne de l’envoi d’un mail d’activation dudit compte

principal.

Le mail que vous allez recevoir vous informe des modalités d’accès au support et présente un

lien d’activation valable 7 jours. Lorsque vous l’utiliserez pour activer votre compte, vous

devrez saisir un mot de passe ainsi qu’un capcha :

Le mot de passe doit contenir 8 caractères comprenant des majuscules, minuscules, chiffres et

caractères spéciaux (/*-+.?,;:§!%ùµ*$@_()').

7 / 114

Vous recevrez un nouveau mail confirmant l’activation de votre compte. Vous pourrez ensuite

vous connecter au portail Live Objects.

2.1.3. Connexion au portail Live Objects

2.1.3.1. Navigateurs supportés

Les navigateurs supportés sont les suivants :

Firefox 38 et plus

IE 11,

Edge 13 et plus,

Chrome 49 et plus

2.1.3.2. Connexion/authentification

L’accès à l’adresse https://liveobjects.orange-business.com renvoie à la page d’authentification

suivante :

Si vous disposez d’un Espace Client Entreprise Orange connectez-vous directement depuis cet

espace en cliquant sur le bouton prévu à cet effet.

Si vous ne disposez pas d’un Espace Client Entreprise Orange connectez-vous avec votre

identifiant/mot de passe Live Objects. En cas d’oubli de mot de passe, cliquez sur le lien « mot

de passe oublié ».

8 / 114

Saisissez votre identifiant de connexion Live Objects ainsi que le capcha. Un lien de

réinitialisation vous sera envoyé par email, à l’adresse correspondant à votre identifiant. Ce lien

est reste valable 10 minutes.

NB : si vous utilisez un compte «Espace Client Entreprise », la demande de réinitialisation doit

se faire depuis cet espace https://espaceclient.orange-

business.com/group/ece2/home?codeContexte=eceDefault

2.2. Principes de navigation

2.2.1. Bandeau de navigation

Il permet la navigation entre les différentes rubriques du portail Live Objects :

- L’onglet « Tableau de bord » : il s’agit de la page d’accueil du portail qui donne une vue

synthétique de l’activité du compte

- L’onglet « Parc » pour la gestion du parc d’équipements

- L’onglet « Données » pour la visualisation des données stockées dans Live Objects, la

gestion des fifos et des règles de routage ainsi que le journal d’évènements

- L’onglet « Configuration » pour la configuration du compte (Clés d’API, utilisateurs,

décodeurs…)

- L’onglet « Alarmes » pour configurer et visualiser les alarmes (ex : « Silent machine »)

Il permet également l’accès à diverses ressources documentaires et de support :

- Un lien « prototyper » proposant des kits de développement (SDK)

9 / 114

- Un lien vers la market place d’Orange proposant un large choix d’objets connectés,

modules et gateway utilisables avec Live Objects

- Un lien vers l’ensemble de la documentation Live Objects disponible : FAQ, guide

développeur, tutoriels vidéo, et outils à destination des développeurs (collections

Postman, swagger, code samples)

- Un lien vous permettant de vous déconnecter, et d’accéder aux informations

concernant votre compte :

o Vos identifiants de compte (à communiquer systématiquement lors de tout appel

au support)

o Nom du compte, date de création et email de l’utilisateur principal (adresse

utilisée à la création du compte Live Objects)

Enfin la langue peut être changée à tout moment en cliquant sur l’icône correspondante.

Actuellement deux langues sont disponibles : Français (FR) ou Anglais (EN)

10 / 114

2.3. Tableau de bord

Le tableau de bord est la page d’accueil du portail Live Objects. Elle donne une vue synthétique

de l’activité du compte.

11 / 114

2.3.1. Nombre total d’équipements répartis par connectivité :

Cette vue donne le nombre d’équipements actuellement en parc répartis par connectivité.

Notez qu’un même équipement peut tout à fait avoir plusieurs interfaces s’il utilise plusieurs

connectivités pour communiquer (par exemple une interface LoRa et une interface SMS)

2.3.2. Utilisation des quotas

Ces quotas dépendent de l’offre souscrite.

- Files de messages : Nombre de files créées / Nombre de files max autorisées

- Clés d’API : Nombre de clés créées / Nombre de clés max autorisées

- Utilisateurs : Nombre d’utilisateurs créés / Nombre d’utilisateurs max autorisées

12 / 114

2.3.3. Activité du parc

Cette vue permet de sélectionner pour une période donnée l’activité globale du compte Live

Objects en termes de :

- nombre d’équipements ayant communiqué sur la période (historique disponible sur les 7

derniers jours ou les 12 derniers mois)

- trafic en nombre de messages (entrants/sortants) ou en volume (octets) (historique

disponible sur les 7 derniers jours, les 4 dernières semaines ou les 12 derniers mois)

On entend par « message entrant » tout message entrant dans la plateforme. Exemples :

- Un équipement qui émet un message à destination de la plateforme (uplink),

- Une application qui effectue des appels API POST, PUT vers la plateforme (ex : requête

de search, envoi de commande …)

On entend par « message sortant » tout message sortant de la plateforme. Exemples :

- Une commande envoyée de la plateforme vers un équipement (downlink)

- Réponse aux appels API GET

- Consommation de messages via MQTT

13 / 114

2.3.4. Activité détaillée

Une synthèse de l’activité est également donnée par type de connectivité.

Pour chaque connectivité on affiche :

- Le nombre d’équipements actuellement en parc

- Les statistiques sur la période sélectionnée. Notez que sur cette période le nombre

d’équipements peut varier par rapport à l’état du parc actuel en fonction des

ajouts/suppression qui auraient pu voir lieu entre temps.

Certaines informations peuvent être spécifiques au type de connectivité : Equipements

activés/désactivés pour LoRa ; équipements connectés/déconnectés pour Mqtt

Le nombre de messages mqtt sortants comprend l’ensemble des messages mqtt sortant de la

plateforme qu’ils soient à destination des équipements (device management) ou des

applications (consommation de données).

14 / 114

2.3.5. Tableaux de bord personnalisés

Vous pouvez constituer vos propres tableaux de bord pour visualiser vos données. Un tableau

de bord est constitué d’objets graphiques appelés « widgets » qui permettent de visualiser les

données de différentes manières.

Remarques :

Les tableaux de bord personnalisés sont propres à un utilisateur du compte Live

Objects. Ils ne sont pas partagés à d’autres utilisateurs du compte.

Il est possible de paramétrer un rafraichissement automatique d’un tableau de bord.

Dans ce cas chaque les widgets sont rafraichis de de façon séquentielle suivant le délai

défini. Il reste toutefois possible de rafraichir un widget individuellement en cliquant sur

son icône « actualiser ».

Pour visualiser des données remontées par des équipements LoRa, il est nécessaire

que la payload hexadécimal véhiculant ces données soit décodée (Voir paragraphe

« Gérer les décodeurs »). Les métadonnées réseaux (snr, rssi, sf, esp) restent

néanmoins accessibles sans décodage

Seules les 10 000 données les plus récentes sont affichées par les widget. Si une série

comporte plus de données sur la période sélectionnée, cela est indiqué par une pastille

jaune située à côté le nom de la série

Cliquez ici pour créer un tableau

de bord personnalisé

Nom de la série

15 / 114

2.3.5.1. Création d’un widget de type valeur

Ce widget permet d’afficher la dernière valeur d’une donnée remontée par un équipement. Pour

créer un widget de type valeur, cliquez sur le bouton correspondant, puis sélectionner

l’équipement qui émet la donnée à visualiser.

Une fois l’équipement sélectionné, le champ « Donnée à afficher » présente la structure du

message remonté par cet équipement. Sélectionner le champ portant la donnée à afficher :

16 / 114

2.3.5.2. Création d’un widget de type courbe

Ce widget permet d’afficher sous forme d’une courbe ou d’un nuage de points les valeurs

prises par une donnée remontée par un équipement sur une période de temps. Pour créer un

widget de type valeur, cliquez sur le bouton correspondant, puis sélectionner l’équipement qui

émet la donnée à visualiser.

Une fois l’équipement sélectionné, le champ « Donnée à afficher » présente la structure du

message remonté par cet équipement. Sélectionner le champ portant la donnée à afficher :

NB : Un widget de type courbe ne permet d’afficher que des valeurs de type numérique

2.3.5.3. Création d’un widget de type carte

Ce widget permet d’afficher sur une carte la position géographique de l’équipement ainsi que la

dernière valeur d’une donnée émise par cet équipement. Pour créer un widget de type carte,

cliquez sur le bouton correspondant, puis sélectionner l’équipement qui émet la donnée à

visualiser de la même façon que pour les widgets précédents.

17 / 114

Une fois l’équipement sélectionné, le champ « Donnée à afficher » présente la structure du

message remonté par cet équipement. Attention : Vous n’avez pas à aller chercher les

informations de localisation qui seront automatiquement reportées sur la carte. La donnée à

afficher que vous avez à sélectionner est celle que vous souhaitez afficher sur la carte à l’endroit

où votre équipement est localisé. Par exemple la température indiquée par l’équipement lors de

sa dernière géolocalisation.

2.3.5.4. Création d’un widget de type jauge

Le widget jauge permet de représenter la dernière valeur remontée par un équipement sous la

forme d’une jauge sur laquelle vous pouvez faire figurer une valeur minimum et une valeur

maximum. Ces valeurs min et max sont utilisées à des fins de présentation uniquement, un

équipement pourra tout à fait remonter des valeurs en dessous ou en dessus de ces bornes, la

jauge apparaitre dans ce cas vide ou pleine.

18 / 114

NB : Un widget de type jauge ne permet d’afficher que des valeurs de type numérique

19 / 114

2.3.5.5. Création d’un widget de type histogramme

Avec un widget de type histogramme vous avez la possibilité de visualiser l’évolution comparée

dans le temps d’une valeur remontée par un plusieurs équipements.

Comme pour les autres widgets, vous devez sélectionner la donnée à afficher, une fois les

équipements sélectionnés. Le champ « Données à afficher » contient la structure des données

remontées par ces équipements.

La méthode d’approximation sélectionnée correspondant à votre cas d’usage, par exemple:

- Suivi de la température moyenne/max/min sur le mois. (sélectionnez « la moyenne des

mesures », « le maximum des mesures », ou « le minimum des mesures)

- Volume des précipitations cumulées sur le mois (sélectionnez « la somme des

mesures »)

NB 1: l’axe des ordonnées est automatiquement positionné sur la valeur minimum sur la

période de temps sélectionné, sauf si la case « barres empilées » est cochée auquel cas

l’échelle démarre à zéro.

NB 2 : Le widget histogramme ne permet d’afficher que des valeurs de type numérique

20 / 114

21 / 114

2.4. Gestion du parc d’équipements

Le menu parc permet de visualiser et de gérer votre flotte d’équipements. Un bouton d’export

permet d’exporter au format csv la liste des équipements préalablement sélectionnés.

(1)

(2)

(3)

(4)

(5)

22 / 114

2.4.1. Afficher son parc d’équipements par type de connectivité

Etant donné que les équipements présentent des caractéristiques propres à la connectivité

utilisée, l’affichage des équipements du parc se fait en sélectionnant cette connectivité dans la

liste déroulante

La liste des équipements peut être affinée par une recherche multicritères. Pour cela cliquez sur

le champ et sélectionner les critères souhaités

La sélection des équipements se fait unitairement, par page ou en totalité en cochant les cases

de sélection

Des opérations peuvent être appliquées sur la sélection : export au format csv, déplacement

dans un groupe, suppression

L’état de l’équipement ainsi sa dernière communication et le cas échant une alarme s’il n’a pas

communiqué plus depuis une durée définie par une alarme de « silent machine »

2.4.2. Etats des équipements

Les états que peuvent prendre les équipements dépendent de leur connectivité.

Equipements LoRa

- Enregistré : L’équipement a été enregistré dans le réseau avec les paramètres spécifiés

lors de sa création. Aucune donnée montante (uplink), ni de Join Request n’a encore

été reçue par la plateforme.

- En cours d’initialisation : Le réseau a reçu un Join Request de la part de l’équipement

- Initialisé : Le réseau a envoyé un Join Accept à l’équipement

- Activé : Au moins un uplink émis par l’équipement a été reçu par Live Objects (hors

messages MAC)

- Désactivé : L’équipement a été désactivé dans Live Objects. Il ne peut plus

communiquer sur le réseau (Voir le paragraphe « Désactiver et réactiver un

équipement »

- Réactivé : L’équipement a été réactivé dans Live Objects. Ne pouvant connaitre à priori

l’état de l’équipement au moment de la réactivation, l’état passera à « Activé » si l’on

reçoit un Join Request, ou directement à « Activé » si un uplink est reçu.

- Erreur : Ce statut, rare, est affiché en cas de problème de configuration de l’équipement

dans le réseau. Si cet état s’affiche contactez votre support.

(1)

(2)

(3)

(4)

(5)

23 / 114

Equipements MQTT

- En ligne : La connexion MQTT de l’équipement est active

- Hors ligne : L’équipement s’est déjà connecté au moins une fois mais sa connexion

MQTT est inactive

Equipements SMS

- En ligne : L’équipement est activé au niveau Live Objects

- Hors ligne : L’équipement est désactivé au niveau Live Objects

2.4.3. Etat des commandes (downlink)

Les commandes ou downlink sont les messages que vous pouvez envoyer à vos

équipements depuis Live Objects.

Le moteur de commande unifié de Live Objects vous permet de suivre finement la

progression d’une commande à travers ses différents états.

24 / 114

Pour suivre l’état d’une commande envoyée à un équipement, commencez par sélectionner

l’équipement dans le menu « Parc ». Puis dans les détails de l’équipement sélectionnez le

menu « Commandes (downlink) » pour afficher l’historique des commandes envoyées à cet

équipement. Enfin, cliquez sur une commande pour afficher ses détails

25 / 114

La première partie de l’écran montre la progression de la commande :

Pending : La commande est en attente dans Live Objects (par exemple une commande

précédente est en cours d’exécution, ou l’équipement n’est pas disponible pour recevoir

une commande)

Sending : La commande est partie de Live Objects, elle est en transit dans le réseau (cas

des équipements LoRa et SMS)

Sent : La commande est arrivée jusqu’à l’équipement. Notez que si aucun acquittement n’a

été demandé lors de l’envoi de la commande, celle-ci passe automatiquement à l’état

processed

26 / 114

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)

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é traitée par l’équipement

et non le résultat de ce traitement qui relève votre applicatif. Ce résultat est une information qui

peut toutefois être communiquée par l’équipement lors de sa réponse à Live Objects.

2.4.4. Propriétés des équipements et notion d’interface

Les équipements peuvent utiliser différents types de connectivité pour communiquer avec Live

Objects. Les spécificités liées à ces différentes connectivités sont gérées par des « interfaces ».

Un même équipement pouvant avoir plusieurs interfaces s’il se connecte via des réseaux

différents par exemple une interface LoRa et une interface SMS.

Les informations concernant les équipements sont donc présentées en deux parties :

- Les informations indépendantes de la connectivité et communes à tous les équipements

dans Live Objects (détail ci-dessous)

- Les informations spécifiques aux interfaces réseaux qu’ils utilisent pour se connecter à

Live Objects (voir paragraphes spécifiques)

27 / 114

Nom : Nom de l’équipement. Il s’agit d’un champ libre.

ID de l’équipement: Il s’agit de l’identifiant unique de l’équipement dans Live Objects (URN). Il

doit être de la forme urn:lo:nsid:{namespace}:{id}. Les champs namespace et id sont

personnalisables.

StreamId par défaut : Il permet de spécifier le stream dans lequel les données émises par

l’équipement seront stockées. Par défaut chaque équipement dispose de son propre stream,

mais il est tout à fait possible de collecter les données de plusieurs équipements dans un même

stream.

Tags personnalisés : Les tags sont des étiquettes en saisie libre que vous pouvez attribuer à

vos équipements. L’utilisation des tags peut être utile pour trier et identifier vos équipements par

exemple. Vous pouvez saisir jusqu’à 10 tags de 32 caractères par équipement.

Groupe : Il s’agit du groupe auquel a été affecté l’équipement. Voir le paragraphe « Groupes »

Propriétés : Vous pouvez définir ici des propriétés pour vos équipements. Ces propriétés vous

permettent d’enrichir votre gestion d’équipements. Vous pouvez positionner jusqu’à 10

propriétés (128 caractères max pour la clé, et 256 caractères max pour la valeur).

28 / 114

2.4.5. Importer en masse des équipements

Cette fonctionnalité n’est actuellement disponible que pour les équipements LoRa et SMS.

L’import en masse d’équipements MQTT est prévu dans une prochaine version.

Pour accéder à cette fonctionnalité, aller dans le menu « Parc » et cliquer sur le bouton

« Importer en masse ».

L’import se passe en trois étapes :

La première, facultative, vous propose un modèle de fichier d’import pré-formaté avec les

paramètres à remplir correspondants au type d’équipement que vous souhaitez importer. Les

champs à renseigner sont les mêmes que ceux à fournir lors de la création unitaire (voir les

paragraphes correspondants). Vous pouvez passer cette étape si vous disposez déjà de votre

fichier d’import.

29 / 114

La seconde étape permet d’importer le fichier et de vérifier que le format est correct.

30 / 114

Seule la correction de toutes erreurs permet de passer à l’étape suivante.

La troisième étape procède à la création proprement dites des équipements contenus dans le

fichier d’import. Pour confirmer la création en masse cliquer sur le bouton « importer les

équipements »

31 / 114

2.4.6. Exporter la liste de ses équipements

Vous pouvez exporter la liste de vos équipements au format csv. Pour cela rendez-vous dans la

vue « Parc » et sélectionnez le type d’équipement souhaité. Sélectionnez ensuite la liste des

« équipements » à exporter et cliquer sur l’icône d’export

32 / 114

2.4.7. Equipements LoRa

2.4.7.1. Ajouter un équipement LoRa

Pour ajouter un équipement LoRa, cliquer sur le bouton « Ajouter un équipement ».

Le formulaire de création s’ouvre avec les paramètres spécifiques à un équipement LoRa

33 / 114

Nom : Nom de l’équipement (par exemple « Mon premier équipement »)

Profil : Le profil, ou « device profile » est une configuration préétablie de votre équipement sur le

réseau. Il rassemble un certain nombre de paramètres tels que le « spreading factor » utilisé

pour le JOIN, la classe, le RX. Sélectionner dans la liste le profil correspondant à votre matériel.

Si vous ne trouvez pas de profil correspondant choisissez le profil Generic_classA_RX2SF12 (si

votre équipement est en classe A) ou Generic_classC_RX2SF12 (si votre équipement est en

classe C)

Décodeur : Les décodeurs permettent de traduire une payload hexadécimale en données

humainement compréhensibles et indexables. Sélectionner dans la liste le décodeur adapté à

votre équipement. S’il n’y en a pas, vous pouvez en créer un dans le menu « Configuration ». Si

le champ « Décodeur » n’est pas présent c’est que votre compte Live Objects ne dispose pas

de cette fonction.

DevEUI : C’est l’identifiant unique de votre équipement dans le réseau LoRa il est fourni avec

votre matériel

ID de l’équipement: Il s’agit de l’identifiant unique de l’équipement dans Live Objects (URN). Par

défaut il est construit dans l’espace de nommage « lora » avec comme identifiant d’équipement

le DevEUI. Il vous est possible de le personnaliser avec votre propre espace de nommage et un

identifiant d’équipement différent du devEUI.

AppEUI, AppKey : Les paramètres AppEUI et AppKey sont des paramètres propres au

propriétaire de l’objet et/ou de l’applicatif utilisé avec l’objet (voir la spécification LoraWan)

StreamId par defaut : Il permet de spécifier le stream dans lequel les données émises par

l’équipement seront stockées. Ce champ est automatiquement renseigné lors de la saisie du

devEUI, mais il peut être personnalisé. Par défaut chaque équipement dispose de son propre

stream, mais il est tout à fait possible de collecter les données de plusieurs équipements dans

un même stream.

Tags personnalisés : Les tags sont des étiquettes en saisie libre que vous pouvez attribuer à

vos équipements. L’utilisation des tags peut être utile pour trier et identifier vos équipements par

exemple. Vous pouvez saisir jusqu’à 10 tags de 32 caractères par équipement.

Options de connectivité : Ce champ n’apparait que si des options de connectivités ont été

activées sur votre compte Live Objects. Voir le paragraphe « Ajouter une option de

connectivité »

Groupe : Indiquez ici le groupe auquel vous souhaitez affecter votre équipement. Voir le

paragraphe « Groupes »

Propriétés : Vous pouvez définir ici des propriétés pour vos équipements. Ces propriétés vous

permettent d’enrichir votre gestion d’équipements.

NB : Orange préconise le mode d’activation « Over the Air » (OTA) sur son réseau. Seul ce

mode d’activation est donc disponible via le formulaire de création. Si votre besoin nécessite

une activation en mode personnalisé (ABP) veuillez contacter votre support client.

34 / 114

2.4.7.2. Désactiver et réactiver un équipement LoRa

Il est possible d’interdire à un ou plusieurs équipements LoRa de communiquer sur le réseau,

de façon temporaire sans avoir à le supprimer. Pour cela sélectionner les équipements

concernés en cochant la case correspondante dans la liste, et cliquer sur le bouton

« Désactiver ».

Pour réactiver un ou plusieurs équipements, procéder de la même façon en cliquant sur le

bouton « Activer »

2.4.7.3. Supprimer un équipement LoRa

Il est possible de supprimer un équipement LoRa de la plateforme. Cette action aura pour

conséquence de le supprimer également du réseau LoRa d’Orange. 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 ».

35 / 114

2.4.7.4. Détail d’un équipement LoRa

Pour accéder aux informations détaillées concernant un équipement LoRa, cliquez sur

l’équipement désiré dans la liste principale du menu « Parc ».

L’onglet « supervision » fournit les informations suivantes sur l’équipement:

- son état: (voir définition au paragraphe « Etat des équipements»

- sa date de dernière communication (basé sur le champ timestamp remonté par la

gateway LoRa (LRR) qui a relayé le dernier message reçu)

- le signal réseau : il s’agit d’un indicateur de qualité de la connectivité calculé par Live

Objects sur la base des différents paramètres réseaux remontés par l’équipement

(RSSI, SNR, PER…)

- le niveau de batterie : Il se base sur la valeur transmise au réseau par l’équipement

(norme LoraWan)

36 / 114

- la géolocalisation de l’équipement sur une carte avec un cercle figurant la précision.

Cette précision est variable. Elle dépend du type de géolocalisation utilisée par votre

équipement (TDOA, Macro, device) ainsi que des conditions radio (couverture et

positionnement de l’équipement)

2.4.7.5. Modifier un équipement LoRa

Pour modifier un équipement LoRa allez dans les détails de l’équipement et cliquez sur la

rubrique « identité ».

Les informations concernant l’équipement sont présentées en deux parties :

- Les informations sur l’équipement indépendantes de ses interfaces

- Les informations spécifiques aux interfaces réseaux qu’il utilise pour se connecter à Live

Objects.

37 / 114

Les informations saisies lors de la création de l’équipement sont affichées. Il est possible de

modifier le nom, le profil, le décodeur, les tags ainsi que les clés appEUI et appKey

La modification du devEUI n’est pas possible.

Remarques:

- l’appKey n’est jamais affichée en clair

- Le nom, et les clés appEUI, appKey ne sont pas modifiables si l’équipement est

désactivé.

- Les options de connectivité doivent préalablement avoir été activées sur votre compte

par votre service client pour être sélectionnables.

38 / 114

2.4.7.6. Ajouter une option de connectivité

Les options de connectivité disponibles sont :

Géolocalisation TDOA : Sous conditions de couverture* ce type de géolocalisation

permet une précision beaucoup plus grande qu’une géolocalisation standard

« Ack Uplink » : Permet à l’équipement de demander au réseau un acquittement à

chaque uplink émis

(* Contactez votre service client)

Pour bénéficier de ces options :

1) contactez votre service client pour activer ces options sur votre compte Live Objects

2) ensuite vous pouvez affecter ces options à un équipement (voir paragraphe

« Modifier un équipement LoRa »)

Pour ajouter une option de connectivité à plusieurs équipements à la fois, sélectionnez vos

équipements dans la vue principale LoRa, puis cliquez sur l’icône « modifier ».

Dans la fenêtre qui s’ouvre cocher l’option désirée et sélectionner « ON » pour activer l’option

sur tous les équipements sélectionnés ou « OFF » pour la désactiver. Si une option est laissée

décochée aucune modification concernant cette option ne sera appliquée sur les équipements

de la sélection.

Exemples ci-dessous :

39 / 114

Dans cet exemple : On active

l’option TDOA sur tous les

équipements de la sélection.

Dans cet exemple : On

désactive l’option TDOA et on

active l’option Ack uplink sur

tous les équipements de la

sélection.

40 / 114

2.4.7.7. Consulter les données remontées par un équipement LoRa (uplink)

Pour consulter les données remontées par un équipement LoRa allez dans les détails de

l’équipement et cliquez sur la rubrique « Uplink».

La liste chronologique des messages envoyés par l’équipement est affichée ainsi que les

informations réseau associées :

La colonne « Payload » représente le contenu applicatif envoyé par l’équipement, au

format hexadécimal. Ce contenu peut être décodé en associant un décodeur approprié.

La colonne « Statut de décodage » indique si un décodage a été demandé et s’il s’est

déroulé correctement ou non

La colonne « Nombre de Gateway » indique le nombre de gateway qui ont relayé le

message (c’est la « macro-diversité »)

Informations réseaux : Rssi, Snr, Esp, Sf correspondant à la gateway ayant relayé le

message (« best LRR »)

L’utilisation du filtre permet de rechercher les messages collectés sur une plage de temps.

Le sélecteur positionné à 100 par défaut permet de limiter le nombre d’uplink à afficher. Les

1000 plus récents peuvent être affichés au maximum

Ce tableau peut également être exporté au format CSV

41 / 114

2.4.7.8. Envoi de commande à un équipement LoRa (downlink)

Pour envoyer une commande à un équipement LoRa allez dans les détails de l’équipement et

cliquez sur la rubrique « Downlink».

L’historique des commandes envoyées à l’équipement est affiché par ordre chronologique. La

colonne « statut » renvoie l’état de la commande et peut prendre les valeurs suivantes :

- Envoyé : Signifie que la commande a été prise en charge par le réseau, qui se chargera

de l’acheminer jusqu’à l’équipement en mettant en œuvre, le cas échéant des

mécanismes de « retry ». Dans la version actuelle cette information ne constitue pas un

accusé de réception par l’équipement

- Erreur : La commande n’a pas été acceptée par le réseau. Elle ne sera donc pas

délivrée à l’équipement

L’historique des commandes est exportable au format csv.

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 »

42 / 114

Le formulaire requiert la saisie de trois champs :

- le port utilisé par l’équipement (il doit être supérieur à 0)

- si la commande doit être acquittée par l’équipement (cocher la case « Confirmé »)

- les données de la commande au format hexadécimal (la validité du format est contrôlée)

Remarques :

- l’envoi de commandes MAC (port 0) n’est pas possible via Live Objects.

2.4.7.9. Antennes LoRa

Si vous disposez de vos propres antennes LoRa, vous pouvez les gérer dans votre portail Live

Objects, au même endroit que vos capteurs. Il y a pour cela deux prérequis :

Ces antennes doivent avoir été provisionnées dans le réseau Orange

L’option permettant de les visualiser doit avoir été activée sur votre compte Live Objects

Pour cela veuillez contacter votre service client.

Pour consulter l’état de vos antennes, rendez-vous dans le menu « Parc ». Sélectionnez

« LoRa » dans le sélecteur de connectivité et cliquez sur la rubrique « Antennes LoRa »

43 / 114

Vous accédez ainsi à la liste de vos antennes

Pour afficher les détails d’une antenne, cliquez dessus dans la liste

44 / 114

L’id de ces antennes sera ajouté dans les métadonnées des messages qu’elles auront relayés,

et que vous pouvez visualiser dans le menu « Données »

45 / 114

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

menu principal « Parc »

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

46 / 114

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 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.8.2. Supprimer un équipement MQTT

Il est possible de supprimer un équipement MQTT de la plateforme. Cette action aura pour

conséquence de le supprimer du gestionnaire de parc de Live Objects (historique, propriétés,

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 ».

47 / 114

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

48 / 114

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

interfaces de connectivité.

Modification des attributs

de l’équipement

49 / 114

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)

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

Les informations affichées donnent :

- le nom du paramètre (Id)

Désactivation/réactivation de

l’interface de connectivité

50 / 114

- sa valeur courante et son type

- la date de sa dernière mise à jour

Il est également indiqué si une demande de mise à jour est en cours :

- son statut

- la date changement du dernier statut

- la valeur cible

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 ».

51 / 114

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 :

« en attente » : 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)

« synchronisé » : 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)

« échoué » 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.

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».

L’historique des commandes est affiché. Le « Statut » indique :

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 n’a été

demandé lors de l’envoi de la commande, celle-ci passe automatiquement à l’état 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)

52 / 114

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é traitée par l’équipement

et non le résultat de ce traitement qui relève de l’applicatif. Ce résultat est une information qui

peut toutefois être communiquée par l’équipement lors de sa réponse à Live Objects.

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 » :

La commande à envoyer doit être saisie dans le champ « Requête ». Il est possible de passer

des arguments avec une commande. Ces arguments doivent être saisis sous forme de paires

clé-valeur. NB : Les valeurs de type chaine de caractère doivent être placées entre guillemets.

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 : Live Objects s’assure juste que la commande a été acheminée jusqu’à

l’équipement (souscription de l’équipement au topic de réception dev/cmd et

acquittement de réception du message via l’acquittement protocolaire MQTT)

- 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.

53 / 114

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

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

Si l’équipement n’est pas connecté à la plateforme, la commande passe en attente (statut

pending). Lorsque l’équipement est disponible pour recevoir des commandes, le statut passe à

« envoyé » (sent). Et lorsque l’équipement a répondu à la plateforme, le statut passe à « traité »

(processed).

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

54 / 114

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)

NB : Live Objects peut gérer plusieurs firmwares pour un même équipement si celui-ci le

supporte.

55 / 114

Pour lancer la mise à jour, choisir le firmware et cliquer sur le lien « changer » de la ligne

correspondante. Dans la fenêtre modale qui s’ouvre, choisir la version souhaitée et cliquer sur le

bouton « Enregistrer »

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.

56 / 114

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.

57 / 114

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

SMS pour communiquer avec la plateforme. Ce numéro a été provisionné lors de la création de

votre compte Live Objects.

58 / 114

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.

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 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

Dans la version actuelle, seule la création/suppression d’équipements SMS est possible via le

portail Live Objects.

L’envoi de commande est possible via API. Pour cela, rendez-vous dans la documentation API

(swagger) : https://liveobjects.orange-business.com/swagger-

ui/index.html#!/SMS_Connector/sendSMSUsingPOST)

59 / 114

2.4.9.4. Modifier un équipement SMS

Dans la version actuelle, seule la création/suppression d’équipements SMS est possible via le

portail Live Objects. La modification d’un équipement (par exemple, le changement de

décodeur, doit se faire via l’API https://liveobjects.orange-business.com/swagger-

ui/index.html#!/Device_management_-_Connector_nodes_-_V1/updateNodeUsingPATCH

Exemple pour un changement de décodeur

60 / 114

2.4.10. 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 « Tous les équipements » ou sur un groupe ou sous-groupe existant.

NB : Il n’est pas possible de supprimer un groupe qui contient au moins un équipement.

En cliquant sur un groupe vous affichez la liste des équipements qui en font partie. Un

équipement ne peut faire partie que d’un seul groupe à la fois.

Paramétrages de l’équipement à changer

(ici un nouveau décodeur)

réponse de l’api

61 / 114

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 ».

62 / 114

2.4.11. 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 supportées sont l’envoi de commandes, la mise à jour

de configuration, la mise à jour de firmware. La gestion de campagne est pour l’instant

disponible uniquement pour les équipements MQTT.

2.4.11.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 »

63 / 114

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 MQTT (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 (Voir le paragraphe

« Equipements MQTT » pour la description de ces opérations).

64 / 114

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.

65 / 114

2.4.11.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

66 / 114

2.4.11.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.

Une campagne annulée reste présente dans l’historique des campagnes avec le statut

« Annulée »

Répartition des cibles

vert : cibles traitées

rouge : cibles en erreur

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

67 / 114

2.4.11.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.11.5. Statuts d’une campagne

Statut (FR) Statut (EN) Signification

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

En cours Ongoing la date de démarrage est échue

ET

la date de fin n’est pas échue et des actions sont toujours en

cours

Lorsqu’une campagne est en cours, sa progression est

affichée : nb cibles atteintes/nb de cibles total, ainsi que les

cibles en échec

Annulation Canceling la campagne est en cours d’annulation. En attente que les

actions en cours se terminent. Les actions qui n’ont pas démarré

ne démarreront pas

Annulée Canceled la campagne a été annulée. Certaines actions programmées

peuvent ne pas avoir été réalisées

Succès Success la campagne s’est déroulée sans erreur : L’ensemble des cibles

ont été atteintes et les opérations réalisées avec succès*

(* Voir les paragraphes correspondants aux actions concernées)

Non terminée Incomplete la date de fin est échue, mais des cibles n’ont pu être atteintes,

ou des opérations ont échoué.

2.4.11.5.1. Statuts des équipements cibles

Statut (FR) Statut (EN) Signification

Succès Success les opérations ont été réalisées avec succès* sur l’équipement

cible (* Voir les paragraphes correspondants aux actions

concernées)

Non commencé Not started aucune opération n’a encore été démarrée sur l’équipement

68 / 114

cible

En cours In progress une opération est en cours sur l’équipement cible

Echec Failure une opération a échoué sur l’équipement cible

69 / 114

2.4.11.6. Rapport campagne

L’état détaillé d’une campagne peut être consulté à tout moment. Pour cela il suffit de cliquer

dessus dans la liste.

Retour à la liste des campagnes Supprimer la campagne

de l’historique

Bilan global de la

campagne et

possibilité d’actualiser

en temps réel

Détail par équipement

et possibilité

d’exporter au format

csv

Rappel des opérations

contenues dans la

campagne

Rappel de la

planification de la

campagne

70 / 114

2.5. Données

Les données qui sont stockées dans Live Objects peuvent être visualisées via le menu

« Données »

L’affichage des données peut être filtré à l’aide de différents champs :

Du/Au: La plage de temps sur laquelle effectuer la recherche

Connectivité : Il s’agit du type de connectivité utilisé par votre équipement pour

communiquer avec la plateforme. Il peut être « lora », « mqtt », « sms »

Source : Il s’agit de l’émetteur de la donnée (ex : URN de l’équipement, DevEUI LoRa,

msisdn)

Stream : Il s’agit de la série temporelle (« time-serie ») dans laquelle sont regroupées les

données. Un stream peut contenir toutes les données remontées par un même

équipement (cas par défaut pour LoRa), ou toutes les données d’un certain type (ex :

« temperatures », « pression »…)

Tags : Etiquettes insérées dans le data message par l’équipement qui l’émet.

Les données affichées dans le tableau :

Date : Il s’agit la date de la donnée communiquée par l’équipement (ou la gateway dans

le cas de Lora), via le champ « timestamp » du data message. (NB : Si ce champ est

absent, la date est celle de l’arrivée de la donnée dans la plateforme)

Tags : Tout comme les équipements, les données peuvent être « tagguées ». Ce tag est

inséré dans le data message par l’équipement qui l’émet.

Valeur : Il s’agit du « data message » remonté par l’équipement, dont le détail est

disponible en cliquant dessus.

Les détails propres au type d’équipement (connectivité LoRa ou MQTT)

71 / 114

72 / 114

2.5.1. Export des données

L’affichage de la page en cours peut être exporté au format csv en cliquant sur l’icône prévue à

cet effet.

73 / 114

2.5.2. Visualisation avancée

Live Objects s’appuie sur l’outil d’exploration de données et de dashboarding « Kibana ». Il

s’agit d’un outil basé sur la technologie « elastic search » qui permet la réalisation de tableaux

de bord dynamiques et la recherche avancée de données. Rendez-vous sur

https://liveobjects.orange-business.com/#/faq rubrique « Visualisation des données » pour en

savoir plus.

Pour lancer Kibana cliquer sur le bouton « Kibana »

Prérequis pour que vos données puissent être indexées par « elastic search » :

Pour les équipements MQTT

74 / 114

le champ « model » doit être renseigné dans le data message renvoyé par l’équipement.

Ce champ renseigne sur la structure du champ « value » du data message et permet

l’indexation des données contenue dans ce champ

si ce champ est absent du data message, les données dans « value » ne seront pas

indexées

si la structure du champ value change (par exemple un champ « temperature » qui

passe d’entier à string), la valeur du champ « model » doit être changée également. Un

même modèle de données ne peut être utilisé pour indexer des données de structures

différentes.

la valeur du champ « model » n’est pas imposée par Live Objects, elle est fournie par

l’équipement

Voir le manuel développeur pour la description détaillée du data message

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

Pour les équipements LoRa

la payload doit être décodée pour que les données puissent être indexées

le décodeur doit spécifier également un champ modèle correspondant à la structure de

la donnée décodée, ceci pour les même raisons qu’explicité ci-dessus.

2.5.3. Files de messages (fifo)

Les files de messages, ou « fifo » sont des espaces disque de taille limitée utilisés pour persister

les messages consommés en temps réel par les applications métier connectées à Live Objects

en MQTT (voir paragraphe « Consommation des données par les applications »)

L’espace disque total alloué aux fifo dépend de votre offre (ex : 100 Mo pour 10 fifo). Contactez

votre service client pour plus d’informations.

Les messages sont dépilés de la fifo (premier entrée, premier sorti) dès qu’un ou plusieurs

consommateurs y ont souscrit. En cas de plusieurs consommateurs sur une même fifo les

messages sont « load balancés » entre les consommateurs.

Si une fifo est pleine le message le plus récent remplace le message le plus ancien dans la fifo.

Les messages non consommés dans les fifos sont automatiquement supprimés au bout de 7

jours.

Pour créer une fifo veuillez-vous rendre dans le menu « Données » et sélectionnez la rubrique

fifo.

75 / 114

Pour alimenter une fifo avec des données voir le paragraphe « Routage des données ».

76 / 114

2.5.4. Routage des données

Les données collectées par Live Objects peuvent être routées vers des files de messages (fifo)

ou poussées vers des serveurs http externes (push http).

2.5.4.1. Créer une règle de routage

La création d’une règle de routage se fait en trois étapes :

1) Nom de la règle

2) Critères de sélection des messages à router

3) Mode de routage (fifo ou push http)

Pour démarrer allez dans la rubrique « Routage » du menu « Données », et cliquez sur « Créer

une règle de routage »

Etape 1 : Nommage de la règle

77 / 114

Etape 2 : Sélection des messages à router

Si vous souhaitez router uniquement certains messages, vous pouvez les filtrer :

Par connectivité : Seuls les messages des équipements utilisant la connectivité

sélectionnée seront pris en compte

Par groupes ou sous-groupes : Seuls les messages émis par les équipements

appartenant aux groupes sélectionnés seront pris en compte.

Vous pouvez également saisir directement les identifiants des équipements (URN) dont

vous souhaitez router les messages. Vous pouvez obtenir les identifiants des

équipements en visualisant leur détail dans le menu « Parc »

NB : Les critères par « groupe » ou par « identifiant de d’équipements » sont mutuellement

exclusifs

NB : En cas de sélection de plusieurs critères, les filtres s’ajoutent (« AND »). Dans l’exemple ci-

dessus les messages qui seront sélectionnés seront tous les messages remontés par des

équipements LoRa et qui sont membres des groupes « Allemagne » ou « Belgique ».

78 / 114

Etape 3 : Sélection du mode de routage

Voir les paragraphes suivants pour paramétrer le mode de routage.

NB : Il est tout à fait possible de combiner plusieurs mode de routage (ex : router à la fois vers

des fifos et des serveurs http externes)

2.5.4.2. Routage vers des fifo

A l’étape 3 de la création de la règle de routage, cliquez sur le bouton « +FIFO », puis

sélectionnez dans la liste des fifos existantes, la fifo cible.

Pour créer une fifo rendez-vous au paragraphe « Files de messages (fifo) »

Vous pouvez router les messages vers plusieurs fifo à la fois. Dans ce cas les messages seront

dupliqués dans chacune des fifo cibles

79 / 114

2.5.4.3. Push http

A l’étape 3 de la création de la règle de routage, cliquez sur le bouton « +HTTP Push ».

Saisissez dans le champ URL, l’adresse du serveur http externe à laquelle envoyer les données.

Si le serveur http externe requiert des entêtes spécifiques (typiquement des informations

d’authentification) vous pouvez les saisir dans le champ prévu à cet effet.

Attention : Les ports de sortie autorisés sont les ports standards uniquement : 80, 8080, 443,

8443, 9243

Si la « Politique en cas d’échec » est activée, Live Objects va essayer, en cas d’erreur de type

« 5xx » retournée par le serveur distant, de transmettre à nouveau les messages à intervalles

réguliers.

NB : Seules les erreurs indiquant un dysfonctionnement du serveur distant (ex : 500 Internal

error) sont prises en compte par le mécanisme de retransmission. Les erreurs de types 400

(page introuvable, accès interdit…) n’indiquant pas à priori un comportement anormal du

serveur distant, le mécanisme de retransmission ne sera pas activé dans ces cas-là.

Les données à transmettre peuvent être :

L’ensemble du message : C’est l’intégralité du message Live Objects, c’est-à-dire les

données remontées par l’équipement lui-même (champ « value » : {..}) ainsi que toutes

80 / 114

les métadonnées (ex : information de connectivité…) et les données issues de

l’enrichissement du gestionnaire de équipements de Live Objects (appartenance aux

groupes, propriétés etc)

La valeur seulement : Seulement la partie « value » : {..} du message Live Objects

Message formaté à l’aide d’un template Mustache : Dans ce cas vous pouvez choisir

quelles données contenues dans message Live Objects vous souhaitez transmettre et

sous quelle forme. Le formalisé utilisé pour la mise en forme est le formalisme

« Mustache » https://mustache.github.io/mustache.5.html

Exemple ci-dessous :

Important : Vous avez la possibilité de tester votre webhook avant la création de votre règle de

routage de façon à vous assurer que Live Objects communique bien avec le service externe.

Pour cela utilisez l’API de test disponible dans le swagger https://liveobjects.orange-

business.com/swagger-ui/index.html#!/Triggers_and_Actions_-_Test/testHttpPushUsingPOST

2.5.4.4. Suspendre / réactiver une règle

Vous pouvez à tout moment suspendre ou réactiver une règle, via les icônes correspondantes

dans la rubrique « Routage » du menu « Données ».

Ensemble du

message Live

Objects

Valeur du message

Message formaté Mustache :

{

"valeur1" : "android35709970479549PRIMARY",

"valeur2" : "temperature",

"valeur3" : "hygrometry"

}

81 / 114

2.5.5. Consommation des données par les applications

Les applications métier disposent de différentes API pour consommer les données de Live

Objects, en temps réel ou de façon asynchrone.

2.5.5.1. Explorer les données

Pour l’exploration de données, les API http REST sont à utiliser :

API “Datastore” : https://liveobjects.orange-business.com/swagger-

ui/index.html#!/Data_management_data_store/retrieveDataUsingGET. Cette API offre

simplicité et performance pour les recherches de type time series.

API “Search” : https://liveobjects.orange-business.com/swagger-

ui/index.html#!/Data_management_data_search/dslQueryUsingPOST. Cette API est

indiquée pour les recherches complexes. Les données recherchées doivent être

indexées.

Pour plus de détails sur ces API veuillez consulter le guide développeur :

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

2.5.5.2. Consommer les données en temps réel

Les données peuvent être consommées en temps réel par les applications métier de deux

façons : Soit en se connectant à Live Objects en utilisant le protocole MQTT, soit en demandant

à Live Objects de pousser les données au serveur applicatif via http.

2.5.5.2.1. Consommation via MQTT

Prérequis :

Avoir créé une fifo et l’alimenter en données par une règle de routage. Voir les

paragraphes « Files de messages (fifo) » et « Routage des données »

Des exemples de codes sont disponibles pour intégrer le protocole MQTT à votre

applicatif : https://liveobjects.orange-business.com/#/cms/ressources-exemples-de-

codes/

NB : L’utilisation de clients MQTT avec GUI peut grandement faciliter les tests et prototypages

de connexions MQTT. On peut citer HiveMQ, MQTT.box, MQTT.fx.

Etape 1 : Connexion

Les paramètres de connexion MQTT à renseigner sont les suivants :

URL du serveur : liveobjects.orange-business.com

Port : 1883 (défaut), 8883 (MQTTS), 80 (MQTT over Websocket), 443 (Secure

websocket)

82 / 114

Username: application

Password: la valeur d’une clé d’API disposant des droits BUS_R (voir le paragraphe

« Gérer les clés d’API »)

Keep Alive : 30 secondes

NB : L’identifiant de connexion MQTT (« clientID ») est libre.

NB : les options MQTT « will » ne sont pas utilisées par le serveur MQTT Live Objects

NB : Pour obtenir le certificat nécessaire aux connexions sécurisées (TLS) rendez-vous dans la

documentation développeur https://liveobjects.orange-

business.com/doc/html/lo_manual_v2.html#_server_certificates

Etape 2 : Souscription à la fifo

Souscrire à la fifo qui a été préalablement créée (voir prérequis) en souscrivant au topic :

fifo/myFifo

Le préfixe fifo/ est obligatoire

myFifo est le nom de votre fifo

La consommation des messages démarre dès que la souscription est réalisée.

NB : Les valeurs de « qos » MQTT supportées par Live Objects sont 0 et 1.

2.5.5.2.2. Consommation via push HTTP

Prérequis : Un serveur applicatif disposant d’un service web capable de recevoir les requêtes

http en provenance de Live Objects

Pour démarrer la consommation de messages via push http, créez une règle de routage « Push

http ». Les messages sont poussés vers le serveur applicatif cible dès que la règle est activée.

Voir le paragraphe « Routage des données / Push http »

83 / 114

2.5.6. Journal d’activité

Le journal d’activité est un outil précieux pour diagnostiquer des problèmes de connectivité, de

stockage ou de notification vers de systèmes tiers.

Les informations affichées dans le journal d’activité peuvent être filtrées en fonction de leur

catégorie, et des offres activées sur le compte Live Objects.

Pour accéder au journal d’activité, rendez-vous dans le menu Données et cliquer sur « journal »

2.5.6.1. Connectivité LoRa

Pour afficher les informations concernant la connectivité LoRa sélectionner dans la barre de

filtre, la catégorie « Connectivité » et la valeur « LoRa ».

Les messages de connectivité LoRa que vous pouvez afficher sont :

Join Request, join Accept

Commandes MAC avec affichage des valeurs (RawValue) pour les commandes initiées

par l’équipement (LinkCheckReq/LinkCheckAns et DevStatusReq/DevStatusAns)

Uplink : Envoi de payload applicative, demande d’acquittement réseau (« Ack uplink »)

Downlink : Envoi de commande à un équipement, Acquittement uplink

Barre de filtre

84 / 114

2.5.6.2. Connectivité MQTT

Pour afficher les informations concernant la connectivité MQTT sélectionner dans la barre de

filtre, la catégorie « Connectivité » et la valeur « MQTT».

Les évènements suivants sont journalisés avec le niveau ERROR :

- Souscription/publication à/sur un topic incorrect (1)

- Publication avec un format de message incorrect (1)

- Rate limiting atteint (2)

- Déconnexion en raison d’une connexion concurrente utilisant un même clientId

Les évènements suivants sont journalisés en INFO : - Connexion / déconnexion

NB : Le niveau INFO est non loggé par défaut et nécessite le passage de l’API Key en mode

debug. Pour activer le mode debug sur une clé d’API reportez-vous au paragraphe « Passer

une clé d’API en mode debug »

(1) Consulter le guide développeur

(2) Consulter votre service client

2.5.6.3. Stockage

La catégorie stockage permet de journaliser les évènements liés à des problèmes d’indexation:

- Limite du nombre de champs indexables atteinte (1000)

- Incohérence de modèle (Un champ ne peut pas être indexé avec deux types différents

pour un même modèle)

- Données impossibles à indexer (Ex : Un tableau contenant des données de différents

type [1234, « data »])

2.5.6.4. Notification

La catégorie notification permet de journaliser les évènements liés aux notifications vers des

systèmes externes:

- Push http : Seules les erreurs sont journalisées. Les push en succès (codes retour http

20x) ne sont pas journalisés.

85 / 114

2.5.6.5. Limitations

- Les évènements sont conservés dans le journal pendant 14 jours

- Le nombre d’évènements maximum journalisés est de 10 millions

- Le nombre d’évènements maximum exportables via le portail est de 10 000

2.6. Configuration

Le menu « Configuration » permet la gestion de votre compte Live Objects

2.6.1. Identification du compte

La rubrique « Compte » donne les informations d’identification du compte

- Nom : Le nom du compte

- Numéro de compte client : Identifiant de client Orange tel qu’il figure sur votre facture

- Identifiant Live Objects: Il s’agit d’un identifiant technique utile pour le support technique

- Date de création : La date de création du compte

86 / 114

2.6.2. Identification de l’utilisateur connecté

Plusieurs utilisateurs peuvent se connecter au compte Live Objects (administrateurs, simples

utilisateurs. Voir le paragraphe « Gérer les utilisateurs »). La partie « Mon Profil » de la rubrique

« Compte » indique l’identifiant de connexion et l’email de l’utilisateur actuellement connecté »

2.6.3. Limites de trafic

Les limitations de trafic appliquées à votre compte Live Objects sont décrites dans la section du

même nom. Ces limitations dépendent de votre offre.

2.6.4. Rôles et droits dans Live Objects

Les droits dans Live Objects sont gérés via des « rôles ». Chaque rôle délimite un périmètre

d’actions possibles sur une ou plusieurs fonctionnalités du produit. Ces rôles peuvent être

attribués à des utilisateurs, ou à des clés d’API utilisées par les équipements ou les applications

accédant à Live Objects.

Deux profils d’utilisateurs sont disponibles dans Live Objects :

- Le profil « administrateur » : il dispose de tous les droits de modification sur le compte

Live Objects,

87 / 114

- Le profil « utilisateur » : il dispose essentiellement de droits en lecture.

Il est également possible de définir un profil personnalisé, en sélectionnant chaque rôle que l’on

souhaite affecter à un utilisateur donné. (Voir le paragraphe « Gérer les utilisateurs »)

Le tableau ci-dessous résume les différents rôles attribués à chaque profil :

Valeur technique

(Read/Write) Description

Administra

teur

Utilisateur

API_KEY_R/W Gestion des clés d’API R/W R/W

USER_R/W Gestion des utilisateurs R/W R

SETTINGS_R/W Paramétrage du compte R/W R/W

DEVICE_R/W Gestion des équipements connectés R/W R

DATA_R/W Accès aux données collectées R/W R

DATA_PROCESSIN

G_R/W

Configuration du décodage et traitement des

données collectées. R/W R

KIBANA_R Accès à Kibana R/W R

BUS_CONFIG_R/W Gestion du routage et files de messages (fifo) R/W R/W

BUS_R/W Accès au bus de messages via MQTT (ou http) R/W R

DEVICE_ACCESS Accès d'un équipement MQTT (permet à créer

des clés d’API réservées aux équipements)

R/W R/W

CAMPAIGN_R/W Gestion des opérations en masse sur un ensemble

d'équipements (campagnes) R/W R

LOGS_R Permet l’accès au Journal d’Activité R N/A

CONNECTOR_ACCE

SS_R/W

Permet de créer des clés API pour connecter en

MQTT des connecteurs externes R/W R/W

2.6.5. Gérer les utilisateurs

Les utilisateurs de Live Objects peuvent être gérés à partir de la rubrique « Utilisateurs »

88 / 114

Actif : L’utilisateur a accès à Live Objects

Suspendu : L’accès à Live Objects a été suspendu pour l’utilisateur par un administrateur du

compte Live Objects

Inactif : Un email d’activation a été envoyé à l’utilisateur, mais ce dernier ne l’a pas encore

activé

89 / 114

2.6.5.1. Créer d’un utilisateur

Pour créer un utilisateur cliquez sur le bouton « Ajouter »

L’identifiant est celui utilisé par l’utilisateur pour se connecter à son portail Live Objects.

L’email est l’adresse à laquelle sera envoyé l’email d’activation, ainsi que les demandes de

réinitialisation de mot de passe.

Le profil permet de sélectionner un des profils de droits prédéfinis : « administrateur » ou

« utilisateur ». Pour attribuer des droits personnalisés, sélectionner « Personnalisé », et

cocher/décocher les rôles souhaités.

Cliquez sur le bouton « Ajouter » pour valider la création de l’utilisateur. Un email d’activation est

aussitôt envoyé à l’utilisateur. Cet email contient un lien d’activation valable 7 jours.

Tant que le l’utilisateur n’a pas activé son accès en cliquant sur le lien d’activation, son état

reste à « inactif ».

Si l’utilisateur n’a pas validé son accès dans les 7 jours, il sera nécessaire de renvoyer un email

d’activation. Cela peut se faire via la liste principale des utilisateurs en sélectionnant le ou les

90 / 114

utilisateurs concernés et en cliquant sur l’icône « Activer », ou dans les détails de l’utilisateur en

cliquant sur le bouton « Envoyer le mail d’activation »

2.6.5.2. Suspendre / réactiver un utilisateur

Il est possible de suspendre l’accès au service pour un utilisateur de façon temporaire. Pour

cela allez dans les détails de l’utilisateur en cliquant dessus dans la liste principale et cliquez sur

le bouton « Suspendre ». La suspension est immédiate, l’utilisateur ne peut plus se connecter

au portail Live Objects.

Pour réactiver un utilisateur suspendu, allez dans les détails de l’utilisateur et cliquez sur le

bouton « Réactiver ». La réactivation est immédiate et l’utilisateur peut à nouveau se connecter

au portail Live Objects.

2.6.5.3. Supprimer un utilisateur

Pour supprimer un utilisateur sélectionnez-le dans la liste principale et cliquez sur l’icône

« Supprimer ». La suppression est immédiate et définitive.

2.6.6. Gérer les clés d’API

Les clés d’API permettent :

- Aux équipements utilisant MQTT de se connecter à la plateforme

- Aux applications métiers d’utiliser les services Live Objects via les API (MQTT et REST) :

o Exploration de données (Search)

o Consommation de données en temps réel

o Device management

o Configuration (utilisateurs, décodeurs etc.)

Toutes les fonctionnalités disponibles via le portail Live Objects le sont également via les API

REST (voir https://liveobjects.orange-business.com/#/swagger)

Les API MQTT sont réservées :

- à la connexion des équipements utilisant ce protocole

- à la consommation de données en temps par les applications métier

Comme pour les utilisateurs il est possible d’affecter des rôles à des clés d’API, afin d’autoriser

certains fonctionnalités. Par exemple :

- une clé API utilisée par un équipement MQTT ne nécessite que le rôle DEVICE_ACCESS

- une application métier qui a besoin d’utiliser les API de « device management »

nécessitera le rôle DEVICE_R (si consultation simple) et DEVICE_R + DEVICE_W (si

consultation et modification)

91 / 114

- une application métier qui a besoin de consommer des données en temps réel via

MQTT aura besoin du rôle BUS_R

NB : pour chaque API REST, le rôle nécessaire est indiqué dans le swagger

(https://liveobjects.orange-business.com/#/swagger).

Pour visualiser l’ensemble des clés d’API crées dans votre compte Live Objects allez dans la

rubrique « Clés d’API » du menu « Configuration ».

2.6.6.1. Créer une clé d’API

Pour créer une nouvelle clé d’API cliquer sur le bouton « Ajouter » du menu principal.

92 / 114

Lors de la création d’une clé d’API vous pouvez choisir de lui affecter un profil de droits

prédéfini en fonction de votre usage, ou un profil personnalisé.

- Le profil « Equipement MQTT » est le profil à sélectionner pour les clés destinées à

connecter des équipements MQTT.

- Le profil « Application » est le profil à sélectionner pour les clés utilisées par les serveurs

applicatifs pour les usages principaux : consommation de données en temps réel,

configuration de files de message, gestion des décodeurs et « Event processing ».

- Le profil « Connecteur externe » est le profil à sélectionner pour les clés destinées à être

utilisées par des connecteurs externes. Un connecteur externe permet de gérer dans

Live Objects des équipements « cloud » ne pouvant pas être connectés directement à

Live Objects (connectivité, modèle de donnée ou mode de fonctionnement propriétaires

ou non supportés par Live Objects)

- Pour des besoins plus avancés (« Device management », gestion de campagne par

exemple), utiliser le profil « Personnalisé » et sélectionnez les droits souhaités.

Vous pouvez également définir une période de validité pour votre clé. A l’expiration de la

période la clé sera automatiquement désactivée.

Il est également possible de restreindre une clé d’API à une ou plusieurs files de messages (fifo).

Cela signifie que cette clé ne pourra être utilisée que pour la consommation des messages

routés dans les files spécifiées et uniquement cela. La consommation de messages sur d’autres

files, ou l’utilisation d’autres API, notamment REST, avec cette clé sera impossible.

Cette fonctionnalité vous permet de partager avec un tiers des données issues de certains

équipements tout en restreignant l’accès de votre compte Live Objects à ces données

uniquement.

Pour valider la création de la clé, cliquez sur le bouton « Créer ». Votre clé est générée sous la

forme d’une séquence alphanumérique et d’un QR code.

93 / 114

Remarque importante : La clé n’est pas stockée dans Live Objects. Seul un hash est conservé

dans la plateforme. Il vous appartient de la conserver en lieu sûr. En cas de perte la clé ne

pourra être retrouvée dans Live Objects, elle devra être supprimée et régénérée et les systèmes

l’utilisant (équipements MQTT, applications) devront être mis à jour avec la nouvelle clé.

2.6.6.2. Hiérarchie des clés d’API

Il est possible de créer des clés filles d’une clé d’API. Ces clés filles hériteront automatiquement

des rôles de la clé parent ainsi que de sa validité.

Il n’est pas possible d’ajouter à une fille des rôles non détenus par la clé parent.

La désactivation de la clé parent, entraine automatiquement la désactivation de toute sa

descendance.

L’utilisation de clés filles peut être utile pour gérer des groupes et sous-groupes de clés d’API.

Par exemple une seule clé d’API pour un groupe d’équipements, avec une clé fille pour chacun,

permettra de désactiver en un clic l’accès à Live Objects pour ce groupe d’équipements.

Pour créer une clé fille, il suffit de sélectionner la clé désirée en cliquant dessus dans la liste,

puis de cliquer sur le bouton « Ajouter » dans l’écran de modification, en bas de page.

94 / 114

2.6.6.3. Régénérer une clé d’API

Vous pouvez régénérer une clé à partir de l’écran de modification de la clé, en cliquant sur le

bouton « Régénérer ». Une nouvelle valeur de clé sera alors générée et l’ancienne valeur sera

caduque. Si vous régénérez une clé (en cas de perte, par exemple) vous devez mettre à jour les

systèmes qui l’utilisent (équipements MQTT, applications).

2.6.6.4. Désactiver/ réactiver une clé d’API

Vous pouvez avoir besoin de désactiver temporairement une clé d’API. Cela est possible à

partir de l’écran de modification de la clé, en cliquant sur le bouton « Désactiver ». L’accès API

deviendra alors impossible pour tout système utilisant cette clé. Inversement, une clé peut être

95 / 114

instantanément réactivée en cliquant sur le bouton « Activer » présent dans l’écran de

modification de la clé, ou via la liste principale en cliquant sur l’icône « Activer »

2.6.6.5. Supprimer une clé d’API

Pour supprimer une ou plusieurs clés d’API, sélectionnez-les dans la liste principale et cliquez

sur l’icône « Supprimer ».

La suppression est irréversible, et l’accès à tout système utilisant la ou les clés est rendu

impossible.

NB : La suppression d’une clé parent entraine automatiquement la suppression de toutes ses

clés filles.

2.6.6.6. Passer une clé d’API en mode debug

Le passage en mode debug d’une clé d’API permet l’affichage dans le journal d’activité des

informations de connexion / déconnexion MQTT (Voir le paragraphe « Journal d’activité »). Le

mode debug est désactivé par défaut et ne peut être activé que pour une durée limitée.

Pour passer une clé en mode debug, ouvrez les propriétés de la clé en cliquant dessus, puis

cliquer sur le bouton « Activer le mode debug ». Une fenêtre vous demandera de spécifier le

délai pendant lequel le mode debug sera actif. A l’issue de ce délai, le mode debug sera

automatiquement désactivé.

96 / 114

Lorsque le mode debug est activé, cela est mentionné dans les détails de la clé ainsi que le

temps restant.

97 / 114

2.6.7. Gérer les firmwares

La mise à jour de firmware nécessite que l’équipement soit connecté en MQTT et qu’il

implémente la logique de « device management » (voir le manuel développeur

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

Pour pouvoir mettre à jour le firmware de vos équipements, vous devez préalablement avoir

créé le ou les firmwares correspondants dans Live Objects. Cela consiste en deux étapes :

1. Création du firmware avec le même ID que celui communiqué par l’équipement

2. Création des différentes versions rattachées à ce firmware et import dans Live Objects

des binaires correspondants.

Etape 1

Pour créer un nouveau firmware, rendez-vous dans la rubrique « Firmwares » du menu

« Configuration » et cliquez sur le bouton « Créer un firmware »

Saisissez bien le même Id de firwmare que celui communiqué par votre équipement, et

sélectionnez le connecteur « http-updater ». Cliquez sur le bouton « Créer le nouveau firmware »

pour terminer l’étape 1.

98 / 114

Etape 2

Dans la liste principale, cliquez sur le lien « Ajoutez une version » correspondant au firmware

précédemment créé.

Indiquez l’id de la version en cohérence avec celui communiqué par votre équipement, puis

importez le fichier binaire correspondant au firmware.

NB : Vous avez la possibilité de gérer la compatibilité entre les versions de firmwares. Pour cela

indiquez dans le champ « Anciennes autorisées » les anciennes versions de firmware

compatibles avec cette nouvelle version. Si vous ne précisez aucune version, cela signifie que la

nouvelle version pourra s’installer sur n’importe quelle version précédente.

99 / 114

Les différentes versions créées pour un firmware donné, sont consultables en cliquant sur

l’icône correspondant à la ligne du firmware concerné.

Vous pouvez maintenant programmer une mise à jour de firmware. Pour cela rendez-vous dans

le menu de gestion de parc. (Voir paragraphe « mettre à jour le firmware d’un équipement

MQTT ».

100 / 114

2.6.8. Gérer les décodeurs

Les décodeurs permettent de traduire les données remontées par les équipements sous forme

« informatique » (ex : payload hexadécimale pour les équipements LoRa), en données

humainement compréhensibles et indexables. Cette traduction permet en outre l’utilisation de

services avancés se basant sur les données, tels que la gestion d’évènements, le paramétrage

d’actions sur évènements etc. Ces fonctions avancées ne sont pour l’instant disponibles que

via API (Voir le manuel développeur https://liveobjects.orange-

business.com/doc/html/lo_manual_v2.html)

2.6.8.1. Type des décodeurs

Les décodeurs disponibles dans Live Objects sont de 2 types :

Les décodeurs « paramétrables » : Il s’agit des décodeurs binaires (payload

hexadécimales), ou csv (payload texte avec séparateur). Ces décodeurs sont adaptés

pour les équipements dont la structure de la payload ne varie pas. Vous pouvez créer

vos propres décodeurs paramétrables vous-même (voir paragraphe « Créer un

décodeur paramétrable »)

Les décodeurs « programmables » (Script) : Ces décodeurs s’adressent aux

équipements dont la structure de la payload est complexe et ne peut être traitée par un

décodeur paramétrable. Pour des raisons de sécurité, la mise en production de ce type

de décodeur ne peut être faite que par les équipes d’Orange (voir paragraphe « Créer

un décodeur programmable »)

2.6.8.2. Visibilité des décodeurs

Les décodeurs peuvent être « privés », c’est-à-dire visibles et utilisables uniquement dans votre

compte Live Objects, c’est le cas des décodeurs paramétrables que vous créez vous-même.

Orange propose également dans le cadre de son catalogue d’objets

https://iotmarket.orange.com une liste de décodeurs prédéfinis adaptés aux différents

matériels. Ces décodeurs sont dits « publics » c’est-à-dire visibles et utilisables par tous les

clients Live Objects.

La liste des décodeurs publics et privés est affichée dans la fenêtre principale de la rubrique

« Décodeurs» du menu « Configuration »

101 / 114

2.6.8.3. Modèle de données et Indexation

Lorsque vous créez un décodeur vous pouvez spécifier un modèle. Ce modèle décrit la

structure de la donnée décodée et permet son indexation correcte dans Live Objects. Si aucun

modèle n’est spécifié, un modèle par défaut sera affecté :

- « lora_v0 » dans le cas d’une donnée émise par un équipement LoRa

- « sms_v0 » dans le cas d’une donnée émise par un équipement SMS

- Il n’y a pas de modèle par défaut dans le cas d’un équipement MQTT ce qui signifie que

la donnée décodée ne sera pas indexée si aucun modèle n’est explicitement indiqué

Exemple, prenons la donnée décodée suivante :

"value" : {

"test3": 0,

"test5": 7,

"pressure": -86,

"temperature": -1

}

Si le modèle défini lors de la création du décodeur est « MyModel », alors les données

décodées seront indexées dans Live Objects de la façon suivante :

@mymodel.value.temperature, @mymodel.value.pressure etc

Si aucun modèle n’est spécifié et que les données proviennent d’un équipement lora, les

données décodées seront indexées de la façon suivante :

@lora_v0.value.temperature, @lora_v0.value.pressure etc

102 / 114

IMPORTANT : Une même donnée ne peut être indexée avec deux types différents. Exemple, ici

l’information portée par la variable « temperature » devient de type string et non plus numeric

"value" : {

"test3": 0,

"test5": 7,

"pressure": -86,

"temperature": "-1"

}

Si le modèle utilisé est le même que précédemment alors il y aura un conflit d’indexation, et la

donnée @mymodel.value.temperature ne sera pas indexées. Dans ce cas une erreur sera

reportée dans le journal d’activité (voir paragraphe « Journal d’activité »).

2.6.8.4. Créer un décodeur paramétrable binaire

Pour créer un décodeur paramétrable, rendez-vous dans la rubrique « Décodeurs » du menu

« Configuration », et cliquez sur le bouton « Ajouter »

La création du décodeur se fait en deux étapes :

1. Définition et test du décodeur

2. Création du décodeur

103 / 114

Etape 1 : Définition du décodeur

Dans cette étape il s’agit de décrire la structure de la payload. Live Objects s’appuie sur la

librairie JBBP (Java Binary Block Parser) pour la description des structures binaires. Les

différents types sont consultables ici https://github.com/raydac/java-binary-block-

parser#primitive-types

Dans le champ « Description du contenu binaire » saisissez la structure de votre payload de la

façon suivante : type variable;

Dans l’exemple donné ci-dessous, la variable « test3 » est codée sur 3 bits, la variable « test5 »

sur 5 bits et les variables « pressure » et « temperature » sur 1 octet chacun. Ce qui constitue

une payload de 3 octets au total.

104 / 114

Il est conseillé de tester le décodeur avant de le créer. Pour cela ne cliquez pas de suite sur le

bouton « Créer », mais saisissez d’abord une payload de test dans le champ « Contenu à

décoder, en hexadécimal » et cliquez sur le bouton « Tester ». Dans l’exemple ci-dessus la

payload 38AAFF va correspondre aux valeurs décodées

{

"test3": 0,

"test5": 7,

"pressure": -86,

"temperature": -1

}

En effet 38AAFF correspond à la séquence binaire 00111000 10101010 11111111

Premier octet : les trois premiers bits sont à 000 ce qui vaut 0 en décimal (valeur de test3), les 5

suivants sont à 00111 ce qui vaut 7 en décimal (valeur de test5), l’octet complet 00111000

valant 38 hexa

Second octet : AA en hexa vaut -86 en décimal (valeur de pressure)

Troisième octet : FF en hexa vaut -1 en décimal (valeur de temperature)

38 AA FF

105 / 114

Il est possible de mettre en forme les données décodées et d’y appliquer des opérations

mathématiques (application d’offset, conversion d’unités…). Cela est rendu possible via

l’utilisation de « templates ». Les templates s’appuient sur le formalisme « mustache »

http://mustache.github.io/

Si l’on reprend l’exemple précédent on peut vouloir donner un sens particulier aux valeurs

véhiculées par « test3 » et « test5 » ainsi que convertir les valeurs de pression et de température

et les afficher avec la bonne unité.

Le sélecteur « Evaluation mathématique du template » permet de restreindre l’évaluation

mathématique aux balises {{math}} seulement (valeur off) ou de l’étendre à tout le template

(valeur on)

Attention : Le caractère « . » dans nom des variables n’est pas supporté : Dans l’exemple

précédent « bat.stat» au lieu de « batStat » provoquerait une erreur.

Etape 2 : Création du décodeur

Une fois le décodeur testé et validé, vous pouvez le créer en cliquant sur le bouton « Créer ». Il

devient immédiatement disponible pour être utilisé par vos équipements (voir le paragraphe

« Affecter un décodeur à un équipement »)

106 / 114

107 / 114

2.6.8.5. Créer un décodeur paramétrable csv

Pour créer un décodeur paramétrable de type csv, procédez de la même façon que pour un

décodeur paramétrable binaire. La structure de la payload est simplement constituée de

couples « Nom de la variable » (name) et « type » (jsonType), et d’un caractère séparateur. Elle

doit être saisie dans le champ « Description des colonnes ».

Les valeurs possibles pour le type sont : NUMERIC (integer, long, float double), STRING (UTF-

8), et BOOLEAN (« true »/ »false »)

Le champ « Options de format » permet de saisir différentes options de formatage du csv et en

particulier le caractère séparateur. Si ce champ n’est pas rempli le caractère séparateur par

défaut est la virgule, comme indiqué dans l’exemple ci-dessus.

La liste complète des options disponibles se trouve dans la documentation développeur

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

108 / 114

Il est également possible de définir un template pour la mise en forme des données décodées,

de la même façon que pour le décodeur binaire (voir « Créer un décodeur paramétrable

binaire »)

2.6.8.6. Créer un décodeur programmable

Si votre équipement produit des payload à structures variables et complexes, il vous est

possible de recourir à des décodeurs programmables. La création de ce type de décodeur

nécessite une intervention de la part des équipes d’Orange. Si vous ne trouvez pas de

décodeur public correspondant à votre matériel, veuillez effectuer votre demande à l’adresse

liveobjects.support@orange.com.

2.6.8.7. Désactiver/réactiver un décodeur paramétrable

Lors de sa création un décodeur est automatiquement activé, mais il est possible de le

désactiver si l’on souhaite suspendre temporairement le décodage pour les équipements qui

l’utilisent.

Pour désactiver/réactiver un décodeur, cliquez dessus à partir de la liste principale de la

rubrique « Décodeurs », puis cliquer sur le bouton « Désactiver/Activer »

109 / 114

NB : Seul les décodeurs qui vous appartiennent (décodeurs privés) peuvent être désactivés.

2.6.8.8. Affecter un décodeur à un équipement

Vous pouvez affecter des décodeurs à des équipements LoRa, ou SMS. Les équipements

utilisant MQTT n’utilisent pas de décodeur car ils remontent déjà un format de données non

encodé (json).

Vous pouvez affecter un décodeur à un équipement LoRa, lors de sa création en sélectionnant

le décodeur dans la liste proposée (voir « Ajouter un équipement LoRa »), ou à un équipement

déjà existant (voir « Modification d’un équipement LoRa »). NB : Une fois le décodeur associé à

l’équipement les prochaines payload remontées seront automatiquement décodées. En

revanche les payload remontées avant l’association du décodeur restent elles non décodées.

L’affectation d’un décodeur à un équipement SMS, ne peut se faire via le portail, que lors de

l’ajout de l’équipement (voir « Ajouter un équipement SMS »). Néanmoins il reste possible de

modifier un équipement SMS existant et d’y ajouter un décodeur en utilisant les API, voir

paragraphe « Modifier un équipement SMS »

110 / 114

2.7. Alarmes

Dans ce menu vous pouvez paramétrer des alarmes et les visualiser.

Les types d’alarmes actuellement disponibles sont :

« Silent machine » : Ce type d’alarme permet de détecter les équipements qui

n’émettent plus de données. L’équipement est alors dit « silencieux », ce qui peut être le

signe d’un dysfonctionnement (par exemple un problème lié à l’équipement, ou à la

connectivité locale). La définition des équipements « silencieux », et notamment de la

période d’inactivité, se fait via les règles de « silent machine »

Dans les prochaines versions de Live Objects, de nouveaux types d’alarme actuellement

disponibles uniquement via API, pourront être gérés via le portail :

Event Processing

State processing

(Voir le paragraphe « Alarming » de la documentation développeur https://liveobjects.orange-

business.com/doc/html/lo_manual_v2.html)

2.7.1. Visualiser les alarmes

Rendez-vous dans le menu « Alarmes », et sélectionnez le type d’alarmes que vous souhaitez

visualiser

Vous pouvez filtrer les alarmes sur la date et sur l’origine (équipement, règle)

111 / 114

2.7.2. Paramétrer une règle de « Silent machine »

Pour créer, modifier ou supprimer une règle de silent machine, cliquez sur la rubrique « Règles

de silent machine » dans le menu « Alarmes ».

A partir de cet écran vous pouvez visualiser vos règles ainsi que leurs principales

caractéristiques. Vous pouvez également suspendre une règle ce qui passera son statut à

« Inactif », la réactiver ou la supprimer définitivement.

La création d’une règle se fait en trois étapes :

Tout d’abord sélectionnez la source à monitorer

Cela peut être, un groupe d’équipements, ou des équipements spécifiques, ou tous les

équipements de votre parc.

112 / 114

Une fois la source définie, nommez là et spécifiez la durée d’inactivité qui déclenchera l’alarme.

Dans l’exemple ci-dessous, si un équipement présent dans la source sélectionnée à l’étape

précédente n’émet plus de message pendant plus de 10 heures, alors une alarme sera

générée. La durée d’inactivité minimale est de 10 minutes.

Enfin vous pouvez associer une action à une alarme. Les actions possibles sont :

Notifier l’alarme par SMS ou email

Pousser l’alarme en http vers un serveur externe

Envoyer l’alarme dans une fifo pour consommation en MQTT par une application

externe

Vous pouvez combiner tout ou partie de ces moyens de notification dans une même règle.

Vous pouvez choisir également aucune notification, dans ce cas l’alarme reste toutefois visible

dans le menu « Alarmes » du portail Live Objects.

Le paramétrage des différentes notifications (sms, email, push http et fifo) est le même que pour

le routage des données (voir descriptif des écrans dans le paragraphe « Routage des

données »)

113 / 114

De plus, vous pouvez décider de recevoir à nouveau une notification périodique si l'appareil

reste silencieux. Dans les exemples ci-dessus, vous avez eu une première alarme au bout de 10

heures d'inactivité, puis vous êtes à nouveau avertis toutes les heures si l'appareil reste

silencieux.

NB : Le délai de « silence » n’est pris en compte qu’à compter de la date de création de la

règle. Exemple : Je crée à l’instant T une règle pour signaler les équipements silencieux depuis

plus de 10 jours. J’aurais les premières alarmes à l’instant T+10 jours, même si au moment de

la création de l’alarme j’ai déjà des équipements silencieux depuis plus de 10 jours.

114 / 114

3. Ressources

Un ensemble de ressources documentaires est à votre disposition et accessible depuis votre

portail Live Objects : https://liveobjects.orange-business.com/#/faq

Vous y trouvez :

Des réponses pratiques aux questions les plus fréquentes (FAQ)

Des tutoriels vidéo vous permettant une prise en main rapide des différentes

fonctionnalités de Live Objects

Le guide de développement complet de Live Objects. Il s’agit de la documentation à

destination des développeurs et intégrateurs. Cette documentation décrit en détail le

fonctionnement des API et les différents concepts de Live Objects

Un kit complet de formation à Live Objects

La documentation des API REST (swagger). Il s’agit d’une documentation interactive

vous permettant de manipuler les API avec votre compte Live Objects

Des collections Postman pour une utilisation avancée des API

Des exemples de code à mettre en œuvre aussi bien par vos équipements (SDK) que

par vos applications (samples)

Une rubrique « A propos » dans laquelle vous pouvez retrouver la version en cours et

son contenu (Release Note)

Il vous est également possible de rejoindre la communauté Live Objects sur le forum

développeur https://stackoverflow.com/tags/orange-api