mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 09:36:05 -08:00
459 lines
17 KiB
Python
Executable File
459 lines
17 KiB
Python
Executable File
#!/usr/bin/env python
|
|
|
|
import json
|
|
import subprocess
|
|
import argparse
|
|
import os
|
|
import pathlib
|
|
import sys
|
|
from datetime import datetime
|
|
import time
|
|
import re
|
|
import paho.mqtt.client as mqtt
|
|
# from paho.mqtt import client as mqtt_client
|
|
# from paho.mqtt import CallbackAPIVersion as mqtt_CallbackAPIVersion
|
|
import hashlib
|
|
|
|
|
|
# Register NetAlertX directories
|
|
INSTALL_PATH="/app"
|
|
sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
|
|
|
|
# NetAlertX modules
|
|
import conf
|
|
from const import apiPath, confFileName
|
|
from plugin_utils import getPluginObject
|
|
from plugin_helper import Plugin_Objects
|
|
from logger import mylog, append_line_to_file
|
|
from helper import timeNowTZ, 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')
|
|
|
|
|
|
# Initialize the Plugin obj output file
|
|
plugin_objects = Plugin_Objects(RESULT_FILE)
|
|
# Create an MD5 hash object
|
|
md5_hash = hashlib.md5()
|
|
|
|
pluginName = 'MQTT'
|
|
|
|
# globals
|
|
|
|
mqtt_sensors = []
|
|
mqtt_connected_to_broker = False
|
|
mqtt_client = None # mqtt client
|
|
|
|
def main():
|
|
|
|
mylog('verbose', [f'[{pluginName}](publisher) In script'])
|
|
|
|
# Check if basic config settings supplied
|
|
if check_config() == False:
|
|
mylog('verbose', [f'[{pluginName}] ⚠ ERROR: Publisher notification gateway not set up correctly. Check your {confFileName} {pluginName}_* variables.'])
|
|
return
|
|
|
|
# Create a database connection
|
|
db = DB() # instance of class DB
|
|
db.open()
|
|
|
|
mqtt_start(db)
|
|
|
|
plugin_objects.write_result_file()
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------------------
|
|
# MQTT
|
|
#-------------------------------------------------------------------------------
|
|
#-------------------------------------------------------------------------------
|
|
def check_config():
|
|
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('verbose', [f'[Check Config] ⚠ ERROR: MQTT service not set up correctly. Check your {confFileName} MQTT_* variables.'])
|
|
return False
|
|
else:
|
|
return True
|
|
|
|
|
|
#-------------------------------------------------------------------------------
|
|
# Sensor configs are tracking which sensors in NetAlertX exist and if a config has changed
|
|
class sensor_config:
|
|
def __init__(self, deviceId, deviceName, sensorType, sensorName, icon, mac):
|
|
self.deviceId = deviceId
|
|
self.deviceName = deviceName
|
|
self.sensorType = sensorType
|
|
self.sensorName = sensorName
|
|
self.icon = icon
|
|
|
|
# Define your input string
|
|
input_string = str(deviceId) + str(deviceName) + str(sensorType) + str(sensorName) + str(icon)
|
|
|
|
# Hash the input string and convert the hash to a string
|
|
# Update the hash object with the bytes of the input string
|
|
md5_hash.update(input_string.encode('utf-8'))
|
|
|
|
# Get the hexadecimal representation of the MD5 hash
|
|
md5_hash_hex = md5_hash.hexdigest()
|
|
hash_value = str(md5_hash_hex)
|
|
|
|
self.hash = hash_value
|
|
|
|
plugObj = getPluginObject({"Plugin":"MQTT", "Watched_Value3":hash_value})
|
|
|
|
# mylog('verbose', [f"[{pluginName}] Previous plugin object entry: {json.dumps(plugObj)}"])
|
|
|
|
if plugObj == {}:
|
|
self.isNew = True
|
|
mylog('verbose', [f"[{pluginName}] New sensor entry name : {deviceName}"])
|
|
mylog('verbose', [f"[{pluginName}] New sensor entry mac : {mac}"])
|
|
mylog('verbose', [f"[{pluginName}] New sensor entry hash_value : {hash_value}"])
|
|
else:
|
|
device_name = plugObj.get("Watched_Value1", "Unknown")
|
|
mylog('verbose', [f"[{pluginName}] Existing, skip Device Name : {device_name}"])
|
|
self.isNew = False
|
|
|
|
|
|
# Log sensor
|
|
global plugin_objects
|
|
|
|
if mac == '':
|
|
mac = "N/A"
|
|
|
|
plugin_objects.add_object(
|
|
primaryId = deviceId,
|
|
secondaryId = sensorName,
|
|
watched1 = deviceName,
|
|
watched2 = sensorType,
|
|
watched3 = hash_value,
|
|
watched4 = mac,
|
|
extra = input_string,
|
|
foreignKey = mac
|
|
)
|
|
|
|
#-------------------------------------------------------------------------------
|
|
|
|
def publish_mqtt(mqtt_client, topic, message):
|
|
status = 1
|
|
|
|
message = json.dumps(message).replace("'",'"')
|
|
qos = get_setting_value('MQTT_QOS')
|
|
|
|
mylog('verbose', [f"[{pluginName}] Sending MQTT topic: {topic}"])
|
|
mylog('verbose', [f"[{pluginName}] Sending MQTT message: {message}"])
|
|
# mylog('verbose', [f"[{pluginName}] get_setting_value('MQTT_QOS'): {qos}"])
|
|
|
|
if mqtt_connected_to_broker == False:
|
|
|
|
mylog('verbose', [f"[{pluginName}] ⚠ ERROR: Not connected to broker, aborting."])
|
|
|
|
return False
|
|
|
|
while status != 0:
|
|
|
|
# mylog('verbose', [f"[{pluginName}] mqtt_client.publish "])
|
|
# mylog('verbose', [f"[{pluginName}] mqtt_client.is_connected(): {mqtt_client.is_connected()} "])
|
|
|
|
result = mqtt_client.publish(
|
|
topic=topic,
|
|
payload=message,
|
|
qos=qos,
|
|
retain=True,
|
|
)
|
|
|
|
status = result[0]
|
|
|
|
# mylog('verbose', [f"[{pluginName}] status: {status}"])
|
|
# mylog('verbose', [f"[{pluginName}] result: {result}"])
|
|
|
|
if status != 0:
|
|
mylog('verbose', [f"[{pluginName}] Waiting to reconnect to MQTT broker"])
|
|
time.sleep(0.1)
|
|
return True
|
|
|
|
#-------------------------------------------------------------------------------
|
|
def create_generic_device(mqtt_client, deviceId, deviceName):
|
|
|
|
create_sensor(mqtt_client, deviceId, deviceName, 'sensor', 'online', 'wifi-check')
|
|
create_sensor(mqtt_client, deviceId, deviceName, 'sensor', 'down', 'wifi-cancel')
|
|
create_sensor(mqtt_client, deviceId, deviceName, 'sensor', 'all', 'wifi')
|
|
create_sensor(mqtt_client, deviceId, deviceName, 'sensor', 'archived', 'wifi-lock')
|
|
create_sensor(mqtt_client, deviceId, deviceName, 'sensor', 'new', 'wifi-plus')
|
|
create_sensor(mqtt_client, deviceId, deviceName, 'sensor', 'unknown', 'wifi-alert')
|
|
|
|
|
|
#-------------------------------------------------------------------------------
|
|
|
|
def create_sensor(mqtt_client, deviceId, deviceName, sensorType, sensorName, icon, mac=""):
|
|
|
|
global mqtt_sensors
|
|
|
|
# check previous configs
|
|
sensorConfig = sensor_config(deviceId, deviceName, sensorType, sensorName, icon, mac)
|
|
|
|
mylog('verbose', [f"[{pluginName}] Publishing sensor number {len(mqtt_sensors)}"])
|
|
|
|
state_topic = ''
|
|
topic = ''
|
|
|
|
# binary sensor only sensor
|
|
if sensorConfig.sensorType == 'binary_sensor' or sensorConfig.sensorType == 'sensor':
|
|
|
|
topic = f'homeassistant/{sensorConfig.sensorType}/{sensorConfig.deviceId}/{sensorConfig.sensorName}/config'
|
|
state_topic = f'system-sensors/{sensorConfig.sensorType}/{sensorConfig.deviceId}/state'
|
|
|
|
|
|
message = {
|
|
"name" : sensorConfig.sensorName,
|
|
"state_topic" : state_topic,
|
|
"value_template" : "{{value_json."+sensorConfig.sensorName+"}}",
|
|
"unique_id" : sensorConfig.deviceId+'_sensor_'+sensorConfig.sensorName,
|
|
"device":
|
|
{
|
|
"identifiers" : [sensorConfig.deviceId+"_sensor"],
|
|
"manufacturer" : "NetAlertX",
|
|
"name" : sensorConfig.deviceName
|
|
},
|
|
"icon": f'mdi:{sensorConfig.icon}'
|
|
}
|
|
|
|
|
|
|
|
elif sensorConfig.sensorType == 'device_tracker':
|
|
|
|
|
|
topic = f'homeassistant/device_tracker/{sensorConfig.deviceId}/config'
|
|
state_topic = f'system-sensors/device_tracker/{sensorConfig.deviceId}/state'
|
|
unique_id = f'{sensorConfig.deviceId}_{sensorConfig.sensorType}_{sensorConfig.sensorName}'
|
|
|
|
message = {
|
|
"state_topic": state_topic,
|
|
"name": sensorConfig.sensorName,
|
|
"payload_home": "home",
|
|
"payload_not_home": "away",
|
|
"unique_id" : unique_id,
|
|
"icon": f'mdi:{sensorConfig.icon}',
|
|
"device":
|
|
{
|
|
"identifiers" : [sensorConfig.deviceId+"_sensor", unique_id],
|
|
"manufacturer" : "NetAlertX",
|
|
"name" : sensorConfig.deviceName
|
|
},
|
|
}
|
|
|
|
|
|
|
|
# mosquitto_pub -h 127.0.0.1 -t homeassistant/device_tracker/a4567d663eaf/config -m '{"state_topic": "a4567d663eaf/state", "name": "My Tracker", "payload_home": "home", "payload_not_home": "not_home"}'
|
|
|
|
|
|
|
|
# mosquitto_pub -h 127.0.0.1 -t homeassistant/device_tracker/a4567d663eaf/config -m '{"json_attributes_topic": "a4567d663eaf/attributes", "name": "My Tracker"}'
|
|
# mosquitto_pub -h 127.0.0.1 -t a4567d663eaf/state -m 'home'
|
|
|
|
|
|
# # create device tracker attributes
|
|
# publish_mqtt(mqtt_client, f'homeassistant/device_tracker/a4567d663eaf/config',
|
|
# {
|
|
# "json_attributes_topic": f"{deviceId}/attributes",
|
|
# "name": deviceNameDisplay
|
|
# }
|
|
# )
|
|
|
|
# send if new TODO uncomment
|
|
# if sensorConfig.isNew:
|
|
|
|
# add the sensor to the global list to keep track of succesfully added sensors
|
|
if publish_mqtt(mqtt_client, topic, message):
|
|
# hack - delay adding to the queue in case the process is
|
|
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)
|
|
mqtt_sensors.append(sensorConfig)
|
|
|
|
return state_topic
|
|
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------------------
|
|
def mqtt_create_client():
|
|
def on_disconnect(mqtt_client, userdata, reason_code):
|
|
|
|
global mqtt_connected_to_broker
|
|
|
|
mqtt_connected_to_broker = False
|
|
|
|
# not sure is below line is correct / necessary
|
|
# client = mqtt_create_client()
|
|
|
|
def on_connect(mqtt_client, userdata, flags, reason_code):
|
|
|
|
global mqtt_connected_to_broker
|
|
|
|
if reason_code == 0:
|
|
mylog('verbose', [f"[{pluginName}] Connected to broker"])
|
|
mqtt_connected_to_broker = True # Signal connection
|
|
else:
|
|
mylog('verbose', [f"[{pluginName}] Connection failed, reason_code: {reason_code}"])
|
|
mqtt_connected_to_broker = False
|
|
|
|
|
|
global mqtt_client
|
|
|
|
if get_setting_value('MQTT_VERSION') == 1:
|
|
mqtt_client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION1)
|
|
else:
|
|
mqtt_client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
|
|
|
|
|
|
mqtt_client.username_pw_set(get_setting_value('MQTT_USER'), get_setting_value('MQTT_PASSWORD'))
|
|
mqtt_client.on_connect = on_connect
|
|
mqtt_client.on_disconnect = on_disconnect
|
|
mqtt_client.connect(get_setting_value('MQTT_BROKER'), get_setting_value('MQTT_PORT'))
|
|
mqtt_client.loop_start()
|
|
|
|
return mqtt_client
|
|
|
|
#-------------------------------------------------------------------------------
|
|
def mqtt_start(db):
|
|
|
|
global mqtt_client, mqtt_connected_to_broker
|
|
|
|
if mqtt_connected_to_broker == False:
|
|
mqtt_connected_to_broker = True
|
|
mqtt_client = mqtt_create_client()
|
|
|
|
|
|
deviceName = get_setting_value('MQTT_DEVICE_NAME')
|
|
deviceId = get_setting_value('MQTT_DEVICE_ID')
|
|
|
|
# General stats
|
|
|
|
# Create a generic device for overal stats
|
|
if get_setting_value('MQTT_SEND_STATS') == True:
|
|
# Create a new device representing overall stats
|
|
create_generic_device(mqtt_client, deviceId, deviceName)
|
|
|
|
# Get the data
|
|
row = get_device_stats(db)
|
|
|
|
# Publish (wrap into {} and remove last ',' from above)
|
|
publish_mqtt(mqtt_client, f"system-sensors/sensor/{deviceId}/state",
|
|
{
|
|
"online": row[0],
|
|
"down": row[1],
|
|
"all": row[2],
|
|
"archived": row[3],
|
|
"new": row[4],
|
|
"unknown": row[5]
|
|
}
|
|
)
|
|
|
|
# Generate device-specific MQTT messages if enabled
|
|
if get_setting_value('MQTT_SEND_DEVICES') == True:
|
|
|
|
# Specific devices
|
|
|
|
# Get all devices
|
|
devices = get_all_devices(db)
|
|
|
|
sec_delay = len(devices) * int(get_setting_value('MQTT_DELAY_SEC'))*5
|
|
|
|
mylog('verbose', [f"[{pluginName}] Estimated delay: ", (sec_delay), 's ', '(', round(sec_delay/60,1) , 'min)' ])
|
|
|
|
debug_index = 0
|
|
|
|
for device in devices:
|
|
|
|
# TODO remove
|
|
if 'Moto' in device["dev_Name"]:
|
|
|
|
|
|
# Create devices in Home Assistant - send config messages
|
|
deviceId = 'mac_' + device["dev_MAC"].replace(" ", "").replace(":", "_").lower()
|
|
deviceNameDisplay = re.sub('[^a-zA-Z0-9-_\s]', '', device["dev_Name"])
|
|
|
|
state_topic = create_sensor(mqtt_client, deviceId, deviceNameDisplay, 'sensor', 'last_ip', 'ip-network', device["dev_MAC"])
|
|
state_topic = create_sensor(mqtt_client, deviceId, deviceNameDisplay, 'sensor', 'mac_address', 'folder-key-network', device["dev_MAC"])
|
|
state_topic = create_sensor(mqtt_client, deviceId, deviceNameDisplay, 'sensor', 'is_new', 'bell-alert-outline', device["dev_MAC"])
|
|
state_topic = create_sensor(mqtt_client, deviceId, deviceNameDisplay, 'sensor', 'vendor', 'cog', device["dev_MAC"])
|
|
state_topic = create_sensor(mqtt_client, deviceId, deviceNameDisplay, 'sensor', 'first_connection', 'calendar-start', device["dev_MAC"])
|
|
state_topic = create_sensor(mqtt_client, deviceId, deviceNameDisplay, 'sensor', 'last_connection', 'calendar-end', device["dev_MAC"])
|
|
|
|
# bulk update device sensors in home assistant
|
|
|
|
publish_mqtt(mqtt_client, state_topic,
|
|
{
|
|
"last_ip": device["dev_LastIP"],
|
|
"is_new": str(device["dev_NewDevice"]),
|
|
"vendor": sanitize_string(device["dev_Vendor"]),
|
|
"mac_address": str(device["dev_MAC"]),
|
|
"last_connection": str(device["dev_LastConnection"]),
|
|
"first_connection": str(device["dev_FirstConnection"])
|
|
}
|
|
)
|
|
|
|
# create and update is_present sensor
|
|
state_topic = create_sensor(mqtt_client, deviceId, deviceNameDisplay, 'binary_sensor', 'is_present', 'wifi', device["dev_MAC"])
|
|
publish_mqtt(mqtt_client, state_topic,
|
|
{
|
|
"is_present": to_binary_sensor(str(device["dev_PresentLastScan"]))
|
|
}
|
|
)
|
|
|
|
# handle device_tracker
|
|
state_topic = create_sensor(mqtt_client, deviceId, deviceNameDisplay, 'device_tracker', 'is_home', 'home', device["dev_MAC"])
|
|
|
|
# <away|home> are only valid states
|
|
state = 'away'
|
|
if to_binary_sensor(str(device["dev_PresentLastScan"])) == "ON":
|
|
state = 'home'
|
|
|
|
publish_mqtt(mqtt_client, state_topic, state)
|
|
|
|
|
|
|
|
# delete device / topic
|
|
# homeassistant/sensor/mac_44_ef_bf_c4_b1_af/is_present/config
|
|
# client.publish(
|
|
# topic="homeassistant/sensor/"+deviceId+"/is_present/config",
|
|
# payload="",
|
|
# qos=1,
|
|
# retain=True,
|
|
# )
|
|
# time.sleep(10)
|
|
|
|
|
|
#===============================================================================
|
|
# Home Assistant UTILs
|
|
#===============================================================================
|
|
def to_binary_sensor(input):
|
|
# In HA a binary sensor returns ON or OFF
|
|
result = "OFF"
|
|
|
|
# bytestring
|
|
if isinstance(input, str):
|
|
if input == "1":
|
|
result = "ON"
|
|
elif isinstance(input, int):
|
|
if input == 1:
|
|
result = "ON"
|
|
elif isinstance(input, bool):
|
|
if input == True:
|
|
result = "ON"
|
|
elif isinstance(input, bytes):
|
|
if bytes_to_string(input) == "1":
|
|
result = "ON"
|
|
return result
|
|
|
|
|
|
|
|
|
|
# -------------INIT---------------------
|
|
if __name__ == '__main__':
|
|
sys.exit(main())
|
|
|
|
|
|
|