pyb — פונקציות הקשורות ללוח

אזהרה

מודול pyb הוצא משימוש. השתמשו במודול machine חוצה-הפורטים עבור קוד חדש – הוא מספק את אותה פונקציונליות בכל OpenMV Cam ללא תלות במשפחת ה-MCU, בעוד ש-pyb קיים רק בלוחות מבוססי STM32. pyb נשמר לצורך תאימות לאחור עם סקריפטים ישנים, לא יתווספו אליו מאפיינים חדשים, והוא עשוי להיות מוסר בגרסה עתידית.

המודול pyb מכיל פונקציות ייחודיות ל-STM32 הקשורות ללוח.

פונקציות הקשורות לזמן

pyb.delay(ms: int) → None

השהיה למשך מספר המילישניות הנתון.

pyb.udelay(us: int) → None

השהיה למשך מספר המיקרושניות הנתון.

pyb.millis() → int

מחזירה את מספר המילישניות שחלפו מאז האיפוס האחרון של הלוח.

התוצאה היא תמיד smallint של MicroPython (מספר חתום של 31 ביט), ולכן לאחר 2^30 מילישניות (כ-12.4 ימים) הפונקציה תתחיל להחזיר מספרים שליליים.

שימו לב שאם pyb.stop() מופעלת, מונה החומרה התומך בפונקציה זו יושהה למשך מצב ה“שינה“. הדבר ישפיע על התוצאה של pyb.elapsed_millis().

pyb.micros() → int

מחזירה את מספר המיקרושניות שחלפו מאז האיפוס האחרון של הלוח.

התוצאה היא תמיד smallint של MicroPython (מספר חתום של 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

מאפסת אל מאתחל (bootloader) ה-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, הוא ידפיס את האוגרים (registers) ואת מעקב המחסנית, ולאחר מכן יבהב את הנוריות (LEDs) ללא הגבלה.

ערך ברירת המחדל הוא מושבת, כלומר איפוס אוטומטי.

פונקציות הקשורות לפסיקות

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 כדי לצאת ממקטע קריטי.

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 באמצעות מחלקי תדר (prescalers) שהמנהל בוחר כדי להתאים בצורה הטובה ביותר לערכים המבוקשים.

אזהרה

שינוי התדר בעוד ה-USB מאופשר עלול להפוך את ה-USB לבלתי אמין. שנו אותו מתוך boot.py, לפני הפעלת ההתקן ההיקפי של ה-USB, ואל תבחרו ערך sysclk נמוך מדי עבור דרישות שעון ה-USB של ה-MCU.

פונקציות הקשורות לצריכת חשמל

pyb.wfi() → None

המתנה לפסיקה פנימית או חיצונית.

פעולה זו מבצעת פקודת wfi המפחיתה את צריכת החשמל של ה-MCU עד שמתרחשת פסיקה כלשהי (בין אם פנימית או חיצונית), שאז הביצוע ממשיך. שימו לב שפסיקת ה-system-tick מתרחשת אחת לכל מילישנייה (1000Hz) ולכן פונקציה זו תחסום למשך 1ms לכל היותר.

pyb.stop() → None

מעבירה את ה-OpenMV Cam למצב צריכת החשמל הנמוכה stop של STM32. הביצוע ממשיך מנקודה זו עם ההתעוררות. ההתעוררות דורשת פסיקה חיצונית או אירוע שעון זמן-אמת; ראו pyb.RTC.wakeup() כדי להגדיר אחד כזה. צריכת הזרם המדויקת שניתן להשיג תלויה בלוח ובאילו התקנים היקפיים נותרים מקבלים שעון.

pyb.standby() → None

מעבירה את ה-OpenMV Cam למצב השינה העמוקה standby של STM32. זוהי רמת כיבוי החשמל הנמוכה ביותר; ההתקן יוצא ממנה באמצעות איפוס מלא (hard reset) כאשר מתעורר, ולכן הביצוע אינו מתחדש במקומו. ההתעוררות דורשת אירוע שעון זמן-אמת; ראו pyb.RTC.wakeup() כדי להגדיר אחד כזה. צריכת הזרם המדויקת שניתן להשיג תלויה בלוח.

פונקציות שונות

pyb.have_cdc() → bool

מחזירה True אם ה-USB מחובר כהתקן טורי, אחרת False.

הערה

פונקציה זו הוצאה משימוש. השתמשו ב-pyb.USB_VCP().isconnected() במקום זאת.

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

מקבלת 4-tuple (או רשימה) ושולחת אותו למארח ה-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)	מעתיק buf בייטים מההתקן החל מבלוק blocknum. אורך buf הוא כפולה של 512.
writeblocks(self, blocknum, buf) (אופציונלי)	כותב buf אל ההתקן החל מבלוק blocknum. אם מושמט, ההתקן מעוגן לקריאה בלבד.
count(self)	מחזיר את מספר הבלוקים בני 512 הבייטים בהתקן.
sync(self) (אופציונלי)	מרוקן כתיבות שנשמרו במטמון.

