micrOSDevToolKit 2.8.7__tar.gz → 2.9.1__tar.gz

{microsdevtoolkit-2.8.7/micrOSDevToolKit.egg-info → microsdevtoolkit-2.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: micrOSDevToolKit
-Version: 2.8.7
+Version: 2.9.1
 Summary: Development and deployment environment for micrOS, the diy micropython automation OS (IoT)
 Home-page: https://github.com/BxNxM/micrOS
 Author: Marcell Ban
@@ -28,7 +28,7 @@ Requires-Dist: soundfile
 
 # ![LOGO](./media/logo_mini.png?raw=true) micrOS
 
-> **"Simple, yet increadbly useful."**
+> **"The mini yet powerful operating system for DIY projects."**
 
 ![telnet](https://img.shields.io/badge/wifi-telnet-blue) ![esp32S2](https://img.shields.io/badge/esp32-S2-olive) ![tinypico](https://img.shields.io/badge/esp32-tinypico-olive) ![esp32S3](https://img.shields.io/badge/esp32-S3-olive) ![esp32S3](https://img.shields.io/badge/esp32-S3_RAM-olive) ![PYQT](https://img.shields.io/badge/esp32-PYQT-olive) ![raspberry-pico-w](https://img.shields.io/badge/raspberry-pico_W-critical) ![espCAM-esp-s](https://img.shields.io/badge/esp32-CAM_OV2640-olive) ![esp32-c3](https://img.shields.io/badge/esp32-C3_RISCV-olive) ![OTA](https://img.shields.io/badge/ota-update-blue) ![GPIO](https://img.shields.io/badge/gpio-i2c-success) ![clock](https://img.shields.io/badge/rtc-ntp-success) ![async](https://img.shields.io/badge/async-task_manager-success) ![irq](https://img.shields.io/badge/hardware-IRQs-success) ![socket](https://img.shields.io/badge/socket-STA_or_AP-blue) ![cron](https://img.shields.io/badge/scheduling-cron-success) ![stable](https://img.shields.io/badge/stabile-master_HEAD-success) ![stable](https://img.shields.io/badge/micropython-OS-gold)<br/>
 
@@ -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.8.7 → microsdevtoolkit-2.9.1}/README.md

@@ -1,6 +1,6 @@
 # ![LOGO](./media/logo_mini.png?raw=true) micrOS
 
-> **"Simple, yet increadbly useful."**
+> **"The mini yet powerful operating system for DIY projects."**
 
 ![telnet](https://img.shields.io/badge/wifi-telnet-blue) ![esp32S2](https://img.shields.io/badge/esp32-S2-olive) ![tinypico](https://img.shields.io/badge/esp32-tinypico-olive) ![esp32S3](https://img.shields.io/badge/esp32-S3-olive) ![esp32S3](https://img.shields.io/badge/esp32-S3_RAM-olive) ![PYQT](https://img.shields.io/badge/esp32-PYQT-olive) ![raspberry-pico-w](https://img.shields.io/badge/raspberry-pico_W-critical) ![espCAM-esp-s](https://img.shields.io/badge/esp32-CAM_OV2640-olive) ![esp32-c3](https://img.shields.io/badge/esp32-C3_RISCV-olive) ![OTA](https://img.shields.io/badge/ota-update-blue) ![GPIO](https://img.shields.io/badge/gpio-i2c-success) ![clock](https://img.shields.io/badge/rtc-ntp-success) ![async](https://img.shields.io/badge/async-task_manager-success) ![irq](https://img.shields.io/badge/hardware-IRQs-success) ![socket](https://img.shields.io/badge/socket-STA_or_AP-blue) ![cron](https://img.shields.io/badge/scheduling-cron-success) ![stable](https://img.shields.io/badge/stabile-master_HEAD-success) ![stable](https://img.shields.io/badge/micropython-OS-gold)<br/>
 
@@ -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.8.7 → microsdevtoolkit-2.9.1}/micrOS/release_info/micrOS_ReleaseInfo/system_analysis_sum.json

@@ -5,7 +5,7 @@
             7
         ],
         "micrOSloader.py": [
-            7.84,
+            8.0,
             1
         ],
         "Hooks.py": [
@@ -17,7 +17,7 @@
             3
         ],
         "Web.py": [
-            9.23,
+            9.25,
             1
         ],
         "Tasks.py": [
@@ -25,8 +25,8 @@
             12
         ],
         "Config.py": [
-            9.44,
-            16
+            9.49,
+            17
         ],
         "reset.py": [
             8.75,
@@ -37,20 +37,20 @@
             1
         ],
         "Notify.py": [
-            9.26,
-            2
+            8.38,
+            3
         ],
         "Types.py": [
-            8.87,
-            28
+            8.91,
+            29
         ],
         "Logger.py": [
-            8.57,
+            8.78,
             4
         ],
         "Common.py": [
-            8.48,
-            33
+            8.71,
+            34
         ],
         "InterConnect.py": [
             9.4,
@@ -62,7 +62,7 @@
         ],
         "Network.py": [
             9.71,
-            9
+            8
         ],
         "Espnow.py": [
             9.01,
@@ -109,8 +109,8 @@
             0
         ],
         "LM_system.py": [
-            8.31,
-            4
+            8.36,
+            5
         ],
         "LM_robustness.py": [
             7.57,
@@ -145,7 +145,7 @@
             0
         ],
         "LM_buzzer.py": [
-            8.9,
+            8.88,
             0
         ],
         "LM_switch.py": [
@@ -185,7 +185,7 @@
             0
         ],
         "LM_neoeffects.py": [
-            6.71,
+            6.86,
             0
         ],
         "LM_i2c.py": [
@@ -237,7 +237,7 @@
             0
         ],
         "LM_telegram.py": [
-            9.02,
+            9.53,
             0
         ],
         "LM_OV2640.py": [
@@ -315,11 +315,11 @@
     },
     "summary": {
         "core": [
-            3390,
+            3276,
             23
         ],
         "load": [
-            8732,
+            8939,
             55
         ],
         "core_dep": [
@@ -330,8 +330,8 @@
             true,
             6
         ],
-        "core_score": 9.07,
-        "load_score": 8.2,
-        "version": "2.8.4-0"
+        "core_score": 9.06,
+        "load_score": 8.22,
+        "version": "2.9.1-0"
     }
 }

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/Common.py

