Módulo de alarmas por SMS "smsalarms"

Descripción

El módulo "smsalarms" permite enviar por SMS, de forma procesada, nuevas alarmas de la central de alarmas.

Interfaces y protocolos utilizados

• mecanismos internos de alarma de smartCORE

Configuración JSON

En la sección siguiente se describe la configuración JSON completa del módulo y se explican los distintos parámetros.

Configuraciones de ejemplo (mínimas)

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

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

Configuración de ejemplo (máxima)

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

Parámetros globales del módulo

Nombre del parámetro	Obligatorio	Tipo de datos	Rango de valores razonable	Valor por defecto	Descripción
pollingIntervalMs	No	INT	1000 -	1000	Intervalo de procesamiento [ms]
phoneNumber	SÍ	STRING			Número de teléfono del destinatario del SMS
phoneNumberChannelName	No	STRING		MODULNAME.phoneNumber	Canal para proporcionar el número de teléfono establecido actualmente
setPhoneNumberChannelName	No	STRING		MODULNAME.setPhoneNumber	Canal para establecer el número de teléfono actual
contextContains	SÍ (*)	STRING			Expresión regular que selecciona un mensaje de alarma con el contexto correspondiente
messageContains	SÍ (*)	STRING			Expresión regular que selecciona un mensaje de alarma con el mensaje correspondiente
message	No	STRING		Mensaje del mensaje de alarma	Texto de la notificación por SMS (véase más abajo)
level	No	STRING			Gravedad de la alarma ("none", "info", "action", "service", "warning", "alarm", "error", "fatal")

(*) a elegir uno de los dos o ambos

Configuración de la notificación por SMS "message"

El mensaje SMS puede contener los siguientes componentes

• Texto
• Contexto de alarma, expresado mediante la variable ${AlarmContext}
• Mensaje de alarma, expresado mediante la variable ${AlarmMessage}
• valores sin formato de cualquier canal (${someChannel})
• valores con formato de cualquier canal utilizando la sintaxis de printf, como p. ej. ${someChannel}{%.2d}
• Datos de ubicación (posiciones GPS), como p. ej. ${GPS.Location}
• Datos de ubicación con vínculo a un servicio de mapas, como ${GPS.Location}{google} o ${GPS.Location}{openstreetmap}

Además, tanto el contexto de alarma como el mensaje de alarma pueden preprocesarse textualmente mediante edición de flujo (stream editing), siendo posible la referencia hacia atrás, como p. ej.

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

Información del módulo

Información	Valor
Autores	optiMEAS GmbH
desde smartCORE	2.8
Tipo de módulo	Consumer/Producer
Dependencias	NINGUNA