micrOSDevToolKit 2.2.0__tar.gz → 2.4.0__tar.gz

{micrOSDevToolKit-2.2.0/micrOSDevToolKit.egg-info → micrOSDevToolKit-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: micrOSDevToolKit
-Version: 2.2.0
+Version: 2.4.0
 Summary: Development and deployment environment for micrOS, the diy micropython automation OS (IoT)
 Home-page: https://github.com/BxNxM/micrOS
 Author: Marcell Ban

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/release_info/micrOS_ReleaseInfo/system_analysis_sum.json

@@ -13,8 +13,8 @@
             1
         ],
         "Server.py": [
-            9.29,
-            4
+            9.38,
+            3
         ],
         "Tasks.py": [
             9.71,
@@ -37,11 +37,15 @@
             2
         ],
         "Types.py": [
-            9.54,
+            9.84,
             22
         ],
+        "Logger.py": [
+            8.33,
+            3
+        ],
         "Common.py": [
-            9.21,
+            9.33,
             26
         ],
         "InterConnect.py": [
@@ -49,7 +53,7 @@
             1
         ],
         "Debug.py": [
-            8.72,
+            8.54,
             20
         ],
         "Network.py": [
@@ -61,7 +65,7 @@
             1
         ],
         "microIO.py": [
-            9.08,
+            9.17,
             38
         ],
         "micrOS.py": [
@@ -77,7 +81,7 @@
             0
         ],
         "urequests.py": [
-            8.9,
+            8.83,
             4
         ],
         "LM_roboarm.py": [
@@ -101,7 +105,7 @@
             3
         ],
         "LM_robustness.py": [
-            7.5,
+            7.57,
             0
         ],
         "LM_co2.py": [
@@ -279,11 +283,11 @@
     },
     "summary": {
         "core": [
-            3108,
-            20
+            3100,
+            21
         ],
         "load": [
-            6930,
+            6927,
             49
         ],
         "core_dep": [
@@ -294,8 +298,8 @@
             true,
             7
         ],
-        "core_score": 9.2,
+        "core_score": 9.17,
         "load_score": 8.07,
-        "version": "2.2.1-0"
+        "version": "2.4.0-0"
     }
 }

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/Common.py

@@ -3,15 +3,15 @@ micrOS Load Module programming API-s
     Designed by Marcell Ban aka BxNxM
 """
 
-from Server import SocketServer
-from Server import WebCli
+from Server import SocketServer, WebCli
+from Debug import errlog_add
+from Logger import logger, log_get
 from microIO import physical_pin
-from Debug import logger, log_get, errlog_add
 from machine import Pin, ADC
 try:
     from Tasks import TaskBase, Manager
-except Exception as e:
-    print(f"Import ERROR, TaskManager: {e}")
+except Exception as ie:
+    print(f"Import ERROR, TaskManager: {ie}")
     TaskBase, Manager = None, None
 TELEGRAM = None
 
@@ -178,10 +178,10 @@ def notify(text):
 def web_endpoint(endpoint, function):
     """
     Add test endpoint <localhost.local>/endpoint from Load Modules
-    Simple:
+    Simple function:
         image/jpeg | text/html | text/plain, <data>
             <data>: binary | string