mountpoint הוא הנתיב בשורש מערכת הקבצים שבו לעגן את ההתקן; הוא חייב להתחיל בקו נטוי קדמי. readonly כופה עיגון לקריאה בלבד. mkfs יוצר מערכת קבצים חדשה אם אין כזו קיימת.

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

מקבלת או מגדירה את אובייקט ה-UART שעליו ה-REPL משוכפל.

pyb.rng() → int

מחזירה מספר אקראי שנוצר על ידי החומרה ברוחב 30 ביט.

pyb.sync() → None

מסנכרנת את כל מערכות הקבצים.

pyb.unique_id() → bytes

מחזירה מחרוזת של 12 בייטים (96 ביט), שהיא המזהה הייחודי של ה-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 הנוכחי כמחרוזת.

אם נקראת עם 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 LUNs לחשיפה בממשק האחסון ההמוני. לדוגמה 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-tuples מוכנים מראש בצורה

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

מתאימים להעברה כארגומנט ה-hid של usb_mode() כדי לגרום ל-OpenMV Cam להופיע בפני המארח כהתקן USB HID. subclass = 1 משמעו ”boot interface“ ו-protocol בוחר את מחלקת התקן ה-boot (1 = מקלדת, 2 = עכבר). האיבר החמישי הוא אובייקט bytes המכיל את מתאר דיווח ה-HID המשמש כאשר המארח מונה את ההתקן.

pyb.hid_mouse: tuple

מתאר HID בנוי מראש עבור עכבר boot בעל 3 כפתורים עם תנועת X/Y יחסית. ה-tuple הוא (1, 2, 4, 8, <mouse report descriptor>): boot subclass, פרוטוקול עכבר, דיווחי קלט בני 4 בייט (מסכת כפתורים + X + Y + גלגלת), מתשאל כל 8 ms. מתאר הדיווח המובנה הוא זה שבו משתמש pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

מתאר HID בנוי מראש עבור מקלדת boot של USB. ה-tuple הוא (1, 1, 8, 8, <keyboard report descriptor>): boot subclass, פרוטוקול מקלדת, דיווחי קלט בני 8 בייט (בייט modifier, בייט שמור אחד, שישה קודי מקש בו-זמניים), מתשאל כל 8 ms. מתאר הדיווח המובנה תואם לפריסת boot-keyboard הסטנדרטית של HID בת 8 הבייטים, ולכן הדיווח הנשלח באמצעות USB_HID.send() צריך להיות bytes בצורה (modifiers, 0, key1, key2, key3, key4, key5, key6).

מחלקות

• class ADC – המרה מאנלוגי לדיגיטלי
• class ADCAll – גישה לכל ערוצי ה-ADC
• class CAN – אפיק תקשורת רשת בקרים (controller area network)
• class DAC – המרה מדיגיטלי לאנלוגי
• class ExtInt – הגדרת פיני קלט/פלט להפעלת פסיקה על אירועים חיצוניים
• class Flash – גישה לאחסון פלאש מובנה
• class I2C – פרוטוקול טורי דו-חוטי
• class LED – LED על הלוח
• class Pin – שליטה בפיני קלט/פלט
• class PinAF – פונקציות חלופיות של פין
• class RTC – שעון זמן אמת
• class Servo – נהג סרוו תחביבי בעל 3 חוטים
• class SPI – פרוטוקול סדרתי מונע בקר
• class Timer – שליטה בטיימרים פנימיים
• class TimerChannel – הגדרת ערוץ עבור טיימר
• מחלקה UART – אפיק תקשורת טורית דו-כיוונית
• מחלקה USB_HID – התקן ממשק אנושי של USB (HID)
• מחלקה USB_VCP – פורט תקשורת וירטואלי של USB