Sommaire
L’interface REST “Constellation” est une API HTTP permettant d’exposer les fonctionnalités de base pour les packages “virtuels”.
Avec cette interface vous pourrez via des requêtes HTTP :
- Publier, consommer ou purger des StateObjects
- Envoyer et recevoir des messages
- Récupérer les settings du package « virtuel »
- Produire des logs
- Déclarer le “Package Descriptor” (MessageCallbacks exposés ou les types utilisés par les MC ou SO)
De ce fait un script Bash ou Powershell, une page PHP, un Arduino, ESP ou NetDuino, bref n’importe quel système, objet ou langage pouvant effectuer des appels HTTP peut être considéré comme un package (dit virtuel) de votre Constellation et produire ou consommer des StateObjects, envoyer ou recevoir des messages, écrire des logs, etc…
Généralités
Construction de l’URL
L’URL est : <Root URI>/rest/constellation/<action>?<paramètres>
Partons du principe que votre Constellation est exposée en HTTP sur le port 8088 (sans path). On retrouvera dans le fichier de configuration la section suivante :
1 2 3 |
<listenUris> <uri listenUri="http://+:8088/" /> </listenUris> |
La “Root URI “ est donc “http://<ip ou dns>:8088/”.
Par exemple si nous sommes en local, nous pourrions écrire :
1 |
http://localhost:8088/rest/constellation/xxxxx |
Authentification
Comme pour toutes les requêtes vers Constellation vous devez impérativement spécifier dans les headers HTTP ou dans les paramètres de l’URL (querystring), les paramètres “SentinelName”, “PackageName” et “AccessKey” pour l’authentification.
Ici votre “package virtuel” doit être déclaré dans la configuration de votre Constellation comme un véritable package, c’est à dire avec une sentinelle (dite virtuelle) et un package qui peut contenir des settings, etc…
Par exemple :
1 2 3 4 5 6 7 8 9 10 11 12 |
<sentinels> <sentinel name="MyVirtualSentinel" credential="Standard"> <packages> <package name="MyVirtualPackage" enable="true"> <settings> <setting key="IntSetting" value="42" /> <setting key="StringSetting" value="sample config value" /> </settings> </package> </packages> </sentinel> </sentinels> |
On a ici déclaré une sentinelle virtuelle “MyVirtualSentinel” qui contient le package virtuelle “MonPackageVirtuel”. Ce package utilise implicitement l’AccessKey du credential “Standard” déclaré au niveau de la sentinelle.
De ce fait, pour chaque appel on passera les paramètres suivants (dans l’URL ou dans les headers) :
- SentinelName = MyVirtualSentinel
- PackageName = MyVirtualPackage
- AccessKey = MyAccessKey (en partant du principe que l’AccessKey déclaré pour le credential “Standard” est “MyAccessKey”)
Pour la suite de cet article nous passerons tous les paramètres dans l’URL, ainsi chaque appel sera sous la forme :
1 |
http://localhost:8088/rest/constellation/<action>?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey&<paramètres> |
Check Access
Toutes les API REST de Constellation exposent une méthode en GET “CheckAccess” qui retourne un code HTTP 200 (OK). Cela permet de tester la connexion et l’authentification au serveur Constellation.
- Action : “CheckAccess” (GET)
- Paramètres : aucun
Exemple :
1 |
http://localhost:8088/rest/constellation/CheckAccess?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey |
Publier des StateObjects
- Action : “PushStateObject” (GET ou POST)
- En GET, voici les paramètres de l’URL :
- name : le nom du StateObject
- value : la valeur du StateObject
- type (optionnel) : le type du StateObject
- lifetime (optionnel – par défaut 0) : la durée de vie (en seconde) du StateObject avant d’être marqué “expiré”. (0 = durée de vie infinie)
Pour publier un StateObject vous devez obligatoirement spécifier son nom (name) et sa valeur (value). La valeur peut être un type simple (un Int, String, bool, etc..) ou un objet complexe formaté en JSON. Optionnellement vous pouvez spécifier le type et la durée de vie de votre SO (en seconde).
Par exemple publions un StateObject nommé “Temperature” dont la valeur est le nombre “21” :
1 |
http://localhost:8088/rest/constellation/PushStateObject?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey&name=Temperature&value=21 |
Autre exemple avec un objet complexe contenant deux propriété (Temperature et Humidity) dont la durée de vie est de 60 secondes et le type nommé “TemperatureHumidity” :
1 |
http://localhost:8088/rest/constellation/PushStateObject?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey&name=Temperature&value={ Temperature: 21, Humidity: 72 }&type=TemperatureHumidity&lifetime=60 |
Si la valeur du StateObject est trop grande pour être passée dans l’URL ou si vous souhaitez ajouter des métadonnées (metadatas) à votre StateObject vous pouvez “poster” le StateObject dans le corps de la requête HTTP en utilisant le verbe “POST” (sans oublier de définir le Content-Type à “application/json”).
Pour publier par un POST le même StateObject en lui ajoutant deux métadonnées :
1 2 3 4 5 6 7 8 9 10 11 12 |
POST http://localhost:8088/rest/constellation/PushStateObject?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey Host: localhost:8088 Content-Length: 189 Content-Type: application/json { "Name" : "Temperature", "Value" : { Temperature: 21, Humidity: 72 }, "Type" : "TemperatureHumidity", "Lifetime" : 60, "Metadatas": { "ChipId":"ABC123", "Room":"Garden" } } |
Purger ses StateObjects
Un package peut supprimer ses StateObjects qu’il produit avec la méthode “PurgeStateObjects”.
- Action : “PurgeStateObjects” (GET)
- Paramètres:
- name (optionnel – par défaut “*”) : le nom du StateObject
- type (optionnel – par défaut “*”) : le type du StateObject
Vous pouvez spécifier le nom du StateObject à supprimer et/ou son type. Par défaut ces deux paramètres sont définis à “*”. C’est à dire que si vous ne précisez rien, tous les StateObjects du package seront purgés.
Par exemple pour purger tous les StateObjects de notre package virtuel (instance MyVirtualSentinel/MyVirtualPackage):
1 |
http://localhost:8088/rest/constellation/PurgeStateObjects?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey |
Pour purger tous les StateObjects de type “Temperature” de cette même instance :
1 |
http://localhost:8088/rest/constellation/PurgeStateObjects?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey&type=Temperature |
Ou pour supprimer le StateObject nommé “Demo” :
1 |
http://localhost:8088/rest/constellation/PurgeStateObjects?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey&name=Demo |
Ecrire des logs
Les packages peuvent écrire des logs qui seront remontés dans le hub Constellation.
- Action : “WriteLog” (GET)
- Paramètres:
- message : texte du log
- level (optionnel – par défaut “Info”) : le niveau du log (Info, Warn ou Error)
Exemple d’un message “Info” :
1 |
http://localhost:8088/rest/constellation/WriteLog?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey&message=Hello World |
Exemple pour produire un message d’erreur (Error) :
1 |
http://localhost:8088/rest/constellation/WriteLog?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey&message=Il y a une erreur ici&level=Error |
Récupérer ses settings
Les settings sont récupérés en invoquant la méthode “GetSettings”.
- Action : “GetSettings” (GET)
- Paramètres: aucun
Par exemple pour récupérer les settings (dictionnaire de clé / valeur) définis pour notre package virtuel :
1 |
http://localhost:8088/rest/constellation/GetSettings?SentinelName=MyVirtualSentinel&PackageName=MyVirtualPackage&AccessKey=MyAccessKey |
Envoyer des messages
- Action : “SendMessage” (GET ou POST)
- En GET, voici les paramètres de l’URL :
- scope : le type de scope (All, Other, Group, Sentinel ou Package)
- args : les arguments du scope (par exemple le nom du groupe, de la sentinelle, du package ou de l’instance du package – plusieurs valeurs possibles séparées par des virgules)
- key : la clé du message (= la méthode à invoquer)
- data : le contenu du message (= les arguments de la méthode)
- sagaId (optionnel) : l’identification de la saga si le message est envoyé dans une saga
Vous pouvez également invoquer cette action en POST. Le corps de votre requête contiendra l’objet JSON suivant :
1 2 3 4 5 |
{ "Scope" : { "Type" : "<type>", Args: [ "<arg1>", "<args2>", .... ], "SagaId":"Identifiant de la Saga" }, "Key" : "<Key>", "Data" : "<Data>" } |
La propriété “SagaId” dans le JSON ci-dessus est optionnelle.
Par exemple pour envoyer un message au package Nest en invoquant la méthode (key) “SetTargetTemperature” avec en paramètre le nombre “21” :
1 |
http://localhost:8088/rest/constellation/SendMessage?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&scope=Package&args=Nest&key=SetTargetTemperature&data=21 |
Ce même MessageCallback “SetTargetTemperature” du package Nest peut être invoqué dans une saga afin de recevoir un accusé de réception :
1 |
http://localhost:8088/rest/constellation/SendMessage?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&scope=Package&args=Nest&key=SetTargetTemperature&data=21&sagaId=123456789 |
Il faudra ensuite “récupérer” les messages reçus (voir dessous) pour lire la réponse à votre saga que nous avons ici identifié par la clé “123456789”.
Recevoir des messages
Créer un abonnement de réception
Tout d’abord pour recevoir des messages il faut s’abonner aux messages.
- Action : “SubscribeToMessage” (GET)
- Paramètres :
- subscriptionId (optionnel) : identifiant de l’abonnement si déjà connu
1 |
http://localhost:8088/rest/constellation/SubscribeToMessage?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123 |
Vous obtiendrez en réponse l’ID de votre abonnement, le “Subscription Id”.
Relever les messages
- Action : “GetMessages” (GET)
- Paramètres :
- subscriptionId : identifiant de l’abonnement
- timeout (optionnel – par défaut 60000) : temps maximal en milliseconde de la mise en attente de la requête (entre 1000ms et 120000ms)
- limit (optionnel – par défaut 0) : nombre maximum de message à retourner pour l’appel
Il s’agit d’une requête en “long-polling” c’est à dire que la requête sera “bloquée” sur le serveur tant qu’il n’y a pas de message reçu évitant ainsi de “flooder” en continue le serveur pour savoir si de nouveaux messages sont disponibles ou non. Par défaut la requête est bloquée 60 secondes maximum mais vous pouvez personnaliser cette valeur avec le paramètre “timeout”. Si il y a des messages disponibles, le serveur vous renvoi un tableau JSON avec les messages reçus. Si il n’y a pas de réponse dans le délai spécifié par le paramètre “timeout” (60 secondes par défaut), le tableau retourné sera vide.
A chaque réponse vous devez donc relancer une requête “GetMessages” pour “écouter” les prochains messages qui vont sont destinés.
Il est également possible de limiter le nombre de message dans la réponse avec le paramètre “limit” ce qui peut être utile sur de petits “devices” ne disposant pas de beaucoup de mémoire RAM pour désérialiser de gros tableaux JSON.
Exemple simple :
1 |
http://localhost:8088/rest/constellation/GetMessages?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&subscriptionId=xxxxx |
Autre exemple en limitant le nombre de message à 2 par appel et en bloquant la requête pendant 10 secondes au maximum :
1 |
http://localhost:8088/rest/constellation/GetMessages?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&subscriptionId=xxxxx&timeout=10000&limit=2 |
S’abonner à un groupe
Vous pouvez vous abonner à des groupes pour recevoir les messages envoyés dans ces groupes par l’action “SubscribeToMessageGroup” en précisant le nom du groupe et votre ID d’abonnement.
- Action : “SubscribeToMessageGroup” (GET)
- Paramètres :
- group : le nom du groupe à joindre
- subscriptionId (optionnel) : identifiant de l’abonnement si déjà connu
1 |
http://localhost:8088/rest/constellation/SubscribeToMessageGroup?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&subscriptionId=xxxxx&group=A |
Comme l’action “SubscribeToMessage”, cette action vous retourne l’ID d’abonnement à utiliser pour l’action “GetMessages”.
Consommation de StateObjects
Request
Cette méthode permet de récupérer la valeur actuelle d’un ou de plusieurs StateObjects.
- Action : “RequestStateObjects” (GET)
- Paramètres :
- sentinel (optionnel – par défaut “*”): nom de la sentinelle
- package (optionnel – par défaut “*”) : nom du package
- name (optionnel – par défaut “*”) : nom du StateObject
- type (optionnel – par défaut “*”) : type du StateObject
Par exemple pour récupérer tous les StateObject de votre Constellation :
1 |
http://localhost:8088/rest/constellation/RequestStateObjects?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123 |
Ou seulement ceux produits par le package “HWMonitor” (quelque soit la sentinelle) :
1 |
http://localhost:8088/rest/constellation/RequestStateObjects?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&package=HWMonitor |
Ou encore tous les StateObjects nommés “/intelcpu/load/0” et produits le package “HWMonitor” (quelque soit la sentinelle) :
1 |
http://localhost:8088/rest/constellation/RequestStateObjects?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&package=HWMonitor&name=/intelcpu/load/0 |
Subscribe
Vous pouvez également vous abonner aux mises à jour des StateObjects.
Le principe est le même qu’avec les messages : il faut récupérer un ID d’abonnement et invoquer une méthode en long-polling pour recevoir les mises à jour.
S’abonner à des StateObjects
- Action : “SubscribeToStateObjects” (GET)
- Paramètres :
- subscriptionId (optionnel) : identifiant de l’abonnement si déjà connu
- sentinel (optionnel – par défaut “*”): nom de la sentinelle
- package (optionnel – par défaut “*”) : nom du package
- name (optionnel – par défaut “*”) : nom du StateObject
- type (optionnel – par défaut “*”) : type du StateObject
En retour vous obtiendrez l’ID d’abonnement (un GUID).
Par exemple pour s’abonner au SO “/intelcpu/load/0”, produit le package “HWMonitor” sur la sentinelle “MON-PC” :
1 |
http://localhost:8088/rest/constellation/SubscribeToStateObjects?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&sentinel=MON-PC&package=HWMonitor&name=/intelcpu/load/0 |
ATTENTION : si vous souhaitez “ajouter” des SO à votre abonnement vous devez impérativement préciser votre ID d’abonnement récupéré lors du 1er appel autrement vous allez créer un nouvel abonnement.
Par exemple pour “ajouter” le SO correspondant à la consommation RAM :
1 |
http://localhost:8088/rest/constellation/SubscribeToStateObjects?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&sentinel=MON-PC&package=HWMonitor&name=/ram/load&subscriptionId=<subId> |
Relever les StateObjects mis à jour
Pour récupérer les SO de votre abonnement qui ont changés entre deux appels vous devez invoquer l’action “GetStateObjects” en spécifiant l’ID de votre abonnement :
- Action : “GetStateObjects” (GET)
- Paramètres :
- subscriptionId : identifiant de l’abonnement
- timeout (optionnel – par défaut 60000) : temps maximal en milliseconde de la mise en attente de la requête (entre 1000ms et 120000ms)
- limit (optionnel – par défaut 0) : nombre maximum de message à retourner pour l’appel
Comme pour les messages, vous pouvez limiter le nombre de SO (limit) et le timeout de la requête (timeout).
1 |
http://localhost:8088/rest/constellation/GetStateObjects?SentinelName=Consumer&PackageName=Demo&AccessKey=MaCleDeTest123&subscriptionId=<subId> |
Notez que si un StateObject pour lequel vous êtes abonné change plusieurs fois entre deux appels “GetStateObjects”, vous obtiendrez la dernière valeur et non l’historique de tous les changements.
Déclarer le “Package Descriptor”
Action : “DeclarePackageDescriptor” (POST)
Le “Package Descriptor” permet décrire les MessagesCallbacks d’un package ainsi que les types utilisés par ses MC ou StateObjects.
Ainsi en publiant le PackageDescriptor, la Constellation aura connaissance des MessageCallbacks qu’expose un package ainsi que le type des StateObject qu’il publie. C’est grâce au Package Descriiptor que fonctionne le “MessageCallback Explorer” de la Console Constellation.
Le Package Descriptor est un objet JSON contenant :
- Le nom du package
- La liste des MessageCallbacks du package
- La liste des types utilisés par les MessageCallbacks du package
- La liste des types utilisés par les StateObjects publiés par le package
La structure de base est donc :
1 2 3 4 5 6 |
{ "PackageName": "MyVirtualPackage", "MessageCallbacks": [], "MessageCallbackTypes": [], "StateObjectTypes": [], } |
Chaque “MessageCallback” est un objet contenant :
- MessageKey : la clé du message (le nom/clé du MessageCallback)
- Description (optionnel) : description du MessageCallback
- ResponseType (optionnel) : le type du message de retour dans le cas où le MC répond au Saga
- Parameters (optionnel) : la liste des paramètres du MC
Un paramètre est décrit par un objet contenant :
- Name : le nom du paramètre
- TypeName : le type du paramètre
- Description (optionnel) : la description du paramètre
- Type : le type de paramètre (doit être obligatoirement défini à 2 pour un paramètre d’un MC)
- IsOptional (optionnel) : booléen (true ou false) qui indique si le paramètre est optionnel ou non
- DefaultValue (optionnel) : la valeur par défaut du paramètre si optionnel
Le type d’un paramètre peut être un type simple décrit par les types .NET (System.Int16, System.Int32, System.Int64, System.Double, System.Decimal, System.Float, System.Boolean, System.String) ou un type personnalisé.
Les types personnalisés utilisés dans les paramètres des MC seront décrits dans la propriété “MessageCallbackTypes” du Package Descriptor et les types personnalisés utilisés pour les StateObjects seront décrits dans la propriété “StateObjectTypes” du Package Descriptor.
Dans les deux cas il s’agit de la même structure de donnée.
La description d’un type est un objet contenant :
- TypeName : le nom du type (l’identifiant)
- TypeFullname : le nom complet du type (utilisé pour identifier le nom complet d’un type .NET par exemple)
- Description (optionnel) : la description du type
- IsGeneric (optionnel) : booléen (true ou false) qui indique si le type est un type générique
- IsArray (optionnel) : booléen (true ou false) qui indique si le type est un tableau
- GenericParameters (optionnel) : la liste des types génériques si il s’agit d’un type générique ou d’un tableau
- IsEnum (optionnel) : booléen (true ou false) qui indique si le type est une énumération
- EnumValues (optionnel) : la liste des valeurs de l’énumérations si le type est une énumération
- Properties (optionnel) : la liste des propriétés du type
Les propriétés d’un type tout comme les valeurs d’une énumération sont décrits de la même manière qu’un paramètre d’un MessageCallback déjà détaillé ci-dessus.
Seule la propriété “Type” change :
- Type = 0 : pour décrire une propriété
- Type = 1 : pour décrire une valeur d’une énumération
- Type = 2 : pour décrire une paramètre d’un MessageCallback comme expliqué précédemment
Exemple 1 – Package “NetworkTools”
Voici le Package Descriptor du package “NetworkTools” :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
{ "PackageName":"NetworkTools", "MessageCallbacks":[ { "MessageKey":"Ping", "Description":"Pings the specified host and return the response time.", "ResponseType":"System.Int64", "Parameters":[ { "Name":"host", "TypeName":"System.String", "Description":"The host.", "Type":2, "IsOptional":false, "DefaultValue":null }, { "Name":"timeout", "TypeName":"System.Int32", "Description":"The timeout (5000ms by defaut).", "Type":2, "IsOptional":false, "DefaultValue":null } ] }, { "MessageKey":"CheckPort", "Description":"Check a port's status by entering an address and port number above and return the response time.", "ResponseType":"System.Int64", "Parameters":[ { "Name":"host", "TypeName":"System.String", "Description":"The host.", "Type":2, "IsOptional":false, "DefaultValue":null }, { "Name":"port", "TypeName":"System.Int32", "Description":"The port.", "Type":2, "IsOptional":false, "DefaultValue":null }, { "Name":"timeout", "TypeName":"System.Int32", "Description":"The timeout (5000ms by defaut).", "Type":2, "IsOptional":false, "DefaultValue":null } ] }, { "MessageKey":"CheckHttp", "Description":"Checks the HTTP address and return the response time.", "ResponseType":"System.Int64", "Parameters":[ { "Name":"address", "TypeName":"System.String", "Description":"The address.", "Type":2, "IsOptional":false, "DefaultValue":null } ] }, { "MessageKey":"ScanPort", "Description":"Scans TCP port range to discover which TCP ports are open on your target host.", "ResponseType":"System.Collections.Generic.Dictionary`2[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]", "Parameters":[ { "Name":"host", "TypeName":"System.String", "Description":"The host.", "Type":2, "IsOptional":false, "DefaultValue":null }, { "Name":"startPort", "TypeName":"System.Int32", "Description":"The start port.", "Type":2, "IsOptional":false, "DefaultValue":null }, { "Name":"endPort", "TypeName":"System.Int32", "Description":"The end port.", "Type":2, "IsOptional":false, "DefaultValue":null }, { "Name":"timeout", "TypeName":"System.Int32", "Description":"The timeout (5000ms by defaut).", "Type":2, "IsOptional":false, "DefaultValue":null } ] }, { "MessageKey":"WakeUp", "Description":"Wakes up the specified host.", "ResponseType":"System.Boolean", "Parameters":[ { "Name":"host", "TypeName":"System.String", "Description":"The host.", "Type":2, "IsOptional":false, "DefaultValue":null }, { "Name":"macAddress", "TypeName":"System.String", "Description":"The mac address.", "Type":2, "IsOptional":false, "DefaultValue":null } ] }, { "MessageKey":"DnsLookup", "Description":"Resolves a host name or IP address.", "ResponseType":"System.String[]", "Parameters":[ { "Name":"host", "TypeName":"System.String", "Description":"The host.", "Type":2, "IsOptional":false, "DefaultValue":null } ] } ], "MessageCallbackTypes":[ { "Description":null, "IsGeneric":true, "IsArray":false, "GenericParameters":[ "System.Int32", "System.Boolean" ], "IsEnum":false, "EnumValues":null, "TypeName":"Dictionary`2", "TypeFullname":"System.Collections.Generic.Dictionary`2[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]", "Properties":null }, { "Description":null, "IsGeneric":false, "IsArray":true, "GenericParameters":[ "System.String" ], "IsEnum":false, "EnumValues":null, "TypeName":"String[]", "TypeFullname":"System.String[]", "Properties":null } ], "StateObjectTypes":[ { "Description":"Monitoring type", "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":false, "EnumValues":null, "TypeName":"MonitoringResult", "TypeFullname":"NetworkTools.MonitoringResult", "Properties":[ { "Name":"ResponseTime", "TypeName":"System.Int64", "Description":"Gets or sets the response time in millisecond.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"State", "TypeName":"System.Boolean", "Description":"Gets or sets the state.", "Type":1, "IsOptional":false, "DefaultValue":null } ] } ] } |
Exemple 2 – Package “Paradox”
Autre exemple plus complet, le Package Descriptor du package “Paradox” :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 |
{ "PackageName":"Paradox", "MessageCallbacks":[ { "MessageKey":"AreaArm", "Description":"Arm the area.", "ResponseType":"System.Boolean", "Parameters":[ { "Name":"request", "TypeName":"ParadoxOnConstellation.ArmingRequestData", "Description":"The request.", "Type":2, "IsOptional":false, "DefaultValue":null } ] }, { "MessageKey":"AreaDisarm", "Description":"Disarm the area.", "ResponseType":"System.Boolean", "Parameters":[ { "Name":"request", "TypeName":"ParadoxOnConstellation.ArmingRequestData", "Description":"The request.", "Type":2, "IsOptional":false, "DefaultValue":null } ] }, { "MessageKey":"RefreshArea", "Description":"Refreshes the area.", "ResponseType":null, "Parameters":[ { "Name":"area", "TypeName":"Paradox.Core.Area", "Description":"The area.", "Type":2, "IsOptional":false, "DefaultValue":null } ] }, { "MessageKey":"RefreshAll", "Description":"Refreshes all.", "ResponseType":null, "Parameters":[ ] } ], "MessageCallbackTypes":[ { "Description":"Arming or disarming request", "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":false, "EnumValues":null, "TypeName":"ArmingRequestData", "TypeFullname":"ParadoxOnConstellation.ArmingRequestData", "Properties":[ { "Name":"Area", "TypeName":"Paradox.Core.Area", "Description":"The number of area.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Mode", "TypeName":"Paradox.Core.ArmingMode", "Description":"The mode number.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"PinCode", "TypeName":"System.String", "Description":"The pin code.", "Type":1, "IsOptional":false, "DefaultValue":null } ] }, { "Description":null, "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":true, "EnumValues":[ { "Name":"All", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Area1", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Area2", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Area3", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Area4", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Area5", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Area6", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Area7", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Area8", "TypeName":"Paradox.Core.Area", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null } ], "TypeName":"Area", "TypeFullname":"Paradox.Core.Area", "Properties":null }, { "Description":null, "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":true, "EnumValues":[ { "Name":"RegularArm", "TypeName":"Paradox.Core.ArmingMode", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"ForceArm", "TypeName":"Paradox.Core.ArmingMode", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"StayArm", "TypeName":"Paradox.Core.ArmingMode", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"InstantArm", "TypeName":"Paradox.Core.ArmingMode", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null } ], "TypeName":"ArmingMode", "TypeFullname":"Paradox.Core.ArmingMode", "Properties":null } ], "StateObjectTypes":[ { "Description":null, "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":false, "EnumValues":null, "TypeName":"UserInfo", "TypeFullname":"ParadoxOnConstellation.UserInfo", "Properties":[ { "Name":"Id", "TypeName":"System.Int32", "Description":"The identifier.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Type", "TypeName":"System.String", "Description":"The object type.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Name", "TypeName":"System.String", "Description":"The name.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"LastActivity", "TypeName":"System.DateTime", "Description":"The last activity.", "Type":1, "IsOptional":false, "DefaultValue":null } ] }, { "Description":null, "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":false, "EnumValues":null, "TypeName":"DateTime", "TypeFullname":"System.DateTime", "Properties":[ { "Name":"Date", "TypeName":"System.DateTime", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Day", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"DayOfWeek", "TypeName":"System.DayOfWeek", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"DayOfYear", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Hour", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Kind", "TypeName":"System.DateTimeKind", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Millisecond", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Minute", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Month", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Now", "TypeName":"System.DateTime", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"UtcNow", "TypeName":"System.DateTime", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Second", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Ticks", "TypeName":"System.Int64", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"TimeOfDay", "TypeName":"System.TimeSpan", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Today", "TypeName":"System.DateTime", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Year", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null } ] }, { "Description":null, "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":true, "EnumValues":[ { "Name":"Sunday", "TypeName":"System.DayOfWeek", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Monday", "TypeName":"System.DayOfWeek", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Tuesday", "TypeName":"System.DayOfWeek", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Wednesday", "TypeName":"System.DayOfWeek", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Thursday", "TypeName":"System.DayOfWeek", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Friday", "TypeName":"System.DayOfWeek", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Saturday", "TypeName":"System.DayOfWeek", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null } ], "TypeName":"DayOfWeek", "TypeFullname":"System.DayOfWeek", "Properties":null }, { "Description":null, "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":true, "EnumValues":[ { "Name":"Unspecified", "TypeName":"System.DateTimeKind", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Utc", "TypeName":"System.DateTimeKind", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null }, { "Name":"Local", "TypeName":"System.DateTimeKind", "Description":null, "Type":0, "IsOptional":false, "DefaultValue":null } ], "TypeName":"DateTimeKind", "TypeFullname":"System.DateTimeKind", "Properties":null }, { "Description":null, "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":false, "EnumValues":null, "TypeName":"TimeSpan", "TypeFullname":"System.TimeSpan", "Properties":[ { "Name":"Ticks", "TypeName":"System.Int64", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Days", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Hours", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Milliseconds", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Minutes", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Seconds", "TypeName":"System.Int32", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"TotalDays", "TypeName":"System.Double", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"TotalHours", "TypeName":"System.Double", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"TotalMilliseconds", "TypeName":"System.Double", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"TotalMinutes", "TypeName":"System.Double", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"TotalSeconds", "TypeName":"System.Double", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null } ] }, { "Description":"Represent Zone information", "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":false, "EnumValues":null, "TypeName":"ZoneInfo", "TypeFullname":"ParadoxOnConstellation.ZoneInfo", "Properties":[ { "Name":"IsOpen", "TypeName":"System.Boolean", "Description":"A value indicating whether this zone is open.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"IsTamper", "TypeName":"System.Boolean", "Description":"A value indicating whether this zone is tamper.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"InAlarm", "TypeName":"System.Boolean", "Description":"A value indicating whether this zone is in alarm.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"InFireAlarm", "TypeName":"System.Boolean", "Description":"A value indicating whether this zone is in fire alarm].", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"SupervisionLost", "TypeName":"System.Boolean", "Description":"A value indicating whether this zone has supervision lost.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"LowBattery", "TypeName":"System.Boolean", "Description":"A value indicating whether this zone has low battery.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Id", "TypeName":"System.Int32", "Description":"The identifier.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Type", "TypeName":"System.String", "Description":"The object type.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Name", "TypeName":"System.String", "Description":"The name.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"LastActivity", "TypeName":"System.DateTime", "Description":"The last activity.", "Type":1, "IsOptional":false, "DefaultValue":null } ] }, { "Description":null, "IsGeneric":false, "IsArray":false, "GenericParameters":null, "IsEnum":false, "EnumValues":null, "TypeName":"AreaInfo", "TypeFullname":"ParadoxOnConstellation.AreaInfo", "Properties":[ { "Name":"IsFullArmed", "TypeName":"System.Boolean", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"IsStayArmed", "TypeName":"System.Boolean", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"ZoneInMemory", "TypeName":"System.Boolean", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"HasTrouble", "TypeName":"System.Boolean", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"IsReady", "TypeName":"System.Boolean", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"IsInProgramming", "TypeName":"System.Boolean", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"InAlarm", "TypeName":"System.Boolean", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Strobe", "TypeName":"System.Boolean", "Description":null, "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Id", "TypeName":"System.Int32", "Description":"The identifier.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Type", "TypeName":"System.String", "Description":"The object type.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"Name", "TypeName":"System.String", "Description":"The name.", "Type":1, "IsOptional":false, "DefaultValue":null }, { "Name":"LastActivity", "TypeName":"System.DateTime", "Description":"The last activity.", "Type":1, "IsOptional":false, "DefaultValue":null } ] } ] } |
Dans la partie CheckAccess, bien rajouter l’édition de la sentinel après édition de la configuration, dans la partie Sentinels, Editer, et bien choisir les droits.