machine.pyi

"""
functions related to the hardware.

Descriptions taken from:
https://raw.githubusercontent.com/micropython/micropython/master/docs/library/machine.rst.
====================================================

.. module:: machine
   :synopsis: functions related to the hardware

   

   The ``machine`` module contains specific functions related to the hardware
   on a particular board. Most functions in this module allow to achieve direct
   and unrestricted access to and control of hardware blocks on a system
   (like CPU, timers, buses, etc.). Used incorrectly, this can lead to
   malfunction, lockups, crashes of your board, and in extreme cases, hardware
   damage.
   
   .. _machine_callbacks:
   
   A note of callbacks used by functions and class methods of :mod:`machine` module:
   all these callbacks should be considered as executing in an interrupt context.
   This is true for both physical devices with IDs >= 0 and "virtual" devices
   with negative IDs like -1 (these "virtual" devices are still thin shims on
   top of real hardware and real hardware interrupts). See :ref:`isr_rules`.
"""

__author__ = "Howard C Lovatt"
__copyright__ = "Howard C Lovatt, 2020 onwards."
__license__ = "MIT https://opensource.org/licenses/MIT (as used by MicroPython)."
__version__ = "7.3.0"  # Version set by https://github.com/hlovatt/tag2ver

from typing import overload, NoReturn, Callable
from typing import Sequence, ClassVar, Any, Final
from typing import Optional

from uos import AbstractBlockDev
from uio import AnyReadableBuf, AnyWritableBuf

def reset() -> NoReturn:
    """
    Resets the device in a manner similar to pushing the external RESET
    button.
    """

def soft_reset() -> NoReturn:
    """
    Performs a soft reset of the interpreter, deleting all Python objects and
    resetting the Python heap.  It tries to retain the method by which the user
    is connected to the MicroPython REPL (eg serial, USB, Wifi).
    """

def reset_cause() -> int:
    """
    Get the reset cause. See :ref:`constants <machine_constants>` for the possible return values.
    """

def disable_irq() -> bool:
    """
    Disable interrupt requests.
    Returns the previous IRQ state which should be considered an opaque value.
    This return value should be passed to the `enable_irq()` function to restore
    interrupts to their original state, before `disable_irq()` was called.
    """

def enable_irq(state: bool = True, /) -> None:
    """
    Re-enable interrupt requests.
    The *state* parameter should be the value that was returned from the most
    recent call to the `disable_irq()` function.
    """

@overload
def freq() -> int:
    """
    Returns the CPU frequency in hertz.
    
    On some ports this can also be used to set the CPU frequency by passing in *hz*.
    """

@overload
def freq(hz: int, /) -> None:
    """
    Returns the CPU frequency in hertz.
    
    On some ports this can also be used to set the CPU frequency by passing in *hz*.
    """

def idle() -> None:
    """
    Gates the clock to the CPU, useful to reduce power consumption at any time during
    short or long periods. Peripherals continue working and execution resumes as soon
    as any interrupt is triggered (on many ports this includes system timer
    interrupt occurring at regular intervals on the order of millisecond).
    """

def sleep() -> None:
    """
    .. note:: This function is deprecated, use `lightsleep()` instead with no arguments.
    """

@overload
def lightsleep() -> None:
    """
    Stops execution in an attempt to enter a low power state.
    
    If *time_ms* is specified then this will be the maximum time in milliseconds that
    the sleep will last for.  Otherwise the sleep can last indefinitely.
    
    With or without a timeout, execution may resume at any time if there are events
    that require processing.  Such events, or wake sources, should be configured before
    sleeping, like `Pin` change or `RTC` timeout.
    
    The precise behaviour and power-saving capabilities of lightsleep and deepsleep is
    highly dependent on the underlying hardware, but the general properties are:
    
    * A lightsleep has full RAM and state retention.  Upon wake execution is resumed
      from the point where the sleep was requested, with all subsystems operational.
    
    * A deepsleep may not retain RAM or any other state of the system (for example
      peripherals or network interfaces).  Upon wake execution is resumed from the main
      script, similar to a hard or power-on reset. The `reset_cause()` function will
      return `machine.DEEPSLEEP` and this can be used to distinguish a deepsleep wake
      from other resets.
    
    """

@overload
def lightsleep(time_ms: int, /) -> None:
    """
    Stops execution in an attempt to enter a low power state.
    
    If *time_ms* is specified then this will be the maximum time in milliseconds that
    the sleep will last for.  Otherwise the sleep can last indefinitely.
    
    With or without a timeout, execution may resume at any time if there are events
    that require processing.  Such events, or wake sources, should be configured before
    sleeping, like `Pin` change or `RTC` timeout.
    
    The precise behaviour and power-saving capabilities of lightsleep and deepsleep is
    highly dependent on the underlying hardware, but the general properties are:
    
    * A lightsleep has full RAM and state retention.  Upon wake execution is resumed
      from the point where the sleep was requested, with all subsystems operational.
    
    * A deepsleep may not retain RAM or any other state of the system (for example
      peripherals or network interfaces).  Upon wake execution is resumed from the main
      script, similar to a hard or power-on reset. The `reset_cause()` function will
      return `machine.DEEPSLEEP` and this can be used to distinguish a deepsleep wake
      from other resets.
    
    """

@overload
def deepsleep() -> NoReturn:
    """
    Stops execution in an attempt to enter a low power state.
    
    If *time_ms* is specified then this will be the maximum time in milliseconds that
    the sleep will last for.  Otherwise the sleep can last indefinitely.
    
    With or without a timeout, execution may resume at any time if there are events
    that require processing.  Such events, or wake sources, should be configured before
    sleeping, like `Pin` change or `RTC` timeout.
    
    The precise behaviour and power-saving capabilities of lightsleep and deepsleep is
    highly dependent on the underlying hardware, but the general properties are:
    
    * A lightsleep has full RAM and state retention.  Upon wake execution is resumed
      from the point where the sleep was requested, with all subsystems operational.
    
    * A deepsleep may not retain RAM or any other state of the system (for example
      peripherals or network interfaces).  Upon wake execution is resumed from the main
      script, similar to a hard or power-on reset. The `reset_cause()` function will
      return `machine.DEEPSLEEP` and this can be used to distinguish a deepsleep wake
      from other resets.
    
    """

@overload
def deepsleep(time_ms: int, /) -> NoReturn:
    """
    Stops execution in an attempt to enter a low power state.
   
    If *time_ms* is specified then this will be the maximum time in milliseconds that
    the sleep will last for.  Otherwise the sleep can last indefinitely.
   
    With or without a timeout, execution may resume at any time if there are events
    that require processing.  Such events, or wake sources, should be configured before
    sleeping, like `Pin` change or `RTC` timeout.
   
    The precise behaviour and power-saving capabilities of lightsleep and deepsleep is
    highly dependent on the underlying hardware, but the general properties are:
   
    * A lightsleep has full RAM and state retention.  Upon wake execution is resumed
      from the point where the sleep was requested, with all subsystems operational.
   
    * A deepsleep may not retain RAM or any other state of the system (for example
      peripherals or network interfaces).  Upon wake execution is resumed from the main
      script, similar to a hard or power-on reset. The `reset_cause()` function will
      return `machine.DEEPSLEEP` and this can be used to distinguish a deepsleep wake
      from other resets.
    
    """

def wake_reason() -> int:
    """
    Get the wake reason. See :ref:`constants <machine_constants>` for the possible return values.
   
    Availability: ESP32, WiPy.
    """

def unique_id() -> bytes:
    """
    Returns a byte string with a unique identifier of a board/SoC. It will vary
    from a board/SoC instance to another, if underlying hardware allows. Length
    varies by hardware (so use substring of a full value if you expect a short
    ID). In some MicroPython ports, ID corresponds to the network MAC address.
    """

def time_pulse_us(pin: Pin, pulse_level: int, timeout_us: int = 1_000_000, /) -> int:
    """
    Time a pulse on the given *pin*, and return the duration of the pulse in
    microseconds.  The *pulse_level* argument should be 0 to time a low pulse
    or 1 to time a high pulse.
   
    If the current input value of the pin is different to *pulse_level*,
    the function first (*) waits until the pin input becomes equal to *pulse_level*,
    then (**) times the duration that the pin is equal to *pulse_level*.
    If the pin is already equal to *pulse_level* then timing starts straight away.
   
    The function will return -2 if there was timeout waiting for condition marked
    (*) above, and -1 if there was timeout during the main measurement, marked (**)
    above. The timeout is the same for both cases and given by *timeout_us* (which
    is in microseconds).
    """


IDLE: Final[int] = ...
"""
IRQ wake values.
"""

SLEEP: Final[int] = ...
"""
IRQ wake values.
"""

DEEPSLEEP: Final[int] = ...
"""
IRQ wake values.
"""

PWRON_RESET: Final[int] = ...
"""
Reset causes.
"""

HARD_RESET: Final[int] = ...
"""
Reset causes.
"""

WDT_RESET: Final[int] = ...
"""
Reset causes.
"""

DEEPSLEEP_RESET: Final[int] = ...
"""
Reset causes.
"""

SOFT_RESET: Final[int] = ...
"""
Reset causes.
"""

WLAN_WAKE: Final[int] = ...
"""
Wake-up reasons.
"""

PIN_WAKE: Final[int] = ...
"""
Wake-up reasons.
"""

RTC_WAKE: Final[int] = ...
"""
Wake-up reasons.
"""

