:mod:`microcontroller`
======================

.. py:module:: microcontroller

.. autoapi-nested-parse::

   Pin references and cpu functionality

   The `microcontroller` module defines the pins from the perspective of the
   microcontroller. See :py:mod:`board` for board-specific pin mappings.



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> 8086 Commander
    <li> @sarfata shIRtty
    <li> AITHinker ESP32-C3S_Kit
    <li> ARAMCON Badge 2019
    <li> ARAMCON2 Badge
    <li> ATMegaZero ESP32-S2
    <li> Adafruit BLM Badge
    <li> Adafruit CLUE nRF52840 Express
    <li> Adafruit Circuit Playground Bluefruit
    <li> Adafruit Circuit Playground Express 4-H
    <li> Adafruit CircuitPlayground Express
    <li> Adafruit CircuitPlayground Express with Crickit libraries
    <li> Adafruit CircuitPlayground Express with displayio
    <li> Adafruit EdgeBadge
    <li> Adafruit Feather Bluefruit Sense
    <li> Adafruit Feather ESP32-S2 TFT
    <li> Adafruit Feather ESP32S2
    <li> Adafruit Feather M0 Adalogger
    <li> Adafruit Feather M0 Basic
    <li> Adafruit Feather M0 Express
    <li> Adafruit Feather M0 Express with Crickit libraries
    <li> Adafruit Feather M0 RFM69
    <li> Adafruit Feather M0 RFM9x
    <li> Adafruit Feather M4 CAN
    <li> Adafruit Feather M4 Express
    <li> Adafruit Feather MIMXRT1011
    <li> Adafruit Feather RP2040
    <li> Adafruit Feather STM32F405 Express
    <li> Adafruit Feather nRF52840 Express
    <li> Adafruit FunHouse
    <li> Adafruit Gemma M0
    <li> Adafruit Gemma M0 PyCon 2018
    <li> Adafruit Grand Central M4 Express
    <li> Adafruit Hallowing M4 Express
    <li> Adafruit ItsyBitsy M0 Express
    <li> Adafruit ItsyBitsy M4 Express
    <li> Adafruit ItsyBitsy RP2040
    <li> Adafruit ItsyBitsy nRF52840 Express
    <li> Adafruit KB2040
    <li> Adafruit LED Glasses Driver nRF52840
    <li> Adafruit Macropad RP2040
    <li> Adafruit MagTag
    <li> Adafruit Matrix Portal M4
    <li> Adafruit Metro ESP32S2
    <li> Adafruit Metro M0 Express
    <li> Adafruit Metro M4 Airlift Lite
    <li> Adafruit Metro M4 Express
    <li> Adafruit Metro nRF52840 Express
    <li> Adafruit Monster M4SK
    <li> Adafruit NeoKey Trinkey M0
    <li> Adafruit NeoPixel Trinkey M0
    <li> Adafruit ProxLight Trinkey M0
    <li> Adafruit PyGamer
    <li> Adafruit PyPortal
    <li> Adafruit PyPortal Pynt
    <li> Adafruit PyPortal Titano
    <li> Adafruit PyRuler
    <li> Adafruit Pybadge
    <li> Adafruit QT Py ESP32S2
    <li> Adafruit QT Py M0
    <li> Adafruit QT Py M0 Haxpress
    <li> Adafruit QT Py RP2040
    <li> Adafruit QT2040 Trinkey
    <li> Adafruit Rotary Trinkey M0
    <li> Adafruit Slide Trinkey M0
    <li> Adafruit Trellis M4 Express
    <li> Adafruit Trinket M0
    <li> AloriumTech Evo M51
    <li> Arduino MKR Zero
    <li> Arduino MKR1300
    <li> Arduino Nano 33 BLE
    <li> Arduino Nano 33 IoT
    <li> Arduino Nano RP2040 Connect
    <li> Arduino Zero
    <li> Artisense Reference Design RD00
    <li> AtelierDuMaker nRF52840 Breakout
    <li> BDMICRO VINA-D21
    <li> BDMICRO VINA-D51
    <li> BLE-SS dev board Multi Sensor
    <li> BastBLE
    <li> BastWiFi
    <li> BlueMicro840
    <li> CP Sapling M0
    <li> CP Sapling M0 w/ SPI Flash
    <li> CP32-M4
    <li> Capable Robot Programmable USB Hub
    <li> Cedar Grove StringCar M0 Express
    <li> Challenger NB RP2040 WiFi
    <li> Challenger RP2040 LTE
    <li> Challenger RP2040 WiFi
    <li> Circuit Playground Express Digi-Key PyCon 2019
    <li> CircuitBrains Basic
    <li> CircuitBrains Deluxe
    <li> CrumpS2
    <li> Cytron Maker Nano RP2040
    <li> Cytron Maker Pi RP2040
    <li> DynOSSAT-EDU-EPS
    <li> DynOSSAT-EDU-OBC
    <li> DynaLoRa_USB
    <li> ESP 12k NodeMCU
    <li> Electronic Cats Bast Pro Mini M0
    <li> Electronic Cats CatWAN USBStick
    <li> Electronic Cats Hunter Cat NFC
    <li> Electronic Cats NFC Copy Cat
    <li> Electronut Labs Blip
    <li> Electronut Labs Papyr
    <li> EncoderPad RP2040
    <li> Escornabot Makech
    <li> Espruino Pico
    <li> Espruino Wifi
    <li> Feather ESP32S2 without PSRAM
    <li> Feather MIMXRT1011
    <li> Feather MIMXRT1062
    <li> FeatherS2
    <li> FeatherS2 Neo
    <li> FeatherS2 PreRelease
    <li> Fluff M0
    <li> Fomu
    <li> Franzininho WIFI w/Wroom
    <li> Franzininho WIFI w/Wrover
    <li> Gravitech Cucumber M
    <li> Gravitech Cucumber MS
    <li> Gravitech Cucumber R
    <li> Gravitech Cucumber RS
    <li> HMI-DevKit-1.1
    <li> Hacked Feather M0 Express with 8Mbyte SPI flash
    <li> HalloWing M0 Express
    <li> HiiBot BlueFi
    <li> IMXRT1010-EVK
    <li> IkigaiSense Vita nRF52840
    <li> J&J Studios datum-Distance
    <li> J&J Studios datum-IMU
    <li> J&J Studios datum-Light
    <li> J&J Studios datum-Weather
    <li> Kaluga 1
    <li> LILYGO TTGO T8 ESP32-S2 w/Display
    <li> LoC BeR M4 base board
    <li> MDBT50Q-DB-40
    <li> MDBT50Q-RX Dongle
    <li> MEOWBIT
    <li> MORPHEANS MorphESP-240
    <li> MakerDiary nRF52840 MDK
    <li> MakerDiary nRF52840 MDK USB Dongle
    <li> Makerdiary M60 Keyboard
    <li> Makerdiary Pitaya Go
    <li> Makerdiary nRF52840 M.2 Developer Kit
    <li> Melopero Shake RP2040
    <li> Meow Meow
    <li> Metro MIMXRT1011
    <li> MicroDev microC3
    <li> MicroDev microS2
    <li> Mini SAM M4
    <li> NUCLEO STM32F746
    <li> NUCLEO STM32F767
    <li> NUCLEO STM32H743
    <li> OPENMV-H7 R1
    <li> Oak Dev Tech BREAD2040
    <li> Oak Dev Tech PixelWing ESP32S2
    <li> Open Hardware Summit 2020 Badge
    <li> PCA10056 nRF52840-DK
    <li> PCA10059 nRF52840 Dongle
    <li> PCA10100 nRF52833 DK
    <li> PYB LR Nano V2
    <li> Particle Argon
    <li> Particle Boron
    <li> Particle Xenon
    <li> PewPew 10.2
    <li> PewPew 13
    <li> PewPew M4
    <li> PicoPlanet
    <li> Pimoroni Interstate 75
    <li> Pimoroni Keybow 2040
    <li> Pimoroni PGA2040
    <li> Pimoroni Pico LiPo (16MB)
    <li> Pimoroni Pico LiPo (4MB)
    <li> Pimoroni PicoSystem
    <li> Pimoroni Plasma 2040
    <li> Pimoroni Tiny 2040
    <li> PyCubedv04
    <li> PyCubedv04-MRAM
    <li> PyCubedv05
    <li> PyCubedv05-MRAM
    <li> PyKey60
    <li> PyboardV1_1
    <li> RP2040 Stamp
    <li> Raspberry Pi 4B
    <li> Raspberry Pi Compute Module 4 IO Board
    <li> Raspberry Pi Pico
    <li> Raspberry Pi Zero 2W
    <li> Robo HAT MM1 M4
    <li> S2Mini
    <li> S2Pico
    <li> SAM E54 Xplained Pro
    <li> SAM32v26
    <li> SPRESENSE
    <li> ST STM32F746G Discovery
    <li> STM32F411E_DISCO
    <li> STM32F412G_DISCO
    <li> STM32F4_DISCO
    <li> Saola 1 w/Wroom
    <li> Saola 1 w/Wrover
    <li> Seeeduino Wio Terminal
    <li> Seeeduino XIAO
    <li> Seeeduino XIAO KB
    <li> Serpente
    <li> Silicognition LLC M4-Shim
    <li> Simmel
    <li> SparkFun LUMIDrive
    <li> SparkFun MicroMod RP2040 Processor
    <li> SparkFun MicroMod SAMD51 Processor
    <li> SparkFun MicroMod nRF52840 Processor
    <li> SparkFun Pro Micro RP2040
    <li> SparkFun Pro nRF52840 Mini
    <li> SparkFun Qwiic Micro
    <li> SparkFun RedBoard Turbo
    <li> SparkFun SAMD21 Dev Breakout
    <li> SparkFun SAMD21 Mini Breakout
    <li> SparkFun STM32 MicroMod Processor
    <li> SparkFun Thing Plus - RP2040
    <li> SparkFun Thing Plus - SAMD51
    <li> Sprite_v2b
    <li> StackRduino M0 PRO
    <li> Swan R5
    <li> TG-Boards' Datalore IP M4
    <li> TG-Watch
    <li> THUNDERPACK_v11
    <li> THUNDERPACK_v12
    <li> Targett Module Clip w/Wroom
    <li> Targett Module Clip w/Wrover
    <li> Teensy 4.0
    <li> Teensy 4.1
    <li> Teknikio Bluebird
    <li> The Open Book Feather
    <li> Thingz - Galaxia
    <li> TinkeringTech ScoutMakes Azul
    <li> TinyS2
    <li> Trinket M0 Haxpress
    <li> UARTLogger II
    <li> WarmBit BluePixel nRF52840
    <li> Winterbloom Big Honking Button
    <li> Winterbloom Sol
    <li> XinaBox CC03
    <li> XinaBox CS11
    <li> iMX RT 1020 EVK
    <li> iMX RT 1060 EVK
    <li> keithp.com snekboard
    <li> micro:bit v2
    <li> nanoESP32-S2  w/Wrover
    <li> nanoESP32-S2 w/Wroom
    <li> ndGarage[n°] Bit6: FeatherSnow-v2
    <li> ndGarage[n°]Bit6:FeatherSnow
    <li> nice!nano
    <li> senseBox MCU
    <li> stm32f411ce-blackpill
    <li> stm32f411ce-blackpill-with-flash
    <li> uChip
    <li> uGame10
    </ul>
    </details>
    </p>