-    Stream:
+    Stream function:
         multipart/x-mixed-replace | multipart/form-data, <data>
             <data>: {'callback':<func>, 'content-type': image/jpeg | audio/l16;*}
     """

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/Debug.py

@@ -1,7 +1,9 @@
-import os
-from time import localtime
+from os import listdir, remove
 from machine import Pin
-
+try:
+    from Logger import syslog
+except:
+    syslog = None
 try:
     from microIO import physical_pin, pinmap_dump, detect_platform
 except:
@@ -26,11 +28,12 @@ class DebugCfg:
             # Check LogicalPins module loadable (robustness...)
             return
         micro_platform = detect_platform()
-        pled = pinmap_dump('builtin')['builtin']
         if micro_platform == "tinypico":
             # Progress led for TinyPico
             DebugCfg._init_apa102()
-        elif pled is not None:
+            return
+        pled = pinmap_dump('builtin')['builtin']
+        if pled is not None:
             if isinstance(pled, int):
                 # SET PROGRESS LED WITH BUILT-IN step FUNCTION
                 if micro_platform == "esp32s3":
@@ -131,85 +134,6 @@ def console_write(msg):
         except Exception as e:
             errlog_add(f"[ERR] console_write: {e}", console=False)
 
-#############################################
-#        LOGGING WITH DATA ROTATION         #
-#############################################
-
-
-def logger(data, f_name, limit):
-    """
-    Create generic logger function
-    - implements log line rotation
-    - automatic time stump
-    :param data: input string data to log
-    :param f_name: file name to use
-    :param limit: line limit for log rotation
-    return write verdict - true / false
-    INFO: hardcoded max data number = 30
-    """
-    def _logger(_data, _f_name, _limit, f_mode='r+'):
-        _limit = 30 if _limit > 30 else _limit
-        # [1] GET TIME STUMP
-        ts_buff = [str(k) for k in localtime()]
-        ts = ".".join(ts_buff[0:3]) + "-" + ":".join(ts_buff[3:6])
-        # [2] OPEN FILE - WRITE DATA WITH TS
-        with open(_f_name, f_mode) as f:
-            _data = f"{ts} {_data}\n"
-            # read file lines and filter by time stump chunks (hack for replace truncate)
-            lines = [_l for _l in f.readlines() if '-' in _l and '.' in _l]
-            # get file params
-            lines_len = len(lines)
-            lines.append(_data)
-            f.seek(0)
-            # line data rotate
-            if lines_len >= _limit:
-                lines = lines[-_limit:]
-                lines_str = ''.join(lines)
-            else:
-                lines_str = ''.join(lines)
-            # write file
-            f.write(lines_str)
-
-    # Run logger
-    try:
-        # There is file - append 'r+'
-        _logger(data, f_name, limit)
-    except:
-        try:
-            # There is no file - create 'a+'
-            _logger(data, f_name, limit, 'a+')
-        except:
-            return False
-    return True
-
-
-def log_get(f_name, msgobj=None):
-    """
-    Get and stream (ver osocket/stdout) .log file's content and count "critical" errors
-    - critical error tag in log line: [ERR]
-    """
-    err_cnt = 0
-    try:
-        with open(f_name, 'r') as f:
-            eline = f.readline().strip()
-            while eline:
-                # GET error from log line (tag: [ERR])
-                err_cnt += 1 if "[ERR]" in eline else 0
-                # GIVE BACK .log file contents
-                if msgobj is None:
-                    console_write(eline)
-                else:
-                    msgobj(eline)
-                eline = f.readline().strip()
-    except:
-        pass
-    return err_cnt
-
-
-#############################################
-#               ERROR LOGGING               #
-#############################################
-
 
 def errlog_add(data, console=True):
     """
