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

toolkit/workspace/precompiled/modules/LM_mh_z19c.py

@@ -0,0 +1,198 @@
+"""
+MH-Z19 Co2 sensor driver for MicroPython (supports MH-Z19B and MH-Z19C)
+
+Provides a simple interface to read:
+    - Co2 concentration (PPM)
+    - Temperature
+    - Status
+
+Calibration (MH-Z19C)
+---------------------
+There are two ways to calibrate the zero point on MH-Z19C:
+
+1) Apply a low-level signal for more than 7 seconds.
+
+2) Send the calibration command:
+   FF 01 87 00 00 00 00 00 78
+   On success the sensor returns:
+   FF 87 01 00 00 00 00 00 78
+
+Auto-calibration (ABC) period
+-----------------------------
+Set 7-day automatic calibration period:
+    Command:      FF 01 AF 01 07 00 00 00 48
+    Confirmation: FF AF 01 07 00 00 00 00 49
+
+Set 1-day automatic calibration period:
+    Command:      FF 01 AF 01 01 00 00 00 4E
+    Confirmation: FF AF 01 01 00 00 00 00 4F
+
+Notes
+-----
+- Use a well-ventilated environment (around 400 ppm) for command-based zero calibration
+
+:author: Florian Mandl
+:version: 1.0
+:date: 2025-12-06
+"""
+
+import time
+import json
+from machine import Pin, UART
+from microIO import bind_pin, pinmap_search
+from Common import micro_task, manage_task, console, notify
+from Types import resolve
+
+
+class MHZ19:
+    INSTANCE = None
+
+    SENSOR_TASK = 'mh_z19c.sensor'
+    CALIBRATE_TASK = 'mh_z19c.calibrate'
+
+    def __init__(self):
+        self.uart_no = 1
+        self.ppm = 0
+        self.temp = 0
+        self.co2status = 0
+        self.tx_pin = Pin(bind_pin('mh_z19c_tx',16))
+        self.rx_pin = Pin(bind_pin('mh_z19c_rx',17))
+        self.hd_pin = Pin(bind_pin('mh_z19c_hd',19), Pin.OUT, Pin.PULL_UP)
+        self.start()
+
+    def start(self):
+        self.uart = UART(self.uart_no, baudrate=9600, tx=self.tx_pin, rx=self.rx_pin)
+        self.uart.init(9600, bits=8, parity=None, stop=1, timeout=10)
+
+    def stop(self):
+        while self.uart.any():
+            self.uart.read()
+        self.uart.deinit()
+
+    def get_data(self):
+        # Clear buffer
+        while self.uart.any():
+            self.uart.read()
+
+        self.uart.write(b"\xff\x01\x86\x00\x00\x00\x00\x00\x79")
+        time.sleep(0.1)
+        s = self.uart.read(9)
+        if not s or len(s) < 9:
+            return False
+        if self._crc8(s) != s[8]:
+            self.stop()
+            time.sleep(0.1)
+            self.start()
+            return False
+        self.ppm = s[2] * 256 + s[3]
+        self.temp = s[4] - 40
+        self.co2status = s[5]
+        return True
+
+    async def calibrate(self):
+        with micro_task(tag=self.CALIBRATE_TASK) as my_task:
+            try:
+                self.stop()
+                self.hd_pin.value(0)
+                await my_task.feed(sleep_ms=8000)
+                self.hd_pin.value(1)
+                self.start()
+                console("Calibration finished")
+            except Exception as e:
+                console(f"Calibration error: {e}")
+
+    @staticmethod
+    def _crc8(a):
+        crc = sum(bytearray(a)[1:8]) % 256
+        crc = (~crc & 0xFF) + 1
+        return crc
+
+#########################
+# Application functions #
+#########################
+
+def load():
+    """
+    Create MH-Z19 CO2 sensor (over UART)
+    """
+
+    if MHZ19.INSTANCE is None:
+        MHZ19.INSTANCE = MHZ19()
+    return MHZ19.INSTANCE
+
+
+def measure():
+    """
+    Measure with MH-Z19 CO2 sensor
+    """
+    mhz19 = load()
+    mhz19.get_data()
+    return {"ppm": mhz19.ppm,
+            "temp": mhz19.temp,
+            "status": mhz19.co2status}
+
+
+def calibrate():
+    """
+    Calibrate MH-Z19 sensor
+    """
+    mhz19 = load()
+    return micro_task(tag=MHZ19.CALIBRATE_TASK, task=mhz19.calibrate())
+
+
+async def _run_sensor_loop(interval, topic, channels):
+    channels = [] if channels is None else channels
+    with micro_task(tag=MHZ19.SENSOR_TASK) as my_task:
+        while True:
+            my_task.out = "Start measurement"
+            out = notify(json.dumps(measure()), topic=topic, channels=channels)
+            my_task.out = f"Measurement published: {out}, wait {interval}ms"
+            await my_task.feed(sleep_ms=interval)
+
+
+def start(interval:int=5000, topic:str="MH_Z19C", channels:list=None):
+    """
+    Start sensor measurement loop and publish results over micros notify feature
+    :param interval: update interval in milliseconds
+    :param topic: for MQTT channel, default: MH_Z19C
+    :param channels: selected notification channels, ex.: ["MQTT"], default: None (all)
+    """
+    load()
+    return micro_task(tag=MHZ19.SENSOR_TASK, task=_run_sensor_loop(interval, topic, channels))
+
+
+def stop():
+    """
+    Stop sensor measurement loop and publish, delete MHZ19.INSTANCE
+    """
+    mhz19 = load()
+    manage_task(MHZ19.SENSOR_TASK, "kill")
+    if mhz19:
+        mhz19.stop()
+        MHZ19.INSTANCE = None
+    return f"{MHZ19.SENSOR_TASK}: Stopped"
+
+#######################
+# LM helper functions #
+#######################
+
+def pinmap():
+    """
+    [i] micrOS LM naming convention
+    Shows logical pins - pin number(s) used by this Load module
+    - info which pins to use for this application
+    :return dict: pin name (str) - pin value (int) pairs
+    """
+    return pinmap_search(['mh_z19c_tx', 'mh_z19c_rx', 'mh_z19c_hd'])
+
+
+def help(widgets=False):
+    """
+    [i] micrOS LM naming convention - built-in help message
+    :return tuple:
+        (widgets=False) list of functions implemented by this application
+        (widgets=True) list of widget json for UI generation
+    """
+    return resolve(('load',
+                    'BUTTON start interval=5000',
+                    'BUTTON stop', 'TEXTBOX measure', 'calibrate', 'pinmap'), widgets=widgets)

