micrOSDevToolKit 2.17.2__py3-none-any.whl → 2.20.0__py3-none-any.whl

micrOS/release_info/micrOS_ReleaseInfo/system_analysis_sum.json

@@ -25,7 +25,7 @@
             1
         ],
         "Tasks.py": [
-            9.43,
+            9.48,
             12
         ],
         "Config.py": [
@@ -46,7 +46,7 @@
         ],
         "Types.py": [
             8.91,
-            28
+            29
         ],
         "Logger.py": [
             8.84,
@@ -54,10 +54,10 @@
         ],
         "Common.py": [
             9.85,
-            35
+            34
         ],
         "InterConnect.py": [
-            9.41,
+            9.62,
             2
         ],
         "Debug.py": [
@@ -69,8 +69,8 @@
             8
         ],
         "Espnow.py": [
-            9.5,
-            3
+            9.47,
+            4
         ],
         "Scheduler.py": [
             9.62,
@@ -97,7 +97,7 @@
             5
         ],
         "modules/LM_roboarm.py": [
-            7.78,
+            7.83,
             0
         ],
         "modules/LM_stepper.py": [
@@ -117,7 +117,7 @@
             0
         ],
         "modules/LM_oled_ui.py": [
-            8.78,
+            9.2,
             0
         ],
         "modules/LM_system.py": [
@@ -125,7 +125,7 @@
             0
         ],
         "modules/LM_robustness.py": [
-            8.36,
+            8.33,
             0
         ],
         "modules/LM_qmi8658.py": [
@@ -137,11 +137,11 @@
             0
         ],
         "modules/LM_rest.py": [
-            8.18,
+            8.6,
             0
         ],
         "modules/LM_tcs3472.py": [
-            9.0,
+            9.48,
             0
         ],
         "modules/LM_oled.py": [
@@ -161,7 +161,7 @@
             0
         ],
         "modules/LM_buzzer.py": [
-            9.11,
+            9.09,
             0
         ],
         "modules/LM_switch.py": [
@@ -189,11 +189,11 @@
             0
         ],
         "modules/LM_neopixel.py": [
-            7.78,
+            7.77,
             0
         ],
         "modules/LM_cct.py": [
-            9.04,
+            9.03,
             0
         ],
         "modules/LM_L9110_DCmotor.py": [
@@ -220,10 +220,6 @@
             7.62,
             0
         ],
-        "modules/LM_pet_feeder.py": [
-            7.94,
-            0
-        ],
         "modules/LM_rencoder.py": [
             8.65,
             0
@@ -245,15 +241,15 @@
             0
         ],
         "modules/LM_oledui.py": [
-            8.7,
+            8.94,
             0
         ],
         "modules/LM_espnow.py": [
-            6.0,
+            7.14,
             0
         ],
         "modules/LM_telegram.py": [
-            9.58,
+            9.62,
             0
         ],
         "modules/LM_OV2640.py": [
@@ -265,7 +261,7 @@
             0
         ],
         "modules/LM_distance.py": [
-            8.87,
+            8.86,
             0
         ],
         "modules/LM_VL53L0X.py": [
@@ -273,7 +269,7 @@
             0
         ],
         "modules/LM_light_sensor.py": [
-            9.17,
+            9.12,
             0
         ],
         "modules/LM_rp2w.py": [
@@ -281,7 +277,7 @@
             0
         ],
         "modules/LM_presence.py": [
-            8.9,
+            8.89,
             0
         ],
         "modules/LM_trackball.py": [
@@ -289,7 +285,7 @@
             0
         ],
         "modules/LM_mqtt_client.py": [
-            8.45,
+            8.68,
             0
         ],
         "modules/LM_dashboard_be.py": [
@@ -297,7 +293,7 @@
             0
         ],
         "modules/LM_dimmer.py": [
-            8.33,
+            8.32,
             0
         ],
         "modules/LM_gameOfLife.py": [
@@ -309,7 +305,7 @@
             0
         ],
         "modules/LM_i2s_mic.py": [
-            8.43,
+            8.42,
             0
         ],
         "modules/LM_sdcard.py": [
@@ -323,12 +319,12 @@
     },
     "summary": {
         "core": [
-            3925,
+            3994,
             24
         ],
         "load": [
-            9880,
-            56
+            9912,
+            55
         ],
         "core_dep": [
             true,
@@ -338,8 +334,8 @@
             true,
             4
         ],
-        "core_score": 9.24,
-        "load_score": 8.36,
-        "version": "2.17.1-0"
+        "core_score": 9.25,
+        "load_score": 8.42,
+        "version": "2.20.0-0"
     }
 }