class Pin:
    """
    A pin object is used to control I/O pins (also known as GPIO - general-purpose
    input/output).  Pin objects are commonly associated with a physical pin that can
    drive an output voltage and read input voltages.  The pin class has methods to set the mode of
    the pin (IN, OUT, etc) and methods to get and set the digital logic level.
    For analog control of a pin, see the :class:`ADC` class.
   
    A pin object is constructed by using an identifier which unambiguously
    specifies a certain I/O pin.  The allowed forms of the identifier and the
    physical pin that the identifier maps to are port-specific.  Possibilities
    for the identifier are an integer, a string or a tuple with port and pin
    number.
   
    Usage Model::
   
        from machine import Pin
        
        # create an output pin on pin #0
        p0 = Pin(0, Pin.OUT)
        
        # set the value low then high
        p0.value(0)
        p0.value(1)
        
        # create an input pin on pin #2, with a pull up resistor
        p2 = Pin(2, Pin.IN, Pin.PULL_UP)
        
        # read and print the pin value
        print(p2.value())
        
        # reconfigure pin #0 in input mode with a pull down resistor
        p0.init(p0.IN, p0.PULL_DOWN)
        
        # configure an irq callback
        p0.irq(lambda p:print(p))
    
    """

    IN: ClassVar[int] = ...
    """
    Selects the pin mode.
    """

    OUT: ClassVar[int] = ...
    """
    Selects the pin mode.
    """

    OPEN_DRAIN: ClassVar[int] = ...
    """
    Selects the pin mode.
    """

    ALT: ClassVar[int] = ...
    """
    Selects the pin mode.
    """

    ALT_OPEN_DRAIN: ClassVar[int] = ...
    """
    Selects the pin mode.
    """

    PULL_UP: ClassVar[int] = ...
    """
    Selects whether there is a pull up/down resistor.  Use the value ``None`` for no pull.
    """

    PULL_DOWN: ClassVar[int] = ...
    """
    Selects whether there is a pull up/down resistor.  Use the value ``None`` for no pull.
    """

    PULL_HOLD: ClassVar[int] = ...
    """
    Selects whether there is a pull up/down resistor.  Use the value ``None`` for no pull.
    """

    LOW_POWER: ClassVar[int] = ...
    """
    Selects the pin drive strength.
    """

    MED_POWER: ClassVar[int] = ...
    """
    Selects the pin drive strength.
    """

    HIGH_POWER: ClassVar[int] = ...
    """
    Selects the pin drive strength.
    """

    IRQ_FALLING: ClassVar[int] = ...
    """
    Selects the IRQ trigger type.
    """

    IRQ_RISING: ClassVar[int] = ...
    """
    Selects the IRQ trigger type.
    """

    IRQ_LOW_LEVEL: ClassVar[int] = ...
    """
    Selects the IRQ trigger type.
    """

    IRQ_HIGH_LEVEL: ClassVar[int] = ...
    """
    Selects the IRQ trigger type.
    """
    
    def __init__(
        self,
        id: Any,
        /,
        mode: int = -1,
        pull: int = -1,
        *,
        value: Any = None,
        drive: int | None = None,
        alt: int | None = None,
    ):
        """
        Access the pin peripheral (GPIO pin) associated with the given ``id``.  If
        additional arguments are given in the constructor then they are used to initialise
        the pin.  Any settings that are not specified will remain in their previous state.
      
        The arguments are:
      
          - ``id`` is mandatory and can be an arbitrary object.  Among possible value
            types are: int (an internal Pin identifier), str (a Pin name), and tuple
            (pair of [port, pin]).
      
          - ``mode`` specifies the pin mode, which can be one of:
      
            - ``Pin.IN`` - Pin is configured for input.  If viewed as an output the pin
              is in high-impedance state.
            - ``Pin.OUT`` - Pin is configured for (normal) output.
            - ``Pin.OPEN_DRAIN`` - Pin is configured for open-drain output. Open-drain
              output works in the following way: if the output value is set to 0 the pin
              is active at a low level; if the output value is 1 the pin is in a high-impedance
              state.  Not all ports implement this mode, or some might only on certain pins.
            - ``Pin.ALT`` - Pin is configured to perform an alternative function, which is
              port specific.  For a pin configured in such a way any other Pin methods
              (except :meth:`Pin.init`) are not applicable (calling them will lead to undefined,
              or a hardware-specific, result).  Not all ports implement this mode.
            - ``Pin.ALT_OPEN_DRAIN`` - The Same as ``Pin.ALT``, but the pin is configured as
                open-drain.  Not all ports implement this mode.
                
          - ``pull`` specifies if the pin has a (weak) pull resistor attached, and can be
            one of:
          
            - ``None`` - No pull up or down resistor.
            - ``Pin.PULL_UP`` - Pull up resistor enabled.
            - ``Pin.PULL_DOWN`` - Pull down resistor enabled.
            
          - ``value`` is valid only for Pin.OUT and Pin.OPEN_DRAIN modes and specifies initial
            output pin value if given, otherwise the state of the pin peripheral remains
            unchanged.      
          - ``drive`` specifies the output power of the pin and can be one of: ``Pin.LOW_POWER``,
            ``Pin.MED_POWER`` or ``Pin.HIGH_POWER``.  The actual current driving capabilities
            are port dependent.  Not all ports implement this argument.    
          - ``alt`` specifies an alternate function for the pin and the values it can take are
            port dependent.  This argument is valid only for ``Pin.ALT`` and ``Pin.ALT_OPEN_DRAIN``
            modes.  It may be used when a pin supports more than one alternate function.  If only
            one pin alternate function is supported the this argument is not required.  Not all
            ports implement this argument.
      
        As specified above, the Pin class allows to set an alternate function for a particular
        pin, but it does not specify any further operations on such a pin.  Pins configured in
        alternate-function mode are usually not used as GPIO but are instead driven by other
        hardware peripherals.  The only operation supported on such a pin is re-initialising,
        by calling the constructor or :meth:`Pin.init` method.  If a pin that is configured in
        alternate-function mode is re-initialised with ``Pin.IN``, ``Pin.OUT``, or
        ``Pin.OPEN_DRAIN``, the alternate function will be removed from the pin.
        """
        
    def init(
        self,
        mode: int = -1,
        pull: int = -1,
        *,
        value: Any = None,
        drive: int | None = None,
        alt: int | None = None,
    ) -> None:
        """
        Re-initialise the pin using the given parameters.  Only those arguments that
        are specified will be set.  The rest of the pin peripheral state will remain
        unchanged.  See the constructor documentation for details of the arguments.
      
        Returns ``None``.
        """
        
    @overload
    def value(self) -> int:
        """
        This method allows to set and get the value of the pin, depending on whether
        the argument ``x`` is supplied or not.
      
        If the argument is omitted then this method gets the digital logic level of
        the pin, returning 0 or 1 corresponding to low and high voltage signals
        respectively.  The behaviour of this method depends on the mode of the pin:
      
          - ``Pin.IN`` - The method returns the actual input value currently present
            on the pin.
          - ``Pin.OUT`` - The behaviour and return value of the method is undefined.
          - ``Pin.OPEN_DRAIN`` - If the pin is in state '0' then the behaviour and
            return value of the method is undefined.  Otherwise, if the pin is in
            state '1', the method returns the actual input value currently present
            on the pin.
      
        If the argument is supplied then this method sets the digital logic level of
        the pin.  The argument ``x`` can be anything that converts to a boolean.
        If it converts to ``True``, the pin is set to state '1', otherwise it is set
        to state '0'.  The behaviour of this method depends on the mode of the pin:
      
          - ``Pin.IN`` - The value is stored in the output buffer for the pin.  The
            pin state does not change, it remains in the high-impedance state.  The
            stored value will become active on the pin as soon as it is changed to
            ``Pin.OUT`` or ``Pin.OPEN_DRAIN`` mode.
          - ``Pin.OUT`` - The output buffer is set to the given value immediately.
          - ``Pin.OPEN_DRAIN`` - If the value is '0' the pin is set to a low voltage
            state.  Otherwise the pin is set to high-impedance state.
      
        When setting the value this method returns ``None``.
        """
        
    @overload
    def value(self, x: Any, /) -> None:
        """
        This method allows to set and get the value of the pin, depending on whether
        the argument ``x`` is supplied or not.
      
        If the argument is omitted then this method gets the digital logic level of
        the pin, returning 0 or 1 corresponding to low and high voltage signals
        respectively.  The behaviour of this method depends on the mode of the pin:
      
          - ``Pin.IN`` - The method returns the actual input value currently present
            on the pin.
          - ``Pin.OUT`` - The behaviour and return value of the method is undefined.
          - ``Pin.OPEN_DRAIN`` - If the pin is in state '0' then the behaviour and
            return value of the method is undefined.  Otherwise, if the pin is in
            state '1', the method returns the actual input value currently present
            on the pin.
      
        If the argument is supplied then this method sets the digital logic level of
        the pin.  The argument ``x`` can be anything that converts to a boolean.
        If it converts to ``True``, the pin is set to state '1', otherwise it is set
        to state '0'.  The behaviour of this method depends on the mode of the pin:
      
          - ``Pin.IN`` - The value is stored in the output buffer for the pin.  The
            pin state does not change, it remains in the high-impedance state.  The
            stored value will become active on the pin as soon as it is changed to
            ``Pin.OUT`` or ``Pin.OPEN_DRAIN`` mode.
          - ``Pin.OUT`` - The output buffer is set to the given value immediately.
          - ``Pin.OPEN_DRAIN`` - If the value is '0' the pin is set to a low voltage
            state.  Otherwise the pin is set to high-impedance state.
      
        When setting the value this method returns ``None``.
        """
        
    @overload
    def __call__(self) -> int:
        """
        Pin objects are callable.  The call method provides a (fast) shortcut to set
        and get the value of the pin.  It is equivalent to Pin.value([x]).
        See :meth:`Pin.value` for more details.
        """
        
    @overload
    def __call__(self, x: Any, /) -> None:
        """
        Pin objects are callable.  The call method provides a (fast) shortcut to set
        and get the value of the pin.  It is equivalent to Pin.value([x]).
        See :meth:`Pin.value` for more details.
        """
        
    def on(self) -> None:
        """
        Set pin to "1" output level.
        """
        
    def off(self) -> None:
        """
        Set pin to "0" output level.
        """
        
    def irq(
        self,
        /,
        handler: Callable[[Pin], None] | None = None,
        trigger: int = (IRQ_FALLING | IRQ_RISING),
        *,
        priority: int = 1,
        wake: int | None = None,
        hard: bool = False,
    ) -> Callable[[Pin], None] | None:
        """
        Configure an interrupt handler to be called when the trigger source of the
        pin is active.  If the pin mode is ``Pin.IN`` then the trigger source is
        the external value on the pin.  If the pin mode is ``Pin.OUT`` then the
        trigger source is the output buffer of the pin.  Otherwise, if the pin mode
        is ``Pin.OPEN_DRAIN`` then the trigger source is the output buffer for
        state '0' and the external pin value for state '1'.
      
        The arguments are:
      
          - ``handler`` is an optional function to be called when the interrupt
            triggers. The handler must take exactly one argument which is the
            ``Pin`` instance.    
          - ``trigger`` configures the event which can generate an interrupt.
            Possible values are:
      
              - ``Pin.IRQ_FALLING`` interrupt on falling edge.
              - ``Pin.IRQ_RISING`` interrupt on rising edge.
              - ``Pin.IRQ_LOW_LEVEL`` interrupt on low level.
              - ``Pin.IRQ_HIGH_LEVEL`` interrupt on high level.
      
        These values can be OR'ed together to trigger on multiple events.
      
          - ``priority`` sets the priority level of the interrupt.  The values it
            can take are port-specific, but higher values always represent higher
            priorities.  
          - ``wake`` selects the power mode in which this interrupt can wake up the
            system.  It can be ``machine.IDLE``, ``machine.SLEEP`` or ``machine.DEEPSLEEP``.
            These values can also be OR'ed together to make a pin generate interrupts in
            more than one power mode.
          - ``hard`` if true a hardware interrupt is used. This reduces the delay
            between the pin change and the handler being called. Hard interrupt
            handlers may not allocate memory; see :ref:`isr_rules`.
            Not all ports support this argument.
      
        This method returns a callback object.
        """
        
    def low(self) -> None:
        """
        Set pin to "0" output level.
      
        Availability: nrf, rp2, stm32 ports.
        """
        
    def high(self) -> None:
        """
        Set pin to "1" output level.
      
        Availability: nrf, rp2, stm32 ports.
        """
        
    @overload
    def mode(self) -> int:
        """
        Get or set the pin mode.
        See the constructor documentation for details of the ``mode`` argument.
      
        Availability: cc3200, stm32 ports.
        """
        
    @overload
    def mode(self, mode: int, /) -> None:
        """
        Get or set the pin mode.
        See the constructor documentation for details of the ``mode`` argument.
      
        Availability: cc3200, stm32 ports.
        """
        
    @overload
    def pull(self) -> int:
        """
        Get or set the pin pull state.
        See the constructor documentation for details of the ``pull`` argument.
      
        Availability: cc3200, stm32 ports.
        """
        
    @overload
    def pull(self, pull: int, /) -> None:
        """
        Get or set the pin pull state.
        See the constructor documentation for details of the ``pull`` argument.
      
        Availability: cc3200, stm32 ports.
        """



