micrOSDevToolKit 2.9.0__tar.gz → 2.9.4__tar.gz

{microsdevtoolkit-2.9.0/micrOSDevToolKit.egg-info → microsdevtoolkit-2.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: micrOSDevToolKit
-Version: 2.9.0
+Version: 2.9.4
 Summary: Development and deployment environment for micrOS, the diy micropython automation OS (IoT)
 Home-page: https://github.com/BxNxM/micrOS
 Author: Marcell Ban
@@ -107,13 +107,23 @@ I would suggest to use micrOS GUI as a primary interface for micrOS development
 
 <br/>
 
-### 1. Install python3.9+
+## 1. Prerequisites
+
+### 1.1 Install python3.9+
 
 Link for python 3.9+ [download](https://www.python.org/downloads/release/python-390/)
 
 > Note: **Allow extend system path** with that python version (installation parameter) </br>
 > On **Windows**: RUN AS ADMINISTARTOR
 
+### 1.2 Install git
+
+Link for git [download](https://git-scm.com/downloads)
+
+> Git is a distributed version control system that helps developers track changes, collaborate on code, and manage project history efficiently.
+
+It is needed to be able to download webrepl client (automatic), that is used for OverTheAir file transfers and other features.
+
 ----------------------------------------
 
 ### 2. Install micrOS devToolKit GUI
@@ -481,17 +491,20 @@ Version **3.0.0-0**
     Core:
     - Async SSL/TLS integration (micropython 1.22+ required)
         - urequest module async redesign for rest clients
-            - Notify (telegram) + server (listener - chatbot)
+            - LM_telegram (Notify) + server (listener - chatbot)
             - Time (ntp location + sunset/sunrise api)
+    - ESP-NOW (peer-to-peer communication) integration into InterCon
+    - ??? New intercon syntax ???:
+    	- rgb toggle >>RingLight.local
+    	- similar as: intercon sendcmd host="RingLight.local" cmd="rgb toggle"
 ```
 
 Version **3.1.0-0**
 
 ```
     Core:
-    - Async socket SSL/TLS integration (with auth.)
-        - WebCli (http), ShellCli (terminal) and InterCon
-        - Study of ESP-NOW (peer-to-peer communication) integration into InterCon (micropython requirements?)
+    - Async socket servers with SSL/TLS integration (with auth.)
+        - WebCli (https?), ShellCli (ssocket/sterminal) and InterCon
 ```
 
 Version **4.0.0-0**

{microsdevtoolkit-2.9.0 → microsdevtoolkit-2.9.4}/README.md

@@ -79,13 +79,23 @@ I would suggest to use micrOS GUI as a primary interface for micrOS development
 
 <br/>
 
-### 1. Install python3.9+
+## 1. Prerequisites
+
+### 1.1 Install python3.9+
 
 Link for python 3.9+ [download](https://www.python.org/downloads/release/python-390/)
 
 > Note: **Allow extend system path** with that python version (installation parameter) </br>
 > On **Windows**: RUN AS ADMINISTARTOR
 
+### 1.2 Install git
+
+Link for git [download](https://git-scm.com/downloads)
+
+> Git is a distributed version control system that helps developers track changes, collaborate on code, and manage project history efficiently.
+
+It is needed to be able to download webrepl client (automatic), that is used for OverTheAir file transfers and other features.
+
 ----------------------------------------
 
 ### 2. Install micrOS devToolKit GUI
@@ -453,17 +463,20 @@ Version **3.0.0-0**
     Core:
     - Async SSL/TLS integration (micropython 1.22+ required)
         - urequest module async redesign for rest clients
-            - Notify (telegram) + server (listener - chatbot)
+            - LM_telegram (Notify) + server (listener - chatbot)
             - Time (ntp location + sunset/sunrise api)
+    - ESP-NOW (peer-to-peer communication) integration into InterCon
+    - ??? New intercon syntax ???:
+    	- rgb toggle >>RingLight.local
+    	- similar as: intercon sendcmd host="RingLight.local" cmd="rgb toggle"
 ```
 
 Version **3.1.0-0**
 
 ```
     Core:
-    - Async socket SSL/TLS integration (with auth.)
-        - WebCli (http), ShellCli (terminal) and InterCon
-        - Study of ESP-NOW (peer-to-peer communication) integration into InterCon (micropython requirements?)
+    - Async socket servers with SSL/TLS integration (with auth.)
+        - WebCli (https?), ShellCli (ssocket/sterminal) and InterCon
 ```
 
 Version **4.0.0-0**

{microsdevtoolkit-2.9.0 → microsdevtoolkit-2.9.4}/micrOS/release_info/micrOS_ReleaseInfo/system_analysis_sum.json

@@ -13,7 +13,7 @@
             1
         ],
         "Server.py": [
-            9.52,
+            9.5,
             3
         ],
         "Web.py": [
@@ -45,7 +45,7 @@
             29
         ],
         "Logger.py": [
-            8.78,
+            8.75,
             4
         ],
         "Common.py": [
@@ -315,7 +315,7 @@
     },
     "summary": {
         "core": [
-            3275,
+            3274,
             23
         ],
         "load": [
@@ -332,6 +332,6 @@
         ],
         "core_score": 9.06,
         "load_score": 8.22,
-        "version": "2.9.0-0"
+        "version": "2.9.4-0"
     }
 }

{microsdevtoolkit-2.9.0 → microsdevtoolkit-2.9.4}/micrOS/source/Common.py

@@ -210,7 +210,7 @@ def data_logger(f_name, data=None, limit=12, msgobj=None):
 
 def syslog(msg):
     """ Wrapper of errlog_add """
-    return errlog_add(f"[U] {msg}")
+    return errlog_add(f"{msg}")
 
 
 def console(msg):

{microsdevtoolkit-2.9.0 → microsdevtoolkit-2.9.4}/micrOS/source/Logger.py

@@ -6,6 +6,7 @@ Designed by Marcell Ban aka BxNxM
 """
 from time import localtime
 from os import listdir, remove
+from re import match
 
 #############################################
 #        LOGGING WITH DATA ROTATION         #
@@ -66,6 +67,8 @@ def log_get(f_name, msgobj=None):
     """
     err_cnt = 0
     try:
+        if msgobj is not None:
+            msgobj(f_name)
         with open(f_name, 'r') as f:
             eline = f.readline().strip()
             while eline:
@@ -73,7 +76,7 @@ def log_get(f_name, msgobj=None):
                 err_cnt += 1 if "[ERR]" in eline else 0
                 # GIVE BACK .log file contents
                 if msgobj is not None:
-                    msgobj(eline)
+                    msgobj(f"\t{eline}")
                 eline = f.readline().strip()
     except:
         pass
@@ -82,8 +85,13 @@ def log_get(f_name, msgobj=None):
 
 def syslog(data=None, msgobj=None):
     if data is None:
-        return log_get('err.log', msgobj)
-    return logger(data, 'err.log', limit=6)
+        err_cnt = sum([log_get(f, msgobj) for f in listdir() if f.endswith(".sys.log")])
+        return err_cnt
+
+    _match = match(r"^\[([^\[\]]+)\]", data)
+    log_lvl = _match.group(1).lower() if _match else 'user'
+    f_name = f"{log_lvl}.sys.log" if log_lvl in ("err", "warn", "boot") else 'user.sys.log'
+    return logger(data, f_name, limit=4)
 
 
 def log_clean(msgobj=None):

{microsdevtoolkit-2.9.0 → microsdevtoolkit-2.9.4}/micrOS/source/Server.py

@@ -114,7 +114,7 @@ class Client:
             console_write("[Client] NoCon: response>dev/nul")
 
     def send(self, response):
-        # Implement in child class - synchronous send method
+        # Implement in child class - synchronous send (all) method
         pass
 
     async def close(self):
@@ -196,7 +196,9 @@ class ShellCli(Client, Shell):
 
     def send(self, response):
         """
-        Send response to client with non-async function
+        Synchronous send function (with drain task)
+        - not used in Shell or ShellCli
+        - Note: it is a support function for synchronous scenarios: Server.reply_all
         """
         if self.connected:
             if self.prompt() != response:
@@ -219,8 +221,7 @@ class ShellCli(Client, Shell):
 
     async def __wait_for_drain(self):
         """
-        Handle drain serialization
-        - solve output data duplicate
+        Handle drain serialization - for synchronous send function
         """
         try:
             # send write buffer
@@ -233,55 +234,45 @@ class ShellCli(Client, Shell):
         # set drain free
         self.drain_event.set()                  # set drain free (True)
 
-    async def close(self):
-        Client.console(f"[ShellCli] Close connection {self.client_id}")
-        self.send("Bye!\n")
-        # Reset shell state machine
-        self.reset()
-        await asyncio.sleep_ms(50)
-        # Used from Client parent class
-        await super().close()
-
-    async def __shell_cmd(self, request):
+    async def a_send(self, response, encode='utf8'):
         """
-        Handle micrOS shell commands
+        Async send for Shell (new line + prompt$)
         """
-        # Run micrOS shell with request string
-        try:
-            # Handle micrOS shell
-            Client.console("[ShellCli] --- #Run shell")
-            state = self.shell(request)
-            if state:
-                return False      # exit_loop
-            return True           # exit_loop : Close session when shell returns False (auth Failed, etc.)
-        except Exception as e:
-            Client.console(f"[ShellCli] Shell exception: {e}")
-            if "ECONNRESET" in str(e):
-                return True       # exit_loop
-        self.send("[HA] Critical error - disconnect & hard reset")
-        errlog_add("[ERR] Socket critical error - reboot")
-        self.reboot()
+        if self.prompt() != response:
+            # [format] Add new line if not prompt
+            response = f"{response}\n"
+        await super().a_send(response, encode)
 
     async def run_shell(self):
         # Update server task output
         Manager().server_task_msg(','.join(list(Client.ACTIVE_CLIS)))
         # Init prompt
-        self.send(self.prompt())
+        await self.a_send(self.prompt())
         # Run async connection handling
+        _exit = False
         while self.connected:
             try:
                 # Read request msg from client
                 state, request = await self.read()
                 if state:
                     break
-                _exit = await self.__shell_cmd(request)
-                if _exit:
-                    collect()
-                    break
+                # Run micrOS shell with request string
+                Client.console("[ShellCli] --- #Run shell")
+                # Shell -> True (OK) or False (NOK) -> NOK->Close session (auth Failed, etc.)
+                _exit = not await self.shell(request)
             except Exception as e:
-                errlog_add(f"[ERR] handle_client: {e}")
+                errlog_add(f"[ERR] Shell client: {e}")
+                if "ECONNRESET" in str(e):
+                    _exit = True  # exit_loop
+                else:
+                    await self.a_send("[HA] Critical error - disconnect & hard reset")
+                    errlog_add("[ERR] Socket critical error - reboot")
+                    await self.reboot()
+            if _exit:
+                collect()
                 break
         # Close connection
+        await self.a_send("Bye!")
         await self.close()
 
 
@@ -418,7 +409,7 @@ class Server:
         """
         for _, cli in Client.ACTIVE_CLIS.items():
             if cli.connected:
-                cli.send(msg)
+                cli.send(f"~~~ {msg}")
 
     def __del__(self):
         Client.console("[ socket server ] <<destructor>>")

{microsdevtoolkit-2.9.0 → microsdevtoolkit-2.9.4}/micrOS/source/Shell.py

@@ -25,7 +25,7 @@ from Debug import errlog_add
 
 class Shell:
     __slots__ = ['__devfid', '__auth_mode', '__hwuid', '__auth_ok', '__conf_mode']
-    MICROS_VERSION = '2.9.0-0'
+    MICROS_VERSION = '2.9.4-0'
 
     def __init__(self):
         """
@@ -45,10 +45,8 @@ class Shell:
         except Exception as e:
             errlog_add(f"[ERR] micrOS version export failed (config): {e}")
 
-    def send(self, msg):
-        """
-        Must be defined by child class...
-        """
+    async def a_send(self, msg):
+        """ Must be defined by parent class... """
         pass
 
     def reset(self):
@@ -56,44 +54,43 @@ class Shell:
         self.__auth_ok = False
         self.__conf_mode = False
 
-    def reboot(self, hard=False):
-        """Reboot micropython VM"""
-        self.send(f"{'[HARD] ' if hard else ''}Reboot micrOS system.")
-        self.send("Bye!")
+    async def reboot(self, hard=False):
+        """ Reboot micropython VM """
+        await self.a_send(f"{'[HARD] ' if hard else ''}Reboot micrOS system.\nBye!")
         if hard:
             hard_reset()
         soft_reset()
 
     def prompt(self):
-        """Generate prompt"""
+        """ Generate prompt """
         auth = "[password] " if self.__auth_mode and not self.__auth_ok else ""
         mode = "[configure] " if self.__conf_mode else ""
         return f"{auth}{mode}{self.__devfid} $ "
 
-    def __auth(self, msg_list):
-        """Authorize user"""
+    async def __auth(self, msg_list):
+        """ Authorize user """
         # Set user auth state
         if self.__auth_mode and not self.__auth_ok:
             # check password
             usrpwd = cfgget('appwd')
             if usrpwd == msg_list[0].strip():
                 self.__auth_ok = True
-                self.send("AuthOk")
+                await self.a_send("AuthOk")
                 return True, []
-            self.send("AuthFailed\nBye!")
+            await self.a_send("AuthFailed\nBye!")
             return False, []
         return True, msg_list
 
-    def shell(self, msg):
+    async def shell(self, msg):
         """
         micrOS Shell main - input string handling
         :param msg: incoming shell command (command or load module call)
         """
-        state = self.__shell(msg)
-        self.send(self.prompt())
+        state = await self.__shell(msg)
+        await self.a_send(self.prompt())
         return state
 
-    def __shell(self, msg):
+    async def __shell(self, msg):
         """
         Socket server - interpreter shell
         :param msg: socket input string
@@ -118,11 +115,11 @@ class Shell:
         # Hello message
         if msg_list[0] == 'hello':
             # For low level device identification - hello msg
-            self.send(f"hello:{self.__devfid}:{self.__hwuid}")
+            await self.a_send(f"hello:{self.__devfid}:{self.__hwuid}")
             return True
 
         # [!] AUTH
-        state, msg_list = self.__auth(msg_list)
+        state, msg_list = await self.__auth(msg_list)
         if not state:
             return False
         if len(msg_list) == 0:
@@ -131,7 +128,7 @@ class Shell:
         # Version handling
         if msg_list[0] == 'version':
             # For micrOS system version info
-            self.send(str(Shell.MICROS_VERSION))
+            await self.a_send(str(Shell.MICROS_VERSION))
             return True
 
         # Reboot micropython VM
@@ -140,12 +137,12 @@ class Shell:
             if len(msg_list) >= 2 and "-h" in msg_list[1]:
                 # reboot / reboot -h
                 hard = True
-            self.reboot(hard)
+            await self.reboot(hard)
 
         if msg_list[0].startswith('webrepl'):
             if len(msg_list) == 2 and '-u' in msg_list[1]:
-                Shell.webrepl(msg_obj=self.send, update=True)
-            Shell.webrepl(msg_obj=self.send)
+                await Shell.webrepl(msg_obj=self.a_send, update=True)
+            return await Shell.webrepl(msg_obj=self.a_send)
 
         # CONFIGURE MODE STATE: ACCESS FOR NODE_CONFIG.JSON
         if msg_list[0].startswith('conf'):
@@ -157,34 +154,34 @@ class Shell:
 
         # HELP MSG
         if msg_list[0] == "help":
-            self.send("[MICROS]   - built-in shell commands")
-            self.send("   hello   - hello msg - for device identification")
-            self.send("   modules - show active Load Modules")
-            self.send("   version - returns micrOS version")
-            self.send("   exit    - exit from shell socket prompt")
-            self.send("   reboot  - system soft reboot (vm), hard reboot (hw): reboot -h")
-            self.send("   webrepl - start webrepl, for file transfers use with --update")
-            self.send("[CONF] Configure mode - built-in shell commands")
-            self.send("  conf       - Enter conf mode")
-            self.send("    dump       - Dump all data")
-            self.send("    key        - Get value")
-            self.send("    key value  - Set value")
-            self.send("  noconf     - Exit conf mode")
-            self.send("[TASK] postfix: &x - one-time,  &&x - periodic, x: wait ms [x min: 20ms]")
-            self.send("  task list         - list tasks with <tag>s")
-            self.send("  task kill <tag>   - stop task")
-            self.send("  task show <tag>   - show task output")
-            self.send("[EXEC] Command mode (LMs):")
-            self.send("   help lm  - list ALL LoadModules")
+            await self.a_send("[MICROS]   - built-in shell commands")
+            await self.a_send("   hello   - hello msg - for device identification")
+            await self.a_send("   modules - show active Load Modules")
+            await self.a_send("   version - returns micrOS version")
+            await self.a_send("   exit    - exit from shell socket prompt")
+            await self.a_send("   reboot  - system soft reboot (vm), hard reboot (hw): reboot -h")
+            await self.a_send("   webrepl - start webrepl, for file transfers use with --update")
+            await self.a_send("[CONF] Configure mode - built-in shell commands")
+            await self.a_send("  conf       - Enter conf mode")
+            await self.a_send("    dump       - Dump all data")
+            await self.a_send("    key        - Get value")
+            await self.a_send("    key value  - Set value")
+            await self.a_send("  noconf     - Exit conf mode")
+            await self.a_send("[TASK] postfix: &x - one-time,  &&x - periodic, x: wait ms [x min: 20ms]")
+            await self.a_send("  task list         - list tasks with <tag>s")
+            await self.a_send("  task kill <tag>   - stop task")
+            await self.a_send("  task show <tag>   - show task output")
+            await self.a_send("[EXEC] Command mode (LMs):")
+            await self.a_send("   help lm  - list ALL LoadModules")
             if "lm" in str(msg_list):
-                return Shell._show_lm_funcs(msg_obj=self.send)
-            return Shell._show_lm_funcs(msg_obj=self.send, active_only=True)
+                return await Shell._show_lm_funcs(msg_obj=self.a_send)
+            return await Shell._show_lm_funcs(msg_obj=self.a_send, active_only=True)
 
         # [2] EXECUTE:
         # @1 Configure mode
         if self.__conf_mode and len(msg_list) > 0:
             # Lock thread under config handling is threads available
-            return Shell._configure(self.send, msg_list)
+            return await Shell._configure(self.a_send, msg_list)
         # @2 Command mode
         """
         INPUT MSG STRUCTURE
@@ -193,43 +190,43 @@ class Shell:
         """
         try:
             # Execute command via InterpreterCore
-            self.send(lm_exec(arg_list=msg_list)[1])
+            await self.a_send(lm_exec(arg_list=msg_list)[1])
             return True
         except Exception as e:
-            self.send(f"[ERROR] shell.lm_exec internal error: {e}")
+            await self.a_send(f"[ERROR] shell.lm_exec internal error: {e}")
             return False
 
     #################################################################
     #                     CONFIGURE MODE HANDLER                    #
     #################################################################
     @staticmethod
-    def _configure(msg_obj, msg_list):
+    async def _configure(msg_obj, msg_list):
         """
         :param msg_obj: shell output stream function reference (write object)
         :param msg_list: socket input param list
         :return: execution status
         """
-        def dump():
+        async def dump():
             nonlocal msg_obj, msg_list
             if msg_list[0] == 'dump':
                 search = msg_list[1] if len(msg_list) == 2 else None
                 # DUMP DATA
                 for _key, value in cfgget().items():
                     if search is None or search in _key:
-                        msg_obj(f"  {_key}{' ' * (10 - len(_key))}:{' ' * 7} {value}")
+                        await msg_obj(f"  {_key}{' ' * (10 - len(_key))}:{' ' * 7} {value}")
                 return True
             return False
 
         # [CONFIG] Get value
         if len(msg_list) == 1:
-            if dump():                      # Simple dump without param filter
+            if await dump():                      # Simple dump without param filter
                 return True
             # GET SINGLE PARAMETER VALUE
-            msg_obj(cfgget(msg_list[0]))
+            await msg_obj(cfgget(msg_list[0]))
             return True
         # [CONFIG] Set value
         if len(msg_list) >= 2:
-            if dump():                      # Dump with search option
+            if await dump():                      # Dump with search option
                 return True
             # Deserialize params
             key = msg_list[0]
@@ -237,37 +234,38 @@ class Shell:
             try:
                 output = cfgput(key, " ".join(msg_list[1:]), type_check=True)
             except Exception as e:
-                msg_obj(f"node_config write error: {e}")
+                await msg_obj(f"node_config write error: {e}")
                 output = False
             # Evaluation and reply
-            msg_obj('Saved' if output else 'Invalid key' if cfgget(key) is None else 'Failed to save')
+            await msg_obj('Saved' if output else 'Invalid key' if cfgget(key) is None else 'Failed to save')
         return True
 
     #################################################################
     #                   COMMAND MODE & LMS HANDLER                  #
     #################################################################
     @staticmethod
-    def _show_lm_funcs(msg_obj, active_only=False):
+    async def _show_lm_funcs(msg_obj, active_only=False):
         """
         Dump LM modules with functions - in case of [py] files
         Dump LM module with help function call - in case of [mpy] files
         """
-        def _help(mod):
+        async def _help(mod):
             for lm_path in (i for i in mod if i.startswith('LM_') and (i.endswith('py'))):
                 lm_name = lm_path.replace('LM_', '').split('.')[0]
                 try:
-                    msg_obj(f"   {lm_name}")
+                    await msg_obj(f"   {lm_name}")
                     if lm_path.endswith('.mpy'):
-                        msg_obj(f"   {' ' * len(lm_path.replace('LM_', '').split('.')[0])}help")
+                        await msg_obj(f"   {' ' * len(lm_path.replace('LM_', '').split('.')[0])}help")
                         continue
                     with open(lm_path, 'r') as f:
                         line = "micrOSisTheBest"
                         while line:
                             line = f.readline()
-                            if line.strip().startswith('def') and '_' not in line and 'self' not in line:
-                                msg_obj(f"   {' ' * len(lm_name)}{line.replace('def ', '').split('(')[0]}")
+                            ldata = line.strip()
+                            if ldata.startswith('def ') and not ldata.split()[1].startswith("_") and 'self' not in ldata:
+                                await msg_obj(f"   {' ' * len(lm_name)}{ldata.replace('def ', '').split('(')[0]}")
                 except Exception as e:
-                    msg_obj(f"[{lm_path}] SHOW LM PARSER WARNING: {e}")
+                    await msg_obj(f"[{lm_path}] SHOW LM PARSER WARNING: {e}")
                     return False
             return True
 
@@ -275,29 +273,30 @@ class Shell:
         if active_only:
             mod_keys = modules.keys()
             active_modules = (dir_mod for dir_mod in listdir() if dir_mod.split('.')[0] in mod_keys)
-            return _help(active_modules)
+            return await _help(active_modules)
         # [2] list all LMs on file system (ALL - help lm) - manual
-        return _help(listdir())
+        return await _help(listdir())
 
     @staticmethod
-    def webrepl(msg_obj, update=False):
+    async def webrepl(msg_obj, update=False):
         from Network import ifconfig
 
-        msg_obj(" Start micropython WEBREPL - file transfer and debugging")
-        msg_obj("  [i] restart machine shortcut: import reset")
-        msg_obj(f"  Connect over http://micropython.org/webrepl/#{ifconfig()[1][0]}:8266/")
-        msg_obj(f"  \t[!] webrepl password: {cfgget('appwd')}")
+        await msg_obj(" Start micropython WEBREPL - file transfer and debugging")
+        await msg_obj("  [i] restart machine shortcut: import reset")
+        await msg_obj(f"  Connect over http://micropython.org/webrepl/#{ifconfig()[1][0]}:8266/")
+        await msg_obj(f"  \t[!] webrepl password: {cfgget('appwd')}")
         if update:
-            msg_obj(" Restart node then start webrepl...")
-            msg_obj(" Bye!")
+            await msg_obj(" Restart node then start webrepl...")
+            await msg_obj(" Bye!")
             # Set .if_mode->webrepl (start webrepl after reboot and poll update status...)
             with open('.if_mode', 'w') as f:
                 f.write('webrepl')
             hard_reset()
         try:
             import webrepl
-            msg_obj(webrepl.start(password=cfgget('appwd')))
+            await msg_obj(webrepl.start(password=cfgget('appwd')))
         except Exception as e:
             _err_msg = f"[ERR] while starting webrepl: {e}"
-            msg_obj(_err_msg)
+            await msg_obj(_err_msg)
             errlog_add(_err_msg)
+        return True