`supervisor` – Supervisor settings

Available on these boards

01Space 0.42 OLED ESP32C3
0xCB Gemini
0xCB Helios
42. Keebs Frood
8086 Commander
8086 RP2040 Interfacer
8086 USB Interposer
@sarfata shIRtty
AITHinker ESP32-C3S_Kit
AITHinker ESP32-C3S_Kit_2M
APARD32690
ARAMCON Badge 2019
ARAMCON2 Badge
ATMegaZero ESP32-S2
Adafruit BLM Badge
Adafruit CLUE nRF52840 Express
Adafruit Camera
Adafruit Circuit Playground Bluefruit
Adafruit Circuit Playground Express 4-H
Adafruit CircuitPlayground Express
Adafruit CircuitPlayground Express with Crickit libraries
Adafruit CircuitPlayground Express with displayio
Adafruit EdgeBadge
Adafruit Feather Bluefruit Sense
Adafruit Feather ESP32 V2
Adafruit Feather ESP32-C6 4MB Flash No PSRAM
Adafruit Feather ESP32-S2 Reverse TFT
Adafruit Feather ESP32-S2 TFT
Adafruit Feather ESP32-S3 Reverse TFT
Adafruit Feather ESP32-S3 TFT
Adafruit Feather ESP32S2
Adafruit Feather ESP32S3 4MB Flash 2MB PSRAM
Adafruit Feather ESP32S3 No PSRAM
Adafruit Feather HUZZAH32
Adafruit Feather M0 Adalogger
Adafruit Feather M0 Basic
Adafruit Feather M0 Express
Adafruit Feather M0 Express with Crickit libraries
Adafruit Feather M0 RFM69
Adafruit Feather M0 RFM9x
Adafruit Feather M4 CAN
Adafruit Feather M4 Express
Adafruit Feather MIMXRT1011
Adafruit Feather RP2040
Adafruit Feather RP2040 Adalogger
Adafruit Feather RP2040 CAN
Adafruit Feather RP2040 DVI
Adafruit Feather RP2040 Prop-Maker
Adafruit Feather RP2040 RFM
Adafruit Feather RP2040 Scorpio
Adafruit Feather RP2040 ThinkInk
Adafruit Feather RP2040 USB Host
Adafruit Feather RP2350
Adafruit Feather RP2350 Adalogger
Adafruit Feather STM32F405 Express
Adafruit Feather nRF52840 Express
Adafruit Floppsy RP2040
Adafruit Fruit Jam
Adafruit FunHouse
Adafruit Gemma M0
Adafruit Gemma M0 PyCon 2018
Adafruit Grand Central M4 Express
Adafruit HUZZAH32 Breakout
Adafruit Hallowing M4 Express
Adafruit ItsyBitsy ESP32
Adafruit ItsyBitsy M0 Express
Adafruit ItsyBitsy M4 Express
Adafruit ItsyBitsy RP2040
Adafruit ItsyBitsy nRF52840 Express
Adafruit KB2040
Adafruit LED Glasses Driver nRF52840
Adafruit Macropad RP2040
Adafruit MagTag
Adafruit Matrix Portal M4
Adafruit MatrixPortal S3
Adafruit Metro ESP32S2
Adafruit Metro ESP32S3
Adafruit Metro M0 Express
Adafruit Metro M4 Airlift Lite
Adafruit Metro M4 Express
Adafruit Metro RP2040
Adafruit Metro RP2350
Adafruit Metro nRF52840 Express
Adafruit Mini Sparkle Motion
Adafruit Monster M4SK
Adafruit NeoKey Trinkey M0
Adafruit NeoPixel Trinkey M0
Adafruit Pixel Trinkey M0
Adafruit ProxLight Trinkey M0
Adafruit PyGamer
Adafruit PyPortal
Adafruit PyPortal Pynt
Adafruit PyPortal Titano
Adafruit PyRuler
Adafruit Pybadge
Adafruit QT Py ESP32 PICO
Adafruit QT Py ESP32-S3 4MB Flash 2MB PSRAM
Adafruit QT Py ESP32-S3 no psram
Adafruit QT Py ESP32C3
Adafruit QT Py ESP32S2
Adafruit QT Py M0
Adafruit QT Py M0 Haxpress
Adafruit QT Py RP2040
Adafruit QT2040 Trinkey
Adafruit Rotary Trinkey M0
Adafruit SHT4x Trinkey M0
Adafruit Slide Trinkey M0
Adafruit Sparkle Motion
Adafruit Sparkle Motion Stick
Adafruit TRRS Trinkey M0
Adafruit Trellis M4 Express
Adafruit Trinket M0
Adafruit Vindie S2
Adafruit-Qualia-S3-RGB666
Ai Thinker ESP32-CAM
AloriumTech Evo M51
Archi RP2040
Arduino MKR Zero
Arduino MKR1300
Arduino Nano 33 BLE
Arduino Nano 33 BLE Rev2
Arduino Nano 33 IoT
Arduino Nano ESP32
Arduino Nano RP2040 Connect
Arduino Zero
Artisense Reference Design RD00
AtelierDuMaker nRF52840 Breakout
AutosportLabs-ESP32-CAN-X2
BARDUINO 4.0.2
BBQ20KBD
BDMICRO VINA-D51
BLE-SS dev board Multi Sensor
BLING!
BLOK
BPI-Bit-S2
BPI-Leaf-S3
BPI-PicoW-S3
BastBLE
BastWiFi
Bee-Data-Logger
Bee-Motion-S3
Bee-S3
BlizzardS3
BlueMicro833
BlueMicro840
Bradán Lane STUDIO Coin M0
Bradán Lane STUDIO Explorer Badge
COSMO-Pico
CP Sapling M0
CP Sapling M0 w/ SPI Flash
CP32-M4
CRCibernetica IdeaBoard
Capable Robot Programmable USB Hub
Cedar Grove StringCar M0 Express
Challenger NB RP2040 WiFi
Challenger RP2040 LTE
Challenger RP2040 LoRa
Challenger RP2040 SD/RTC
Challenger RP2040 SubGHz
Challenger RP2040 WiFi
Challenger RP2040 WiFi/BLE
Challenger+ RP2350 BConnect
Challenger+ RP2350 WiFi6/BLE5
Circuit Playground Express Digi-Key PyCon 2019
CircuitART Zero S3
CircuitBrains Basic
CircuitBrains Deluxe
ColumbiaDSL-Sensor-Board-V1
CrowPanel 4.2 EPaper
CrumpS2
Cygnet
Cytron EDU PICO W
Cytron IRIV IO Controller
Cytron MOTION 2350 Pro
Cytron Maker Feather AIoT S3
Cytron Maker Nano RP2040
Cytron Maker Pi RP2040
Cytron Maker Uno RP2040
DAISY_SEED
DFRobot Beetle ESP32-C3
DFRobot FireBeetle 2 ESP32-S3
Datanoise PicoADK
Datanoise PicoADK V2
Deneyap Kart
Deneyap Kart 1A
Deneyap Kart 1A v2
Deneyap Kart G
Deneyap Mini
Deneyap Mini v2
Diodes Delight Piunora
DynOSSAT-EDU-EPS
DynOSSAT-EDU-OBC
DynaLoRa_USB
E-Fidget
EDGES3D
ELECFREAKS PICO:ED
ES3ink
ESP 12k NodeMCU
ESP32 Devkit V1
ESP32-C3-DevKitM-1
ESP32-C3-Lyra-V2
ESP32-C6-DevKitC-1-N8
ESP32-C6-DevKitM-1
ESP32-C61-DevKitC-1-N8R2
ESP32-H2-DevKitM-1
ESP32-P4 Stamp XL
ESP32-P4-Function-EV
ESP32-S2-DevKitC-1-N4
ESP32-S2-DevKitC-1-N4R2
ESP32-S2-DevKitC-1-N8R2
ESP32-S3-Box-2.5
ESP32-S3-Box-Lite
ESP32-S3-DevKitC-1-N16
ESP32-S3-DevKitC-1-N32R8
ESP32-S3-DevKitC-1-N8
ESP32-S3-DevKitC-1-N8R2
ESP32-S3-DevKitC-1-N8R2 (ROS version)
ESP32-S3-DevKitC-1-N8R8
ESP32-S3-DevKitC-1-N8R8-with-HACKTABLET
ESP32-S3-DevKitM-1-N8
ESP32-S3-EYE
ESP32-S3-USB-OTG-N8
ESP8684-DevKitC-02-N4
Elecrow CrowPanel
Electrolama minik
Electronic Cats Bast Pro Mini M0
Electronic Cats CatWAN USBStick
Electronic Cats Hunter Cat NFC
Electronic Cats NFC Copy Cat
Electronut Labs Blip
Electronut Labs Papyr
EncoderPad RP2040
Escornabot Makech
Espressif ESP32 DevKitc V4 WROOM-32E
Espressif ESP32 DevKitc V4 WROVER
Espressif ESP32 TTGO T8 v1.7
Espressif ESP32-EYE
Espressif ESP32-LyraT
Espressif-ESP32-S3-LCD-EV-Board
Espressif-ESP32-S3-LCD-EV-Board_v1.5
Espruino Bangle.js 2
Espruino Pico
Espruino Wifi
Feather MIMXRT1011
Feather MIMXRT1062
FeatherS2
FeatherS2 Neo
FeatherS2 PreRelease
FeatherS3
FeatherS3 Neo
Fig Pi
Flipper Zero Wi-Fi Dev
Fluff M0
Fomu
Franzininho WIFI w/Wroom
Franzininho WIFI w/Wrover
Freenove ESP32-WROVER-DEV-CAM
Gravitech Cucumber M
Gravitech Cucumber MS
Gravitech Cucumber R
Gravitech Cucumber RS
HEIA-FR Picomo V2
HEIA-FR Picomo V3
HMI-DevKit-1.1
HXR.DK SAO Digital Multimeter
Hack Club Sprig
Hacked Feather M0 Express with 8Mbyte SPI flash
HalloWing M0 Express
Hardkernel Odroid Go
Heltec ESP32-S3-WIFI-LoRa-V3
Heltec Vison Master E290
Heltec Wireless Paper
HexKyS2
HiiBot BlueFi
IMXRT1010-EVK
IMXRT1015-EVK
IkigaiSense Vita nRF52840
IoTs2
J&J Studios datum-Distance
J&J Studios datum-IMU
J&J Studios datum-Light
J&J Studios datum-Weather
Kaluga 1
LILYGO T-DISPLAY
LILYGO T-DISPLAY S3 v1.2
LILYGO T-Deck (Plus)
LILYGO T-Display S3 Pro
LILYGO T-Dongle S3
LILYGO T-QT PRO NO PSRAM
LILYGO T-QT PRO PSRAM
LILYGO T-Watch-S3
LILYGO TEMBED ESP32S3
LILYGO TTGO T-01C3
LILYGO TTGO T-DISPLAY v1.1
LILYGO TTGO T-DISPLAY v1.1 4M
LILYGO TTGO T-OI PLUS
LILYGO TTGO T8 ESP32-S2
LILYGO TTGO T8 ESP32-S2 w/Display
LOLIN S3 16MB Flash 8MB PSRAM
LOLIN S3 MINI 4MB Flash 2MB PSRAM
LOLIN S3 MINI PRO 4MB Flash 2MB PSRAM
LOLIN S3 PRO 16MB Flash 8MB PSRAM
Lilygo T-watch 2020 V3
LoC BeR M4 base board
Luatos Core-ESP32C3
M5STACK STAMP-C3
M5Stack Atom Echo
M5Stack Atom Lite
M5Stack Atom Matrix
M5Stack Atom U
M5Stack AtomS3
M5Stack AtomS3 Lite
M5Stack AtomS3U
M5Stack Cardputer
M5Stack Cardputer (ROS version)
M5Stack Core Basic
M5Stack Core Fire
M5Stack Core2
M5Stack CoreS3
M5Stack Dial
M5Stack DinMeter
M5Stack M5Paper
M5Stack Stamp-S3
M5Stack Stick C
M5Stack Stick C Plus
M5Stack Stick C Plus2
M5Stack Tab5
M5Stack Timer Camera X
MAX32690 EvKit
MDBT50Q-DB-40
MDBT50Q-RX Dongle
MEOWBIT
MORPHEANS MorphESP-240
MagiClick S3 N4R2
Maker Go ESP32C3 Supermini
Maker Go ESP32C6 Supermini
Maker badge by Czech maker
MakerDiary nRF52840 MDK
MakerDiary nRF52840 MDK USB Dongle
MakerFabs-ESP32-S3-Parallel-TFT-With-Touch-7inch
Makerdiary M60 Keyboard
Makerdiary Pitaya Go
Makerdiary nRF52840 Connect Kit
Makerdiary nRF52840 M.2 Developer Kit
Maple Computing Elite-Pi
Melopero Shake RP2040
Meow Meow
Metro MIMXRT1011
MicroDev microC3
MicroDev microS2
Microchip Curiosity CircuitPython
Mini SAM M4
MixGo CE
Music Thing Modular Workshop Computer
NUCLEO F446RE
NUCLEO STM32F746
NUCLEO STM32F767
NUCLEO STM32H743
NanoS3
Neuron
NodeMcu-ESP32-C2
Noise Nugget 2040
OMGS3
OMNIMO nRF52840
OPENMV-H7 R1
Oak Dev Tech BREAD2040
Oak Dev Tech Cast-Away RP2040
Oak Dev Tech PixelWing ESP32S2
Oak Dev Tech RPGA Feather
Open Hardware Summit 2020 Badge
Orpheus Pico
Oxocard Artwork
Oxocard Connect
Oxocard Galaxy
Oxocard Science
P1AM-200
PCA10056 nRF52840-DK
PCA10059 nRF52840 Dongle
PCA10100 nRF52833 DK
PROVES Kit v4
PYB LR Nano V2
Pajenicko PicoPad
Particle Argon
Particle Boron
Particle Xenon
PewPew 10.2
PewPew LCD
PewPew M4
PicoPlanet
PillBug
Pimoroni Badger 2040
Pimoroni Badger 2040 W
Pimoroni Inky Frame 5.7
Pimoroni Inky Frame 7.3
Pimoroni Interstate 75
Pimoroni Keybow 2040
Pimoroni Motor 2040
Pimoroni PGA2040
Pimoroni PGA2350
Pimoroni Pico DV Base W
Pimoroni Pico LiPo (16MB)
Pimoroni Pico LiPo (4MB)
Pimoroni Pico Plus 2
Pimoroni Pico Plus 2 W
Pimoroni Pico dv Base
Pimoroni PicoSystem
Pimoroni Plasma 2040
Pimoroni Plasma 2040W
Pimoroni Plasma 2350
Pimoroni Plasma 2350W
Pimoroni Servo 2040
Pimoroni Tiny 2040 (2MB)
Pimoroni Tiny 2040 (8MB)
Pimoroni Tiny 2350
Pimoroni Tiny FX
ProS3
Prokyber Ai-On-The-Edge-Cam
PyCubedv04
PyCubedv04-MRAM
PyCubedv05
PyCubedv05-MRAM
PyKey 18 Numpad
PyKey 44 Ergo
PyKey 60
PyKey 87 TKL
PyboardV1_1
RF.Guru RP2040
RGBTouch Mini
RP2.65-F
RP2040 Stamp
RP2350 Stamp
RP2350 Stamp XL
Raspberry Breadstick
Raspberry Pi 4B
Raspberry Pi Compute Module 4
Raspberry Pi Compute Module 4 IO Board
Raspberry Pi Pico
Raspberry Pi Pico 2
Raspberry Pi Pico 2 W
Raspberry Pi Pico W
Raspberry Pi Zero
Raspberry Pi Zero 2W
Raspberry Pi Zero W
Red S2-WROOM
Renode Cortex-M0+
Robo HAT MM1 M4
S2Mini
S2Pico
SAM E54 Xplained Pro
SAM32v26
SPRESENSE
SQFMI Watchy
SSCI ISP1807 Dev Board
SSCI ISP1807 Micro Board
ST STM32F746G Discovery
STM32F411E_DISCO
STM32F412G_DISCO
STM32F4_DISCO
Saola 1 w/Wroom
Saola 1 w/Wrover
Seeed Studio XIAO ESP32C3
Seeed XIAO nRF52840 Sense
Seeed Xiao ESP32-C6 4MB Flash 512KB SRAM
Seeed Xiao ESP32-S3 Sense
Seeeduino Wio Terminal
Seeeduino XIAO
Seeeduino XIAO KB
Seeeduino XIAO RP2040
Seeeduino XIAO RP2350
Serpente
SiLabs xG24 Dev Kit
SiLabs xG24 Explorer Kit
Silicognition LLC M4-Shim
Silicognition LLC RP2040-Shim
Simmel
SparkFun LUMIDrive
SparkFun MicroMod RP2040 Processor
SparkFun MicroMod SAMD51 Processor
SparkFun MicroMod nRF52840 Processor
SparkFun Pro Micro RP2040
SparkFun Pro Micro RP2350
SparkFun Pro nRF52840 Mini
SparkFun Qwiic Micro
SparkFun RedBoard Turbo
SparkFun SAMD21 Dev Breakout
SparkFun SAMD21 Mini Breakout
SparkFun STM32 MicroMod Processor
SparkFun Teensy MicroMod Processor
SparkFun Thing Plus - RP2040
SparkFun Thing Plus - SAMD51
SparkFun Thing Plus - STM32
SparkFun Thing Plus RP2350
Sparkfun Thing Plus MGM240P
Spotpear ESP32C3 LCD 1.44
Spotpear ESP32C3 LCD 1.69
Sprite_v2b
StackRduino M0 PRO
Studiolab Pico Expander
Sunton ESP32-2424S012
Sunton-ESP32-8048S050
Sunton-ESP32-8048S070
SuperMini NRF52840
Swan R5
TG-Boards' Datalore IP M4
TG-Watch
THUNDERPACK_v11
THUNDERPACK_v12
TTGO T8 ESP32-S2-WROOM
Targett Module Clip w/Wroom
Targett Module Clip w/Wrover
Teensy 4.0
Teensy 4.1
Teknikio Bluebird
The Open Book Feather
ThingPulse Pendrive S3
TinkeringTech ScoutMakes Azul
TinyC6
TinyPICO
TinyPICO Nano
TinyS2
TinyS3
TinyWATCH S3
Trinket M0 Haxpress
UARTLogger II
VCC-GND Studio YD RP2040
VCC-GND YD-ESP32-S3 (N16R8)
VCC-GND YD-ESP32-S3 (N8R8)
VIDI X V1.1
W5100S-EVB-Pico
W5100S-EVB-Pico2
W5500-EVB-Pico
W5500-EVB-Pico2
WK-50 Trackball Keyboard
WSC-1450
WarmBit BluePixel nRF52840
Waveshare ESP32-C6 LCD 1.47
Waveshare ESP32-S2-Pico
Waveshare ESP32-S2-Pico-LCD
Waveshare ESP32-S3 LCD 1.47
Waveshare ESP32-S3 Touch LCD 1.47
Waveshare ESP32-S3 Touch LCD 2.8
Waveshare ESP32-S3-ETH
Waveshare ESP32-S3-GEEK
Waveshare ESP32-S3-Matrix
Waveshare ESP32-S3-Pico
Waveshare ESP32-S3-Tiny
Waveshare ESP32-S3-Zero
Waveshare ESP32S3 LCD 1.28
Waveshare ESP32S3 Touch LCD 2
Waveshare RP2040-GEEK
Waveshare RP2040-LCD-0.96
Waveshare RP2040-LCD-1.28
Waveshare RP2040-One
Waveshare RP2040-PiZero
Waveshare RP2040-Plus (16MB)
Waveshare RP2040-Plus (4MB)
Waveshare RP2040-TOUCH-LCD-1.28
Waveshare RP2040-Tiny
Waveshare RP2040-Zero
Waveshare RP2350-GEEK
Waveshare RP2350-LCD-0.96
Waveshare RP2350-LCD-1.28
Waveshare RP2350-One
Waveshare RP2350-Plus
Waveshare RP2350-TOUCH-LCD-1.28
Waveshare RP2350-Tiny
Waveshare RP2350-Zero
WeAct ESP32-C6 (4MB)
WeAct ESP32-C6 (8MB)
WeAct Studio Pico
WeAct Studio Pico 16MB
WeMos LOLIN32 Lite
Wemos Lolin C3 Mini
Wemos Lolin C3 Pico
Winterbloom Big Honking Button
Winterbloom Sol
WisdPi Ardu2040M
WisdPi Tiny RP2040
XinaBox CC03
XinaBox CS11
cezerio dev ESP32C6
iLabs Challenger 840
iMX RT 1020 EVK
iMX RT 1040 EVK
iMX RT 1050 EVKB
iMX RT 1060 EVK
iMX RT 1060 EVKB
iMX RT1011 Nano Kit
keithp.com snekboard
micro:bit v2
nanoESP32-S2 w/Wrover
nanoESP32-S2 w/Wroom
ndGarage[n°] Bit6: FeatherSnow-v2
ndGarage[n°]Bit6:FeatherSnow
nice!nano
nullbits Bit-C PRO
senseBox MCU
senseBox MCU-S2 ESP32S2
senseBox-eye ESP32S3
splitkb.com Liatris
stm32f411ce-blackpill
stm32f411ce-blackpill-with-flash
sunton_esp32_2432S024C
sunton_esp32_2432S028
sunton_esp32_2432S032C
takayoshiotake Octave RP2040
uChip
uGame10
uGame22

