pyb — funções relacionadas com a placa

Aviso

O módulo pyb está obsoleto. Utilize o módulo portátil machine para novo código – este oferece a mesma funcionalidade em todas as OpenMV Cam independentemente da família de MCU, enquanto que pyb existe apenas nas placas baseadas em STM32. O pyb é mantido por compatibilidade retroativa com scripts mais antigos, não serão adicionadas novas funcionalidades e poderá ser removido numa versão futura.

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

Funções relacionadas com o tempo

pyb.delay(ms: int) → None

Aguarda o número de milissegundos indicado.

pyb.udelay(us: int) → None

Aguarda o número de microssegundos indicado.

pyb.millis() → int

Devolve o número de milissegundos desde o último reset da placa.

O resultado é sempre um smallint do MicroPython (número assinado de 31 bits), por isso após 2^30 milissegundos (cerca de 12,4 dias) começará a devolver números negativos.

Note que se pyb.stop() for invocado, o contador de hardware que suporta esta função ficará em pausa durante o estado de «suspensão». Isto afetará o resultado de pyb.elapsed_millis().

pyb.micros() → int

Devolve o número de microssegundos desde o último reset da placa.

O resultado é sempre um smallint do MicroPython (número assinado de 31 bits), por isso após 2^30 microssegundos (cerca de 17,8 minutos) começará a devolver números negativos.

Note que se pyb.stop() for invocado, o contador de hardware que suporta esta função ficará em pausa durante o estado de «suspensão». Isto afetará o resultado de pyb.elapsed_micros().

pyb.elapsed_millis(start: int) → int

Devolve o número de milissegundos decorridos desde start.

Esta função trata do transbordo do contador e devolve sempre um número positivo. Isto significa que pode ser utilizada 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

Devolve o número de microssegundos decorridos desde start.

Esta função trata do transbordo do contador e devolve sempre um número positivo. Isto significa que pode ser utilizada 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 com o reset

pyb.hard_reset() → None

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

pyb.bootloader() → None

Reinicia para o bootloader USB DFU da OpenMV, pronto para uma atualização de firmware. Esta é a forma recomendada de invocar DFU a partir de código em execução – não é necessário afirmar nenhum pino BOOT no reset.

Não disponível na OpenMV Cam N6 (a camada de compatibilidade legada pyb está desativada nessa placa); utilize machine.bootloader() em alternativa.

pyb.fault_debug(value: bool) → None

Ativa ou desativa a depuração de falhas graves. Uma falha grave ocorre quando há um erro fatal no sistema subjacente, como um acesso a memória inválido.

Se o argumento value for False, a placa reiniciará automaticamente em caso de falha grave.

Se value for True, quando a placa tiver uma falha grave, imprimirá os registos e o rastreio da pilha e, em seguida, ciclará os LEDs indefinidamente.

O valor predefinido é desativado, ou seja, reiniciar automaticamente.

Funções relacionadas com interrupções

pyb.disable_irq() → bool

Desativa os pedidos de interrupção. Devolve o estado IRQ anterior: False/True para IRQs desativados/ativados, respetivamente. Este valor de retorno pode ser passado a enable_irq para restaurar o IRQ ao seu estado original.

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

Ativa os pedidos de interrupção. Se state for True (valor predefinido), os IRQs são ativados. Se state for False, os IRQs são desativados. A utilização mais comum desta função é passar-lhe o valor devolvido por disable_irq para sair de uma secçã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, devolve um tuplo de frequências de relógio (sysclk, hclk, pclk1, pclk2) em hertz:

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

Se chamada com algum argumento, a função define a frequência da CPU (e as frequências dos barramentos, se forem fornecidos argumentos adicionais). As frequências são em hertz; é selecionada a maior frequência suportada que não exceda o valor fornecido. 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 STM32 relevante para a OpenMV Cam em uso. As frequências dos barramentos são derivadas de sysclk através de prescalers que o controlador escolhe para melhor corresponder aos valores solicitados.

Aviso

Alterar a frequência enquanto o USB está ativo 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 demasiado baixo para os requisitos de relógio USB do MCU.

Funções relacionadas com energia

pyb.wfi() → None

Aguarda por uma interrupção interna ou externa.

Executa uma instrução wfi que reduz o consumo de energia do MCU até ocorrer qualquer interrupção (interna ou externa), momento a partir do qual a execução continua. Note que a interrupção do temporizador do sistema ocorre uma vez por milissegundo (1000 Hz), pelo que esta função bloqueará no máximo 1 ms.

pyb.stop() → None

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

pyb.standby() → None

Coloca a OpenMV Cam no estado de suspensão profunda standby do STM32. Este é o nível de desligamento de menor consumo; o dispositivo sai através de um reset completo ao acordar, pelo que a execução não retoma no mesmo ponto. O despertar requer um evento do relógio em 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

Devolve True se o USB estiver ligado como dispositivo série, False caso contrário.

Nota

Esta função está obsoleta. Utilize pyb.USB_VCP().isconnected() em alternativa.

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

