micrOSDevToolKit 2.10.6__py3-none-any.whl → 2.11.0__py3-none-any.whl

micrOS/source/LM_rgb.py

@@ -2,8 +2,7 @@
 #       ANALOG rgb CONTROLLER PARAMS    #
 #########################################
 from machine import Pin, PWM
-from sys import platform
-from Common import transition_gen, micro_task
+from Common import transition_gen, micro_task, data_dir
 from utime import sleep_ms
 from microIO import bind_pin, pinmap_search
 from random import randint
@@ -20,6 +19,7 @@ class Data:
     CH_MAX = 1000                          # maximum value per channel
     TASK_STATE = False
     RGB_TASK_TAG = "rgb._tran"
+    FILE_CACHE = data_dir('rgb.cache')
 
 
 #########################################
@@ -39,7 +39,7 @@ def __RGB_init(red_pin=None, green_pin=None, blue_pin=None):
 
 def __persistent_cache_manager(mode):
     """
-    pds - persistent data structure
+    File state cache
     modes:
         r - recover, s - save
     """
@@ -47,12 +47,12 @@ def __persistent_cache_manager(mode):
         return
     if mode == 's':
         # SAVE CACHE
-        with open('rgb.pds', 'w') as f:
+        with open(Data.FILE_CACHE, 'w') as f:
             f.write(','.join([str(k) for k in Data.RGB_CACHE]))
         return
     try:
         # RESTORE CACHE
-        with open('rgb.pds', 'r') as f:
+        with open(Data.FILE_CACHE, 'r') as f:
             Data.RGB_CACHE = [float(data) for data in f.read().strip().split(',')]
     except:
         pass
@@ -74,7 +74,7 @@ def load(red_pin=None, green_pin=None, blue_pin=None, cache=True):
     :param red_pin: optional red color pin to overwrite built-in
     :param green_pin: optional green color pin to overwrite built-in
     :param blue_pin: optional blue color pin to overwrite built-in
-    :param cache: file state machine cache: True/False (.pds), default=True
+    :param cache: file state machine cache: True/False (.cache), default=True
     :return str: Cache state
     """
     Data.PERSISTENT_CACHE = cache

micrOS/source/LM_roboarm.py

@@ -2,7 +2,7 @@ from utime import sleep_ms
 from random import randint
 import LM_servo as servo
 from LM_switch import set_state, pinmap as switch_pinmap
-from Common import transition, micro_task
+from Common import transition, micro_task, data_dir
 from Types import resolve
 
 
@@ -13,23 +13,24 @@ class RoboArm:
     SPEED_MS = 10                           # Set default speed between steps (ms)
     MOVE_RECORD = []                        # Buffer for XY move record/replay
     PLAY_TAG = 'roboarm._play'
+    FILE_CACHE = data_dir('rarm.cache')
 
 
 def __persistent_cache_manager(mode):
     """
-    pds - persistent data structure
+    File state cache
     modes:
         r - recover, s - save
     """
 
     if mode == 's':
         # SAVE CACHE
-        with open('rarm.pds', 'w') as f:
+        with open(RoboArm.FILE_CACHE, 'w') as f:
             f.write(','.join([str(k) for k in RoboArm.MOVE_RECORD]))
         return
     try:
         # RESTORE CACHE
-        with open('rarm.pds', 'r') as f:
+        with open(RoboArm.FILE_CACHE, 'r') as f:
             RoboArm.MOVE_RECORD = [int(data) for data in f.read().strip().split(',')]
     except:
         pass

micrOS/source/LM_switch.py

@@ -1,5 +1,6 @@
 from machine import Pin
 from microIO import bind_pin, pinmap_search
+from Common import data_dir
 from Types import resolve
 
 #########################################
@@ -8,6 +9,7 @@ from Types import resolve
 __SWITCH_OBJ = [None, None, None, None]
 __PERSISTENT_CACHE = False
 __SWITCH_STATE = [0, 0, 0, 0]
+__FILE_CACHE = data_dir('switch.cache')
 
 
 #########################################
@@ -16,7 +18,7 @@ __SWITCH_STATE = [0, 0, 0, 0]
 
 def __persistent_cache_manager(mode):
     """