supervisor.runtime: Runtime: Runtime information, such as runtime.serial_connected (USB serial connection status). This object is the sole instance of supervisor.Runtime.

supervisor.status_bar: StatusBar: The status bar, shown on an attached display, and also sent to an attached terminal via OSC escape codes over the REPL serial connection. The status bar reports the current IP or BLE connection, what file is running, the last exception name and location, and firmware version information. This object is the sole instance of supervisor.StatusBar.

supervisor.reload() → None: Reload the main Python code and run it (equivalent to hitting Ctrl-D at the REPL).

supervisor.set_next_code_file(filename: str | None, *, working_directory: str | None = None, reload_on_success: bool = False, reload_on_error: bool = False, sticky_on_success: bool = False, sticky_on_error: bool = False, sticky_on_reload: bool = False) → None

Set what file to run on the next vm run.

When not None, the given filename is inserted at the front of the usual [‘code.py’, ‘main.py’] search sequence.

The optional keyword arguments specify what happens after the specified file has run:

sticky_on_… determine whether the newly set filename and options stay in effect: If True, further runs will continue to run that file (unless it says otherwise by calling set_next_code_filename() itself). If False, the settings will only affect one run and revert to the standard code.py/main.py afterwards.

reload_on_… determine how to continue: If False, wait in the usual “Code done running. Waiting for reload. / Press any key to enter the REPL. Use CTRL-D to reload.” state. If True, reload immediately as if CTRL-D was pressed.

