machine -- Functions related to the hardware. ============================================= .. This document was autogenerated by Sphinx-autoapi from a .pyi stub or a source code file. .. Do not edit this file, instead edit the source file and run Sphinx to update. .. Source: docs/stubs/machine/__init__.pyi .. py:module:: machine .. autoapi-nested-parse:: 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. Attributes ---------- .. autoapisummary:: machine.DEEPSLEEP machine.DEEPSLEEP_RESET machine.HARD_RESET machine.IDLE machine.PIN_WAKE machine.PWRON_RESET machine.RTC_WAKE machine.SLEEP machine.SOFT_RESET machine.WDT_RESET machine.WLAN_WAKE machine.mem16 machine.mem32 machine.mem8 Functions --------- .. autoapisummary:: machine.bitstream machine.bootloader machine.deepsleep machine.disable_irq machine.enable_irq machine.freq machine.idle machine.lightsleep machine.reset machine.reset_cause machine.rng machine.sleep machine.soft_reset machine.time_pulse_us machine.unique_id machine.wake_reason Module Contents --------------- .. py:function:: bitstream(pin, encoding, timing, data) -> _typeshed.Incomplete Transmits *data* by bit-banging the specified *pin*. The *encoding* argument specifies how the bits are encoded, and *timing* is an encoding-specific timing specification. The supported encodings are: - ``0`` for "high low" pulse duration modulation. This will transmit 0 and 1 bits as timed pulses, starting with the most significant bit. The *timing* must be a four-tuple of nanoseconds in the format ``(high_time_0, low_time_0, high_time_1, low_time_1)``. For example, ``(400, 850, 800, 450)`` is the timing specification for WS2812 RGB LEDs at 800kHz. The accuracy of the timing varies between ports. On Cortex M0 at 48MHz, it is at best +/- 120ns, however on faster MCUs (ESP8266, ESP32, STM32, Pyboard), it will be closer to +/-30ns. .. note:: For controlling WS2812 / NeoPixel strips, see the :mod:`neopixel` module for a higher-level API. .. py:function:: bootloader(value: Optional[Any] = None) -> None Reset the device and enter its bootloader. This is typically used to put the device into a state where it can be programmed with new firmware. Some ports support passing in an optional *value* argument which can control which bootloader to enter, what to pass to it, or other things. .. py:function:: deepsleep(time_ms: Optional[Any] = None) -> 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. .. py:function:: disable_irq() -> _typeshed.Incomplete 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. .. py:function:: enable_irq(state) -> _typeshed.Incomplete Re-enable interrupt requests. The *state* parameter should be the value that was returned from the most recent call to the `disable_irq()` function. .. py:function:: freq(hz: Optional[Any] = None) -> _typeshed.Incomplete Returns the CPU frequency in hertz. On some ports this can also be used to set the CPU frequency by passing in *hz*. .. py:function:: idle() -> _typeshed.Incomplete 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). .. py:function:: lightsleep(time_ms: Optional[Any] = None) -> _typeshed.Incomplete 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. .. py:function:: reset() -> NoReturn Resets the device in a manner similar to pushing the external RESET button. .. py:function:: reset_cause() -> int Get the reset cause. See :ref:`constants ` for the possible return values. .. py:function:: rng() -> int Return a 24-bit software generated random number. Availability: WiPy. .. py:function:: sleep() -> _typeshed.Incomplete .. note:: This function is deprecated, use `lightsleep()` instead with no arguments. .. py:function:: 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). .. py:function:: time_pulse_us(pin, pulse_level, timeout_us=1000000) -> 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). .. py:function:: 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. .. py:function:: wake_reason() -> _typeshed.Incomplete Get the wake reason. See :ref:`constants ` for the possible return values. Availability: ESP32, WiPy. .. py:data:: DEEPSLEEP :type: _typeshed.Incomplete IRQ wake values. .. py:data:: DEEPSLEEP_RESET :type: _typeshed.Incomplete Reset causes. .. py:data:: HARD_RESET :type: _typeshed.Incomplete Reset causes. .. py:data:: IDLE :type: _typeshed.Incomplete IRQ wake values. .. py:data:: PIN_WAKE :type: _typeshed.Incomplete Wake-up reasons. .. py:data:: PWRON_RESET :type: _typeshed.Incomplete Reset causes. .. py:data:: RTC_WAKE :type: _typeshed.Incomplete Wake-up reasons. .. py:data:: SLEEP :type: _typeshed.Incomplete IRQ wake values. .. py:data:: SOFT_RESET :type: _typeshed.Incomplete Reset causes. .. py:data:: WDT_RESET :type: _typeshed.Incomplete Reset causes. .. py:data:: WLAN_WAKE :type: _typeshed.Incomplete Wake-up reasons. .. py:data:: mem16 :type: _typeshed.Incomplete Read/write 16 bits of memory. .. py:data:: mem32 :type: int Read/write 32 bits of memory. .. py:data:: mem8 :type: _typeshed.Incomplete Read/write 8 bits of memory. .. moved block submodules to the end of the file. Submodules ---------- .. toctree:: :maxdepth: 1 /modules/machine/ADC/index /modules/machine/ADCBlock/index /modules/machine/ADCWiPy/index /modules/machine/I2C/index /modules/machine/I2S/index /modules/machine/PWM/index /modules/machine/Pin/index /modules/machine/RTC/index /modules/machine/SD/index /modules/machine/SDCard/index /modules/machine/SPI/index /modules/machine/Signal/index /modules/machine/Timer/index /modules/machine/TimerWiPy/index /modules/machine/UART/index /modules/machine/USBDevice/index /modules/machine/WDT/index