pyb — funções relacionadas à placa

Aviso

O módulo pyb está obsoleto. Use o módulo multiplataforma machine para código novo – ele fornece a mesma funcionalidade em qualquer OpenMV Cam, independentemente da família de MCU, enquanto o pyb existe apenas nas placas baseadas em STM32. O pyb é mantido por compatibilidade com scripts mais antigos, nenhum novo recurso será adicionado a ele e ele pode ser removido em uma versão futura.

O módulo pyb contém funções específicas do STM32 relacionadas à placa.

Funções relacionadas a tempo

pyb.delay(ms: int) → None

Aguarda pelo número de milissegundos especificado.

pyb.udelay(us: int) → None

Aguarda pelo número de microssegundos especificado.

pyb.millis() → int

Retorna o número de milissegundos desde a última reinicialização da placa.

O resultado é sempre um smallint do MicroPython (número de 31 bits com sinal), então após 2^30 milissegundos (cerca de 12,4 dias) ele começará a retornar números negativos.

Observe que, se pyb.stop() for emitido, o contador de hardware que dá suporte a esta função ficará pausado durante o estado de “sleeping”. Isso afetará o resultado de pyb.elapsed_millis().

pyb.micros() → int

Retorna o número de microssegundos desde a última reinicialização da placa.

O resultado é sempre um smallint do MicroPython (número de 31 bits com sinal), então após 2^30 microssegundos (cerca de 17,8 minutos) ele começará a retornar números negativos.

Observe que, se pyb.stop() for emitido, o contador de hardware que dá suporte a esta função ficará pausado durante o estado de “sleeping”. Isso afetará o resultado de pyb.elapsed_micros().

pyb.elapsed_millis(start: int) → int

Retorna o número de milissegundos que se passaram desde start.

Esta função lida com o estouro do contador e sempre retorna um número positivo. Isso significa que ela pode ser usada para medir períodos de até cerca de 12,4 dias.

Exemplo:

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

pyb.elapsed_micros(start: int) → int

Retorna o número de microssegundos que se passaram desde start.

Esta função lida com o estouro do contador e sempre retorna um número positivo. Isso significa que ela pode ser usada para medir períodos de até cerca de 17,8 minutos.

Exemplo:

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

Funções relacionadas a reinicialização

pyb.hard_reset() → None

Reinicializa o OpenMV Cam de forma semelhante a pressionar o botão externo RESET.

pyb.bootloader() → None

Reinicializa no próprio bootloader USB DFU do OpenMV, pronto para uma atualização de firmware. Esta é a forma recomendada de invocar o DFU a partir de código em execução – nenhum pino BOOT precisa ser ativado durante a reinicialização.

Não disponível no OpenMV Cam N6 (a camada de compatibilidade legada pyb está desabilitada nessa placa); use machine.bootloader() em vez disso.

pyb.fault_debug(value: bool) → None

Habilita ou desabilita a depuração de hard-fault. Um hard-fault ocorre quando há um erro fatal no sistema subjacente, como um acesso inválido à memória.

Se o argumento value for False, então a placa será reinicializada automaticamente caso ocorra um hard fault.

Se value for True, então, quando a placa tiver um hard fault, ela imprimirá os registradores e o rastreamento da pilha e, em seguida, alternará os LEDs indefinidamente.

O valor padrão é desabilitado, ou seja, reinicializar automaticamente.

Funções relacionadas a interrupções

pyb.disable_irq() → bool

Desabilita as requisições de interrupção. Retorna o estado anterior da IRQ: False/True para IRQs desabilitadas/habilitadas, respectivamente. Esse valor de retorno pode ser passado para enable_irq para restaurar a IRQ ao seu estado original.

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

Habilita as requisições de interrupção. Se state for True (o valor padrão), então as IRQs são habilitadas. Se state for False, então as IRQs são desabilitadas. O uso mais comum desta função é passar a ela o valor retornado por disable_irq para sair de uma seção 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

Se chamada sem argumentos, retorna uma tupla com as frequências de clock (sysclk, hclk, pclk1, pclk2) em hertz:

Campo	Significado
sysclk	Frequência da CPU
hclk	Frequência do barramento AHB, da memória do núcleo e do DMA
pclk1	Frequência do barramento APB1
pclk2	Frequência do barramento APB2

