# -*- coding: utf-8 -*-
# ********************************************************************
#
#  $Id: yocto_micropython.py 67995 2025-07-24 17:06:13Z mvuilleu $
#
#  High-level API for YMicroPython
#
#  - - - - - - - - - License information: - - - - - - - - -
#
#  Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
#
#  Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
#  non-exclusive license to use, modify, copy and integrate this
#  file into your software for the sole purpose of interfacing
#  with Yoctopuce products.
#
#  You may reproduce and distribute copies of this file in
#  source or object form, as long as the sole purpose of this
#  code is to interface with Yoctopuce products. You must retain
#  this notice in the distributed source file.
#
#  You should refer to Yoctopuce General Terms and Conditions
#  for additional information regarding your rights and
#  obligations.
#
#  THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT
#  WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
#  WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
#  FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
#  EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
#  INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
#  COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
#  SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
#  LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
#  CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
#  BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
#  WARRANTY, OR OTHERWISE.
#
# *********************************************************************
"""
Yoctopuce library: High-level API for YMicroPython
version: PATCH_WITH_VERSION
requires: yocto_micropython_aio
requires: yocto_api
"""
from __future__ import annotations

import sys

# On MicroPython, code below will be wiped out at compile time
if sys.implementation.name != "micropython":
    # In CPython, enable edit-time type checking, including Final declaration
    from typing import Any, Union, Final
    from collections.abc import Callable, Awaitable
    const = lambda obj: obj
    _IS_MICROPYTHON = False
    _DYNAMIC_HELPERS = False
else:
    # In our micropython VM, common generic types are global built-ins
    # Others such as TypeVar should be avoided when using micropython,
    # as they produce overhead in runtime code
    # Final is translated into const() expressions before compilation
    _IS_MICROPYTHON: Final[bool] = True # noqa
    _DYNAMIC_HELPERS: Final[bool] = True # noqa

from .yocto_micropython_aio import YMicroPython as YMicroPython_aio
from .yocto_api import (
    YAPIContext, YAPI, YFunction
)

# --- (generated code: YMicroPython class start)
if not _IS_MICROPYTHON:
    # For CPython, use strongly typed callback types
    try:
        YMicroPythonValueCallback = Union[Callable[['YMicroPython', str], Any], None]
        YMicroPythonLogCallback = Union[Callable[['YMicroPython', str], Any], None]
    except TypeError:
        YMicroPythonValueCallback = Union[Callable, Awaitable]
        YMicroPythonLogCallback = Union[Callable, Awaitable]

