pyb — Funktionen rund um das Board

Warnung

Das pyb-Modul ist veraltet. Verwenden Sie für neuen Code das portübergreifende machine-Modul – es bietet dieselbe Funktionalität auf jeder OpenMV Cam unabhängig von der MCU-Familie, während pyb nur auf den STM32-basierten Boards existiert. pyb bleibt aus Gründen der Abwärtskompatibilität mit älteren Skripten erhalten, es werden keine neuen Funktionen hinzugefügt und es kann in einer zukünftigen Version entfernt werden.

Das pyb-Modul enthält STM32-spezifische Funktionen rund um das Board.

Zeitbezogene Funktionen

pyb.delay(ms: int) → None

Verzögert um die angegebene Anzahl von Millisekunden.

pyb.udelay(us: int) → None

Verzögert um die angegebene Anzahl von Mikrosekunden.

pyb.millis() → int

Gibt die Anzahl der Millisekunden seit dem letzten Reset des Boards zurück.

Das Ergebnis ist immer ein MicroPython-Smallint (31-Bit-Zahl mit Vorzeichen), sodass dieser Wert nach 2^30 Millisekunden (etwa 12,4 Tage) negative Zahlen zurückzugeben beginnt.

Beachten Sie, dass bei einem Aufruf von pyb.stop() der diese Funktion unterstützende Hardware-Zähler für die Dauer des „Schlaf“-Zustands pausiert. Dies wirkt sich auf das Ergebnis von pyb.elapsed_millis() aus.

pyb.micros() → int

Gibt die Anzahl der Mikrosekunden seit dem letzten Reset des Boards zurück.

Das Ergebnis ist immer ein MicroPython-Smallint (31-Bit-Zahl mit Vorzeichen), sodass dieser Wert nach 2^30 Mikrosekunden (etwa 17,8 Minuten) negative Zahlen zurückzugeben beginnt.

Beachten Sie, dass bei einem Aufruf von pyb.stop() der diese Funktion unterstützende Hardware-Zähler für die Dauer des „Schlaf“-Zustands pausiert. Dies wirkt sich auf das Ergebnis von pyb.elapsed_micros() aus.

pyb.elapsed_millis(start: int) → int

Gibt die Anzahl der Millisekunden zurück, die seit start vergangen sind.

Diese Funktion behandelt den Überlauf des Zählers und gibt immer eine positive Zahl zurück. Das bedeutet, dass sie zum Messen von Zeiträumen von bis zu etwa 12,4 Tagen verwendet werden kann.

Beispiel:

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

pyb.elapsed_micros(start: int) → int

Gibt die Anzahl der Mikrosekunden zurück, die seit start vergangen sind.

Diese Funktion behandelt den Überlauf des Zählers und gibt immer eine positive Zahl zurück. Das bedeutet, dass sie zum Messen von Zeiträumen von bis zu etwa 17,8 Minuten verwendet werden kann.

Beispiel:

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

Reset-bezogene Funktionen

pyb.hard_reset() → None

Setzt die OpenMV Cam auf ähnliche Weise zurück wie das Drücken der externen RESET-Taste.

pyb.bootloader() → None

Setzt das Board zurück in OpenMV’s eigenen USB-DFU-Bootloader, bereit für ein Firmware-Update. Dies ist die empfohlene Methode, um DFU aus laufendem Code aufzurufen – es muss kein BOOT-Pin beim Reset gesetzt werden.

Nicht verfügbar auf der OpenMV Cam N6 (die pyb-Legacy-Kompatibilitätsschicht ist auf diesem Board deaktiviert); verwenden Sie stattdessen machine.bootloader().

pyb.fault_debug(value: bool) → None

Aktiviert oder deaktiviert das Hard-Fault-Debugging. Ein Hard-Fault tritt auf, wenn ein schwerwiegender Fehler im zugrunde liegenden System auftritt, wie etwa ein ungültiger Speicherzugriff.

Wenn das Argument value gleich False ist, wird das Board bei einem Hard-Fault automatisch zurückgesetzt.

Wenn value gleich True ist, gibt das Board bei einem Hard-Fault die Register und den Stack-Trace aus und lässt anschließend die LEDs endlos blinken.

