pyb — functies die betrekking hebben op het board

Waarschuwing

De pyb-module is verouderd. Gebruik voor nieuwe code de port-overstijgende machine-module – deze biedt dezelfde functionaliteit op elke OpenMV Cam, ongeacht de MCU-familie, terwijl pyb alleen bestaat op de STM32-gebaseerde boards. pyb wordt behouden voor achterwaartse compatibiliteit met oudere scripts, er worden geen nieuwe functies aan toegevoegd en het kan in een toekomstige release worden verwijderd.

De pyb-module bevat STM32-specifieke functies die betrekking hebben op het board.

Tijdgerelateerde functies

pyb.delay(ms: int) → None

Wacht het opgegeven aantal milliseconden.

pyb.udelay(us: int) → None

Wacht het opgegeven aantal microseconden.

pyb.millis() → int

Geeft het aantal milliseconden terug sinds het board voor het laatst is gereset.

Het resultaat is altijd een MicroPython smallint (31-bits getal met teken), dus na 2^30 milliseconden (ongeveer 12,4 dagen) gaat dit negatieve getallen teruggeven.

Merk op dat als pyb.stop() wordt aangeroepen, de hardwareteller die deze functie ondersteunt wordt gepauzeerd voor de duur van de “slapende” toestand. Dit beïnvloedt het resultaat van pyb.elapsed_millis().

pyb.micros() → int

Geeft het aantal microseconden terug sinds het board voor het laatst is gereset.

Het resultaat is altijd een MicroPython smallint (31-bits getal met teken), dus na 2^30 microseconden (ongeveer 17,8 minuten) gaat dit negatieve getallen teruggeven.

Merk op dat als pyb.stop() wordt aangeroepen, de hardwareteller die deze functie ondersteunt wordt gepauzeerd voor de duur van de “slapende” toestand. Dit beïnvloedt het resultaat van pyb.elapsed_micros().

pyb.elapsed_millis(start: int) → int

Geeft het aantal milliseconden terug dat is verstreken sinds start.

Deze functie houdt rekening met het omslaan van de teller en geeft altijd een positief getal terug. Dit betekent dat hij kan worden gebruikt om perioden tot ongeveer 12,4 dagen te meten.

Voorbeeld:

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

pyb.elapsed_micros(start: int) → int

Geeft het aantal microseconden terug dat is verstreken sinds start.

Deze functie houdt rekening met het omslaan van de teller en geeft altijd een positief getal terug. Dit betekent dat hij kan worden gebruikt om perioden tot ongeveer 17,8 minuten te meten.

Voorbeeld:

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

Resetgerelateerde functies

pyb.hard_reset() → None

Reset de OpenMV Cam op een manier die vergelijkbaar is met het indrukken van de externe RESET-knop.

pyb.bootloader() → None

Reset naar OpenMV’s eigen USB DFU-bootloader, klaar voor een firmware-update. Dit is de aanbevolen manier om DFU vanuit draaiende code aan te roepen – er hoeft geen BOOT-pin te worden geactiveerd bij reset.

Niet beschikbaar op de OpenMV Cam N6 (de pyb legacy compatibiliteitslaag is uitgeschakeld op dat board); gebruik in plaats daarvan machine.bootloader().

pyb.fault_debug(value: bool) → None

Schakel het debuggen van hard faults in of uit. Een hard fault is wanneer er een fatale fout optreedt in het onderliggende systeem, zoals een ongeldige geheugentoegang.

Als het argument value gelijk is aan False, dan wordt het board automatisch gereset bij een hard fault.

Als value gelijk is aan True, dan zal het board bij een hard fault de registers en de stack trace afdrukken en daarna de LED’s onbeperkt laten knipperen.

De standaardwaarde is uitgeschakeld, d.w.z. automatisch resetten.

Interruptgerelateerde functies

pyb.disable_irq() → bool

Schakel interruptverzoeken uit. Geeft de vorige IRQ-toestand terug: False/True voor respectievelijk uitgeschakelde/ingeschakelde IRQ’s. Deze teruggegeven waarde kan worden doorgegeven aan enable_irq om de IRQ naar zijn oorspronkelijke toestand te herstellen.

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

Schakel interruptverzoeken in. Als state gelijk is aan True (de standaardwaarde), dan worden IRQ’s ingeschakeld. Als state gelijk is aan False, dan worden IRQ’s uitgeschakeld. Het meest voorkomende gebruik van deze functie is om de waarde door te geven die door disable_irq wordt teruggegeven om een kritieke sectie te verlaten.

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

Indien aangeroepen zonder argumenten, geeft een tuple van klokfrequenties (sysclk, hclk, pclk1, pclk2) in hertz terug:

