"
+ },
+ {
+ "equals": "watched-changed",
+ "replacement": "
"
+ },
+ {
+ "equals": "new",
+ "replacement": "
"
+ },
+ {
+ "equals": "missing-in-last-scan",
+ "replacement": "
"
+ }
+ ],
+ "localized": ["name"],
+ "name":[{
+ "language_code": "en_us",
+ "string" : "Status"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Estado"
+ }]
+ },
+ {
+ "column": "Extra",
+ "css_classes": "col-sm-3",
+ "show": false,
+ "type": "label",
+ "default_value":"",
+ "options": [],
+ "localized": ["name"],
+ "name":[{
+ "language_code": "en_us",
+ "string" : "Extra"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Extra"
+ }]
+ }
+ ],
+ "settings":[
+ {
+ "function": "RUN",
+ "events": ["test"],
+ "type": "text.select",
+ "default_value":"disabled",
+ "options": ["disabled", "on_notification" ],
+ "localized": ["name", "description"],
+ "name" :[{
+ "language_code": "en_us",
+ "string" : "When to run"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Cuando ejecuta"
+ }],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string" : "Enable sending notifications via
MQTT to your Home Assistance instance."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Habilitar el envío de notificaciones a través de
MQTT a su Home Assistance."
+ }
+ ]
+ },
+ {
+ "function": "CMD",
+ "type": "readonly",
+ "default_value":"python3 /home/pi/pialert/front/plugins/_publisher_mqtt/mqtt.py",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "Command"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Comando"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Command to run"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Comando a ejecutar"
+ }]
+ },
+ {
+ "function": "RUN_TIMEOUT",
+ "type": "integer",
+ "default_value": 600,
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "Run timeout"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Tiempo de espera de ejecución"
+ },
+ {
+ "language_code": "de_de",
+ "string" : "Wartezeit"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Tiempo máximo en segundos para esperar a que finalice el script. Si se supera este tiempo, el script se cancela."
+ }]
+ },
+ {
+ "function": "BROKER",
+ "type": "text",
+ "default_value": "",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "MQTT broker URL"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "URL del broker MQTT"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "MQTT host URL (do not include
http:// or
https://)."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "URL del host MQTT (no incluya
http:// o
https://)."
+ }]
+ },
+ {
+ "function": "PORT",
+ "type": "integer",
+ "default_value": 1883,
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "MQTT broker port"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Puerto del broker MQTT"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Port number where the broker is listening. Usually
1883."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Puerto donde escucha el broker MQTT. Normalmente
1883."
+ }]
+ },
+ {
+ "function": "USER",
+ "type": "text",
+ "default_value": "",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "MQTT user"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Usuario de MQTT"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "User name used to login into your MQTT broker instance."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Nombre de usuario utilizado para iniciar sesión en su instancia de agente de MQTT."
+ }]
+ },
+ {
+ "function": "PASSWORD",
+ "type": "password",
+ "default_value": "",
+ "options": [],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "MQTT password"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Contraseña de MQTT"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Password used to login into your MQTT broker instance."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Contraseña utilizada para iniciar sesión en su instancia de agente de MQTT."
+ }]
+ },
+ {
+ "function": "QOS",
+ "type": "integer.select",
+ "default_value": 0,
+ "options": [0, 1, 2],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "MQTT Quality of Service"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Calidad de servicio MQTT"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "Quality of service setting for MQTT message sending.
0 - Low quality to
2 - High quality. The higher the quality the longer the delay."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Configuración de calidad de servicio para el envío de mensajes MQTT.
0: baja calidad a
2: alta calidad. Cuanto mayor sea la calidad, mayor será el retraso."
+ }]
+ },
+ {
+ "function": "DELAY_SEC",
+ "type": "integer",
+ "default_value": 2,
+ "options": [2, 3, 4, 5],
+ "localized": ["name", "description"],
+ "name" : [{
+ "language_code": "en_us",
+ "string" : "MQTT delay per device"
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Retraso de MQTT por dispositivo"
+ }],
+ "description": [{
+ "language_code": "en_us",
+ "string" : "A little hack - delay adding to the queue in case the process is restarted and previous publish processes aborted (it takes ~
2s to update a sensor config on the broker). Tested with
2-
3 seconds of delay. This delay is only applied when devices are created (during the first notification loop). It doesn not affect subsequent scans or notifications."
+ },
+ {
+ "language_code": "es_es",
+ "string" : "Un pequeño truco: retrase la adición a la cola en caso de que el proceso se reinicie y los procesos de publicación anteriores se anulen (se necesitan ~
2s para actualizar la configuración de un sensor en el intermediario). Probado con
2-
3 segundos de retraso. Este retraso solo se aplica cuando se crean dispositivos (durante el primer bucle de notificación). No afecta los escaneos o notificaciones posteriores."
+ }]
+ }
+ ]
+}
diff --git a/front/plugins/_publisher_mqtt/ignore_plugin b/front/plugins/_publisher_mqtt/ignore_plugin
deleted file mode 100755
index 77ffa1c1f..000000000
--- a/front/plugins/_publisher_mqtt/ignore_plugin
+++ /dev/null
@@ -1 +0,0 @@
-This plugin will not be loaded
\ No newline at end of file
diff --git a/pialert/publishers/mqtt.py b/front/plugins/_publisher_mqtt/mqtt.py
similarity index 77%
rename from pialert/publishers/mqtt.py
rename to front/plugins/_publisher_mqtt/mqtt.py
index 472e9b1b5..3cf448cc4 100755
--- a/pialert/publishers/mqtt.py
+++ b/front/plugins/_publisher_mqtt/mqtt.py
@@ -1,12 +1,48 @@
-
+#!/usr/bin/env python
+
+import json
+import subprocess
+import argparse
+import os
+import pathlib
+import sys
+from datetime import datetime
import time
import re
from paho.mqtt import client as mqtt_client
+
+# Replace these paths with the actual paths to your Pi.Alert directories
+sys.path.extend(["/home/pi/pialert/front/plugins", "/home/pi/pialert/pialert"])
+
+# PiAlert modules
import conf
-from logger import mylog
-from database import get_all_devices, get_device_stats
-from helper import bytes_to_string, sanitize_string
+from plugin_helper import Plugin_Objects
+from logger import mylog, append_line_to_file
+from helper import timeNowTZ, noti_obj, get_setting_value, bytes_to_string, sanitize_string
+from notification import Notification_obj
+from database import DB, get_all_devices, get_device_stats
+
+
+CUR_PATH = str(pathlib.Path(__file__).parent.resolve())
+RESULT_FILE = os.path.join(CUR_PATH, 'last_result.log')
+
+pluginName = 'MQTT'
+
+def main():
+
+ mylog('verbose', [f'[{pluginName}](publisher) In script'])
+
+ # Check if basic config settings supplied
+ if check_config() == False:
+ mylog('none', [f'[{pluginName}] Error: Publisher notification gateway not set up correctly. Check your pialert.conf {pluginName}_* variables.'])
+ return
+
+ # Create a database connection
+ db = DB() # instance of class DB
+ db.open()
+
+ mqtt_start(db)
@@ -16,7 +52,7 @@
#-------------------------------------------------------------------------------
def check_config():
- if conf.MQTT_BROKER == '' or conf.MQTT_PORT == '' or conf.MQTT_USER == '' or conf.MQTT_PASSWORD == '':
+ if get_setting_value('MQTT_BROKER') == '' or get_setting_value('MQTT_PORT') == '' or get_setting_value('MQTT_USER') == '' or get_setting_value('MQTT_PASSWORD') == '':
mylog('none', ['[Check Config] Error: MQTT service not set up correctly. Check your pialert.conf MQTT_* variables.'])
return False
else:
@@ -41,14 +77,14 @@ def publish_mqtt(client, topic, message):
result = client.publish(
topic=topic,
payload=message,
- qos=conf.MQTT_QOS,
+ qos=get_setting_value('MQTT_QOS'),
retain=True,
)
status = result[0]
if status != 0:
- mylog('minimal', ["Waiting to reconnect to MQTT broker"])
+ mylog('minimal', [f"[{pluginName}] Waiting to reconnect to MQTT broker"])
time.sleep(0.1)
return True
@@ -74,6 +110,8 @@ def create_sensor(client, deviceId, deviceName, sensorType, sensorName, icon):
# check if config already in list and if not, add it, otherwise skip
is_unique = True
+ mylog('minimal', [f"[{pluginName}] Already previously published sensors: {len(conf.mqtt_sensors)}"])
+
for sensor in conf.mqtt_sensors:
if sensor.hash == new_sensor_config.hash:
is_unique = False
@@ -108,7 +146,7 @@ def publish_sensor(client, sensorConf):
# add the sensor to the global list to keep track of succesfully added sensors
if publish_mqtt(client, topic, message):
# hack - delay adding to the queue in case the process is
- time.sleep(conf.MQTT_DELAY_SEC) # restarted and previous publish processes aborted
+ time.sleep(get_setting_value('MQTT_DELAY_SEC')) # restarted and previous publish processes aborted
# (it takes ~2s to update a sensor config on the broker)
conf.mqtt_sensors.append(sensorConf)
@@ -123,18 +161,18 @@ def on_disconnect(client, userdata, rc):
def on_connect(client, userdata, flags, rc):
if rc == 0:
- mylog('verbose', [" Connected to broker"])
+ mylog('verbose', [f"[{pluginName}] Connected to broker"])
conf.mqtt_connected_to_broker = True # Signal connection
else:
- mylog('none', [" Connection failed"])
+ mylog('none', [f"[{pluginName}] Connection failed"])
conf.mqtt_connected_to_broker = False
client = mqtt_client.Client('PiAlert') # Set Connecting Client ID
- client.username_pw_set(conf.MQTT_USER, conf.MQTT_PASSWORD)
+ client.username_pw_set(get_setting_value('MQTT_USER'), get_setting_value('MQTT_PASSWORD'))
client.on_connect = on_connect
client.on_disconnect = on_disconnect
- client.connect(conf.MQTT_BROKER, conf.MQTT_PORT)
+ client.connect(get_setting_value('MQTT_BROKER'), get_setting_value('MQTT_PORT'))
client.loop_start()
return client
@@ -178,9 +216,9 @@ def mqtt_start(db):
# Get all devices
devices = get_all_devices(db)
- sec_delay = len(devices) * int(conf.MQTT_DELAY_SEC)*5
+ sec_delay = len(devices) * int(get_setting_value('MQTT_DELAY_SEC'))*5
- mylog('minimal', [" Estimated delay: ", (sec_delay), 's ', '(', round(sec_delay/60,1) , 'min)' ])
+ mylog('minimal', [f"[{pluginName}] Estimated delay: ", (sec_delay), 's ', '(', round(sec_delay/60,1) , 'min)' ])
for device in devices:
@@ -242,4 +280,14 @@ def to_binary_sensor(input):
elif isinstance(input, bytes):
if bytes_to_string(input) == "1":
result = "ON"
- return result
\ No newline at end of file
+ return result
+
+
+
+
+# -------------INIT---------------------
+if __name__ == '__main__':
+ sys.exit(main())
+
+
+
diff --git a/front/plugins/arp_scan/config.json b/front/plugins/arp_scan/config.json
index 730ae03ce..dd55f51af 100755
--- a/front/plugins/arp_scan/config.json
+++ b/front/plugins/arp_scan/config.json
@@ -1,6 +1,7 @@
{
"code_name": "arp_scan",
"unique_prefix": "ARPSCAN",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"mapped_to_table": "CurrentScan",
diff --git a/front/plugins/csv_backup/config.json b/front/plugins/csv_backup/config.json
index 0817c2fef..9cb9907a7 100755
--- a/front/plugins/csv_backup/config.json
+++ b/front/plugins/csv_backup/config.json
@@ -1,6 +1,7 @@
{
"code_name": "csv_backup",
"unique_prefix": "CSVBCKP",
+ "plugin_type": "system",
"enabled": true,
"data_source": "script",
"show_ui": false,
diff --git a/front/plugins/db_cleanup/config.json b/front/plugins/db_cleanup/config.json
index 7f22084ce..77dd4b4c8 100755
--- a/front/plugins/db_cleanup/config.json
+++ b/front/plugins/db_cleanup/config.json
@@ -1,6 +1,7 @@
{
"code_name": "db_cleanup",
"unique_prefix": "DBCLNP",
+ "plugin_type": "system",
"enabled": true,
"data_source": "script",
"show_ui": false,
diff --git a/front/plugins/ddns_update/config.json b/front/plugins/ddns_update/config.json
index f2ec2de12..8c25ab636 100755
--- a/front/plugins/ddns_update/config.json
+++ b/front/plugins/ddns_update/config.json
@@ -1,6 +1,7 @@
{
"code_name": "ddns_update",
"unique_prefix": "DDNS",
+ "plugin_type": "system",
"enabled": true,
"data_filters": [
{
diff --git a/front/plugins/dhcp_leases/config.json b/front/plugins/dhcp_leases/config.json
index f02cdf5d3..19b6ce9d3 100755
--- a/front/plugins/dhcp_leases/config.json
+++ b/front/plugins/dhcp_leases/config.json
@@ -1,6 +1,7 @@
{
"code_name": "dhcp_leases",
"unique_prefix": "DHCPLSS",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"data_filters": [
diff --git a/front/plugins/dhcp_servers/config.json b/front/plugins/dhcp_servers/config.json
index a1290c15b..1823bd3a8 100755
--- a/front/plugins/dhcp_servers/config.json
+++ b/front/plugins/dhcp_servers/config.json
@@ -1,6 +1,7 @@
{
"code_name": "dhcp_servers",
"unique_prefix": "DHCPSRVS",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"show_ui": true,
diff --git a/front/plugins/internet_ip/config.json b/front/plugins/internet_ip/config.json
index 05f2a2846..5db22c8f3 100755
--- a/front/plugins/internet_ip/config.json
+++ b/front/plugins/internet_ip/config.json
@@ -1,6 +1,7 @@
{
"code_name": "internet_ip",
"unique_prefix": "INTRNT",
+ "plugin_type": "scanner",
"enabled": true,
"mapped_to_table": "CurrentScan",
"data_filters": [
diff --git a/front/plugins/internet_speedtest/config.json b/front/plugins/internet_speedtest/config.json
index 8a626c4a3..61dd1a907 100755
--- a/front/plugins/internet_speedtest/config.json
+++ b/front/plugins/internet_speedtest/config.json
@@ -1,6 +1,7 @@
{
"code_name": "internet_speedtest",
"unique_prefix": "INTRSPD",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"show_ui": true,
diff --git a/front/plugins/known_template/config.json b/front/plugins/known_template/config.json
index 295a907d6..66710fa4b 100755
--- a/front/plugins/known_template/config.json
+++ b/front/plugins/known_template/config.json
@@ -2,6 +2,7 @@
"code_name": "known_template",
"template_type": "database-entry",
"unique_prefix": "KNWN",
+ "plugin_type": "system",
"enabled": true,
"data_source": "template",
"show_ui": false,
diff --git a/front/plugins/newdev_template/config.json b/front/plugins/newdev_template/config.json
index e92a2b3dc..10c1efb3f 100755
--- a/front/plugins/newdev_template/config.json
+++ b/front/plugins/newdev_template/config.json
@@ -2,6 +2,7 @@
"code_name": "Devices.new",
"template_type": "database-entry",
"unique_prefix": "NEWDEV",
+ "plugin_type": "system",
"enabled": true,
"data_source": "template",
"show_ui": false,
diff --git a/front/plugins/nmap_scan/config.json b/front/plugins/nmap_scan/config.json
index d1d840c33..4c5066590 100755
--- a/front/plugins/nmap_scan/config.json
+++ b/front/plugins/nmap_scan/config.json
@@ -1,6 +1,7 @@
{
"code_name": "nmap_scan",
"unique_prefix": "NMAP",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"data_filters": [
diff --git a/front/plugins/pholus_scan/config.json b/front/plugins/pholus_scan/config.json
index c839a86d4..c0f3c3fbe 100755
--- a/front/plugins/pholus_scan/config.json
+++ b/front/plugins/pholus_scan/config.json
@@ -1,6 +1,7 @@
{
"code_name": "pholus_scan",
"unique_prefix": "PHOLUS",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"mapped_to_table": "Pholus_Scan",
diff --git a/front/plugins/pihole_scan/config.json b/front/plugins/pihole_scan/config.json
index eeb84b3eb..9ea4cf7d8 100755
--- a/front/plugins/pihole_scan/config.json
+++ b/front/plugins/pihole_scan/config.json
@@ -1,6 +1,7 @@
{
"code_name": "pihole_scan",
"unique_prefix": "PIHOLE",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "sqlite-db-query",
"mapped_to_table": "CurrentScan",
diff --git a/front/plugins/set_password/config.json b/front/plugins/set_password/config.json
index 0449b0ea1..a1369b36d 100755
--- a/front/plugins/set_password/config.json
+++ b/front/plugins/set_password/config.json
@@ -2,6 +2,7 @@
"code_name": "set_password",
"template_type": "database-entry",
"unique_prefix": "SETPWD",
+ "plugin_type": "system",
"enabled": true,
"data_source": "script",
"show_ui": false,
diff --git a/front/plugins/snmp_discovery/config.json b/front/plugins/snmp_discovery/config.json
index 0e2555ca6..fec025d9f 100755
--- a/front/plugins/snmp_discovery/config.json
+++ b/front/plugins/snmp_discovery/config.json
@@ -1,6 +1,7 @@
{
"code_name": "snmp_discovery",
"unique_prefix": "SNMPDSC",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"data_filters": [
diff --git a/front/plugins/undiscoverables/config.json b/front/plugins/undiscoverables/config.json
index eb13e4350..54be1f33e 100755
--- a/front/plugins/undiscoverables/config.json
+++ b/front/plugins/undiscoverables/config.json
@@ -1,6 +1,7 @@
{
"code_name": "undiscoverables",
"unique_prefix": "UNDIS",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"mapped_to_table": "CurrentScan",
diff --git a/front/plugins/unifi_import/config.json b/front/plugins/unifi_import/config.json
index fac277aa2..7781fe138 100755
--- a/front/plugins/unifi_import/config.json
+++ b/front/plugins/unifi_import/config.json
@@ -1,5 +1,8 @@
{
"code_name": "unifi_import",
+ "show_ui": true,
+ "unique_prefix": "UNFIMP",
+ "plugin_type": "scanner",
"data_filters": [
{
"compare_column": "Object_PrimaryID",
@@ -950,7 +953,5 @@
],
"type": "text.select"
}
- ],
- "show_ui": true,
- "unique_prefix": "UNFIMP"
+ ]
}
diff --git a/front/plugins/vendor_update/config.json b/front/plugins/vendor_update/config.json
index 4ef041dfa..465d29c2b 100755
--- a/front/plugins/vendor_update/config.json
+++ b/front/plugins/vendor_update/config.json
@@ -1,6 +1,7 @@
{
"code_name": "vendor_update",
"unique_prefix": "VNDRPDT",
+ "plugin_type": "system",
"enabled": true,
"data_source": "script",
"show_ui": true,
diff --git a/front/plugins/website_monitor/config.json b/front/plugins/website_monitor/config.json
index 603140860..3efa2fd53 100755
--- a/front/plugins/website_monitor/config.json
+++ b/front/plugins/website_monitor/config.json
@@ -1,6 +1,7 @@
{
"code_name": "website_monitor",
"unique_prefix": "WEBMON",
+ "plugin_type": "scanner",
"enabled": true,
"data_source": "script",
"show_ui": true,
diff --git a/front/settings.php b/front/settings.php
index a6dd7ee80..1a2d5c702 100755
--- a/front/settings.php
+++ b/front/settings.php
@@ -72,8 +72,30 @@
-
-
+
+
+
+ (">)
+
+
+
+
+
+ (">)
+
+
+
+
+ (">)
+
+
+
+
+ (">)
+
+
+
+
@@ -96,6 +118,25 @@