Se chamada com quaisquer argumentos, então a função define a frequência da CPU (e as frequências dos barramentos, se argumentos adicionais forem fornecidos). As frequências são em hertz; a maior frequência suportada que não seja maior que o valor informado é selecionada. O conjunto de frequências sysclk válidas e os valores máximos de hclk / pclk1 / pclk2 dependem do MCU – consulte o manual de referência do STM32 correspondente ao OpenMV Cam em uso. As frequências dos barramentos são derivadas de sysclk por meio de prescalers que o driver escolhe para corresponder da melhor forma aos valores solicitados.

Aviso

Alterar a frequência enquanto o USB está habilitado pode tornar o USB instável. Altere-a a partir de boot.py, antes de o periférico USB ser iniciado, e não selecione um valor de sysclk baixo demais para os requisitos de clock do USB do MCU.

Funções relacionadas a energia

pyb.wfi() → None

Aguarda por uma interrupção interna ou externa.

Isso executa uma instrução wfi que reduz o consumo de energia do MCU até que qualquer interrupção ocorra (seja interna ou externa), ponto no qual a execução continua. Observe que a interrupção do system-tick ocorre uma vez a cada milissegundo (1000Hz), então esta função bloqueará por no máximo 1ms.

pyb.stop() → None

Coloca o OpenMV Cam no estado de baixo consumo stop do STM32. A execução continua a partir deste ponto ao despertar. O despertar requer uma interrupção externa ou um evento do relógio de tempo real; consulte pyb.RTC.wakeup() para configurar um. O consumo de corrente exato alcançável depende da placa e de quais periféricos permanecem com clock ativo.

pyb.standby() → None

Coloca o OpenMV Cam no estado de sono profundo standby do STM32. Este é o nível mais baixo de desligamento; o dispositivo sai dele por meio de um hard reset ao despertar, então a execução não é retomada no mesmo ponto. O despertar requer um evento do relógio de tempo real; consulte pyb.RTC.wakeup() para configurar um. O consumo de corrente exato alcançável depende da placa.

Funções diversas

pyb.have_cdc() → bool

Retorna True se o USB estiver conectado como um dispositivo serial, False caso contrário.

Nota

Esta função está obsoleta. Use pyb.USB_VCP().isconnected() em vez disso.

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

Recebe uma tupla de 4 elementos (ou lista) e a envia ao host USB (o PC) para sinalizar um evento de movimento de mouse HID.

Nota

Esta função está obsoleta. Use pyb.USB_HID.send() em vez disso.

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

Imprime muitas informações sobre a placa.

pyb.main(filename: str) → None

Define o nome do arquivo do script principal a ser executado após o boot.py terminar. Se esta função não for chamada, então o arquivo padrão main.py será executado.

Só faz sentido chamar esta função de dentro do boot.py.

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

Nota

Esta função está obsoleta. Use vfs.mount() / vfs.umount() e um dispositivo de bloco derivado de vfs.AbstractBlockDev em vez disso.

Monta um dispositivo de bloco sob mountpoint. O device deve implementar o protocolo legado de dispositivo de bloco do pyb (também obsoleto – consulte vfs.AbstractBlockDev para a interface moderna):

Método	Finalidade
readblocks(self, blocknum, buf)	Copia o equivalente a buf em bytes do dispositivo, começando no bloco blocknum. O comprimento de buf é um múltiplo de 512.
writeblocks(self, blocknum, buf) (opcional)	Escreve buf no dispositivo, começando no bloco blocknum. Se omitido, o dispositivo é montado como somente leitura.
count(self)	Retorna o número de blocos de 512 bytes no dispositivo.
sync(self) (opcional)	Descarrega quaisquer escritas em cache.

mountpoint é o caminho na raiz do sistema de arquivos onde o dispositivo será montado; ele deve começar com uma barra. readonly força uma montagem somente leitura. mkfs cria um novo sistema de arquivos se nenhum estiver presente.

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

Obtém ou define o objeto UART no qual o REPL é repetido.

pyb.rng() → int

Retorna um número aleatório gerado por hardware de 30 bits.

pyb.sync() → None

Sincroniza todos os sistemas de arquivos.

pyb.unique_id() → bytes