toolkit/workspace/precompiled/modules/LM_qmi8658.py

@@ -0,0 +1,204 @@
+"""
+A simple driver for the QMI8658 IMU.
+https://github.com/echo-lalia/qmi8658-micropython/blob/main/qmi8685.py
+"""
+
+import struct
+import time
+from machine import Pin, I2C
+from micropython import const
+from microIO import bind_pin, pinmap_search
+
+
+# Sensor constants
+_QMI8685_PARTID = const(0x05)
+_REG_PARTID = const(0x00)
+_REG_REVISION = const(0x01)
+
+_REG_CTRL1 = const(0x02)  # Serial interface and sensor enable
+_REG_CTRL2 = const(0x03)  # Accelerometer settings
+_REG_CTRL3 = const(0x04)  # Gyroscope settings
+_REG_CTRL4 = const(0x05)  # Magnetomer settings (support not implemented in this driver yet)
+_REG_CTRL5 = const(0x06)  # Sensor data processing settings
+_REG_CTRL6 = const(0x07)  # Attitude Engine ODR and Motion on Demand
+_REG_CTRL7 = const(0x08)  # Enable Sensors and Configure Data Reads
+
+_REG_TEMP = const(0x33)  # Temperature sensor.
+
+_REG_AX_L = const(0x35)  # Read accelerometer
+_REG_AX_H = const(0x36)
+_REG_AY_L = const(0x37)
+_REG_AY_H = const(0x38)
+_REG_AZ_L = const(0x39)
+_REG_AZ_H = const(0x3A)
+
+_REG_GX_L = const(0x3B)  # read gyro
+_REG_GX_H = const(0x3C)
+_REG_GY_L = const(0x3D)
+_REG_GY_H = const(0x3E)
+_REG_GZ_L = const(0x3F)
+_REG_GZ_H = const(0x40)
+
+_QMI8658_I2CADDR_DEFAULT = const(0X6B)
+
+
+_ACCELSCALE_RANGE_2G = const(0b00)
+_ACCELSCALE_RANGE_4G = const(0b01)
+_ACCELSCALE_RANGE_8G = const(0b10)
+_ACCELSCALE_RANGE_16G = const(0b11)
+
+_GYROSCALE_RANGE_16DPS = const(0b000)
+_GYROSCALE_RANGE_32DPS = const(0b001)
+_GYROSCALE_RANGE_64DPS = const(0b010)
+_GYROSCALE_RANGE_128DPS = const(0b011)
+_GYROSCALE_RANGE_256DPS = const(0b100)
+_GYROSCALE_RANGE_512DPS = const(0b101)
+_GYROSCALE_RANGE_1024DPS = const(0b110)
+_GYROSCALE_RANGE_2048DPS = const(0b111)
+
+_ODR_8000HZ = const(0b0000)
+_ODR_4000HZ = const(0b0001)
+_ODR_2000HZ = const(0b0010)
+_ODR_1000HZ = const(0b0011)
+_ODR_500HZ = const(0b0100)
+_ODR_250HZ = const(0b0101)
+_ODR_125HZ = const(0b0110)
+_ODR_62_5HZ = const(0b0111)
+
+
+class QMI8658:
+    """QMI8658 inertial measurement unit."""
+    INSTANCE = None
+
+    def __init__(
+            self,
+            i2c_bus: I2C,
+            address: int = _QMI8658_I2CADDR_DEFAULT,
+            accel_scale: int = _ACCELSCALE_RANGE_8G,
+            gyro_scale: int = _GYROSCALE_RANGE_256DPS):
+        """Read from a sensor on the given I2C bus, at the given address."""
+        self.i2c = i2c_bus
+        self.address = address
+        # Cache the sensor instance globally for easy access
+        QMI8658.INSTANCE = self
+
+        # Verify sensor part ID
+        if self._read_u8(_REG_PARTID) != _QMI8685_PARTID:
+            raise AttributeError("Cannot find a QMI8658")
+
+        # Setup initial configuration
+        self._configure_sensor(accel_scale, gyro_scale)
+
+        # Configure scales/divisors for the driver
+        self.acc_scale_divisor = {
+            _ACCELSCALE_RANGE_2G: 1 << 14,
+            _ACCELSCALE_RANGE_4G: 1 << 13,
+            _ACCELSCALE_RANGE_8G: 1 << 12,
+            _ACCELSCALE_RANGE_16G: 1 << 11,
+        }[accel_scale]
+
+        self.gyro_scale_divisor = {
+            _GYROSCALE_RANGE_16DPS: 2048,
+            _GYROSCALE_RANGE_32DPS: 1024,
+            _GYROSCALE_RANGE_64DPS: 512,
+            _GYROSCALE_RANGE_128DPS: 256,
+            _GYROSCALE_RANGE_256DPS: 128,
+            _GYROSCALE_RANGE_512DPS: 64,
+            _GYROSCALE_RANGE_1024DPS: 32,
+            _GYROSCALE_RANGE_2048DPS: 16,
+        }[gyro_scale]
+
+
+    def _configure_sensor(self, accel_scale: int, gyro_scale: int):
+        # Initialize accelerometer and gyroscope settings
+        self._write_u8(_REG_CTRL1, 0x60)  # Set SPI auto increment and big endian (Ctrl 1)
+        self._write_u8(_REG_CTRL2, (accel_scale << 4) | _ODR_1000HZ)  # Accel Config
+        self._write_u8(_REG_CTRL3, (gyro_scale << 4) | _ODR_1000HZ)  # Gyro Config
+        self._write_u8(_REG_CTRL5, 0x01)  # Low-pass filter enable
+        self._write_u8(_REG_CTRL7, 0x03)  # Enable accel and gyro
+        time.sleep_ms(100)
+
+
+    # Helper functions for register operations
+    def _read_u8(self, reg:int) -> int:
+        return self.i2c.readfrom_mem(self.address, reg, 1)[0]
+
+    def _read_xyz(self, reg:int) -> tuple[int, int, int]:
+        data = self.i2c.readfrom_mem(self.address, reg, 6)
+        return struct.unpack('<hhh', data)
+
+    def _write_u8(self, reg: int, value: int):
+        self.i2c.writeto_mem(self.address, reg, bytes([value]))
+
+
+    @property
+    def temperature(self) -> float:
+        """Get the device temperature."""
+        temp_raw = self._read_u8(_REG_TEMP)
+        return temp_raw / 256
+
+    @property
+    def acceleration(self) -> tuple[float, float, float]:
+        """Get current acceleration reading."""
+        raw_accel = self._read_xyz(_REG_AX_L)
+        return tuple(val / self.acc_scale_divisor for val in raw_accel)
+
+    @property
+    def gyro(self) -> tuple[float, float, float]:
+        """Get current gyroscope reading."""
+        raw_gyro = self._read_xyz(_REG_GX_L)
+        return tuple(val / self.gyro_scale_divisor for val in raw_gyro)
+
+#######################
+#   Public functions  #
+#######################
+
+def load():
+    """
+    Load the QMI8658 sensor instance.
+    The QMI8658 is a motion sensor that measures acceleration, angular velocity (gyroscope), and temperature
+    """
+    if QMI8658.INSTANCE is None:
+        QMI8658(I2C(0, sda=Pin(bind_pin('i2c_sda')), scl=Pin(bind_pin('i2c_scl'))))
+    return QMI8658.INSTANCE
+
+
+def temperature():
+    return load().temperature
+
+
+def acceleration():
+    return load().acceleration
+
+
+def gyro():
+    return load().gyro
+
+
+def measure():
+    inst = load()
+    return {"temp": inst.temperature, "accel": inst.acceleration, "gyro": inst.gyro}
+
+
+#######################
+# LM helper functions #
+#######################
+
+def pinmap():
+    """
+    [i] micrOS LM naming convention
+    Shows logical pins - pin number(s) used by this Load module
+    - info which pins to use for this application
+    :return dict: pin name (str) - pin value (int) pairs
+    """
+    return pinmap_search(['i2c_scl', 'i2c_sda'])
+
+
+def help(widgets=False):
+    """
+    [i] micrOS LM naming convention - built-in help message
+    :return tuple:
+        (widgets=False) list of functions implemented by this application
+        (widgets=True) list of widget json for UI generation
+    """
+    return 'load', 'temperature', 'acceleration', 'gyro', 'measure', 'pinmap'