# noinspection PyProtectedMember
class YMicroPython(YFunction):
    """
    The YMicroPython class provides control of the MicroPython interpreter
    that can be found on some Yoctopuce devices.

    """
    _aio: YMicroPython_aio
    # --- (end of generated code: YMicroPython class start)
    if not _IS_MICROPYTHON:
        # --- (generated code: YMicroPython return codes)
        LASTMSG_INVALID: Final[str] = YAPI.INVALID_STRING
        HEAPUSAGE_INVALID: Final[int] = YAPI.INVALID_UINT
        HEAPFRAG_INVALID: Final[int] = YAPI.INVALID_UINT
        XHEAPUSAGE_INVALID: Final[int] = YAPI.INVALID_UINT
        STACKUSAGE_INVALID: Final[int] = YAPI.INVALID_UINT
        CURRENTSCRIPT_INVALID: Final[str] = YAPI.INVALID_STRING
        STARTUPSCRIPT_INVALID: Final[str] = YAPI.INVALID_STRING
        STARTUPDELAY_INVALID: Final[float] = YAPI.INVALID_DOUBLE
        COMMAND_INVALID: Final[str] = YAPI.INVALID_STRING
        DEBUGMODE_OFF: Final[int] = 0
        DEBUGMODE_ON: Final[int] = 1
        DEBUGMODE_INVALID: Final[int] = -1
        # --- (end of generated code: YMicroPython return codes)


    # --- (generated code: YMicroPython implementation)

    @classmethod
    def FirstMicroPython(cls) -> Union[YMicroPython, None]:
        """
        Starts the enumeration of MicroPython interpreters currently accessible.
        Use the method YMicroPython.nextMicroPython() to iterate on
        next MicroPython interpreters.

        @return a pointer to a YMicroPython object, corresponding to
                the first MicroPython interpreter currently online, or a None pointer
                if there are none.
        """
        return cls._proxy(cls, YMicroPython_aio.FirstMicroPython())

    @classmethod
    def FirstMicroPythonInContext(cls, yctx: YAPIContext) -> Union[YMicroPython, None]:
        """
        Starts the enumeration of MicroPython interpreters currently accessible.
        Use the method YMicroPython.nextMicroPython() to iterate on
        next MicroPython interpreters.

        @param yctx : a YAPI context.

        @return a pointer to a YMicroPython object, corresponding to
                the first MicroPython interpreter currently online, or a None pointer
                if there are none.
        """
        return cls._proxy(cls, YMicroPython_aio.FirstMicroPythonInContext(yctx))

    def nextMicroPython(self):
        """
        Continues the enumeration of MicroPython interpreters started using yFirstMicroPython().
        Caution: You can't make any assumption about the returned MicroPython interpreters order.
        If you want to find a specific a MicroPython interpreter, use MicroPython.findMicroPython()
        and a hardwareID or a logical name.

        @return a pointer to a YMicroPython object, corresponding to
                a MicroPython interpreter currently online, or a None pointer
                if there are no more MicroPython interpreters to enumerate.
        """
        return self._proxy(type(self), self._aio.nextMicroPython())

    if not _DYNAMIC_HELPERS:
        def get_lastMsg(self) -> str:
            """
            Returns the last message produced by a python script.

            @return a string corresponding to the last message produced by a python script

            On failure, throws an exception or returns YMicroPython.LASTMSG_INVALID.
            """
            return self._run(self._aio.get_lastMsg())

    if not _DYNAMIC_HELPERS:
        def get_heapUsage(self) -> int:
            """
            Returns the percentage of MicroPython main memory in use,
            as observed at the end of the last garbage collection.

            @return an integer corresponding to the percentage of MicroPython main memory in use,
                    as observed at the end of the last garbage collection

            On failure, throws an exception or returns YMicroPython.HEAPUSAGE_INVALID.
            """
            return self._run(self._aio.get_heapUsage())

    if not _DYNAMIC_HELPERS:
        def get_heapFrag(self) -> int:
            """
            Returns the fragmentation ratio of MicroPython main memory,
            as observed at the end of the last garbage collection.

            @return an integer corresponding to the fragmentation ratio of MicroPython main memory,
                    as observed at the end of the last garbage collection

            On failure, throws an exception or returns YMicroPython.HEAPFRAG_INVALID.
            """
            return self._run(self._aio.get_heapFrag())

    if not _DYNAMIC_HELPERS:
        def get_xheapUsage(self) -> int:
            """
            Returns the percentage of MicroPython external memory in use,
            as observed at the end of the last garbage collection.

            @return an integer corresponding to the percentage of MicroPython external memory in use,
                    as observed at the end of the last garbage collection

            On failure, throws an exception or returns YMicroPython.XHEAPUSAGE_INVALID.
            """
            return self._run(self._aio.get_xheapUsage())

    if not _DYNAMIC_HELPERS:
        def get_stackUsage(self) -> int:
            """
            Returns the maximum percentage of MicroPython call stack in use,
            as observed at the end of the last garbage collection.

            @return an integer corresponding to the maximum percentage of MicroPython call stack in use,
                    as observed at the end of the last garbage collection

            On failure, throws an exception or returns YMicroPython.STACKUSAGE_INVALID.
            """
            return self._run(self._aio.get_stackUsage())

    if not _DYNAMIC_HELPERS:
        def get_currentScript(self) -> str:
            """
            Returns the name of currently active script, if any.

            @return a string corresponding to the name of currently active script, if any

            On failure, throws an exception or returns YMicroPython.CURRENTSCRIPT_INVALID.
            """
            return self._run(self._aio.get_currentScript())

    if not _DYNAMIC_HELPERS:
        def set_currentScript(self, newval: str) -> int:
            """
            Stops current running script, and/or selects a script to run immediately in a
            fresh new environment. If the MicroPython interpreter is busy running a script,
            this function will abort it immediately and reset the execution environment.
            If a non-empty string is given as argument, the new script will be started.

            @param newval : a string

            @return YAPI.SUCCESS if the call succeeds.

            On failure, throws an exception or returns a negative error code.
            """
            return self._run(self._aio.set_currentScript(newval))

    if not _DYNAMIC_HELPERS:
        def get_startupScript(self) -> str:
            """
            Returns the name of the script to run when the device is powered on.

            @return a string corresponding to the name of the script to run when the device is powered on

            On failure, throws an exception or returns YMicroPython.STARTUPSCRIPT_INVALID.
            """
            return self._run(self._aio.get_startupScript())

    if not _DYNAMIC_HELPERS:
        def set_startupScript(self, newval: str) -> int:
            """
            Changes the script to run when the device is powered on.
            Remember to call the saveToFlash() method of the module if the
            modification must be kept.

            @param newval : a string corresponding to the script to run when the device is powered on

            @return YAPI.SUCCESS if the call succeeds.

            On failure, throws an exception or returns a negative error code.
            """
            return self._run(self._aio.set_startupScript(newval))

    if not _DYNAMIC_HELPERS:
        def set_startupDelay(self, newval: float) -> int:
            """
            Changes the wait time before running the startup script on power on, between 0.1
            second and 25 seconds. Remember to call the saveToFlash() method of the
            module if the modification must be kept.

            @param newval : a floating point number corresponding to the wait time before running the startup
            script on power on, between 0.1
                    second and 25 seconds

            @return YAPI.SUCCESS if the call succeeds.

            On failure, throws an exception or returns a negative error code.
            """
            return self._run(self._aio.set_startupDelay(newval))

    if not _DYNAMIC_HELPERS:
        def get_startupDelay(self) -> float:
            """
            Returns the wait time before running the startup script on power on,
            between 0.1 second and 25 seconds.

            @return a floating point number corresponding to the wait time before running the startup script on power on,
                    between 0.1 second and 25 seconds

            On failure, throws an exception or returns YMicroPython.STARTUPDELAY_INVALID.
            """
            return self._run(self._aio.get_startupDelay())

    if not _DYNAMIC_HELPERS:
        def get_debugMode(self) -> int:
            """
            Returns the activation state of MicroPython debugging interface.

            @return either YMicroPython.DEBUGMODE_OFF or YMicroPython.DEBUGMODE_ON, according to the activation
            state of MicroPython debugging interface

            On failure, throws an exception or returns YMicroPython.DEBUGMODE_INVALID.
            """
            return self._run(self._aio.get_debugMode())

    if not _DYNAMIC_HELPERS:
        def set_debugMode(self, newval: int) -> int:
            """
            Changes the activation state of MicroPython debugging interface.

            @param newval : either YMicroPython.DEBUGMODE_OFF or YMicroPython.DEBUGMODE_ON, according to the
            activation state of MicroPython debugging interface

            @return YAPI.SUCCESS if the call succeeds.

            On failure, throws an exception or returns a negative error code.
            """
            return self._run(self._aio.set_debugMode(newval))

    if not _DYNAMIC_HELPERS:
        def set_command(self, newval: str) -> int:
            return self._run(self._aio.set_command(newval))

    @classmethod
    def FindMicroPython(cls, func: str) -> YMicroPython:
        """
        Retrieves a MicroPython interpreter for a given identifier.
        The identifier can be specified using several formats:

        - FunctionLogicalName
        - ModuleSerialNumber.FunctionIdentifier
        - ModuleSerialNumber.FunctionLogicalName
        - ModuleLogicalName.FunctionIdentifier
        - ModuleLogicalName.FunctionLogicalName


        This function does not require that the MicroPython interpreter is online at the time
        it is invoked. The returned object is nevertheless valid.
        Use the method YMicroPython.isOnline() to test if the MicroPython interpreter is
        indeed online at a given time. In case of ambiguity when looking for
        a MicroPython interpreter by logical name, no error is notified: the first instance
        found is returned. The search is performed first by hardware name,
        then by logical name.

        If a call to this object's is_online() method returns FALSE although
        you are certain that the matching device is plugged, make sure that you did
        call registerHub() at application initialization time.

        @param func : a string that uniquely characterizes the MicroPython interpreter, for instance
                MyDevice.microPython.

        @return a YMicroPython object allowing you to drive the MicroPython interpreter.
        """
        return cls._proxy(cls, YMicroPython_aio.FindMicroPython(func))

    @classmethod
    def FindMicroPythonInContext(cls, yctx: YAPIContext, func: str) -> YMicroPython:
        """
        Retrieves a MicroPython interpreter for a given identifier in a YAPI context.
        The identifier can be specified using several formats:

        - FunctionLogicalName
        - ModuleSerialNumber.FunctionIdentifier
        - ModuleSerialNumber.FunctionLogicalName
        - ModuleLogicalName.FunctionIdentifier
        - ModuleLogicalName.FunctionLogicalName


        This function does not require that the MicroPython interpreter is online at the time
        it is invoked. The returned object is nevertheless valid.
        Use the method YMicroPython.isOnline() to test if the MicroPython interpreter is
        indeed online at a given time. In case of ambiguity when looking for
        a MicroPython interpreter by logical name, no error is notified: the first instance
        found is returned. The search is performed first by hardware name,
        then by logical name.

        @param yctx : a YAPI context
        @param func : a string that uniquely characterizes the MicroPython interpreter, for instance
                MyDevice.microPython.

        @return a YMicroPython object allowing you to drive the MicroPython interpreter.
        """
        return cls._proxy(cls, YMicroPython_aio.FindMicroPythonInContext(yctx, func))

    if not _IS_MICROPYTHON:
        def registerValueCallback(self, callback: YMicroPythonValueCallback) -> int:
            """
            Registers the callback function that is invoked on every change of advertised value.
            The callback is invoked only during the execution of ySleep or yHandleEvents.
            This provides control over the time when the callback is triggered. For good responsiveness, remember to call
            one of these two functions periodically. To unregister a callback, pass a None pointer as argument.

            @param callback : the callback function to call, or a None pointer. The callback function should take two
                    arguments: the function object of which the value has changed, and the character string describing
                    the new advertised value.
            @noreturn
            """
            return super().registerValueCallback(callback)

    if not _DYNAMIC_HELPERS:
        def eval(self, codeName: str, mpyCode: str) -> int:
            """
            Submit MicroPython code for execution in the interpreter.
            If the MicroPython interpreter is busy, this function will
            block until it becomes available. The code is then uploaded,
            compiled and executed on the fly, without beeing stored on the device filesystem.

            There is no implicit reset of the MicroPython interpreter with
            this function. Use method reset() if you need to start
            from a fresh environment to run your code.

            Note that although MicroPython is mostly compatible with recent Python 3.x
            interpreters, the limited ressources on the device impose some restrictions,
            in particular regarding the libraries that can be used. Please refer to
            the documentation for more details.

            @param codeName : name of the code file (used for error reporting only)
            @param mpyCode : MicroPython code to compile and execute

            @return YAPI.SUCCESS if the call succeeds.

            On failure, throws an exception or returns a negative error code.
            """
            return self._run(self._aio.eval(codeName, mpyCode))

    if not _DYNAMIC_HELPERS:
        def reset(self) -> int:
            """
            Stops current execution, and reset the MicroPython interpreter to initial state.
            All global variables are cleared, and all imports are forgotten.

            @return YAPI.SUCCESS if the call succeeds.

            On failure, throws an exception or returns a negative error code.
            """
            return self._run(self._aio.reset())

    if not _DYNAMIC_HELPERS:
        def clearLogs(self) -> int:
            """
            Clears MicroPython interpreter console log buffer.

            @return YAPI.SUCCESS if the call succeeds.

            On failure, throws an exception or returns a negative error code.
            """
            return self._run(self._aio.clearLogs())

    if not _DYNAMIC_HELPERS:
        def get_lastLogs(self) -> str:
            """
            Returns a string with last logs of the MicroPython interpreter.
            This method return only logs that are still in the module.

            @return a string with last MicroPython logs.
                    On failure, throws an exception or returns  YAPI.INVALID_STRING.
            """
            return self._run(self._aio.get_lastLogs())

    def registerLogCallback(self, callback: YMicroPythonLogCallback) -> int:
        """
        Registers a device log callback function. This callback will be called each time
        microPython sends a new log message.

        @param callback : the callback function to invoke, or a None pointer.
                The callback function should take two arguments:
                the module object that emitted the log message,
                and the character string containing the log.
                On failure, throws an exception or returns a negative error code.
        """
        return self._run(self._aio.registerLogCallback(self._proxyCb(type(self), callback)))

    # --- (end of generated code: YMicroPython implementation)

