Verificar com Bruno

Use a coleção Bruno para verificar autenticação, consultas de dispositivo, controle de relé, transceptor RS485 e consulta de resultados de comandos. Comparado com as duas requisições curl, esse caminho cobre mais terreno, e as asserções integradas validam a estrutura da resposta automaticamente em vez de exigir que você confira o JSON manualmente.

Antes de começar

• Tenha em mãos o clientId e o clientSecret.
• Ative device:read; ative device:control ou device:config somente se for executar as requisições de relé ou RS485.
• Confirme que é seguro operar o dispositivo e o relé de destino.
• Ainda sem hardware nem credenciais? Escreva para support@svnwi.com para solicitar credenciais de teste e os modelos de dispositivo de demonstração disponíveis: você não precisa comprar hardware antes.

1. Instalar o Bruno

Baixe o aplicativo desktop do Bruno. Para CI ou ambientes sem interface, instale a CLI:

npm install -g @usebruno/cli
bru --version

2. Obter a coleção

Você só precisa da pasta examples/bruno do repositório do SDK, não do repositório inteiro. Use um sparse checkout para baixar apenas essa parte:

git clone --filter=blob:none --sparse https://github.com/svnwi/wlte-openapi-sdk.git
cd wlte-openapi-sdk
git sparse-checkout set examples/bruno

Abra esta pasta no aplicativo desktop do Bruno:

examples/bruno/WLTE-OpenAPI/

3. Configurar as credenciais

O arquivo environments/quickstart.bru presente no repositório contém apenas placeholders, por isso é seguro que apareça no histórico do Git. As credenciais reais vão em uma cópia local que nunca é commitada:

cd examples/bruno/WLTE-OpenAPI
cp environments/quickstart.bru environments/quickstart.local.bru

Abra environments/quickstart.local.bru e substitua apenas:

clientId     ->  seu_client_id
clientSecret ->  seu_client_secret

Selecione o ambiente quickstart.local no Bruno. Os scripts da coleção preenchem accessToken, deviceId e commandId automaticamente; relayIndex usa 1 por padrão.

quickstart.local.bru já está excluído no .gitignore: não altere essa regra.

4. Executar a verificação somente leitura

Execute estas requisições em ordem:

Ordem	Requisição	Finalidade
1	00-auth / Auth	Obter um access token
2	01-device-queries / 01-list-devices	Confirmar os dispositivos acessíveis e preencher deviceId automaticamente
3	01-device-queries / 02-get-device-real-time-status	Atualizar e ler o estado de um dispositivo
4	01-device-queries / 03-list-profiles	Consultar as definições de tipo de dispositivo para confirmar suas capacidades
5	01-device-queries / 04-get-device-config	Ler a configuração atual (taxa de transmissão, duração do pulso etc.)

As asserções integradas validam o status HTTP e a estrutura da resposta.

5. Opcional: verificar o controle do dispositivo

Comandos de dispositivo alteram o estado real do hardware. Continue apenas se o API Client tiver a permissão correspondente e a operação for segura; escolha as requisições que precisar:

Ordem	Requisição	Finalidade	Permissão necessária
6	02-relay-control / 01-turn-relay-on	Ligar um relé	device:control
7	02-relay-control / 02-turn-relay-off	Desligar um relé	device:control
8	02-relay-control / 03-jog-relay	Disparar um pulso	device:control
9	02-relay-control / 04-set-relay-jog-time	Definir a duração do pulso (não altera o estado atual do relé)	device:config
10	02-relay-control / 05-control-multiple-relays	Controlar vários relés em uma requisição	device:control
11	04-rs485 / 01-rs485-transceive	Enviar dados transparentes RS485 (exige um dispositivo com RS485)	device:control
12	04-rs485 / 02-set-rs485-baud-rate	Definir a taxa de transmissão RS485	device:config
13	03-command-result / 01-get-command-result	Consultar o resultado final com o commandId de um passo anterior	device:read

Se sua integração é somente leitura, pule esta seção inteira. Antes de testar as requisições RS485, altere rs485DeviceId para um dispositivo que realmente suporte RS485 (por padrão aponta para o primeiro dispositivo encontrado, apenas para navegação na coleção, o que não implica suporte a RS485).

Uso pela linha de comando

A CLI permite escolher por caminho quais pastas executar, assim você pode manter a verificação somente leitura e o controle de dispositivos como dois comandos separados, em vez de um que poderia acionar relés sem querer:

cd examples/bruno/WLTE-OpenAPI

# Verificação somente leitura: só lê dados, nunca altera o estado do dispositivo
bru run --env-file environments/quickstart.local.bru \
  00-auth 01-device-queries

# Verificação de controle: aciona relés e dispositivos RS485 de verdade — confirme antes que é seguro
bru run --env-file environments/quickstart.local.bru \
  02-relay-control 04-rs485 03-command-result

Não execute bru run --env quickstart sem caminhos

Sem um caminho de pasta, bru run executa recursivamente todas as requisições da coleção, incluindo ligar/desligar relés, pulso e comandos RS485, mesmo que você quisesse apenas uma verificação de leitura. Sempre especifique as pastas explicitamente, como mostrado acima.

Para uma primeira integração, o aplicativo desktop é mais fácil para inspecionar variáveis de ambiente, asserções e corpos de resposta. A CLI é mais adequada para verificação repetida ou CI.

Resultado da verificação

Ao concluir esta página, você verificou:

• A autenticação do API Client
• O acesso a dispositivos, seu estado em tempo real, sua configuração e as definições de tipo
• Opcionalmente, o controle de relés, o transceptor RS485 e a consulta de resultados de comandos

Não monitore uma conta inteira repetindo requisições sobre um único dispositivo. Use as listas de dispositivos para exibições em massa e os eventos WebSocket para mudanças contínuas.

Próximos passos

• Integrar um SDK
• Ver as falhas comuns
• Escolher REST API ou WebSocket