Der Standardwert ist deaktiviert, d. h. automatisches Zurücksetzen.

Interrupt-bezogene Funktionen

pyb.disable_irq() → bool

Deaktiviert Interrupt-Anforderungen. Gibt den vorherigen IRQ-Zustand zurück: False/True für deaktivierte bzw. aktivierte IRQs. Dieser Rückgabewert kann an enable_irq übergeben werden, um den IRQ in seinen ursprünglichen Zustand zurückzuversetzen.

pyb.enable_irq(state: bool = True) → None

Aktiviert Interrupt-Anforderungen. Wenn state gleich True (der Standardwert) ist, werden IRQs aktiviert. Wenn state gleich False ist, werden IRQs deaktiviert. Die häufigste Verwendung dieser Funktion besteht darin, ihr den von disable_irq zurückgegebenen Wert zu übergeben, um einen kritischen Abschnitt zu verlassen.

pyb.freq(sysclk: int | None = None, hclk: int | None = None, pclk1: int | None = None, pclk2: int | None = None) → Tuple[int, int, int, int] | None

Wenn keine Argumente angegeben werden, wird ein Tupel der Taktfrequenzen (sysclk, hclk, pclk1, pclk2) in Hertz zurückgegeben:

Feld	Bedeutung
sysclk	CPU-Frequenz
hclk	AHB-Bus-, Kernspeicher- und DMA-Frequenz
pclk1	APB1-Bus-Frequenz
pclk2	APB2-Bus-Frequenz

Wenn Argumente angegeben werden, setzt die Funktion die CPU-Frequenz (und die Bus-Frequenzen, falls zusätzliche Argumente übergeben werden). Die Frequenzen werden in Hertz angegeben; es wird die größte unterstützte Frequenz ausgewählt, die nicht größer als der angegebene Wert ist. Die Menge der gültigen sysclk-Frequenzen und die maximalen hclk-/pclk1-/pclk2-Werte hängen von der MCU ab – siehe das entsprechende STM32-Referenzhandbuch für die verwendete OpenMV Cam. Die Bus-Frequenzen werden über Vorteiler aus sysclk abgeleitet, die der Treiber so wählt, dass sie den angeforderten Werten am besten entsprechen.

Warnung

Das Ändern der Frequenz bei aktiviertem USB kann USB unzuverlässig machen. Ändern Sie sie über boot.py, bevor das USB-Peripheriegerät gestartet wird, und wählen Sie keinen sysclk-Wert, der zu niedrig für die USB-Taktanforderungen der MCU ist.

Energiebezogene Funktionen

pyb.wfi() → None

Wartet auf einen internen oder externen Interrupt.

Dies führt eine wfi-Instruktion aus, die den Stromverbrauch der MCU reduziert, bis ein Interrupt (intern oder extern) auftritt, woraufhin die Ausführung fortgesetzt wird. Beachten Sie, dass der System-Tick-Interrupt einmal pro Millisekunde (1000 Hz) auftritt, sodass diese Funktion höchstens 1 ms blockiert.

pyb.stop() → None

Versetzt die OpenMV Cam in den STM32-stop-Energiesparzustand. Die Ausführung wird beim Aufwachen ab diesem Punkt fortgesetzt. Zum Aufwachen ist ein externer Interrupt oder ein Echtzeituhr-Ereignis erforderlich; siehe pyb.RTC.wakeup(), um eines zu konfigurieren. Die genau erreichbare Stromaufnahme hängt vom Board und davon ab, welche Peripheriegeräte weiterhin getaktet werden.

pyb.standby() → None

Versetzt die OpenMV Cam in den STM32-standby-Tiefschlafzustand. Dies ist die niedrigste Abschaltstufe; das Gerät verlässt sie beim Aufwachen über einen Hard-Reset, sodass die Ausführung nicht an Ort und Stelle fortgesetzt wird. Zum Aufwachen ist ein Echtzeituhr-Ereignis erforderlich; siehe pyb.RTC.wakeup(), um eines zu konfigurieren. Die genau erreichbare Stromaufnahme hängt vom Board ab.

Verschiedene Funktionen

pyb.have_cdc() → bool

Gibt True zurück, wenn USB als serielles Gerät verbunden ist, andernfalls False.