@@ -9,8 +9,7 @@ from Logger import logger, log_get
 from microIO import resolve_pin
 from Tasks import TaskBase, Manager, lm_exec
 from machine import Pin, ADC
-
-TELEGRAM = None
+from Notify import Notify
 
 ################## Common LM features ##################
 
@@ -78,7 +77,7 @@ class SmartADC:
         return {'raw': raw, 'percent': round(percent*100, 1), 'volt': volt}
 
     @staticmethod
-    def get_singleton(pin):                                         # TODO: rename to get_instance
+    def get_instance(pin):
         if pin in SmartADC.OBJS.keys():
             return SmartADC.OBJS[pin]
         SmartADC.OBJS[pin] = SmartADC(pin)
@@ -141,22 +140,18 @@ def exec_cmd(cmd, skip_check=False):
     return lm_exec(cmd) if isinstance(cmd, list) else False, f"Invalid type, must be list: {type(cmd)}"
 
 
-def notify(text):
+def notify(text=None) -> bool:
     """
     [LM] micrOS common notification handler (Telegram)
-    :param text: notification text
+    :param text: notification text / None (return notification state)
     return: verdict: True/False
     """
-    global TELEGRAM
-    if TELEGRAM is None:
-        try:
-            from Notify import Telegram
-            TELEGRAM = Telegram()
-        except Exception as e:
-            errlog_add(f"[ERR] Import Notify.Telegram: {e}")
-            return False
+    # (1) Return notification state
+    if text is None:
+        return Notify.GLOBAL_NOTIFY
+    # (2) Send notification
     try:
-        out = TELEGRAM.notify(text)
+        out = Notify.notify(text)
     except Exception as e:
         errlog_add(f"[ERR] Notify: {e}")
         out = str(e)
@@ -165,7 +160,7 @@ def notify(text):
     return False
 
 
-def web_endpoint(endpoint, function):
+def web_endpoint(endpoint, function) -> bool:
     """
     [LM] Add test endpoint <localhost.local>/endpoint from Load Modules
     :param endpoint: simple string, name of the endpoint

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/Config.py

@@ -13,6 +13,7 @@ Designed by Marcell Ban aka BxNxM
 #                           IMPORTS                             #
 #################################################################
 from os import remove
+from re import search
 from json import load, dump
 from utime import sleep
 from Debug import DebugCfg, console_write, errlog_add
@@ -185,6 +186,21 @@ class Data:
             # Return default value if key not exists
             return 'n/a'
 
+    @staticmethod
+    def validate_pwd(password):
+        """
+        Validate appwd parameter
+        - webrepl password
+        - micrOS auth password (Shell/WebCli)
+        - wifi access point password
+        """
+        # Check password rules
+        if 4 <= len(password) <= 9:
+            if search(r"[A-Z]", password) and search(r"[a-z]", password):
+                if search(r"\d", password):
+                    return True, ''
+        return False, 'Password must include [0-9] both [a-z][A-Z] and length between 4-9 char.'
+
 
 #################################################################
 #                  CONFIGHANDLER  FUNCTIONS                     #
@@ -204,8 +220,11 @@ def cfgget(key=None):
         errlog_add(f'[ERR] cfgget {key} error: {e}')
     return None
 
-
 def cfgput(key, value, type_check=False):
+    if key == 'appwd':
+        is_valid, verdict = Data.validate_pwd(value)
+        if not is_valid:
+            raise Exception(verdict)
     # Handle special "offloaded" keys
     if str(Data.CONFIG_CACHE.get(key, None)) == '...':
         return Data.disk_keys(key, value)

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/LM_buzzer.py

@@ -1,7 +1,7 @@
 from sys import platform
 from utime import sleep
 from microIO import resolve_pin, pinmap_search
-from Common import micro_task
+from Common import micro_task, notify
 from Types import resolve
 
 
@@ -13,6 +13,7 @@ __BUZZER_OBJ = None
 __BUZZER_CACHE = [600]
 __PERSISTENT_CACHE = False
 __TASK_TAG = "buzzer._play"
+CHECK_NOTIFY = False
 
 #########################################
 #              BUZZER RTTL              #
@@ -229,7 +230,9 @@ def bipp(repeat=1, freq=None):
     :param freq int: 0-1000 default: 600
     :return str: Verdict string
     """
