pyb --- ฟังก์ชันที่เกี่ยวข้องกับบอร์ด

Warning

โมดูล 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

ฟังก์ชันนี้จัดการการล้นของตัวนับ และจะคืนค่าเป็นจำนวนบวกเสมอ ซึ่งหมายความว่าสามารถใช้วัดช่วงเวลาได้สูงสุดประมาณ 12.4 วัน

ตัวอย่าง:

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

pyb.elapsed_micros(start: int) → int

คืนค่าจำนวนไมโครวินาทีที่ผ่านไปนับตั้งแต่ start

ฟังก์ชันนี้จัดการการล้นของตัวนับ และจะคืนค่าเป็นจำนวนบวกเสมอ ซึ่งหมายความว่าสามารถใช้วัดช่วงเวลาได้สูงสุดประมาณ 17.8 นาที

ตัวอย่าง:

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

ฟังก์ชันที่เกี่ยวกับการรีเซ็ต

pyb.hard_reset() → None

รีเซ็ต OpenMV Cam ในลักษณะเดียวกับการกดปุ่ม RESET ภายนอก

pyb.bootloader() → None

รีเซ็ตเข้าสู่บูตโหลดเดอร์ USB DFU ของ OpenMV เพื่อเตรียมอัปเดตเฟิร์มแวร์ นี่คือวิธีที่แนะนำในการเรียก DFU จากโค้ดที่กำลังทำงานอยู่ โดยไม่จำเป็นต้องกดพิน BOOT ขณะรีเซ็ต

ไม่รองรับบน OpenMV Cam N6 (เลเยอร์ความเข้ากันได้เดิมของ pyb ถูกปิดใช้งานบนบอร์ดนั้น) ให้ใช้ machine.bootloader() แทน

pyb.fault_debug(value: bool) → None

เปิดหรือปิดการดีบักข้อผิดพลาดแบบ hard-fault ซึ่ง hard-fault คือเมื่อเกิดข้อผิดพลาดร้ายแรงในระบบพื้นฐาน เช่น การเข้าถึงหน่วยความจำที่ไม่ถูกต้อง

หากอาร์กิวเมนต์ value เป็น False บอร์ดจะรีเซ็ตโดยอัตโนมัติเมื่อเกิด hard fault

หาก value เป็น True เมื่อบอร์ดเกิด hard fault จะพิมพ์ค่ารีจิสเตอร์และ 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

หากเรียกโดยไม่มีอาร์กิวเมนต์ จะคืนค่า tuple ของความถี่นาฬิกา (sysclk, hclk, pclk1, pclk2) ในหน่วยเฮิรตซ์:

ฟิลด์	ความหมาย
sysclk	ความถี่ CPU
hclk	ความถี่บัส AHB หน่วยความจำหลัก และ DMA
pclk1	ความถี่บัส APB1
pclk2	ความถี่บัส APB2

หากเรียกพร้อมอาร์กิวเมนต์ ฟังก์ชันจะกำหนดความถี่ CPU (และความถี่บัสหากระบุอาร์กิวเมนต์เพิ่มเติม) ความถี่อยู่ในหน่วยเฮิรตซ์ โดยจะเลือกความถี่ที่รองรับสูงสุดที่ไม่เกินค่าที่กำหนด ชุดของค่า sysclk ที่ถูกต้องและค่าสูงสุดของ hclk / pclk1 / pclk2 ขึ้นอยู่กับ MCU -- โปรดอ้างอิงคู่มือ STM32 ที่เกี่ยวข้องสำหรับ OpenMV Cam ที่ใช้งาน ความถี่บัสได้มาจาก sysclk ผ่านตัวหาร (prescaler) ที่ไดรเวอร์เลือกให้ตรงกับค่าที่ร้องขอมากที่สุด

Warning

การเปลี่ยนความถี่ขณะ USB ทำงานอยู่อาจทำให้ USB ทำงานไม่เสถียร ควรเปลี่ยนจาก boot.py ก่อนที่อุปกรณ์ต่อพ่วง USB จะเริ่มทำงาน และอย่าเลือกค่า sysclk ต่ำเกินไปจนไม่ตรงตามข้อกำหนดนาฬิกา USB ของ MCU

ฟังก์ชันที่เกี่ยวกับพลังงาน

pyb.wfi() → None

รอการเกิดอินเทอร์รัปต์ภายในหรือภายนอก

คำสั่งนี้รัน wfi instruction ซึ่งลดการใช้พลังงานของ MCU จนกว่าจะเกิดอินเทอร์รัปต์ใดๆ (ไม่ว่าจะภายในหรือภายนอก) จึงจะดำเนินการต่อ โปรดทราบว่า system-tick interrupt เกิดขึ้นทุกมิลลิวินาที (1000Hz) ดังนั้นฟังก์ชันนี้จะบล็อกได้นานสูงสุด 1ms

pyb.stop() → None

