machine – Functions related to the hardware.
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
IRQ wake values. |
|
Reset causes. |
|
Reset causes. |
|
IRQ wake values. |
|
Wake-up reasons. |
|
Reset causes. |
|
Wake-up reasons. |
|
IRQ wake values. |
|
Reset causes. |
|
Reset causes. |
|
Wake-up reasons. |
|
Read/write 16 bits of memory. |
|
Read/write 32 bits of memory. |
|
Read/write 8 bits of memory. |
Functions
|
Transmits data by bit-banging the specified pin. The encoding argument |
|
Reset the device and enter its bootloader. This is typically used to put the |
|
Stops execution in an attempt to enter a low power state. |
|
Disable interrupt requests. |
|
Re-enable interrupt requests. |
|
Returns the CPU frequency in hertz. |
|
Gates the clock to the CPU, useful to reduce power consumption at any time during |
|
Stops execution in an attempt to enter a low power state. |
|
Resets the device in a manner similar to pushing the external RESET |
|
Get the reset cause. See constants for the possible return values. |
|
Return a 24-bit software generated random number. |
|
|
|
Performs a soft reset of the interpreter, deleting all Python objects and |
|
Time a pulse on the given pin, and return the duration of the pulse in |
|
Returns a byte string with a unique identifier of a board/SoC. It will vary |
|
Get the wake reason. See constants for the possible return values. |
Module Contents
- machine.bitstream(pin, encoding, timing, data) → 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:
0for “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
neopixelmodule for a higher-level API.
- machine.bootloader(value: Any | None = 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.
- machine.deepsleep(time_ms: Any | None = 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
Pinchange orRTCtimeout.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 returnmachine.DEEPSLEEPand this can be used to distinguish a deepsleep wake from other resets.
- machine.disable_irq() → 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, beforedisable_irq()was called.
- machine.enable_irq(state) → 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.
- machine.freq(hz: Any | None = None) → Incomplete
Returns the CPU frequency in hertz.
On some ports this can also be used to set the CPU frequency by passing in hz.
- machine.idle() → 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).
- machine.lightsleep(time_ms: Any | None = None) → 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
Pinchange orRTCtimeout.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 returnmachine.DEEPSLEEPand this can be used to distinguish a deepsleep wake from other resets.
- machine.reset() → NoReturn
Resets the device in a manner similar to pushing the external RESET button.
- machine.sleep() → Incomplete
Note
This function is deprecated, use
lightsleep()instead with no arguments.
- machine.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).
- machine.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).
- machine.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.
- machine.wake_reason() → Incomplete
Get the wake reason. See constants for the possible return values.
Availability: ESP32, WiPy.
- machine.DEEPSLEEP: Incomplete
IRQ wake values.
- machine.DEEPSLEEP_RESET: Incomplete
Reset causes.
- machine.HARD_RESET: Incomplete
Reset causes.
- machine.IDLE: Incomplete
IRQ wake values.
- machine.PIN_WAKE: Incomplete
Wake-up reasons.
- machine.PWRON_RESET: Incomplete
Reset causes.
- machine.RTC_WAKE: Incomplete
Wake-up reasons.
- machine.SLEEP: Incomplete
IRQ wake values.
- machine.SOFT_RESET: Incomplete
Reset causes.
- machine.WDT_RESET: Incomplete
Reset causes.
- machine.WLAN_WAKE: Incomplete
Wake-up reasons.
- machine.mem16: Incomplete
Read/write 16 bits of memory.
- machine.mem8: Incomplete
Read/write 8 bits of memory.