-    pds - persistent data structure
+    File cache
     modes:
         r - recover, s - save
     """
@@ -25,12 +27,12 @@ def __persistent_cache_manager(mode):
     global __SWITCH_STATE
     if mode == 's':
         # SAVE CACHE
-        with open('switch.pds', 'w') as f:
+        with open(__FILE_CACHE, 'w') as f:
             f.write(','.join([str(k) for k in __SWITCH_STATE]))
         return
     try:
         # RESTORE CACHE
-        with open('switch.pds', 'r') as f:
+        with open(__FILE_CACHE, 'r') as f:
             __SWITCH_STATE = [int(data) for data in f.read().strip().split(',')]
     except:
         pass
@@ -54,7 +56,7 @@ def load(cache=None, ch_init=None):
     """
     Initiate switch module (4 switch pack)
     :param cache bool: file state machine cache: True/False/None(default: automatic True)
-    - Load .pds (state machine cache) for this load module
+    - Load .cache (state machine cache) for this load module
     - Apply loaded states to gpio pins (boot function)
     :return str: Cache state
     """

micrOS/source/LM_tcs3472.py

@@ -0,0 +1,75 @@
+"""
+A MicroPython library for the TCS3472 light sensing chip
+https://github.com/tti0/tcs3472-micropython
+
+Copyright (c) 2021 tti0
+Licensed under the MIT License
+"""
+
+from machine import I2C, Pin
+from microIO import bind_pin, pinmap_search
+import struct
+
+
+class TCS3472:
+    INSTANCE = None
+
+    def __init__(self, bus, address=0x29):
+        self._bus = bus
+        self._i2c_address = address
+
+        self._bus.start()
+
+        self._bus.writeto(self._i2c_address, b'\x80\x03')
+        self._bus.writeto(self._i2c_address, b'\x81\x2b')
+
+        TCS3472.INSTANCE = self
+
+    def scaled(self):
+        crgb = self.raw()
+        if crgb[0] > 0:
+            return tuple(float(x) / crgb[0] for x in crgb[1:])
+
+        return (0, 0, 0)
+
+    def rgb(self):
+        return tuple(int(x * 255) for x in self.scaled())
+
+    def light(self):
+        return self.raw()[0]
+
+    def brightness(self, level=65.535):
+        return int((self.light() / level))
+
+    def valid(self):
+        self._bus.writeto(self._i2c_address, b'\x93')
+        return self._bus.readfrom(self._i2c_address, 1)[0] & 1
+
+    def raw(self):
+        self._bus.writeto(self._i2c_address, b'\xb4')
+        return struct.unpack("<HHHH", self._bus.readfrom(self._i2c_address, 8))
+
+
+############################ Exposed functions ############################
+
+def load():
+    """
+    Load the TCS3472 Color sensor instance.
+    """
+    if TCS3472.INSTANCE is None:
+        bus = I2C(sda=Pin(bind_pin('i2c_sda')), scl=Pin(bind_pin('i2c_scl')))
+        TCS3472.INSTANCE = TCS3472(bus)
+    return TCS3472.INSTANCE
+
+
+def pinmap():
+    return pinmap_search(['i2c_scl', 'i2c_sda'])
+
+
+def measure():
+    sensor = load()
+    return {"rgb": sensor.rgb(), "light": sensor.light(), "brightness": sensor.brightness()}
+
+
+def help(widgest=False):
+    return 'load', 'measure'

micrOS/source/LM_telegram.py

@@ -2,7 +2,7 @@ from sys import modules
 import urequests
 from Notify import Notify
 from Config import cfgget
-from Common import micro_task, syslog, console_write
+from Common import micro_task, syslog, console_write, data_dir
 from LM_system import ifconfig
 from utime import localtime
 
@@ -18,6 +18,7 @@ class Telegram(Notify):
     _CHAT_IDS = set()  # Telegram bot chat IDs - multi group support - persistent caching
     _API_PARAMS = "?offset=-1&limit=1&timeout=2"  # Generic API params - optimization
     _IN_MSG_ID = None
+    _FILE_CACHE = data_dir('telegram.cache')
 
     def __init__(self):
         # Subscribe to the notification system - provide send_msg method (over self)
@@ -26,20 +27,20 @@ class Telegram(Notify):
     @staticmethod
     def __id_cache(mode):
         """
