SMS Alarmmodul "smsalarms"

Beschreibung

Das "smsalarms" Modul ermöglicht es, neue Alarme aus der Alarmzentrale aufbereitet via SMS zu versenden.

Verwendete Schnittstellen und Protokolle

• interne smartCORE Alarmierungsmechanismen

JSON-Konfiguration

Im folgenden Abschnitt soll die gesamte JSON-Konfiguration des Moduls beschrieben und die einzelnen Parameter erläutert werden.

Beispielkonfigurationen (minimal)

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

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

Beispielkonfiguration (maximal)

{
  "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"
  }
}

Globale Modulparameter

Parametername	Erforderlich	Datentyp	sinnvoller Wertebereich	Default	Beschreibung
pollingIntervalMs	Nein	INT	1000 -	1000	Verarbeitungsintervall [ms]
phoneNumber	JA	STRING			Telefonnummer des Empfängers der SMS
phoneNumberChannelName	Nein	STRING		MODULNAME.phoneNumber	Kanal zur Bereitstellung der aktuell gesetzten Telefonnummer
setPhoneNumberChannelName	Nein	STRING		MODULNAME.setPhoneNumber	Kanal zum Setzen der aktuellen Telefonnummer
contextContains	JA (*)	STRING			Regulärer Ausdruck, der eine Alarmnachricht mit entsprechendem Kontext selektiert
messageContains	JA (*)	STRING			Regulärer Ausdruck, der eine Alarmnachricht mit entsprechender Nachricht selektiert
message	Nein	STRING		Nachricht der Alarmnachricht	Text der SMS-Benachrichtigung (siehe unten)
level	Nein	STRING			Schweregrad des Alarms ("none", "info", "action", "service", "warning", "alarm", "error", "fatal")

(*) wahlweise oder beides

Konfiguration der SMS-Benachrichtigung "message"

Die SMS-Nachricht kann folgende Bestandteile enthalten

• Text
• Alarmkontext durch Variable ${AlarmContext} ausgedrückt
• Alarmnachricht durch Variable ${AlarmMessage} ausgedrückt
• unformatierte Werte beliebiger Kanäle (${someChannel})
• formatierte Werte beliebiger Kanäle unter Verwendung der Syntax von printf, wie z.B. ${someChannel}{%.2d}
• Ortsangaben (GPS Positionen), wie z.B. ${GPS.Location}
• Ortsangaben mit Verknüpfung zu Kartendienst, wie ${GPS.Location}{google} oder ${GPS.Location}{openstreetmap}

Außerdem können sowohl Alarmkontext als auch Alarmnachricht mittels Stream-Editierung textuell vorverarbeitet werden, wobei Rückreferenzierung möglich ist, wie z.B.

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

Modul-Informationen

Information	Wert
Autoren	optiMEAS Measurement and Automation Systems GmbH
seit smartCORE	2.8
Modultyp	Consumer/Producer
Abhängigkeiten	KEINE