Bemerkung

Diese Funktion ist veraltet. Verwenden Sie stattdessen pyb.USB_VCP().isconnected().

pyb.hid(data: Tuple[int, int, int, int]) → None

Nimmt ein 4-Tupel (oder eine Liste) entgegen und sendet es an den USB-Host (den PC), um ein HID-Maus-Bewegungsereignis zu signalisieren.

Bemerkung

Diese Funktion ist veraltet. Verwenden Sie stattdessen pyb.USB_HID.send().

pyb.info(dump_alloc_table: bool | None = None) → None

Gibt zahlreiche Informationen über das Board aus.

pyb.main(filename: str) → None

Legt den Dateinamen des Hauptskripts fest, das ausgeführt werden soll, nachdem boot.py abgeschlossen ist. Wenn diese Funktion nicht aufgerufen wird, wird die Standarddatei main.py ausgeführt.

Es ist nur sinnvoll, diese Funktion innerhalb von boot.py aufzurufen.

pyb.mount(device: Any, mountpoint: str, *, readonly: bool = False, mkfs: bool = False) → None

Bemerkung

Diese Funktion ist veraltet. Verwenden Sie stattdessen vfs.mount() / vfs.umount() und ein von vfs.AbstractBlockDev abgeleitetes Blockgerät.

Hängt ein Blockgerät unter mountpoint ein. device muss das alte pyb-Blockgeräteprotokoll implementieren (ebenfalls veraltet – siehe vfs.AbstractBlockDev für die moderne Schnittstelle):

Methode	Zweck
readblocks(self, blocknum, buf)	Kopiert buf an Bytes vom Gerät, beginnend bei Block blocknum. Die Länge von buf ist ein Vielfaches von 512.
writeblocks(self, blocknum, buf) (optional)	Schreibt buf auf das Gerät, beginnend bei Block blocknum. Wenn weggelassen, wird das Gerät schreibgeschützt eingehängt.
count(self)	Gibt die Anzahl der 512-Byte-Blöcke auf dem Gerät zurück.
sync(self) (optional)	Schreibt alle zwischengespeicherten Schreibvorgänge zurück.

mountpoint ist der Pfad im Wurzelverzeichnis des Dateisystems, an dem das Gerät eingehängt wird; er muss mit einem Schrägstrich beginnen. readonly erzwingt ein schreibgeschütztes Einhängen. mkfs erstellt ein neues Dateisystem, falls keines vorhanden ist.

pyb.repl_uart(uart: UART | None = None) → UART | None

Ruft das UART-Objekt ab, auf dem die REPL gespiegelt wird, oder legt es fest.

pyb.rng() → int

Gibt eine 30-Bit-Hardware-generierte Zufallszahl zurück.

pyb.sync() → None

Synchronisiert alle Dateisysteme.

pyb.unique_id() → bytes

Gibt eine Zeichenkette aus 12 Bytes (96 Bit) zurück, die die eindeutige ID der MCU ist.

pyb.usb_mode(modestr: str | None = None, port: int = -1, vid: int = 0xf055, pid: int = -1, msc: Tuple = (), hid: Tuple = pyb.hid_mouse, high_speed: bool = False) → str | None

Wenn ohne Argumente aufgerufen, wird der aktuelle USB-Modus als Zeichenkette zurückgegeben.

Wenn mit angegebenem modestr aufgerufen, wird versucht, den USB-Modus zu konfigurieren. Die folgenden Werte von modestr werden verstanden:

modestr	Konfiguriert
None	Deaktiviert USB.
'VCP'	Nur VCP (Virtual COM Port).
'MSC'	Nur MSC (USB Mass Storage Class).
'VCP+MSC'	VCP und MSC.
'VCP+HID'	VCP und HID (Human Interface Device).
'VCP+MSC+HID'	VCP, MSC und HID zusammen. Nicht auf jeder OpenMV Cam unterstützt.

Aus Gründen der Abwärtskompatibilität wird 'CDC' als 'VCP' verstanden (und entsprechend für 'CDC+MSC' und 'CDC+HID').

Der Parameter port sollte eine Ganzzahl (0, 1, …) sein und wählt aus, welcher USB-Port verwendet wird, falls das Board mehrere Ports unterstützt. Ein Wert von -1 verwendet den Standard- oder automatisch ausgewählten Port.

