pyb --- 與開發板相關的函式

警告

pyb 模組已被棄用。 新程式碼請改用跨埠的 machine 模組——它在每一款 OpenMV Cam 上都提供相同的功能，不論 MCU 系列為何；而 pyb 僅存在於以 STM32 為基礎的開發板上。pyb 之所以保留，是為了與較舊的指令碼維持向後相容，不會再新增功能，且在未來版本中可能會被移除。

pyb 模組包含與開發板相關的 STM32 專屬函式。

時間相關函式

pyb.delay(ms: int) → None

延遲指定的毫秒數。

pyb.udelay(us: int) → None

延遲指定的微秒數。

pyb.millis() → int

傳回自開發板上次重置以來的毫秒數。

結果一律為 MicroPython smallint（31 位元有號數），因此在 2^30 毫秒（約 12.4 天）之後，此函式將開始傳回負數。

請注意，若發出 pyb.stop()，支援此函式的硬體計數器將在「睡眠」狀態期間暫停。這會影響 pyb.elapsed_millis() 的結果。

pyb.micros() → int

傳回自開發板上次重置以來的微秒數。

結果一律為 MicroPython smallint（31 位元有號數），因此在 2^30 微秒（約 17.8 分鐘）之後，此函式將開始傳回負數。

請注意，若發出 pyb.stop()，支援此函式的硬體計數器將在「睡眠」狀態期間暫停。這會影響 pyb.elapsed_micros() 的結果。

pyb.elapsed_millis(start: int) → int

傳回自 start 以來已經過的毫秒數。

此函式會處理計數器溢位（wrap），並一律傳回正數。這表示它可用於量測長達約 12.4 天的時間區間。

範例：：

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

pyb.elapsed_micros(start: int) → int

傳回自 start 以來已經過的微秒數。

此函式會處理計數器溢位（wrap），並一律傳回正數。這表示它可用於量測長達約 17.8 分鐘的時間區間。

範例：：

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

重置相關函式

pyb.hard_reset() → None

以類似按下外部 RESET 按鈕的方式重置 OpenMV Cam。

pyb.bootloader() → None

重置進入 OpenMV 自有的 USB DFU 開機載入程式，準備進行韌體更新。這是從執行中的程式碼叫用 DFU 的建議做法——重置時不需要拉高任何 BOOT 接腳。

在 OpenMV Cam N6 上不可用（該開發板上停用了 pyb 舊版相容層）；請改用 machine.bootloader()。

pyb.fault_debug(value: bool) → None

啟用或停用硬故障（hard-fault）除錯。硬故障是指底層系統發生致命錯誤，例如無效的記憶體存取。

若 value 引數為 False，則在發生硬故障時，開發板將自動重置。

若 value 為 True，則當開發板發生硬故障時，它會印出暫存器與堆疊追蹤（stack trace），然後無限循環地閃爍 LED。

預設值為停用，即自動重置。

中斷相關函式

pyb.disable_irq() → bool

停用中斷請求。傳回先前的 IRQ 狀態：False/True 分別代表已停用／已啟用的 IRQ。此傳回值可傳給 enable_irq，以將 IRQ 還原至其原始狀態。

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

啟用中斷請求。若 state 為 True（預設值），則啟用 IRQ。若 state 為 False，則停用 IRQ。此函式最常見的用法，是將 disable_irq 傳回的值傳給它，以離開臨界區段（critical section）。

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

若不給定任何引數，則傳回以赫茲為單位的時脈頻率元組 (sysclk, hclk, pclk1, pclk2)：

欄位	意義
sysclk	CPU 頻率
hclk	AHB 匯流排、核心記憶體與 DMA 頻率
pclk1	APB1 匯流排頻率
pclk2	APB2 匯流排頻率