.. py:data:: cpu
   :annotation: :Processor

   CPU information and control, such as ``cpu.temperature`` and ``cpu.frequency``
   (clock frequency).
   This object is an instance of `microcontroller.Processor`.


.. py:data:: cpus
   :annotation: :Processor

   CPU information and control, such as ``cpus[0].temperature`` and ``cpus[1].frequency``
   (clock frequency) on chips with more than 1 cpu. The index selects which cpu.
   This object is an instance of `microcontroller.Processor`.


.. py:function:: delay_us(delay: int) -> None

   Dedicated delay method used for very short delays. **Do not** do long delays
   because this stops all other functions from completing. Think of this as an empty
   ``while`` loop that runs for the specified ``(delay)`` time. If you have other
   code or peripherals (e.g audio recording) that require specific timing or
   processing while you are waiting, explore a different avenue such as using
   `time.sleep()`.


.. py:function:: disable_interrupts() -> None

   Disable all interrupts. Be very careful, this can stall everything.


.. py:function:: enable_interrupts() -> None

   Enable the interrupts that were enabled at the last disable.


.. py:function:: on_next_reset(run_mode: RunMode) -> None

   Configure the run mode used the next time the microcontroller is reset but
   not powered down.

   :param ~microcontroller.RunMode run_mode: The next run mode