Veld	Betekenis
sysclk	CPU-frequentie
hclk	AHB-bus, kerngeheugen en DMA-frequentie
pclk1	APB1-busfrequentie
pclk2	APB2-busfrequentie

Indien argumenten worden opgegeven, stelt de functie de CPU-frequentie in (en de busfrequenties als er extra argumenten worden opgegeven). Frequenties zijn in hertz; de grootste ondersteunde frequentie die niet groter is dan de opgegeven waarde wordt geselecteerd. De verzameling geldige sysclk-frequenties en de maximale hclk- / pclk1- / pclk2-waarden zijn afhankelijk van de MCU – raadpleeg de relevante STM32-referentiehandleiding voor de gebruikte OpenMV Cam. De busfrequenties worden afgeleid van sysclk via prescalers die de driver kiest om zo goed mogelijk overeen te komen met de gevraagde waarden.

Waarschuwing

Het wijzigen van de frequentie terwijl USB is ingeschakeld kan USB onbetrouwbaar maken. Wijzig het vanuit boot.py, voordat het USB-randapparaat wordt gestart, en kies geen sysclk-waarde die te laag is voor de USB-klokvereisten van de MCU.

Stroomgerelateerde functies

pyb.wfi() → None

Wacht op een interne of externe interrupt.

Dit voert een wfi-instructie uit die het stroomverbruik van de MCU verlaagt totdat er een interrupt optreedt (intern of extern), waarna de uitvoering wordt voortgezet. Merk op dat de system-tick-interrupt eens per milliseconde (1000Hz) optreedt, dus deze functie blokkeert maximaal 1ms.

pyb.stop() → None

Zet de OpenMV Cam in de STM32 stop energiezuinige toestand. De uitvoering gaat vanaf dit punt verder bij het ontwaken. Ontwaken vereist een externe interrupt of een real-time-clock-gebeurtenis; zie pyb.RTC.wakeup() om er een te configureren. Het exact haalbare stroomverbruik hangt af van het board en van welke randapparaten geklokt blijven.

pyb.standby() → None

Zet de OpenMV Cam in de STM32 standby diepe-slaaptoestand. Dit is het laagste uitschakelniveau; het apparaat verlaat deze toestand via een hard reset bij het ontwaken, dus de uitvoering wordt niet ter plekke hervat. Ontwaken vereist een real-time-clock-gebeurtenis; zie pyb.RTC.wakeup() om er een te configureren. Het exact haalbare stroomverbruik hangt af van het board.

Diverse functies

pyb.have_cdc() → bool

Geeft True terug als USB is aangesloten als serieel apparaat, anders False.

Notitie

Deze functie is verouderd. Gebruik in plaats daarvan pyb.USB_VCP().isconnected().

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

Neemt een 4-tuple (of lijst) en stuurt deze naar de USB-host (de pc) om een HID-muisbewegingsgebeurtenis te signaleren.

Notitie

Deze functie is verouderd. Gebruik in plaats daarvan pyb.USB_HID.send().

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

Druk veel informatie over het board af.

pyb.main(filename: str) → None

Stel de bestandsnaam in van het hoofdscript dat moet worden uitgevoerd nadat boot.py is voltooid. Als deze functie niet wordt aangeroepen, wordt het standaardbestand main.py uitgevoerd.

Het heeft alleen zin om deze functie aan te roepen vanuit boot.py.

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

Notitie

Deze functie is verouderd. Gebruik in plaats daarvan vfs.mount() / vfs.umount() en een blokapparaat dat is afgeleid van vfs.AbstractBlockDev.

Koppel een blokapparaat onder mountpoint. device moet het verouderde pyb blokapparaat-protocol implementeren (ook verouderd – zie vfs.AbstractBlockDev voor de moderne interface):

Methode	Doel
readblocks(self, blocknum, buf)	Kopieer buf aan bytes van het apparaat, beginnend bij blok blocknum. De lengte van buf is een veelvoud van 512.
writeblocks(self, blocknum, buf) (optioneel)	Schrijf buf naar het apparaat, beginnend bij blok blocknum. Indien weggelaten, wordt het apparaat alleen-lezen gekoppeld.
count(self)	Geeft het aantal blokken van 512 bytes op het apparaat terug.
sync(self) (optioneel)	Schrijf eventuele gecachte schrijfacties weg.

mountpoint is het pad in de root van het bestandssysteem waar het apparaat aan moet worden gekoppeld; het moet beginnen met een schuine streep naar voren. readonly forceert een alleen-lezen koppeling. mkfs maakt een nieuw bestandssysteem aan als er geen aanwezig is.

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

Haal het UART-object op waarop de REPL wordt herhaald, of stel dit in.

pyb.rng() → int

Geeft een 30-bits door hardware gegenereerd willekeurig getal terug.