toolkit/workspace/precompiled/{LM_rencoder.py → modules/LM_rencoder.py}

@@ -1,7 +1,7 @@
 from machine import Pin
 import micropython
 from Common import socket_stream, syslog
-from microIO import resolve_pin, pinmap_search
+from microIO import bind_pin, pinmap_search
 from Types import resolve
 
 # https://www.coderdojotc.org/micropython/sensors/10-rotary-encoder/
@@ -76,7 +76,7 @@ def load(min_val=0, max_val=20):
     """
     if Data.ROTARY_OBJ is None:
         # GPIO Pins 33 and 35 are for the encoder pins.
-        Data.ROTARY_OBJ = Rotary(resolve_pin('rot_dt'), resolve_pin('rot_clk'))
+        Data.ROTARY_OBJ = Rotary(bind_pin('rot_dt'), bind_pin('rot_clk'))
         Data.MIN_VAL = min_val
         Data.MAX_VAL = max_val
         Data.VAL = min_val

toolkit/workspace/precompiled/modules/LM_robustness.py

@@ -0,0 +1,137 @@
+from LM_system import memory_usage
+from Common import socket_stream, syslog, micro_task
+from Auth import sudo
+
+
+@socket_stream
+def raise_error(msgobj=None):
+    """
+    Test function - raise  LM exception
+    """
+    if msgobj is not None:
+        msgobj("Raise test exception")
+    state = syslog('Robustness TeSt ErRoR')
+    raise Exception(f"Test exception: {'OK' if state else 'NOK'}")
+
+
+@socket_stream
+def memory_leak(cnt=160, msgobj=None):
+    """
+    Test function - allocate lot of memory
+    :param cnt: data counter, default 160 iteration
+    :return: verdict
+    """
+    dict_test = {}
+    mem_start = memory_usage()['mem_used']
+    for k in range(cnt):
+        mem = memory_usage()['percent']
+        data = "micrOS memory usage: {} %".format(mem)
+        if msgobj is not None:
+            msgobj("[{}] gen: {}".format(k, data))
+        dict_test[k] = data
+    mem_end = memory_usage()['mem_used']
+    delta = mem_start - mem_end
+    return '[{}] RAM Alloc.: {} kB {} byte'.format(len(dict_test), int(delta / 1024), int(delta % 1024))
+
+@socket_stream
+def recursion_limit(limit=14, msgobj=None):
+    cnt = 0
+    for cnt in range(1, limit+1):
+        try:
+            _recursion(cnt, msgobj=msgobj)
+        except Exception as e:
+            msgobj(f"ok error: {e}")
+            break
+    return f"Recursion limit: {cnt}"
+
+
+def _recursion(cnt, msgobj=None):
+    """
+    Test function - recursion test
+    :param cnt: recursion depth
+    :return: verdict
+    Error example:
+        node01 $  robustness recursion_limit 15
+        lm_exec LM_robustness->recursion_limit: maximum recursion depth exceeded
+    """
+    if cnt > 0:
+        remain = _recursion(cnt-1)
+        if msgobj is not None:
+            msgobj("recalled {}".format(cnt))
+    else:
+        remain = 0
+    return remain
+
+################## TEST micro_task UCs ##########################
+
+async def __task(tag, period_ms):
+    counter = 0
+    with micro_task(tag=tag) as my_task:
+        while True:
+            # DO something here in the async loop...
+            counter += 1
+
+            # Store data in task cache (task show mytask)
+            my_task.out = f'MyTask Counter: {counter}'
+
+            # Async sleep - feed event loop
+            await my_task.feed(sleep_ms=period_ms)
+            # [i] feed same as "await asyncio.sleep_ms(period_ms)" with micrOS features (WDT)
+
+def create_task():
+    """
+    Legacy way of task creation (with exact task tagging)
+    """
+    # [!] ASYNC TASK CREATION [1*] with async task callback + taskID (TAG) handling
+    task_tag = "microtask.run"
+    return micro_task(tag=task_tag, task=__task(tag=task_tag, period_ms=5))
+
+
+@micro_task("microtask", _wrap=True)
+async def mytask(tag, period_ms=30):
+    """
+    New shorter way of task creation
+     with decorator function
+    """
+    counter = 0
+    with micro_task(tag=tag) as my_task:
+        while True:
+            # DO something here in the async loop...
+            counter += 1
+
+            # Store data in task cache (task show mytask)
+            my_task.out = f'MyTask Counter: {counter}'
+
+            # Async sleep - feed event loop
+            await my_task.feed(sleep_ms=period_ms)
+            # [i] feed same as "await asyncio.sleep_ms(period_ms)" with micrOS features (WDT)
+
+
+@sudo
+def func_sudo():
+    """
+    Function execution requires pwd=<...>
+    """
+    return "Access granted"
+
+
+@sudo(_force_only=(True, 0))
+def func_sudo_force(force=False):
+    """
+    Function requires pwd=<...> when force=True
+    """
+    return f"Access granted, force flag: {force}"
+
+##############################################################################
+
+def help(widgets=False):
+    """
+    [i] micrOS LM naming convention - built-in help message
+    :return tuple:
+        (widgets=False) list of functions implemented by this application
+        (widgets=True) list of widget json for UI generation
+    """
+    return 'NOTE: This is a test module to validate system robustness', \
+           'raise_error', 'memory_leak cnt=160', 'recursion_limit cnt=14', \
+           'create_task', 'mytask', "func_sudo", "func_sudo_force"
+