.. py:function:: reset() -> None

   Reset the microcontroller. After reset, the microcontroller will enter the
   run mode last set by `on_next_reset`.

   .. warning:: This may result in file system corruption when connected to a
     host computer. Be very careful when calling this! Make sure the device
     "Safely removed" on Windows or "ejected" on Mac OSX and Linux.


.. py:data:: nvm
   :annotation: :Optional[nvm.ByteArray]

   Available non-volatile memory.
   This object is the sole instance of `nvm.ByteArray` when available or ``None`` otherwise.

   :type: nvm.ByteArray or None


.. py:data:: watchdog
   :annotation: :Optional[watchdog.WatchDogTimer]

   Available watchdog timer.
   This object is the sole instance of `watchdog.WatchDogTimer` when available or ``None`` otherwise.


.. py:class:: Pin

   Identifies an IO pin on the microcontroller.

   Identifies an IO pin on the microcontroller. They are fixed by the
   hardware so they cannot be constructed on demand. Instead, use
   :mod:`board` or :mod:`microcontroller.pin` to reference the desired pin.


.. py:class:: Processor

   Microcontroller CPU information and control

   Usage::

      import microcontroller
      print(microcontroller.cpu.frequency)
      print(microcontroller.cpu.temperature)

      Note that on chips with more than one cpu (such as the RP2040)
      microcontroller.cpu will return the value for CPU 0.
      To get values from other CPUs use microcontroller.cpus indexed by
      the number of the desired cpu. i.e.

      print(microcontroller.cpus[0].temperature)
      print(microcontroller.cpus[1].frequency)

   You cannot create an instance of `microcontroller.Processor`.
   Use `microcontroller.cpu` to access the sole instance available.

   .. py:attribute:: frequency
      :annotation: :int

      The CPU operating frequency in Hertz. (read-only)


   .. py:attribute:: reset_reason
      :annotation: :ResetReason

      The reason the microcontroller started up from reset state.


   .. py:attribute:: temperature
      :annotation: :Optional[float]

      The on-chip temperature, in Celsius, as a float. (read-only)

      Is `None` if the temperature is not available.


   .. py:attribute:: uid
      :annotation: :bytearray

      The unique id (aka serial number) of the chip as a `bytearray`. (read-only)


   .. py:attribute:: voltage
      :annotation: :Optional[float]

      The input voltage to the microcontroller, as a float. (read-only)

      Is `None` if the voltage is not available.