-        pds - persistent data structure
+        File cache
         modes:
             r - recover, s - save
         """
         if mode == 's':
             # SAVE CACHE
             console_write("[NTFY] Save chatIDs cache...")
-            with open('telegram.pds', 'w') as f:
+            with open(Telegram._FILE_CACHE, 'w') as f:
                 f.write(','.join([str(k) for k in Telegram._CHAT_IDS]))
             return
         try:
             # RESTORE CACHE
             console_write("[NTFY] Restore chatIDs cache...")
-            with open('telegram.pds', 'r') as f:
+            with open(Telegram._FILE_CACHE, 'r') as f:
                 # set() comprehension
                 Telegram._CHAT_IDS = {int(k) for k in f.read().strip().split(',')}
         except:

micrOS/source/Logger.py

@@ -6,48 +6,52 @@ Designed by Marcell Ban aka BxNxM
 """
 from time import localtime
 from re import match
-from uos import remove, mkdir, getcwd
-from Files import ilist_fs, is_dir
+from uos import remove, mkdir
+from Files import OSPath, path_join, ilist_fs, is_dir
 
 #############################################
 #        LOGGING WITH DATA ROTATION         #
 #############################################
-LOG_FOLDER = None
 
 def _init_logger():
     """ Init /logs folder """
-    global LOG_FOLDER
-    if LOG_FOLDER is None:
-        LOG_FOLDER = f"{getcwd()}logs"
-        if not is_dir(LOG_FOLDER):
-            try:
-                mkdir(LOG_FOLDER)
-                syslog(f"[BOOT] log dir {LOG_FOLDER} init")
-            except Exception as e:
-                LOG_FOLDER = getcwd()
-                syslog(f"[BOOT] log dir {LOG_FOLDER} fallback: {e}")
-    return LOG_FOLDER
+    if not is_dir(OSPath.LOGS):
+        try:
+            mkdir(OSPath.LOGS)
+            syslog(f"[BOOT] log dir {OSPath.LOGS} init")
+        except Exception as e:
+            OSPath.LOGS = OSPath.ROOT
+            syslog(f"[BOOT] log dir {OSPath.LOGS} fallback: {e}")
+    return OSPath.LOGS
+
+
+def _dir_select(f_name:str) -> str:
+    """
+    Select log dir based on file extension
+    :param f_name: filename with extension to detect target dir
+    """
+    if f_name.endswith(".log"):
+        return OSPath.LOGS
+    return OSPath.DATA
 
 
-def logger(data, f_name, limit):
+def logger(data, f_name:str, limit:int):
     """
-    Create generic logger function
-    - implements log line rotation
-    - automatic time stump
-    :param data: input string data to log
+    Generic logger function with line rotation and time
+    :param data: 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(f_mode='r+'):
-        nonlocal data, f_name, limit
+        nonlocal data, f_path, limit
         limit = min(limit, 30)  # Hardcoded max data line = 30
         # [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:
+        with open(f_path, 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]
@@ -61,7 +65,7 @@ def logger(data, f_name, limit):
             # write file
             f.write(''.join(lines))
 
-    f_name = f"{LOG_FOLDER}/{f_name}"
+    f_path = path_join(_dir_select(f_name), f_name)
     # Run logger
     try:
         # There is file - append 'r+'
@@ -75,17 +79,17 @@ def logger(data, f_name, limit):
     return True
 
 
-def log_get(f_name, msgobj=None):
+def log_get(f_name:str, msgobj=None):
     """