micrOS/source/Common.py

@@ -15,7 +15,7 @@ from Notify import Notify
 #####################################################################################
 #                                     SYSTEM                                        #
 #####################################################################################
-def micro_task(tag: str, task=None, _wrap=False):
+def micro_task(tag:str, task=None, _wrap=False):
     """
     [LM] Async task manager.
     Modes:
@@ -37,21 +37,14 @@ def micro_task(tag: str, task=None, _wrap=False):
     """
     # --- CREATE (original) ---
     if task is not None:
-        if TaskBase.is_busy(tag):
-            return None     # task already running
         return Manager().create_task(callback=task, tag=tag)
 
     # --- CREATE WITH DECORATOR FACTORY (simplified) ---
     if _wrap:
         def _decorator(async_fn):
             task_tag = f"{tag}._{async_fn.__name__}"
-            _launcher = (
-                lambda *args, **kwargs:
-                None if TaskBase.is_busy(task_tag)
-                else Manager().create_task(
-                    callback=async_fn(task_tag, *args, **kwargs),
-                    tag=task_tag)
-            )
+            _launcher = (lambda *args, **kwargs: Manager().create_task(callback=async_fn(task_tag, *args, **kwargs),
+                                                              tag=task_tag))
             return _launcher
         return _decorator
 
@@ -404,9 +397,8 @@ class AnimationPlayer:
         # Ensure async loop set up correctly. (After stop operation, it is needed)
         self.__running = True
         # [!] ASYNC TASK CREATION
-        raw_state:bool = micro_task(tag=self._task_tag, task=self._player())
-        state = "starting" if raw_state else "running"
-        settings["state"] = state
+        state:dict = micro_task(tag=self._task_tag, task=self._player())
+        settings["state"] = list(state.values())[0]
         return settings
 
     def stop(self):

micrOS/source/Config.py

@@ -102,12 +102,12 @@ class Data:
         liveconf = Data.read_cfg_file(nosafe=True)
         # Remove obsolete keys from conf
         try:
-            remove('cleanup.pds')       # Try to remove cleanup.pds (cleanup indicator by micrOSloader)
+            remove('.cleanup')       # Try to remove .cleanup (cleanup indicator by micrOSloader)
             console_write("[CONF] Purge obsolete keys")
             for key in (key for key in liveconf if key not in Data.CONFIG_CACHE):
                 liveconf.pop(key, None)
         except Exception:
-            console_write("[CONF] SKIP obsolete keys check (no cleanup.pds)")
+            console_write("[CONF] SKIP obsolete keys check (no .cleanup)")
         # Merge template to live conf (store active conf in Data.CONFIG_CACHE)
         Data.CONFIG_CACHE.update(liveconf)
         console_write("[CONF] User config injection done")

micrOS/source/Espnow.py

@@ -99,14 +99,14 @@ class ESPNowSS:
             self.devfid = cfgget('devfid')
             self.devices: dict[bytes, str] = {}         # mapping for { "mac address": "devfid" } pairs
             self.server_ready = False
-            self.peer_cache = path_join(OSPath.DATA, "espnow_peers.app_json")
+            self.peer_cache_path = path_join(OSPath.DATA, "espnow_peers.app_json")
             self._load_peers()
 
     def _load_peers(self):
-        if not is_file(self.peer_cache):
+        if not is_file(self.peer_cache_path):
             return
         try:
-            with open(self.peer_cache, 'r') as f:
+            with open(self.peer_cache_path, 'r') as f:
                 devices_map = load(f)
                 self.devices = {bytes(k): v for k, v in devices_map}
             for mac in self.devices:
@@ -179,6 +179,7 @@ class ESPNowSS:
             self.server_ready = True
             my_task.out = "ESPNow receiver running"
             async for mac, msg in self.espnow:
+                reply, response = False, ""
                 try:
                     reply, response = self._request_handler(msg, my_task, mac)
                     if reply:
@@ -188,7 +189,6 @@ class ESPNowSS:
                     if len(err.args) > 1 and err.args[1] == 'ESP_ERR_ESPNOW_NOT_FOUND':
                         # AUTOMATIC PEER REGISTRATION
                         self.espnow.add_peer(mac)
-                        reply, response = self._request_handler(msg, my_task, mac)
                         if reply:
                             await self.__asend_raw(mac, response)
                     else:
@@ -201,8 +201,7 @@ class ESPNowSS:
         """
         # Create an asynchronous task with tag 'espnow.server'
         tag = 'espnow.server'
-        state = NativeTask().create(callback=self._server(tag), tag=tag)
-        return {tag: "Starting"} if state else {tag: "Already running"}
+        return NativeTask().create(callback=self._server(tag), tag=tag)
 
     #----------- SEND METHODS --------------
     async def __asend_raw(self, mac:bytes, msg:str):
@@ -249,8 +248,7 @@ class ESPNowSS:
         peer_name = hexlify(peer, ':').decode() if peer_name is None else peer_name
         task_id = f"con.espnow.{peer_name}"
         # Create an asynchronous sending task.
-        state = NativeTask().create(callback=self._asend_task(peer, task_id, msg), tag=task_id)
-        return {task_id: "Starting"} if state else {task_id: "Already running"}
+        return NativeTask().create(callback=self._asend_task(peer, task_id, msg), tag=task_id)
 
     def cluster_send(self, msg):
         """
@@ -262,6 +260,14 @@ class ESPNowSS:
         return _tasks
 
     # ----------- OTHER METHODS --------------
+    def save_peers(self):
+        try:
+            with open(self.peer_cache_path, "w") as f:
+                dump([[list(k), v] for k, v in self.devices.items()], f)
+            return True
+        except Exception as e:
+            syslog(f"[ERR][ESPNOW] Saving peers: {e}")
+        return False
 
     async def _handshake(self, peer:bytes, tag:str):
         """
@@ -285,16 +291,10 @@ class ESPNowSS:
             expected_response =  f"hello {self.devfid}"
             is_ok = False
             if result == expected_response:
-                try:
-                    with open(self.peer_cache, "w") as f:
-                        dump([[list(k), v] for k, v in self.devices.items()], f)
-                    is_ok = True
-                except Exception as e:
-                    syslog(f"[ERR][ESPNOW] Saving peers: {e}")
+                is_ok = self.save_peers()
             my_task.out = f"Handshake: {result} from {self.devices.get(peer)} [{'OK' if is_ok else 'NOK'}]"
             sender_task.cancel()    # Delete sender task (cleanup)
 
-
     def handshake(self, peer:bytes|str):
         task_id = f"con.espnow.handshake"
         # Create an asynchronous sending task.
@@ -302,8 +302,7 @@ class ESPNowSS:
             # Convert 50:02:91:86:34:28 format to b'P\x02\x91\x864(' bytes
             peer = bytes(int(x, 16) for x in peer.split(":"))
         if isinstance(peer, bytes):
-            state = NativeTask().create(callback=self._handshake(peer, task_id), tag=task_id)
-            return {task_id: "Starting"} if state else {task_id: "Already running"}
+            return NativeTask().create(callback=self._handshake(peer, task_id), tag=task_id)
         else:
             return {None: "Invalid MAC address format. Use 50:02:91:86:34:28 or b'P\\x02\\x91\\x864('"}
 
@@ -321,4 +320,19 @@ class ESPNowSS:
             _peers = self.espnow.peers_table
         except Exception as e:
             _peers = str(e)
-        return {"stats": _stats, "peers": _peers, "map": self.devices, "ready": self.server_ready}
+        return {"stats": _stats, "peers": _peers, "ready": self.server_ready}
+    
+    def members(self):
+        return self.devices
+
+    def remove_peer(self, peer:bytes) -> bool:
+        """
+        Remove peer from ESPNow devices
+        :param peer: MAC address as bytes to remove
+        """
+        if isinstance(peer, bytes):
+            if self.devices.pop(peer, None) is not None:
+                self.save_peers()
+                self.espnow.del_peer(peer)
+                return True
+        return False

micrOS/source/InterConnect.py

@@ -1,14 +1,34 @@
+"""
+Module is responsible for device-device communication
+dedicated to micrOS framework.
+Built-in-function:
+- Socket InterConnect interface
+- ESPNow redirection
+
+Designed by 
+    Marcell Ban aka BxNxM
+    Kristof Kasza aka KKristof452
+"""
+
 from socket import getaddrinfo, SOCK_STREAM
-from re import compile
+from re import compile as re_compile
+from json import loads
 from uasyncio import open_connection
+
 from Debug import syslog
 from Config import cfgget
 from Server import Server
 from Tasks import NativeTask
 
+if cfgget('espnow'):
+    from Espnow import ESPNowSS
+else:
+    ESPNowSS = None
+
 
 class InterCon:
-    CONN_MAP = {}
+    CONN_MAP: dict[str, str] = {}   # hostname: IP address pairs
+    NO_ESPNOW: list[str] = []       # disabled ESPNow hostname list (cache for fallback speed-up)
     PORT = cfgget('socport')
 
     def __init__(self):
@@ -19,7 +39,7 @@ class InterCon:
 
     @staticmethod
     def validate_ipv4(str_in):
-        pattern = compile(r'^(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])$')
+        pattern = re_compile(r'^(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])$')
         return bool(pattern.match(str_in))
 
     async def send_cmd(self, host:str, cmd:list):
@@ -34,7 +54,12 @@ class InterCon:
         # Check if host is a hostname (example.local) and resolve its IP address
         if not InterCon.validate_ipv4(host):
             hostname = host
-            # Retrieve IP address by hostname dynamically
+            # Lookup hostname without .domain (sub-hostname matching)
+            if '.' not in hostname:
+                _hosts = list([d for d in InterCon.CONN_MAP if hostname in d])
+                if len(_hosts) > 0:
+                    hostname = _hosts[0]
+            # Retrieve IP address by hostname.domain dynamically
             if InterCon.CONN_MAP.get(hostname, None) is None:
                 try:
                     addr_info = getaddrinfo(host, InterCon.PORT, 0, SOCK_STREAM)
@@ -68,8 +93,7 @@ class InterCon:
                 InterCon.CONN_MAP[hostname] = None if output is None else host
             # None: ServerBusy(or \0) or Prompt mismatch (auto delete cached IP), STR: valid comm. output
             return output
-        else:
-            syslog(f"[ERR][intercon] Invalid host: {host}")
+        syslog(f"[ERR][intercon] Invalid host: {host}")
         return ''
 
     async def __run_command(self, cmd:list, hostname:str):
@@ -85,7 +109,6 @@ class InterCon:
         # Compare prompt |node01 $| with hostname 'node01.local'
         if hostname is None or prompt is None or str(prompt).replace('$', '').strip() == str(hostname).split('.')[0]:
             # Run command on validated device
-            # TODO: Handle multiple cmd as input, separated by ; (????)
             self.writer.write(str.encode(' '.join(cmd)))
             await self.writer.drain()
             data, _ = await self.__receive_data(prompt=prompt)
@@ -109,7 +132,7 @@ class InterCon:
             return True             # AuthOk
         return False                # AuthFailed
 
-    async def __receive_data(self, prompt=None):
+    async def __receive_data(self, prompt=None) -> tuple[str, str]:
         """
         Implements data receive loop until prompt / [configure] / Bye!
         :param prompt: socket shell prompt