@@ -218,23 +142,18 @@ def errlog_add(data, console=True):
     :return: is ok
     """
     if console:
-        console_write(msg=data)
-    return logger(data, 'err.log', limit=6)
+        console_write(data)
+    return False if syslog is None else syslog(data)
 
 
 def errlog_get(msgobj=None):
-    f_name = 'err.log'
-    errcnt = log_get(f_name, msgobj)
     # Return error number
-    return errcnt
+    return -1 if syslog is None else syslog(msgobj=msgobj)
 
 
 def errlog_clean(msgobj=None):
-    to_del = [file for file in os.listdir() if file.endswith('.log')]
+    to_del = [file for file in listdir() if file.endswith('.log')]
     for _del in to_del:
-        del_msg = f" Delete: {_del}"
-        if msgobj is None:
-            console_write(del_msg)
-        else:
-            msgobj(del_msg)
-        os.remove(_del)
+        if msgobj is not None:
+            msgobj(f" Delete: {_del}")
+        remove(_del)

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_OV2640.py

@@ -233,6 +233,7 @@ def help(widgets=False):
         'SLIDER settings saturation=<0-100>',
         'SLIDER settings brightness=<0-100>',
         'SLIDER settings contrast=<0-100>',
+        'BUTTON settings effect=<NONE,NEG,BW,RED,GREEN,BLUE,RETRO>',
         'capture',
         'photo',
         'set_photo_endpoint',

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_buzzer.py

@@ -320,5 +320,5 @@ def help(widgets=False):
         (widgets=True) list of widget json for UI generation
     """
     return resolve(('BUTTON bipp repeat=3 freq=600',
-                             'play <rtttlstr/title>', 'list_tones',
+                             'TOGGLE play rtttlstr=<Indiana,TakeOnMe,StarWars,MissionImp>', 'list_tones',
                              'load', 'pinmap'), widgets=widgets)

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_cct.py

@@ -352,7 +352,7 @@ def help(widgets=False):
         (widgets=True) list of widget json for UI generation
     """
     return resolve(('WHITE white cw=<0-1000-5> ww smooth=True force=True',
-                             'TOGGLE toggle state=None smooth=True', 'load',
+                             'BUTTON toggle state=<True,False> smooth=True', 'load',
                              'SLIDER brightness percent=<0-100> smooth=True wake=True',
                              'transition cw=None ww=None sec=1.0 wake=False',
                              'hue_transition percent=<0-100> sec=1.0 wake=False',

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_dimmer.py

@@ -232,7 +232,7 @@ def help(widgets=False):
         (widgets=True) list of widget json for UI generation
     """
     return resolve(('SLIDER set_value value=<0-1000> smooth=True force=True',
-                             'BUTTON toggle state=None smooth=True',
+                             'BUTTON toggle state=<True,False> smooth=True',
                              'subscribe_presence',
                              'transition value=<0-1000> sec wake=False',
                              'status', 'load', 'pinmap'), widgets=widgets)

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_keychain.py

@@ -20,7 +20,7 @@ class KC:
     DP_cnt_default = None   # store calculated sequence to sleep 30sec/period_ms
     NEOPIXEL_OBJ = None     # Neopixel LED handler object
     COLOR_WHEEL = None      # LED color wheel generator object for animation
-    NEOPIXEL_BR = 30        # default neopixel brightness
+    NEOPIXEL_BR = 20        # default neopixel brightness
 
 #############################
 #    INTERNAL FUNCTIONS     #
@@ -54,7 +54,7 @@ async def _screen_saver(scale=2):
         show()
 
 
-def _color_wheel():
+def __color_wheel():
     """
     RGB LED color wheel generator - rainbow
     """
@@ -126,7 +126,7 @@ async def _main_page():
     return "Display show"
 
 
-async def _task(period_ms):
+async def _ui_task(period_ms):
     """
     Async display refresh task
     - main page    (main mode)  - auto sleep after 30 sec
@@ -166,7 +166,7 @@ async def _task(period_ms):
                 show()                          #3 show cleaned display
                 KC.DP_cnt = KC.DP_cnt_default   #4 reset sleep counter to default
                 my_task.out = 'sleep...'
-            neopixel_color_wheel()              # update neopixel color wheel
+            color_wheel()              # update neopixel color wheel
 
 
 def _boot_page(msg):
@@ -189,7 +189,7 @@ def load(width=64, height=32, bootmsg="micrOS"):
     :param height: screen height (pixel)
     :param bootmsg: First text on page at bootup, default: "micrOS"
     """