…_on_success take effect when the program runs to completion or calls sys.exit().

…_on_error take effect when the program exits with an exception, including the KeyboardInterrupt caused by CTRL-C.

…_on_reload take effect when the program is interrupted by files being written to the USB drive (auto-reload) or when it calls supervisor.reload().

These settings are stored in RAM, not in persistent memory, and will therefore only affect soft reloads. Powering off or resetting the device will always revert to standard settings.

When called multiple times in the same run, only the last call takes effect, replacing any settings made by previous ones. This is the main use of passing None as a filename: to reset to the standard search sequence.

supervisor.ticks_ms() → int

Return the time in milliseconds since an unspecified reference point, wrapping after 2**29ms.

The value is initialized so that the first overflow occurs about 65 seconds after power-on, making it feasible to check that your program works properly around an overflow.

The wrap value was chosen so that it is always possible to add or subtract two ticks_ms values without overflow on a board without long ints (or without allocating any long integer objects, on boards with long ints).

This ticks value comes from a low-accuracy clock internal to the microcontroller, just like time.monotonic. Due to its low accuracy and the fact that it “wraps around” every few days, it is intended for working with short term events like advancing an LED animation, not for long term events like counting down the time until a holiday.

Addition, subtraction, and comparison of ticks values can be done with routines like the following:

_TICKS_PERIOD = const(1<<29)
_TICKS_MAX = const(_TICKS_PERIOD-1)
_TICKS_HALFPERIOD = const(_TICKS_PERIOD//2)

def ticks_add(ticks, delta):
    "Add a delta to a base number of ticks, performing wraparound at 2**29ms."
    return (ticks + delta) % _TICKS_PERIOD

def ticks_diff(ticks1, ticks2):
    "Compute the signed difference between two ticks values, assuming that they are within 2**28 ticks"
    diff = (ticks1 - ticks2) & _TICKS_MAX
    diff = ((diff + _TICKS_HALFPERIOD) & _TICKS_MAX) - _TICKS_HALFPERIOD
    return diff

def ticks_less(ticks1, ticks2):
    "Return true iff ticks1 is less than ticks2, assuming that they are within 2**28 ticks"
    return ticks_diff(ticks1, ticks2) < 0

supervisor.get_previous_traceback() → str | None

If the last vm run ended with an exception (including the KeyboardInterrupt caused by CTRL-C), returns the traceback as a string. Otherwise, returns None.

An exception traceback is only preserved over a soft reload, a hard reset clears it.

Only code (main or boot) runs are considered, not REPL runs.

supervisor.reset_terminal(x_pixels: int, y_pixels: int) → None: Reset the CircuitPython serial terminal with new dimensions.

supervisor.set_usb_identification(manufacturer: str | None = None, product: str | None = None, vid: int = -1, pid: int = -1) → None

Override identification constants in the USB Device Descriptor.

If passed, manufacturer and product must be ASCII strings (or buffers) of at most 126 characters. Any omitted arguments will be left at their default values.

This method must be called in boot.py to have any effect.

Not available on boards without native USB support.

class supervisor.RunReason

The reason that CircuitPython started running.

STARTUP: object: CircuitPython started the microcontroller started up. See microcontroller.Processor.reset_reason for more detail on why the microcontroller was started.

AUTO_RELOAD: object: CircuitPython restarted due to an external write to the filesystem.

SUPERVISOR_RELOAD: object: CircuitPython restarted due to a call to supervisor.reload().

REPL_RELOAD: object: CircuitPython started due to the user typing CTRL-D in the REPL.

class supervisor.Runtime

Current status of runtime objects.

Usage:

import supervisor
if supervisor.runtime.serial_connected:
    print("Hello World!")

You cannot create an instance of supervisor.Runtime. Use supervisor.runtime to access the sole instance available.

usb_connected: bool: Returns the USB enumeration status (read-only).

serial_connected: bool: Returns the USB serial communication status (read-only).

serial_bytes_available: int

Returns the number of bytes are available to read on the console serial input. Multiple console serial inputs may be in use at once, including USB, web workflow, BLE workflow, and/or UART.

Allows for polling to see whether to call the built-in input() or wait. (read-only)

Limitations: On STM, UART (not USB) console input can only determine that at least one character is available, and so if only the UART console is in use, only 1 or 0 will be returned.

Changed in version 9.1.0: Previously returned only True or False. Since 0 acts as False, if supervisor.runtime.serial_byes_available: will still work.

run_reason: RunReason: Why CircuitPython started running this particular time (read-only).

safe_mode_reason: SafeModeReason

Why CircuitPython went into safe mode this particular time (read-only).

Limitations: Raises NotImplementedError on builds that do not implement safemode.py.

autoreload: bool: Whether CircuitPython may autoreload based on workflow writes to the filesystem.

ble_workflow: bool: Enable/Disable ble workflow until a reset. This prevents BLE advertising outside of the VM and the services used for it.

rgb_status_brightness: int: Set brightness of status RGB LED from 0-255. This will take effect after the current code finishes and the status LED is used to show the finish state.

display: displayio.AnyDisplay | None

The primary configured displayio display, if any.

If the board has a display that is hard coded, or that was explicitly set in boot.py or code.py (including a previous run of code.py), it is available here until it is released with displayio.release_displays().

The display can be of any supported display type, such as busdisplay.BusDisplay.

If no display is configured, this property is None.

In a future release of CircuitPython, any display that is not the primary display will be automatically released at the end of running a code file.

On boards without displayio, this property is present but the value is always None.

class supervisor.SafeModeReason

The reason that CircuitPython went into safe mode.

Limitations: Class not available on builds that do not implement safemode.py.

NONE: object: CircuitPython is not in safe mode.

BROWNOUT: object: The microcontroller voltage dropped too low.

FLASH_WRITE_FAIL: object: Could not write to flash memory.

GC_ALLOC_OUTSIDE_VM: object: CircuitPython tried to allocate storage when its virtual machine was not running.

HARD_FAULT: object: The microcontroller detected a fault, such as an out-of-bounds memory write.

INTERRUPT_ERROR: object: Internal error related to interrupts.

NLR_JUMP_FAIL: object: An error occurred during exception handling, possibly due to memory corruption.

NO_CIRCUITPY: object: The CIRCUITPY drive was not available.

NO_HEAP: object: Heap storage was not present.

PROGRAMMATIC: object: The program entered safe mode using the supervisor module.

SDK_FATAL_ERROR: object: Third party firmware reported a fatal error.

STACK_OVERFLOW: object: The CircuitPython heap was corrupted because the stack was too small.

USB_BOOT_DEVICE_NOT_INTERFACE_ZERO: object: The USB HID boot device was not set up to be the first device, on interface #0.

USB_TOO_MANY_ENDPOINTS: object: USB devices need more endpoints than are available.

USB_TOO_MANY_INTERFACE_NAMES: object: USB devices specify too many interface names.

USER: object: The user pressed one or more buttons to enter safe mode. This safe mode does not cause safemode.py to be run, since its purpose is to prevent all user code from running. This allows errors in safemode.py to be corrected easily.

WATCHDOG: object: An internal watchdog timer expired.

class supervisor.StatusBar

Current status of runtime objects.

Usage:

import supervisor

supervisor.status_bar.console = False

You cannot create an instance of supervisor.StatusBar. Use supervisor.status_bar to access the sole instance available.

console: bool: Whether status bar information is sent over the console (REPL) serial connection, using OSC terminal escape codes that change the terminal’s title. Default is True. If set to False, status bar will be cleared and then disabled. May be set in boot.py or later. Persists across soft restarts.

display: bool: Whether status bar information is displayed on the top line of the display. Default is True. If set to False, status bar will be cleared and then disabled. May be set in boot.py or later. Persists across soft restarts. Not available if terminalio is not available.

supervisor – Supervisor settings

`supervisor` – Supervisor settings