pyb — funkce související s deskou

Varování

Modul pyb je zastaralý. Pro nový kód použijte přenositelný modul machine – ten poskytuje stejnou funkcionalitu na každé OpenMV Cam bez ohledu na rodinu MCU, zatímco pyb existuje pouze na deskách založených na STM32. pyb je zachován kvůli zpětné kompatibilitě se staršími skripty, žádné nové funkce nebudou přidávány a v budoucí verzi může být odstraněn.

Modul pyb obsahuje funkce specifické pro STM32 související s deskou.

Funkce související s časem

pyb.delay(ms: int) → None

Pozdrží běh o zadaný počet milisekund.

pyb.udelay(us: int) → None

Pozdrží běh o zadaný počet mikrosekund.

pyb.millis() → int

Vrací počet milisekund od posledního resetu desky.

Výsledek je vždy MicroPython smallint (31bitové číslo se znaménkem), takže po 2^30 milisekundách (přibližně 12,4 dne) začne vracet záporná čísla.

Pokud je vydán příkaz pyb.stop(), hardwarový čítač podporující tuto funkci se po dobu trvání „spánkového“ stavu pozastaví. To ovlivní výsledek pyb.elapsed_millis().

pyb.micros() → int

Vrací počet mikrosekund od posledního resetu desky.

Výsledek je vždy MicroPython smallint (31bitové číslo se znaménkem), takže po 2^30 mikrosekundách (přibližně 17,8 minuty) začne vracet záporná čísla.

Pokud je vydán příkaz pyb.stop(), hardwarový čítač podporující tuto funkci se po dobu trvání „spánkového“ stavu pozastaví. To ovlivní výsledek pyb.elapsed_micros().

pyb.elapsed_millis(start: int) → int

Vrací počet milisekund, které uplynuly od start.

Tato funkce se stará o přetečení čítače a vždy vrací kladné číslo. To znamená, že ji lze použít k měření period až přibližně 12,4 dne.

Příklad:

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

pyb.elapsed_micros(start: int) → int

Vrací počet mikrosekund, které uplynuly od start.

Tato funkce se stará o přetečení čítače a vždy vrací kladné číslo. To znamená, že ji lze použít k měření period až přibližně 17,8 minuty.

Příklad:

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

Funkce související s resetem

pyb.hard_reset() → None

Resetuje OpenMV Cam způsobem podobným stisknutí externího tlačítka RESET.

pyb.bootloader() → None

Resetuje do vlastního USB DFU bootloaderu OpenMV, připraveného k aktualizaci firmwaru. Toto je doporučený způsob, jak vyvolat DFU z běžícího kódu – při resetu není třeba aktivovat žádný BOOT pin.

Není k dispozici na OpenMV Cam N6 (vrstva zpětné kompatibility pyb je na této desce vypnuta); místo toho použijte machine.bootloader().

pyb.fault_debug(value: bool) → None

Povolí nebo zakáže ladění hard-fault. Hard-fault nastává, když dojde k fatální chybě v základním systému, například k neplatnému přístupu do paměti.

Pokud je argument value False, deska se při hard faultu automaticky resetuje.

Pokud je value True, pak deska při hard faultu vypíše registry a trasování zásobníku a poté donekonečna cyklicky bliká LED diodami.

Výchozí hodnota je zakázáno, tj. automaticky resetovat.

Funkce související s přerušeními

pyb.disable_irq() → bool

Zakáže požadavky na přerušení. Vrací předchozí stav IRQ: False/True pro zakázaná/povolená IRQ. Tuto návratovou hodnotu lze předat funkci enable_irq pro obnovení IRQ do jeho původního stavu.

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

Povolí požadavky na přerušení. Pokud je state True (výchozí hodnota), pak jsou IRQ povolena. Pokud je state False, pak jsou IRQ zakázána. Nejběžnějším použitím této funkce je předat jí hodnotu vrácenou funkcí disable_irq pro ukončení kritické sekce.

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

Pokud nejsou zadány žádné argumenty, vrací n-tici taktovacích frekvencí (sysclk, hclk, pclk1, pclk2) v hertzích:

Pole	Význam
sysclk	Frekvence CPU
hclk	Frekvence sběrnice AHB, jádrové paměti a DMA
pclk1	Frekvence sběrnice APB1
pclk2	Frekvence sběrnice APB2

