Interface de commande
Un certain nombre de fonctions peuvent être commandées par écriture d'une chaîne de commande dans l'article COMMAND du sujet SYSTEM ou transmission de cette même chaîne dans une requête EXECUTE ou dans la ligne de commande "ALERT".
Les commandes disponibles sont les suivantes :
| Identificateur | Chaîne de commande | Définition |
|---|---|---|
| ALERT_SZCREATEALARM | "CreateAlarm" | Création d'une alarme |
| ALERT_SZSETINSTRUCTIONS | "SetInstructions" | Attachement fichier d'instructions |
| ALERT_SZSETPRIORITY | "SetPriority" | Modification priorité |
| ALERT_SZSETALARM | "SetAlarm" | Activation/désactivation alarme |
| ALERT_SZACKALARM | "AckAlarm" | Acquittement alarme |
| ALERT_SZMASKALARM | "MaskAlarm" | Masquage/démasquage alarme |
| ALERT_SZACKCALL | "AckCall" | Acquittement appel |
| ALERT_SZCALLGROUP | "CallGroup" | Appel groupe |
| ALERT_SZCALLUSER | "CallUser" | Appel opérateur |
| ALERT_SZVALIDUSER | "ValidUser" | Validation/invalidation opérateur |
| ALERT_SZSENDCONSOLE | "SendConsole" | Envoi message console |
| ALERT_SZACKCONSOLE | "AckConsole" | Acquittement message console |
| ALERT_SZRESTORELINKS | "RestoreLinks" | Réinitialise les liaisons DDE et OPC |
| ALERT_SZSHOWWINDOW | "ShowWindow" | Sélectionne l'affichage de la fenêtre ALERT |
| ALERT_SZPLAYTEXT | "PlayText" | Synthétise et joue un message sur le poste local |
A) Commande DDE
Lorsque la commande est acceptée, la commande POKE ou EXECUTE retourne un compte-rendu d'acceptation. Si la commande est refusée, la commande POKE ou EXECUTE retourne un compte-rendu de non acceptation. La cause du rejet peut être lue dans l'article REPORT du sujet SYSTEM.
L'article REPORT peut être lu par requête simple (REQUEST) ou par demande d'avis (ADVISE). Il retourne la valeur du compte-rendu de la dernière commande effectuée (POKE article COMMAND ou commande EXECUTE) :
| Identificateur | Valeur | Définition |
|---|---|---|
| ALERT_ERR_NOERROR | 00 | Commande acceptée |
| ALERT_ERR_INVALIDCOMMAND | 02 | Fonction invalide |
| ALERT_ERR_SYNTAXERROR | 03 | Erreur de syntaxe |
| ALERT_ERR_LOWMEMORY | 04 | Débordement mémoire |
| ALERT_ERR_INVALIDGROUP | 05 | Nom de groupe invalide |
| ALERT_ERR_INVALIDALARM | 06 | Identificateur alarme invalide |
| ALERT_ERR_ACKNOWLEDGED | 07 | Alarme déjà acquittée |
| ALERT_ERR_INVALIDUSER | 08 | Nom d'opérateur invalide |
| ALERT_ERR_NOCONSOLE | 09 | Pas de console définie |
Le compte-rendu d'exécution d'une commande demandant un délai d'exécution (commande d'appel) doit être interprété par l'analyse des événements transmis en retour dans l'article TRACE du sujet SYSTEM.
Les commandes sont transmises sous forme de chaînes de caractères (majuscules ou minuscules) comportant un libellé de commande, suivi d'une liste de paramètres, chaque paramètre étant séparé du précédent par un caractère de tabulation.
B) Commande par ligne de commande
Les commandes sont transmises sous forme de chaînes de caractères (majuscules ou minuscules) comportant le nom de l'application ALERT (avec son chemin complet), un libellé de commande, suivi d'une liste de paramètres, chaque paramètre étant séparé du précédent par un espace ou une tabulation. Si un paramètre comprend des espaces ou des tabulations, il doit être mis entre guillemets (").
1) CreateAlarm
Objet : Création d'une entrée dans la table de scrutation des alarmes (priorité 0)
Paramètres :
1er paramètre: identificateur de l'alarme
2ème paramètre: groupe d'astreinte attaché
3ème paramètre: message d'alarme alphanumérique associé
4ème paramètre: message d'alarme numérique associé (facultatif)
5ème paramètre: nom du fichier SON contenant le message vocal associé (facultatif)
Exemple :
Commande DDE :
CreateAlarm <Tab> Pression <Tab> Technique <Tab> Surpression chaudière <Tab> 00835 <Tab> C:\MMI\ALERT\Message\Pression.wav
Ligne de commande :
ALERT CreateAlarm Pression Technique "Surpression chaudière" 00835 "C:\MMI\ALERT\Message\Pression.wav"
2) SetInstructions
Objet : Attachement d'un fichier d'instructions
Paramètres :
1er paramètre: identificateur de l'alarme
2ème paramètre: nom du fichier texte contenant les instructions
3ème paramètre: "1" = demande effacement du fichier lors de la suppression de l'alarme (paramètre optionnel, par défaut = "0" : fichier jamais supprimé).
Exemple :
Commande DDE :
SetInstructions <Tab> Pression <Tab> c:\inst\pression.txt
Ligne de commande :
ALERT SetInstructions Pression "c:\inst\pression.txt"
(attache le fichier "c:\inst\pression.txt" à l'alarme "Pression")
3) SetPriority
Objet : Modification de la priorité d'une alarme
Paramètres :
1er paramètre: identificateur de l'alarme
2ème paramètre: niveau de priorité (0 à 99)
Exemple :
Commande DDE :
SetPriority <Tab> Pression <Tab> 3
Ligne de commande :
ALERT SetPriority Pression 3
(positionne le niveau de priorité de l'alarme "Pression" à 3)
4) SetAlarm
Objet : Activation/désactivation d'une alarme
Paramètres :
1er paramètre: identificateur de l'alarme
2ème paramètre: "1" pour activation, "0" pour désactivation (facultatif, 1 par défaut)
3ème paramètre: valeur de l'alarme (facultatif)
Exemple :
Commande DDE :
SetAlarm <Tab> Pression <Tab> 1
Ligne de commande :
ALERT SetAlarm Pression 1
(déclenche l'alarme "Pression", et provoque en conséquence un appel vers le groupe "Technique", suivant la configuration effectuée par CreateAlarm)
5) AckAlarm
Objet : Acquittement d'une alarme (suspend les appels en cours pour cette alarme)
Paramètres :
1er paramètre: identificateur de l'alarme
2ème paramètre: nom de l'opérateur acquittant l'alarme (facultatif)
Exemple :
Commande DDE :
AckAlarm <Tab> Pression
Ligne de commande :
ALERT AckAlarm Pression
6) MaskAlarm
Objet : Masquage/Démasquage d'une alarme
Paramètres :
1er paramètre: identificateur de l'alarme
2ème paramètre: "1" pour masquage, "0" pour démasquage (facultatif, 1 par défaut)
3ème paramètre: nom de l'opérateur masquant l'alarme (facultatif)
Exemple :
Commande DDE :
MaskAlarm <Tab> Pression
Ligne de commande :
ALERT MaskAlarm Pression
7) AckCall
Objet : Acquittement d'un appel
Paramètres :
1er paramètre: nom de l'opérateur appelé
2ème paramètre: nom de l'opérateur acquittant (facultatif)
3ème paramètre: "1" pour demande de déconnexion , "0" sinon (facultatif, 0 par défaut)
Exemple :
Commande DDE :
AckCall <Tab> Martin
Ligne de commande :
ALERT AckCall Martin
8) CallGroup
Objet : Création d'une alarme temporaire, déclenchement de l'alarme et appel du groupe associé. L'alarme sera détruite lors de l'acquittement.
Paramètres :
1er paramètre: groupe d'astreinte destinataire
2ème paramètre: identificateur de l'alarme
3ème paramètre: message d'alarme alphanumérique associé
4ème paramètre: message d'alarme numérique associé (facultatif)
5ème paramètre: nom du fichier SON contenant le message vocal associé (facultatif)
Exemple :
Commande DDE :
CallGroup <Tab> Technique <Tab> Pression <Tab> Surpression chaudière <Tab> 00835 <Tab> C:\Message\Pression.wav
Ligne de commande :
ALERT CallGroup Technique Pression "Surpression chaudière" 00835 "C:\Message\Pression.wav"
9) CallUser
Objet : Appel d'un opérateur pour transmission d'un message
Paramètres :
1er paramètre: nom de l'opérateur
2ème paramètre: message alphanumérique à transmettre
3ème paramètre: message numérique à transmettre (facultatif)
4ème paramètre: nom du fichier SON contenant le message vocal associé (facultatif)
5ème paramètre: nom du fichier texte associé (facultatif)
Exemple :
Commande DDE :
CallUser <Tab> Martin <Tab> Appeler le poste de garde
Ligne de commande :
ALERT CallUser Martin "Appeler le poste de garde"
10) ValidUser
Objet : Mise en service / hors-service d'un opérateur
Paramètres :
1er paramètre: nom de l'opérateur
2ème paramètre: "0" = hors-service, "1" = en service (optionnel : "1" par défaut)
Exemple :
Commande DDE :
ValidUser <Tab> Martin <Tab> 0
Ligne de commande :
ALERT ValidUser Martin 0
11) SendConsole
Objet : Envoi d'un message aux opérateurs définis avec l'attribut console (voir appels programmés)
Paramètres :
1er paramètre: message alphanumérique à transmettre
2ème paramètre: identificateur du message (facultatif)
L'identificateur message sert à identifier le message lors d'un acquittement (AckConsole). Si cet identificateur est défini, le message ne sera transmis que pendant la période d'astreinte de la console, le message étant conservé en attente en dehors de cette période. Si l'identificateur n'est pas défini (pas de 2ème paramètre), le message est systématiquement transmis, que la console soit ou non en période d'astreinte.
Exemple :
Commande DDE :
SendConsole <Tab> Défaut batterie — message forcé
SendConsole <Tab> Défaut batterie <Tab> A001 — message transmis si astreinte
Ligne de commande :
ALERT SendConsole "Défaut batterie" — message forcé
ALERT SendConsole "Défaut batterie" A001 — message transmis si astreinte
12) AckConsole
Objet : Acquittement d'un message console en attente
Paramètres :
1er paramètre: identificateur du message à acquitter
Exemple :
Commande DDE :
AckConsole <Tab> A001
Ligne de commande :
ALERT AckConsole A001
13) RestoreLinks
Objet : Réinitialisation des liaisons DDE et OPC
Paramètres :
aucun
Exemple :
Commande DDE :
RestoreLinks
Ligne de commande :
ALERT RestoreLinks
14) ShowWindow
Objet : Sélection affichage de la fenêtre ALERT
Paramètres :
1er paramètre: mode d'affichage
"0" Application invisible
"1" Affichage de la fenêtre ALERT en dimension normales
"2" Affichage de la fenêtre ALERT en icône
"3" Affichage de la fenêtre ALERT plein écran
"4" Fenêtre ALERT toujours visible
Exemple :
Commande DDE :
ShowWindow <Tab> 2
Ligne de commande :
ALERT ShowWindow 2
Mise en icône de la fenêtre ALERT
15) PlayText
Objet : Synthétise et joue un message sur le poste local (nécessite l'option synthèse vocale)
Paramètres :
1er paramètre: message à synthétiser
Exemple :
Commande DDE :
PlayText <Tab> Alerte générale au poste de contrôle
Ligne de commande :
ALERT PlayText "Alerte générale au poste de contrôle"
16) SendDataToScript
Objet : Transmet une chaine de commande au Processeur Message
Paramètres :
1er paramètre: message à traiter
Exemple :
Commande DDE :
SendDataToScript <Tab> AAAA XXX ZZZZ
Ligne de commande :
ALERT SendDataToScript " AAAA XXX ZZZZ "