class Signal:
    """
    The Signal class is a simple extension of the `Pin` class. Unlike Pin, which
    can be only in "absolute" 0 and 1 states, a Signal can be in "asserted"
    (on) or "deasserted" (off) states, while being inverted (active-low) or
    not. In other words, it adds logical inversion support to Pin functionality.
    While this may seem a simple addition, it is exactly what is needed to
    support wide array of simple digital devices in a way portable across
    different boards, which is one of the major MicroPython goals. Regardless
    of whether different users have an active-high or active-low LED, a normally
    open or normally closed relay - you can develop a single, nicely looking
    application which works with each of them, and capture hardware
    configuration differences in few lines in the config file of your app.
   
    Example::
    
        from machine import Pin, Signal
        
        # Suppose you have an active-high LED on pin 0
        led1_pin = Pin(0, Pin.OUT)
        # ... and active-low LED on pin 1
        led2_pin = Pin(1, Pin.OUT)
        
        # Now to light up both of them using Pin class, you'll need to set
        # them to different values
        led1_pin.value(1)
        led2_pin.value(0)
        
        # Signal class allows to abstract away active-high/active-low
        # difference
        led1 = Signal(led1_pin, invert=False)
        led2 = Signal(led2_pin, invert=True)
        
        # Now lighting up them looks the same
        led1.value(1)
        led2.value(1)
        
        # Even better:
        led1.on()
        led2.on()
   
    Following is the guide when Signal vs Pin should be used:
   
    * Use Signal: If you want to control a simple on/off (including software
      PWM!) devices like LEDs, multi-segment indicators, relays, buzzers, or
      read simple binary sensors, like normally open or normally closed buttons,
      pulled high or low, Reed switches, moisture/flame detectors, etc. etc.
      Summing up, if you have a real physical device/sensor requiring GPIO
      access, you likely should use a Signal.
   
    * Use Pin: If you implement a higher-level protocol or bus to communicate
      with more complex devices.
   
    The split between Pin and Signal come from the use cases above and the
    architecture of MicroPython: Pin offers the lowest overhead, which may
    be important when bit-banging protocols. But Signal adds additional
    flexibility on top of Pin, at the cost of minor overhead (much smaller
    than if you implemented active-high vs active-low device differences in
    Python manually!). Also, Pin is a low-level object which needs to be
    implemented for each support board, while Signal is a high-level object
    which comes for free once Pin is implemented.
   
    If in doubt, give the Signal a try! Once again, it is offered to save
    developers from the need to handle unexciting differences like active-low
    vs active-high signals, and allow other users to share and enjoy your
    application, instead of being frustrated by the fact that it doesn't
    work for them simply because their LEDs or relays are wired in a slightly
    different way.
    """

    @overload
    def __init__(self, pin_obj: Pin, invert: bool = False, /):
        """
        Create a Signal object. There're two ways to create it:
      
        * By wrapping existing Pin object - universal method which works for
          any board.
        * By passing required Pin parameters directly to Signal constructor,
          skipping the need to create intermediate Pin object. Available on
          many, but not all boards.
      
        The arguments are:
      
          - ``pin_obj`` is existing Pin object.
          - ``pin_arguments`` are the same arguments as can be passed to Pin constructor.
          - ``invert`` - if True, the signal will be inverted (active low).
        
        """
        
    @overload
    def __init__(
        self,
        id: Pin | str,
        /,
        mode: int = -1,
        pull: int = -1,
        *,
        value: Any = None,
        drive: int | None = None,
        alt: int | None = None,
        invert: bool = False,
    ):
        """
        Create a Signal object. There're two ways to create it:
      
        * By wrapping existing Pin object - universal method which works for
          any board.
        * By passing required Pin parameters directly to Signal constructor,
          skipping the need to create intermediate Pin object. Available on
          many, but not all boards.
      
        The arguments are:
      
          - ``pin_obj`` is existing Pin object.
          - ``pin_arguments`` are the same arguments as can be passed to Pin constructor.
          - ``invert`` - if True, the signal will be inverted (active low).
        
        """
        
    @overload
    def value(self) -> int:
        """
        This method allows to set and get the value of the signal, depending on whether
        the argument ``x`` is supplied or not.
      
        If the argument is omitted then this method gets the signal level, 1 meaning
        signal is asserted (active) and 0 - signal inactive.
      
        If the argument is supplied then this method sets the signal level. The
        argument ``x`` can be anything that converts to a boolean. If it converts
        to ``True``, the signal is active, otherwise it is inactive.
      
        Correspondence between signal being active and actual logic level on the
        underlying pin depends on whether signal is inverted (active-low) or not.
        For non-inverted signal, active status corresponds to logical 1, inactive -
        to logical 0. For inverted/active-low signal, active status corresponds
        to logical 0, while inactive - to logical 1.
        """
        
    @overload
    def value(self, x: Any, /) -> None:
        """
        This method allows to set and get the value of the signal, depending on whether
        the argument ``x`` is supplied or not.
       
        If the argument is omitted then this method gets the signal level, 1 meaning
        signal is asserted (active) and 0 - signal inactive.
      
        If the argument is supplied then this method sets the signal level. The
        argument ``x`` can be anything that converts to a boolean. If it converts
        to ``True``, the signal is active, otherwise it is inactive.
      
        Correspondence between signal being active and actual logic level on the
        underlying pin depends on whether signal is inverted (active-low) or not.
        For non-inverted signal, active status corresponds to logical 1, inactive -
        to logical 0. For inverted/active-low signal, active status corresponds
        to logical 0, while inactive - to logical 1.
        """
        
    def on(self) -> None:
        """
        Activate signal.
        """
        
    def off(self) -> None:
        """
        Deactivate signal.
        """


class ADC:
    """
    The ADC class provides an interface to analog-to-digital convertors, and
    represents a single endpoint that can sample a continuous voltage and
    convert it to a discretised value.
   
    Example usage::
   
        import machine
        
        adc = machine.ADC(pin)   # create an ADC object acting on a pin
        val = adc.read_u16()     # read a raw analog value in the range 0-65535
    
    """

    def __init__(self, pin: int | Pin, /):
        """
        Access the ADC associated with a source identified by *id*.  This
        *id* may be an integer (usually specifying a channel number), a
        :ref:`Pin <machine.Pin>` object, or other value supported by the
        underlying machine.
        """
        
    def read_u16(self) -> int:
        """
        Take an analog reading and return an integer in the range 0-65535.
        The return value represents the raw reading taken by the ADC, scaled
        such that the minimum value is 0 and the maximum value is 65535.
        """