-    KC.COLOR_WHEEL = _color_wheel()             #1 Init neopixel color wheel generator
+    KC.COLOR_WHEEL = __color_wheel()             #1 Init neopixel color wheel generator
     try:
         oled_lni(width, height, brightness=20)  #2 Init oled display
         _boot_page(bootmsg)                     #3 Show boot page text
@@ -207,7 +207,7 @@ def display(period=1000):
     """
     # [!] ASYNC TASK CREATION [1*] with async task callback + taskID (TAG) handling
     period_ms = 500 if period < 500 else period
-    state = micro_task(tag="kc._display", task=_task(period_ms=period_ms))
+    state = micro_task(tag="kc._display", task=_ui_task(period_ms=period_ms))
     return "Starting" if state else "Already running"
 
 
@@ -218,7 +218,7 @@ def temperature():
     return measure()
 
 
-def neopixel_color_wheel(br=None):
+def color_wheel(br=None):
     """
     Neopixel color wheel
     :param br: brightness value 0-100 percent
@@ -236,7 +236,7 @@ def neopixel_color_wheel(br=None):
     else:
         KC.NEOPIXEL_BR = br                         # update neopixel brightness cache
     if KC.COLOR_WHEEL is None:
-        KC.COLOR_WHEEL = _color_wheel()             # init color wheel generator
+        KC.COLOR_WHEEL = __color_wheel()             # init color wheel generator
     # UPDATE
     r, g, b = next(KC.COLOR_WHEEL)                  # get next color
     br = br if br == 100 else br/100                # calculate brightness multiplier
@@ -266,7 +266,7 @@ def neopixel_toggle():
     v = 'disabled' if KC.NEOPIXEL_BR == 0 else 'enabled'
     return f"Neopixel: {v} br: {KC.NEOPIXEL_BR}"
 
-def press_event():
+def button():
     """
     IRQ1 keychain module control function
     - neopixel ON/OFF
@@ -311,8 +311,8 @@ def help(widgets=False):
     """
     return ('load width=64 height=32 bootmsg="micrOS"',
             'temperature', 'display period>=1000',
-            'press_event',
+            'button',
             'display_toggle',
             'neopixel_toggle',
-            'neopixel_color_wheel br=<0-100>',
+            'color_wheel br=<0-100>',
             'pinmap', 'lmdep')

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_neopixel.py

