This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Documentation

Complete VDM Visual Displacement Meter API Documentation

Welcome to the VDM API Documentation. This documentation covers the MQTT API interfaces for all VDM series devices.

Quick Navigation

  • Quick Start - 5-minute quick integration guide
  • Models - API manuals for each device model

Product Models

ModelSensorPTUDescription
V1MonoNoneFixed basic model
V2W / V2W4MStereoNoneFixed stereo
V2KStereoNoneStereo free-angle
O1MonoSingle-axisHorizontal rotation
X1MonoDual-axisDual-axis rotation
X2W / X2W4MStereoDual-axisRotating stereo

MQTT Topics

vdm/{deviceId}/rpc/req       # Downstream RPC commands
vdm/{deviceId}/rpc/resp      # Upstream RPC responses
vdm/{deviceId}/telemetry     # Upstream telemetry data
vdm/{deviceId}/attributes    # Upstream attribute reports
vdm/{deviceId}/event         # Upstream event notifications
vdm/{deviceId}/3A            # Upstream 3A notifications

1 - Quick Start

Get started with VDM API in 5 minutes

English version is under translation. Please refer to the Chinese version for now.

2 - Models

API manuals for each VDM device model

This section contains detailed API manuals for each VDM device model.

Model List

Fixed Devices

  • V1 - Mono fixed (basic reference)
  • V2W - V2W/V2W4M stereo fixed
  • V2K - V2K stereo free-angle

Rotating Devices

  • O1 - O1 mono single-axis rotating
  • X1 - X1 mono dual-axis rotating
  • X2W - X2W/X2W4M stereo rotating

2.1 - VDM-V1

V1 Monocular Fixed Visual Displacement Meter API Reference

English version is under translation. Please refer to the Chinese version for now.

2.2 - VDM-V2W

V2W/V2W4M Stereo Fixed Visual Displacement Meter API Reference

English version is under translation. Please refer to the Chinese version for now.

2.3 - VDM-V2K

V2K Stereo Free-angle Visual Displacement Meter API Reference

English version is under translation. Please refer to the Chinese version for now.

2.4 - VDM-O1

O1 Monocular Single-axis Rotary Visual Displacement Meter API Reference

English version is under translation. Please refer to the Chinese version for now.

2.5 - VDM-X1

X1 Monocular Dual-axis Rotary Visual Displacement Meter API Reference

English version is under translation. Please refer to the Chinese version for now.

2.6 - VDM-X2W

X2W/X2W4M Stereo Dual-axis Rotary Visual Displacement Meter API Reference

English version is under translation. Please refer to the Chinese version for now.