Module d'alarme SMS « smsalarms »

Description

Le module « smsalarms » permet d'envoyer par SMS, sous forme mise en forme, les nouvelles alarmes provenant de la centrale d'alarmes.

Interfaces et protocoles utilisés

• mécanismes d'alarme internes de smartCORE

Configuration JSON

La section suivante décrit l'intégralité de la configuration JSON du module et explique chacun des paramètres.

Exemples de configuration (minimale)

{
  "module":"smsalarms",
  "factory":"smsalarms",
  "config":{
    "phoneNumber": "+49800762782673",
    "messageContains": "some.*RegularExpressionMatchingAlarmMessage"
  }
}

{
  "module":"smsalarms",
  "factory":"smsalarms",
  "config":{
    "phoneNumber": "+49800762782673",
    "contextContains": "some.*RegularExpressionMatchingAlarmContext"
  }
}

Exemple de configuration (maximale)

{
  "module":"smsalarms",
  "factory":"smsalarms",
  "config":{
    "pollingIntervalMs": 1000,
    "phoneNumber": "+49800762782673",
    "phoneNumberChannelName": "SomeChannelShowingPhoneNumber",
    "setPhoneNumberChannelName": "SomeChannelForSettingTheNumber",
    "contextContains": "some.*RegularExpressionMatchingAlarmContext",
    "messageContains": "some.*RegularExpressionMatchingAlarmMessage",
    "message": "Some message text",
    "level": "alarm"
  }
}

Paramètres globaux du module

Nom du paramètre	Obligatoire	Type de données	Plage de valeurs utile	Défaut	Description
pollingIntervalMs	Non	INT	1000 -	1000	Intervalle de traitement [ms]
phoneNumber	OUI	STRING			Numéro de téléphone du destinataire du SMS
phoneNumberChannelName	Non	STRING		MODULNAME.phoneNumber	Canal fournissant le numéro de téléphone actuellement défini
setPhoneNumberChannelName	Non	STRING		MODULNAME.setPhoneNumber	Canal permettant de définir le numéro de téléphone actuel
contextContains	OUI (*)	STRING			Expression régulière qui sélectionne un message d'alarme avec le contexte correspondant
messageContains	OUI (*)	STRING			Expression régulière qui sélectionne un message d'alarme avec le message correspondant
message	Non	STRING		Message du message d'alarme	Texte de la notification SMS (voir ci-dessous)
level	Non	STRING			Niveau de gravité de l'alarme ("none", "info", "action", "service", "warning", "alarm", "error", "fatal")

(*) l'un ou l'autre, ou les deux

Configuration de la notification SMS « message »

Le message SMS peut contenir les éléments suivants

• Texte
• Contexte d'alarme, exprimé par la variable ${AlarmContext}
• Message d'alarme, exprimé par la variable ${AlarmMessage}
• valeurs non formatées de canaux quelconques (${someChannel})
• valeurs formatées de canaux quelconques selon la syntaxe de printf, comme p. ex. ${someChannel}{%.2d}
• Indications de lieu (positions GPS), comme p. ex. ${GPS.Location}
• Indications de lieu avec lien vers un service cartographique, comme ${GPS.Location}{google} ou ${GPS.Location}{openstreetmap}

En outre, le contexte d'alarme comme le message d'alarme peuvent être prétraités textuellement par édition de flux (stream editing), les références arrière étant possibles, comme p. ex.

${AlarmMessage}{s/hello/world/}

Informations sur le module

Information	Valeur
Auteurs	optiMEAS GmbH
depuis smartCORE	2.8
Type de module	Consumer/Producer
Dépendances	AUCUNE