Die Parameter vid und pid ermöglichen es Ihnen, die VID (Vendor-ID) und PID (Product-ID) anzugeben. Ein pid-Wert von -1 wählt eine PID basierend auf dem Wert von modestr aus.

Beim Aktivieren des MSC-Modus kann der Parameter msc verwendet werden, um eine Liste von SCSI-LUNs anzugeben, die auf der Massenspeicherschnittstelle bereitgestellt werden sollen. Zum Beispiel msc=(pyb.Flash(), pyb.SDCard()).

Beim Aktivieren des HID-Modus können Sie die HID-Details auch durch Übergeben des Schlüsselwortparameters hid angeben. Er nimmt ein Tupel aus (Subclass, Protocol, maximale Paketlänge, Polling-Intervall, Report-Deskriptor) entgegen. Standardmäßig werden geeignete Werte für eine USB-Maus gesetzt. Es gibt außerdem eine pyb.hid_keyboard-Konstante, die ein geeignetes Tupel für eine USB-Tastatur ist.

Der Parameter high_speed aktiviert, wenn auf True gesetzt, den USB-HS-Modus, sofern er von der Hardware unterstützt wird.

Konstanten

Beide der folgenden Konstanten sind vorgefertigte 5-Tupel in der Form

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

geeignet zur Übergabe als hid-Argument von usb_mode(), damit die OpenMV Cam dem Host als USB-HID-Gerät erscheint. subclass = 1 bedeutet „Boot-Schnittstelle“ und protocol wählt die Boot-Geräteklasse aus (1 = Tastatur, 2 = Maus). Das fünfte Element ist ein bytes-Objekt, das den HID-Report-Deskriptor enthält, der verwendet wird, wenn der Host das Gerät enumeriert.

pyb.hid_mouse: tuple

Vorgefertigter HID-Deskriptor für eine 3-Tasten-Boot-Maus mit relativer X/Y-Bewegung. Das Tupel ist (1, 2, 4, 8, <mouse report descriptor>): Boot-Subclass, Maus-Protokoll, 4-Byte-Eingabe-Reports (Tastenmaske + X + Y + Rad), alle 8 ms abgefragt. Der eingebaute Report-Deskriptor ist derjenige, der von pyb.USB_HID().send((buttons, dx, dy, wheel)) verwendet wird.

pyb.hid_keyboard: tuple

Vorgefertigter HID-Deskriptor für eine USB-Boot-Tastatur. Das Tupel ist (1, 1, 8, 8, <keyboard report descriptor>): Boot-Subclass, Tastatur-Protokoll, 8-Byte-Eingabe-Reports (Modifier-Byte, ein reserviertes Byte, sechs gleichzeitige Tastencodes), alle 8 ms abgefragt. Der eingebaute Report-Deskriptor entspricht dem standardmäßigen 8-Byte-HID-Boot-Tastatur-Layout, sodass der über USB_HID.send() gesendete Report ein bytes der Form (modifiers, 0, key1, key2, key3, key4, key5, key6) sein sollte.

Klassen

• Klasse ADC – Analog-Digital-Wandlung
• Klasse ADCAll – Zugriff auf alle ADC-Kanäle
• class CAN – Controller Area Network Kommunikationsbus
• class DAC – Digital-Analog-Wandlung
• class ExtInt – E/A-Pins zum Auslösen von Interrupts bei externen Ereignissen konfigurieren
• class Flash – Zugriff auf integrierten Flash-Speicher
• class I2C – ein serielles Zweidraht-Protokoll
• class LED – integrierte LED
• class Pin – Steuerung von I/O-Pins
• class PinAF – alternative Pin-Funktionen
• class RTC – Echtzeituhr
• class Servo – 3-Draht-Hobby-Servotreiber
• class SPI – ein controllergesteuertes serielles Protokoll
• class Timer – interne Timer steuern
• class TimerChannel – einen Kanal für einen Timer einrichten
• Klasse UART – serieller Vollduplex-Kommunikationsbus
• Klasse USB_HID – USB Human Interface Device (HID)
• Klasse USB_VCP – virtueller USB-COM-Port