diff --git a/CHANGELOG.md b/CHANGELOG.md index 83b304a91..2af2f675e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file. ### Added - ESP32 Extension Manager, replacing loading of Partition Wizard (#23955) - Berry animation framework web ui to compile DSL (#23962) +- Berry Devices Online Extension App ### Breaking Changed diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 41f2f7070..6fbe3b7b4 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -135,6 +135,7 @@ The latter links can be used for OTA upgrades too like ``OtaUrl https://ota.tasm - Berry `call()` now works for classes [#23744](https://github.com/arendst/Tasmota/issues/23744) - Berry multiplication between string and int [#23850](https://github.com/arendst/Tasmota/issues/23850) - Berry animation framework web ui to compile DSL [#23962](https://github.com/arendst/Tasmota/issues/23962) +- Berry Devices Online Extension App ### Breaking Changed - Berry `animate` framework is DEPRECATED, will be replace by `animation` framework [#23854](https://github.com/arendst/Tasmota/issues/23854) diff --git a/tasmota/berry/extensions/Devices_Online.tapp b/tasmota/berry/extensions/Devices_Online.tapp new file mode 100644 index 000000000..93468ce38 Binary files /dev/null and b/tasmota/berry/extensions/Devices_Online.tapp differ diff --git a/tasmota/berry/extensions/Devices_Online/autoexec.be b/tasmota/berry/extensions/Devices_Online/autoexec.be new file mode 100644 index 000000000..29c20df0a --- /dev/null +++ b/tasmota/berry/extensions/Devices_Online/autoexec.be @@ -0,0 +1,9 @@ +# rm Devices_Online.tapp; zip -j -0 Devices_Online.tapp Devices_Online/autoexec.be Devices_Online/devices_online.be Devices_Online/manifest.json +do # embed in `do` so we don't add anything to global namespace + import introspect + var devices_online = introspect.module('devices_online', true) # load module but don't cache + tasmota.add_extension(devices_online) +end + +# to remove: +# tasmota.unload_extension('Devices Online') diff --git a/tasmota/berry/extensions/Devices_Online/devices_online.be b/tasmota/berry/extensions/Devices_Online/devices_online.be new file mode 100644 index 000000000..0feba4b9f --- /dev/null +++ b/tasmota/berry/extensions/Devices_Online/devices_online.be @@ -0,0 +1,359 @@ +################################################################################### +# Display in Main GUI Devices Online based on MQTT Tasmota Discovery Config and STATE reports +# +# Copyright (C) 2025 Stephan Hadinger & Theo Arends +# +# Enable either +# line_option = 1 : Scroll 'line_cnt' lines +# or +# line_option = 2 : Show devices updating within 'line_teleperiod' +# +# rm Devices_Online.tapp; zip -j -0 Devices_Online.tapp Devices_Online/autoexec.be Devices_Online/devices_online.be Devices_Online/manifest.json +################################################################################### + +import mqtt +import json +import string +import webserver +import persist + +class devices_online +# static var line_option = 1 # Scroll line_cnt lines + static var line_option = 2 # Show devices updating within line_teleperiod + + static var line_cnt = 10 # Option 1 number of lines to show + static var line_teleperiod = 600 # Option 2 number of teleperiod seconds for devices to be shown as online + static var line_highlight = 10 # Highlight latest change duration in seconds + static var line_highlight_color = "yellow" # Latest change highlight HTML color like "#FFFF00" or "yellow" + static var line_lowuptime_color = "lime" # Low uptime highlight HTML color like "#00FF00" or "lime" + + var mqtt_tele # MQTT tele STATE subscribe format + var bool_devicename # Show device name + var bool_version # Show version + var bool_ipaddress # Show IP address + var sort_direction # Sort direction + var sort_column # Sort column + var sort_last_column # Sort last column + var list_buffer # Buffer storing lines + var list_config # Buffer storing retained config + + ################################################################################# + # init + # + # install the extension and allocate all resources + ################################################################################# + def init() + self.bool_devicename = persist.std_devicename # Show device name + self.bool_version = persist.std_version # Show version + self.bool_ipaddress = persist.std_ipaddress # Show IP address + + self.sort_direction = persist.std_direction # Sort direction (0) Up or (1) Down + if !self.sort_direction + self.sort_direction = 0 # Default Up + end + self.sort_column = persist.std_column # Sort column + if !self.sort_column + self.sort_column = 0 # Default Hostname + end + self.sort_last_column = self.sort_column # Sort last column to detect direction toggle + + self.list_buffer = [] # Init line buffer list + self.list_config = [] # Init retained config buffer list + +# var full_topic = tasmota.cmd("FullTopic", true)['FullTopic'] # "%prefix%/%topic%/" + var prefix_tele = tasmota.cmd("Prefix", true)['Prefix3'] # tele = Prefix3 used by STATE message + self.mqtt_tele = format("%s/#", prefix_tele) + mqtt.subscribe(self.mqtt_tele, /topic, idx, data, databytes -> self.handle_state_data(topic, idx, data, databytes)) + mqtt.subscribe("tasmota/discovery/+/config", /topic, idx, data, databytes -> self.handle_discovery_data(topic, idx, data, databytes)) + + tasmota.add_driver(self) + end + + ################################################################################# + # unload + # + # Uninstall the extension and deallocate all resources + ################################################################################# + def unload() + mqtt.unsubscribe("tasmota/discovery/+/config") + mqtt.unsubscribe(self.mqtt_tele) + tasmota.remove_driver(self) + end + + ################################################################################# + # handle_discovery_data(discovery_topic, idx, data, databytes) + # + # Handle MQTT Tasmota Discovery Config data + ################################################################################# + def handle_discovery_data(discovery_topic, idx, data, databytes) + var config = json.load(data) + if config + # tasmota/discovery/142B2F9FAF38/config = {"ip":"192.168.2.208","dn":"AtomLite2","fn":["Tasmota",null,null,null,null,null,null,null],"hn":"atomlite2","mac":"142B2F9FAF38","md":"M5Stack Atom Lite","ty":0,"if":0,"cam":0,"ofln":"Offline","onln":"Online","state":["OFF","ON","TOGGLE","HOLD"],"sw":"15.0.1.4","t":"atomlite2","ft":"%prefix%/%topic%/","tp":["cmnd","stat","tele"],"rl":[2,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"swc":[-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1],"swn":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null],"btn":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"so":{"4":0,"11":0,"13":0,"17":0,"20":0,"30":0,"68":0,"73":0,"82":0,"114":0,"117":0},"lk":1,"lt_st":3,"bat":0,"dslp":0,"sho":[],"sht":[],"ver":1} (retained) + var topic = config['t'] + var hostname = config['hn'] + var ipaddress = config['ip'] + var devicename = config['dn'] + var version = config['sw'] + var line = format("%s\001%s\001%s\001%s\001%s", topic, hostname, ipaddress, devicename, version) +# tasmota.log(format("STD: 111 Size %03d, Topic '%s', Line '%s'", self.list_config.size(), topic, line), 3) + if self.list_config.size() + var list_index = 0 + var list_size = size(self.list_config) + var topic_delim = format("%s\001", topic) # Add find delimiter + while list_index < list_size # Use while loop as counter is decremented + if 0 == string.find(self.list_config[list_index], topic_delim) + self.list_config.remove(list_index) # Remove current config + list_size -= 1 # Continue for duplicates + end + list_index += 1 + end + end + self.list_config.push(line) # Add (re-discovered) config as last entry +# tasmota.log(format("STD: 222 Size %03d, Topic '%s', Line '%s'", self.list_config.size(), topic, line), 3) + end + return true # return true to stop propagation as a Tasmota cmd + end + + ################################################################################# + # handle_state_data(tele_topic, idx, data, databytes) + # + # Handle MQTT STATE data + ################################################################################# + def handle_state_data(tele_topic, idx, data, databytes) + var subtopic = string.split(tele_topic, "/") + if subtopic[-1] == "STATE" # tele/atomlite2/STATE + var topic = subtopic[1] # Assume default Fulltopic (%prefix%/%topic%/) = tele/atomlite2/STATE = atomlite2 + + var topic_index = -1 + for i: self.list_config.keys() + if 0 == string.find(self.list_config[i], topic) + topic_index = i + break + end + end +# tasmota.log(format("STD: Topic '%s', Index %d, Size %d, Line '%s'", topic, topic_index, self.list_config.size(), self.list_config[topic_index]), 3) + if topic_index == -1 return true end # return true to stop propagation as a Tasmota cmd + + var state = json.load(data) # Assume topic is in retained discovery list + if state # Valid JSON state message + var config_splits = string.split(self.list_config[topic_index], "\001") + var hostname = config_splits[1] + var ipaddress = config_splits[2] + var devicename = config_splits[3] + var version = config_splits[4] + + # tele/atomlite2/STATE = {"Time":"2025-09-24T14:13:00","Uptime":"0T00:15:09","UptimeSec":909,"Heap":142,"SleepMode":"Dynamic","Sleep":50,"LoadAvg":19,"MqttCount":1,"Berry":{"HeapUsed":12,"Objects":167},"POWER":"OFF","Dimmer":10,"Color":"1A0000","HSBColor":"0,100,10","Channel":[10,0,0],"Scheme":0,"Width":1,"Fade":"OFF","Speed":1,"LedTable":"ON","Wifi":{"AP":1,"SSId":"indebuurt_IoT","BSSId":"18:E8:29:CA:17:C1","Channel":11,"Mode":"HT40","RSSI":100,"Signal":-28,"LinkCount":1,"Downtime":"0T00:00:04"},"Hostname":"atomlite2","IPAddress":"192.168.2.208"} + var uptime = state['Uptime'] # 0T00:15:09 + if state.find('Hostname') + hostname = state['Hostname'] # atomlite2 + ipaddress = state['IPAddress'] # 192.168.2.208 + end + var last_seen = tasmota.rtc('local') + var line = format("%s\001%s\001%s\001%d\001%s\001%s", hostname, ipaddress, uptime, last_seen, devicename, version) + + if self.list_buffer.size() + var list_index = 0 + var list_size = size(self.list_buffer) + var hostname_delim = format("%s\001", hostname) # Add find delimiter + while list_index < list_size # Use while loop as counter is decremented + if 0 == string.find(self.list_buffer[list_index], hostname_delim) + self.list_buffer.remove(list_index) # Remove current state + list_size -= 1 # Continue for duplicates + end + list_index += 1 + end + end + self.list_buffer.push(line) # Add state as last entry + + end + end + return true # return true to stop propagation as a Tasmota cmd + end + + ################################################################################# + # sort_col(l, col, dir) + # + # Shell sort list of online devices based on user selected column and direction + ################################################################################# + def sort_col(l, col, dir) # Sort list based on col and Hostname (is first entry in line) + # For 50 records takes 6ms (primary key) or 25ms(ESP32S3&240MHz) / 50ms(ESP32@160MHz) (primary and secondary key) + var cmp = /a,b -> a < b # Sort up + if dir + cmp = /a,b -> a > b # Sort down + end + if col # col is new primary key (not Hostname) + for i:l.keys() + var splits = string.split(l[i], "\001") + l[i] = splits[col] + "\002" + l[i] # Add primary key to secondary key as "col" + Hostname + end + end + for i:1..size(l)-1 + var k = l[i] + var j = i + while (j > 0) && !cmp(l[j-1], k) + l[j] = l[j-1] + j -= 1 + end + l[j] = k + end + if col + for i:l.keys() + var splits = string.split(l[i], "\002") # Remove primary key + l[i] = splits[1] + end + end + return l + end + + ################################################################################# + # persist_save + # + # Save user data to be used on restart + ################################################################################# + def persist_save() + persist.std_devicename = self.bool_devicename + persist.std_version = self.bool_version + persist.std_ipaddress = self.bool_ipaddress + persist.std_column = self.sort_column + persist.std_direction = self.sort_direction + persist.save() +# tasmota.log("STD: Persist saved", 3) + end + + ################################################################################# + # web_sensor + # + # Display Devices Online in user selected sorted columns + ################################################################################# + def web_sensor() + if webserver.has_arg("sd_dn") + # Toggle display Device Name + if self.bool_devicename self.bool_devicename = false else self.bool_devicename = true end + self.persist_save() + elif webserver.has_arg("sd_sw") + # Toggle display software version + if self.bool_version self.bool_version = false else self.bool_version = true end + self.persist_save() + elif webserver.has_arg("sd_ip") + # Toggle display IP address + if self.bool_ipaddress self.bool_ipaddress = false else self.bool_ipaddress = true end + self.persist_save() + elif webserver.has_arg("sd_sort") + # Toggle sort column + self.sort_column = int(webserver.arg("sd_sort")) + if self.sort_last_column == self.sort_column + self.sort_direction ^= 1 + end + self.sort_last_column = self.sort_column + self.persist_save() + end + + if self.list_buffer.size() + var now = tasmota.rtc('local') + var time_window = now - self.line_teleperiod + var list_index = 0 + var list_size = size(self.list_buffer) + while list_index < list_size + var splits = string.split(self.list_buffer[list_index], "\001") + var last_seen = int(splits[3]) + if time_window > last_seen # Remove offline devices + self.list_buffer.remove(list_index) + list_size -= 1 + end + list_index += 1 + end + if !list_size return end # If list became empty bail out + + var msg = "" # Terminate two column table and open new table + msg += "" + + list_index = 0 + if 1 == self.line_option + list_index = list_size - self.line_cnt # Offset in list using self.line_cnt + if list_index < 0 list_index = 0 end + + if self.bool_devicename + msg += "" + end + if self.bool_version + msg += "" + end + msg += "" + if self.bool_ipaddress + msg += "" + end + msg += "" + else + self.sort_col(self.list_buffer, self.sort_column, self.sort_direction) # Sort list by column + + var icon_direction = self.sort_direction ? "▼" : "▲" + if self.bool_devicename + msg += format("", self.sort_column == 4 ? icon_direction : "") + end + if self.bool_version + msg += format("", self.sort_column == 5 ? icon_direction : "") + end + msg += format("", self.sort_column == 0 ? icon_direction : "") + if self.bool_ipaddress + msg += format("", self.sort_column == 1 ? icon_direction : "") + end + msg += format("", self.sort_column == 2 ? icon_direction : "") + end + + msg += "" + + while list_index < list_size + var splits = string.split(self.list_buffer[list_index], "\001") + var hostname = splits[0] + var ipaddress = splits[1] + var uptime = splits[2] + var last_seen = int(splits[3]) + var devicename = splits[4] + var version = splits[5] + + msg += "" + if self.bool_devicename + msg += format("", devicename) + end + if self.bool_version + msg += format("", version) + end + msg += format("", hostname, hostname) + if self.bool_ipaddress + msg += format("", ipaddress, ipaddress) + end + + var uptime_str = string.replace(uptime, "T", ":") # 11T21:50:34 -> 11:21:50:34 + var uptime_splits = string.split(uptime_str, ":") + var uptime_sec = (int(uptime_splits[0]) * 86400) + # 11 * 86400 + (int(uptime_splits[1]) * 3600) + # 21 * 3600 + (int(uptime_splits[2]) * 60) + # 50 * 60 + int(uptime_splits[3]) # 34 + if last_seen >= (now - self.line_highlight) # Highlight changes within latest seconds + msg += format("", self.line_highlight_color, uptime) + elif uptime_sec < self.line_teleperiod # Highlight changes just after restart + msg += format("", self.line_lowuptime_color, uptime) + else + msg += format("", uptime) + end + + msg += "" + list_index += 1 + end + msg += "
Device Name Version Hostname IP Address Uptime Device Name%s Version%s Hostname%s IP Address%s Uptime%s 
%s %s %s %s %s%s%s
{t}" # Terminate three/four/five column table and open new table: + msg += format("{s}Devices online{m}%d{e}", list_size) # + + msg += "
Devices online%d

{t}" # Terminate two column table and open new table: + msg += "" + msg += "" + msg += "" + msg += "
{t}" # Terminate two column table and open new table: + + tasmota.web_send(msg) # Do not use tasmota.web_send_decimal() which will replace IPAddress dots + tasmota.web_send_decimal("") # Force horizontal line + end + end + +end + +return devices_online() diff --git a/tasmota/berry/extensions/Devices_Online/manifest.json b/tasmota/berry/extensions/Devices_Online/manifest.json new file mode 100644 index 000000000..91b25c37b --- /dev/null +++ b/tasmota/berry/extensions/Devices_Online/manifest.json @@ -0,0 +1,8 @@ +{ + "name": "Devices Online", + "version": "0x01010100", + "description": "Display devices online", + "author": "Theo Arends", + "min_tasmota": "0x0E060001", + "features": "" +}