SenseCAP Indicator - Desenvolvimento de Aplicativo para Home Assistant

Introdução

Adquira Agora 🖱️

Liberte todo o potencial da sua casa inteligente integrando o SenseCAP Indicator ao Home Assistant. Essa combinação poderosa permite monitorar e controlar seu ambiente com uma facilidade sem precedentes.

Aprenda como integrar perfeitamente seu SenseCAP Indicator ao Home Assistant usando MQTT neste guia abrangente.

Antes de começarmos, vamos explorar suas opções para configurar o Home Assistant. O Home Assistant pode ser facilmente instalado em duas opções de hardware dedicadas:

nota

Com certeza, você tem várias opções para instalar o HA seguindo Installation - Home Assistant (home-assistant.io).

Home Assistant Green

O acessível Home Assistant Green é a maneira mais fácil de começar a usar o Home Assistant. Ele é plug-and-play e vem com o Home Assistant já instalado.

Home Assistant Yellow

O Home Assistant Yellow vem pré-montado em um gabinete personalizado com um Raspberry Pi Compute Module 4 (CM4) e um dissipador de calor customizado para operação silenciosa, sem ventoinha. O CM4 é uma versão sem wireless e possui 2 GB de RAM e 16 GB de armazenamento eMMC. Vem com o Home Assistant pré-instalado.

Para maximizar os recursos do Home Assistant, recomendamos usar Home Assistant OS ou Home Assistant Supervised. Ambas as opções oferecem recursos avançados e maior possibilidade de personalização, permitindo que você adapte sua experiência de casa inteligente exatamente às suas necessidades.

Agora, vamos começar o processo de integração. Siga estas três etapas principais para fazer seu SenseCAP Indicator funcionar com o Home Assistant:

1. Instalar o Home Assistant OS
   1. Instalar Add-ons
   2. Configurar a Integração MQTT
2. Compilar e Gravar o Firmware
3. Adicionar Dispositivos MQTT
4. Configurar um Dashboard

Pré-requisitos

Antes de começarmos, certifique-se de ter lido o Guia do Usuário da SenseCAP Indicator Board para se familiarizar com as informações de hardware e software.

Instalar Home Assistant OS

Home Assistant é uma poderosa plataforma de automação residencial de código aberto que se concentra em privacidade e controle local. Ela oferece uma estrutura personalizável e flexível para gerenciar e automatizar todos os dispositivos da sua casa a partir de uma única plataforma unificada.

Com o Home Assistant Yellow você pode seguir as instruções fornecidas aqui. Além disso, para executar em qualquer tipo de Raspberry Pi ou em um servidor local, você pode seguir este tutorial passo a passo.

Depois de instalado, acessar esta página significa que você pode ir para o próximo passo.

Não sabe como fazer o onboarding do Home Assistant?

Depois de instalar o Home Assistant, consulte Onboarding Home Assistant - Home Assistant para mais detalhes.

Passo 1: Instalar Add-ons

Recurso de Add-ons necessário

O Home Assistant Yellow vem com o Home Assistant Operating System, que permite instalar Add-ons facilmente. No entanto, o Home Assistant Container não suporta Add-ons, o que significa que você precisa instalar um aplicativo de broker MQTT separado do Home Assistant. Para mais detalhes, consulte os métodos de instalação.

O próximo passo é instalar o Mosquitto Broker e o File Editor. O Mosquitto é um broker de mensagens open source que implementa o protocolo MQTT, enquanto o File Editor permite modificar o arquivo configuration.yaml sem acessar o terminal.

No Home Assistant Yellow, você pode instalar o Mosquitto Broker e o File Editor usando o recurso de Add-ons.

dica

Para conveniência, mostre o 'File editor' na barra lateral:

Agora temos dois add-ons.

Passo 2: Configurar a Integração MQTT

MQTT (Message Queuing Telemetry Transport) é um protocolo de mensagens leve que é fundamental para conectar sua SenseCAP Indicator Board ao Home Assistant. Para habilitar essa funcionalidade, você precisa adicionar a integração MQTT à sua configuração do Home Assistant.

Adicionar a integração MQTT permite que o Home Assistant se comunique perfeitamente com sua SenseCAP Indicator Board, possibilitando troca de dados e controle em tempo real. Essa comunicação bidirecional é essencial para monitorar dados de sensores e enviar comandos para o seu dispositivo.

Para configurar a integração MQTT:

1. No painel do Home Assistant, vá até a página Integrations (Devices & Services -> Integrations).
2. Procure por "MQTT" e selecione-o na lista. (Se não for descoberto automaticamente,)
3. Siga as instruções na tela para concluir a configuração.

dica

Se você estiver usando um broker MQTT não oficial (como o EMQX Broker) em vez do broker Mosquitto padrão, a descoberta automática pode não funcionar. Nesse caso, você precisará inserir manualmente o endereço IP do broker para estabelecer a conexão. Isso garante que o Home Assistant possa se comunicar com sua configuração MQTT personalizada.

Adicionar Usuários para o Add-on MQTT

Ao usar o add-on oficial Mosquitto Broker no Home Assistant, talvez seja necessário configurar credenciais para a conexão MQTT. Essa etapa garante uma comunicação segura entre seus dispositivos e o Home Assistant. Veja como adicionar um usuário:

1. Navegue até o add-on Mosquitto broker na interface do Home Assistant.
2. Procure pela seção ou aba "Users" dentro da configuração do add-on.
3. Clique no botão "Add User" ou "+" para criar um novo usuário.

4. No formulário de criação de usuário:
   • Insira um nome de usuário de sua escolha. o padrão é indicator-usr¹.
   • Crie uma senha forte. o padrão é indicator-password.
   • Opcionalmente, você pode definir permissões específicas, se necessário.
5. Salve as novas credenciais de usuário.

dica

Certifique-se de usar essas credenciais ao configurar seu SenseCAP Indicator ou qualquer outro dispositivo MQTT para se conectar ao Home Assistant.

Depois de adicionar o usuário, talvez seja necessário reiniciar o add-on Mosquitto broker para que as alterações entrem em vigor. Agora você já deve conseguir estabelecer uma conexão MQTT segura usando essas credenciais.

Lembre-se de atualizar as configurações MQTT do seu SenseCAP Indicator com o novo nome de usuário e senha para garantir que ele possa se comunicar com o Home Assistant.

Configurando o Projeto SenseCAP Indicator ESP32

Antes de integrar o seu SenseCAP Indicator com o Home Assistant, você precisa configurar o dispositivo com o firmware apropriado. Siga estes passos para baixar, compilar e gravar o projeto no seu SenseCAP Indicator.

Etapa 1: Baixar o Projeto

Existem dois projetos disponíveis para integrar o SenseCAP Indicator com o Home Assistant. Escolha o que melhor atender às suas necessidades:

sensecap-indicator-ha

Este projeto é especificamente projetado para integração com o Home Assistant.

Obter o Firmware

Ou use Git para clonar o repositório:

git clone https://github.com/Love4yzp/sensecap-indicator-ha

SenseCAP_Indicator_ESP32

Este projeto inclui mais exemplos e recursos para o SenseCAP Indicator.

Obter o Firmware

Ou use Git para clonar o repositório:

git clone https://github.com/Seeed-Solution/SenseCAP_Indicator_ESP32

Etapa 2: Navegar até o Diretório do Projeto

Depois de ter baixado ou clonado o projeto, navegue até o diretório apropriado:

sensecap-indicator-ha

cd sensecap-indicator-ha

SenseCAP_Indicator_ESP32

cd SenseCAP_Indicator_ESP32/examples/indicator_ha

Etapa 3: Compilar, Gravar e Monitorar o Projeto

Agora você está pronto para compilar o firmware, gravá-lo no seu SenseCAP Indicator e monitorar a saída do dispositivo. Use o seguinte comando:

idf.py -p PORT build flash monitor

Substitua PORT pela porta apropriada para o seu dispositivo (por exemplo, COM3 no Windows ou /dev/ttyUSB0 no Linux).

dica

Se você não tiver certeza sobre a porta do seu dispositivo:

• No Windows: Verifique o Gerenciador de Dispositivos em "Ports (COM & LPT)"
• No Linux/macOS: Execute ls /dev/tty* no terminal

Este comando irá:

1. Compilar o projeto
2. Gravar o firmware no seu SenseCAP Indicator
3. Abrir um monitor serial para exibir a saída do dispositivo

Para sair do monitor serial, pressione Ctrl-].

Etapa 4: Verificar a Configuração

Depois de gravar o firmware, o monitor serial exibirá a saída do seu SenseCAP Indicator. Procure por mensagens indicando conexão bem-sucedida à sua rede Wi-Fi e ao broker MQTT.

cuidado

Certifique-se de que o seu SenseCAP Indicator esteja conectado à mesma rede que a sua instância do Home Assistant e que o seu broker MQTT esteja devidamente configurado e acessível.

Depois de gravar e verificar com sucesso o firmware no seu SenseCAP Indicator, você estará pronto para prosseguir com a integração dele ao Home Assistant usando a integração MQTT.

Em seguida, vamos configurar o Home Assistant para reconhecer e se comunicar com o seu SenseCAP Indicator.

Adicionar Dispositivos MQTT

Depois de configurar a integração MQTT no Home Assistant, o próximo passo é adicionar dispositivos MQTT. Esse processo envolve configurar o Home Assistant para reconhecer e se comunicar com a sua SenseCAP Indicator Board por meio de MQTT.

Etapa 1: Adicionar Entidades do Indicator

Para adicionar as entidades do SenseCAP Indicator ao Home Assistant, você precisa modificar o arquivo configuration.yaml. Este arquivo é crucial para definir como o Home Assistant interage com seus dispositivos.

dica

Se você estiver usando o Home Assistant Yellow ou qualquer sistema com o complemento File editor, poderá facilmente modificar o arquivo configuration.yaml pela interface web. Para outras configurações, como o Home Assistant Container, talvez seja necessário modificar o arquivo via acesso ao terminal.

Para modificar o arquivo configuration.yaml:

1. Navegue até o complemento File editor no painel do Home Assistant.
2. Selecione o arquivo configuration.yaml na lista de arquivos.
3. Adicione a seguinte configuração MQTT ao arquivo:

Clique para expandir e copiar a configuração MQTT para o SenseCAP Indicator

# Example configuration.yaml entry | SenseCAP Indicator MQTT Configuration
mqtt:
  sensor:
    - unique_id: indicator_temperature
      name: "Indicator Temperature"
      state_topic: "indicator/sensor"
      suggested_display_precision: 1
      unit_of_measurement: "°C"
      value_template: "{{ value_json.temp }}"
    - unique_id: indicator_humidity
      name: "Indicator Humidity"
      state_topic: "indicator/sensor"
      unit_of_measurement: "%"
      value_template: "{{ value_json.humidity }}"
    - unique_id: indicator_co2
      name: "Indicator CO2"
      state_topic: "indicator/sensor"
      unit_of_measurement: "ppm"
      value_template: "{{ value_json.co2 }}"
    - unique_id: indicator_tvoc
      name: "Indicator tVOC"
      state_topic: "indicator/sensor"
      unit_of_measurement: ""
      value_template: "{{ value_json.tvoc }}"
  switch:
    - unique_id: indicator_switch1
      name: "Indicator Switch1"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch1 }}"
      payload_on: '{"switch1":1}'
      payload_off: '{"switch1":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch2
      name: "Indicator Switch2"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch2 }}"
      payload_on: '{"switch2":1}'
      payload_off: '{"switch2":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch3
      name: "Indicator Switch3"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch3 }}"
      payload_on: '{"switch3":1}'
      payload_off: '{"switch3":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch4
      name: "Indicator Switch4"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch4 }}"
      payload_on: '{"switch4":1}'
      payload_off: '{"switch4":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch6
      name: "Indicator Switch6"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch6 }}"
      payload_on: '{"switch6":1}'
      payload_off: '{"switch6":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch7
      name: "Indicator Switch7"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch7 }}"
      payload_on: '{"switch7":1}'
      payload_off: '{"switch7":0}'
      state_on: 1
      state_off: 0
  number:
    - unique_id: indicator_switch5
      name: "Indicator Switch5"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      command_template: '{"switch5": {{ value }} }'
      value_template: "{{ value_json.switch5 }}"
    - unique_id: indicator_switch8
      name: "Indicator Switch8"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      command_template: '{"switch8": {{ value }} }'
      value_template: "{{ value_json.switch8 }}"

1. Salve as alterações no arquivo configuration.yaml.

cuidado

Se a sua instalação do Home Assistant não oferece suporte a add-ons (por exemplo, Home Assistant Container), você precisará modificar o arquivo configuration.yaml por meio de um terminal ou conexão SSH.

Etapa 2: Aplicando as alterações de configuração

Após modificar o arquivo configuration.yaml, você precisa aplicar as alterações:

1. Navegue até Developer Tools no painel do Home Assistant.
2. Encontre e clique na aba "YAML".
3. Recarregue a configuração por ALL YAML CONFIGURATION.

nota

se algo der errado, você pode

• Clicar no botão "Check Configuration" para verificar suas alterações.
• Se a verificação da configuração for aprovada, clique no botão "Restart" para aplicar a nova configuração.

Após reiniciar, o Home Assistant reconhecerá as entidades do seu SenseCAP Indicator, e você deverá conseguir vê-las no seu painel. Se as entidades não aparecerem imediatamente, talvez seja necessário aguardar alguns minutos para que o processo de descoberta MQTT seja concluído.

Lembre-se de garantir que o seu SenseCAP Indicator esteja devidamente configurado para publicar seus dados nos tópicos MQTT corretos, conforme definido na configuração.

Seguindo estas etapas, você adicionou com sucesso seus dispositivos SenseCAP Indicator ao Home Assistant via MQTT. Agora você pode usar essas entidades em suas automações, scripts e painel para uma experiência de casa inteligente mais integrada.

Configurar Dashboard

A etapa final na integração do seu SenseCAP Indicator com o Home Assistant é configurar um painel personalizado. Isso permitirá que você visualize e controle com facilidade os dados e funções do seu dispositivo.

Criando um novo painel (Opcional)

Se você quiser criar um painel dedicado para o seu SenseCAP Indicator:

1. Navegue até Settings -> Dashboards na barra lateral do Home Assistant.
2. Clique no botão "Add Dashboard".
3. Defina um título (por exemplo, "SenseCAP Indicator") e escolha um ícone.
4. Clique em "Create" para finalizar o novo painel.

Configurando o painel

Para adicionar entidades do SenseCAP Indicator ao seu painel:

1. Abra o painel que você quer editar.
2. Clique no menu de três pontos no canto superior direito e selecione "Edit Dashboard".
3. Clique no botão "TAKE CONTROL" para habilitar a configuração manual.

4. No editor de painel, clique novamente no menu de três pontos e selecione "Raw configuration editor".
5. Substitua o conteúdo YAML existente pela seguinte configuração:

Clique para copiar o YAML do Painel para alterar a interface

Observação: Isto não é para Configuration.YAML.

views:
  - title: Indicator device
    icon: ''
    badges: []
    cards:
      - graph: line
        type: sensor
        detail: 1
        icon: mdi:molecule-co2
        unit: ppm
        entity: sensor.indicator_co2
      - graph: line
        type: sensor
        entity: sensor.indicator_temperature
        detail: 1
        icon: mdi:coolant-temperature
      - graph: line
        type: sensor
        detail: 1
        entity: sensor.indicator_humidity
      - graph: line
        type: sensor
        entity: sensor.indicator_tvoc
        detail: 1
        icon: mdi:air-filter
      - type: entities
        entities:
          - entity: switch.indicator_switch1
          - entity: switch.indicator_switch2
          - entity: switch.indicator_switch3
          - entity: switch.indicator_switch4
          - entity: number.indicator_switch5
          - entity: switch.indicator_switch6
          - entity: switch.indicator_switch7
          - entity: number.indicator_switch8
        title: Indicator control
        show_header_toggle: false
        state_color: true

cuidado

Esta configuração YAML é especificamente para o painel e não deve ser adicionada ao seu arquivo configuration.yaml.

1. Clique em "SAVE" para aplicar as alterações.

Parabéns! Você configurou com sucesso o painel do Home Assistant para exibir e controlar o seu SenseCAP Indicator. Agora você pode monitorar níveis de CO2, temperatura, umidade e TVOC, bem como controlar vários interruptores diretamente na interface do Home Assistant.

Recursos

1. Demo SDK: O Demo SDK para o SenseCAP Indicator está disponível no GitHub.
2. Arquivo indicator_ha.c: Este arquivo contém as funções principais para a integração com o Home Assistant. Você pode vê-lo aqui.
3. Guia do Usuário: O Guia do Usuário fornece informações detalhadas sobre o software e o hardware da SenseCAP Indicator Board. Você pode lê-lo aqui.
4. Guia de Instalação do Home Assistant: Se você é novo no Home Assistant, este guia ajudará você a instalá-lo e configurá-lo. Você pode encontrá-lo aqui.
5. Guia de Introdução ao ESP-IDF: Este guia fornece todas as etapas para configurar e usar o ESP-IDF para construir projetos. Você pode acessá-lo aqui.
6. Conceitos e terminologia do Home Assistant

Referência

• 🔗 [Link] Home Assistant and MQTT: 4 Things You Could Build | EMQ (emqx.com)

Suporte Técnico

Precisa de ajuda com o seu SenseCAP Indicator? Estamos aqui para ajudar você!

Se você encontrar algum problema ou tiver dúvidas enquanto segue este tutorial, sinta-se à vontade para entrar em contato com o nosso suporte técnico. Estamos sempre aqui para ajudar!

Visite o nosso Canal Oficial da Seeed no Discord para fazer suas perguntas ou as discussões no GitHub para compartilhar tudo o que você quiser!

Footnotes

1. MQTT default credential - GitHub ↩