Recebe um tuplo de 4 elementos (ou lista) e envia-o ao host USB (o PC) para sinalizar um evento de movimento do rato HID.

Nota

Esta função está obsoleta. Utilize pyb.USB_HID.send() em alternativa.

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

Imprime muita informação sobre a placa.

pyb.main(filename: str) → None

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

Só faz sentido chamar esta função a partir de boot.py.

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

Nota

Esta função está obsoleta. Utilize vfs.mount() / vfs.umount() e um dispositivo de blocos derivado de vfs.AbstractBlockDev em alternativa.

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

Método	Objetivo
readblocks(self, blocknum, buf)	Copia buf bytes do dispositivo a partir do bloco blocknum. O comprimento de buf é um múltiplo de 512.
writeblocks(self, blocknum, buf) (opcional)	Escreve buf no dispositivo a partir do bloco blocknum. Se omitido, o dispositivo é montado em modo de apenas leitura.
count(self)	Devolve o número de blocos de 512 bytes no dispositivo.
sync(self) (opcional)	Liberta quaisquer escritas em cache.

mountpoint é o caminho na raiz do sistema de ficheiros onde o dispositivo será montado; deve começar com uma barra diagonal. readonly força uma montagem em modo de apenas leitura. mkfs cria um novo sistema de ficheiros se não existir nenhum.

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

Obtém ou define o objeto UART onde o REPL é repetido.

pyb.rng() → int

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

pyb.sync() → None

Sincroniza todos os sistemas de ficheiros.

pyb.unique_id() → bytes

Devolve 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, devolve 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	Desativa o USB.
'VCP'	Apenas VCP (Porta COM Virtual).
'MSC'	Apenas MSC (classe de armazenamento em massa USB).
'VCP+MSC'	VCP e MSC.
'VCP+HID'	VCP e HID (dispositivo de interface humana).
'VCP+MSC+HID'	VCP, MSC e HID em conjunto. Não suportado em todas as OpenMV Cam.

Por compatibilidade retroativa, 'CDC' é interpretado como significando '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 utilizar se a placa suportar múltiplas portas. Um valor de -1 utiliza a porta predefinida ou selecionada automaticamente.

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

Se ativar o modo MSC, o parâmetro msc pode ser utilizado para especificar uma lista de LUNs SCSI a expor na interface de armazenamento em massa. Por exemplo msc=(pyb.Flash(), pyb.SDCard()).

Se ativar o modo HID, pode também especificar os detalhes HID passando o parâmetro de palavra-chave hid. Recebe um tuplo de (subclasse, protocolo, comprimento máximo de pacote, intervalo de polling, descritor de relatório). Por predefinição, definirá os valores apropriados para um rato USB. Existe também uma constante pyb.hid_keyboard, que é um tuplo adequado para um teclado USB.

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

Constantes

Ambas as constantes abaixo são tuplos de 5 elementos prontos a usar na forma

(subclass, protocol, max_packet_size, polling_interval_ms, report_descriptor)

adequados para serem passados como argumento hid de usb_mode() para fazer a OpenMV Cam aparecer ao host como um dispositivo USB HID. subclass = 1 significa «interface de arranque» e protocol seleciona a classe de dispositivo de arranque (1 = teclado, 2 = rato). O quinto elemento é um objeto bytes com o descritor de relatório HID utilizado quando o host enumera o dispositivo.

pyb.hid_mouse: tuple

Descritor HID pré-construído para um rato de arranque de 3 botões com movimento relativo X/Y. O tuplo é (1, 2, 4, 8, <mouse report descriptor>): subclasse de arranque, protocolo de rato, 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 integrado é o utilizado por pyb.USB_HID().send((buttons, dx, dy, wheel)).

pyb.hid_keyboard: tuple

Descritor HID pré-construído para um teclado USB de arranque. O tuplo é (1, 1, 8, 8, <keyboard report descriptor>): subclasse de arranque, protocolo de teclado, relatórios de entrada de 8 bytes (byte modificador, um byte reservado, seis códigos de teclas simultâneos), com polling a cada 8 ms. O descritor de relatório integrado corresponde ao esquema padrão de teclado HID de arranque de 8 bytes, pelo que o relatório enviado via USB_HID.send() deve ser um bytes da 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
• class CAN – barramento de comunicação da rede de área de controlador
• class DAC – conversão digital para analógico
• class ExtInt – configurar pinos de E/S para interrupção em eventos externos
• class Flash – acesso ao armazenamento flash integrado
• class I2C – protocolo série de dois fios
• class LED – LED integrado
• class Pin – controlo de pinos de E/S
• class PinAF – funções alternativas de pinos
• class RTC – relógio em tempo real
• class Servo – driver de servo de modelo com 3 fios
• class SPI – protocolo série controlado por controlador
• classe Timer – controlar temporizadores internos
• classe TimerChannel – configurar um canal para um temporizador
• classe UART – barramento de comunicação série duplex
• classe USB_HID – Dispositivo de Interface Humana USB (HID)
• classe USB_VCP – porta de comunicação virtual USB