# noinspection PyShadowingNames
class PWM:
    """
    This class provides pulse width modulation output.
   
    Example usage::
   
        from machine import PWM
        
        pwm = PWM(pin)          # create a PWM object on a pin
        pwm.duty_u16(32768)     # set duty to 50%
        
        # reinitialise with a period of 200us, duty of 5us
        pwm.init(freq=5000, duty_ns=5000)
        
        pwm.duty_ns(3000)       # set pulse width to 3us
        
        pwm.deinit()
    
    """

    def __init__(
        self,
        dest: Pin | int,
        /,
        *,
        freq: int = ...,
        duty_u16: int = ...,
        duty_ns: int = ...,
    ):
        """
        Construct and return a new PWM object using the following parameters:
      
          - *dest* is the entity on which the PWM is output, which is usually a
            :ref:`machine.Pin <machine.Pin>` object, but a port may allow other values,
            like integers.
          - *freq* should be an integer which sets the frequency in Hz for the
            PWM cycle.
          - *duty_u16* sets the duty cycle as a ratio ``duty_u16 / 65535``.
          - *duty_ns* sets the pulse width in nanoseconds.
      
        Setting *freq* may affect other PWM objects if the objects share the same
        underlying PWM generator (this is hardware specific).
        Only one of *duty_u16* and *duty_ns* should be specified at a time.
        """
        
    def init(self, *, freq: int = ..., duty_u16: int = ..., duty_ns: int = ...) -> None:
        """
        Modify settings for the PWM object.  See the above constructor for details
        about the parameters.
        """
        
    def deinit(self) -> None:
        """
        Disable the PWM output.
        """
    
    @overload
    def freq(self) -> int:
        """
        Get or set the current frequency of the PWM output.
      
        With no arguments the frequency in Hz is returned.
      
        With a single *value* argument the frequency is set to that value in Hz.  The
        method may raise a ``ValueError`` if the frequency is outside the valid range.
        """
    
    @overload
    def freq(self, value: int, /,) -> None:
        """
        Get or set the current frequency of the PWM output.
      
        With no arguments the frequency in Hz is returned.
      
        With a single *value* argument the frequency is set to that value in Hz.  The
        method may raise a ``ValueError`` if the frequency is outside the valid range.
        """
        
    @overload
    def duty_u16(self) -> int:
        """
        Get or set the current duty cycle of the PWM output, as an unsigned 16-bit
        value in the range 0 to 65535 inclusive.
      
        With no arguments the duty cycle is returned.
      
        With a single *value* argument the duty cycle is set to that value, measured
        as the ratio ``value / 65535``.
        """
        
    @overload
    def duty_u16(self, value: int, /,) -> None:
        """
        Get or set the current duty cycle of the PWM output, as an unsigned 16-bit
        value in the range 0 to 65535 inclusive.
      
        With no arguments the duty cycle is returned.
      
        With a single *value* argument the duty cycle is set to that value, measured
        as the ratio ``value / 65535``.
        """
        
    @overload
    def duty_ns(self) -> int:
        """
        Get or set the current pulse width of the PWM output, as a value in nanoseconds.
      
        With no arguments the pulse width in nanoseconds is returned.
      
        With a single *value* argument the pulse width is set to that value.
        """
        
    @overload
    def duty_ns(self, value: int, /,) -> None:
        """
        Get or set the current pulse width of the PWM output, as a value in nanoseconds.
      
        With no arguments the pulse width in nanoseconds is returned.
      
        With a single *value* argument the pulse width is set to that value.
        """

class UART:
    """
    UART implements the standard UART/USART duplex serial communications protocol.  At
    the physical level it consists of 2 lines: RX and TX.  The unit of communication
    is a character (not to be confused with a string character) which can be 8 or 9
    bits wide.
   
    UART objects can be created and initialised using::
   
        from machine import UART
   
        uart = UART(1, 9600)                         # init with given baudrate
        uart.init(9600, bits=8, parity=None, stop=1) # init with given parameters
   
    Supported parameters differ on a board:
   
    Pyboard: Bits can be 7, 8 or 9. Stop can be 1 or 2. With *parity=None*,
    only 8 and 9 bits are supported.  With parity enabled, only 7 and 8 bits
    are supported.
   
    WiPy/CC3200: Bits can be 5, 6, 7, 8. Stop can be 1 or 2.
   
    A UART object acts like a `stream` object and reading and writing is done
    using the standard stream methods::
   
        uart.read(10)       # read 10 characters, returns a bytes object
        uart.read()         # read all available characters
        uart.readline()     # read a line
        uart.readinto(buf)  # read and store into the given buffer
        uart.write('abc')   # write the 3 characters
    """

    RX_ANY: ClassVar[int] = ...
    """
    IRQ trigger sources

    Availability: WiPy.
    """
    
    @overload
    def __init__(
        self,
        id: int | str,
        baudrate: int = 9600,
        bits: int = 8,
        parity: int | None = None,
        stop: int = 1,
        /,
        *,
        tx: Pin | None = None,
        rx: Pin | None = None,
        txbuf: int | None = None,
        rxbuf: int | None = None,
        timeout: int | None = None,
        timeout_char: int | None = None,
        invert: int | None = None,
    ):
        """
        Construct a UART object of the given id.
        """
        
    @overload
    def __init__(
        self,
        id: int | str,
        baudrate: int = 9600,
        bits: int = 8,
        parity: int | None = None,
        stop: int = 1,
        /,
        *,
        pins: tuple[Pin, Pin] | None = None,
    ):
        """
        Construct a UART object of the given id.
        """
        
    @overload
    def __init__(
        self,
        id: int | str,
        baudrate: int = 9600,
        bits: int = 8,
        parity: int | None = None,
        stop: int = 1,
        /,
        *,
        pins: tuple[Pin, Pin, Pin, Pin] | None = None,
    ):
        """
        Construct a UART object of the given id.
        """
        
    @overload
    def init(
        self,
        baudrate: int = 9600,
        bits: int = 8,
        parity: int | None = None,
        stop: int = 1,
        /,
        *,
        tx: Pin | None = None,
        rx: Pin | None = None,
        txbuf: int | None = None,
        rxbuf: int | None = None,
        timeout: int | None = None,
        timeout_char: int | None = None,
        invert: int | None = None,
    ) -> None:
        """
        Initialise the UART bus with the given parameters:
      
        - *baudrate* is the clock rate.
        - *bits* is the number of bits per character, 7, 8 or 9.
        - *parity* is the parity, ``None``, 0 (even) or 1 (odd).
        - *stop* is the number of stop bits, 1 or 2.
      
        Additional keyword-only parameters that may be supported by a port are:
      
        - *tx* specifies the TX pin to use.
        - *rx* specifies the RX pin to use.
        - *rts* specifies the RTS (output) pin to use for hardware receive flow control.
        - *cts* specifies the CTS (input) pin to use for hardware transmit flow control.
        - *txbuf* specifies the length in characters of the TX buffer.
        - *rxbuf* specifies the length in characters of the RX buffer.
        - *timeout* specifies the time to wait for the first character (in ms).
        - *timeout_char* specifies the time to wait between characters (in ms).
        - *invert* specifies which lines to invert.
        - *flow* specifies which hardware flow control signals to use. The value
          is a bitmask. 
      
          - ``0`` will ignore hardware flow control signals.
          - ``UART.RTS`` will enable receive flow control by using the RTS output pin to
            signal if the receive FIFO has sufficient space to accept more data.
          - ``UART.CTS`` will enable transmit flow control by pausing transmission when the
            CTS input pin signals that the receiver is running low on buffer space.
          - ``UART.RTS | UART.CTS`` will enable both, for full hardware flow control.
      
        On the WiPy only the following keyword-only parameter is supported:
      
        - *pins* is a 4 or 2 item list indicating the TX, RX, RTS and CTS pins (in that order).
          Any of the pins can be None if one wants the UART to operate with limited functionality.
          If the RTS pin is given the the RX pin must be given as well. The same applies to CTS.
          When no pins are given, then the default set of TX and RX pins is taken, and hardware
          flow control will be disabled. If *pins* is ``None``, no pin assignment will be made.
        """
        
    @overload
    def init(
        self,
        baudrate: int = 9600,
        bits: int = 8,
        parity: int | None = None,
        stop: int = 1,
        /,
        *,
        pins: tuple[Pin, Pin] | None = None,
    ) -> None:
        """
        Initialise the UART bus with the given parameters:
      
        - *baudrate* is the clock rate.
        - *bits* is the number of bits per character, 7, 8 or 9.
        - *parity* is the parity, ``None``, 0 (even) or 1 (odd).
        - *stop* is the number of stop bits, 1 or 2.
      
        Additional keyword-only parameters that may be supported by a port are:
      
        - *tx* specifies the TX pin to use.
        - *rx* specifies the RX pin to use.
        - *rts* specifies the RTS (output) pin to use for hardware receive flow control.
        - *cts* specifies the CTS (input) pin to use for hardware transmit flow control.
        - *txbuf* specifies the length in characters of the TX buffer.
        - *rxbuf* specifies the length in characters of the RX buffer.
        - *timeout* specifies the time to wait for the first character (in ms).
        - *timeout_char* specifies the time to wait between characters (in ms).
        - *invert* specifies which lines to invert.
        - *flow* specifies which hardware flow control signals to use. The value
          is a bitmask. 
      
          - ``0`` will ignore hardware flow control signals.
          - ``UART.RTS`` will enable receive flow control by using the RTS output pin to
            signal if the receive FIFO has sufficient space to accept more data.
          - ``UART.CTS`` will enable transmit flow control by pausing transmission when the
            CTS input pin signals that the receiver is running low on buffer space.
          - ``UART.RTS | UART.CTS`` will enable both, for full hardware flow control.
      
        On the WiPy only the following keyword-only parameter is supported:
      
        - *pins* is a 4 or 2 item list indicating the TX, RX, RTS and CTS pins (in that order).
          Any of the pins can be None if one wants the UART to operate with limited functionality.
          If the RTS pin is given the the RX pin must be given as well. The same applies to CTS.
          When no pins are given, then the default set of TX and RX pins is taken, and hardware
          flow control will be disabled. If *pins* is ``None``, no pin assignment will be made.
        """
        
    @overload
    def init(
        self,
        baudrate: int = 9600,
        bits: int = 8,
        parity: int | None = None,
        stop: int = 1,
        /,
        *,
        pins: tuple[Pin, Pin, Pin, Pin] | None = None,
    ) -> None:
        """
        Initialise the UART bus with the given parameters:
      
        - *baudrate* is the clock rate.
        - *bits* is the number of bits per character, 7, 8 or 9.
        - *parity* is the parity, ``None``, 0 (even) or 1 (odd).
        - *stop* is the number of stop bits, 1 or 2.
      
        Additional keyword-only parameters that may be supported by a port are:
      
        - *tx* specifies the TX pin to use.
        - *rx* specifies the RX pin to use.
        - *rts* specifies the RTS (output) pin to use for hardware receive flow control.
        - *cts* specifies the CTS (input) pin to use for hardware transmit flow control.
        - *txbuf* specifies the length in characters of the TX buffer.
        - *rxbuf* specifies the length in characters of the RX buffer.
        - *timeout* specifies the time to wait for the first character (in ms).
        - *timeout_char* specifies the time to wait between characters (in ms).
        - *invert* specifies which lines to invert.
        - *flow* specifies which hardware flow control signals to use. The value
          is a bitmask. 
      
          - ``0`` will ignore hardware flow control signals.
          - ``UART.RTS`` will enable receive flow control by using the RTS output pin to
            signal if the receive FIFO has sufficient space to accept more data.
          - ``UART.CTS`` will enable transmit flow control by pausing transmission when the
            CTS input pin signals that the receiver is running low on buffer space.
          - ``UART.RTS | UART.CTS`` will enable both, for full hardware flow control.
      
        On the WiPy only the following keyword-only parameter is supported:
      
        - *pins* is a 4 or 2 item list indicating the TX, RX, RTS and CTS pins (in that order).
          Any of the pins can be None if one wants the UART to operate with limited functionality.
          If the RTS pin is given the the RX pin must be given as well. The same applies to CTS.
          When no pins are given, then the default set of TX and RX pins is taken, and hardware
          flow control will be disabled. If *pins* is ``None``, no pin assignment will be made.
        """
        
    def deinit(self) -> None:
        """
        Turn off the UART bus.
        """
        
    def any(self) -> int:
        """
        Returns an integer counting the number of characters that can be read without
        blocking.  It will return 0 if there are no characters available and a positive
        number if there are characters.  The method may return 1 even if there is more
        than one character available for reading.
      
        For more sophisticated querying of available characters use select.poll::
      
            poll = select.poll()
            poll.register(uart, select.POLLIN)
            poll.poll(timeout)
            
        """
        
    @overload
    def read(self) -> bytes | None:
        """
        Read characters.  If ``nbytes`` is specified then read at most that many bytes,
        otherwise read as much data as possible. It may return sooner if a timeout
        is reached. The timeout is configurable in the constructor.
      
        Return value: a bytes object containing the bytes read in.  Returns ``None``
        on timeout.
        """
        
    @overload
    def read(self, nbytes: int, /) -> bytes | None:
        """
        Read characters.  If ``nbytes`` is specified then read at most that many bytes,
        otherwise read as much data as possible. It may return sooner if a timeout
        is reached. The timeout is configurable in the constructor.
      
        Return value: a bytes object containing the bytes read in.  Returns ``None``
        on timeout.
        """
        
    @overload
    def readinto(self, buf: AnyWritableBuf, /) -> int | None:
        """
        Read bytes into the ``buf``.  If ``nbytes`` is specified then read at most
        that many bytes.  Otherwise, read at most ``len(buf)`` bytes. It may return sooner if a timeout
        is reached. The timeout is configurable in the constructor.
      
        Return value: number of bytes read and stored into ``buf`` or ``None`` on
        timeout.
        """
        
    @overload
    def readinto(self, buf: AnyWritableBuf, nbytes: int, /) -> int | None:
        """
        Read bytes into the ``buf``.  If ``nbytes`` is specified then read at most
        that many bytes.  Otherwise, read at most ``len(buf)`` bytes. It may return sooner if a timeout
        is reached. The timeout is configurable in the constructor.
      
        Return value: number of bytes read and stored into ``buf`` or ``None`` on
        timeout.
        """
        
    def readline(self) -> bytes | None:
        """
        Read a line, ending in a newline character. It may return sooner if a timeout
        is reached. The timeout is configurable in the constructor.
      
        Return value: the line read or ``None`` on timeout.
        """
        
    def write(self, buf: AnyReadableBuf, /) -> int | None:
        """
        Write the buffer of bytes to the bus.
      
        Return value: number of bytes written or ``None`` on timeout.
        """
        
    def sendbreak(self) -> None:
        """
        Send a break condition on the bus. This drives the bus low for a duration
        longer than required for a normal transmission of a character.
        """
        
    def irq(
        self,
        trigger: int,
        priority: int = 1,
        handler: Callable[[UART], None] | None = None,
        wake: int = IDLE,
        /,
    ) -> Any:
        """
        Create a callback to be triggered when data is received on the UART.
      
        - *trigger* can only be ``UART.RX_ANY``
        - *priority* level of the interrupt. Can take values in the range 1-7.
          Higher values represent higher priorities.
        - *handler* an optional function to be called when new characters arrive.
        - *wake* can only be ``machine.IDLE``.
      
        .. note::
      
            The handler will be called whenever any of the following two conditions are met:
      
            - 8 new characters have been received.
            - At least 1 new character is waiting in the Rx buffer and the Rx line has been
              silent for the duration of 1 complete frame.
      
            This means that when the handler function is called there will be between 1 to 8
            characters waiting.
      
        Returns an irq object.
      
        Availability: WiPy.
        """