@@ -139,8 +162,34 @@ class InterCon:
         data = data.replace(prompt, '').replace('\n', ' ')
         return data, prompt
 
+    async def auto_espnow_handshake(self, host:str) -> dict:
+        """
+        [1] Check espnow.server running on host
+        [2] Get MAC address for host (from system info)
+        [3] Execute ESPNowSS.handshake
+        """
+        response = await self.send_cmd(host, ["task", "list", ">json"])
+        if not response:
+            return {None: f"[ERR] ESPNow auto handshake: task list, {response}"}
+
+        active_tasks = loads(response).get("active")
+        if "espnow.server" in active_tasks:
+            response = await self.send_cmd(host, ["system", "info", ">json"])
+            if not response:
+                return {None: "[ERR] ESPNow auto handshake: system info"}
+            try:
+                host_mac = loads(response).get("mac")
+            except Exception as ex:
+                return {None: f"[ERR] ESPNow auto handshake: {ex}"}
+
+            return ESPNowSS().handshake(host_mac)
+
+        if not InterCon.validate_ipv4(host):
+            InterCon.NO_ESPNOW.append(str(host).split(".")[0])   # host.local -> host
+        return {None: f"ESPNow auto handshake: espnow disabled on host {host}"}
+
 
-async def _send_cmd(host:str, cmd:list, com_obj):
+async def _socket_send_cmd(host:str, cmd:list, com_obj:InterCon) -> None:
     """
     Async send command wrapper for further async task integration and sync send_cmd usage (main)
     :param host: hostname / IP address
@@ -148,21 +197,57 @@ async def _send_cmd(host:str, cmd:list, com_obj):
     :param com_obj: InterCon object to utilize send_cmd method and task status updates
     """
     # Send command
+    for _ in range(0, 2):                           # Retry mechanism
+        out = await com_obj.send_cmd(host, cmd)     # Send CMD
+        if out is not None:                         # Retry mechanism
+            break
+        await com_obj.task.feed(sleep_ms=100)       # Retry mechanism
+    com_obj.task.out = '' if out is None else out
+
+
+async def _send_cmd(host:str, cmd:list|str, com_obj:InterCon):
+    """
+    Top level InterConnect callback function
+        [1] node01.domain -> ESPNow, Socket
+                (domain: .local, .net, etc.)
+        [2] node01 -> ESPNow, Socket fallback in case found in InterConnect cache
+        [3] IP address -> Socket
+    """
     with com_obj.task:
-        for _ in range(0, 4):                           # Retry mechanism
-            out = await com_obj.send_cmd(host, cmd)     # Send CMD
-            if out is not None:                         # Retry mechanism
-                break
-            await com_obj.task.feed(sleep_ms=100)       # Retry mechanism
-        com_obj.task.out = '' if out is None else out
-    return com_obj.task.out
+        if ESPNowSS:
+            # [1] ESPNow Active
+            name = str(host).split(".")[0]   # host.local -> host
+            if name not in InterCon.NO_ESPNOW and name in list(ESPNowSS().devices.values()):
+                com_obj.task.out = "Redirected to ESPNow"
+                if isinstance(cmd, list):
+                    cmd = ' '.join(cmd)
+                # Send command and retrieve result
+                sender = ESPNowSS().send(peer=name, msg=cmd)
+                sender_task = NativeTask.TASKS.get(list(sender.keys())[0])
+                result = await sender_task.await_result(timeout=10)
+                if result != "Timeout has beed exceeded":
+                    # Successful command execution
+                    com_obj.task.out = result                       # Output mirroring: Child -> Parent
+                    sender_task.out = "Redirected to ParentTask"    # Remove redundant data in embedded mode
+                    return
+
+        # Handle legacy string input
+        if isinstance(cmd, str):
+            cmd = cmd.split()
+        # [1][2] Socket send (default and fallback)
+        await _socket_send_cmd(host, cmd, com_obj)
+
+        if ESPNowSS and name not in InterCon.NO_ESPNOW:
+            # [3] Automatic ESPNow handshake
+            verdict = await com_obj.auto_espnow_handshake(host)
+            if list(verdict.keys())[0] is None:
+                syslog(str(list(verdict.values())[0]))
 
 
 def send_cmd(host:str, cmd:list|str) -> dict:
     """
-    Sync wrapper of async _send_cmd (InterCon.send_cmd consumer with retry)
-    :param host: hostname / IP address
-    :param cmd: command string to server socket shell
+    Top level InterConnect send task creation
+        Handles ESPNow and socket communication
     """
     def _tagify():
         nonlocal host, cmd
@@ -171,18 +256,9 @@ def send_cmd(host:str, cmd:list|str) -> dict:
             return f"{'.'.join(host.split('.')[-2:])}.{_mod}"
         return f"{host.replace('.local', '')}.{_mod}"
 
-    # Handle legacy string input
-    if isinstance(cmd, str):
-        cmd = cmd.split()
-
     com_obj = InterCon()
-    tag = f"con.{_tagify()}"
-    started = com_obj.task.create(callback=_send_cmd(host, cmd, com_obj), tag=tag)
-    if started:
-        result = {"verdict": f"Task started: task show {tag}", "tag": tag}
-    else:
-        result = {"verdict": "Task is Busy", "tag": tag}
-    return result
+    task_id = f"con.{_tagify()}"            # CHECK TASK ID CONFLICT
+    return com_obj.task.create(callback=_send_cmd(host, cmd, com_obj), tag=task_id)
 
 
 def host_cache() -> dict:
@@ -190,4 +266,3 @@ def host_cache() -> dict:
     Dump InterCon connection cache
     """
     return InterCon.CONN_MAP
-

micrOS/source/Server.py

@@ -183,12 +183,11 @@ class WebCli(Client, WebEngine):
         :param method: HTTP method name
         :param auto_enable: enable webui when register (endpoint)
         """
-        if method not in WebEngine.METHODS:
-            raise ValueError(f"method must be one of {WebEngine.METHODS}")
-
         if cfgget('webui'):
             if not endpoint in WebEngine.ENDPOINTS:
                 WebEngine.ENDPOINTS[endpoint] = {}
+            if method not in WebEngine.METHODS:
+                raise ValueError(f"method must be one of {WebEngine.METHODS}")
             WebEngine.ENDPOINTS[endpoint][method] = callback
             return
         # AUTO ENABLE webui when register (endpoint) called and webui is False

micrOS/source/Shell.py

@@ -25,7 +25,7 @@ from Debug import syslog
 
 class Shell:
     __slots__ = ['__devfid', '__auth_mode', '__hwuid', '__auth_ok', '__conf_mode']
-    MICROS_VERSION = '2.17.1-0'
+    MICROS_VERSION = '2.20.0-0'
 
     def __init__(self):
         """