Verificar con Bruno
Usa la colección de Bruno para verificar la autenticación, las consultas de dispositivo, el control de relés, la transmisión RS485 y la consulta de resultados de comandos. Comparado con las dos peticiones curl, este camino cubre más terreno, y las aserciones integradas validan la forma de la respuesta automáticamente en lugar de obligarte a revisar el JSON a ojo.
Antes de empezar
- Ten a mano el
clientIdy elclientSecret. - Activa
device:read; activadevice:controlodevice:configsolo si vas a ejecutar las peticiones de relé o RS485. - Confirma que es seguro operar el dispositivo y el relé de destino.
- ¿Todavía sin hardware ni credenciales? Escribe a support@svnwi.com para pedir credenciales de prueba y los modelos de dispositivo de demostración disponibles: no necesitas comprar hardware primero.
1. Instalar Bruno
Descarga la aplicación de escritorio de Bruno. Para CI o entornos sin interfaz, instala la CLI:
npm install -g @usebruno/cli
bru --version2. Obtener la colección
Solo necesitas la carpeta examples/bruno del repositorio del SDK, no el repositorio entero. Usa un sparse checkout para descargar únicamente esa parte:
git clone --filter=blob:none --sparse https://github.com/svnwi/wlte-openapi-sdk.git
cd wlte-openapi-sdk
git sparse-checkout set examples/brunoAbre esta carpeta en la aplicación de escritorio de Bruno:
examples/bruno/WLTE-OpenAPI/3. Configurar las credenciales
El archivo environments/quickstart.bru que hay en el repositorio contiene solo marcadores de posición, por lo que es seguro que aparezca en el historial de Git. Las credenciales reales van en una copia local que nunca se sube:
cd examples/bruno/WLTE-OpenAPI
cp environments/quickstart.bru environments/quickstart.local.bruAbre environments/quickstart.local.bru y sustituye solo:
clientId -> tu_client_id
clientSecret -> tu_client_secretSelecciona el entorno quickstart.local en Bruno. Los scripts de la colección rellenan accessToken, deviceId y commandId automáticamente; relayIndex vale 1 por defecto.
quickstart.local.bru ya está excluido en el .gitignore: no cambies esa regla.
4. Ejecutar la verificación de solo lectura
Ejecuta estas peticiones en orden:
| Orden | Petición | Para qué |
|---|---|---|
| 1 | 00-auth / Auth | Obtener un access token |
| 2 | 01-device-queries / 01-list-devices | Confirmar los dispositivos accesibles y rellenar deviceId automáticamente |
| 3 | 01-device-queries / 02-get-device-real-time-status | Actualizar y leer el estado de un dispositivo |
| 4 | 01-device-queries / 03-list-profiles | Consultar las definiciones de tipo de dispositivo para confirmar sus capacidades |
| 5 | 01-device-queries / 04-get-device-config | Leer la configuración actual (baudios, duración del pulso, etc.) |
Las aserciones integradas validan el estado HTTP y la forma de la respuesta.
5. Opcional: verificar el control del dispositivo
Los comandos de dispositivo cambian el estado del hardware real. Continúa solo si el API Client tiene el permiso correspondiente y la operación es segura; elige las peticiones que necesites:
| Orden | Petición | Para qué | Permiso necesario |
|---|---|---|---|
| 6 | 02-relay-control / 01-turn-relay-on | Activar un relé | device:control |
| 7 | 02-relay-control / 02-turn-relay-off | Desactivar un relé | device:control |
| 8 | 02-relay-control / 03-jog-relay | Lanzar un pulso | device:control |
| 9 | 02-relay-control / 04-set-relay-jog-time | Fijar la duración del pulso (no cambia el estado actual del relé) | device:config |
| 10 | 02-relay-control / 05-control-multiple-relays | Controlar varios relés en una sola petición | device:control |
| 11 | 04-rs485 / 01-rs485-transceive | Enviar datos transparentes RS485 (requiere un dispositivo con RS485) | device:control |
| 12 | 04-rs485 / 02-set-rs485-baud-rate | Fijar la velocidad en baudios de RS485 | device:config |
| 13 | 03-command-result / 01-get-command-result | Consultar el resultado final con el commandId de un paso anterior | device:read |
Si tu integración es de solo lectura, sáltate esta sección entera. Antes de probar las peticiones RS485, cambia rs485DeviceId por un dispositivo que realmente admita RS485 (por defecto apunta al primer dispositivo encontrado, solo para poder navegar por la colección, lo que no implica que admita RS485).
Uso desde la línea de comandos
La CLI permite elegir por ruta qué carpetas ejecutar, así que puedes mantener la verificación de solo lectura y el control de dispositivos como dos comandos separados, en lugar de uno que podría accionar relés sin querer:
cd examples/bruno/WLTE-OpenAPI
# Verificación de solo lectura: solo lee datos, nunca cambia el estado del dispositivo
bru run --env-file environments/quickstart.local.bru \
00-auth 01-device-queries
# Verificación de control: acciona relés y dispositivos RS485 de verdad — confirma antes que es seguro
bru run --env-file environments/quickstart.local.bru \
02-relay-control 04-rs485 03-command-resultNo ejecutes bru run --env quickstart sin rutas
Sin una ruta de carpeta, bru run ejecuta de forma recursiva todas las peticiones de la colección, incluidas la activación y desactivación de relés, el pulso y los comandos RS485, aunque solo quisieras hacer una comprobación de lectura. Indica siempre las carpetas de forma explícita, como se muestra arriba.
Para una primera integración, la aplicación de escritorio es más cómoda para inspeccionar variables de entorno, aserciones y cuerpos de respuesta. La CLI encaja mejor en verificaciones repetidas o en CI.
Resultado de la verificación
Al terminar esta página has verificado:
- La autenticación del API Client
- El acceso a dispositivos, su estado en tiempo real, su configuración y las definiciones de tipo
- Opcionalmente, el control de relés, la transmisión RS485 y la consulta de resultados de comandos
No monitorices una cuenta entera repitiendo peticiones sobre un solo dispositivo. Usa las listas de dispositivos para las vistas masivas y los eventos WebSocket para los cambios continuos.