micrOSDevToolKit 2.1.5__py3-none-any.whl → 2.26.1__py3-none-any.whl

toolkit/dashboard_apps/Template_app.py

@@ -2,22 +2,16 @@
 
 import os
 import sys
-import time
 MYPATH = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(os.path.dirname(MYPATH))
-import socketClient
 sys.path.append(os.path.join(MYPATH, '../lib/'))
 from TerminalColors import Colors
 
-# FILL OUT
-DEVICE = 'node01'
-PASSWD = None
-
-def base_cmd():
-    if PASSWD is None:
-        return ['--dev', DEVICE]
-    return ['--dev', DEVICE, '--password', PASSWD]
+try:
+    from ._app_base import AppBase
+except:
+    from _app_base import AppBase
 
+CLIENT = None
 
 def app(devfid=None, pwd=None):
     """
@@ -25,14 +19,13 @@ def app(devfid=None, pwd=None):
         send command(s) over socket connection [socketClient.run(args)]
         list load module commands and send in single connection
     """
-    global DEVICE, PASSWD
-    if devfid is not None:
-        DEVICE = devfid
-    if pwd is not None:
-        PASSWD = pwd
-    # EDIT YOUR COMMAND
-    args = base_cmd() + ['help', 'version']
-    status, answer = socketClient.run(args)
+    global CLIENT
+    CLIENT = AppBase(device=devfid, password=pwd)
+
+    output = CLIENT.execute(['help', 'version'])
+    status = output[0]
+    result = output[1]
+    print(f"{Colors.WARN}[{status}]{Colors.NC} {result}")
 
 
 if __name__ == "__main__":

toolkit/dashboard_apps/_app_base.py

@@ -0,0 +1,34 @@
+#####################################
+#            APP CONFIG             #
+#####################################
+import os, sys
+MYPATH = os.path.dirname(os.path.abspath(__file__))
+sys.path.append(os.path.dirname(MYPATH))
+import socketClient
+
+class AppBase:
+
+    def __init__(self, device:str, password:str):
+        self.device = device
+        self.password = password
+
+    def base_cmd(self) -> list:
+        if self.password is None:
+            return ['--dev', self.device]
+        return ['--dev', self.device, '--password', self.password]
+
+    def get_device(self):
+        return self.device
+
+    def execute(self, cmd_list, tout=5, verbose=False):
+        cmd_args = self.base_cmd() + cmd_list
+        print(f"Execute: {cmd_args}")
+        return socketClient.run(cmd_args, timeout=tout, verbose=verbose)
+
+    def run(self, cmd_list):
+        """Legacy"""
+        out = self.execute(cmd_list)
+        return out[0], out[1]
+
+    def connection_metrics(self):
+        return socketClient.connection_metrics(f"{self.device}.local")

toolkit/dashboard_apps/_gyro_visualizer.py