นำ OpenMV Cam เข้าสู่สถานะพลังงานต่ำแบบ STM32 stop การทำงานจะดำเนินต่อจากจุดนี้เมื่อตื่นขึ้น การปลุกต้องใช้อินเทอร์รัปต์ภายนอกหรือเหตุการณ์ real-time-clock ดู pyb.RTC.wakeup() เพื่อกำหนดค่า กระแสไฟที่ใช้จริงขึ้นอยู่กับบอร์ดและอุปกรณ์ต่อพ่วงที่ยังคงจ่ายนาฬิกาอยู่

pyb.standby() → None

นำ OpenMV Cam เข้าสู่สถานะ deep-sleep แบบ STM32 standby นี่คือระดับการปิดพลังงานที่ต่ำที่สุด อุปกรณ์จะออกจากสถานะนี้ผ่านการรีเซ็ตแบบ hard reset เมื่อถูกปลุก ดังนั้นการทำงานจะไม่ดำเนินต่อจากจุดเดิม การปลุกต้องใช้เหตุการณ์ real-time-clock ดู pyb.RTC.wakeup() เพื่อกำหนดค่า กระแสไฟที่ใช้จริงขึ้นอยู่กับบอร์ด

ฟังก์ชันเบ็ดเตล็ด

pyb.have_cdc() → bool

คืนค่า True หาก USB เชื่อมต่ออยู่ในรูปแบบอุปกรณ์อนุกรม หรือ False ในกรณีอื่น

Note

ฟังก์ชันนี้ถูกเลิกใช้งานแล้ว ให้ใช้ pyb.USB_VCP().isconnected() แทน

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

รับ 4-tuple (หรือ list) และส่งไปยัง USB host (PC) เพื่อส่งสัญญาณเหตุการณ์การเคลื่อนไหวของเมาส์ HID

Note

ฟังก์ชันนี้ถูกเลิกใช้งานแล้ว ให้ใช้ 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

Note

ฟังก์ชันนี้ถูกเลิกใช้งานแล้ว ให้ใช้ vfs.mount() / vfs.umount() และอุปกรณ์ block device ที่สืบทอดจาก vfs.AbstractBlockDev แทน

เมาต์ block device ภายใต้ mountpoint โดย device ต้องใช้งาน legacy pyb block-device protocol (ซึ่งถูกเลิกใช้งานเช่นกัน -- ดู vfs.AbstractBlockDev สำหรับอินเทอร์เฟซสมัยใหม่):

เมธอด	วัตถุประสงค์
readblocks(self, blocknum, buf)	คัดลอกข้อมูลจำนวน buf ไบต์จากอุปกรณ์เริ่มต้นที่บล็อก blocknum โดยความยาวของ buf เป็นทวีคูณของ 512
writeblocks(self, blocknum, buf) (optional)	เขียน buf ไปยังอุปกรณ์เริ่มต้นที่บล็อก blocknum หากละเว้น อุปกรณ์จะถูกเมาต์แบบอ่านอย่างเดียว
count(self)	คืนค่าจำนวนบล็อกขนาด 512 ไบต์บนอุปกรณ์
sync(self) (optional)	ล้างการเขียนที่ถูกแคชไว้

mountpoint คือเส้นทางในรูทของระบบไฟล์เพื่อเมาต์อุปกรณ์ โดยต้องขึ้นต้นด้วย forward slash readonly บังคับเมาต์แบบอ่านอย่างเดียว mkfs สร้างระบบไฟล์ใหม่หากไม่มีอยู่

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

รับหรือกำหนดออบเจกต์ UART ที่ REPL จะถูกส่งซ้ำไปที่นั้น

pyb.rng() → int

คืนค่าตัวเลขสุ่ม 30 บิตที่สร้างโดยฮาร์ดแวร์

pyb.sync() → None

ซิงค์ระบบไฟล์ทั้งหมด

pyb.unique_id() → bytes

คืนค่า string ขนาด 12 ไบต์ (96 บิต) ซึ่งเป็น unique ID ของ 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

หากเรียกโดยไม่มีอาร์กิวเมนต์ จะคืนค่าโหมด USB ปัจจุบันในรูปแบบ string

หากเรียกพร้อม modestr จะพยายามกำหนดค่าโหมด USB โดยค่า modestr ที่รองรับมีดังนี้:

modestr	กำหนดค่า
None	ปิดใช้งาน USB
'VCP'	VCP (Virtual COM Port) เท่านั้น
'MSC'	MSC (USB mass storage class) เท่านั้น
'VCP+MSC'	VCP และ MSC
'VCP+HID'	VCP และ HID (human interface device)
'VCP+MSC+HID'	VCP, MSC และ HID พร้อมกัน ไม่รองรับบน OpenMV Cam ทุกรุ่น

เพื่อความเข้ากันได้ย้อนหลัง 'CDC' ถูกตีความว่าหมายถึง 'VCP' (และเช่นเดียวกันสำหรับ 'CDC+MSC' และ 'CDC+HID')