class SPI:
    """
     SPI is a synchronous serial protocol that is driven by a controller. At the
     physical level, a bus consists of 3 lines: SCK, MOSI, MISO. Multiple devices
     can share the same bus. Each device should have a separate, 4th signal,
     CS (Chip Select), to select a particular device on a bus with which
     communication takes place. Management of a CS signal should happen in
     user code (via machine.Pin class).
   
     Both hardware and software SPI implementations exist via the
     :ref:`machine.SPI <machine.SPI>` and `machine.SoftSPI` classes.  Hardware SPI uses underlying
     hardware support of the system to perform the reads/writes and is usually
     efficient and fast but may have restrictions on which pins can be used.
     Software SPI is implemented by bit-banging and can be used on any pin but
     is not as efficient.  These classes have the same methods available and
     differ primarily in the way they are constructed.
     """

    CONTROLLER: ClassVar[int] = ...
    """
    for initialising the SPI bus to controller; this is only used for the WiPy
    """

    MSB: ClassVar[int] = ...
    """
    set the first bit to be the most significant bit
    """

    LSB: ClassVar[int] = ...
    """
    set the first bit to be the least significant bit
    """
    
    class Bus:
        
        def __init__(
            self,
            *,
            host: int,
            mosi: int,
            miso: int,
            sck: int,
            quad_pins: Optional[tuple[int]] = None,
            octal_pins: Optional[tuple[int]] = None
        ):
            """
            Construct an SPI object on the given bus, *id*. Values of *id* depend
            on a particular port and its hardware. Values 0, 1, etc. are commonly used
            to select hardware SPI block #0, #1, etc.
          
            With no additional parameters, the SPI object is created but not
            initialised (it has the settings from the last initialisation of
            the bus, if any).  If extra arguments are given, the bus is initialised.
            See ``init`` for parameters of initialisation.
            """
        
        def deinit(self) -> None:
            """
            Turn off the SPI bus.
            """
            
    class Device:
        
        def __init__(
            self,
            *,
            spi_bus: "SPI.Bus",
            freq: int,  # NOQA
            cs: int,
            polarity: int = 0,
            phase: int = 0,
            bits: int = 8,
            firstbit: int = "SPI.MSB",
            dual: bool = False,
            quad: bool = False,
            octal: bool = False
        ):
            ...
        
        def deinit(self) -> None:
            """
            Turn off the SPI device.
            """
        
        def read(self, nbytes: int, write: int = 0x00, /) -> bytes:
            """
            Read a number of bytes specified by ``nbytes`` while continuously writing
            the single byte given by ``write``.
            Returns a ``bytes`` object with the data that was read.
           """
            
        def readinto(self, buf: AnyWritableBuf, write: int = 0x00, /) -> int | None:
            """
            Read into the buffer specified by ``buf`` while continuously writing the
            single byte given by ``write``.
            Returns ``None``.
           
            Note: on WiPy this function returns the number of bytes read.
            """
            
        def write(self, buf: AnyReadableBuf, /) -> int | None:
            """
            Write the bytes contained in ``buf``.
            Returns ``None``.
           
            Note: on WiPy this function returns the number of bytes written.
            """
            
        def write_readinto(
            self, write_buf: AnyReadableBuf, read_buf: AnyWritableBuf, /
        ) -> int | None:
            """
            Write the bytes from ``write_buf`` while reading into ``read_buf``.  The
            buffers can be the same or different, but both buffers must have the
            same length.
            Returns ``None``.
           
            Note: on WiPy this function returns the number of bytes written.
            """