-    global __BUZZER_CACHE
+    global __BUZZER_CACHE, CHECK_NOTIFY
+    if CHECK_NOTIFY and not notify():
+        return "NoBipp - notify off"
     # restore data from cache if it was not provided
     freq = int(__BUZZER_CACHE[0] if freq is None else freq)
     for _ in range(repeat):
@@ -264,6 +267,9 @@ def play(rtttlstr='Indiana'):
     :param rtttlstr str: rttl string, default: 'd=4,o=5,b=250:e,8p,8f,8g,8p,1c6,8p.,d,8p,8e,1f,p.'
     :return str: verdict
     """
+    global CHECK_NOTIFY
+    if CHECK_NOTIFY and not notify():
+        return "NoBipp - notify off"
     state = micro_task(tag=__TASK_TAG, task=_play(rtttlstr))
     if state:
         return 'Play song'
@@ -277,22 +283,24 @@ def list_tones():
     return '\n'.join(list(_builtin_tones()))
 
 
-def load(cache=None):
+def load(cache=None, check_notify=False):
     """
     Initialize buzzer module
     :param cache bool: file state machine cache: True/False/None(default: automatic True)
     - Load .pds (state machine cache) for this load module
     - Apply loaded states to gpio pins (boot function)
-    :return str: Cache state
+    :param check_notify: check notify enabled/disabled - make noise if enabled only
+    :return str: Verdict
     """
     from sys import platform
-    global __PERSISTENT_CACHE
+    global __PERSISTENT_CACHE, CHECK_NOTIFY
     if cache is None:
         __PERSISTENT_CACHE = False if platform == 'esp8266' else True
     else:
         __PERSISTENT_CACHE = cache
     __persistent_cache_manager('r')
-    return "CACHE: {}".format(__PERSISTENT_CACHE)
+    CHECK_NOTIFY = check_notify
+    return f"CACHE: {__PERSISTENT_CACHE}, check notify: {CHECK_NOTIFY}"
 
 
 #######################
@@ -319,4 +327,4 @@ def help(widgets=False):
     return resolve(('BUTTON bipp repeat=3 freq=600',
                              'BUTTON play rtttlstr=<Indiana,TakeOnMe,StarWars,MissionImp>',
                              'list_tones',
-                             'load', 'pinmap'), widgets=widgets)
+                             'load check_notify=False', 'pinmap'), widgets=widgets)

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/LM_genIO.py

@@ -124,7 +124,7 @@ def get_adc(pin, key=None):
     if isinstance(pin, int):
         pin_tag = f"ADC{pin}"
         pin = register_pin(pin_tag, pin)
-    data = SmartADC.get_singleton(pin).get()
+    data = SmartADC.get_instance(pin).get()
     data["pin"] = pin
     if key is None:
         return data

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/LM_neoeffects.py

@@ -1,5 +1,7 @@
 from LM_neopixel import load, segment, Data, status, pinmap as pm
 from random import randint
+from Types import resolve
+from Common import manage_task
 
 
 #################################
@@ -285,6 +287,13 @@ def fire(r=None, g=None, b=None, ledcnt=24):
     effect.draw(cgen, shift=False)
     return 'fire R{}:G{}:B{} N:{}'.format(r, g, b, effect.pix_cnt)
 
+
+def stop_effects():
+    """
+    Stop all running (neo)effects tasks
+    """
+    return manage_task("neoeffects.*", "kill")
+
 #######################
 # LM helper functions #
 #######################
@@ -307,10 +316,16 @@ def help(widgets=False):
         (widgets=False) list of functions implemented by this application
         (widgets=True) list of widget json for UI generation
     """
