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 a tuple of clock frequencies: (sysclk,) These correspond to:

• sysclk: frequency of the CPU

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 (including the systick which has a period of 1ms). Current consumption is reduced to ~12mA (in WLAN STA mode)

machine.sleep()¶

Stops the CPU and disables all peripherals except for WLAN. Execution is resumed from the point where the sleep was requested. Wake sources are Pin, RTC and WLAN. Current consumption is reduced to 950uA (in WLAN STA mode).

machine.deepsleep()¶

Stops the CPU and all peripherals including WLAN. Execution is resumed from main, just as with a reset. The reset cause can be checked to know that we are coming from from machine.DEEPSLEEP. Wake sources are Pin and RTC. Current consumption is reduced to ~5uA.

machine.wake_reason()¶

Get the wake reason. See constants for the possible return values.

Miscellaneous functions¶

machine.main(filename)¶

Set the filename of the main script to run after boot.py is finished. If this function is not called then the default file main.py will be executed.

It only makes sense to call this function from within boot.py.

machine.rng()¶

Return a 24-bit software generated random number.

machine.unique_id()¶

Returns a string of 6 bytes (48 bits), which is the unique ID of the MCU. This also corresponds to the network MAC address.

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¶