Skip to content

Verify with Bruno

Use the Bruno collection to verify authentication, device queries, relay control, RS485 transceive, and command-result lookups. Compared with the two curl requests, this path covers more ground, and the built-in assertions validate response shape automatically instead of requiring you to eyeball JSON.

Before You Start

  • Prepare clientId and clientSecret.
  • Enable device:read; enable device:control or device:config only if you will run the relay or RS485 requests.
  • Confirm that the target device and relay are safe to control.
  • No hardware or credentials yet? Contact support@svnwi.com to request test credentials and available demo device models — you do not need to purchase hardware first.

1. Install Bruno

Download the Bruno desktop app. For CI or headless environments, install the CLI:

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

2. Get the Collection

You only need the examples/bruno folder from the SDK repository, not the whole repository. Use a sparse checkout to fetch only that part:

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

Open this folder in the Bruno desktop app:

text
examples/bruno/WLTE-OpenAPI/

3. Configure Credentials

The environments/quickstart.bru file committed to the repository contains placeholders only, so it is safe to appear in Git history. Real credentials go into a local copy that is never committed:

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

Open environments/quickstart.local.bru and replace only:

text
clientId     ->  your_client_id
clientSecret ->  your_client_secret

Select the quickstart.local environment in Bruno. Collection scripts populate accessToken, deviceId, and commandId automatically; relayIndex defaults to 1.

quickstart.local.bru is already excluded via .gitignore — do not change that rule.

4. Run Read-only Verification

Run these requests in order:

OrderRequestPurpose
100-auth / AuthObtain an access token
201-device-queries / 01-list-devicesConfirm accessible devices and auto-populate deviceId
301-device-queries / 02-get-device-real-time-statusRefresh and read one device's state
401-device-queries / 03-list-profilesLook up device type definitions to confirm capabilities
501-device-queries / 04-get-device-configRead the current configuration (baud rate, jog duration, etc.)

The built-in assertions validate the HTTP status and response shape.

5. Optionally Verify Device Control

Device commands change real hardware state. Continue only when the API Client has the matching permission and the operation is safe; pick whichever requests you need:

OrderRequestPurposeRequired Scope
602-relay-control / 01-turn-relay-onTurn one relay ondevice:control
702-relay-control / 02-turn-relay-offTurn one relay offdevice:control
802-relay-control / 03-jog-relayTrigger one jogdevice:control
902-relay-control / 04-set-relay-jog-timeSet the jog duration (does not change the relay's current state)device:config
1002-relay-control / 05-control-multiple-relaysControl multiple relays in one requestdevice:control
1104-rs485 / 01-rs485-transceiveSend RS485 transceive data (requires an RS485-capable device)device:control
1204-rs485 / 02-set-rs485-baud-rateSet the RS485 baud ratedevice:config
1303-command-result / 01-get-command-resultLook up the final result using the commandId from a previous stepdevice:read

Skip this whole section for read-only integrations. Before testing RS485 requests, set rs485DeviceId to a device that actually supports RS485 (it defaults to the first discovered device purely for collection navigation, which does not imply RS485 support).

CLI Usage

The CLI can select which folders to run by path, so you can keep read-only verification and device control as two separate commands instead of one that might trigger relay actions by accident:

bash
cd examples/bruno/WLTE-OpenAPI

# Read-only verification: only reads data, never changes device state
bru run --env-file environments/quickstart.local.bru \
  00-auth 01-device-queries

# Device control verification: actually operates relays and RS485 devices — confirm it's safe first
bru run --env-file environments/quickstart.local.bru \
  02-relay-control 04-rs485 03-command-result

Do not run bru run --env quickstart with no paths

Without a folder path, bru run executes every request in the collection recursively, including relay on/off, jog, and RS485 commands — even if you only intended a read-only check. Always specify the folders explicitly as shown above.

For a first integration, the desktop app is easier for inspecting environment variables, assertions, and response bodies. The CLI is better suited for repeated verification or CI.

Verification Result

After completing this page, you have verified:

  • API Client authentication
  • Device access, real-time state, device configuration, and type definitions
  • Optional relay control, RS485 transceive, and command-result lookup

Do not use repeated single-device requests to monitor an entire account. Use device lists for bulk views and WebSocket events for continuous changes.

Next Steps

Docs buildVersion v1.5.8-20260814-180545-84
Copyright © 2026 WLTE