-    return 'meteor r=<0-255> g=<0-255> b=<0-255> shift=True ledcnt=24',\
-           'cycle r g b shift=True ledcnt=24',\
-           'rainbow step=1 br=<5-100> ledcnt=24',\
-           'fire r=None g=None b=None ledcnt=24',\
-           'shader size=4 offset=0 shift=True ledcnt=24',\
-           'random max_val=255',\
-           'color r g b', 'pinmap'
+    return resolve(('meteor r=<0-255> g=<0-255> b=<0-255> shift=True ledcnt=24',
+                             'BUTTON meteor &&',
+                             'cycle r g b shift=True ledcnt=24',
+                             'BUTTON cycle &&50',
+                             'rainbow step=1 br=<5-100> ledcnt=24 &&',
+                             'BUTTON rainbow br=50 &&',
+                             'fire r=None g=None b=None ledcnt=24',
+                             'BUTTON fire &&200',
+                             'BUTTON stop_effects',
+                             'shader size=4 offset=0 shift=True ledcnt=24',
+                             'random max_val=255',
+                             'pinmap',
+                             'COLOR color r=<0-255-10> g b'), widgets=widgets)

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/LM_neopixel.py

@@ -345,7 +345,7 @@ def help(widgets=False):
                              '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>',
+                             'segment r g b s=<0-n>',
                              'transition r g b sec=1.0 wake=False',
                              'BUTTON random smooth=True max_val=254',
                              'status',

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/LM_ph_sensor.py

@@ -12,7 +12,7 @@ ADC.ATTN_11DB — the full range voltage: 3.3V
 
 
 def __measure(samples=10):
-    adc_obj = SmartADC.get_singleton(resolve_pin('ph'))
+    adc_obj = SmartADC.get_instance(resolve_pin('ph'))
     mbuf = 0
     for k in range(0, samples):
         mbuf += adc_obj.get()['volt']
@@ -22,7 +22,7 @@ def __measure(samples=10):
 
 
 def measure():
-    data = SmartADC.get_singleton(resolve_pin('ph')).get()
+    data = SmartADC.get_instance(resolve_pin('ph')).get()
     return "ADC data: {}\nAVG V: {}".format(data, __measure())
 
 

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/LM_presence.py

@@ -96,7 +96,7 @@ async def __task(ms_period, buff_size):
 
     if Data.MIC_TYPE == Data.MIC_TYPES['ADC']:
         # Create ADC object
-        Data.MIC_ADC = SmartADC.get_singleton(resolve_pin('mic'))
+        Data.MIC_ADC = SmartADC.get_instance(resolve_pin('mic'))
     elif Data.MIC_TYPE == Data.MIC_TYPES['I2S']:
         if Data.I2S_MIC is None:
             import LM_i2s_mic

{microsdevtoolkit-2.8.7 → microsdevtoolkit-2.9.1}/micrOS/source/LM_system.py

@@ -7,6 +7,7 @@ from Network import get_mac, ifconfig as network_config
 from Time import ntp_time, set_time, uptime
 from Tasks import Manager
 from Types import resolve
+from Notify import Notify
 
 try:
     from gc import mem_free, mem_alloc, collect
@@ -177,15 +178,16 @@ def list_stations():
     return [("NoAP", '')]
 
 
-def pinmap(key='builtin'):
+def pinmap(keys='builtin irq1 irq2 irq3 irq4'):
     """
     Get Logical pin by key runtime
-    :param key str: logical pin name to resolve
+    :param keys str: logical pin name or names to resolve
     :return dict: key map
     """
     from microIO import pinmap_search, pinmap_info
     map = pinmap_info()
-    map[key] = pinmap_search(key)[key]
+    keys = keys.split()
+    map["search"] = pinmap_search(keys)
     return map
 
 @socket_stream
@@ -232,6 +234,14 @@ def urequests_host_cache():
     return host_cache()
 
 
+def notifications(enable=None):
+    """
+    Global notifications control for micrOS
+    :param enable: True: Enable notifications / False: Disable notifications
+    return: state verdict
+    """
+    return Notify.notifications(state=enable)
+
 #######################
 # LM helper functions #
 #######################
@@ -246,5 +256,6 @@ def help(widgets=False):
     return resolve(('info', 'TEXTBOX top', 'gclean', 'heartbeat', 'clock',
                     'setclock year month mday hour min sec',
                     'ntp', 'rssi', 'list_stations', 'pinmap key="dhtpin"/None', 'alarms clean=False',
+                    'notifications enable=<None,True,False>',
                     'sun refresh=False', 'ifconfig', 'memory_usage',
                     'disk_usage', 'dat_dump', 'urequests_host_cache'), widgets=widgets)