pyb — funciones relacionadas con la placa

Advertencia

El módulo pyb está obsoleto. Para código nuevo, utilice el módulo multiplataforma machine, ya que ofrece la misma funcionalidad en cualquier OpenMV Cam independientemente de la familia de MCU, mientras que pyb solo existe en las placas basadas en STM32. pyb se conserva por compatibilidad con scripts antiguos, no se añadirán nuevas funciones y podría eliminarse en una versión futura.

El módulo pyb contiene funciones específicas de STM32 relacionadas con la placa.

Funciones relacionadas con el tiempo

pyb.delay(ms: int) → None

Espera durante el número de milisegundos indicado.

pyb.udelay(us: int) → None

Espera durante el número de microsegundos indicado.

pyb.millis() → int

Devuelve el número de milisegundos transcurridos desde el último reinicio de la placa.

El resultado siempre es un smallint de MicroPython (número con signo de 31 bits), por lo que tras 2^30 milisegundos (unos 12,4 días) comenzará a devolver números negativos.

Tenga en cuenta que si se invoca pyb.stop(), el contador de hardware que da soporte a esta función se detendrá durante el estado de «suspensión». Esto afectará al resultado de pyb.elapsed_millis().

pyb.micros() → int

Devuelve el número de microsegundos transcurridos desde el último reinicio de la placa.

El resultado siempre es un smallint de MicroPython (número con signo de 31 bits), por lo que tras 2^30 microsegundos (unos 17,8 minutos) comenzará a devolver números negativos.

Tenga en cuenta que si se invoca pyb.stop(), el contador de hardware que da soporte a esta función se detendrá durante el estado de «suspensión». Esto afectará al resultado de pyb.elapsed_micros().

pyb.elapsed_millis(start: int) → int

Devuelve el número de milisegundos transcurridos desde start.

Esta función gestiona el desbordamiento del contador y siempre devuelve un número positivo. Esto significa que puede usarse para medir periodos de hasta unos 12,4 días.

Ejemplo:

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

pyb.elapsed_micros(start: int) → int

Devuelve el número de microsegundos transcurridos desde start.

Esta función gestiona el desbordamiento del contador y siempre devuelve un número positivo. Esto significa que puede usarse para medir periodos de hasta unos 17,8 minutos.

Ejemplo:

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

Funciones relacionadas con el reinicio

pyb.hard_reset() → None

Reinicia la OpenMV Cam de forma similar a pulsar el botón RESET externo.

pyb.bootloader() → None

Reinicia en el propio gestor de arranque (bootloader) USB DFU de OpenMV, listo para una actualización de firmware. Esta es la forma recomendada de invocar DFU desde el código en ejecución: no es necesario forzar ningún pin BOOT en el reinicio.

No disponible en la OpenMV Cam N6 (la capa de compatibilidad heredada pyb está deshabilitada en esa placa); utilice machine.bootloader() en su lugar.

pyb.fault_debug(value: bool) → None

Habilita o deshabilita la depuración de fallos graves (hard-fault). Un hard-fault se produce cuando hay un error fatal en el sistema subyacente, como un acceso de memoria no válido.

Si el argumento value es False, la placa se reiniciará automáticamente si se produce un hard-fault.

Si value es True, cuando la placa sufra un hard-fault imprimirá los registros y la traza de la pila, y luego parpadeará los LED indefinidamente.

El valor predeterminado es deshabilitado, es decir, reiniciar automáticamente.

Funciones relacionadas con las interrupciones

pyb.disable_irq() → bool

Deshabilita las solicitudes de interrupción. Devuelve el estado anterior de la IRQ: False/True para IRQ deshabilitadas/habilitadas respectivamente. Este valor de retorno puede pasarse a enable_irq para restaurar la IRQ a su estado original.

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

Habilita las solicitudes de interrupción. Si state es True (el valor predeterminado), las IRQ se habilitan. Si state es False, las IRQ se deshabilitan. El uso más habitual de esta función es pasarle el valor devuelto por disable_irq para salir de una sección crítica.

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

Si no se le pasan argumentos, devuelve una tupla con las frecuencias de reloj (sysclk, hclk, pclk1, pclk2) en hercios:

Campo	Significado
sysclk	Frecuencia de la CPU
hclk	Frecuencia del bus AHB, la memoria del núcleo y el DMA
pclk1	Frecuencia del bus APB1
pclk2	Frecuencia del bus APB2

