Quick Start
Get started with VDM API in 5 minutes
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
| Model | Sensor | PTU | Description |
|---|---|---|---|
| V1 | Mono | None | Fixed basic model |
| V2W / V2W4M | Stereo | None | Fixed stereo |
| V2K | Stereo | None | Stereo free-angle |
| O1 | Mono | Single-axis | Horizontal rotation |
| X1 | Mono | Dual-axis | Dual-axis rotation |
| X2W / X2W4M | Stereo | Dual-axis | Rotating 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