-    Get and stream (ver osocket/stdout) .log file's content and count "critical" errors
-    - critical error tag in log line: [ERR]
+    Generic file getter for .log files
+    - log content critical [ERR] counter
     """
-    f_name = f"{LOG_FOLDER}/{f_name}"
+    f_path = path_join(_dir_select(f_name), f_name)
     err_cnt = 0
     try:
         if msgobj is not None:
-            msgobj(f_name)
-        with open(f_name, 'r') as f:
+            msgobj(f_path)
+        with open(f_path, 'r') as f:
             eline = f.readline().strip()
             while eline:
                 # GET error from log line (tag: [ERR])
@@ -100,10 +104,16 @@ def log_get(f_name, msgobj=None):
 
 
 def syslog(data=None, msgobj=None):
+    """
+    System log setter/getter
+    :param data: None - read logs, str - write logs
+    :param msgobj: function to stream .log files
+    """
     if data is None:
-        err_cnt = sum([log_get(f, msgobj) for f in ilist_fs(LOG_FOLDER, type_filter='f') if f.endswith(".sys.log")])
+        # READ LOGS
+        err_cnt = sum([log_get(f, msgobj) for f in ilist_fs(OSPath.LOGS, type_filter='f') if f.endswith(".sys.log")])
         return err_cnt
-
+    # WRITE LOGS - [target].sys.log automatic log level detection
     _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'
@@ -111,9 +121,13 @@ def syslog(data=None, msgobj=None):
 
 
 def log_clean(msgobj=None):
-    to_del = [file for file in ilist_fs(LOG_FOLDER, type_filter='f') if file.endswith('.log')]
+    """
+    Clean logs folder
+    """
+    logs_dir = OSPath.LOGS
+    to_del = [file for file in ilist_fs(logs_dir, type_filter='f') if file.endswith('.log')]
     for _del in to_del:
-        _del = f"{LOG_FOLDER}/{_del}"
+        _del = path_join(logs_dir, _del)
         if msgobj is not None:
             msgobj(f" Delete: {_del}")
         remove(_del)

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.10.5-1'
+    MICROS_VERSION = '2.11.0-0'
 
     def __init__(self):
         """

micrOS/source/Tasks.py

@@ -98,9 +98,11 @@ class TaskBase:
     async def feed(sleep_ms=1):
         """
         Feed event loop
-        :param sleep_ms: in millisecond (min: 1)
+        :param sleep_ms: in millisecond
         """
         # TODO: feed WDT - preemptive cooperative multitasking aka reboot if no feed until X time period
+        if sleep_ms <= 0:
+            return await asyncio.sleep(0.000_000_1)     # 0 means: 100ns (Absolute minimum)
         return await asyncio.sleep_ms(sleep_ms)
 
     def __del__(self):
@@ -116,7 +118,7 @@ class NativeTask(TaskBase):
     - could be built in function or custom code from load modules
     """
 
-    def create(self, callback=None, tag=None):
+    def create(self, callback:callable=None, tag:str=None) -> bool:
         """
         Create async task with coroutine callback (no queue limit check!)
         + async socket server task
@@ -166,7 +168,7 @@ class MagicTask(TaskBase):
         self.__inloop = False        # [LM] Task while loop for LM callback
         self.__sleep = 20            # [LM] Task while loop - async wait (proc feed) [ms]
 
-    def create(self, callback=None, loop=None, sleep=None):
+    def create(self, callback:list=None, loop:bool=None, sleep:int=None) -> bool:
         """
         Create async task with function callback (with queue limit check)
         - wrap (sync) function into async task (task_wrapper)
@@ -295,11 +297,12 @@ class Manager:
         my_task.done.set()
 
     @staticmethod
-    def create_task(callback, tag=None, loop=False, delay=None):
+    def create_task(callback, tag:str=None, loop:bool=False, delay:int=None):
         """
         Primary interface
         Generic task creator method
             Create async Task with coroutine/list(lm call) callback
+        :param callback: list|callable
         """
         if isinstance(callback, list):
             # Check queue if task is Load Module

micrOS/source/Time.py

@@ -16,12 +16,14 @@ from utime import sleep_ms, time, mktime, localtime
 from Config import cfgput, cfgget
 from Debug import errlog_add, console_write
 from urequests import get as http_get
+from Files import OSPath, path_join
 
 
 class Sun:
     TIME = {}
     UTC = cfgget('utc')  # STORED IN MINUTE
     BOOTIME = None       # Initialize BOOTIME: Not SUN, but for system uptime
+    FILE_CACHE = path_join(OSPath.DATA, 'sun.cache')
 
 
 def set_time(year, month, mday, hour, minute, sec):
@@ -89,14 +91,14 @@ def ntp_time():
 
 def __sun_cache(mode):
     """
