pyb — funcții legate de placă

Atenționare

Modulul pyb este învechit. Folosiți modulul machine, valabil pe toate porturile, pentru codul nou – acesta oferă aceleași funcționalități pe orice OpenMV Cam, indiferent de familia de MCU, în timp ce pyb există doar pe plăcile bazate pe STM32. pyb este păstrat pentru compatibilitate retroactivă cu scripturile mai vechi, nu i se vor adăuga funcționalități noi și ar putea fi eliminat într-o versiune viitoare.

Modulul pyb conține funcții specifice STM32 legate de placă.

Funcții legate de timp

pyb.delay(ms: int) → None

Așteaptă numărul indicat de milisecunde.

pyb.udelay(us: int) → None

Așteaptă numărul indicat de microsecunde.

pyb.millis() → int

Returnează numărul de milisecunde scurse de la ultima resetare a plăcii.

Rezultatul este întotdeauna un smallint MicroPython (număr cu semn pe 31 de biți), așa că după 2^30 milisecunde (aproximativ 12,4 zile) acesta va începe să returneze numere negative.

Rețineți că, dacă se apelează pyb.stop(), contorul hardware care susține această funcție va fi suspendat pe durata stării de „repaus”. Acest lucru va afecta rezultatul lui pyb.elapsed_millis().

pyb.micros() → int

Returnează numărul de microsecunde scurse de la ultima resetare a plăcii.

Rezultatul este întotdeauna un smallint MicroPython (număr cu semn pe 31 de biți), așa că după 2^30 microsecunde (aproximativ 17,8 minute) acesta va începe să returneze numere negative.

Rețineți că, dacă se apelează pyb.stop(), contorul hardware care susține această funcție va fi suspendat pe durata stării de „repaus”. Acest lucru va afecta rezultatul lui pyb.elapsed_micros().

pyb.elapsed_millis(start: int) → int

Returnează numărul de milisecunde care au trecut de la start.

Această funcție tratează depășirea contorului și returnează întotdeauna un număr pozitiv. Aceasta înseamnă că poate fi folosită pentru a măsura perioade de până la aproximativ 12,4 zile.

Exemplu:

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

pyb.elapsed_micros(start: int) → int

Returnează numărul de microsecunde care au trecut de la start.

Această funcție tratează depășirea contorului și returnează întotdeauna un număr pozitiv. Aceasta înseamnă că poate fi folosită pentru a măsura perioade de până la aproximativ 17,8 minute.

Exemplu:

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

Funcții legate de resetare

pyb.hard_reset() → None

Resetează OpenMV Cam într-un mod similar cu apăsarea butonului extern RESET.

pyb.bootloader() → None

Resetează în propriul bootloader USB DFU al OpenMV, pregătit pentru o actualizare de firmware. Acesta este modul recomandat de a invoca DFU din cod în execuție – nu este necesară activarea vreunui pin BOOT la resetare.

Nu este disponibilă pe OpenMV Cam N6 (stratul de compatibilitate retroactivă pyb este dezactivat pe acea placă); folosiți în schimb machine.bootloader().

pyb.fault_debug(value: bool) → None

Activează sau dezactivează depanarea erorilor grave (hard-fault). O eroare gravă apare când există o eroare fatală în sistemul subiacent, cum ar fi un acces nevalid la memorie.

Dacă argumentul value este False, atunci placa se va reseta automat dacă apare o eroare gravă.

Dacă value este True, atunci, când placa întâmpină o eroare gravă, va afișa registrele și urma stivei (stack trace), după care va aprinde LED-urile în mod ciclic la nesfârșit.

Valoarea implicită este dezactivat, adică resetare automată.

Funcții legate de întreruperi

pyb.disable_irq() → bool

Dezactivează solicitările de întrerupere. Returnează starea IRQ anterioară: False/True pentru IRQ dezactivate/activate. Această valoare returnată poate fi transmisă către enable_irq pentru a restabili IRQ la starea sa inițială.

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

Activează solicitările de întrerupere. Dacă state este True (valoarea implicită), atunci IRQ-urile sunt activate. Dacă state este False, atunci IRQ-urile sunt dezactivate. Cea mai frecventă utilizare a acestei funcții este de a-i transmite valoarea returnată de disable_irq pentru a ieși dintr-o secțiune critică.

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

Dacă este apelată fără argumente, returnează un tuplu cu frecvențele de ceas (sysclk, hclk, pclk1, pclk2) exprimate în hertzi:

Câmp	Semnificație
sysclk	Frecvența CPU
hclk	Frecvența magistralei AHB, a memoriei nucleului și a DMA
pclk1	Frecvența magistralei APB1
pclk2	Frecvența magistralei APB2

Dacă i se transmit argumente, atunci funcția setează frecvența CPU (și frecvențele magistralelor, dacă sunt furnizate argumente suplimentare). Frecvențele sunt exprimate în hertzi; este selectată cea mai mare frecvență acceptată care nu depășește valoarea indicată. Setul de valori valide pentru sysclk și valorile maxime hclk / pclk1 / pclk2 depind de MCU – consultați manualul de referință STM32 corespunzător pentru OpenMV Cam utilizat. Frecvențele magistralelor sunt derivate din sysclk prin prescalere pe care driverul le alege pentru a corespunde cât mai bine valorilor solicitate.

Atenționare

Modificarea frecvenței în timp ce USB este activat poate face USB nesigur. Modificați-o din boot.py, înainte de pornirea perifericului USB, și nu selectați o valoare sysclk prea mică pentru cerințele de ceas USB ale MCU-ului.

Funcții legate de alimentare

pyb.wfi() → None

Așteaptă o întrerupere internă sau externă.

Aceasta execută o instrucțiune wfi care reduce consumul de energie al MCU-ului până la apariția oricărei întreruperi (fie ea internă sau externă), moment în care execuția continuă. Rețineți că întreruperea system-tick apare o dată la fiecare milisecundă (1000 Hz), așa că această funcție va bloca cel mult 1 ms.

pyb.stop() → None

Pune OpenMV Cam în starea de consum redus stop a STM32. Execuția continuă din acest punct la trezire. Trezirea necesită o întrerupere externă sau un eveniment al ceasului în timp real; consultați pyb.RTC.wakeup() pentru a configura unul. Consumul de curent exact ce poate fi atins depinde de placă și de perifericele lăsate alimentate cu ceas.

pyb.standby() → None

Pune OpenMV Cam în starea de repaus profund standby a STM32. Acesta este cel mai scăzut nivel de oprire; dispozitivul iese printr-o resetare completă la trezire, așa că execuția nu se reia din loc. Trezirea necesită un eveniment al ceasului în timp real; consultați pyb.RTC.wakeup() pentru a configura unul. Consumul de curent exact ce poate fi atins depinde de placă.

Funcții diverse

pyb.have_cdc() → bool

Returnează True dacă USB este conectat ca dispozitiv serial, False în caz contrar.

Notă

Această funcție este învechită. Folosiți în schimb pyb.USB_VCP().isconnected().

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

Preia un 4-tuplu (sau o listă) și îl trimite către gazda USB (PC-ul) pentru a semnala un eveniment de mișcare a mouse-ului HID.

Notă

Această funcție este învechită. Folosiți în schimb pyb.USB_HID.send().

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

Afișează numeroase informații despre placă.

pyb.main(filename: str) → None

Setează numele fișierului scriptului principal care va fi rulat după finalizarea boot.py. Dacă această funcție nu este apelată, atunci se va executa fișierul implicit main.py.

Are sens să apelați această funcție doar din interiorul boot.py.

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

Notă

Această funcție este învechită. Folosiți în schimb vfs.mount() / vfs.umount() și un dispozitiv de bloc derivat din vfs.AbstractBlockDev.

Montează un dispozitiv de bloc sub mountpoint. device trebuie să implementeze protocolul vechi de dispozitiv de bloc pyb (de asemenea învechit – consultați vfs.AbstractBlockDev pentru interfața modernă):

Metodă	Scop
readblocks(self, blocknum, buf)	Copiază o cantitate de octeți cât buf de pe dispozitiv, începând de la blocul blocknum. Lungimea lui buf este un multiplu de 512.
writeblocks(self, blocknum, buf) (opțional)	Scrie buf pe dispozitiv, începând de la blocul blocknum. Dacă este omis, dispozitivul este montat doar pentru citire.
count(self)	Returnează numărul de blocuri de 512 octeți de pe dispozitiv.
sync(self) (opțional)	Golește orice scrieri din cache.

mountpoint este calea din rădăcina sistemului de fișiere unde se montează dispozitivul; trebuie să înceapă cu o bară oblică înainte. readonly forțează o montare doar pentru citire. mkfs creează un nou sistem de fișiere dacă nu există niciunul.

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

Obține sau setează obiectul UART pe care este replicat REPL-ul.

pyb.rng() → int

Returnează un număr aleatoriu generat hardware pe 30 de biți.

pyb.sync() → None

Sincronizează toate sistemele de fișiere.

pyb.unique_id() → bytes

Returnează un șir de 12 octeți (96 de biți), care reprezintă ID-ul unic al MCU-ului.

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

Dacă este apelată fără argumente, returnează modul USB curent sub formă de șir.

Dacă este apelată cu modestr furnizat, încearcă să configureze modul USB. Sunt acceptate următoarele valori ale lui modestr:

modestr	Configurează
None	Dezactivează USB.
'VCP'	Doar VCP (Virtual COM Port).
'MSC'	Doar MSC (USB mass storage class).
'VCP+MSC'	VCP și MSC.
'VCP+HID'	VCP și HID (human interface device).
'VCP+MSC+HID'	VCP, MSC și HID împreună. Nu este acceptat pe fiecare OpenMV Cam.

Pentru compatibilitate retroactivă, 'CDC' este interpretat ca însemnând 'VCP' (și în mod similar pentru 'CDC+MSC' și 'CDC+HID').

Parametrul port ar trebui să fie un număr întreg (0, 1, …) și selectează portul USB de utilizat dacă placa acceptă mai multe porturi. O valoare de -1 folosește portul implicit sau cel selectat automat.

Parametrii vid și pid vă permit să specificați VID-ul (vendor id) și PID-ul (product id). O valoare pid de -1 va selecta un PID în funcție de valoarea lui modestr.

Dacă activați modul MSC, parametrul msc poate fi folosit pentru a specifica o listă de LUN-uri SCSI care să fie expuse pe interfața de stocare în masă. De exemplu msc=(pyb.Flash(), pyb.SDCard()).

Dacă activați modul HID, puteți specifica și detaliile HID transmițând parametrul-cheie hid. Acesta preia un tuplu de (subclass, protocol, max packet length, polling interval, report descriptor). În mod implicit, va seta valori adecvate pentru un mouse USB. Există de asemenea o constantă pyb.hid_keyboard, care este un tuplu adecvat pentru o tastatură USB.

Parametrul high_speed, când este setat la True, activează modul USB HS dacă este acceptat de hardware.

Constante

Ambele constante de mai jos sunt 5-tupluri gata pregătite, de forma

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

potrivite pentru a fi transmise ca argument hid al usb_mode() pentru a face OpenMV Cam să apară gazdei ca un dispozitiv USB HID. subclass = 1 înseamnă „boot interface”, iar protocol selectează clasa de dispozitiv boot (1 = tastatură, 2 = mouse). Al cincilea element este un obiect bytes care conține descriptorul de raport HID utilizat când gazda enumeră dispozitivul.

pyb.hid_mouse: tuple

Descriptor HID pre-construit pentru un mouse boot cu 3 butoane cu mișcare relativă X/Y. Tuplul este (1, 2, 4, 8, <mouse report descriptor>): subclasa boot, protocol mouse, rapoarte de intrare de 4 octeți (masca de butoane + X + Y + rotiță), interogate la fiecare 8 ms. Descriptorul de raport încorporat este cel folosit de pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

Descriptor HID pre-construit pentru o tastatură boot USB. Tuplul este (1, 1, 8, 8, <keyboard report descriptor>): subclasa boot, protocol tastatură, rapoarte de intrare de 8 octeți (octet modificator, un octet rezervat, șase coduri de taste concurente), interogate la fiecare 8 ms. Descriptorul de raport încorporat corespunde structurii standard de tastatură boot HID pe 8 octeți, astfel încât raportul trimis prin USB_HID.send() ar trebui să fie un bytes de forma (modifiers, 0, key1, key2, key3, key4, key5, key6).

Clase

• clasa ADC – conversie analog-digitală
• clasa ADCAll – acces la toate canalele ADC
• class CAN – magistrală de comunicație controller area network
• clasa DAC – conversie digital-analogică
• clasa ExtInt – configurarea pinilor I/O pentru a întrerupe la evenimente externe
• clasa Flash – acces la stocarea flash încorporată
• clasa I2C – un protocol serial pe două fire
• clasa LED – LED-ul de pe placă
• clasa Pin – controlul pinilor I/O
• clasa PinAF – funcții alternative ale pinului
• clasa RTC – ceas în timp real
• clasa Servo – driver pentru servo hobby cu 3 fire
• clasa SPI – un protocol serial condus de un controler
• class Timer – controlul temporizatoarelor interne
• class TimerChannel – configurarea unui canal pentru un temporizator
• class UART – magistrală de comunicație serială duplex
• class USB_HID – dispozitiv USB de interfață cu utilizatorul (HID)
• class USB_VCP – port de comunicație virtual USB