# noinspection PyShadowingNames
class I2C:
    """
    I2C is a two-wire protocol for communicating between devices.  At the physical
    level it consists of 2 wires: SCL and SDA, the clock and data lines respectively.
   
    I2C objects are created attached to a specific bus.  They can be initialised
    when created, or initialised later on.
   
    Printing the I2C object gives you information about its configuration.
   
    Both hardware and software I2C implementations exist via the
    :ref:`machine.I2C <machine.I2C>` and `machine.SoftI2C` classes.  Hardware I2C uses
    underlying hardware support of the system to perform the reads/writes and is
    usually efficient and fast but may have restrictions on which pins can be used.
    Software I2C is implemented by bit-banging and can be used on any pin but is not
    as efficient.  These classes have the same methods available and differ primarily
    in the way they are constructed.
   
    Example usage::
   
        from machine import I2C
   
        i2c = I2C(freq=400000)          # create I2C peripheral at frequency of 400kHz
                                        # depending on the port, extra parameters may be required
                                        # to select the peripheral and/or pins to use
        
        i2c.scan()                      # scan for peripherals, returning a list of 7-bit addresses
        
        i2c.writeto(42, b'123')         # write 3 bytes to peripheral with 7-bit address 42
        i2c.readfrom(42, 4)             # read 4 bytes from peripheral with 7-bit address 42
        
        i2c.readfrom_mem(42, 8, 3)      # read 3 bytes from memory of peripheral 42,
                                        #   starting at memory-address 8 in the peripheral
        i2c.writeto_mem(42, 2, b'\x10') # write 1 byte to memory of peripheral 42
                                        #   starting at address 2 in the peripheral

    """

    @overload
    def __init__(self, id: int, /, *, freq: int = 400_000):
        """
        Construct and return a new I2C object using the following parameters:
      
        - *id* identifies a particular I2C peripheral.  Allowed values for
          depend on the particular port/board
        - *scl* should be a pin object specifying the pin to use for SCL.
        - *sda* should be a pin object specifying the pin to use for SDA.
        - *freq* should be an integer which sets the maximum frequency
          for SCL.
      
        Note that some ports/boards will have default values of *scl* and *sda*
        that can be changed in this constructor.  Others will have fixed values
        of *scl* and *sda* that cannot be changed.
        """
        
    @overload
    def __init__(self, id: int, /, *, scl: Pin, sda: Pin, freq: int = 400_000):
        """
        Construct and return a new I2C object using the following parameters:
      
        - *id* identifies a particular I2C peripheral.  Allowed values for
          depend on the particular port/board
        - *scl* should be a pin object specifying the pin to use for SCL.
        - *sda* should be a pin object specifying the pin to use for SDA.
        - *freq* should be an integer which sets the maximum frequency
          for SCL.
      
        Note that some ports/boards will have default values of *scl* and *sda*
        that can be changed in this constructor.  Others will have fixed values
        of *scl* and *sda* that cannot be changed.
        """
        
    @overload
    def init(self, *, freq: int = 400_000) -> None:
        """
        Initialise the I2C bus with the given arguments:
     
        - *scl* is a pin object for the SCL line
        - *sda* is a pin object for the SDA line
        - *freq* is the SCL clock rate
        """
        
    @overload
    def init(self, *, scl: Pin, sda: Pin, freq: int = 400_000) -> None:
        """
        Initialise the I2C bus with the given arguments:
     
        - *scl* is a pin object for the SCL line
        - *sda* is a pin object for the SDA line
        - *freq* is the SCL clock rate
        """
        
    def deinit(self) -> None:
        """
        Turn off the I2C bus.
      
        Availability: WiPy.
        """
        
    def scan(self) -> list[int]:
        """
        Scan all I2C addresses between 0x08 and 0x77 inclusive and return a list of
        those that respond.  A device responds if it pulls the SDA line low after
        its address (including a write bit) is sent on the bus.
        """
        
    def start(self) -> None:
        """
        Generate a START condition on the bus (SDA transitions to low while SCL is high).
      
      
        Primitive I2C operations
        ------------------------
      
        The following methods implement the primitive I2C controller bus operations and can
        be combined to make any I2C transaction.  They are provided if you need more
        control over the bus, otherwise the standard methods (see below) can be used.
      
        These methods are only available on the `machine.SoftI2C` class.
        """
        
    def stop(self) -> None:
        """
        Generate a STOP condition on the bus (SDA transitions to high while SCL is high).
      
        Primitive I2C operations
        ------------------------
      
        The following methods implement the primitive I2C controller bus operations and can
        be combined to make any I2C transaction.  They are provided if you need more
        control over the bus, otherwise the standard methods (see below) can be used.
      
        These methods are only available on the `machine.SoftI2C` class.
        """
        
    def readinto(self, buf: AnyWritableBuf, nack: bool = True, /) -> None:
        """
        Reads bytes from the bus and stores them into *buf*.  The number of bytes
        read is the length of *buf*.  An ACK will be sent on the bus after
        receiving all but the last byte.  After the last byte is received, if *nack*
        is true then a NACK will be sent, otherwise an ACK will be sent (and in this
        case the peripheral assumes more bytes are going to be read in a later call).
            
        Primitive I2C operations
        ------------------------
      
        The following methods implement the primitive I2C controller bus operations and can
        be combined to make any I2C transaction.  They are provided if you need more
        control over the bus, otherwise the standard methods (see below) can be used.
      
        These methods are only available on the `machine.SoftI2C` class.
        """
        
    def write(self, buf: AnyReadableBuf, /) -> int:
        """
        Write the bytes from *buf* to the bus.  Checks that an ACK is received
        after each byte and stops transmitting the remaining bytes if a NACK is
        received.  The function returns the number of ACKs that were received.
        
        Primitive I2C operations
        ------------------------
        
        The following methods implement the primitive I2C controller bus operations and can
        be combined to make any I2C transaction.  They are provided if you need more
        control over the bus, otherwise the standard methods (see below) can be used.
      
        These methods are only available on the `machine.SoftI2C` class.
        """
        
    def readfrom(self, addr: int, nbytes: int, stop: bool = True, /) -> bytes:
        """
        Read *nbytes* from the peripheral specified by *addr*.
        If *stop* is true then a STOP condition is generated at the end of the transfer.
        Returns a `bytes` object with the data read.
      
        Standard bus operations
        -----------------------
      
        The following methods implement the standard I2C controller read and write
        operations that target a given peripheral device.
        """
        
    def readfrom_into(
        self, addr: int, buf: AnyWritableBuf, stop: bool = True, /
    ) -> None:
        """
        Read into *buf* from the peripheral specified by *addr*.
        The number of bytes read will be the length of *buf*.
        If *stop* is true then a STOP condition is generated at the end of the transfer.
      
        The method returns ``None``.
        
        Standard bus operations
        -----------------------
      
        The following methods implement the standard I2C controller read and write
        operations that target a given peripheral device.
        """
        
    def writeto(self, addr: int, buf: AnyReadableBuf, stop: bool = True, /) -> int:
        """
        Write the bytes from *buf* to the peripheral specified by *addr*.  If a
        NACK is received following the write of a byte from *buf* then the
        remaining bytes are not sent.  If *stop* is true then a STOP condition is
        generated at the end of the transfer, even if a NACK is received.
        The function returns the number of ACKs that were received.
      
        Standard bus operations
        -----------------------
      
        The following methods implement the standard I2C controller read and write
        operations that target a given peripheral device.
        """
        
    def writevto(
        self, addr: int, vector: Sequence[AnyReadableBuf], stop: bool = True, /
    ) -> int:
        """
        Write the bytes contained in *vector* to the peripheral specified by *addr*.
        *vector* should be a tuple or list of objects with the buffer protocol.
        The *addr* is sent once and then the bytes from each object in *vector*
        are written out sequentially.  The objects in *vector* may be zero bytes
        in length in which case they don't contribute to the output.
      
        If a NACK is received following the write of a byte from one of the
        objects in *vector* then the remaining bytes, and any remaining objects,
        are not sent.  If *stop* is true then a STOP condition is generated at
        the end of the transfer, even if a NACK is received.  The function
        returns the number of ACKs that were received.
      
        Standard bus operations
        -----------------------
      
        The following methods implement the standard I2C controller read and write
        operations that target a given peripheral device.
        """
        
    def readfrom_mem(
        self, addr: int, memaddr: int, nbytes: int, /, *, addrsize: int = 8
    ) -> bytes:
        """
        Read *nbytes* from the peripheral specified by *addr* starting from the memory
        address specified by *memaddr*.
        The argument *addrsize* specifies the address size in bits.
        Returns a `bytes` object with the data read.
      
        Memory operations
        -----------------
      
        Some I2C devices act as a memory device (or set of registers) that can be read
        from and written to.  In this case there are two addresses associated with an
        I2C transaction: the peripheral address and the memory address.  The following
        methods are convenience functions to communicate with such devices.
        """
        
    def readfrom_mem_into(
        self, addr: int, memaddr: int, buf: AnyWritableBuf, /, *, addrsize: int = 8
    ) -> None:
        """
        Read into *buf* from the peripheral specified by *addr* starting from the
        memory address specified by *memaddr*.  The number of bytes read is the
        length of *buf*.
        The argument *addrsize* specifies the address size in bits (on ESP8266
        this argument is not recognised and the address size is always 8 bits).
      
        The method returns ``None``.
      
        Memory operations
        -----------------
      
        Some I2C devices act as a memory device (or set of registers) that can be read
        from and written to.  In this case there are two addresses associated with an
        I2C transaction: the peripheral address and the memory address.  The following
        methods are convenience functions to communicate with such devices.
        """
        
    def writeto_mem(
        self, addr: int, memaddr: int, buf: AnyReadableBuf, /, *, addrsize: int = 8
    ) -> None:
        """
        Write *buf* to the peripheral specified by *addr* starting from the
        memory address specified by *memaddr*.
        The argument *addrsize* specifies the address size in bits (on ESP8266
        this argument is not recognised and the address size is always 8 bits).
      
        The method returns ``None``.
      
        Memory operations
        -----------------
      
        Some I2C devices act as a memory device (or set of registers) that can be read
        from and written to.  In this case there are two addresses associated with an
        I2C transaction: the peripheral address and the memory address.  The following
        methods are convenience functions to communicate with such devices.
        """