-    pds - persistent data structure
+    File cache
     modes:
         r - recover, s - save
     """
     if mode == 's':
         # SAVE CACHE
         try:
-            with open('sun.pds', 'w') as f:
+            with open(Sun.FILE_CACHE, 'w') as f:
                 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:
@@ -104,7 +106,7 @@ def __sun_cache(mode):
         return
     try:
         # RESTORE CACHE
-        with open('sun.pds', 'r') as f:
+        with open(Sun.FILE_CACHE, 'r') as f:
             buff = {data.split(':')[0]: data.split(':')[1].split('-')
                     for data in f.read().strip().split(';')}
             for k, v in buff.items():

micrOS/source/micrOS.py

@@ -9,7 +9,7 @@ Designed by Marcell Ban aka BxNxM
 #################################################################
 from Time import ntp_time, suntime
 from Tasks import Manager
-from Hooks import bootup, profiling_info
+from Hooks import bootup, profiling_info, enableESPNow
 from Network import auto_nw_config
 from Server import Server
 from Interrupts import enableInterrupt, enableCron, initEventIRQs
@@ -74,7 +74,10 @@ def micrOS():
 
     # [Server] as async task
     aio.create_task(Server().run_server(), tag='server')
-    profiling_info(label='[memUsage] SYSTEM IS UP')
+
+    # [ESPNow] server as async task
+    enableESPNow()
+    profiling_info(label='[memUsage] SYSTEM IS UP AND RUNNING')
 
     # [EVENT LOOP] Start async event loop
     aio.run_forever()

micrOS/source/microIO.py

@@ -30,17 +30,19 @@ def detect_platform():
     """
     Unified platform detection for micrOS
     """
-    if 'esp32' in platform:
+    if 'esp32' in platform:     # esp32 family
         board = str(uname()[-1]).lower()
         if 'tinypico' in board:
-            return 'tinypico'    # esp32 family - tinypico
+            return 'tinypico'
         if 'esp32s2' in board:
-            return 'esp32s2'     # esp32 family - esp32S2
+            return 'esp32s2'
         if 'esp32s3' in board:
-            return 'esp32s3'     # esp32 family - esp32s3
+            return 'esp32s3'
         if 'esp32c3' in board:
-            return 'esp32c3'     # esp32 family - esp32c3
-        return 'esp32'           # esp32 family - general
+            return 'esp32c3'
+        if 'esp32c6' in board:
+            return 'esp32c6'
+        return 'esp32'           # esp32 family: general
     return platform              # esp8266 or something else
 
 

{microsdevtoolkit-2.10.6.dist-info → microsdevtoolkit-2.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: micrOSDevToolKit
-Version: 2.10.6
+Version: 2.11.0
 Summary: Development and deployment environment for micrOS, the diy micropython automation OS (IoT)
 Home-page: https://github.com/BxNxM/micrOS
 Author: Marcell Ban
@@ -404,6 +404,7 @@ These parameters controlls micrOS core functionalities, so you can define an ent
 |   **`appwd`**       |   `ADmin123`  `<str>`       |       Yes       | Device system password.: Used in AP password (access point mode) + webrepl password + micrOS auth
 | **`boothook`**      |    `n/a` `<str>`            |      Yes        | Add Load Module execution(s) to the boot sequence. Separator `;`. Examples: `rgb load; cct load` but you can call any load module function here if you want to run it at boot time.
 | **`webui`**         |       `False`  `bool`       |      Yes        | Launch http rest server on port 80 (in parallel with micrOS shell on port 9008 aka `socport`). It has 2 endpoints: / aka main page (index.html) and /rest aka rest (json) interface for load module execution. Example: `<devfid>.local` or `<devfid>.local/rest` + optional parameters: `/rgb/toggle`. **Apple shortcuts compatible**
+| **`espnow`**         |     `False`  `bool`       |      Yes        | Enable **ESPNow communication protocol**. It starts `espnow.server` task, that can receive espnow messages and execute Load Module commands. It is an extension for **InterCon** feature example: `system heartbeat >>target.local`. 
 | | |
 | **`cron`**          |     `False`  `<bool>`       |       Yes       | Enable timestamp based Load Module execution aka Cron scheduler (linux terminology), Timer(1) hardware interrupt enabler.
 | **`crontasks`**     |     `n/a`  `<str>`          |       Yes       | Cron scheduler input, task format: `WD:H:M:S!module function` e.g.: `1:8:0:0!system heartbeat`, task separator in case of multiple tasks: `;`. [WD:0-6, H:0-23, M:0-59, S:0-59] in case of each use: `*`. Instead `WD:H:M:S` you can use suntime tags: `sunset`, `sunrise`, optional offset: `sunset+-<minutes>`, `sunrise+-<minutes>`, example: `sunset-30!system heartbeat`. Range of days: WD can be conrete day number or range like: 0-2 means Monday to Wednesday.