中文版
ESP-IDF é a estrutura de desenvolvimento para SoCs Espressif com suporte em Windows, Linux e macOS.
Leia a política de suporte e a documentação para obter mais informações sobre as versões do ESP-IDF.
Consulte os Avisos de Fim de Vida para obter informações sobre lançamentos ESP-IDF com suporte descontinuado.
A tabela a seguir mostra o suporte ESP-IDF de SoCs Espressif, onde e denotam o status de visualização e suporte, respectivamente. O suporte de pré-visualização geralmente é limitado no tempo e destinado a versões beta de chips. Use uma versão ESP-IDF onde o SoC desejado já seja compatível.
Chip | v5.0 | v5.1 | v5.2 | v5.3 | v5.4 | |
---|---|---|---|---|---|---|
ESP32 | ||||||
ESP32-S2 | ||||||
ESP32-C3 | ||||||
ESP32-S3 | Anúncio | |||||
ESP32-C2 | Anúncio | |||||
ESP32-C6 | Anúncio | |||||
ESP32-H2 | Anúncio | |||||
ESP32-P4 | Anúncio | |||||
ESP32-C5 | Anúncio | |||||
ESP32-C61 | Anúncio |
Existem variantes de revisões para uma série de chips. Consulte Compatibilidade entre versões e revisões ESP-IDF de SoCs Espressif para obter detalhes sobre a compatibilidade entre ESP-IDF e revisões de chip.
Os SoCs Espressif lançados antes de 2016 (ESP8266 e ESP8285) são suportados pelo RTOS SDK.
Consulte https://idf.espressif.com/ para obter links com instruções detalhadas sobre como configurar o ESP-IDF dependendo do chip que você usa.
Nota: Cada série SoC e cada versão ESP-IDF possui sua própria documentação. Consulte a seção Versões para saber como encontrar a documentação e como verificar a versão específica do ESP-IDF.
ESP-IDF usa localizações relativas como URLs de seus submódulos (.gitmodules). Então, eles vinculam ao GitHub. Se o ESP-IDF for bifurcado para um repositório Git que não está no GitHub, você precisará executar o script tools/set-submodules-to-github.sh após o git clone.
O script define URLs absolutos para todos os submódulos, permitindo que git submodule update --init --recursive
seja concluído. Se estiver clonando ESP-IDF do GitHub, esta etapa não será necessária.
Assim como o projeto esp-idf-template mencionado em Primeiros passos, o ESP-IDF vem com alguns projetos de exemplo no diretório de exemplos.
Depois de encontrar o projeto com o qual deseja trabalhar, mude para seu diretório e você poderá configurá-lo e construí-lo.
Para iniciar seu próprio projeto com base em um exemplo, copie o diretório do projeto de exemplo fora do diretório ESP-IDF.
Consulte os links do guia de primeiros passos acima para obter um guia de configuração detalhado. Esta é uma referência rápida para comandos comuns ao trabalhar com projetos ESP-IDF:
(Consulte o guia de primeiros passos listado acima para obter uma lista completa das etapas necessárias com mais detalhes.)
Instale as dependências de compilação do host mencionadas no guia de primeiros passos.
Execute o script de instalação para configurar o ambiente de construção. As opções incluem install.bat
ou install.ps1
para Windows e install.sh
ou install.fish
para shells Unix.
Execute o script de exportação no Windows ( export.bat
) ou crie-o no Unix ( source export.sh
) em todos os ambientes shell antes de usar o ESP-IDF.
idf.py set-target <chip_name>
define o destino do projeto como <chip_name>
. Execute idf.py set-target
sem argumentos para ver uma lista de destinos suportados.
idf.py menuconfig
abre um menu de configuração baseado em texto onde você pode configurar o projeto.
idf.py build
... irá compilar o aplicativo, o bootloader e gerar uma tabela de partição com base na configuração.
Quando a compilação terminar, uma linha de comando será impressa para usar esptool.py para atualizar o chip. No entanto, você também pode fazer isso automaticamente executando:
idf.py -p PORT flash
Substitua PORT pelo nome da sua porta serial (como COM3
no Windows, /dev/ttyUSB0
no Linux ou /dev/cu.usbserial-X
no MacOS. Se a opção -p
for omitida, idf.py flash
tentará atualize a primeira porta serial disponível.
Isso irá atualizar todo o projeto (aplicativo, bootloader e tabela de partição) para um novo chip. As configurações para flash da porta serial podem ser definidas com idf.py menuconfig
.
Você não precisa executar idf.py build
antes de executar idf.py flash
, idf.py flash
reconstruirá automaticamente qualquer coisa que precise dele.
O destino idf.py monitor
usa a ferramenta esp-idf-monitor para exibir a saída serial dos SoCs Espressif. esp-idf-monitor também possui uma variedade de recursos para decodificar a saída de falha e interagir com o dispositivo. Verifique a página de documentação para obter detalhes.
Saia do monitor digitando Ctrl-].
Para criar, atualizar e monitorar a saída em uma passagem, você pode executar:
idf.py flash monitor
Após o flash inicial, você pode querer apenas construir e atualizar apenas seu aplicativo, não o gerenciador de inicialização e a tabela de partições:
idf.py app
- crie apenas o aplicativo.
idf.py app-flash
- atualiza apenas o aplicativo.
idf.py app-flash
reconstruirá automaticamente o aplicativo se algum arquivo de origem for alterado.
(No desenvolvimento normal, não há desvantagem em atualizar novamente o gerenciador de inicialização e a tabela de partições todas as vezes, se eles não tiverem sido alterados.)
O destino idf.py flash
não apaga todo o conteúdo do flash. No entanto, às vezes é útil redefinir o dispositivo para um estado totalmente apagado, principalmente ao fazer alterações na tabela de partições ou atualizações de aplicativos OTA. Para apagar todo o flash, execute idf.py erase-flash
.
Isso pode ser combinado com outros alvos, ou seja, idf.py -p PORT erase-flash flash
apagará tudo e, em seguida, atualizará novamente o novo aplicativo, carregador de inicialização e tabela de partição.
Documentação para a versão mais recente: https://docs.espressif.com/projects/esp-idf/. Esta documentação foi construída a partir do diretório docs deste repositório.
Guia para iniciantes sobre os principais conceitos e recursos do ESP-IDF
O fórum esp32.com é um lugar para fazer perguntas e encontrar recursos da comunidade.
Verifique a seção Problemas no github se você encontrar um bug ou tiver uma solicitação de recurso. Verifique os problemas existentes antes de abrir um novo.
Se você estiver interessado em contribuir para o ESP-IDF, consulte o Guia de Contribuições.