class I2S:
    """
    I2S is a synchronous serial protocol used to connect digital audio devices. 
    At the physical level, a bus consists of 3 lines: SCK, WS, SD.
    The I2S class supports controller operation.  Peripheral operation is not supported.
   
    The I2S class is currently available as a Technical Preview.  During the preview period, feedback from 
    users is encouraged.  Based on this feedback, the I2S class API and implementation may be changed.
   
    I2S objects can be created and initialized using::
   
        from machine import I2S
        from machine import Pin
        
        # ESP32
        sck_pin = Pin(14)   # Serial clock output
        ws_pin = Pin(13)    # Word clock output
        sd_pin = Pin(12)    # Serial data output
    
    or
       
        # PyBoards
        sck_pin = Pin("Y6")   # Serial clock output
        ws_pin = Pin("Y5")    # Word clock output
        sd_pin = Pin("Y8")    # Serial data output
       
        audio_out = I2S(2, 
                        sck=sck_pin, ws=ws_pin, sd=sd_pin,
                        mode=I2S.TX, 
                        bits=16,                       
                        format=I2S.MONO,
                        rate=44100, 
                        ibuf=20000)
        
        audio_in = I2S(2, 
                       sck=sck_pin, ws=ws_pin, sd=sd_pin,
                       mode=I2S.RX, 
                       bits=32,                       
                       format=I2S.STEREO,
                       rate=22050, 
                       ibuf=20000)
                       
    3 modes of operation are supported:
    - blocking 
    - non-blocking 
    - uasyncio
     
    blocking::
    
        num_written = audio_out.write(buf) # blocks until buf emptied
   
        num_read = audio_in.readinto(buf) # blocks until buf filled
      
    non-blocking::
    
        audio_out.irq(i2s_callback)         # i2s_callback is called when buf is emptied
        num_written = audio_out.write(buf)  # returns immediately
           
        audio_in.irq(i2s_callback)          # i2s_callback is called when buf is filled
        num_read = audio_in.readinto(buf)   # returns immediately    
    
    uasyncio::
    
        swriter = uasyncio.StreamWriter(audio_out)
        swriter.write(buf)
        await swriter.drain()
      
        sreader = uasyncio.StreamReader(audio_in)
        num_read = await sreader.readinto(buf)
        
    """

    RX: ClassVar[int] = ...
    """
    for initialising the I2S bus ``mode`` to receive
    """

    TX: ClassVar[int] = ...
    """
    for initialising the I2S bus ``mode`` to transmit
    """

    STEREO: ClassVar[int] = ...
    """
    for initialising the I2S bus ``format`` to stereo
    """

    MONO: ClassVar[int] = ...
    """
    for initialising the I2S bus ``format`` to mono
    """
    
    def __init__(
        self,
        id: int,
        /,
        *,
        sck: Pin,
        ws: Pin,
        sd: Pin,
        mode: int,
        bits: int,
        format: int,
        rate: int,
        ibuf: int,
    ):
        """
        Construct an I2S object of the given id:
      
        - ``id`` identifies a particular I2S bus.  
      
        ``id`` is board and port specific:
      
          - PYBv1.0/v1.1: has one I2S bus with id=2.
          - PYBD-SFxW: has two I2S buses with id=1 and id=2. 
          - ESP32: has two I2S buses with id=0 and id=1. 
      
        Keyword-only parameters that are supported on all ports:
       
          - ``sck`` is a pin object for the serial clock line
          - ``ws`` is a pin object for the word select line
          - ``sd`` is a pin object for the serial data line
          - ``mode`` specifies receive or transmit
          - ``bits`` specifies sample size (bits), 16 or 32
          - ``format`` specifies channel format, STEREO or MONO
          - ``rate`` specifies audio sampling rate (samples/s)
          - ``ibuf`` specifies internal buffer length (bytes)
        
        For all ports, DMA runs continuously in the background and allows user applications to perform other operations while 
        sample data is transfered between the internal buffer and the I2S peripheral unit. 
        Increasing the size of the internal buffer has the potential to increase the time that user applications can perform non-I2S operations
        before underflow (e.g. ``write`` method) or overflow (e.g. ``readinto`` method).
        """
        
        
    def init(
        self,
        *,
        sck: Pin,
        ws: Pin,
        sd: Pin,
        mode: int,
        bits: int,
        format: int,
        rate: int,
        ibuf: int,
    ) -> None:
        """
        see Constructor for argument descriptions
        """
        
    def deinit(self) -> None:
        """
        Deinitialize the I2S bus
        """
        
    def readinto(self, buf: AnyWritableBuf, /,) -> int:
        """
        Read audio samples into the buffer specified by ``buf``.  ``buf`` must support the buffer protocol, such as bytearray or array. 
        "buf" byte ordering is little-endian.  For Stereo format, left channel sample precedes right channel sample. For Mono format, 
        the left channel sample data is used.
        Returns number of bytes read
        """
        
    def write(self, buf: AnyReadableBuf, /,) -> int:
        """
        Write audio samples contained in ``buf``. ``buf`` must support the buffer protocol, such as bytearray or array.
        "buf" byte ordering is little-endian.  For Stereo format, left channel sample precedes right channel sample. For Mono format, 
        the sample data is written to both the right and left channels.
        Returns number of bytes written
        """
        
    def irq(self, handler: Callable[[], None], /,) -> None:
        """
        Set a callback. ``handler`` is called when ``buf`` is emptied (``write`` method) or becomes full (``readinto`` method).  
        Setting a callback changes the ``write`` and ``readinto`` methods to non-blocking operation.
        ``handler`` is called in the context of the MicroPython scheduler.
        """
        
    @staticmethod
    def shift(buf: AnyWritableBuf, bits: int, shift: int, /,) -> None:
        """
        bitwise shift of all samples contained in ``buf``. ``bits`` specifies sample size in bits. ``shift`` specifies the number of bits to shift each sample. 
        Positive for left shift, negative for right shift. 
        Typically used for volume control.  Each bit shift changes sample volume by 6dB.
        """


