Configuração padrão

A configuração padrão define os fundamentos do dispositivo ESPHome e como você pode acessá-lo sem fio

Sempre que você cria ou adota um novo dispositivo no ESPHome, um arquivo de configuração padrão é automaticamente atribuído a ele e aparece no ESPHome Desktop.

Esta configuração define cada detalhe do seu dispositivo. O conteúdo padrão inicial foca nos fundamentos do dispositivo, e você pode adicionar mais detalhes, por exemplo, para descrever sua configuração de hardware e adicionar funcionalidade especial.

Visão geral

Cada dispositivo é representado por seu próprio arquivo de configuração e aparece como um bloco no ESPHome Dashboard.

O nome do arquivo de configuração é o nome do seu dispositivo, e o tipo de arquivo é yaml. Clique em EDIT para visualizar seu conteúdo.

A configuração padrão cuida dos fundamentos necessários para trabalhar com o dispositivo, como definir um nome de dispositivo, atribuir um nome de host mDNS, definir o tipo de microcontrolador, fornecer detalhes de conexão como SSID e senha do WiFi e assim por diante.

Aqui está um exemplo de configuração de um dispositivo ESPHome recém-criado:

esphome:
  name: co2-sensor-1
  friendly_name: CO2 Sensor #1

esp32:
  board: esp32dev
  framework:
    type: arduino

# Enable logging
logger:

# Enable Home Assistant API
api:
  encryption:
    key: "..."

ota:
  - platform: esphome
    password: "..."

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

  # Enable fallback hotspot (captive portal) in case wifi connection fails
  ap:
    ssid: "Push-Button Fallback Hotspot"
    password: "..."

captive_portal:

Normalmente, você não precisa alterar essas entradas, a menos que realmente queira alterar esses fundamentos.

Alterar entradas padrão pode tornar seu dispositivo inacessível quando você não sabe o que está fazendo. Por exemplo, alterar o nome: para atribuir um novo nome de host ao seu dispositivo falha miseravelmente: o ESPHome usaria o novo nome para tentar contatar seu dispositivo sem fio para aplicar a nova configuração. Como o dispositivo ainda não foi renomeado, ele ainda usa seu nome antigo e se torna inacessível. Se você realmente quiser renomear o nome do host do dispositivo, em seu bloco, clique no menu de três pontos e escolha Renomear nome do host.

Todos os itens na configuração descrevem sua finalidade quando você passa o ponteiro do mouse sobre eles: dicas de ferramentas resumem a finalidade e links o guiam para as páginas de documentação.

Entradas de configuração padrão

Aqui está uma rápida visão geral das entradas padrão na sua configuração padrão:

  • esphome:
    • name: nome da rede mDNS atribuído ao dispositivo. É derivado do nome do seu projeto. Espaços e caracteres especiais são substituídos.
    • nome amigável: nome em texto simples que aparece no painel do ESPHome.
  • esp32: (este pode ser um item diferente quando você tiver selecionado um microcontrolador diferente)
    • placa: o tipo de placa do microcontrolador. esp32dev é a configuração padrão para placas ESP32 genéricas.
    • framework: o tipo de framework de programação a ser usado. Por padrão, o ESPHome usa Arduino, mas você também pode usar ESP-IDF (o próprio ambiente de programação dos fornecedores de ESP)
  • logger: por padrão, todas as mensagens com severidade DEBUG ou maior, são registradas pela porta serial. Você pode ajustar essas configurações, ou seja, para um registro mais detalhado.
  • api: especifica uma chave de criptografia que é necessária sempre que você quiser se comunicar sem fio com o microcontrolador por meio da API ESPHome. Essa chave é gerada e armazenada automaticamente para você. Ela deve corresponder à chave dentro do firmware que foi carregada para seu microcontrolador.
  • ota: define a senha secreta para atualizações de firmware over-the-air. Esta senha deve corresponder à senha definida no firmware carregado. O ESPHome pode então carregar futuras atualizações de firmware convenientemente via WiFi. O formato para esta entrada mudou recentemente.
  • wifi: define os parâmetros de acesso para seu WiFi doméstico. O SSID e a senha reais são armazenados globalmente no secret store.
    • ap:** se o seu microcontrolador não conseguir se conectar ao seu *WiFi doméstico por qualquer motivo, o firmware ESPHome abre automaticamente seu próprio ponto de acesso WiFi (hotspot).
  • captive_portal: quando este componente faz parte da sua configuração, ele instrui seu microcontrolador a fornecer um portal da web que você pode usar para alterar as configurações de WiFi ou carregar manualmente um novo firmware. O portal cativo é ativado quando o WiFi regular não pode ser alcançado e pode ser acessado por meio do hotspot definido em ap:. Não há definições de configuração para este item.

Verificando a configuração

De vez em quando, as atualizações do ESPHome introduzem mudanças drásticas que podem incluir mudanças nas regras de formatação. Uma dessas mudanças drásticas foi introduzida recentemente (junho de 2024). Vamos dar uma olhada nessa mudança e como identificá-la (e corrigi-la).

Anteriormente, OTA era definido desta forma:

ota:
  password: "..."

A partir do ESPHome 2024.6.0, esta entrada deve ficar assim:

ota:
  - platform: esphome
    password: "..."

Validar uma configuração antiga revelaria um problema formal . Você precisaria então editar a configuração, identificar o problema formal e corrigi-lo.

No caso dessa alteração drástica, adicionar a linha - platform: esphome à entrada OTA corrige o problema e garante que você possa compilar e carregar sua configuração novamente com as versões 2024.6.0 e superiores do ESPHome.

Deixe um comentário