Si se le pasan argumentos, la función establece la frecuencia de la CPU (y las frecuencias de bus si se proporcionan argumentos adicionales). Las frecuencias se expresan en hercios; se selecciona la mayor frecuencia admitida que no supere el valor indicado. El conjunto de frecuencias sysclk válidas y los valores máximos de hclk / pclk1 / pclk2 dependen del MCU; consulte el manual de referencia de STM32 correspondiente a la OpenMV Cam que esté utilizando. Las frecuencias de bus se derivan de sysclk mediante divisores que el controlador elige para ajustarse lo mejor posible a los valores solicitados.

Advertencia

Cambiar la frecuencia mientras USB está habilitado puede hacer que USB sea poco fiable. Cámbiela desde boot.py, antes de que se inicie el periférico USB, y no seleccione un valor de sysclk demasiado bajo para los requisitos de reloj USB del MCU.

Funciones relacionadas con la energía

pyb.wfi() → None

Espera a una interrupción interna o externa.

Ejecuta una instrucción wfi que reduce el consumo de energía del MCU hasta que se produce cualquier interrupción (interna o externa), momento en el que la ejecución continúa. Tenga en cuenta que la interrupción del system-tick se produce una vez por milisegundo (1000 Hz), por lo que esta función se bloqueará durante 1 ms como máximo.

pyb.stop() → None

Pone la OpenMV Cam en el estado de bajo consumo stop de STM32. La ejecución continúa desde este punto al despertar. Para despertar se requiere una interrupción externa o un evento del reloj en tiempo real; consulte pyb.RTC.wakeup() para configurar uno. El consumo de corriente exacto que puede alcanzarse depende de la placa y de qué periféricos se mantengan con reloj.

pyb.standby() → None

Pone la OpenMV Cam en el estado de suspensión profunda standby de STM32. Es el nivel de apagado de menor consumo; el dispositivo sale de él mediante un reinicio completo al despertar, por lo que la ejecución no se reanuda en el mismo punto. Para despertar se requiere un evento del reloj en tiempo real; consulte pyb.RTC.wakeup() para configurar uno. El consumo de corriente exacto que puede alcanzarse depende de la placa.

Funciones varias

pyb.have_cdc() → bool

Devuelve True si el USB está conectado como dispositivo serie, y False en caso contrario.

Nota

Esta función está obsoleta. Use pyb.USB_VCP().isconnected() en su lugar.

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

Toma una tupla de 4 elementos (o lista) y la envía al host USB (el PC) para señalar un evento de movimiento de ratón HID.

Nota

Esta función está obsoleta. Use pyb.USB_HID.send() en su lugar.

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

Imprime gran cantidad de información sobre la placa.

pyb.main(filename: str) → None

Establece el nombre del archivo del script principal que se ejecutará después de que finalice boot.py. Si no se llama a esta función, se ejecutará el archivo predeterminado main.py.

Solo tiene sentido llamar a esta función desde dentro de boot.py.

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

Nota

Esta función está obsoleta. Use vfs.mount() / vfs.umount() y un dispositivo de bloques derivado de vfs.AbstractBlockDev en su lugar.

Monta un dispositivo de bloques en mountpoint. device debe implementar el protocolo heredado de dispositivos de bloques de pyb (también obsoleto; consulte vfs.AbstractBlockDev para la interfaz moderna):

Método	Propósito
readblocks(self, blocknum, buf)	Copia buf bytes desde el dispositivo a partir del bloque blocknum. La longitud de buf es un múltiplo de 512.
writeblocks(self, blocknum, buf) (opcional)	Escribe buf en el dispositivo a partir del bloque blocknum. Si se omite, el dispositivo se monta en modo de solo lectura.
count(self)	Devuelve el número de bloques de 512 bytes del dispositivo.
sync(self) (opcional)	Vacía cualquier escritura en caché.

mountpoint es la ruta en la raíz del sistema de archivos donde se montará el dispositivo; debe comenzar con una barra inclinada. readonly fuerza un montaje de solo lectura. mkfs crea un nuevo sistema de archivos si no hay ninguno presente.

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

Obtiene o establece el objeto UART en el que se repite el REPL.

pyb.rng() → int

Devuelve un número aleatorio generado por hardware de 30 bits.

pyb.sync() → None

Sincroniza todos los sistemas de archivos.

pyb.unique_id() → bytes