pyb.sync() → None

Synchroniseer alle bestandssystemen.

pyb.unique_id() → bytes

Geeft een string van 12 bytes (96 bits) terug, die de unieke ID van de MCU is.

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

Indien aangeroepen zonder argumenten, geeft de huidige USB-modus als string terug.

Indien aangeroepen met modestr opgegeven, wordt geprobeerd de USB-modus te configureren. De volgende waarden van modestr worden begrepen:

modestr	Configureert
None	Schakelt USB uit.
'VCP'	Alleen VCP (Virtual COM Port).
'MSC'	Alleen MSC (USB mass storage class).
'VCP+MSC'	VCP en MSC.
'VCP+HID'	VCP en HID (human interface device).
'VCP+MSC+HID'	VCP, MSC en HID samen. Niet ondersteund op elke OpenMV Cam.

Voor achterwaartse compatibiliteit wordt 'CDC' begrepen als 'VCP' (en evenzo voor 'CDC+MSC' en 'CDC+HID').

De parameter port moet een geheel getal zijn (0, 1, …) en selecteert welke USB-poort moet worden gebruikt als het board meerdere poorten ondersteunt. Een waarde van -1 gebruikt de standaard- of automatisch geselecteerde poort.

Met de parameters vid en pid kunt u de VID (vendor id) en PID (product id) opgeven. Een pid-waarde van -1 selecteert een PID op basis van de waarde van modestr.

Bij het inschakelen van de MSC-modus kan de parameter msc worden gebruikt om een lijst van SCSI-LUN’s op te geven die op de mass-storage-interface moeten worden weergegeven. Bijvoorbeeld msc=(pyb.Flash(), pyb.SDCard()).

Bij het inschakelen van de HID-modus kunt u ook de HID-details opgeven door de sleutelwoordparameter hid mee te geven. Deze neemt een tuple van (subclass, protocol, max packet length, polling interval, report descriptor). Standaard stelt het passende waarden in voor een USB-muis. Er is ook een constante pyb.hid_keyboard, wat een passende tuple is voor een USB-toetsenbord.

De parameter high_speed, indien ingesteld op True, schakelt USB HS-modus in als deze door de hardware wordt ondersteund.

Constanten

Beide onderstaande constanten zijn kant-en-klare 5-tuples in de vorm

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

geschikt om door te geven als het hid-argument van usb_mode() om de OpenMV Cam aan de host te laten verschijnen als een USB HID-apparaat. subclass = 1 betekent “boot interface” en protocol selecteert de boot-apparaatklasse (1 = toetsenbord, 2 = muis). Het vijfde element is een bytes-object dat de HID report descriptor bevat die wordt gebruikt wanneer de host het apparaat enumereert.

pyb.hid_mouse: tuple

Kant-en-klare HID descriptor voor een boot-muis met 3 knoppen en relatieve X/Y-beweging. De tuple is (1, 2, 4, 8, <mouse report descriptor>): boot-subclass, muisprotocol, invoerrapporten van 4 bytes (knopmasker + X + Y + wiel), elke 8 ms gepolld. De ingebouwde report descriptor is dezelfde die wordt gebruikt door pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

Kant-en-klare HID descriptor voor een USB boot-toetsenbord. De tuple is (1, 1, 8, 8, <keyboard report descriptor>): boot-subclass, toetsenbordprotocol, invoerrapporten van 8 bytes (modifierbyte, één gereserveerde byte, zes gelijktijdige toetscodes), elke 8 ms gepolld. De ingebouwde report descriptor komt overeen met de standaard HID boot-toetsenbordindeling van 8 bytes, dus het rapport dat via USB_HID.send() wordt verstuurd moet een bytes zijn van de vorm (modifiers, 0, key1, key2, key3, key4, key5, key6).

Klassen

• class ADC – analoog-naar-digitaalconversie
• class ADCAll – toegang tot alle ADC-kanalen
• class CAN – controller area network communicatiebus
• class DAC – digitaal-naar-analoog-conversie
• class ExtInt – I/O-pinnen configureren om te interrupten op externe gebeurtenissen
• class Flash – toegang tot ingebouwde flashopslag
• class I2C – een tweedraads serieel protocol
• class LED – ingebouwde LED
• class Pin – I/O-pinnen besturen
• class PinAF – alternatieve pinfuncties
• class RTC – realtimeklok
• class Servo – 3-draads hobbyservodriver
• class SPI – een door een controller aangestuurd serieel protocol
• class Timer – interne timers besturen
• class TimerChannel – een kanaal voor een timer instellen
• class UART – duplex seriële communicatiebus
• class USB_HID – USB Human Interface Device (HID)
• class USB_VCP – USB virtuele compoort