micrOSDevToolKit 2.9.8__py3-none-any.whl → 2.9.11__py3-none-any.whl

micrOS/release_info/micrOS_ReleaseInfo/system_analysis_sum.json

@@ -1,11 +1,11 @@
 {
     "files": {
         "Time.py": [
-            9.17,
+            9.16,
             7
         ],
         "micrOSloader.py": [
-            8.0,
+            7.33,
             1
         ],
         "Hooks.py": [
@@ -33,11 +33,11 @@
             0
         ],
         "Shell.py": [
-            9.33,
+            9.11,
             1
         ],
         "Notify.py": [
-            8.38,
+            8.46,
             3
         ],
         "Types.py": [
@@ -89,7 +89,7 @@
             0
         ],
         "urequests.py": [
-            9.02,
+            8.99,
             5
         ],
         "LM_roboarm.py": [
@@ -109,7 +109,7 @@
             0
         ],
         "LM_oled_ui.py": [
-            9.07,
+            9.02,
             0
         ],
         "LM_system.py": [
@@ -129,7 +129,7 @@
             0
         ],
         "LM_oled.py": [
-            9.23,
+            9.09,
             4
         ],
         "LM_tinyrgb.py": [
@@ -165,7 +165,7 @@
             0
         ],
         "LM_oled_sh1106.py": [
-            8.84,
+            8.54,
             2
         ],
         "LM_haptic.py": [
@@ -177,7 +177,7 @@
             0
         ],
         "LM_neopixel.py": [
-            7.54,
+            7.43,
             2
         ],
         "LM_cct.py": [
@@ -229,11 +229,11 @@
             0
         ],
         "LM_sound_event.py": [
-            8.49,
+            8.46,
             0
         ],
         "LM_oledui.py": [
-            8.52,
+            8.16,
             0
         ],
         "LM_espnow.py": [
@@ -245,11 +245,11 @@
             0
         ],
         "LM_OV2640.py": [
-            9.19,
+            9.11,
             0
         ],
         "LM_rgb.py": [
-            8.82,
+            8.75,
             1
         ],
         "LM_distance.py": [
@@ -273,7 +273,7 @@
             4
         ],
         "LM_trackball.py": [
-            8.43,
+            8.31,
             1
         ],
         "LM_dashboard_be.py": [
@@ -305,7 +305,7 @@
             2
         ],
         "LM_i2s_mic.py": [
-            8.37,
+            8.3,
             2
         ],
         "LM_sdcard.py": [
@@ -315,11 +315,11 @@
     },
     "summary": {
         "core": [
-            3358,
+            3367,
             23
         ],
         "load": [
-            9061,
+            9087,
             55
         ],
         "core_dep": [
@@ -328,10 +328,10 @@
         ],
         "load_dep": [
             true,
-            6
+            5
         ],
-        "core_score": 9.13,
-        "load_score": 8.23,
-        "version": "2.9.8-0"
+        "core_score": 9.09,
+        "load_score": 8.21,
+        "version": "2.9.9-0"
     }
 }

micrOS/source/LM_espnow.py

@@ -1,23 +1,49 @@
 import Espnow
 
 def load():
+    """
+    Initialize ESPNOW protocal
+    """
     return Espnow.initialize()
 
-def send(peer, msg='ping'):
+def send(peer, msg='modules'):
+    """
+    Send message to peer (by mac address)
+    :param peer: mac address of espnow device
+    :param msg: message string/load module call
+    """
     return Espnow.espnow_send(peer, msg)
 
 def start_server():
+    """
+    Start ESPNOW server/listener
+    - this can receive espnow messages
+    - it includes Load Module execution logic (beta)
+    """
     return Espnow.espnow_server()
 
 def stats():
+    """
+    Get ESPNOW stats
+    """
     return Espnow.stats()
 
 def add_peer(peer):
+    """
+    Add ESPNOW peer to known hosts
+    - It is needed before first send(...)
+    """
     now = Espnow.initialize()
     return Espnow.add_peer(now, peer)
 
 def mac_address():
+    """
+    Get ESPNOW compatible mac address
+    """
     return Espnow.mac_address()
 
 def help():
+    """
+    [beta] ESPNOW sender/receiver with LM execution
+    """
     return 'load', 'send <peer> "ping"', 'start_server', 'add_peer <peer>', 'stats', 'mac_address'

micrOS/source/LM_oled_ui.py

@@ -159,7 +159,7 @@ class PageUI:
             if pin:
                 pin_obj = Pin(pin, Pin.IN, Pin.PULL_DOWN)
                 # [IRQ] - event type setup
-                pin_obj.irq(trigger=Pin.IRQ_RISING, handler=callback)
+                pin_obj.irq(trigger=Pin.IRQ_FALLING, handler=callback)
 
         _set("js_right", lambda pin: self.control('next'))
         _set("js_left", lambda pin: self.control('prev'))

micrOS/source/LM_system.py

@@ -124,18 +124,18 @@ def sun(refresh=False):
     return Sun.TIME
 
 
-def setclock(year, month, mday, hour, min, sec):
+def setclock(year, month, mday, hour, minute, sec):
     """
     Set Localtime + RTC Clock manually
     :param year
     :param month
     :param mday
     :param hour
-    :param min
+    :param minute
     :param sec
     :return: localtime
     """
-    set_time(year, month, mday, hour, min, sec)
+    set_time(year, month, mday, hour, minute, sec)
     return localtime()
 
 
@@ -242,7 +242,7 @@ def help(widgets=False):
         (widgets=True) list of widget json for UI generation
     """
     return resolve(('info', 'TEXTBOX top', 'gclean', 'heartbeat', 'clock',
-                    'setclock year month mday hour min sec',
+                    'setclock year month mday hour minute sec',
                     'ntp', 'rssi', 'list_stations', 'pinmap key="dhtpin"/None', 'alarms clean=False',
                     'notifications enable=<None,True,False>',
                     'sun refresh=False', 'ifconfig', 'memory_usage',

micrOS/source/Notify.py

@@ -32,6 +32,10 @@ class Notify:
             return True
         raise Exception("Subscribe error, Notify parent missing")
 
+    @staticmethod
+    def send_msg(text, reply_to=None, chat_id=None):
+        raise NotImplementedError("Child class must implement send_msg method")
+
     @staticmethod
     def message(text, reply_to=None, chat_id=None):
         """

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 (all) method
+        # Optional - Implement in child class - synchronous send (all) method
         pass
 
     async def close(self):

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.8-0'
+    MICROS_VERSION = '2.9.9-0'
 
     def __init__(self):
         """
@@ -46,8 +46,8 @@ class Shell:
             errlog_add(f"[ERR] micrOS version export failed (config): {e}")
 
     async def a_send(self, msg):
-        """ Must be defined by parent class... """
-        pass
+        """ Must be defined by child class... """
+        raise NotImplementedError("Child class must implement a_send method")
 
     def reset(self):
         """Reset shell state"""

micrOS/source/Tasks.py

@@ -415,7 +415,7 @@ class Manager:
 #################################################################
 def exec_builtins(func):
     """
-    Module execution built-in commands and modifiers
+    [Decorator] Module execution built-in commands and modifiers
     - modules         - show active modules list
     - task kill ...   - task termination
            show ...   - task output dump

micrOS/source/Time.py

@@ -24,17 +24,17 @@ class Sun:
     BOOTIME = None       # Initialize BOOTIME: Not SUN, but for system uptime
 
 
-def set_time(year, month, mday, hour, min, sec):
+def set_time(year, month, mday, hour, minute, sec):
     """
     Set Localtime + RTC Clock manually + update BOOTIME/uptime
         https://docs.micropython.org/en/latest/library/machine.RTC.html
     """
     # Make time from tuple to sec
-    time_sec = mktime((year, month, mday, hour, min, sec, 0, 0))
+    time_sec = mktime((year, month, mday, hour, minute, sec, 0, 0))
     # Set localtime
     localtime(time_sec)
     # Set RTC
-    RTC().datetime((year, month, mday, 0, hour, min, sec, 0))
+    RTC().datetime((year, month, mday, 0, hour, minute, sec, 0))
     # (re)set uptime when settime - normally at boot time
     if Sun.BOOTIME is None:
         Sun.BOOTIME = time()
@@ -95,19 +95,18 @@ def __sun_cache(mode):
     """
     if mode == 's':
         # SAVE CACHE
-        temp = {}
         try:
             with open('sun.pds', 'w') as f:
-                for k, v in Sun.TIME.items():
-                    temp[k] = tuple([str(t) for t in v])
-                f.write(';'.join([f'{k}:{"-".join(v)}' for k, v in temp.items()]))
+                cache = {k:tuple([str(t) for t in v]) for k, v in Sun.TIME.items()}
+                f.write(';'.join([f'{k}:{"-".join(v)}' for k, v in cache.items()]))
         except:
             errlog_add("[ERR] Cannot write sun cache")
         return
     try:
         # RESTORE CACHE
         with open('sun.pds', 'r') as f:
-            buff = {data.split(':')[0]: data.split(':')[1].split('-') for data in f.read().strip().split(';')}
+            buff = {data.split(':')[0]: data.split(':')[1].split('-')
+                    for data in f.read().strip().split(';')}
             for k, v in buff.items():
                 Sun.TIME[k] = tuple([int(e) for e in v])
     except:

micrOS/source/micrOSloader.py

@@ -79,7 +79,6 @@ def __recovery_mode():
         reset()
 
 
-
 def __auto_restart_event():
     """
     Poll .if_mode value main loop in case of webrepl (background) mode:

micrOS/source/urequests.py

@@ -116,7 +116,7 @@ def _parse_response(response):
 #          micropython HTTP request         #
 #############################################
 
-def request(method, url, data=None, json=None, headers=None, sock_size=256, jsonify=False):
+def request(method:str, url:str, data:str=None, json=None, headers:dict=None, sock_size=256, jsonify=False):
     """
     Micropython syncronous HTTP request function for REST API handling
     :param method: GET/POST
@@ -181,7 +181,7 @@ def request(method, url, data=None, json=None, headers=None, sock_size=256, json
 #       async micropython HTTP request      #
 #############################################
 
-async def arequest(method, url, data=None, json=None, headers=None, sock_size=256, jsonify=False):
+async def arequest(method:str, url:str, data:str=None, json=None, headers:dict=None, sock_size=256, jsonify=False):
     """
     Micropython asynchronous HTTP request function for REST API handling
     :param method: GET/POST
@@ -221,7 +221,12 @@ async def arequest(method, url, data=None, json=None, headers=None, sock_size=25
     except Exception as e:
         status_code = 500
         # https://github.com/micropython/micropython/blob/8785645a952c03315dbf93667b5f7c7eec49762f/cc3200/simplelink/include/device.h
-        body = "[WARN] arequest ASSOC_REJECT" if "-104" == str(e) else f"[ERR] arequest failed: {e}"
+        if "-104" == str(e):
+            body = "[WARN] arequest: ASSOC_REJECT"
+        elif "ECONNABORTED" in str(e):
+            body = f"[WARN] arequest: {e}"
+        else:
+            body = f"[ERR] arequest: {e}"
         errlog_add(body)
     finally:
         if writer:
@@ -234,14 +239,16 @@ async def arequest(method, url, data=None, json=None, headers=None, sock_size=25
 #      Implement http get/post functions    #
 #############################################
 
-def get(url, headers={}, sock_size=256, jsonify=False):
+def get(url:str, headers:dict=None, sock_size=256, jsonify=False):
     """
     GENERIC HTTP GET FUNCTION
     """
+    if headers is None:
+        headers = {}
     return request('GET', url, headers=headers, sock_size=sock_size, jsonify=jsonify)
 
 
-def post(url, data=None, json=None, headers={}, sock_size=256, jsonify=False):
+def post(url:str, data=None, json=None, headers:dict=None, sock_size=256, jsonify=False):
     """
     GENERIC HTTP POST FUNCTION
     :param data: string body (handle bare string as data for POST method)
@@ -250,14 +257,14 @@ def post(url, data=None, json=None, headers={}, sock_size=256, jsonify=False):
     return request('POST', url, data=data, json=json, headers=headers, sock_size=sock_size, jsonify=jsonify)
 
 
-async def aget(url, headers={}, sock_size=256, jsonify=False):
+async def aget(url:str, headers:dict=None, sock_size=256, jsonify=False):
     """
     GENERIC ASYNC HTTP GET FUNCTION
     """
     return await arequest('GET', url, headers=headers, sock_size=sock_size, jsonify=jsonify)
 
 
-async def apost(url, data=None, json=None, headers={}, sock_size=256, jsonify=False):
+async def apost(url, data=None, json=None, headers:dict=None, sock_size=256, jsonify=False):
     """
     GENERIC ASYNC HTTP POST FUNCTION
     :param data: string body (handle bare string as data for POST method)

{micrOSDevToolKit-2.9.8.data → micrOSDevToolKit-2.9.11.data}/scripts/devToolKit.py

@@ -35,6 +35,11 @@ try:
 except Exception as e:
     print(f"Optional dependency missing in macroScript: {e}")
     macroScript = None
+try:
+    from toolkit.WebRepl import open_webrepl
+except Exception as e:
+    print(f"Optional dependency missing in WebRepl: {e}")
+    open_webrepl = None
 
 
 def arg_parse():
@@ -70,6 +75,7 @@ def arg_parse():
     dev_group.add_argument("-gw", "--gateway", action="store_true", help="Start micrOS Gateway rest-api server, Env. vars: API_AUTH='username:password' (optional), GATEWAYIP needed for container deployment only.")
     dev_group.add_argument("-v", "--version", action="store_true", help="Get micrOS version - repo + connected device.")
     dev_group.add_argument("-lint", "--linter", action="store_true", help="Run micrOS system linter (pylint+)")
+    dev_group.add_argument("-webrepl", "--open_webrepl", action="store_true", help="(beta) Open webrepl in default browser, micropython repl + file transfers (built-in)")
     dev_group.add_argument("--light", action="store_true", help="Skip optional dependency deployments (low level param: add this as first argument always)")
 
     toolkit_group = parser.add_argument_group("Toolkit development")
@@ -293,6 +299,10 @@ if __name__ == "__main__":
         if micrOSlint is not None:
             sys.exit(micrOSlint.main(verbose=False))
 
+    if cmd_args.open_webrepl:
+        if open_webrepl is not None:
+            open_webrepl()
+
     if cmd_args.macro:
         if macroScript is None:
             print("macroScript not available :(")

{micrOSDevToolKit-2.9.8.dist-info → micrOSDevToolKit-2.9.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: micrOSDevToolKit
-Version: 2.9.8
+Version: 2.9.11
 Summary: Development and deployment environment for micrOS, the diy micropython automation OS (IoT)
 Home-page: https://github.com/BxNxM/micrOS
 Author: Marcell Ban
@@ -19,12 +19,21 @@ Requires-Dist: pylint
 Requires-Dist: pyserial
 Requires-Dist: resources
 Requires-Dist: flask
-Requires-Dist: flask-restful
+Requires-Dist: flask_restful
 Requires-Dist: numpy
 Requires-Dist: json2html
 Requires-Dist: requests
 Requires-Dist: Flask-BasicAuth
 Requires-Dist: soundfile
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
 
 # ![LOGO](./media/logo_mini.png?raw=true) micrOS
 
@@ -78,6 +87,7 @@ Access rest api over browser: `http://<nodename>.local`
 2. micrOS Installer [link](https://github.com/BxNxM/micrOS/#installing-micros-with-devtoolkit-esp32-and-more)
 3. micrOS Tutorials [link](https://github.com/BxNxM/micrOS/#micros-video-tutorials)
 4. micrOS System and features [link](https://github.com/BxNxM/micrOS/#micros-framework-features)
+5. Built-in app modules: [link](https://htmlpreview.github.io/?https://github.com/BxNxM/micrOS/blob/master/micrOS/client/sfuncman/sfuncman.html)
 5. Pin mapping - GPIO [link](https://github.com/BxNxM/micrOS/#device-pinouts-for-wiring)
 6. micrOS Node configuration [link](https://github.com/BxNxM/micrOS/#micros-node-configuration-parameters-with-description)
 7. micrOS create custom Load Modules: [link](./APPLICATION_GUIDE.md)
@@ -116,14 +126,6 @@ Link for python 3.9+ [download](https://www.python.org/downloads/release/python-
 > 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
@@ -370,7 +372,7 @@ LogicalPin lookup tables:
 - [raspberryPicoW](./micrOS/source/IO_rp2.py) - reset needed after ota update (webrepl limitation)
 - `IO_*.py` [etc.](./micrOS/source)
 
-> Note: Good idea to use costant variable for pin map declaration, check the files for more info, These files are also precompiled automatically into byte steams -> `.mpy`
+> Note: Good idea to use costant variable for pin map declaration, check the files for more info, These files are also precompiled automatically into byte streams -> `.mpy`
 
 ![MicrOStinyPicopinout](./media/NodeMCUPinOutTinyPico.png?raw=true)
 
@@ -485,29 +487,71 @@ Official [DockerHub](https://hub.docker.com/repository/docker/bxnxm/micros-gatew
 
 ## FUTURE RELEASE PLANS
 
-Version **3.0.0-0**
+Version **3.0.0-0** `micrOS-Autonomous`
 
 ```
     Core:
-    - Async SSL/TLS integration (micropython 1.22+ required)
-        - urequest module async redesign for rest clients
-            - LM_telegram (Notify) + server (listener - chatbot)
-            - Time (ntp location + sunset/sunrise api)
-    - ESP-NOW (peer-to-peer communication) integration into InterCon
-    - ??? New intercon syntax ???:
+    - (1) Async SSL/TLS integration (micropython 1.22+ required)                [DONE]
+        - urequest module async redesign for rest clients                       [OK]
+            - LM_telegram (Notify) + server (listener - chatbot)                [OK]
+    - (2) ESP-NOW (peer-to-peer communication) integration into InterCon        [PoC][TODO]
+    - (3) New intercon syntax - command level integration:                      [TODO]
     	- rgb toggle >>RingLight.local
     	- similar as: intercon sendcmd host="RingLight.local" cmd="rgb toggle"
+    - (4) Create multi level project structure (curret is flat fs)               [TODO] FS
+		- New micrOS FS structure:
+			- Note:
+				- On device (boot) micrOS Hooks.py/os_dir_fs_hook (check+correct)  [Phase1-FS:TODO]
+				- DevToolKit USB & OTA feature adaptation                          [Phase2-FS:TODO]
+					- os_dir_fs_handler (usb+webrepl) features
+
+			- root fs (stays untouched (approx.: 24)): /
+				- micrOS.py (core)
+				- Config.py (core)
+				- Tasks.py (core)
+				- Shell.py (core)
+				- Web.py (core)
+				- Server.py (core)
+				- node_config,json (core config)
+				- etc... (core)
+
+			- module folder - mip complient: /lib
+				- LM_* (approx.: 54)
+				- IO_* (approx.: 5)
+				- *.py/.mpy (driver)
+				- Dynamic/Runtime (approx.: 0-8):
+					- *.pds (LM app cache - persistent data storage)
+					- *.dat (Common datalogger output)
+
+			- web folder: /web
+				- *.html
+				- *.js
+				- *.css
+
+		- (5) Proper mip installer support (/lib)                                [TODO]
+			- Note: Autonomous package management over wifi (github) 
+				- pacman download
+				- pacman ls
+				- pacman dirtree
+				- pacman ...
 ```
 
-Version **3.1.0-0**
+Version **3.1.0-0** `micrOS-SecurePower`
 
 ```
     Core:
     - Async socket servers with SSL/TLS integration (with auth.)
         - WebCli (https?), ShellCli (ssocket/sterminal) and InterCon
+    - Low power mode with ESPNOW + (AP mode?)
+    	- Remote controller / Sensor UseCase
+    	- --- client mode (fyi: normally micrOS operates in server mode) 
+    - Intercon-Wire (?)
+    	- Idea of wired message communication protocol same as Intercon-Shell/Intercon-espnow
+    	- Possible HW protocols: i2c / onewire / uart BUT it should support bidirectional message transfers
+    	- Goal: CoProcessor easy integration feature - Arduino env support 
 ```
 
-Version **4.0.0-0**
+Version **4.0.0-0** `micrOS-???`
 
 ```
     Core:
@@ -515,6 +559,7 @@ Version **4.0.0-0**
         - Network
             - wifi (defualt, current interfaces)
             - Study of BLE (Shell)
+            - Com. (wifi/now/ble...lora?/etc?.) as plugin architecture (?)
     - Low power mode (with BLE) and soft-sleep / deep-sleep
 ```