.. py:class:: ResetReason

   The reason the microntroller was last reset

   .. py:attribute:: POWER_ON
      :annotation: :object

      The microntroller was started from power off.


   .. py:attribute:: BROWNOUT
      :annotation: :object

      The microntroller was reset due to too low a voltage.


   .. py:attribute:: SOFTWARE
      :annotation: :object

      The microntroller was reset from software.


   .. py:attribute:: DEEP_SLEEP_ALARM
      :annotation: :object

      The microntroller was reset for deep sleep and restarted by an alarm.


   .. py:attribute:: RESET_PIN
      :annotation: :object

      The microntroller was reset by a signal on its reset pin. The pin might be connected to a reset button.


   .. py:attribute:: WATCHDOG
      :annotation: :object

      The microcontroller was reset by its watchdog timer.


   .. py:attribute:: UNKNOWN
      :annotation: :object

      The microntroller restarted for an unknown reason.


   .. py:attribute:: RESCUE_DEBUG
      :annotation: :object

      The microntroller was reset by the rescue debug port.



.. py:class:: RunMode

   run state of the microcontroller

   Enum-like class to define the run mode of the microcontroller and
   CircuitPython.

   .. py:attribute:: NORMAL
      :annotation: :RunMode

      Run CircuitPython as normal.

      :type microcontroller.RunMode:


   .. py:attribute:: SAFE_MODE
      :annotation: :RunMode

      Run CircuitPython in safe mode. User code will not run and the
      file system will be writeable over USB.

      :type microcontroller.RunMode:


   .. py:attribute:: UF2
      :annotation: :RunMode

      Run the uf2 bootloader.

      :type microcontroller.RunMode:


   .. py:attribute:: BOOTLOADER
      :annotation: :RunMode

      Run the default bootloader.

      :type microcontroller.RunMode: