pyb — funkcije povezane s pločom

Upozorenje

Modul pyb je zastario. Za novi kod koristite međuportabilni modul machine – on pruža istu funkcionalnost na svakoj OpenMV Cam neovisno o porodici MCU-a, dok pyb postoji samo na pločama temeljenim na STM32. pyb se zadržava radi povratne kompatibilnosti sa starijim skriptama, nove značajke se neće dodavati i mogao bi biti uklonjen u budućem izdanju.

Modul pyb sadrži funkcije specifične za STM32 povezane s pločom.

Funkcije povezane s vremenom

pyb.delay(ms: int) → None

Pričekaj zadani broj milisekundi.

pyb.udelay(us: int) → None

Pričekaj zadani broj mikrosekundi.

pyb.millis() → int

Vraća broj milisekundi od posljednjeg resetiranja ploče.

Rezultat je uvijek MicroPython smallint (31-bitni predznačeni broj), pa će nakon 2^30 milisekundi (oko 12,4 dana) početi vraćati negativne brojeve.

Imajte na umu da ako se izda pyb.stop(), hardverski brojač koji podržava ovu funkciju zaustavit će se za vrijeme trajanja stanja „mirovanja”. To će utjecati na ishod pyb.elapsed_millis().

pyb.micros() → int

Vraća broj mikrosekundi od posljednjeg resetiranja ploče.

Rezultat je uvijek MicroPython smallint (31-bitni predznačeni broj), pa će nakon 2^30 mikrosekundi (oko 17,8 minuta) početi vraćati negativne brojeve.

Imajte na umu da ako se izda pyb.stop(), hardverski brojač koji podržava ovu funkciju zaustavit će se za vrijeme trajanja stanja „mirovanja”. To će utjecati na ishod pyb.elapsed_micros().

pyb.elapsed_millis(start: int) → int

Vraća broj milisekundi koje su protekle od start.

Ova funkcija vodi računa o prelijevanju brojača i uvijek vraća pozitivan broj. To znači da se može koristiti za mjerenje razdoblja do otprilike 12,4 dana.

Primjer:

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

pyb.elapsed_micros(start: int) → int

Vraća broj mikrosekundi koje su protekle od start.

Ova funkcija vodi računa o prelijevanju brojača i uvijek vraća pozitivan broj. To znači da se može koristiti za mjerenje razdoblja do otprilike 17,8 minuta.

Primjer:

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

Funkcije povezane s resetiranjem

pyb.hard_reset() → None

Resetira OpenMV Cam na način sličan pritiskanju vanjskog gumba RESET.

pyb.bootloader() → None

Resetira u OpenMV-ov vlastiti USB DFU pokretač (bootloader), spreman za ažuriranje ugrađenog programa (firmware). Ovo je preporučeni način pozivanja DFU-a iz koda koji se izvodi – nije potrebno aktivirati BOOT pin pri resetiranju.

Nije dostupno na OpenMV Cam N6 (sloj zastarjele kompatibilnosti pyb onemogućen je na toj ploči); umjesto toga koristite machine.bootloader().

pyb.fault_debug(value: bool) → None

Omogući ili onemogući otklanjanje pogrešaka pri ozbiljnim kvarovima (hard-fault). Ozbiljni kvar nastaje kada dođe do fatalne pogreške u temeljnom sustavu, poput nevaljanog pristupa memoriji.

Ako je argument value jednak False, ploča će se automatski resetirati ako dođe do ozbiljnog kvara.

Ako je value jednak True, tada će ploča pri ozbiljnom kvaru ispisati registre i trag stoga, a zatim neprestano izmjenjivati LED diode.

Zadana vrijednost je onemogućeno, tj. automatsko resetiranje.

Funkcije povezane s prekidima

pyb.disable_irq() → bool

Onemogući zahtjeve za prekidima. Vraća prethodno stanje IRQ-a: False/True za onemogućene/omogućene IRQ-ove. Ovu povratnu vrijednost moguće je proslijediti funkciji enable_irq kako bi se IRQ vratio u izvorno stanje.

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

Omogući zahtjeve za prekidima. Ako je state jednak True (zadana vrijednost), tada su IRQ-ovi omogućeni. Ako je state jednak False, tada su IRQ-ovi onemogućeni. Najčešća upotreba ove funkcije jest proslijediti joj vrijednost koju vraća disable_irq kako bi se izašlo iz kritičnog odsječka.

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

Ako se ne navedu argumenti, vraća n-torku frekvencija takta (sysclk, hclk, pclk1, pclk2) u hercima:

Polje	Značenje
sysclk	frekvencija procesora
hclk	frekvencija AHB sabirnice, jezgrene memorije i DMA
pclk1	frekvencija APB1 sabirnice
pclk2	frekvencija APB2 sabirnice

Ako se navedu argumenti, funkcija postavlja frekvenciju procesora (i frekvencije sabirnica ako se navedu dodatni argumenti). Frekvencije su u hercima; odabire se najveća podržana frekvencija koja nije veća od zadane vrijednosti. Skup valjanih sysclk frekvencija te najveće vrijednosti hclk / pclk1 / pclk2 ovise o MCU-u – pogledajte odgovarajući STM32 referentni priručnik za OpenMV Cam koju koristite. Frekvencije sabirnica izvode se iz sysclk putem djelitelja koje upravljački program odabire kako bi najbolje odgovarale traženim vrijednostima.

Upozorenje

Mijenjanje frekvencije dok je USB omogućen može učiniti USB nepouzdanim. Promijenite je iz boot.py, prije pokretanja USB periferije, i nemojte odabrati sysclk vrijednost prenisku za zahtjeve USB takta MCU-a.

Funkcije povezane s napajanjem

pyb.wfi() → None

Čekaj na unutarnji ili vanjski prekid.

Ovo izvršava instrukciju wfi koja smanjuje potrošnju energije MCU-a dok ne dođe do bilo kakvog prekida (bilo unutarnjeg ili vanjskog), nakon čega se izvođenje nastavlja. Imajte na umu da se prekid sistemskog otkucaja (system-tick) javlja jednom u milisekundi (1000 Hz), pa će ova funkcija blokirati najviše 1 ms.

pyb.stop() → None

Stavlja OpenMV Cam u STM32 stop stanje niske potrošnje energije. Izvođenje se nastavlja od ove točke pri buđenju. Buđenje zahtijeva vanjski prekid ili događaj sata stvarnog vremena; pogledajte pyb.RTC.wakeup() za njegovo postavljanje. Točna ostvariva struja ovisi o ploči i o tome koje periferije ostaju s taktom.

pyb.standby() → None

Stavlja OpenMV Cam u STM32 standby stanje dubokog mirovanja. Ovo je najniža razina smanjenja napajanja; uređaj iz nje izlazi putem ozbiljnog (hard) resetiranja pri buđenju, pa se izvođenje ne nastavlja na istom mjestu. Buđenje zahtijeva događaj sata stvarnog vremena; pogledajte pyb.RTC.wakeup() za njegovo postavljanje. Točna ostvariva struja ovisi o ploči.

Razne funkcije

pyb.have_cdc() → bool

Vraća True ako je USB spojen kao serijski uređaj, inače False.

Napomena

Ova funkcija je zastarjela. Umjesto nje koristite pyb.USB_VCP().isconnected().

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

Uzima 4-torku (ili listu) i šalje je USB domaćinu (računalu) kako bi signalizirao događaj pokreta HID miša.

Napomena

Ova funkcija je zastarjela. Umjesto nje koristite pyb.USB_HID.send().

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

Ispisuje mnoštvo informacija o ploči.

pyb.main(filename: str) → None

Postavlja naziv datoteke glavne skripte koja se izvodi nakon što boot.py završi. Ako se ova funkcija ne pozove, izvršit će se zadana datoteka main.py.

Pozivanje ove funkcije ima smisla samo iz boot.py.

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

Napomena

Ova funkcija je zastarjela. Umjesto nje koristite vfs.mount() / vfs.umount() i blok uređaj izveden iz vfs.AbstractBlockDev.

Montira blok uređaj pod mountpoint. device mora implementirati zastarjeli pyb protokol blok uređaja (također zastario – za moderno sučelje pogledajte vfs.AbstractBlockDev):

Metoda	Svrha
readblocks(self, blocknum, buf)	Kopira buf bajtova s uređaja počevši od bloka blocknum. Duljina buf je višekratnik broja 512.
writeblocks(self, blocknum, buf) (neobavezno)	Zapisuje buf na uređaj počevši od bloka blocknum. Ako se izostavi, uređaj se montira samo za čitanje.
count(self)	Vraća broj blokova od 512 bajtova na uređaju.
sync(self) (neobavezno)	Isprazni sve predmemorirane zapise.

mountpoint je putanja u korijenu datotečnog sustava na koju se montira uređaj; mora počinjati kosom crtom. readonly prisiljava montiranje samo za čitanje. mkfs stvara novi datotečni sustav ako nijedan ne postoji.

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

Dohvati ili postavi UART objekt na kojem se ponavlja REPL.

pyb.rng() → int

Vraća 30-bitni hardverski generirani slučajni broj.

pyb.sync() → None

Sinkronizira sve datotečne sustave.

pyb.unique_id() → bytes

Vraća niz od 12 bajtova (96 bitova), što je jedinstveni ID MCU-a.

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

Ako se pozove bez argumenata, vraća trenutni USB način rada kao niz.

Ako se pozove s navedenim modestr, pokušava konfigurirati USB način rada. Razumiju se sljedeće vrijednosti modestr:

modestr	Konfigurira
None	Onemogućuje USB.
'VCP'	Samo VCP (Virtual COM Port).
'MSC'	Samo MSC (USB klasa masovne pohrane).
'VCP+MSC'	VCP i MSC.
'VCP+HID'	VCP i HID (uređaj za interakciju s čovjekom).
'VCP+MSC+HID'	VCP, MSC i HID zajedno. Nije podržano na svakoj OpenMV Cam.

Radi povratne kompatibilnosti, 'CDC' se tumači kao 'VCP' (i slično za 'CDC+MSC' i 'CDC+HID').

Parametar port trebao bi biti cijeli broj (0, 1, …) i odabire koji se USB priključak koristi ako ploča podržava više priključaka. Vrijednost -1 koristi zadani ili automatski odabrani priključak.

Parametri vid i pid omogućuju navođenje VID-a (ID dobavljača) i PID-a (ID proizvoda). Vrijednost pid od -1 odabrat će PID na temelju vrijednosti modestr.

Ako omogućujete MSC način rada, parametar msc može se koristiti za navođenje liste SCSI LUN-ova koji se izlažu na sučelju masovne pohrane. Na primjer msc=(pyb.Flash(), pyb.SDCard()).

Ako omogućujete HID način rada, možete također navesti HID pojedinosti prosljeđivanjem ključnog parametra hid. Uzima n-torku (podklasa, protokol, najveća duljina paketa, interval ispitivanja, deskriptor izvješća). Prema zadanim postavkama postavit će odgovarajuće vrijednosti za USB miš. Postoji i konstanta pyb.hid_keyboard, koja je odgovarajuća n-torka za USB tipkovnicu.

Parametar high_speed, kada je postavljen na True, omogućuje USB HS način rada ako ga hardver podržava.

Konstante

Obje konstante u nastavku gotove su 5-torke u obliku

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

prikladne za prosljeđivanje kao argument hid funkcije usb_mode() kako bi se OpenMV Cam domaćinu prikazala kao USB HID uređaj. subclass = 1 znači „boot sučelje”, a protocol odabire klasu boot uređaja (1 = tipkovnica, 2 = miš). Peti element je bytes objekt koji sadrži HID deskriptor izvješća koji se koristi kada domaćin nabraja uređaj.

pyb.hid_mouse: tuple

Unaprijed izgrađen HID deskriptor za 3-tipkovni boot miš s relativnim X/Y pomakom. N-torka je (1, 2, 4, 8, <mouse report descriptor>): boot podklasa, protokol miša, 4-bajtna ulazna izvješća (maska tipki + X + Y + kotačić), ispitivana svakih 8 ms. Ugrađeni deskriptor izvješća je onaj koji koristi pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

Unaprijed izgrađen HID deskriptor za USB boot tipkovnicu. N-torka je (1, 1, 8, 8, <keyboard report descriptor>): boot podklasa, protokol tipkovnice, 8-bajtna ulazna izvješća (bajt modifikatora, jedan rezervirani bajt, šest istovremenih kodova tipki), ispitivana svakih 8 ms. Ugrađeni deskriptor izvješća odgovara standardnom 8-bajtnom rasporedu HID boot tipkovnice, pa bi izvješće poslano putem USB_HID.send() trebalo biti bytes u obliku (modifiers, 0, key1, key2, key3, key4, key5, key6).

Klase

• klasa ADC – analogno-digitalna pretvorba
• klasa ADCAll – pristup svim ADC kanalima
• klasa CAN – komunikacijska sabirnica controller area network
• klasa DAC – digitalno-analogna pretvorba
• klasa ExtInt – konfiguriranje U/I pinova za prekid na vanjskim događajima
• klasa Flash – pristup ugrađenoj flash pohrani
• klasa I2C – dvožični serijski protokol
• klasa LED – ugrađena LED
• klasa Pin – upravljanje I/O pinovima
• klasa PinAF – alternativne funkcije pina
• klasa RTC – sat stvarnog vremena
• klasa Servo – upravljački program za 3-žični hobi servo
• klasa SPI – serijski protokol kojim upravlja kontroler
• klasa Timer – upravljanje internim mjeračima vremena
• klasa TimerChannel – postavljanje kanala za mjerač vremena
• klasa UART – dvosmjerna serijska komunikacijska sabirnica
• klasa USB_HID – USB uređaj za interakciju s čovjekom (HID)
• klasa USB_VCP – USB virtualni komunikacijski priključak