Devuelve una cadena de 12 bytes (96 bits) que es el ID único del 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

Si se llama sin argumentos, devuelve el modo USB actual como una cadena.

Si se llama proporcionando modestr, intenta configurar el modo USB. Se entienden los siguientes valores de modestr:

modestr	Configura
None	Deshabilita el USB.
'VCP'	Solo VCP (Virtual COM Port).
'MSC'	Solo MSC (clase de almacenamiento masivo USB).
'VCP+MSC'	VCP y MSC.
'VCP+HID'	VCP y HID (dispositivo de interfaz humana).
'VCP+MSC+HID'	VCP, MSC y HID juntos. No compatible con todas las OpenMV Cam.

Por compatibilidad con versiones anteriores, 'CDC' se interpreta como 'VCP' (y de forma análoga 'CDC+MSC' y 'CDC+HID').

El parámetro port debe ser un entero (0, 1, …) y selecciona qué puerto USB usar si la placa admite varios puertos. Un valor de -1 usa el puerto predeterminado o seleccionado automáticamente.

Los parámetros vid y pid permiten especificar el VID (identificador de fabricante) y el PID (identificador de producto). Un valor de pid de -1 seleccionará un PID basado en el valor de modestr.

Si se habilita el modo MSC, el parámetro msc puede usarse para especificar una lista de LUN SCSI que se expondrán en la interfaz de almacenamiento masivo. Por ejemplo, msc=(pyb.Flash(), pyb.SDCard()).

Si se habilita el modo HID, también puede especificar los detalles HID pasando el parámetro de palabra clave hid. Toma una tupla de (subclase, protocolo, longitud máxima de paquete, intervalo de sondeo, descriptor de informe). De forma predeterminada establecerá valores apropiados para un ratón USB. También existe la constante pyb.hid_keyboard, que es una tupla apropiada para un teclado USB.

El parámetro high_speed, cuando se establece en True, habilita el modo USB HS si el hardware lo admite.

Constantes

Ambas constantes a continuación son tuplas de 5 elementos predefinidas con la forma

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

adecuadas para pasarse como argumento hid de usb_mode() para hacer que la OpenMV Cam aparezca ante el host como un dispositivo USB HID. subclass = 1 significa «interfaz de arranque» y protocol selecciona la clase de dispositivo de arranque (1 = teclado, 2 = ratón). El quinto elemento es un objeto bytes que contiene el descriptor de informe HID utilizado cuando el host enumera el dispositivo.

pyb.hid_mouse: tuple

Descriptor HID predefinido para un ratón de arranque de 3 botones con movimiento relativo en X/Y. La tupla es (1, 2, 4, 8, <mouse report descriptor>): subclase de arranque, protocolo de ratón, informes de entrada de 4 bytes (máscara de botones + X + Y + rueda), sondeado cada 8 ms. El descriptor de informe integrado es el que usa pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

Descriptor HID predefinido para un teclado de arranque USB. La tupla es (1, 1, 8, 8, <keyboard report descriptor>): subclase de arranque, protocolo de teclado, informes de entrada de 8 bytes (byte modificador, un byte reservado, seis códigos de tecla simultáneos), sondeado cada 8 ms. El descriptor de informe integrado coincide con la disposición estándar del teclado de arranque HID de 8 bytes, por lo que el informe enviado mediante USB_HID.send() debe ser un objeto bytes de la forma (modifiers, 0, key1, key2, key3, key4, key5, key6).

Clases

• class ADC – conversión analógica a digital
• class ADCAll – acceso a todos los canales ADC
• clase CAN – bus de comunicación de red de área de controladores (CAN)
• clase DAC – conversión de digital a analógico
• clase ExtInt – configura los pines de E/S para interrumpir ante eventos externos
• clase Flash – acceso al almacenamiento flash integrado
• clase I2C – un protocolo serie de dos hilos
• clase LED – LED integrado
• class Pin – control de pines de E/S
• class PinAF – funciones alternativas de pin
• class RTC – reloj de tiempo real
• class Servo – controlador de servo de aficionado de 3 hilos
• class SPI – un protocolo serie controlado por un controlador
• clase Timer – controla los temporizadores internos
• clase TimerChannel – configura un canal para un temporizador
• clase UART – bus de comunicación serie dúplex
• clase USB_HID – Dispositivo de Interfaz Humana USB (HID)
• clase USB_VCP – puerto de comunicación virtual USB