@@ -0,0 +1,78 @@
+import matplotlib.pyplot as plt
+import matplotlib.animation as animation
+import multiprocessing as mp
+from collections import deque
+from datetime import datetime
+import matplotlib.dates as mdates
+
+def visualizer_main(queue):
+    # Make figure wider and a bit taller
+    fig, (ax_accel, ax_gyro) = plt.subplots(2, 1, figsize=(14, 8))
+    plt.subplots_adjust(top=0.88, bottom=0.12, hspace=0.3)
+
+    history = 100
+    accel_data = {'x': deque([0] * history, maxlen=history),
+                  'y': deque([0] * history, maxlen=history),
+                  'z': deque([0] * history, maxlen=history)}
+    gyro_data = {'x': deque([0] * history, maxlen=history),
+                 'y': deque([0] * history, maxlen=history),
+                 'z': deque([0] * history, maxlen=history)}
+    time_axis = deque([datetime.now()] * history, maxlen=history)
+
+    # Increase line width here
+    line_width = 2.5
+
+    accel_lines = {
+        axis: ax_accel.plot([], [], label=f'accel_{axis}', linewidth=line_width)[0]
+        for axis in 'xyz'
+    }
+    gyro_lines = {
+        axis: ax_gyro.plot([], [], label=f'gyro_{axis}', linewidth=line_width)[0]
+        for axis in 'xyz'
+    }
+
+    ax_accel.set_ylim(-2, 2)
+    ax_gyro.set_ylim(-300, 300)
+
+    for ax in [ax_accel, ax_gyro]:
+        ax.xaxis.set_major_formatter(mdates.DateFormatter('%H:%M:%S'))
+        ax.legend()
+        ax.grid(True)
+        ax.set_xlabel("Time (H:M:S)")
+
+    ax_accel.set_title("Acceleration")
+    ax_gyro.set_title("Gyroscope")
+
+    def update(_):
+        try:
+            while not queue.empty():
+                data = queue.get_nowait()
+                current_time = datetime.now()
+                time_axis.append(current_time)
+
+                for axis, val in zip('xyz', data['accel']):
+                    accel_data[axis].append(val)
+                for axis, val in zip('xyz', data['gyro']):
+                    gyro_data[axis].append(val)
+        except Exception as e:
+            print(f"Visualizer error: {e}")
+            return
+
+        for axis in 'xyz':
+            accel_lines[axis].set_data(time_axis, accel_data[axis])
+            gyro_lines[axis].set_data(time_axis, gyro_data[axis])
+
+        for ax in [ax_accel, ax_gyro]:
+            ax.set_xlim(time_axis[0], time_axis[-1])
+            ax.figure.autofmt_xdate()
+
+        return list(accel_lines.values()) + list(gyro_lines.values())
+
+    ani = animation.FuncAnimation(fig, update, interval=50)
+    plt.show()
+
+
+if __name__ == "__main__":
+    mp.set_start_method('spawn')
+    queue = mp.Queue()
+    visualizer_main(queue)

toolkit/dashboard_apps/uLightDemo.py

@@ -4,28 +4,23 @@ import os
 import sys
 import time
 MYPATH = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(os.path.dirname(MYPATH))
-import socketClient
 sys.path.append(os.path.join(MYPATH, '../lib/'))
 from TerminalColors import Colors
 
-# FILL OUT
-DEVICE = 'node01'
-
-
-def base_cmd():
-    return ['--dev', DEVICE]
+try:
+    from ._app_base import AppBase
+except:
+    from _app_base import AppBase
 
+CLIENT = None
 
 def light_demo(modules, smooth=True, sample=10):
     verdict = [True, []]
     smooth_str = '[smooth]' if smooth else '[simple]'
 
-    if 'LM_rgb' in modules:
-        args = base_cmd() + [f'rgb random {smooth}'] * sample + ['rgb toggle False']
-        print(args)
+    if 'rgb' in modules:
         delta_t = time.time()
-        status_rgb, answer_rgb = socketClient.run(args)
+        status_rgb, answer_rgb =  CLIENT.run([f'rgb random {smooth}'] * sample + ['rgb toggle False'])
         delta_t = round((time.time() - delta_t) / sample, 2)
         if status_rgb:
             msg = f"{smooth_str} rgb module random color func: {Colors.OK}OK{Colors.NC} [{delta_t}sec]"
@@ -35,10 +30,9 @@ def light_demo(modules, smooth=True, sample=10):
             verdict[1].append(msg)
             verdict[0] &= False
 
-    if 'LM_cct' in modules:
-        args = base_cmd() + [f'cct random {smooth}'] * sample + ['cct toggle False']
+    if 'cct' in modules:
         delta_t = time.time()
-        status_cct, answer_cct = socketClient.run(args)
+        status_cct, answer_cct =  CLIENT.run([f'cct random {smooth}'] * sample + ['cct toggle False'])
         delta_t = round((time.time() - delta_t) / sample, 2)
         if status_cct:
             msg = f"{smooth_str} cct module random color func: {Colors.OK}OK{Colors.NC} [{delta_t}sec]"
@@ -48,10 +42,9 @@ def light_demo(modules, smooth=True, sample=10):
             verdict[1].append(msg)
             verdict[0] &= False
 
-    if 'LM_neopixel' in modules:
-        args = base_cmd() + [f'neopixel random {smooth}'] * sample + ['neopixel toggle False']
+    if 'neopixel' in modules:
         delta_t = time.time()
-        status_neo, answer_neo = socketClient.run(args)
+        status_neo, answer_neo = CLIENT.run([f'neopixel random {smooth}'] * sample + ['neopixel toggle False'])
         delta_t = round((time.time() - delta_t) / sample, 2)
         if status_neo:
             msg = f"{smooth_str} neopixel module random color func: {Colors.OK}OK{Colors.NC} [{delta_t}sec]"
