pyb — functions related to the board¶

Time related functions¶

pyb.delay(ms)¶

Delay for the given number of milliseconds.

pyb.udelay(us)¶

Delay for the given number of microseconds.

pyb.millis()¶

Returns the number of milliseconds since the board was last reset.

The result is always a micropython smallint (31-bit signed number), so after 2^30 milliseconds (about 12.4 days) this will start to return negative numbers.

pyb.micros()¶

Returns the number of microseconds since the board was last reset.

The result is always a micropython smallint (31-bit signed number), so after 2^30 microseconds (about 17.8 minutes) this will start to return negative numbers.

pyb.elapsed_millis(start)¶

Returns the number of milliseconds which have elapsed since start.

This function takes care of counter wrap, and always returns a positive number. This means it can be used to measure periods upto about 12.4 days.

Example:

start = pyb.millis()
while pyb.elapsed_millis(start) < 1000:
    # Perform some operation

pyb.elapsed_micros(start)¶

Returns the number of microseconds which have elapsed since start.

This function takes care of counter wrap, and always returns a positive number. This means it can be used to measure periods upto about 17.8 minutes.

Example:

start = pyb.micros()
while pyb.elapsed_micros(start) < 1000:
    # Perform some operation
    pass

Reset related functions¶

Interrupt related functions¶

pyb.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.

pyb.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¶

Miscellaneous functions¶

pyb.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.

pyb.repl_uart(uart)¶

Get or set the UART object that the REPL is repeated on.

pyb.sync()¶

Sync all file systems.

Classes¶