Retorna uma string de 12 bytes (96 bits), que é o ID único do 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

Se chamada sem argumentos, retorna o modo USB atual como uma string.

Se chamada com modestr fornecido, tenta configurar o modo USB. Os seguintes valores de modestr são reconhecidos:

modestr	Configura
None	Desabilita o USB.
'VCP'	Apenas VCP (Virtual COM Port).
'MSC'	Apenas MSC (USB mass storage class).
'VCP+MSC'	VCP e MSC.
'VCP+HID'	VCP e HID (human interface device).
'VCP+MSC+HID'	VCP, MSC e HID juntos. Não suportado em todos os OpenMV Cam.

Por compatibilidade com versões anteriores, 'CDC' é interpretado como 'VCP' (e de forma semelhante para 'CDC+MSC' e 'CDC+HID').

O parâmetro port deve ser um inteiro (0, 1, …) e seleciona qual porta USB usar se a placa suportar múltiplas portas. Um valor de -1 usa a porta padrão ou selecionada automaticamente.

Os parâmetros vid e pid permitem especificar o VID (vendor id) e o PID (product id). Um valor de pid igual a -1 selecionará um PID com base no valor de modestr.

Ao habilitar o modo MSC, o parâmetro msc pode ser usado para especificar uma lista de LUNs SCSI a serem expostos na interface de armazenamento em massa. Por exemplo msc=(pyb.Flash(), pyb.SDCard()).

Ao habilitar o modo HID, você também pode especificar os detalhes do HID passando o parâmetro nomeado hid. Ele recebe uma tupla de (subclasse, protocolo, comprimento máximo do pacote, intervalo de polling, descritor de relatório). Por padrão, ele definirá valores apropriados para um mouse USB. Há também uma constante pyb.hid_keyboard, que é uma tupla apropriada para um teclado USB.

O parâmetro high_speed, quando definido como True, habilita o modo USB HS se ele for suportado pelo hardware.

Constantes

Ambas as constantes abaixo são tuplas de 5 elementos prontas para uso, na forma

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

adequadas para serem passadas como o argumento hid de usb_mode() para fazer o OpenMV Cam aparecer ao host como um dispositivo USB HID. subclass = 1 significa “boot interface” e protocol seleciona a classe do dispositivo de boot (1 = teclado, 2 = mouse). O quinto elemento é um objeto bytes contendo o descritor de relatório HID usado quando o host enumera o dispositivo.

pyb.hid_mouse: tuple

Descritor HID pré-construído para um mouse de boot de 3 botões com movimento relativo em X/Y. A tupla é (1, 2, 4, 8, <mouse report descriptor>): subclasse de boot, protocolo de mouse, relatórios de entrada de 4 bytes (máscara de botões + X + Y + roda), com polling a cada 8 ms. O descritor de relatório embutido é o usado por pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

Descritor HID pré-construído para um teclado de boot USB. A tupla é (1, 1, 8, 8, <keyboard report descriptor>): subclasse de boot, protocolo de teclado, relatórios de entrada de 8 bytes (byte de modificadores, um byte reservado, seis códigos de tecla simultâneos), com polling a cada 8 ms. O descritor de relatório embutido corresponde ao layout padrão de teclado de boot HID de 8 bytes, então o relatório enviado via USB_HID.send() deve ser um bytes na forma (modifiers, 0, key1, key2, key3, key4, key5, key6).

Classes

• classe ADC – conversão analógico-digital
• classe ADCAll – acesso a todos os canais ADC
• classe CAN – barramento de comunicação controller area network
• classe DAC – conversão digital para analógico
• classe ExtInt – configura pinos de E/S para interromper em eventos externos
• classe Flash – acesso ao armazenamento flash interno
• classe I2C – um protocolo serial de dois fios
• classe LED – LED embarcado
• class Pin – controle de pinos de I/O
• class PinAF – funções alternativas de pino
• class RTC – relógio de tempo real
• class Servo – driver de servo de hobby de 3 fios
• class SPI – um protocolo serial acionado por um controlador
• classe Timer – controla os timers internos
• classe TimerChannel – configura um canal para um timer
• classe UART – barramento de comunicação serial duplex
• classe USB_HID – Dispositivo de Interface Humana (HID) USB
• classe USB_VCP – porta de comunicação virtual USB