From 969ae57fc2f274ffc03e2870e39ca9a6fb9564ea Mon Sep 17 00:00:00 2001
From: Christian Hesse <mail@eworm.de>
Date: Fri, 27 Mar 2020 21:41:56 +0100
Subject: add doc/check-lte-firmware-upgrade.md

---
 check-lte-firmware-upgrade        |  3 ++-
 doc/check-lte-firmware-upgrade.md | 41 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 doc/check-lte-firmware-upgrade.md

diff --git a/check-lte-firmware-upgrade b/check-lte-firmware-upgrade
index 101f5e1..6edb6f1 100644
--- a/check-lte-firmware-upgrade
+++ b/check-lte-firmware-upgrade
@@ -3,6 +3,7 @@
 # Copyright (c) 2018-2020 Christian Hesse <mail@eworm.de>
 #
 # check for LTE firmware upgrade, send notification
+# https://git.eworm.de/cgit/routeros-scripts/about/doc/check-lte-firmware-upgrade.md
 
 :global Identity;
 :global SentLteFirmwareUpgradeNotification;
@@ -13,7 +14,7 @@
   :local IntName [ / interface lte get $Interface name ];
   :do {
     :local Firmware [ / interface lte firmware-upgrade $Interface once as-value ];
-    
+
     :if ($SentLteFirmwareUpgradeNotification = ($Firmware->"latest")) do={
       :log debug ("Already sent the LTE firmware upgrade notification for version " . \
         ($Firmware->"latest") . ".");
diff --git a/doc/check-lte-firmware-upgrade.md b/doc/check-lte-firmware-upgrade.md
new file mode 100644
index 0000000..c71dee5
--- /dev/null
+++ b/doc/check-lte-firmware-upgrade.md
@@ -0,0 +1,41 @@
+Notify on LTE firmware upgrade
+==============================
+
+[◀ Go back to main README](../README.md)
+
+Description
+-----------
+
+This script is run from scheduler periodically, checking for LTE firmware
+upgrades. Currently supported LTE hardware:
+
+* R11e-LTE
+* R11e-LTE-US
+* R11e-4G
+* R11e-LTE6
+
+Requirements and installation
+-----------------------------
+
+Just install the script:
+
+    $ScriptInstallUpdate check-lte-firmware-upgrade;
+
+... and create a scheduler:
+
+    / system scheduler add interval=1d name=check-lte-firmware-upgrade on-event="/ system script run check-lte-firmware-upgrade;" start-time=startup;
+
+Configuration
+-------------
+
+Notification setting are required for e-mail and telegram.
+
+See also
+--------
+
+* [Notify on RouterOS update](check-routeros-update.md)
+* [Install LTE firmware upgrade](unattended-lte-firmware-upgrade.md)
+
+---
+[◀ Go back to main README](../README.md)  
+[▲ Go back to top](#top)
-- 
cgit v1.2.3-54-g00ecf