若給定任何引數，則此函式會設定 CPU 頻率（若提供額外引數，也會設定匯流排頻率）。頻率以赫茲為單位；會選取不大於給定值的最大受支援頻率。有效的 sysclk 頻率集合，以及最大的 hclk / pclk1 / pclk2 值，取決於 MCU——請參閱所使用 OpenMV Cam 的相關 STM32 參考手冊。匯流排頻率是透過驅動程式所選取、能最佳符合請求值的預分頻器，從 sysclk 推導而來。

警告

在 USB 啟用時變更頻率，可能會使 USB 不穩定。請在 USB 周邊裝置啟動之前，從 boot.py 變更它，並且不要選取對該 MCU 的 USB 時脈需求而言過低的 sysclk 值。

電源相關函式

pyb.wfi() → None

等待內部或外部中斷。

這會執行一道 wfi 指令，降低 MCU 的功耗，直到任何中斷（不論內部或外部）發生為止，此時執行便繼續進行。請注意，系統滴答（system-tick）中斷每毫秒發生一次（1000Hz），因此此函式最多會阻擋 1ms。

pyb.stop() → None

讓 OpenMV Cam 進入 STM32 stop 低功耗狀態。喚醒後會從此處繼續執行。喚醒需要外部中斷或即時時鐘（real-time-clock）事件；請參閱 pyb.RTC.wakeup() 以進行設定。實際可達成的電流消耗取決於開發板，以及哪些周邊裝置維持供應時脈。

pyb.standby() → None

讓 OpenMV Cam 進入 STM32 standby 深度睡眠狀態。這是最低的關機等級；裝置在被喚醒時會透過硬重置退出，因此執行不會原地恢復。喚醒需要即時時鐘（real-time-clock）事件；請參閱 pyb.RTC.wakeup() 以進行設定。實際可達成的電流消耗取決於開發板。

其他雜項函式

pyb.have_cdc() → bool

若 USB 以序列裝置形式連接，則傳回 True，否則傳回 False。

備註

此函式已被棄用。請改用 pyb.USB_VCP().isconnected()。

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

接收一個 4 元組（或串列），並將其傳送給 USB 主機（PC），以發出 HID 滑鼠移動事件的訊號。

備註

此函式已被棄用。請改用 pyb.USB_HID.send()。

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

印出大量關於開發板的資訊。

pyb.main(filename: str) → None

設定在 boot.py 完成後要執行的主指令碼檔名。若未呼叫此函式，則會執行預設檔案 main.py。

只有在 boot.py 內呼叫此函式才有意義。

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

備註

此函式已被棄用。請改用 vfs.mount() / vfs.umount()，以及衍生自 vfs.AbstractBlockDev 的區塊裝置。

在 mountpoint 之下掛載一個區塊裝置。device 必須實作舊版 pyb 區塊裝置協定（同樣已被棄用——現代介面請參閱 vfs.AbstractBlockDev）：

方法	用途
readblocks(self, blocknum, buf)	從區塊 blocknum 開始，自裝置複製 buf 大小的位元組量。buf 長度為 512 的倍數。
writeblocks(self, blocknum, buf) （選用）	從區塊 blocknum 開始，將 buf 寫入裝置。若省略此方法，則裝置以唯讀方式掛載。
count(self)	傳回裝置上 512 位元組區塊的數量。
sync(self) （選用）	清空任何快取的寫入。

mountpoint 是檔案系統根目錄中要掛載裝置的路徑；它必須以正斜線開頭。readonly 會強制唯讀掛載。mkfs 會在不存在任何檔案系統時建立新的檔案系統。

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

取得或設定要重複 REPL 的 UART 物件。

pyb.rng() → int

傳回一個 30 位元的硬體產生亂數。

pyb.sync() → None

同步所有檔案系統。

pyb.unique_id() → bytes

傳回一個 12 位元組（96 位元）的字串，即 MCU 的唯一 ID。

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

若不帶引數呼叫，則以字串形式傳回目前的 USB 模式。

若呼叫時提供 modestr，則嘗試設定 USB 模式。可理解下列 modestr 值：

