Run the simulatorLink to the section Run the simulator#

Start a synthetic aerial patrol and inspect the messages it produces. This is a development setup on your own computer. The example tokens and plaintext listeners are restricted to loopback.

PrerequisitesLink to the section Prerequisites#

Use a checkout of this repository, Python 3.11 or later, and a shell. The media extra installs the Python video dependencies. The optional browser viewer requires .NET 10 and a browser with H.264 WebRTC support.

All commands below start from the repository root unless they explicitly change directory.

Install the Python gatewayLink to the section Install the Python gateway#

python3 -m venv gateway/.venv
. gateway/.venv/bin/activate
pip install -e './gateway[media]'

Start a receiving endpointLink to the section Start a receiving endpoint#

In the first terminal, with the virtual environment active:

univip-dev-endpoint --listen 127.0.0.1:9443 --token dev-device-token --client-id dev-endpoint

This development Client validates incoming messages and logs telemetry summaries and events. It does not display video.

Start the simulated vehicleLink to the section Start the simulated vehicle#

In a second terminal:

. gateway/.venv/bin/activate
cd gateway
univip-gateway --config gateway.example.yaml

The example configuration starts a simulated patrol and a synthetic camera source. The gateway connects to the endpoint on port 9443 and exposes Device REST on port 8443.

Inspect capabilities and telemetryLink to the section Inspect capabilities and telemetry#

In another terminal:

curl -s -H 'Authorization: Bearer dev-vms-token' \
  http://127.0.0.1:8443/univip/v1/devices/urn:univip:gw-sim:sim-1/capabilities

curl -s -H 'Authorization: Bearer dev-vms-token' \
  http://127.0.0.1:8443/univip/v1/devices/urn:univip:gw-sim:sim-1/telemetry/latest

Look for the advertised profiles and commands, then compare changing telemetry samples. If Profile S is absent, check that the media dependencies installed and that the gateway can offer a stream. Read gateway configuration for adapter and media settings.

Add the web viewerLink to the section Add the web viewer#

Stop the development endpoint in the first terminal so port 9443 is free. Keep the gateway running; it will reconnect. From the repository root, start the .NET viewer:

dotnet run --project dotnet/src/Univip.Viewer.Web -- --insecure-local \
  --device-token dev-device-token --rest-token dev-vms-token --client-id dev-endpoint

Open http://127.0.0.1:8080. The viewer is view-only with these arguments. The viewer documentation covers optional control, authentication and its media constraints.

Continue with your integrationLink to the section Continue with your integration#

Build a Device or gateway or integrate a VMS. The schemas and example messages describe the data; conformance testing defines what must be verified.