machine — functions related to the board¶

Reset related functions¶

machine.reset()¶

Resets the device in a manner similar to pushing the external RESET button.

machine.reset_cause()¶

Get the reset cause. See constants for the possible return values.

Interrupt related functions¶

machine.disable_irq()¶

Disable interrupt requests. Returns the previous IRQ state: False/True for disabled/enabled IRQs respectively. This return value can be passed to enable_irq to restore the IRQ to its original state.

machine.enable_irq(state=True)¶

Enable interrupt requests. If state is True (the default value) then IRQs are enabled. If state is False then IRQs are disabled. The most common use of this function is to pass it the value returned by disable_irq to exit a critical section.

Power related functions¶

machine.freq()¶

Returns CPU frequency in hertz.

machine.idle()¶

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 occuring at regular intervals on the order of millisecond).

machine.sleep()¶

Stops the CPU and disables all peripherals except for WLAN. Execution is resumed from the point where the sleep was requested. For wake up to actually happen, wake sources should be configured first.

machine.deepsleep()¶

Stops the CPU and all peripherals (including networking interfaces, if any). Execution is resumed from the main script, just as with a reset. The reset cause can be checked to know that we are coming from machine.DEEPSLEEP. For wake up to actually happen, wake sources should be configured first, like Pin change or RTC timeout.

Miscellaneous functions¶

machine.unique_id()¶

Returns a byte string with a unique idenifier 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.time_pulse_us(pin, pulse_level, timeout_us=1000000)¶

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.

The function first waits while the pin input is different to the pulse_level parameter, 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 raise an OSError with ETIMEDOUT if either of the waits is longer than the given timeout value (which is in microseconds).

Constants¶

machine.IDLE¶

machine.SLEEP¶

machine.DEEPSLEEP¶

irq wake values

machine.POWER_ON¶

machine.HARD_RESET¶

machine.WDT_RESET¶

machine.DEEPSLEEP_RESET¶

machine.SOFT_RESET¶

reset causes

machine.WLAN_WAKE¶

machine.PIN_WAKE¶

machine.RTC_WAKE¶

wake reasons

Classes¶