A ZCL Advanced Platform (ZAP) é um mecanismo de modelo Node.js que é baseado Clusters Matter.
O ZAP fornece os seguintes recursos para apps Matter e SDKs:
- Configurar Matter endpoints, clusters, atributos e outros recursos do dispositivo em uma interface GUI.
- Crie modelos que gerem automaticamente definições de modelos de dados, callbacks e outros códigos-fonte do Matter.
- Crie e use arquivos ZAP pré-configurados para incluir nos seus SDKs.
Instalar
Acesse os lançamentos da ZAP página.
Procure o lançamento marcado como "Mais recente" A maioria será marcada como "Pré-lançamento".
Neste lançamento, em Recursos, selecione o pacote. designada para seu sistema operacional e fazer o download.
Em uma máquina com Debian ou Ubuntu, instale o ZAP executando:
sudo dpkg -i path/to/zap_installation_package
No Debian ou no Ubuntu Linux, o binário zap
é instalado em /usr/bin/
. Ativado
outros sistemas operacionais, o binário pode ser instalado em outro lugar. De qualquer forma,
Verifique se a localização do executável está no seu ambiente PATH
variável.
Arquivos ZAP
O ZAP usa arquivos de modelo chamados arquivos ZAP. Um arquivo ZAP é um arquivo JSON
que define endpoints, comandos, atributos e outros recursos do
dispositivo. Os arquivos ZAP têm nomes que terminam em .zap
. Por exemplo:
lighting-app.zap
em connectedhomeip/examples/lighting-app/lighting-common
.
O arquivo all-clusters-app.zap
, encontrado em
connectedhomeip/examples/all-clusters-app/all-clusters-common
, é
pré-configuradas com clusters Matter comuns e três
Endpoints, incluindo uma rede secundária Matter
Tipo de dispositivo de comissionamento. Este é um bom exemplo de uso de várias ferramentas
personalizadas.
Executar
- Escolha um arquivo ZAP de um dos Matter exemplos.
- No diretório raiz do repositório do Matter (
connectedhomeip
), execute o script de wrapperrun_zaptool.sh
, transmitindo o caminho para o arquivo.zap
.
Exemplo:
./scripts/tools/zap/run_zaptool.sh ./examples/lighting-app/lighting-common/lighting-app.zap
Configurar
Nas Configurações do
, é possível definir a interface do usuário do ZAP, incluindo sua escolha entre tema claro ou escuro e ativar ou desativar as ferramentas para desenvolvedores.Clicar em
Opções permite selecionar o produto fabricante, política de resposta padrão e ativar ou desativar o comando Descoberta.Clique em
Extensões para adicionar personalizadas clusters ou comandos ZCL para o Configurador de clusters do Zigbee.Usar
Endpoints
O arquivo lighting-app.zap
é pré-configurado com um Matter
Nó raiz (Endpoint - 0) e uma luz escurecida Matter
(Endpoint - 1).
Endpoint - 0 inclui clusters gerais que são relevantes para todo o nó, por exemplo, rede, comissionamento, descritor, credenciais operacionais e clusters OTA.
Nas próximas etapas, você vai analisar e configurar Endpoint - 1
Matter Luz regulável do exemplo lighting-app
.
No repositório Matter
connectedhomeip
, execute ZAP.scripts/tools/zap/run_zaptool.sh \ examples/lighting-app/lighting-common/lighting-app.zap
Clique em Endpoint - 1 e depois
EDITAR.Opcional:o Matter oferece suporte a vários tipos de dispositivos. Em no menu suspenso Dispositivo, comece a digitar
matter
para alterar seu dispositivo e, em seguida, Clique em SALVAR.
Para saber mais, consulte Dispositivos e Endpoints no Matter Introdução.
Clusters
Clusters, atributos e opções de relatórios predefinidos estão ativados em Endpoint - 1 por padrão.
Para mostrar apenas clusters ativados, clique em Endpoint - 1 e selecione
Clusters ativados no menu Mostrar. Também é possível pesquisar on
.
Para ativar um cluster como Cliente, Servidor ou Cliente e Server, use no menu suspenso Ativar. Também é possível selecionar Não ativado para desabilitar uma cluster pré-configurado que não se aplica ao tipo de dispositivo.
Para saber mais, consulte Clusters no Matter Primer.
Atributos e comandos
Para configurar atributos e comandos, siga estas etapas:
- Localize o cluster
On/Off
. Na mesma linha, clique no ícone Configurar
.
Aqui você pode ativar ou desativar Atributos, definir várias opções de Atributos e Pesquisar atributos
por nome.Clique em Comandos para configurar ações para este cluster. Para
Por exemplo, o cluster Ligar/desligar de uma luz vai incluir Ativado, Desativado,
e Alternar. Alguns clusters, como
o cluster Temperature Measurement
, pode não ter nenhum comando associado.
Para saber mais, consulte Atributos e comandos no Matter Primer.
Gerar arquivos de origem ZAP
Os exemplos de Matter usam o código-fonte gerado pelo ZAP, disponível
no diretório connectedhomeip/zzz_generated
. Alguns arquivos são específicos do app,
enquanto outros arquivos ZAP genéricos são agrupados em app-common
.
#include <app-common/zap-generated/ids/Attributes.h>
#include <app-common/zap-generated/ids/Clusters.h>
Depois de configurar os endpoints, você pode gerar arquivos de origem para integrar em seu projeto.
- Clique em Gerar.
- Selecione uma pasta para salvar a saída ZAP. Por exemplo, acesse
connectedhomeip/zzz_generated/lighting-app/zap-generated
para olighting-app
. - Opcional. Abra os arquivos no ambiente de desenvolvimento integrado de sua preferência.
O ZAP gera definições, funções e outros códigos-fonte personalizados para seu tipo de dispositivo e configuração do ZAP.
Por exemplo, callback-stub.cpp
inclui um método de callback de cluster que
inclui apenas os clusters que você ativou:
void emberAfClusterInitCallback(EndpointId endpoint, ClusterId clusterId)
{
switch (clusterId)
{
...
case ZCL_ON_OFF_CLUSTER_ID :
emberAfOnOffClusterInitCallback(endpoint);
break;
...
}
}
Usar arquivos de origem ZAP
Arquivos de origem ZAP comuns, por exemplo Attributes.h
em
zzz_generated/app-common/app-common/zap-generated/ids/
, pode ser usado para
get e set device type Attributes:
Attributes.h
namespace DeviceTemperatureConfiguration {
namespace Attributes {
namespace CurrentTemperature {
static constexpr AttributeId Id = 0x00000000;
} // namespace CurrentTemperature
...
} // namespace Attributes
} // namespace DeviceTemperatureConfiguration
main.cpp
#include <app-common/zap-generated/att-storage.h>
#include <app-common/zap-generated/attribute-id.h>
#include <app-common/zap-generated/attribute-type.h>
#include <app-common/zap-generated/attributes/Accessors.h>
#include <app-common/zap-generated/callback.h>
#include <app-common/zap-generated/cluster-id.h>
#include <app-common/zap-generated/cluster-objects.h>
#include <app-common/zap-generated/command-id.h>
using namespace ::chip;
using namespace ::chip::app::Clusters;
static void InitServer(intptr_t context)
{
...
// Sets temperature to 20C
int16_t temperature = 2000;
auto status = DeviceTemperatureConfiguration::Attributes::CurrentTemperature::Set(1, temperature);
if (status != EMBER_ZCL_STATUS_SUCCESS)
{
ChipLogError(Shell, "Temp measurement set failed");
}
}
Depois de entender como os arquivos ZAP podem ser usados no código-fonte Matter, há várias maneiras de integrar o ZAP:
- Use os arquivos
zzz_generated
já existentes para criar novos exemplos, exclusivos para seus tipos de dispositivo. - Crie arquivos
.zap
personalizados para seus projetos.
Personalizar
Os arquivos ZAP são gerados a partir de ZAP
de modelos.
Quando você usa run_zaptool.sh
para iniciar o ZAP, esse script transmite os seguintes
modelos:
node src-script/zap-start.js --logToStdout \
--gen "$CHIP_ROOT/src/app/zap-templates/app-templates.json" \
--zcl "$CHIP_ROOT/src/app/zap-templates/zcl/zcl.json" \
"${ZAP_ARGS[@]}"
templates.json
define o nome do modelo Matter e
arquivo de saída correspondente usado em exemplos de Matter.
{
"path": "templates/app/callback-stub-src.zapt",
"name": "ZCL callback-stub source",
"output": "callback-stub.cpp"
}
Para personalizar suas soluções Matter, siga estas etapas ao trabalhar com o ZAP:
Recursos
Para recursos ZAP adicionais, consulte
Repositório ZAP
(zap
)
no GitHub.