Pokud jsou zadány nějaké argumenty, funkce nastaví frekvenci CPU (a frekvence sběrnic, pokud jsou poskytnuty další argumenty). Frekvence jsou v hertzích; je vybrána největší podporovaná frekvence, která není větší než zadaná hodnota. Sada platných frekvencí sysclk a maximální hodnoty hclk / pclk1 / pclk2 závisí na MCU – viz příslušný referenční manuál STM32 pro používanou OpenMV Cam. Frekvence sběrnic jsou odvozeny z sysclk pomocí předděličů, které ovladač vybírá tak, aby co nejlépe odpovídaly požadovaným hodnotám.

Varování

Změna frekvence, když je povoleno USB, může učinit USB nespolehlivým. Změňte ji ze souboru boot.py před spuštěním USB periferie a nevybírejte hodnotu sysclk příliš nízkou pro požadavky na USB hodiny daného MCU.

Funkce související s napájením

pyb.wfi() → None

Čeká na interní nebo externí přerušení.

Toto vykoná instrukci wfi, která snižuje spotřebu energie MCU, dokud nedojde k jakémukoli přerušení (ať už internímu nebo externímu), v kterémžto okamžiku pokračuje vykonávání. Vezměte na vědomí, že přerušení systémového tiku nastává jednou za milisekundu (1000Hz), takže tato funkce zablokuje běh nejvýše na 1ms.

pyb.stop() → None

Uvede OpenMV Cam do nízkopříkonového stavu STM32 stop. Vykonávání pokračuje z tohoto bodu po probuzení. Probuzení vyžaduje externí přerušení nebo událost hodin reálného času; pro jeho konfiguraci viz pyb.RTC.wakeup(). Přesný dosažitelný odběr proudu závisí na desce a na tom, které periferie zůstanou taktovány.

pyb.standby() → None

Uvede OpenMV Cam do hlubokého spánkového stavu STM32 standby. Toto je nejnižší úroveň vypnutí napájení; zařízení z ní vystoupí tvrdým resetem po probuzení, takže vykonávání nepokračuje na místě. Probuzení vyžaduje událost hodin reálného času; pro jeho konfiguraci viz pyb.RTC.wakeup(). Přesný dosažitelný odběr proudu závisí na desce.

Různé funkce

pyb.have_cdc() → bool

Vrací True, pokud je USB připojeno jako sériové zařízení, jinak False.

Poznámka

Tato funkce je zastaralá. Místo ní použijte pyb.USB_VCP().isconnected().

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

Přijme 4prvkovou n-tici (nebo seznam) a odešle ji USB hostiteli (PC) pro signalizaci události pohybu HID myši.

Poznámka

Tato funkce je zastaralá. Místo ní použijte pyb.USB_HID.send().

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

Vypíše spoustu informací o desce.

pyb.main(filename: str) → None

Nastaví název souboru hlavního skriptu, který se spustí po dokončení boot.py. Pokud tato funkce není zavolána, spustí se výchozí soubor main.py.

Volat tuto funkci má smysl pouze zevnitř boot.py.

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

Poznámka

Tato funkce je zastaralá. Místo ní použijte vfs.mount() / vfs.umount() a blokové zařízení odvozené od vfs.AbstractBlockDev.

Připojí blokové zařízení pod mountpoint. device musí implementovat starší protokol blokového zařízení pyb (rovněž zastaralý – moderní rozhraní viz vfs.AbstractBlockDev):

Metoda	Účel
readblocks(self, blocknum, buf)	Zkopíruje buf bajtů ze zařízení počínaje blokem blocknum. Délka buf je násobkem 512.
writeblocks(self, blocknum, buf) (volitelné)	Zapíše buf do zařízení počínaje blokem blocknum. Pokud je vynecháno, zařízení je připojeno pouze pro čtení.
count(self)	Vrací počet 512bajtových bloků na zařízení.
sync(self) (volitelné)	Vyprázdní veškeré zapamatované zápisy.

mountpoint je cesta v kořeni souborového systému, kam zařízení připojit; musí začínat lomítkem dopředu. readonly vynutí připojení pouze pro čtení. mkfs vytvoří nový souborový systém, pokud žádný není přítomen.

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

Získá nebo nastaví UART objekt, na kterém je opakován REPL.

pyb.rng() → int

Vrací 30bitové hardwarově generované náhodné číslo.

pyb.sync() → None

Synchronizuje všechny souborové systémy.

pyb.unique_id() → bytes