พารามิเตอร์ port ควรเป็นจำนวนเต็ม (0, 1, ...) และใช้เลือกพอร์ต USB ที่จะใช้หากบอร์ดรองรับหลายพอร์ต ค่า -1 ใช้พอร์ตเริ่มต้นหรือพอร์ตที่เลือกโดยอัตโนมัติ

พารามิเตอร์ vid และ pid ช่วยให้คุณระบุ VID (vendor id) และ PID (product id) ค่า pid ที่เป็น -1 จะเลือก PID ตามค่าของ modestr

หากเปิดใช้งานโหมด MSC พารามิเตอร์ msc สามารถใช้ระบุรายการ SCSI LUN ที่จะเปิดเผยบนอินเทอร์เฟซ mass storage ตัวอย่างเช่น msc=(pyb.Flash(), pyb.SDCard())

หากเปิดใช้งานโหมด HID คุณยังสามารถระบุรายละเอียด HID โดยส่งพารามิเตอร์คำสำคัญ hid ซึ่งรับ tuple ในรูปแบบ (subclass, protocol, max packet length, polling interval, report descriptor) ตามค่าเริ่มต้นจะกำหนดค่าที่เหมาะสมสำหรับเมาส์ USB นอกจากนี้ยังมีค่าคงที่ pyb.hid_keyboard ซึ่งเป็น tuple ที่เหมาะสมสำหรับคีย์บอร์ด USB

พารามิเตอร์ high_speed เมื่อกำหนดเป็น True จะเปิดใช้งานโหมด USB HS หากฮาร์ดแวร์รองรับ

ค่าคงที่

ค่าคงที่ทั้งสองด้านล่างนี้เป็น 5-tuple สำเร็จรูปในรูปแบบ

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

ที่เหมาะสำหรับส่งเป็นอาร์กิวเมนต์ hid ของ usb_mode() เพื่อให้ OpenMV Cam ปรากฏต่อ host เป็นอุปกรณ์ USB HID subclass = 1 หมายถึง "boot interface" และ protocol เลือกคลาสอุปกรณ์ boot (1 = keyboard, 2 = mouse) องค์ประกอบที่ห้าเป็นออบเจกต์ bytes ที่เก็บ HID report descriptor ที่ใช้เมื่อ host ทำการ enumerate อุปกรณ์

pyb.hid_mouse: tuple

HID descriptor สำเร็จรูปสำหรับ boot mouse 3 ปุ่มพร้อมการเคลื่อนไหว X/Y แบบสัมพัทธ์ tuple คือ (1, 2, 4, 8, <mouse report descriptor>): boot subclass, mouse protocol, input report 4 ไบต์ (button mask + X + Y + wheel), polling ทุก 8 ms report descriptor ที่ฝังตัวนี้คือสิ่งที่ใช้โดย pyb.USB_HID().send((buttons, dx, dy, wheel))

pyb.hid_keyboard: tuple

HID descriptor สำเร็จรูปสำหรับ USB boot keyboard tuple คือ (1, 1, 8, 8, <keyboard report descriptor>): boot subclass, keyboard protocol, input report 8 ไบต์ (modifier byte, หนึ่ง reserved byte, six concurrent key codes), polling ทุก 8 ms report descriptor ที่ฝังตัวตรงกับ layout มาตรฐาน HID boot-keyboard 8 ไบต์ ดังนั้น report ที่ส่งผ่าน USB_HID.send() ควรเป็น bytes ในรูปแบบ (modifiers, 0, key1, key2, key3, key4, key5, key6)

คลาส

• คลาส ADC -- การแปลงค่าแอนะล็อกเป็นดิจิทัล
• คลาส ADCAll -- เข้าถึงช่อง ADC ทั้งหมด
• คลาส CAN -- บัสการสื่อสารเครือข่ายในพื้นที่ควบคุม
• คลาส DAC -- การแปลงสัญญาณดิจิทัลเป็นแอนะล็อก
• คลาส ExtInt -- กำหนดค่าพิน I/O เพื่ออินเทอร์รัปต์บนเหตุการณ์ภายนอก
• คลาส Flash -- เข้าถึงพื้นที่จัดเก็บแฟลชในตัว
• คลาส I2C -- โปรโตคอลอนุกรมแบบสองสาย
• คลาส LED -- LED บนบอร์ด
• class Pin -- การควบคุมพิน I/O
• class PinAF -- ฟังก์ชันสำรองของพิน
• class RTC -- นาฬิกาเวลาจริง
• class Servo -- ไดรเวอร์เซอร์โวงานอดิเรก 3 สาย
• class SPI -- โปรโตคอลอนุกรมที่ขับเคลื่อนโดยตัวควบคุม
• คลาส Timer -- ควบคุมตัวจับเวลาภายใน
• คลาส TimerChannel -- ตั้งค่าช่องสัญญาณสำหรับตัวจับเวลา
• คลาส UART -- บัสสื่อสารแบบอนุกรมดูเพล็กซ์
• คลาส USB_HID -- อุปกรณ์อินเทอร์เฟซของมนุษย์ USB (HID)
• คลาส USB_VCP -- พอร์ตสื่อสารเสมือน USB