module machine

The machine module contains specific functions related to the board.

Quick Usage Example

import machine

help(machine) # display all members from the machine module
machine.freq() # get the CPU frequency
machine.unique_id() # return the 6-byte unique id of the board (the LoPy's WiFi MAC address)

Reset 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 Functions

machine.disable_irq()

Disable interrupt requests. Returns and integer representing the previous IRQ state. This return value can be passed to enable_irq to restore the IRQ to its original state.

machine.enable_irq([state])

Enable interrupt requests. The most common use of this function is to pass the value returned by disable_irq to exit a critical section. Another options is to enable all interrupts which can be achieved by calling the function with no parameters.

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

machine.sleep([time_ms], resume_wifi_ble)

Sets the device in to light sleep mode , where in this mode digital peripherals, most of the RAM, and CPUs are clock-gated, and supply voltage is reduced. Upon exit from light sleep, peripherals and CPUs resume operation, their internal state is preserved.

• time_ms is the time in milliseconds that the device should wakeup after, if no time is given the device will sleep until the next reset cycle unless another wakeup source is configured.

• resume_wifi_ble is a boolean value that enables or disable restoring after wakeup any WiFi or BLE connection that was interrupted by light sleep.

  • True Enable WiFi/BLE connections restoration

  • False Disable Wifi/BLE connections restoration, default option is Disabled.

Note: in light sleep mode LoRa/Lte modems are stopped and have to be re-initialized after wakeup.

machine.deepsleep([time_ms])

Stops the CPU and all peripherals, including the networking interfaces (except for LTE). Execution is resumed from the main script, just as with a reset. If a value in milliseconds is given then the device will wake up after that period of time, otherwise it will remain in deep sleep until the reset button is pressed.

The products with LTE connectivity (FiPy, GPy, G01), require the LTE radio to be disabled separately via the LTE class before entering deepsleep. This is required due to the LTE radio being powered independently and allowing use cases which require the system to be taken out from deepsleep by an event from the LTE network (data or SMS received for instance).

machine.pin_sleep_wakeup(pins, mode, enable_pull)

Configure pins to wake up from deep/light sleep mode. The pins which have this capability are: P2, P3, P4, P6, P8 to P10 and P13 to P23.

The arguments are:

• pins a list or tuple containing the GPIO to setup for deepsleep wakeup.
• mode selects the way the configure GPIOs can wake up the module. The possible values are: machine.WAKEUP_ALL_LOW and machine.WAKEUP_ANY_HIGH.
• enable_pull if set to True keeps the pull up or pull down resistors enabled during deep sleep. If this variable is set to True, then ULP or capacitive touch wakeup cannot be used in combination with GPIO wakeup.

machine.wake_reason()

Get the wake reason. See constants for the possible return values. Returns a tuple of the form: (wake_reason, gpio_list). When the wakeup reason is either GPIO or touch pad, then the second element of the tuple is a list with GPIOs that generated the wakeup.

machine.remaining_sleep_time()

Returns the remaining timer duration (in milliseconds) if the ESP32 is woken up from deep sleep by something other than the timer. For example, if you set the timer for 30 seconds (30000 ms) and it wakes up after 10 seconds then this function will return 20000.

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 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.info()

Returns the high water mark of the stack associated with various system tasks, in words (1 word = 4 bytes on the ESP32). If the value is zero then the task has likely overflowed its stack. If the value is close to zero then the task has come close to overflowing its stack.

Constants

Reset Causes

Wake Reasons

Pin Wakeup Modes