modestr	設定
None	停用 USB。
'VCP'	僅 VCP（虛擬 COM 埠）。
'MSC'	僅 MSC（USB 大量儲存類別）。
'VCP+MSC'	VCP 與 MSC。
'VCP+HID'	VCP 與 HID（人機介面裝置）。
'VCP+MSC+HID'	VCP、MSC 與 HID 同時。並非每一款 OpenMV Cam 都支援。

為了向後相容，'CDC' 會被理解為 'VCP'（'CDC+MSC' 與 'CDC+HID' 亦同）。

port 參數應為整數（0、1、...），用於在開發板支援多個 USB 埠時選取要使用哪一個。值為 -1 時使用預設或自動選取的埠。

vid 與 pid 參數可讓您指定 VID（廠商 id）與 PID（產品 id）。pid 值為 -1 時，會根據 modestr 的值選取 PID。

若啟用 MSC 模式，可使用 msc 參數指定要在大量儲存介面上公開的 SCSI LUN 串列。例如 msc=(pyb.Flash(), pyb.SDCard())。

若啟用 HID 模式，您也可以透過傳入 hid 關鍵字參數來指定 HID 細節。它接收一個 (subclass, protocol, max packet length, polling interval, report descriptor) 元組。預設情況下，它會為 USB 滑鼠設定適當的值。此外還有一個 pyb.hid_keyboard 常數，是適用於 USB 鍵盤的元組。

當 high_speed 參數設為 True 時，若硬體支援，則啟用 USB HS 模式。

常數

下方兩個常數都是現成的 5 元組，形式為

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

適合作為 usb_mode() 的 hid 引數傳入，以使 OpenMV Cam 對主機顯示為一個 USB HID 裝置。subclass = 1 表示「開機介面」（boot interface），而 protocol 用於選取開機裝置類別（1 = 鍵盤，2 = 滑鼠）。第五個元素是一個 bytes 物件，內含主機列舉裝置時所使用的 HID 報告描述子（report descriptor）。

pyb.hid_mouse: tuple

適用於具相對 X/Y 移動的 3 鍵開機滑鼠的預先建構 HID 描述子。此元組為 (1, 2, 4, 8, <mouse report descriptor>)：開機子類別、滑鼠協定、4 位元組輸入報告（按鈕遮罩 + X + Y + 滾輪），每 8 ms 輪詢一次。內建的報告描述子即 pyb.USB_HID().send((buttons, dx, dy, wheel)) 所使用的那一個。

pyb.hid_keyboard: tuple

適用於 USB 開機鍵盤的預先建構 HID 描述子。此元組為 (1, 1, 8, 8, <keyboard report descriptor>)：開機子類別、鍵盤協定、8 位元組輸入報告（修飾位元組、一個保留位元組、六個同時按下的鍵碼），每 8 ms 輪詢一次。內建的報告描述子符合標準的 8 位元組 HID 開機鍵盤配置，因此透過 USB_HID.send() 傳送的報告應為形如 (modifiers, 0, key1, key2, key3, key4, key5, key6) 的 bytes。

類別

• class ADC -- 類比數位轉換
• class ADCAll -- 存取所有 ADC 通道
• class CAN -- 控制器區域網路通訊匯流排
• class DAC -- 數位轉類比轉換
• class ExtInt -- 設定 I/O 接腳以在外部事件時中斷
• class Flash -- 存取內建的快閃記憶體儲存空間
• class I2C -- 雙線序列協定
• class LED -- 板載 LED
• class Pin -- 控制 I/O 接腳
• class PinAF -- 接腳替代功能
• class RTC -- 即時時鐘
• class Servo -- 三線式玩具伺服馬達驅動程式
• class SPI -- 由控制器驅動的串列協定
• class Timer -- 控制內部計時器
• class TimerChannel -- 為計時器設定一個通道
• class UART -- 雙工序列通訊匯流排
• class USB_HID -- USB 人機介面裝置（HID）
• class USB_VCP -- USB 虛擬通訊埠