Vrací řetězec o délce 12 bajtů (96 bitů), což je jedinečné ID daného MCU.

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

Pokud je zavolána bez argumentů, vrací aktuální USB režim jako řetězec.

Pokud je zavolána s poskytnutým modestr, pokusí se nakonfigurovat USB režim. Rozumí se následujícím hodnotám modestr:

modestr	Konfiguruje
None	Zakáže USB.
'VCP'	Pouze VCP (Virtual COM Port).
'MSC'	Pouze MSC (USB mass storage class).
'VCP+MSC'	VCP a MSC.
'VCP+HID'	VCP a HID (human interface device).
'VCP+MSC+HID'	VCP, MSC a HID dohromady. Není podporováno na každé OpenMV Cam.

Kvůli zpětné kompatibilitě se 'CDC' rozumí jako 'VCP' (a obdobně pro 'CDC+MSC' a 'CDC+HID').

Parametr port by měl být celé číslo (0, 1, …) a vybírá, který USB port použít, pokud deska podporuje více portů. Hodnota -1 použije výchozí nebo automaticky vybraný port.

Parametry vid a pid vám umožňují specifikovat VID (vendor id) a PID (product id). Hodnota pid rovná -1 vybere PID na základě hodnoty modestr.

Při povolení režimu MSC lze parametr msc použít k zadání seznamu SCSI LUN, které se mají vystavit na rozhraní mass storage. Například msc=(pyb.Flash(), pyb.SDCard()).

Při povolení režimu HID můžete také specifikovat detaily HID předáním klíčového parametru hid. Přijímá n-tici (subclass, protocol, max packet length, polling interval, report descriptor). Ve výchozím nastavení nastaví vhodné hodnoty pro USB myš. Existuje také konstanta pyb.hid_keyboard, což je vhodná n-tice pro USB klávesnici.

Parametr high_speed, nastavený na True, povolí režim USB HS, pokud je podporován hardwarem.

Konstanty

Obě níže uvedené konstanty jsou hotové 5prvkové n-tice ve tvaru

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

vhodné pro předání jako argument hid funkce usb_mode() k tomu, aby se OpenMV Cam zobrazila hostiteli jako USB HID zařízení. subclass = 1 znamená „boot interface“ a protocol vybírá třídu boot zařízení (1 = klávesnice, 2 = myš). Pátý prvek je objekt bytes obsahující deskriptor HID reportu použitý při výčtu zařízení hostitelem.

pyb.hid_mouse: tuple

Předpřipravený HID deskriptor pro 3tlačítkovou boot myš s relativním pohybem X/Y. N-tice je (1, 2, 4, 8, <mouse report descriptor>): boot subclass, protokol myši, 4bajtové vstupní reporty (maska tlačítek + X + Y + kolečko), dotazované každých 8 ms. Vestavěný deskriptor reportu je ten, který používá pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

Předpřipravený HID deskriptor pro USB boot klávesnici. N-tice je (1, 1, 8, 8, <keyboard report descriptor>): boot subclass, protokol klávesnice, 8bajtové vstupní reporty (bajt modifikátoru, jeden rezervovaný bajt, šest souběžných kódů kláves), dotazované každých 8 ms. Vestavěný deskriptor reportu odpovídá standardnímu 8bajtovému rozložení HID boot klávesnice, takže report odeslaný přes USB_HID.send() by měl být bytes ve tvaru (modifiers, 0, key1, key2, key3, key4, key5, key6).

Třídy

• třída ADC – analogově-digitální převod
• třída ADCAll – přístup ke všem kanálům ADC
• třída CAN – komunikační sběrnice controller area network
• třída DAC – digitálně-analogový převod
• třída ExtInt – konfigurace I/O pinů pro přerušení při externích událostech
• třída Flash – přístup k zabudované flash paměti
• třída I2C – dvouvodičový sériový protokol
• třída LED – vestavěná LED
• třída Pin – ovládání I/O pinů
• třída PinAF – alternativní funkce pinu
• třída RTC – hodiny reálného času
• třída Servo – ovladač 3vodičového hobby serva
• třída SPI – sériový protokol řízený řadičem
• třída Timer – ovládání interních časovačů
• třída TimerChannel – nastavení kanálu pro časovač
• třída UART – duplexní sériová komunikační sběrnice
• třída USB_HID – USB Human Interface Device (HID)
• třída USB_VCP – USB virtuální komunikační port