@@ -63,19 +56,17 @@ def light_demo(modules, smooth=True, sample=10):
     return verdict
 
 
-def app(devfid=None):
+def app(devfid=None, pwd=None):
     """
     devfid: selected device input
         send command(s) over socket connection [socketClient.run(args)]
         list load module commands and send in single connection
     """
-    global DEVICE
-    if devfid is not None:
-        DEVICE = devfid
+    global CLIENT
+    CLIENT = AppBase(device=devfid, password=pwd)
 
     # Get loaded modules
-    args = base_cmd() + ['lmpacman module']
-    status, modules = socketClient.run(args)
+    status, modules = CLIENT.run(['modules'])
     print("status: {}\nanswer: {}".format(status, modules))
 
     if not status:

toolkit/index.html

@@ -11,15 +11,15 @@
             50% {background-position: 100% 50%;}
             100% {background-position: 0% 50%;}}
         body {
-            height: 400vh;
-            width: 200vh;
+            height: calc(100vh - 6%); /* Set the height to 100% of the viewport height */
+            width: calc(100vw - 6%); /* Set the width to 200% of the viewport height */
             padding: env(safe-area-inset-top) env(safe-area-inset-right) env(safe-area-inset-bottom) env(safe-area-inset-left);
-            margin: 40px;
+            margin: 3%;
             background: linear-gradient(110deg, #720000, #656565, #252525);
             background-size: 400% 400%;
             animation: backgroundAnimation 20s infinite;
             color: #d9d9d9;
-            font-family: 'Arial', sans-serif;
+            font-family: 'Verdana', Sans-serif;
         }
         button {
             background-color: #e7e7e7; /* Gray */
@@ -40,7 +40,7 @@
     <h1> micrOS GATEWAY </h1>
     <!-- Display micrOSDevices output -->
     <p id="micrOSDevices"></p>
-    <p> micrOS gateway <b>v2.0</b> </p>
+    <p> micrOS gateway <b>v2.1</b> </p>
     <p> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/list &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; List known devices, sort by online/offline </p>
     <p> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/search &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Search devices </p>
     <p> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/status &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Get all device status - node info </p>
@@ -49,6 +49,7 @@
     <p> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/image/&lt;device&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Get esp camera image over gateway (without device param endpoint lists cameras)</p>
     <p> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/imgstream&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Get esp camera image stream (with camera endpoint detection)</p>
     <p> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/webhooks/&lt;payload&gt;/&lt;args&gt &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Webhook for micrOS Gateway. Payload: name of the script. Args: optional script args </p>
+    <p> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/webhooks/macro/&lt;macroName&gt &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Webhook/macro for micrOS Gateway. macroName: macro to call </p>
 
     <div id="camera_stream_link">Camera stream link</div>
 

toolkit/lib/LocalMachine.py

@@ -186,11 +186,13 @@ class FileHandler:
                     os.remove(path)
                 elif type_ == 'd':
                     shutil.rmtree(path)
+                return True
         except Exception as e:
             if ignore:
                 debug_print("[DEBUG] Removing " + path + " is forced to ignore failure: " + str(e))
             else:
                 raise Exception("Cannot remove " + path + ": " + str(e))
+        return False
 
     @staticmethod
     def extract_tar(targz, extract_path):
@@ -210,7 +212,10 @@ class FileHandler:
     def copy(from_path, to_path):
         debug_print("[DEBUG] Copy " + from_path + " to " + to_path)
         try:
-            shutil.copy(from_path, to_path)
+            if os.path.isdir(from_path):
+                shutil.copytree(from_path, to_path, dirs_exist_ok=True)
+            else:
+                shutil.copy(from_path, to_path)
             return True
         except Exception as e:
             debug_print("Copy error: {}".format(e))

toolkit/lib/MicrosFiles.py

@@ -0,0 +1,46 @@
+import os
+
+try:
+    from . import LocalMachine
+except Exception as e:
+    print("Import warning __name__:{}: {}".format(__name__, e))
+    import LocalMachine
+
+PYTHON_EXTENSIONS = ('py', 'mpy')
+WEB_ONLY = ('js', 'html', 'css', 'json', 'ico', 'jpeg', 'png')
+ENABLED_EXTENSIONS = PYTHON_EXTENSIONS + WEB_ONLY
+
+def check_all_extensions(path):
+    extension = path.split('.')[-1]
+    if extension in ENABLED_EXTENSIONS:
+        return True
+    return False
+
+def check_web_extensions(path):
+    extension = path.split('.')[-1]
+    if extension in WEB_ONLY:
+        return True
+    return False
+
+def check_python_extensions(path):
+    extension = path.split('.')[-1]
+    if extension in PYTHON_EXTENSIONS:
+        return True
+    return False
+
+def micros_resource_list(root_folder):
+    resources_path = []
+    subfolders = []
+    for source in LocalMachine.FileHandler.list_dir(root_folder):
+        source_full_path = os.path.join(root_folder, source)
+        # [1] / Root directory source files and folders.
+        if check_all_extensions(source):
+            resources_path.append(source_full_path)
+        # [2] /dir Handle sub dictionary sources
+        elif LocalMachine.FileHandler.path_is_exists(source_full_path)[1] == 'd':
+            subfolders.append(source)
+            for sub_source in LocalMachine.FileHandler.list_dir(source_full_path):
+                sub_source_full_path = os.path.join(source_full_path, sub_source)
+                if check_all_extensions(sub_source):
+                    resources_path.append(sub_source_full_path)
+    return resources_path, subfolders

toolkit/lib/Repository.py

@@ -0,0 +1,64 @@
+import requests
+import zipfile
+import io
+import os
+
+try:
+    from .LocalMachine import CommandHandler
+except:
+    from LocalMachine import CommandHandler
+
+
+def git_clone_archive(url):
+    """
+    Clone git repo as archive (without git installed)
+    Note: No git history, it is just a snapshot
+    :param url: https://github.com/micropython/webrepl
+    """
+    print(f"CLONE ARCHIVE: {url}")
+    url = url.replace(".git", "") if url.endswith(".git") else url
+    # URL of the repository zip archive (adjust branch name if needed)
+    target_name = url.split("/")[-1].strip()
+    zip_url = f"{url}/archive/refs/heads/master.zip"
+    response = requests.get(zip_url)
+    if response.status_code == 200:
+        # Read the downloaded content as a binary stream
+        with zipfile.ZipFile(io.BytesIO(response.content)) as z:
+            for member in z.infolist():
+                # Each member's filename is something like 'webrepl-master/filename'
+                # Remove the first directory component
+                parts = member.filename.split('/', 1)
+                if len(parts) > 1:
+                    relative_path = parts[1]
+                else:
+                    relative_path = parts[0]
+
+                # Build the target path relative to the current directory
+                target_path = os.path.join(target_name, relative_path)
+
+                if member.is_dir():
+                    os.makedirs(target_path, exist_ok=True)
+                else:
+                    os.makedirs(os.path.dirname(target_path), exist_ok=True)
+                    with z.open(member) as source, open(target_path, 'wb') as target_file:
+                        target_file.write(source.read())
+        print(f"\tRepository extracted successfully: {target_name}")
+        return 0, zip_url, ""
+    print(f"\tFailed to download repository archive: {target_name}")
+    return 1, zip_url, ""
+
+
+def git_clone(url):
+    """
+    Git clone - subshell call
+    - git is needed to be preinstalled
+    """
+    print(f"GIT CLONE: {url}")
+    target_name = url.split("/")[-1].strip().replace(".git", "")
+    command = 'git clone {url} {name}'.format(name=target_name, url=url)
+    exitcode, stdout, stderr = CommandHandler.run_command(command, shell=True)
+    if exitcode == 0:
+        print(f"\tRepository was cloned successfully: {target_name}")
+    else:
+        print(f"\tRepository clone failed: {target_name}")
+    return exitcode, stdout, stderr

toolkit/lib/TerminalColors.py

@@ -16,6 +16,8 @@ class Colors:
         OKGREEN = '\033[92m'
         HEADER = '\033[95m'
         UNDERLINE = '\033[4m'
+        LIGHT_GRAY = '\033[37m'
+        GRAY = '\033[90m'
     else:
         NC = ''
         OK = ''
@@ -26,6 +28,8 @@ class Colors:
         OKGREEN = ''
         HEADER = ''
         UNDERLINE = ''
+        LIGHT_GRAY = ''
+        GRAY = ''
 
 
 if __name__ == "__main__":