class RTC:
    """
    The RTC is an independent clock that keeps track of the date
    and time.
   
    Example usage::
   
        rtc = machine.RTC()
        rtc.datetime((2020, 1, 21, 2, 10, 32, 36, 0))
        print(rtc.datetime())
   
    The documentation for RTC is in a poor state; better to experiment and use `dir`!
    """

    ALARM0: ClassVar[int] = ...
    """
    irq trigger source
    
    The documentation for RTC is in a poor state; better to experiment and use `dir`!
    """
    
    @overload
    def __init__(self, id: int = 0, /, *, datetime: tuple[int, int, int]):
        """
        Create an RTC object. See init for parameters of initialization.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def __init__(self, id: int = 0, /, *, datetime: tuple[int, int, int, int]):
        """
        Create an RTC object. See init for parameters of initialization.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def __init__(self, id: int = 0, /, *, datetime: tuple[int, int, int, int, int]):
        """
        Create an RTC object. See init for parameters of initialization.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def __init__(
        self, id: int = 0, /, *, datetime: tuple[int, int, int, int, int, int]
    ):
        """
        Create an RTC object. See init for parameters of initialization.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def __init__(
        self, id: int = 0, /, *, datetime: tuple[int, int, int, int, int, int, int]
    ):
        """
        Create an RTC object. See init for parameters of initialization.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def __init__(
        self, id: int = 0, /, *, datetime: tuple[int, int, int, int, int, int, int, int]
    ):
        """
        Create an RTC object. See init for parameters of initialization.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def init(self) -> None:
        """
        Initialise the RTC. Datetime is a tuple of the form:
      
        ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def init(self, datetime: tuple[int, int, int], /) -> None:
        """
        Initialise the RTC. Datetime is a tuple of the form:
      
        ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def init(self, datetime: tuple[int, int, int, int], /) -> None:
        """
        Initialise the RTC. Datetime is a tuple of the form:
      
        ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def init(self, datetime: tuple[int, int, int, int, int], /) -> None:
        """
        Initialise the RTC. Datetime is a tuple of the form:
      
        ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def init(self, datetime: tuple[int, int, int, int, int, int], /) -> None:
        """
        Initialise the RTC. Datetime is a tuple of the form:
      
        ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def init(self, datetime: tuple[int, int, int, int, int, int, int], /) -> None:
        """
        Initialise the RTC. Datetime is a tuple of the form:
      
        ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def init(self, datetime: tuple[int, int, int, int, int, int, int, int], /) -> None:
        """
        Initialise the RTC. Datetime is a tuple of the form:
      
        ``(year, month, day[, hour[, minute[, second[, microsecond[, tzinfo]]]]])``
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    def now(self) -> tuple[int, int, int, int, int, int, int, int]:
        """
        Get get the current datetime tuple.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    def deinit(self) -> None:
        """
        Resets the RTC to the time of January 1, 2015 and starts running it again.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def alarm(self, id: int, time: int, /, *, repeat: bool = False) -> None:
        """
        Set the RTC alarm. Time might be either a millisecond value to program the alarm to
        current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
        milliseconds, repeat can be set to ``True`` to make the alarm periodic.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def alarm(self, id: int, time: tuple[int, int, int], /) -> None:
        """
        Set the RTC alarm. Time might be either a millisecond value to program the alarm to
        current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
        milliseconds, repeat can be set to ``True`` to make the alarm periodic.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def alarm(self, id: int, time: tuple[int, int, int, int], /) -> None:
        """
        Set the RTC alarm. Time might be either a millisecond value to program the alarm to
        current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
        milliseconds, repeat can be set to ``True`` to make the alarm periodic.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def alarm(self, id: int, time: tuple[int, int, int, int, int], /) -> None:
        """
        Set the RTC alarm. Time might be either a millisecond value to program the alarm to
        current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
        milliseconds, repeat can be set to ``True`` to make the alarm periodic.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def alarm(self, id: int, time: tuple[int, int, int, int, int, int], /) -> None:
        """
        Set the RTC alarm. Time might be either a millisecond value to program the alarm to
        current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
        milliseconds, repeat can be set to ``True`` to make the alarm periodic.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def alarm(self, id: int, time: tuple[int, int, int, int, int, int, int], /) -> None:
        """
        Set the RTC alarm. Time might be either a millisecond value to program the alarm to
        current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
        milliseconds, repeat can be set to ``True`` to make the alarm periodic.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    @overload
    def alarm(
        self, id: int, time: tuple[int, int, int, int, int, int, int, int], /
    ) -> None:
        """
        Set the RTC alarm. Time might be either a millisecond value to program the alarm to
        current time + time_in_ms in the future, or a datetimetuple. If the time passed is in
        milliseconds, repeat can be set to ``True`` to make the alarm periodic.
        
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    def alarm_left(self, alarm_id: int = 0, /) -> int:
        """
        Get the number of milliseconds left before the alarm expires.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    def cancel(self, alarm_id: int = 0, /) -> None:
        """
        Cancel a running alarm.
      
        The documentation for RTC is in a poor state; better to experiment and use `dir`!
        """
        
    def irq(
        self,
        /,
        *,
        trigger: int,
        handler: Callable[[RTC], None] | None = None,
        wake: int = IDLE,
    ) -> None:
        """
        Create an irq object triggered by a real time clock alarm.
      
        - ``trigger`` must be ``RTC.ALARM0``
        - ``handler`` is the function to be called when the callback is triggered.
        - ``wake`` specifies the sleep mode from where this interrupt can wake
          up the system.
          
        """


class Timer:
    """
    Hardware timers deal with timing of periods and events. Timers are perhaps
    the most flexible and heterogeneous kind of hardware in MCUs and SoCs,
    differently greatly from a model to a model. MicroPython's Timer class
    defines a baseline operation of executing a callback with a given period
    (or once after some delay), and allow specific boards to define more
    non-standard behaviour (which thus won't be portable to other boards).
   
    See discussion of :ref:`important constraints <machine_callbacks>` on
    Timer callbacks.
   
    .. note::
   
        Memory can't be allocated inside irq handlers (an interrupt) and so
        exceptions raised within a handler don't give much information.  See
        :func:`micropython.alloc_emergency_exception_buf` for how to get around this
        limitation.
   
    If you are using a WiPy board please refer to :ref:`machine.TimerWiPy <machine.TimerWiPy>`
    instead of this class.
    """

    ONE_SHOT: ClassVar[int] = ...
    """
    Timer operating mode.
    """

    PERIODIC: ClassVar[int] = ...
    """
    Timer operating mode.
    """
    
    @overload
    def __init__(self, id: int, /):
        """
        Construct a new timer object of the given id. Id of -1 constructs a
        virtual timer (if supported by a board).
      
        See ``init`` for parameters of initialisation.
        """
        
    @overload
    def __init__(
        self,
        id: int,
        /,
        *,
        mode: int = PERIODIC,
        period: int = -1,
        callback: Callable[[Timer], None] | None = None,
    ):
        """
        Construct a new timer object of the given id. Id of -1 constructs a
        virtual timer (if supported by a board).
      
        See ``init`` for parameters of initialisation.
        """
        
    def init(
        self,
        *,
        mode: int = PERIODIC,
        period: int = -1,
        callback: Callable[[Timer], None] | None = None,
    ) -> None:
        """
        Initialise the timer. Example::
      
            tim.init(period=100)                         # periodic with 100ms period
            tim.init(mode=Timer.ONE_SHOT, period=1000)   # one shot firing after 1000ms
      
        Keyword arguments:
      
          - ``mode`` can be one of:
      
            - ``Timer.ONE_SHOT`` - The timer runs once until the configured period of the channel expires.
            - ``Timer.PERIODIC`` - The timer runs periodically at the configured frequency of the channel.
        
        """
        
    def deinit(self) -> None:
        """
        Deinitialises the timer. Stops the timer, and disables the timer peripheral.
        """


class WDT:
    """
    The WDT is used to restart the system when the application crashes and ends
    up into a non recoverable state. Once started it cannot be stopped or
    reconfigured in any way. After enabling, the application must "feed" the
    watchdog periodically to prevent it from expiring and resetting the system.
   
    Example usage::
   
        from machine import WDT
        wdt = WDT(timeout=2000)  # enable it with a timeout of 2s
        wdt.feed()
   
    Availability of this class: pyboard, WiPy, esp8266, esp32.
    """

    def __init__(self, *, id: int = 0, timeout: int = 5000):
        """
        Create a WDT object and start it. The timeout must be given in milliseconds.
        Once it is running the timeout cannot be changed and the WDT cannot be stopped either.
      
        Notes: On the esp32 the minimum timeout is 1 second. On the esp8266 a timeout
        cannot be specified, it is determined by the underlying system.
        """
        
    def feed(self) -> None:
        """
        Feed the WDT to prevent it from resetting the system. The application
        should place this call in a sensible place ensuring that the WDT is
        only fed after verifying that everything is functioning correctly.
        """


# noinspection PyShadowingNames
class SDCard(AbstractBlockDev):
    """
    SD cards are one of the most common small form factor removable storage media.
    SD cards come in a variety of sizes and physical form factors. MMC cards are
    similar removable storage devices while eMMC devices are electrically similar
    storage devices designed to be embedded into other systems. All three form
    share a common protocol for communication with their host system and high-level
    support looks the same for them all. As such in MicroPython they are implemented
    in a single class called :class:`machine.SDCard` .
   
    Both SD and MMC interfaces support being accessed with a variety of bus widths.
    When being accessed with a 1-bit wide interface they can be accessed using the
    SPI protocol. Different MicroPython hardware platforms support different widths
    and pin configurations but for most platforms there is a standard configuration
    for any given hardware. In general constructing an ``SDCard`` object with without
    passing any parameters will initialise the interface to the default card slot
    for the current hardware. The arguments listed below represent the common
    arguments that might need to be set in order to use either a non-standard slot
    or a non-standard pin assignment. The exact subset of arguments supported will
    vary from platform to platform.
   
    Implementation-specific details
    -------------------------------
   
    Different implementations of the ``SDCard`` class on different hardware support
    varying subsets of the options above.
   
    PyBoard
    ```````
   
    The standard PyBoard has just one slot. No arguments are necessary or supported.
   
    ESP32
    `````
   
    The ESP32 provides two channels of SD/MMC hardware and also supports
    access to SD Cards through either of the two SPI ports that are
    generally available to the user. As a result the *slot* argument can
    take a value between 0 and 3, inclusive. Slots 0 and 1 use the
    built-in SD/MMC hardware while slots 2 and 3 use the SPI ports. Slot 0
    supports 1, 4 or 8-bit wide access while slot 1 supports 1 or 4-bit
    access; the SPI slots only support 1-bit access.
   
    .. note:: Slot 0 is used to communicate with on-board flash memory
              on most ESP32 modules and so will be unavailable to the
              user.
   
    .. note:: Most ESP32 modules that provide an SD card slot using the
              dedicated hardware only wire up 1 data pin, so the default
              value for *width* is 1.
   
    The pins used by the dedicated SD/MMC hardware are fixed. The pins
    used by the SPI hardware can be reassigned.
   
    .. note:: If any of the SPI signals are remapped then all of the SPI
              signals will pass through a GPIO multiplexer unit which
              can limit the performance of high frequency signals. Since
              the normal operating speed for SD cards is 40MHz this can
              cause problems on some cards.
   
    The default (and preferred) pin assignment are as follows:
   
        ====== ====== ====== ====== ======
        Slot   0      1      2      3
        ------ ------ ------ ------ ------
        Signal   Pin    Pin    Pin    Pin
        ====== ====== ====== ====== ======
        sck       6     14     18     14
        cmd      11     15
        cs                      5     15
        miso                   19     12
        mosi                   23     13
        D0        7      2
        D1        8      4
        D2        9     12
        D3       10     13
        D4       16
        D5       17
        D6        5
        D7       18
        ====== ====== ====== ====== ======
   
    cc3200
    ``````
   
    You can set the pins used for SPI access by passing a tuple as the
    *pins* argument.
   
    *Note:* The current cc3200 SD card implementation names the this class
        :class:`machine.SD` rather than :class:`machine.SDCard` .
    """

    def __init__(
        self,
        *,
        slot: int = 1,
        width: int = 1,
        cd: int = -1,
        wp: int = -1,
        spi_bus: Optional[SPI.Bus] = None,
        cs: int = -1,
        freq: int = 20000000
    ):
        """
        This class provides access to SD or MMC storage cards using either
        a dedicated SD/MMC interface hardware or through an SPI channel.
        The class implements the block protocol defined by :class:`os.AbstractBlockDev`.
        This allows the mounting of an SD card to be as simple as::
       
            os.mount(machine.SDCard(), "/sd")
       
        The constructor takes the following parameters:
       
          - *slot* selects which of the available interfaces to use. Leaving this
            unset will select the default interface.  
          - *width* selects the bus width for the SD/MMC interface.
          - *cd* can be used to specify a card-detect pin.
          - *wp* can be used to specify a write-protect pin.
          - *sck* can be used to specify an SPI clock pin.
          - *miso* can be used to specify an SPI miso pin.
          - *mosi* can be used to specify an SPI mosi pin.
          - *cs* can be used to specify an SPI chip select pin.
          - *freq* selects the SD/MMC interface frequency in Hz (only supported on the ESP32).
        
        """