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.

Эта функция учитывает переполнение счётчика и всегда возвращает положительное число. Это означает, что её можно использовать для измерения периодов длительностью примерно до 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). Аппаратный сбой – это фатальная ошибка в нижележащей системе, например недопустимый доступ к памяти.

Если аргумент value равен False, то при возникновении аппаратного сбоя плата автоматически сбрасывается.

Если value равен True, то при возникновении аппаратного сбоя плата выведет регистры и трассировку стека, а затем будет бесконечно мигать светодиодами.

Значение по умолчанию – отключено, то есть автоматический сброс.

Функции, связанные с прерываниями

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

Если вызвана без аргументов, возвращает кортеж частот тактирования (sysclk, hclk, pclk1, pclk2) в герцах:

Поле	Значение
sysclk	Частота CPU
hclk	Частота шины AHB, основной памяти и DMA
pclk1	Частота шины APB1
pclk2	Частота шины APB2

Если переданы какие-либо аргументы, то функция устанавливает частоту CPU (и частоты шин, если предоставлены дополнительные аргументы). Частоты указываются в герцах; выбирается наибольшая поддерживаемая частота, не превышающая заданное значение. Набор допустимых частот sysclk и максимальные значения hclk / pclk1 / pclk2 зависят от MCU – обратитесь к соответствующему справочному руководству STM32 для используемой OpenMV Cam. Частоты шин выводятся из sysclk с помощью предделителей, которые драйвер подбирает для наилучшего соответствия запрошенным значениям.

Предупреждение

Изменение частоты при включённом USB может сделать USB ненадёжным. Изменяйте её в boot.py, до запуска периферийного устройства USB, и не выбирайте значение sysclk слишком низким для требований к тактированию USB данного MCU.

Функции, связанные с питанием

pyb.wfi() → None

Ожидает внутреннего или внешнего прерывания.

Выполняет инструкцию wfi, которая снижает энергопотребление MCU до тех пор, пока не произойдёт какое-либо прерывание (внутреннее или внешнее), после чего выполнение продолжается. Обратите внимание, что прерывание системного тика происходит раз в миллисекунду (1000 Гц), поэтому эта функция блокирует выполнение не более чем на 1 мс.

pyb.stop() → None

Переводит OpenMV Cam в энергосберегающее состояние STM32 stop. Выполнение продолжается с этой точки после пробуждения. Для пробуждения требуется внешнее прерывание или событие часов реального времени; см. pyb.RTC.wakeup() для его настройки. Точное достижимое потребление тока зависит от платы и от того, какие периферийные устройства остаются тактируемыми.

pyb.standby() → None

Переводит OpenMV Cam в состояние глубокого сна STM32 standby. Это самый низкий уровень энергопотребления; устройство выходит из него через аппаратный сброс при пробуждении, поэтому выполнение не возобновляется на месте. Для пробуждения требуется событие часов реального времени; см. pyb.RTC.wakeup() для его настройки. Точное достижимое потребление тока зависит от платы.

Прочие функции

pyb.have_cdc() → bool

Возвращает True, если USB подключён как последовательное устройство, иначе False.

Примечание

Эта функция устарела. Вместо неё используйте pyb.USB_VCP().isconnected().

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

Принимает 4-кортеж (или список) и отправляет его USB-хосту (ПК), чтобы сигнализировать о событии перемещения 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-устройств массового хранения).
'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 (идентификатор производителя) и PID (идентификатор продукта). Значение pid, равное -1, выберет PID на основе значения modestr.

При включении режима 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)

подходящие для передачи в качестве аргумента hid функции usb_mode(), чтобы OpenMV Cam отображалась для хоста как USB-устройство HID. subclass = 1 означает «boot interface», а protocol выбирает класс boot-устройства (1 = клавиатура, 2 = мышь). Пятый элемент – это объект bytes, содержащий дескриптор отчёта HID, используемый при перечислении устройства хостом.

pyb.hid_mouse: tuple

Готовый дескриптор HID для 3-кнопочной boot-мыши с относительным перемещением по X/Y. Кортеж имеет вид (1, 2, 4, 8, <mouse report descriptor>): boot-подкласс, протокол мыши, 4-байтовые входные отчёты (маска кнопок + X + Y + колесо), опрос каждые 8 мс. Встроенный дескриптор отчёта – это тот, который используется в pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

Готовый дескриптор HID для USB boot-клавиатуры. Кортеж имеет вид (1, 1, 8, 8, <keyboard report descriptor>): boot-подкласс, протокол клавиатуры, 8-байтовые входные отчёты (байт модификаторов, один зарезервированный байт, шесть одновременных кодов клавиш), опрос каждые 8 мс. Встроенный дескриптор отчёта соответствует стандартной 8-байтовой раскладке HID boot-клавиатуры, поэтому отчёт, отправляемый через USB_HID.send(), должен быть объектом bytes вида (modifiers, 0, key1, key2, key3, key4, key5, key6).

Классы

• class ADC – аналого-цифровое преобразование
• class ADCAll – доступ ко всем каналам ADC
• class CAN – шина связи controller area network
• класс DAC – цифро-аналоговое преобразование
• класс ExtInt – настройка выводов I/O для прерывания по внешним событиям
• класс Flash – доступ к встроенной флеш-памяти
• класс I2C – двухпроводной последовательный протокол
• класс LED – встроенный светодиод
• класс Pin – управление выводами ввода-вывода
• класс PinAF – альтернативные функции выводов
• класс RTC – часы реального времени
• класс Servo – драйвер 3-проводного хобби-сервопривода
• класс SPI – управляемый контроллером последовательный протокол
• класс Timer – управление внутренними таймерами
• класс TimerChannel – настройка канала для таймера
• class UART – дуплексная последовательная коммуникационная шина
• class USB_HID – USB-устройство человеко-машинного интерфейса (HID)
• class USB_VCP – виртуальный COM-порт USB