Voir égalementTeste ou force l'état d'une alarme.
Support WebVue - Oui.
| Mode | Mnémonique | Syntaxe |
| 1 | ACK | 1, 5 |
| 2 | MASK | 1 |
| 3 | UNMASK | 1 |
| 4 | VALUE | 1 |
| 5 | ACKALL | 2 |
| 6 | ACKLAST | 2 |
| 7 | ACKTAG | 3 |
| 9 | ACKOLDEST | 2 |
| 11 | ACKDOMNAT | 4 |
| 12 | ACKPRIO | 6 |
| 13 | SETMAINTENANCE | 1, 5 |
| 14 | RESETMAINTENANCE | 1, 5 |
| 15 | GETMAINTENANCE | 1 |
| 16 | SETALARMLEVEL | 7 |
| 17 | RESTOREALARMLEVEL | 1, 5 |
| 18 | ALARMON | 8 |
| 19 | RESETANDSETALARM | 1 |
| 20 | GETACKLEVEL | 1 |
| 21 | GETMASKLEVEL | 1 |
| 22 | GETMAINTENANCELEVEL | 1 |
Les modes ENABLE et DISABLE du verbe VARIABLE sont le seul moyen de modifier l'état d'inhibition d'une alarme. Comme pour n'importe quel autre type de variable, de telles modifications par script seront consignées si l'alarme est archivée et que la liste de consignation est configurée de manière appropriée.
Syntaxe 1
IntVal = ALARM (Mode, Alarm_name);
Type de retour : INTEGER
|
Argument |
Définition |
|
Alarm_name |
Nom de l'alarme |
Exécution
|
Mode |
Mnémonique |
Action |
|
1 |
ACK |
Acquittement de l'alarme. |
|
2 |
MASK |
Masquage d'alarme. |
|
3 |
UNMASK |
Démasquage d'alarme. |
|
4 |
VALUE |
Teste l'état de l'alarme. |
|
|
|
Retour : 0 Désactivé. |
|
13 |
SETMAINTENANCE |
Force une alarme en mode maintenance. |
|
14 |
RESETMAINTENANCE |
Cet exemple supprime le mode maintenance de l'alarme. |
|
15 |
GETMAINTENANCE |
Retourne le niveau de maintenance de l'alarme. |
|
|
Retour : 0 L'alarme n'existe pas. |
|
|
17 |
RESTOREALARMLEVEL |
Restaure le niveau de priorité d'une alarme. |
| 19 | RESETANDSETALARM | Force une alarme en mode maintenance (ou mode prise en compte). Il n'a aucun effet si l'alarme est éteinte. Retour : 1 si OK, sinon 0. |
| 20 | GETACKLEVEL | Retourne le niveau d'acquittement de l'alarme. |
| 21 | GETMASKLEVEL | Retourne le niveau de masquage de l'alarme. |
| 22 | GETMAINTENANCELEVEL | Restaure le niveau de priorité d'une alarme. |
Le mode Maintenance ne peut être positionné que lorsque l'alarme est Présente et Acquittée. Le mode maintenance ne peut être effacé lorsque l'alarme est Au repos.
Syntaxe 2
IntVal = ALARM(Mode [, Flag]);
Type de retour : INTEGER
|
Argument |
Définition |
|
Flag |
Active la consignation de l'acquittement par un utilisateur. 1 : activé (consigné pour le compte de l'utilisateur), 0 : désactivé |
Exécution
|
Mode |
Mnémonique |
Action |
|
5 |
ACKALL |
Acquitte toutes les alarmes du niveau spécifié. |
|
|
|
Retour : 1 si OK, 0 sinon. |
|
6 |
ACKLAST |
Acquittement de l'alarme. |
|
|
|
Retour : 1 si OK, 0 sinon. |
|
9 |
ACKOLDEST |
Acquitte la première alarme non acquittée c'est-à-dire la plus ancienne. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 3
IntVal = ALARM(Mode, Alarm_ID [, Flag]);
Type de retour : INTEGER.
|
Argument |
Définition |
|
Flag |
Active la consignation de l'acquittement par un utilisateur. Si Flag est à 1 l'acquittement est consigné comme un acquittement opérateur, sinon, l'acquittement n'est pas consigné comme une action utilisateur. |
Exécution
|
Mode |
Mnémonique |
Action |
|
7 |
ACKTAG |
Acquitte une alarme en désignant son rang. Lorsque l'alarme est dans une liste d'alarmes, son rang peut être récupéré par le verbe ALARMDISPLAY (Mode 18). |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 4
IntVal = ALARM(Mode, Domain, Nature[, Flag]);
Type de retour : INTEGER
|
Argument |
Définition |
|
Flag |
Active la consignation de l'acquittement par un utilisateur. |
|
|
1 : activé (consigné pour le compte de l'utilisateur) |
|
|
0 : désactivé |
Exécution
|
Mode |
Mnémonique |
Action |
|
11 |
ACKDOMNAT |
Acquitter toutes les alarmes avec la nature et le domaine spécifiés. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Le temps nécessaire pour acquitter toutes les alarmes dépendra de la taille de la base de données et du nombre d'alarmes.
The execution of the program may be noticeably delayed.
Syntaxe 5
IntVal = ALARM (Mode, Alarm_name[, Flag]);
Type de retour : INTEGER
|
Argument |
Définition |
|
Flag |
Active la consignation de l'acquittement par un utilisateur. |
|
|
1 : activé (consigné pour le compte de l'utilisateur) |
|
|
0 : désactivé |
Exécution
|
Mode |
Mnémonique |
Action |
|
1 |
ACK |
Acquitte les alarmes du domaine et de la nature spécifiés. |
|
13 |
SETMAINTENANCE |
Force une alarme en mode maintenance (ou mode prise en compte). |
|
14 |
RESETMAINTENANCE |
Supprime le mode maintenance d'une alarme. |
|
17 |
RESTOREALARMLEVEL |
Modifie le niveau de priorité d'une alarme. |
Retour : 1 si OK, sinon 0.
Syntaxe 6
IntVal = ALARM(Mode, Priority[, Flag]);
Type de retour : INTEGER.
|
Argument |
Action |
|
Priority |
Priorité d'une alarme. Type : INTEGER. |
|
Flag |
Active la consignation de l'acquittement par un utilisateur. |
|
|
1 : activé (consigné pour le compte de l'utilisateur) |
|
|
0 : désactivé |
Exécution
|
Mode |
Mnémonique |
Action |
|
12 |
ACKPRIO |
Acquitte toutes les alarmes présentes ou absentes non acquittées avec la priorité spécifiée. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Syntaxe 7
IntVal = ALARM(Mode, Variable_name, Level);
Type de retour : INTEGER.
|
Argument |
Action |
|
Variable_name |
Nom de la variable alarme dont le niveau est à modifier. |
|
Level |
Niveau de priorité des alarmes (entre 0 et 29). |
Exécution
|
Mode |
Mnémonique |
Action |
|
16 |
SETALARMLEVEL |
Démasque l'alarme nom_variable. |
|
|
|
Retour : 1 si OK, 0 sinon. |
Le changement est temporaire, c'est-à-dire que le niveau de priorité défini en configuration est restauré au redémarrage du logiciel PcVue.
Par contre la modification est permanente si la propriété Sauvegardé est activée dans les propriétés avancées de la variable.
Syntaxe 8
IntVal = ALARM(Mode, Variable_name, Transition);
Type de retour : INTEGER
|
Argument |
Action |
|
Variable_name |
Nom de la variable alarme dont la propriété sera modifiée. |
|
Transition |
La transition qui active l'alarme. 0 ou 1 |
Exécution
|
Mode |
Mnémonique |
Action |
|
18 |
ALARMON |
Modifiez dynamiquement la transition qui active l'alarme. |
|
|
|
Retour : 1 si OK, 0 sinon. |
La transition est temporaire. Elle n'affecte pas la configuration de la variable, elle n'est active que lors de la phase d'exécution.
Exemple
Cet exemple teste ou force l'état d'une variable. Il utilise le mode ACK (Syntaxe 1) du verbe ALARM.
SUB AckVar (variance)
DIM res As Integer;
res = ALARM(1,VarName); ' acknowledge alarm
Print ("AckVar returned ",res);
END SUB
SUB AckAllAlarms ()
DIM res As Integer;
res = ALARM("ACKALL");
Print ("AckAllALarms returned ",res);
END SUB
Cet exemple positionne Alarm1 en mode maintenance :
ALARM("SETMAINTENANCE", "Alarm1", 1 );
L'alarme 1 est en mode maintenance
ALARM("RESETMAINTENANCE", "Alarm1", 1);
Pour plus d'exemples, sélectionnez le lien Exemple ci-dessus.