@@ -342,12 +342,12 @@ def help(widgets=False):
         (widgets=False) list of functions implemented by this application
         (widgets=True) list of widget json for UI generation
     """
-    return resolve(('COLOR color r=<0-255> g b smooth=True force=True',
-                             'TOGGLE toggle state smooth=True',
+    return resolve(('COLOR color r=<0-255-5> g b smooth=True force=True',
+                             'BUTTON toggle state=<True,False> smooth=True',
                              'load ledcnt=24',
                              'SLIDER brightness percent=<0-100> smooth=True wake=True',
                              'COLOR segment r g b s=<0-n>',
-                             'transition r=None g=None b=None sec=1.0 wake=False',
+                             'transition r g b sec=1.0 wake=False',
                              'BUTTON random smooth=True max_val=254',
                              'status',
                              'subscribe_presence',

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_oled_ui.py

@@ -643,12 +643,7 @@ def help(widgets=False):
         (widgets=True) list of widget json for UI generation
     """
     return resolve(('pageui page=0 pwr_sec=None/int(sec) oled_type="ssd1306 or sh1106"',
-                             'control next/prev/press/on/off',
-                             'BUTTON control cmd="next"',
-                             'BUTTON control cmd="prev"',
-                             'BUTTON control cmd="press"',
-                             'BUTTON control cmd="on"',
-                             'BUTTON control cmd="off"',
+                             'BUTTON control cmd=<next,prev,press,on,off>',
                              'msgbox "msg"',
                              'intercon_genpage "host" "cmd" run=False',
                              'cmd_genpage "cmd" run=False',

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_rgb.py

@@ -313,8 +313,8 @@ def help(widgets=False):
         (widgets=False) list of functions implemented by this application
         (widgets=True) list of widget json for UI generation
     """
-    return resolve(( 'COLOR color r=<0-1000> g b smooth=True force=True',
-                              'TOGGLE toggle state smooth=True', 'load',
+    return resolve(( 'COLOR color r=<0-1000-10> g b smooth=True force=True',
+                              'BUTTON toggle state=<True,False> smooth=True', 'load',
                               'SLIDER brightness percent=<0-100> smooth=True wake=True',
                               'transition r=None g=None b=None sec=1.0 wake=False',
                               'BUTTON random smooth=True max_val=1000',

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_rgbcct.py

@@ -60,6 +60,6 @@ def help(widgets=False):
         (widgets=True) list of widget json for UI generation
     """
     return resolve(('load',
-                             'BUTTON toggle state smooth=True',
+                             'BUTTON toggle state=<True,False> smooth=True',
                              'SLIDER brightness percent smooth=True wake=True',
                              'status', 'pinmap'), widgets=widgets)

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/LM_robustness.py

@@ -1,5 +1,5 @@
 from LM_system import memory_usage
-from Common import socket_stream
+from Common import socket_stream, syslog
 
 
 @socket_stream
@@ -9,6 +9,7 @@ def raise_error(msgobj=None):
     """
     if msgobj is not None:
         msgobj("Raise test exception")
+    syslog("Raise test exception")
     raise Exception("Test exception")
 
 

micrOSDevToolKit-2.4.0/micrOS/source/Logger.py

@@ -0,0 +1,79 @@
+from time import localtime
+
+#############################################
+#        LOGGING WITH DATA ROTATION         #
+#############################################
+
+
+def logger(data, f_name, limit):
+    """
+    Create generic logger function
+    - implements log line rotation
+    - automatic time stump
+    :param data: input string data to log
+    :param f_name: file name to use
+    :param limit: line limit for log rotation
+    return write verdict - true / false
+    INFO: hardcoded max data number = 30
+    """
+    def _logger(_data, _f_name, _limit, f_mode='r+'):
+        _limit = 30 if _limit > 30 else _limit
+        # [1] GET TIME STUMP
+        ts_buff = [str(k) for k in localtime()]
+        ts = ".".join(ts_buff[0:3]) + "-" + ":".join(ts_buff[3:6])
+        # [2] OPEN FILE - WRITE DATA WITH TS
+        with open(_f_name, f_mode) as f:
+            _data = f"{ts} {_data}\n"
+            # read file lines and filter by time stump chunks (hack for replace truncate)
+            lines = [_l for _l in f.readlines() if '-' in _l and '.' in _l]
+            # get file params
+            lines_len = len(lines)
+            lines.append(_data)
+            f.seek(0)
+            # line data rotate
+            if lines_len >= _limit:
+                lines = lines[-_limit:]
+                lines_str = ''.join(lines)
+            else:
+                lines_str = ''.join(lines)
+            # write file
+            f.write(lines_str)
+
+    # Run logger
+    try:
+        # There is file - append 'r+'
+        _logger(data, f_name, limit)
+    except:
+        try:
+            # There is no file - create 'a+'
+            _logger(data, f_name, limit, 'a+')
+        except:
+            return False
+    return True
+
+
+def log_get(f_name, msgobj=None):
+    """
+    Get and stream (ver osocket/stdout) .log file's content and count "critical" errors
+    - critical error tag in log line: [ERR]
+    """
+    err_cnt = 0
+    try:
+        with open(f_name, 'r') as f:
+            eline = f.readline().strip()
+            while eline:
+                # GET error from log line (tag: [ERR])
+                err_cnt += 1 if "[ERR]" in eline else 0
+                # GIVE BACK .log file contents
+                if msgobj is not None:
+                    msgobj(eline)
+                eline = f.readline().strip()
+    except:
+        pass
+    return err_cnt
+
+
+def syslog(data=None, msgobj=None):
+    if data is None:
+        return log_get('err.log', msgobj)
+    return logger(data, 'err.log', limit=6)

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/Server.py

@@ -18,10 +18,10 @@ from Network import ifconfig
 from Tasks import Manager
 from Shell import Shell
 try:
-    from gc import collect, mem_free
+    from gc import collect
 except:
     console_write("[SIMULATOR MODE GC IMPORT]")
-    from simgc import collect, mem_free
+    from simgc import collect
 
 # Module load optimization, needed only for webui
 if cfgget('webui'):
@@ -107,7 +107,7 @@ class Client:
                 Client.console(f"[Client] Drain error -> close conn: {e}")
                 await self.close()
         else:
-            console_write(f"[Client] NoCon: response>dev/nul")
+            console_write("[Client] NoCon: response>dev/nul")
 
     def send(self, response):
         # Implement in child class - synchronous send method
@@ -177,14 +177,13 @@ class WebCli(Client):
     @staticmethod
     def file_type(path):
         """File dynamic Content-Type handling"""
-        if path.endswith(".html"):
-            return "text/html"
-        elif path.endswith(".css"):
-            return "text/css"
-        elif path.endswith(".js"):
-            return "application/javascript"
-        else:
-            return "text/plain"
+        content_types = {".html": "text/html",
+                         ".css": "text/css",
+                         ".js": "application/javascript"}
+        # Extract the file extension
+        ext = path.rsplit('.', 1)[-1]
+        # Return the content type based on the file extension
+        return content_types.get(f".{ext}", "text/plain")
 
     async def response(self, request):
         """HTTP GET REQUEST - WEB INTERFACE"""
@@ -192,7 +191,7 @@ class WebCli(Client):
         _method, url, _version = request.split('\n')[0].split()
         # Protocol validation
         if _method != "GET" and _version.startswith('HTTP'):
-            _err = f"Bad Request: not GET HTTP/1.1"
+            _err = "Bad Request: not GET HTTP/1.1"
             await self.a_send(self.REQ400.format(len=len(_err), data=_err))
             return
 
@@ -339,10 +338,10 @@ class ShellCli(Client, Shell):
             # Store data in stream buffer
             try:
                 self.writer.write(response.encode('utf8'))
-            except Exception as e:
+            except:
                 # Maintain ACTIVE_CLIS - remove closed connection by peer.
                 Client.drop_client(self.client_id)
-                errlog_add(f"[WARN] ShellCli.send (auto-drop) {self.client_id}: {e}")
+                errlog_add(f"[WARN] ShellCli.send (auto-drop) {self.client_id}")
             # Send buffered data with async task - hacky
             if self.drain_event.is_set():
                 self.drain_event.clear()        # set drain busy (False)

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/Shell.py

@@ -24,7 +24,7 @@ from Debug import errlog_add
 #################################################################
 
 class Shell:
-    MICROS_VERSION = '2.2.1-0'
+    MICROS_VERSION = '2.4.0-0'
 
     def __init__(self):
         """

{micrOSDevToolKit-2.2.0 → micrOSDevToolKit-2.4.0}/micrOS/source/Time.py

@@ -152,10 +152,8 @@ def suntime():
             _, response = http_get(url, sock_size=512, jsonify=True)
             results = response.get('results')
             time_regex = re_comp(r'T([0-9:]+)')
-            sun = {
-                'sunrise': time_regex.search(results.get('sunrise')).group(1).split(':'),
-                'sunset': time_regex.search(results.get('sunset')).group(1).split(':')
-                }
+            sun = {'sunrise': time_regex.search(results.get('sunrise')).group(1).split(':'),
+                   'sunset': time_regex.search(results.get('sunset')).group(1).split(':')}
         except Exception as e:
             errlog_add(f'[ERR] sunrise-api: {e} data: {response}')
     # Try to parse response by expected sun_keys